* lisp/vc/smerge-mode.el (smerge-refine): Choose better default part to
[emacs.git] / src / window.c
blob7591401ee421199e8224ca6af82bce6003e8c88e
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 2000,
4 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <stdio.h>
24 #include <setjmp.h>
26 #include "lisp.h"
27 #include "buffer.h"
28 #include "keyboard.h"
29 #include "keymap.h"
30 #include "frame.h"
31 #include "window.h"
32 #include "commands.h"
33 #include "indent.h"
34 #include "termchar.h"
35 #include "disptab.h"
36 #include "dispextern.h"
37 #include "blockinput.h"
38 #include "intervals.h"
39 #include "termhooks.h" /* For FRAME_TERMINAL. */
41 #ifdef HAVE_X_WINDOWS
42 #include "xterm.h"
43 #endif /* HAVE_X_WINDOWS */
44 #ifdef WINDOWSNT
45 #include "w32term.h"
46 #endif
47 #ifdef MSDOS
48 #include "msdos.h"
49 #endif
50 #ifdef HAVE_NS
51 #include "nsterm.h"
52 #endif
54 Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
55 Lisp_Object Qdisplay_buffer;
56 Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
57 Lisp_Object Qwindow_size_fixed;
59 static int displayed_window_lines (struct window *);
60 static struct window *decode_window (Lisp_Object);
61 static int count_windows (struct window *);
62 static int get_leaf_windows (struct window *, struct window **, int);
63 static void window_scroll (Lisp_Object, int, int, int);
64 static void window_scroll_pixel_based (Lisp_Object, int, int, int);
65 static void window_scroll_line_based (Lisp_Object, int, int, int);
66 static int window_min_size_1 (struct window *, int, int);
67 static int window_min_size_2 (struct window *, int, int);
68 static int window_min_size (struct window *, int, int, int, int *);
69 static void size_window (Lisp_Object, int, int, int, int, int);
70 static int freeze_window_start (struct window *, void *);
71 static int window_fixed_size_p (struct window *, int, int);
72 static void enlarge_window (Lisp_Object, int, int);
73 static Lisp_Object window_list (void);
74 static int add_window_to_list (struct window *, void *);
75 static int candidate_window_p (Lisp_Object, Lisp_Object, Lisp_Object,
76 Lisp_Object);
77 static Lisp_Object next_window (Lisp_Object, Lisp_Object,
78 Lisp_Object, int);
79 static void decode_next_window_args (Lisp_Object *, Lisp_Object *,
80 Lisp_Object *);
81 static int foreach_window_1 (struct window *,
82 int (* fn) (struct window *, void *),
83 void *);
84 static Lisp_Object window_list_1 (Lisp_Object, Lisp_Object, Lisp_Object);
86 /* This is the window in which the terminal's cursor should
87 be left when nothing is being done with it. This must
88 always be a leaf window, and its buffer is selected by
89 the top level editing loop at the end of each command.
91 This value is always the same as
92 FRAME_SELECTED_WINDOW (selected_frame). */
94 Lisp_Object selected_window;
96 /* A list of all windows for use by next_window and Fwindow_list.
97 Functions creating or deleting windows should invalidate this cache
98 by setting it to nil. */
100 Lisp_Object Vwindow_list;
102 /* The mini-buffer window of the selected frame.
103 Note that you cannot test for mini-bufferness of an arbitrary window
104 by comparing against this; but you can test for mini-bufferness of
105 the selected window. */
107 Lisp_Object minibuf_window;
109 /* Non-nil means it is the window whose mode line should be
110 shown as the selected window when the minibuffer is selected. */
112 Lisp_Object minibuf_selected_window;
114 /* Non-nil means it is the window for C-M-v to scroll
115 when the mini-buffer is selected. */
117 Lisp_Object Vminibuf_scroll_window;
119 /* Non-nil means this is the buffer whose window C-M-v should scroll. */
121 Lisp_Object Vother_window_scroll_buffer;
123 /* Non-nil means it's function to call to display temp buffers. */
125 Lisp_Object Vtemp_buffer_show_function;
127 /* Non-zero means line and page scrolling on tall lines (with images)
128 does partial scrolling by modifying window-vscroll. */
130 int auto_window_vscroll_p;
132 /* Non-zero means to use mode-line-inactive face in all windows but the
133 selected-window and the minibuffer-scroll-window when the
134 minibuffer is active. */
135 int mode_line_in_non_selected_windows;
137 /* If a window gets smaller than either of these, it is removed. */
139 EMACS_INT window_min_height;
140 EMACS_INT window_min_width;
142 /* Hook run at end of temp_output_buffer_show. */
144 Lisp_Object Qtemp_buffer_show_hook;
146 /* Number of lines of continuity in scrolling by screenfuls. */
148 EMACS_INT next_screen_context_lines;
150 /* Incremented for each window created. */
152 static int sequence_number;
154 /* Nonzero after init_window_once has finished. */
156 static int window_initialized;
158 /* Hook to run when window config changes. */
160 static Lisp_Object Qwindow_configuration_change_hook;
161 static Lisp_Object Vwindow_configuration_change_hook;
163 /* Non-nil means scroll commands try to put point
164 at the same screen height as previously. */
166 Lisp_Object Vscroll_preserve_screen_position;
168 /* Non-nil means that text is inserted before window's markers. */
170 Lisp_Object Vwindow_point_insertion_type;
172 /* Incremented by 1 whenever a window is deleted. */
174 int window_deletion_count;
176 /* Used by the function window_scroll_pixel_based */
178 static int window_scroll_pixel_based_preserve_x;
179 static int window_scroll_pixel_based_preserve_y;
181 /* Same for window_scroll_line_based. */
183 static int window_scroll_preserve_hpos;
184 static int window_scroll_preserve_vpos;
186 #if 0 /* This isn't used anywhere. */
187 /* Nonzero means we can split a frame even if it is "unsplittable". */
188 static int inhibit_frame_unsplittable;
189 #endif /* 0 */
191 /* If non-nil, then the `recenter' command with a nil argument
192 the entire frame to be redrawn; the special value `tty' causes the
193 frame to be redrawn only if it is a tty frame. */
195 static Lisp_Object Vrecenter_redisplay;
198 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
199 doc: /* Return t if OBJECT is a window. */)
200 (Lisp_Object object)
202 return WINDOWP (object) ? Qt : Qnil;
205 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
206 doc: /* Return t if OBJECT is a window which is currently visible. */)
207 (Lisp_Object object)
209 return WINDOW_LIVE_P (object) ? Qt : Qnil;
212 Lisp_Object
213 make_window (void)
215 Lisp_Object val;
216 register struct window *p;
218 p = allocate_window ();
219 ++sequence_number;
220 XSETFASTINT (p->sequence_number, sequence_number);
221 XSETFASTINT (p->left_col, 0);
222 XSETFASTINT (p->top_line, 0);
223 XSETFASTINT (p->total_lines, 0);
224 XSETFASTINT (p->total_cols, 0);
225 XSETFASTINT (p->hscroll, 0);
226 XSETFASTINT (p->min_hscroll, 0);
227 p->orig_top_line = p->orig_total_lines = Qnil;
228 p->start = Fmake_marker ();
229 p->pointm = Fmake_marker ();
230 XSETFASTINT (p->use_time, 0);
231 p->frame = Qnil;
232 p->display_table = Qnil;
233 p->dedicated = Qnil;
234 p->window_parameters = Qnil;
235 p->pseudo_window_p = 0;
236 memset (&p->cursor, 0, sizeof (p->cursor));
237 memset (&p->last_cursor, 0, sizeof (p->last_cursor));
238 memset (&p->phys_cursor, 0, sizeof (p->phys_cursor));
239 p->desired_matrix = p->current_matrix = 0;
240 p->nrows_scale_factor = p->ncols_scale_factor = 1;
241 p->phys_cursor_type = -1;
242 p->phys_cursor_width = -1;
243 p->must_be_updated_p = 0;
244 XSETFASTINT (p->window_end_vpos, 0);
245 XSETFASTINT (p->window_end_pos, 0);
246 p->window_end_valid = Qnil;
247 p->vscroll = 0;
248 XSETWINDOW (val, p);
249 XSETFASTINT (p->last_point, 0);
250 p->frozen_window_start_p = 0;
251 p->last_cursor_off_p = p->cursor_off_p = 0;
252 p->left_margin_cols = Qnil;
253 p->right_margin_cols = Qnil;
254 p->left_fringe_width = Qnil;
255 p->right_fringe_width = Qnil;
256 p->fringes_outside_margins = Qnil;
257 p->scroll_bar_width = Qnil;
258 p->vertical_scroll_bar_type = Qt;
259 p->resize_proportionally = Qnil;
261 Vwindow_list = Qnil;
262 return val;
265 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
266 doc: /* Return the window that the cursor now appears in and commands apply to. */)
267 (void)
269 return selected_window;
272 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
273 doc: /* Return the window used now for minibuffers.
274 If the optional argument FRAME is specified, return the minibuffer window
275 used by that frame. */)
276 (Lisp_Object frame)
278 if (NILP (frame))
279 frame = selected_frame;
280 CHECK_LIVE_FRAME (frame);
281 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
284 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
285 doc: /* Return non-nil if WINDOW is a minibuffer window.
286 WINDOW defaults to the selected window. */)
287 (Lisp_Object window)
289 struct window *w = decode_window (window);
290 return MINI_WINDOW_P (w) ? Qt : Qnil;
294 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
295 Spos_visible_in_window_p, 0, 3, 0,
296 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
297 Return nil if that position is scrolled vertically out of view.
298 If a character is only partially visible, nil is returned, unless the
299 optional argument PARTIALLY is non-nil.
300 If POS is only out of view because of horizontal scrolling, return non-nil.
301 If POS is t, it specifies the position of the last visible glyph in WINDOW.
302 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
304 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
305 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
306 where X and Y are the pixel coordinates relative to the top left corner
307 of the window. The remaining elements are omitted if the character after
308 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
309 off-window at the top and bottom of the row, ROWH is the height of the
310 display row, and VPOS is the row number (0-based) containing POS. */)
311 (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
313 register struct window *w;
314 register EMACS_INT posint;
315 register struct buffer *buf;
316 struct text_pos top;
317 Lisp_Object in_window = Qnil;
318 int rtop, rbot, rowh, vpos, fully_p = 1;
319 int x, y;
321 w = decode_window (window);
322 buf = XBUFFER (w->buffer);
323 SET_TEXT_POS_FROM_MARKER (top, w->start);
325 if (EQ (pos, Qt))
326 posint = -1;
327 else if (!NILP (pos))
329 CHECK_NUMBER_COERCE_MARKER (pos);
330 posint = XINT (pos);
332 else if (w == XWINDOW (selected_window))
333 posint = PT;
334 else
335 posint = XMARKER (w->pointm)->charpos;
337 /* If position is above window start or outside buffer boundaries,
338 or if window start is out of range, position is not visible. */
339 if ((EQ (pos, Qt)
340 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
341 && CHARPOS (top) >= BUF_BEGV (buf)
342 && CHARPOS (top) <= BUF_ZV (buf)
343 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
344 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
345 in_window = Qt;
347 if (!NILP (in_window) && !NILP (partially))
349 Lisp_Object part = Qnil;
350 if (!fully_p)
351 part = list4 (make_number (rtop), make_number (rbot),
352 make_number (rowh), make_number (vpos));
353 in_window = Fcons (make_number (x),
354 Fcons (make_number (y), part));
357 return in_window;
360 DEFUN ("window-line-height", Fwindow_line_height,
361 Swindow_line_height, 0, 2, 0,
362 doc: /* Return height in pixels of text line LINE in window WINDOW.
363 If WINDOW is nil or omitted, use selected window.
365 Return height of current line if LINE is omitted or nil. Return height of
366 header or mode line if LINE is `header-line' and `mode-line'.
367 Otherwise, LINE is a text line number starting from 0. A negative number
368 counts from the end of the window.
370 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
371 in pixels of the visible part of the line, VPOS and YPOS are the
372 vertical position in lines and pixels of the line, relative to the top
373 of the first text line, and OFFBOT is the number of off-window pixels at
374 the bottom of the text line. If there are off-window pixels at the top
375 of the (first) text line, YPOS is negative.
377 Return nil if window display is not up-to-date. In that case, use
378 `pos-visible-in-window-p' to obtain the information. */)
379 (Lisp_Object line, Lisp_Object window)
381 register struct window *w;
382 register struct buffer *b;
383 struct glyph_row *row, *end_row;
384 int max_y, crop, i, n;
386 w = decode_window (window);
388 if (noninteractive
389 || w->pseudo_window_p)
390 return Qnil;
392 CHECK_BUFFER (w->buffer);
393 b = XBUFFER (w->buffer);
395 /* Fail if current matrix is not up-to-date. */
396 if (NILP (w->window_end_valid)
397 || current_buffer->clip_changed
398 || current_buffer->prevent_redisplay_optimizations_p
399 || XFASTINT (w->last_modified) < BUF_MODIFF (b)
400 || XFASTINT (w->last_overlay_modified) < BUF_OVERLAY_MODIFF (b))
401 return Qnil;
403 if (NILP (line))
405 i = w->cursor.vpos;
406 if (i < 0 || i >= w->current_matrix->nrows
407 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
408 return Qnil;
409 max_y = window_text_bottom_y (w);
410 goto found_row;
413 if (EQ (line, Qheader_line))
415 if (!WINDOW_WANTS_HEADER_LINE_P (w))
416 return Qnil;
417 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
418 if (!row->enabled_p)
419 return Qnil;
420 return list4 (make_number (row->height),
421 make_number (0), make_number (0),
422 make_number (0));
425 if (EQ (line, Qmode_line))
427 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
428 if (!row->enabled_p)
429 return Qnil;
430 return list4 (make_number (row->height),
431 make_number (0), /* not accurate */
432 make_number (WINDOW_HEADER_LINE_HEIGHT (w)
433 + window_text_bottom_y (w)),
434 make_number (0));
437 CHECK_NUMBER (line);
438 n = XINT (line);
440 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
441 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
442 max_y = window_text_bottom_y (w);
443 i = 0;
445 while ((n < 0 || i < n)
446 && row <= end_row && row->enabled_p
447 && row->y + row->height < max_y)
448 row++, i++;
450 if (row > end_row || !row->enabled_p)
451 return Qnil;
453 if (++n < 0)
455 if (-n > i)
456 return Qnil;
457 row += n;
458 i += n;
461 found_row:
462 crop = max (0, (row->y + row->height) - max_y);
463 return list4 (make_number (row->height + min (0, row->y) - crop),
464 make_number (i),
465 make_number (row->y),
466 make_number (crop));
471 static struct window *
472 decode_window (register Lisp_Object window)
474 if (NILP (window))
475 return XWINDOW (selected_window);
477 CHECK_LIVE_WINDOW (window);
478 return XWINDOW (window);
481 static struct window *
482 decode_any_window (register Lisp_Object window)
484 if (NILP (window))
485 return XWINDOW (selected_window);
487 CHECK_WINDOW (window);
488 return XWINDOW (window);
491 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
492 doc: /* Return the buffer that WINDOW is displaying.
493 WINDOW defaults to the selected window. */)
494 (Lisp_Object window)
496 return decode_window (window)->buffer;
499 DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
500 doc: /* Return the number of lines in WINDOW.
501 WINDOW defaults to the selected window.
503 The return value includes WINDOW's mode line and header line, if any.
505 Note: The function does not take into account the value of `line-spacing'
506 when calculating the number of lines in WINDOW. */)
507 (Lisp_Object window)
509 return decode_any_window (window)->total_lines;
512 DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
513 doc: /* Return the number of display columns in WINDOW.
514 WINDOW defaults to the selected window.
516 Note: The return value is the number of columns available for text in
517 WINDOW. If you want to find out how many columns WINDOW takes up, use
518 (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))). */)
519 (Lisp_Object window)
521 return make_number (window_box_text_cols (decode_any_window (window)));
524 DEFUN ("window-full-width-p", Fwindow_full_width_p, Swindow_full_width_p, 0, 1, 0,
525 doc: /* Return t if WINDOW is as wide as its frame.
526 WINDOW defaults to the selected window. */)
527 (Lisp_Object window)
529 return WINDOW_FULL_WIDTH_P (decode_any_window (window)) ? Qt : Qnil;
532 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
533 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
534 WINDOW defaults to the selected window. */)
535 (Lisp_Object window)
537 return decode_window (window)->hscroll;
540 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
541 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
542 Return NCOL. NCOL should be zero or positive.
544 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
545 window so that the location of point moves off-window. */)
546 (Lisp_Object window, Lisp_Object ncol)
548 struct window *w = decode_window (window);
549 int hscroll;
551 CHECK_NUMBER (ncol);
552 hscroll = max (0, XINT (ncol));
554 /* Prevent redisplay shortcuts when changing the hscroll. */
555 if (XINT (w->hscroll) != hscroll)
556 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
558 w->hscroll = make_number (hscroll);
559 return ncol;
562 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
563 Swindow_redisplay_end_trigger, 0, 1, 0,
564 doc: /* Return WINDOW's redisplay end trigger value.
565 WINDOW defaults to the selected window.
566 See `set-window-redisplay-end-trigger' for more information. */)
567 (Lisp_Object window)
569 return decode_window (window)->redisplay_end_trigger;
572 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
573 Sset_window_redisplay_end_trigger, 2, 2, 0,
574 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
575 VALUE should be a buffer position (typically a marker) or nil.
576 If it is a buffer position, then if redisplay in WINDOW reaches a position
577 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
578 with two arguments: WINDOW, and the end trigger value.
579 Afterwards the end-trigger value is reset to nil. */)
580 (register Lisp_Object window, Lisp_Object value)
582 register struct window *w;
584 w = decode_window (window);
585 w->redisplay_end_trigger = value;
586 return value;
589 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
590 doc: /* Return a list of the edge coordinates of WINDOW.
591 The list has the form (LEFT TOP RIGHT BOTTOM).
592 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
593 all relative to 0, 0 at top left corner of frame.
595 RIGHT is one more than the rightmost column occupied by WINDOW.
596 BOTTOM is one more than the bottommost row occupied by WINDOW.
597 The edges include the space used by WINDOW's scroll bar, display
598 margins, fringes, header line, and/or mode line. For the edges of
599 just the text area, use `window-inside-edges'. */)
600 (Lisp_Object window)
602 register struct window *w = decode_any_window (window);
604 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
605 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
606 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
607 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
608 Qnil))));
611 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_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 frame.
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-pixel-edges'. */)
621 (Lisp_Object window)
623 register struct window *w = decode_any_window (window);
625 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
626 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
627 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
628 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
629 Qnil))));
632 static void
633 calc_absolute_offset(struct window *w, int *add_x, int *add_y)
635 struct frame *f = XFRAME (w->frame);
636 *add_y = f->top_pos;
637 #ifdef FRAME_MENUBAR_HEIGHT
638 *add_y += FRAME_MENUBAR_HEIGHT (f);
639 #endif
640 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
641 *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
642 #elif FRAME_TOOLBAR_HEIGHT
643 *add_y += FRAME_TOOLBAR_HEIGHT (f);
644 #endif
645 #ifdef FRAME_NS_TITLEBAR_HEIGHT
646 *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
647 #endif
648 *add_x = f->left_pos;
649 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
650 *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
651 #endif
654 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
655 Swindow_absolute_pixel_edges, 0, 1, 0,
656 doc: /* Return a list of the edge pixel coordinates of WINDOW.
657 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
658 the top left corner of the display.
660 RIGHT is one more than the rightmost x position occupied by WINDOW.
661 BOTTOM is one more than the bottommost y position occupied by WINDOW.
662 The pixel edges include the space used by WINDOW's scroll bar, display
663 margins, fringes, header line, and/or mode line. For the pixel edges
664 of just the text area, use `window-inside-absolute-pixel-edges'. */)
665 (Lisp_Object window)
667 register struct window *w = decode_any_window (window);
668 int add_x, add_y;
669 calc_absolute_offset (w, &add_x, &add_y);
671 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w) + add_x),
672 Fcons (make_number (WINDOW_TOP_EDGE_Y (w) + add_y),
673 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w) + add_x),
674 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w) + add_y),
675 Qnil))));
678 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
679 doc: /* Return a list of the edge coordinates of WINDOW.
680 The list has the form (LEFT TOP RIGHT BOTTOM).
681 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
682 all relative to 0, 0 at top left corner of frame.
684 RIGHT is one more than the rightmost column of WINDOW's text area.
685 BOTTOM is one more than the bottommost row of WINDOW's text area.
686 The inside edges do not include the space used by the WINDOW's scroll
687 bar, display margins, fringes, header line, and/or mode line. */)
688 (Lisp_Object window)
690 register struct window *w = decode_any_window (window);
692 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
693 + WINDOW_LEFT_MARGIN_COLS (w)
694 + WINDOW_LEFT_FRINGE_COLS (w)),
695 make_number (WINDOW_TOP_EDGE_LINE (w)
696 + WINDOW_HEADER_LINE_LINES (w)),
697 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
698 - WINDOW_RIGHT_MARGIN_COLS (w)
699 - WINDOW_RIGHT_FRINGE_COLS (w)),
700 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
701 - WINDOW_MODE_LINE_LINES (w)));
704 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
705 doc: /* Return a list of the edge pixel coordinates of WINDOW.
706 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
707 the top left corner of the frame.
709 RIGHT is one more than the rightmost x position of WINDOW's text area.
710 BOTTOM is one more than the bottommost y position of WINDOW's text area.
711 The inside edges do not include the space used by WINDOW's scroll bar,
712 display margins, fringes, header line, and/or mode line. */)
713 (Lisp_Object window)
715 register struct window *w = decode_any_window (window);
717 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
718 + WINDOW_LEFT_MARGIN_WIDTH (w)
719 + WINDOW_LEFT_FRINGE_WIDTH (w)),
720 make_number (WINDOW_TOP_EDGE_Y (w)
721 + WINDOW_HEADER_LINE_HEIGHT (w)),
722 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
723 - WINDOW_RIGHT_MARGIN_WIDTH (w)
724 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
725 make_number (WINDOW_BOTTOM_EDGE_Y (w)
726 - WINDOW_MODE_LINE_HEIGHT (w)));
729 DEFUN ("window-inside-absolute-pixel-edges",
730 Fwindow_inside_absolute_pixel_edges,
731 Swindow_inside_absolute_pixel_edges, 0, 1, 0,
732 doc: /* Return a list of the edge pixel coordinates of WINDOW.
733 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
734 the top left corner of the display.
736 RIGHT is one more than the rightmost x position of WINDOW's text area.
737 BOTTOM is one more than the bottommost y position of WINDOW's text area.
738 The inside edges do not include the space used by WINDOW's scroll bar,
739 display margins, fringes, header line, and/or mode line. */)
740 (Lisp_Object window)
742 register struct window *w = decode_any_window (window);
743 int add_x, add_y;
744 calc_absolute_offset (w, &add_x, &add_y);
746 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
747 + WINDOW_LEFT_MARGIN_WIDTH (w)
748 + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
749 make_number (WINDOW_TOP_EDGE_Y (w)
750 + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
751 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
752 - WINDOW_RIGHT_MARGIN_WIDTH (w)
753 - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
754 make_number (WINDOW_BOTTOM_EDGE_Y (w)
755 - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
758 /* Test if the character at column *X, row *Y is within window W.
759 If it is not, return ON_NOTHING;
760 if it is in the window's text area,
761 set *x and *y to its location relative to the upper left corner
762 of the window, and
763 return ON_TEXT;
764 if it is on the window's modeline, return ON_MODE_LINE;
765 if it is on the border between the window and its right sibling,
766 return ON_VERTICAL_BORDER.
767 if it is on a scroll bar,
768 return ON_SCROLL_BAR.
769 if it is on the window's top line, return ON_HEADER_LINE;
770 if it is in left or right fringe of the window,
771 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE, and convert *X and *Y
772 to window-relative coordinates;
773 if it is in the marginal area to the left/right of the window,
774 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN, and convert *X and *Y
775 to window-relative coordinates.
777 X and Y are frame relative pixel coordinates. */
779 static enum window_part
780 coordinates_in_window (register struct window *w, register int *x, register int *y)
782 struct frame *f = XFRAME (WINDOW_FRAME (w));
783 int left_x, right_x, top_y, bottom_y;
784 enum window_part part;
785 int ux = FRAME_COLUMN_WIDTH (f);
786 int x0 = WINDOW_LEFT_EDGE_X (w);
787 int x1 = WINDOW_RIGHT_EDGE_X (w);
788 /* The width of the area where the vertical line can be dragged.
789 (Between mode lines for instance. */
790 int grabbable_width = ux;
791 int lmargin_width, rmargin_width, text_left, text_right;
793 /* In what's below, we subtract 1 when computing right_x because we
794 want the rightmost pixel, which is given by left_pixel+width-1. */
795 if (w->pseudo_window_p)
797 left_x = 0;
798 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
799 top_y = WINDOW_TOP_EDGE_Y (w);
800 bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
802 else
804 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
805 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
806 top_y = WINDOW_TOP_EDGE_Y (w);
807 bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
810 /* Outside any interesting row? */
811 if (*y < top_y || *y >= bottom_y)
812 return ON_NOTHING;
814 /* On the mode line or header line? If it's near the start of
815 the mode or header line of window that's has a horizontal
816 sibling, say it's on the vertical line. That's to be able
817 to resize windows horizontally in case we're using toolkit
818 scroll bars. */
820 if (WINDOW_WANTS_MODELINE_P (w)
821 && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
823 part = ON_MODE_LINE;
825 header_vertical_border_check:
826 /* We're somewhere on the mode line. We consider the place
827 between mode lines of horizontally adjacent mode lines
828 as the vertical border. If scroll bars on the left,
829 return the right window. */
830 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
831 || WINDOW_RIGHTMOST_P (w))
833 if (!WINDOW_LEFTMOST_P (w) && eabs (*x - x0) < grabbable_width)
835 /* Convert X and Y to window relative coordinates.
836 Vertical border is at the left edge of window. */
837 *x = max (0, *x - x0);
838 *y -= top_y;
839 return ON_VERTICAL_BORDER;
842 else
844 /* Make sure we're not at the rightmost position of a
845 mode-/header-line and there's yet another window on
846 the right. (Bug#1372) */
847 if ((WINDOW_RIGHTMOST_P (w) || *x < x1)
848 && eabs (*x - x1) < grabbable_width)
850 /* Convert X and Y to window relative coordinates.
851 Vertical border is at the right edge of window. */
852 *x = min (x1, *x) - x0;
853 *y -= top_y;
854 return ON_VERTICAL_BORDER;
858 if (*x < x0 || *x >= x1)
859 return ON_NOTHING;
861 /* Convert X and Y to window relative coordinates.
862 Mode line starts at left edge of window. */
863 *x -= x0;
864 *y -= top_y;
865 return part;
868 if (WINDOW_WANTS_HEADER_LINE_P (w)
869 && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
871 part = ON_HEADER_LINE;
872 goto header_vertical_border_check;
875 if (*x < x0 || *x >= x1)
876 return ON_NOTHING;
878 /* Outside any interesting column? */
879 if (*x < left_x || *x > right_x)
881 *y -= top_y;
882 return ON_SCROLL_BAR;
885 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
886 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
888 text_left = window_box_left (w, TEXT_AREA);
889 text_right = text_left + window_box_width (w, TEXT_AREA);
891 if (FRAME_WINDOW_P (f))
893 if (!w->pseudo_window_p
894 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
895 && !WINDOW_RIGHTMOST_P (w)
896 && (eabs (*x - right_x) < grabbable_width))
898 /* Convert X and Y to window relative coordinates.
899 Vertical border is at the right edge of window. */
900 *x = min (right_x, *x) - left_x;
901 *y -= top_y;
902 return ON_VERTICAL_BORDER;
905 else
907 /* Need to say "*x > right_x" rather than >=, since on character
908 terminals, the vertical line's x coordinate is right_x. */
909 if (!w->pseudo_window_p
910 && !WINDOW_RIGHTMOST_P (w)
911 && *x > right_x - ux)
913 /* On the border on the right side of the window? Assume that
914 this area begins at RIGHT_X minus a canonical char width. */
915 *x = min (right_x, *x) - left_x;
916 *y -= top_y;
917 return ON_VERTICAL_BORDER;
921 if (*x < text_left)
923 if (lmargin_width > 0
924 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
925 ? (*x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
926 : (*x < left_x + lmargin_width)))
928 *x -= left_x;
929 if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
930 *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
931 *y -= top_y;
932 return ON_LEFT_MARGIN;
935 /* Convert X and Y to window-relative pixel coordinates. */
936 *x -= left_x;
937 *y -= top_y;
938 return ON_LEFT_FRINGE;
941 if (*x >= text_right)
943 if (rmargin_width > 0
944 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
945 ? (*x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
946 : (*x >= right_x - rmargin_width)))
948 *x -= right_x - rmargin_width;
949 if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
950 *x += WINDOW_RIGHT_FRINGE_WIDTH (w);
951 *y -= top_y;
952 return ON_RIGHT_MARGIN;
955 /* Convert X and Y to window-relative pixel coordinates. */
956 *x -= left_x + WINDOW_LEFT_FRINGE_WIDTH (w);
957 *y -= top_y;
958 return ON_RIGHT_FRINGE;
961 /* Everything special ruled out - must be on text area */
962 *x -= text_left;
963 *y -= top_y;
964 return ON_TEXT;
968 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
969 Scoordinates_in_window_p, 2, 2, 0,
970 doc: /* Return non-nil if COORDINATES are in WINDOW.
971 COORDINATES is a cons of the form (X . Y), X and Y being distances
972 measured in characters from the upper-left corner of the frame.
973 \(0 . 0) denotes the character in the upper left corner of the
974 frame.
975 If COORDINATES are in the text portion of WINDOW,
976 the coordinates relative to the window are returned.
977 If they are in the mode line of WINDOW, `mode-line' is returned.
978 If they are in the top mode line of WINDOW, `header-line' is returned.
979 If they are in the left fringe of WINDOW, `left-fringe' is returned.
980 If they are in the right fringe of WINDOW, `right-fringe' is returned.
981 If they are on the border between WINDOW and its right sibling,
982 `vertical-line' is returned.
983 If they are in the windows's left or right marginal areas, `left-margin'\n\
984 or `right-margin' is returned. */)
985 (register Lisp_Object coordinates, Lisp_Object window)
987 struct window *w;
988 struct frame *f;
989 int x, y;
990 Lisp_Object lx, ly;
992 CHECK_WINDOW (window);
993 w = XWINDOW (window);
994 f = XFRAME (w->frame);
995 CHECK_CONS (coordinates);
996 lx = Fcar (coordinates);
997 ly = Fcdr (coordinates);
998 CHECK_NUMBER_OR_FLOAT (lx);
999 CHECK_NUMBER_OR_FLOAT (ly);
1000 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
1001 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
1003 switch (coordinates_in_window (w, &x, &y))
1005 case ON_NOTHING:
1006 return Qnil;
1008 case ON_TEXT:
1009 /* X and Y are now window relative pixel coordinates. Convert
1010 them to canonical char units before returning them. */
1011 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
1012 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
1014 case ON_MODE_LINE:
1015 return Qmode_line;
1017 case ON_VERTICAL_BORDER:
1018 return Qvertical_line;
1020 case ON_HEADER_LINE:
1021 return Qheader_line;
1023 case ON_LEFT_FRINGE:
1024 return Qleft_fringe;
1026 case ON_RIGHT_FRINGE:
1027 return Qright_fringe;
1029 case ON_LEFT_MARGIN:
1030 return Qleft_margin;
1032 case ON_RIGHT_MARGIN:
1033 return Qright_margin;
1035 case ON_SCROLL_BAR:
1036 /* Historically we are supposed to return nil in this case. */
1037 return Qnil;
1039 default:
1040 abort ();
1045 /* Callback for foreach_window, used in window_from_coordinates.
1046 Check if window W contains coordinates specified by USER_DATA which
1047 is actually a pointer to a struct check_window_data CW.
1049 Check if window W contains coordinates *CW->x and *CW->y. If it
1050 does, return W in *CW->window, as Lisp_Object, and return in
1051 *CW->part the part of the window under coordinates *X,*Y. Return
1052 zero from this function to stop iterating over windows. */
1054 struct check_window_data
1056 Lisp_Object *window;
1057 int *x, *y;
1058 enum window_part *part;
1061 static int
1062 check_window_containing (struct window *w, void *user_data)
1064 struct check_window_data *cw = (struct check_window_data *) user_data;
1065 enum window_part found;
1066 int continue_p = 1;
1068 found = coordinates_in_window (w, cw->x, cw->y);
1069 if (found != ON_NOTHING)
1071 *cw->part = found;
1072 XSETWINDOW (*cw->window, w);
1073 continue_p = 0;
1076 return continue_p;
1080 /* Find the window containing frame-relative pixel position X/Y and
1081 return it as a Lisp_Object.
1083 If X, Y is on one of the window's special `window_part' elements,
1084 set *PART to the id of that element, and return X and Y converted
1085 to window relative coordinates in WX and WY.
1087 If there is no window under X, Y return nil and leave *PART
1088 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1090 This function was previously implemented with a loop cycling over
1091 windows with Fnext_window, and starting with the frame's selected
1092 window. It turned out that this doesn't work with an
1093 implementation of next_window using Vwindow_list, because
1094 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1095 tree of F when this function is called asynchronously from
1096 note_mouse_highlight. The original loop didn't terminate in this
1097 case. */
1099 Lisp_Object
1100 window_from_coordinates (struct frame *f, int x, int y, enum window_part *part, int *wx, int *wy, int tool_bar_p)
1102 Lisp_Object window;
1103 struct check_window_data cw;
1104 enum window_part dummy;
1106 if (part == 0)
1107 part = &dummy;
1109 window = Qnil;
1110 cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
1111 foreach_window (f, check_window_containing, &cw);
1113 /* If not found above, see if it's in the tool bar window, if a tool
1114 bar exists. */
1115 if (NILP (window)
1116 && tool_bar_p
1117 && WINDOWP (f->tool_bar_window)
1118 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1119 && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
1120 != ON_NOTHING))
1122 *part = ON_TEXT;
1123 window = f->tool_bar_window;
1126 if (wx) *wx = x;
1127 if (wy) *wy = y;
1129 return window;
1132 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1133 doc: /* Return window containing coordinates X and Y on FRAME.
1134 If omitted, FRAME defaults to the currently selected frame.
1135 The top left corner of the frame is considered to be row 0,
1136 column 0. */)
1137 (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
1139 struct frame *f;
1141 if (NILP (frame))
1142 frame = selected_frame;
1143 CHECK_LIVE_FRAME (frame);
1144 f = XFRAME (frame);
1146 /* Check that arguments are integers or floats. */
1147 CHECK_NUMBER_OR_FLOAT (x);
1148 CHECK_NUMBER_OR_FLOAT (y);
1150 return window_from_coordinates (f,
1151 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1152 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1153 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1154 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1155 0, 0, 0, 0);
1158 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1159 doc: /* Return current value of point in WINDOW.
1160 WINDOW defaults to the selected window.
1162 For a nonselected window, this is the value point would have
1163 if that window were selected.
1165 Note that, when WINDOW is the selected window and its buffer
1166 is also currently selected, the value returned is the same as (point).
1167 It would be more strictly correct to return the `top-level' value
1168 of point, outside of any save-excursion forms.
1169 But that is hard to define. */)
1170 (Lisp_Object window)
1172 register struct window *w = decode_window (window);
1174 if (w == XWINDOW (selected_window)
1175 && current_buffer == XBUFFER (w->buffer))
1176 return Fpoint ();
1177 return Fmarker_position (w->pointm);
1180 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1181 doc: /* Return position at which display currently starts in WINDOW.
1182 WINDOW defaults to the selected window.
1183 This is updated by redisplay or by calling `set-window-start'. */)
1184 (Lisp_Object window)
1186 return Fmarker_position (decode_window (window)->start);
1189 /* This is text temporarily removed from the doc string below.
1191 This function returns nil if the position is not currently known.
1192 That happens when redisplay is preempted and doesn't finish.
1193 If in that case you want to compute where the end of the window would
1194 have been if redisplay had finished, do this:
1195 (save-excursion
1196 (goto-char (window-start window))
1197 (vertical-motion (1- (window-height window)) window)
1198 (point))") */
1200 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1201 doc: /* Return position at which display currently ends in WINDOW.
1202 WINDOW defaults to the selected window.
1203 This is updated by redisplay, when it runs to completion.
1204 Simply changing the buffer text or setting `window-start'
1205 does not update this value.
1206 Return nil if there is no recorded value. \(This can happen if the
1207 last redisplay of WINDOW was preempted, and did not finish.)
1208 If UPDATE is non-nil, compute the up-to-date position
1209 if it isn't already recorded. */)
1210 (Lisp_Object window, Lisp_Object update)
1212 Lisp_Object value;
1213 struct window *w = decode_window (window);
1214 Lisp_Object buf;
1215 struct buffer *b;
1217 buf = w->buffer;
1218 CHECK_BUFFER (buf);
1219 b = XBUFFER (buf);
1221 #if 0 /* This change broke some things. We should make it later. */
1222 /* If we don't know the end position, return nil.
1223 The user can compute it with vertical-motion if he wants to.
1224 It would be nicer to do it automatically,
1225 but that's so slow that it would probably bother people. */
1226 if (NILP (w->window_end_valid))
1227 return Qnil;
1228 #endif
1230 if (! NILP (update)
1231 && ! (! NILP (w->window_end_valid)
1232 && XFASTINT (w->last_modified) >= BUF_MODIFF (b)
1233 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (b))
1234 && !noninteractive)
1236 struct text_pos startp;
1237 struct it it;
1238 struct buffer *old_buffer = NULL;
1240 /* Cannot use Fvertical_motion because that function doesn't
1241 cope with variable-height lines. */
1242 if (b != current_buffer)
1244 old_buffer = current_buffer;
1245 set_buffer_internal (b);
1248 /* In case W->start is out of the range, use something
1249 reasonable. This situation occurred when loading a file with
1250 `-l' containing a call to `rmail' with subsequent other
1251 commands. At the end, W->start happened to be BEG, while
1252 rmail had already narrowed the buffer. */
1253 if (XMARKER (w->start)->charpos < BEGV)
1254 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1255 else if (XMARKER (w->start)->charpos > ZV)
1256 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1257 else
1258 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1260 start_display (&it, w, startp);
1261 move_it_vertically (&it, window_box_height (w));
1262 if (it.current_y < it.last_visible_y)
1263 move_it_past_eol (&it);
1264 value = make_number (IT_CHARPOS (it));
1266 if (old_buffer)
1267 set_buffer_internal (old_buffer);
1269 else
1270 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1272 return value;
1275 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1276 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1277 Return POS. */)
1278 (Lisp_Object window, Lisp_Object pos)
1280 register struct window *w = decode_window (window);
1282 CHECK_NUMBER_COERCE_MARKER (pos);
1283 if (w == XWINDOW (selected_window)
1284 && XBUFFER (w->buffer) == current_buffer)
1285 Fgoto_char (pos);
1286 else
1287 set_marker_restricted (w->pointm, pos, w->buffer);
1289 /* We have to make sure that redisplay updates the window to show
1290 the new value of point. */
1291 if (!EQ (window, selected_window))
1292 ++windows_or_buffers_changed;
1294 return pos;
1297 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1298 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1299 WINDOW defaults to the selected window. Return POS.
1300 Optional third arg NOFORCE non-nil inhibits next redisplay from
1301 overriding motion of point in order to display at this exact start. */)
1302 (Lisp_Object window, Lisp_Object pos, Lisp_Object noforce)
1304 register struct window *w = decode_window (window);
1306 CHECK_NUMBER_COERCE_MARKER (pos);
1307 set_marker_restricted (w->start, pos, w->buffer);
1308 /* this is not right, but much easier than doing what is right. */
1309 w->start_at_line_beg = Qnil;
1310 if (NILP (noforce))
1311 w->force_start = Qt;
1312 w->update_mode_line = Qt;
1313 XSETFASTINT (w->last_modified, 0);
1314 XSETFASTINT (w->last_overlay_modified, 0);
1315 if (!EQ (window, selected_window))
1316 windows_or_buffers_changed++;
1318 return pos;
1322 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1323 0, 1, 0,
1324 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1325 More precisely, return the value assigned by the last call of
1326 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1327 never called with WINDOW as its argument, or the value set by that
1328 function was internally reset since its last call. WINDOW defaults to
1329 the selected window.
1331 When a window is dedicated to its buffer, `display-buffer' will refrain
1332 from displaying another buffer in it. `get-lru-window' and
1333 `get-largest-window' treat dedicated windows specially.
1334 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1335 `kill-buffer' can delete a dedicated window and the containing frame.
1337 Functions like `set-window-buffer' may change the buffer displayed by a
1338 window, unless that window is "strongly" dedicated to its buffer, that
1339 is the value returned by `window-dedicated-p' is t. */)
1340 (Lisp_Object window)
1342 return decode_window (window)->dedicated;
1345 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1346 Sset_window_dedicated_p, 2, 2, 0,
1347 doc: /* Mark WINDOW as dedicated according to FLAG.
1348 WINDOW defaults to the selected window. FLAG non-nil means mark WINDOW
1349 as dedicated to its buffer. FLAG nil means mark WINDOW as non-dedicated.
1350 Return FLAG.
1352 When a window is dedicated to its buffer, `display-buffer' will refrain
1353 from displaying another buffer in it. `get-lru-window' and
1354 `get-largest-window' treat dedicated windows specially.
1355 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1356 `kill-buffer' can delete a dedicated window and the containing
1357 frame.
1359 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1360 its buffer. Functions like `set-window-buffer' may change the buffer
1361 displayed by a window, unless that window is strongly dedicated to its
1362 buffer. If and when `set-window-buffer' displays another buffer in a
1363 window, it also makes sure that the window is not marked as dedicated. */)
1364 (Lisp_Object window, Lisp_Object flag)
1366 register struct window *w = decode_window (window);
1368 w->dedicated = flag;
1369 return w->dedicated;
1373 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1374 0, 1, 0,
1375 doc: /* Return the parameters of WINDOW and their values.
1376 WINDOW defaults to the selected window. The return value is a list of
1377 elements of the form (PARAMETER . VALUE). */)
1378 (Lisp_Object window)
1380 return Fcopy_alist (decode_window (window)->window_parameters);
1383 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1384 2, 2, 0,
1385 doc: /* Return WINDOW's value for PARAMETER.
1386 WINDOW defaults to the selected window. */)
1387 (Lisp_Object window, Lisp_Object parameter)
1389 Lisp_Object result;
1391 result = Fassq (parameter, decode_window (window)->window_parameters);
1392 return CDR_SAFE (result);
1395 DEFUN ("set-window-parameter", Fset_window_parameter,
1396 Sset_window_parameter, 3, 3, 0,
1397 doc: /* Set WINDOW's value of PARAMETER to VALUE.
1398 WINDOW defaults to the selected window. Return VALUE. */)
1399 (Lisp_Object window, Lisp_Object parameter, Lisp_Object value)
1401 register struct window *w = decode_window (window);
1402 Lisp_Object old_alist_elt;
1404 old_alist_elt = Fassq (parameter, w->window_parameters);
1405 if (NILP (old_alist_elt))
1406 w->window_parameters = Fcons (Fcons (parameter, value), w->window_parameters);
1407 else
1408 Fsetcdr (old_alist_elt, value);
1409 return value;
1413 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1414 0, 1, 0,
1415 doc: /* Return the display-table that WINDOW is using.
1416 WINDOW defaults to the selected window. */)
1417 (Lisp_Object window)
1419 return decode_window (window)->display_table;
1422 /* Get the display table for use on window W. This is either W's
1423 display table or W's buffer's display table. Ignore the specified
1424 tables if they are not valid; if no valid table is specified,
1425 return 0. */
1427 struct Lisp_Char_Table *
1428 window_display_table (struct window *w)
1430 struct Lisp_Char_Table *dp = NULL;
1432 if (DISP_TABLE_P (w->display_table))
1433 dp = XCHAR_TABLE (w->display_table);
1434 else if (BUFFERP (w->buffer))
1436 struct buffer *b = XBUFFER (w->buffer);
1438 if (DISP_TABLE_P (b->display_table))
1439 dp = XCHAR_TABLE (b->display_table);
1440 else if (DISP_TABLE_P (Vstandard_display_table))
1441 dp = XCHAR_TABLE (Vstandard_display_table);
1444 return dp;
1447 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1448 doc: /* Set WINDOW's display-table to TABLE. */)
1449 (register Lisp_Object window, Lisp_Object table)
1451 register struct window *w;
1453 w = decode_window (window);
1454 w->display_table = table;
1455 return table;
1458 /* Record info on buffer window w is displaying
1459 when it is about to cease to display that buffer. */
1460 static void
1461 unshow_buffer (register struct window *w)
1463 Lisp_Object buf;
1464 struct buffer *b;
1466 buf = w->buffer;
1467 b = XBUFFER (buf);
1468 if (b != XMARKER (w->pointm)->buffer)
1469 abort ();
1471 #if 0
1472 if (w == XWINDOW (selected_window)
1473 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1474 /* Do this except when the selected window's buffer
1475 is being removed from some other window. */
1476 #endif
1477 /* last_window_start records the start position that this buffer
1478 had in the last window to be disconnected from it.
1479 Now that this statement is unconditional,
1480 it is possible for the buffer to be displayed in the
1481 selected window, while last_window_start reflects another
1482 window which was recently showing the same buffer.
1483 Some people might say that might be a good thing. Let's see. */
1484 b->last_window_start = marker_position (w->start);
1486 /* Point in the selected window's buffer
1487 is actually stored in that buffer, and the window's pointm isn't used.
1488 So don't clobber point in that buffer. */
1489 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1490 /* This line helps to fix Horsley's testbug.el bug. */
1491 && !(WINDOWP (b->last_selected_window)
1492 && w != XWINDOW (b->last_selected_window)
1493 && EQ (buf, XWINDOW (b->last_selected_window)->buffer)))
1494 temp_set_point_both (b,
1495 clip_to_bounds (BUF_BEGV (b),
1496 XMARKER (w->pointm)->charpos,
1497 BUF_ZV (b)),
1498 clip_to_bounds (BUF_BEGV_BYTE (b),
1499 marker_byte_position (w->pointm),
1500 BUF_ZV_BYTE (b)));
1502 if (WINDOWP (b->last_selected_window)
1503 && w == XWINDOW (b->last_selected_window))
1504 b->last_selected_window = Qnil;
1507 /* Put replacement into the window structure in place of old. */
1508 static void
1509 replace_window (Lisp_Object old, Lisp_Object replacement)
1511 register Lisp_Object tem;
1512 register struct window *o = XWINDOW (old), *p = XWINDOW (replacement);
1514 /* If OLD is its frame's root_window, then replacement is the new
1515 root_window for that frame. */
1517 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1518 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
1520 p->left_col = o->left_col;
1521 p->top_line = o->top_line;
1522 p->total_cols = o->total_cols;
1523 p->total_lines = o->total_lines;
1524 p->desired_matrix = p->current_matrix = 0;
1525 p->vscroll = 0;
1526 memset (&p->cursor, 0, sizeof (p->cursor));
1527 memset (&p->last_cursor, 0, sizeof (p->last_cursor));
1528 memset (&p->phys_cursor, 0, sizeof (p->phys_cursor));
1529 p->phys_cursor_type = -1;
1530 p->phys_cursor_width = -1;
1531 p->must_be_updated_p = 0;
1532 p->pseudo_window_p = 0;
1533 XSETFASTINT (p->window_end_vpos, 0);
1534 XSETFASTINT (p->window_end_pos, 0);
1535 p->window_end_valid = Qnil;
1536 p->frozen_window_start_p = 0;
1537 p->orig_top_line = p->orig_total_lines = Qnil;
1539 p->next = tem = o->next;
1540 if (!NILP (tem))
1541 XWINDOW (tem)->prev = replacement;
1543 p->prev = tem = o->prev;
1544 if (!NILP (tem))
1545 XWINDOW (tem)->next = replacement;
1547 p->parent = tem = o->parent;
1548 if (!NILP (tem))
1550 if (EQ (XWINDOW (tem)->vchild, old))
1551 XWINDOW (tem)->vchild = replacement;
1552 if (EQ (XWINDOW (tem)->hchild, old))
1553 XWINDOW (tem)->hchild = replacement;
1556 /*** Here, if replacement is a vertical combination
1557 and so is its new parent, we should make replacement's
1558 children be children of that parent instead. ***/
1561 DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
1562 doc: /* Remove WINDOW from its frame.
1563 WINDOW defaults to the selected window. Return nil.
1564 Signal an error when WINDOW is the only window on its frame. */)
1565 (register Lisp_Object window)
1567 struct frame *f;
1568 if (NILP (window))
1569 window = selected_window;
1570 else
1571 CHECK_LIVE_WINDOW (window);
1573 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1574 delete_window (window);
1576 run_window_configuration_change_hook (f);
1578 return Qnil;
1581 void
1582 delete_window (register Lisp_Object window)
1584 register Lisp_Object tem, parent, sib;
1585 register struct window *p;
1586 register struct window *par;
1587 struct frame *f;
1589 /* Because this function is called by other C code on non-leaf
1590 windows, the CHECK_LIVE_WINDOW macro would choke inappropriately,
1591 so we can't decode_window here. */
1592 CHECK_WINDOW (window);
1593 p = XWINDOW (window);
1595 /* It's a no-op to delete an already-deleted window. */
1596 if (NILP (p->buffer)
1597 && NILP (p->hchild)
1598 && NILP (p->vchild))
1599 return;
1601 parent = p->parent;
1602 if (NILP (parent))
1603 error ("Attempt to delete minibuffer or sole ordinary window");
1604 par = XWINDOW (parent);
1606 windows_or_buffers_changed++;
1607 Vwindow_list = Qnil;
1608 f = XFRAME (WINDOW_FRAME (p));
1609 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
1611 /* Are we trying to delete any frame's selected window? */
1613 Lisp_Object swindow, pwindow;
1615 /* See if the frame's selected window is either WINDOW
1616 or any subwindow of it, by finding all that window's parents
1617 and comparing each one with WINDOW. */
1618 swindow = FRAME_SELECTED_WINDOW (f);
1620 while (1)
1622 pwindow = swindow;
1623 while (!NILP (pwindow))
1625 if (EQ (window, pwindow))
1626 break;
1627 pwindow = XWINDOW (pwindow)->parent;
1630 /* If the window being deleted is not a parent of SWINDOW,
1631 then SWINDOW is ok as the new selected window. */
1632 if (!EQ (window, pwindow))
1633 break;
1634 /* Otherwise, try another window for SWINDOW. */
1635 swindow = Fnext_window (swindow, Qlambda, Qnil);
1637 /* If we get back to the frame's selected window,
1638 it means there was no acceptable alternative,
1639 so we cannot delete. */
1640 if (EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1641 error ("Cannot delete window");
1644 /* If we need to change SWINDOW, do it. */
1645 if (! EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1647 /* If we're about to delete the selected window on the
1648 selected frame, then we should use Fselect_window to select
1649 the new window. On the other hand, if we're about to
1650 delete the selected window on any other frame, we shouldn't do
1651 anything but set the frame's selected_window slot. */
1652 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
1653 Fselect_window (swindow, Qnil);
1654 else
1655 FRAME_SELECTED_WINDOW (f) = swindow;
1659 /* Now we know we can delete this one. */
1660 window_deletion_count++;
1662 tem = p->buffer;
1663 /* tem is null for dummy parent windows
1664 (which have inferiors but not any contents themselves) */
1665 if (!NILP (tem))
1667 unshow_buffer (p);
1668 unchain_marker (XMARKER (p->pointm));
1669 unchain_marker (XMARKER (p->start));
1672 /* Free window glyph matrices. It is sure that they are allocated
1673 again when ADJUST_GLYPHS is called. Block input so that expose
1674 events and other events that access glyph matrices are not
1675 processed while we are changing them. */
1676 BLOCK_INPUT;
1677 free_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)));
1679 tem = p->next;
1680 if (!NILP (tem))
1681 XWINDOW (tem)->prev = p->prev;
1683 tem = p->prev;
1684 if (!NILP (tem))
1685 XWINDOW (tem)->next = p->next;
1687 if (EQ (window, par->hchild))
1688 par->hchild = p->next;
1689 if (EQ (window, par->vchild))
1690 par->vchild = p->next;
1692 /* Find one of our siblings to give our space to. */
1693 sib = p->prev;
1694 if (NILP (sib))
1696 /* If p gives its space to its next sibling, that sibling needs
1697 to have its top/left side pulled back to where p's is.
1698 set_window_{height,width} will re-position the sibling's
1699 children. */
1700 sib = p->next;
1701 XWINDOW (sib)->top_line = p->top_line;
1702 XWINDOW (sib)->left_col = p->left_col;
1705 /* Stretch that sibling. */
1706 if (!NILP (par->vchild))
1707 set_window_height (sib,
1708 XFASTINT (XWINDOW (sib)->total_lines) + XFASTINT (p->total_lines),
1710 if (!NILP (par->hchild))
1711 set_window_width (sib,
1712 XFASTINT (XWINDOW (sib)->total_cols) + XFASTINT (p->total_cols),
1715 /* If parent now has only one child,
1716 put the child into the parent's place. */
1717 tem = par->hchild;
1718 if (NILP (tem))
1719 tem = par->vchild;
1720 if (NILP (XWINDOW (tem)->next)) {
1721 replace_window (parent, tem);
1722 par = XWINDOW (tem);
1725 /* Since we may be deleting combination windows, we must make sure that
1726 not only p but all its children have been marked as deleted. */
1727 if (! NILP (p->hchild))
1728 delete_all_subwindows (XWINDOW (p->hchild));
1729 else if (! NILP (p->vchild))
1730 delete_all_subwindows (XWINDOW (p->vchild));
1732 /* Mark this window as deleted. */
1733 p->buffer = p->hchild = p->vchild = Qnil;
1735 if (! NILP (par->parent))
1736 par = XWINDOW (par->parent);
1738 /* Check if we have a v/hchild with a v/hchild. In that case remove
1739 one of them. */
1741 if (! NILP (par->vchild) && ! NILP (XWINDOW (par->vchild)->vchild))
1743 p = XWINDOW (par->vchild);
1744 par->vchild = p->vchild;
1745 tem = p->vchild;
1747 else if (! NILP (par->hchild) && ! NILP (XWINDOW (par->hchild)->hchild))
1749 p = XWINDOW (par->hchild);
1750 par->hchild = p->hchild;
1751 tem = p->hchild;
1753 else
1754 p = 0;
1756 if (p)
1758 while (! NILP (tem)) {
1759 XWINDOW (tem)->parent = p->parent;
1760 if (NILP (XWINDOW (tem)->next))
1761 break;
1762 tem = XWINDOW (tem)->next;
1764 if (! NILP (tem)) {
1765 /* The next of the v/hchild we are removing is now the next of the
1766 last child for the v/hchild:
1767 Before v/hchild -> v/hchild -> next1 -> next2
1769 -> next3
1770 After: v/hchild -> next1 -> next2 -> next3
1772 XWINDOW (tem)->next = p->next;
1773 if (! NILP (p->next))
1774 XWINDOW (p->next)->prev = tem;
1776 p->next = p->prev = p->vchild = p->hchild = p->buffer = Qnil;
1780 /* Adjust glyph matrices. */
1781 adjust_glyphs (f);
1782 UNBLOCK_INPUT;
1787 /***********************************************************************
1788 Window List
1789 ***********************************************************************/
1791 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1792 pointer. This is a callback function for foreach_window, used in
1793 function window_list. */
1795 static int
1796 add_window_to_list (struct window *w, void *user_data)
1798 Lisp_Object *list = (Lisp_Object *) user_data;
1799 Lisp_Object window;
1800 XSETWINDOW (window, w);
1801 *list = Fcons (window, *list);
1802 return 1;
1806 /* Return a list of all windows, for use by next_window. If
1807 Vwindow_list is a list, return that list. Otherwise, build a new
1808 list, cache it in Vwindow_list, and return that. */
1810 static Lisp_Object
1811 window_list (void)
1813 if (!CONSP (Vwindow_list))
1815 Lisp_Object tail;
1817 Vwindow_list = Qnil;
1818 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1820 Lisp_Object args[2];
1822 /* We are visiting windows in canonical order, and add
1823 new windows at the front of args[1], which means we
1824 have to reverse this list at the end. */
1825 args[1] = Qnil;
1826 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1827 args[0] = Vwindow_list;
1828 args[1] = Fnreverse (args[1]);
1829 Vwindow_list = Fnconc (2, args);
1833 return Vwindow_list;
1837 /* Value is non-zero if WINDOW satisfies the constraints given by
1838 OWINDOW, MINIBUF and ALL_FRAMES.
1840 MINIBUF t means WINDOW may be minibuffer windows.
1841 `lambda' means WINDOW may not be a minibuffer window.
1842 a window means a specific minibuffer window
1844 ALL_FRAMES t means search all frames,
1845 nil means search just current frame,
1846 `visible' means search just visible frames,
1847 0 means search visible and iconified frames,
1848 a window means search the frame that window belongs to,
1849 a frame means consider windows on that frame, only. */
1851 static int
1852 candidate_window_p (Lisp_Object window, Lisp_Object owindow, Lisp_Object minibuf, Lisp_Object all_frames)
1854 struct window *w = XWINDOW (window);
1855 struct frame *f = XFRAME (w->frame);
1856 int candidate_p = 1;
1858 if (!BUFFERP (w->buffer))
1859 candidate_p = 0;
1860 else if (MINI_WINDOW_P (w)
1861 && (EQ (minibuf, Qlambda)
1862 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
1864 /* If MINIBUF is `lambda' don't consider any mini-windows.
1865 If it is a window, consider only that one. */
1866 candidate_p = 0;
1868 else if (EQ (all_frames, Qt))
1869 candidate_p = 1;
1870 else if (NILP (all_frames))
1872 xassert (WINDOWP (owindow));
1873 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
1875 else if (EQ (all_frames, Qvisible))
1877 FRAME_SAMPLE_VISIBILITY (f);
1878 candidate_p = FRAME_VISIBLE_P (f)
1879 && (FRAME_TERMINAL (XFRAME (w->frame))
1880 == FRAME_TERMINAL (XFRAME (selected_frame)));
1883 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
1885 FRAME_SAMPLE_VISIBILITY (f);
1886 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
1887 #ifdef HAVE_X_WINDOWS
1888 /* Yuck!! If we've just created the frame and the
1889 window-manager requested the user to place it
1890 manually, the window may still not be considered
1891 `visible'. I'd argue it should be at least
1892 something like `iconified', but don't know how to do
1893 that yet. --Stef */
1894 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
1895 && !f->output_data.x->has_been_visible)
1896 #endif
1898 && (FRAME_TERMINAL (XFRAME (w->frame))
1899 == FRAME_TERMINAL (XFRAME (selected_frame)));
1901 else if (WINDOWP (all_frames))
1902 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
1903 || EQ (XWINDOW (all_frames)->frame, w->frame)
1904 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
1905 else if (FRAMEP (all_frames))
1906 candidate_p = EQ (all_frames, w->frame);
1908 return candidate_p;
1912 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
1913 Fwindow_list. See there for the meaning of WINDOW, MINIBUF, and
1914 ALL_FRAMES. */
1916 static void
1917 decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object *all_frames)
1919 if (NILP (*window))
1920 *window = selected_window;
1921 else
1922 CHECK_LIVE_WINDOW (*window);
1924 /* MINIBUF nil may or may not include minibuffers. Decide if it
1925 does. */
1926 if (NILP (*minibuf))
1927 *minibuf = minibuf_level ? minibuf_window : Qlambda;
1928 else if (!EQ (*minibuf, Qt))
1929 *minibuf = Qlambda;
1931 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
1932 => count none of them, or a specific minibuffer window (the
1933 active one) to count. */
1935 /* ALL_FRAMES nil doesn't specify which frames to include. */
1936 if (NILP (*all_frames))
1937 *all_frames = (!EQ (*minibuf, Qlambda)
1938 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
1939 : Qnil);
1940 else if (EQ (*all_frames, Qvisible))
1942 else if (EQ (*all_frames, make_number (0)))
1944 else if (FRAMEP (*all_frames))
1946 else if (!EQ (*all_frames, Qt))
1947 *all_frames = Qnil;
1949 /* Now *ALL_FRAMES is t meaning search all frames, nil meaning
1950 search just current frame, `visible' meaning search just visible
1951 frames, 0 meaning search visible and iconified frames, or a
1952 window, meaning search the frame that window belongs to, or a
1953 frame, meaning consider windows on that frame, only. */
1957 /* Return the next or previous window of WINDOW in cyclic ordering
1958 of windows. NEXT_P non-zero means return the next window. See the
1959 documentation string of next-window for the meaning of MINIBUF and
1960 ALL_FRAMES. */
1962 static Lisp_Object
1963 next_window (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames, int next_p)
1965 decode_next_window_args (&window, &minibuf, &all_frames);
1967 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
1968 return the first window on the frame. */
1969 if (FRAMEP (all_frames)
1970 && !EQ (all_frames, XWINDOW (window)->frame))
1971 return Fframe_first_window (all_frames);
1973 if (next_p)
1975 Lisp_Object list;
1977 /* Find WINDOW in the list of all windows. */
1978 list = Fmemq (window, window_list ());
1980 /* Scan forward from WINDOW to the end of the window list. */
1981 if (CONSP (list))
1982 for (list = XCDR (list); CONSP (list); list = XCDR (list))
1983 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1984 break;
1986 /* Scan from the start of the window list up to WINDOW. */
1987 if (!CONSP (list))
1988 for (list = Vwindow_list;
1989 CONSP (list) && !EQ (XCAR (list), window);
1990 list = XCDR (list))
1991 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1992 break;
1994 if (CONSP (list))
1995 window = XCAR (list);
1997 else
1999 Lisp_Object candidate, list;
2001 /* Scan through the list of windows for candidates. If there are
2002 candidate windows in front of WINDOW, the last one of these
2003 is the one we want. If there are candidates following WINDOW
2004 in the list, again the last one of these is the one we want. */
2005 candidate = Qnil;
2006 for (list = window_list (); CONSP (list); list = XCDR (list))
2008 if (EQ (XCAR (list), window))
2010 if (WINDOWP (candidate))
2011 break;
2013 else if (candidate_window_p (XCAR (list), window, minibuf,
2014 all_frames))
2015 candidate = XCAR (list);
2018 if (WINDOWP (candidate))
2019 window = candidate;
2022 return window;
2026 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
2027 doc: /* Return window following WINDOW in cyclic ordering of windows.
2028 WINDOW defaults to the selected window. The optional arguments
2029 MINIBUF and ALL-FRAMES specify the set of windows to consider.
2031 MINIBUF t means consider the minibuffer window even if the
2032 minibuffer is not active. MINIBUF nil or omitted means consider
2033 the minibuffer window only if the minibuffer is active. Any
2034 other value means do not consider the minibuffer window even if
2035 the minibuffer is active.
2037 Several frames may share a single minibuffer; if the minibuffer
2038 is active, all windows on all frames that share that minibuffer
2039 are considered too. Therefore, if you are using a separate
2040 minibuffer frame and the minibuffer is active and MINIBUF says it
2041 counts, `next-window' considers the windows in the frame from
2042 which you entered the minibuffer, as well as the minibuffer
2043 window.
2045 ALL-FRAMES nil or omitted means consider all windows on WINDOW's
2046 frame, plus the minibuffer window if specified by the MINIBUF
2047 argument, see above. If the minibuffer counts, consider all
2048 windows on all frames that share that minibuffer too.
2049 ALL-FRAMES t means consider all windows on all existing frames.
2050 ALL-FRAMES `visible' means consider all windows on all visible
2051 frames.
2052 ALL-FRAMES 0 means consider all windows on all visible and
2053 iconified frames.
2054 ALL-FRAMES a frame means consider all windows on that frame only.
2055 Anything else means consider all windows on WINDOW's frame and no
2056 others.
2058 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2059 `next-window' to iterate through the entire cycle of acceptable
2060 windows, eventually ending up back at the window you started with.
2061 `previous-window' traverses the same cycle, in the reverse order. */)
2062 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2064 return next_window (window, minibuf, all_frames, 1);
2068 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
2069 doc: /* Return window preceding WINDOW in cyclic ordering of windows.
2070 WINDOW defaults to the selected window. The optional arguments
2071 MINIBUF and ALL-FRAMES specify the set of windows to consider.
2072 For the precise meaning of these arguments see `next-window'.
2074 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2075 use `previous-window' to iterate through the entire cycle of
2076 acceptable windows, eventually ending up back at the window you
2077 started with. `next-window' traverses the same cycle, in the
2078 reverse order. */)
2079 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2081 return next_window (window, minibuf, all_frames, 0);
2085 DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
2086 doc: /* Select another window in cyclic ordering of windows.
2087 COUNT specifies the number of windows to skip, starting with the
2088 selected window, before making the selection. If COUNT is
2089 positive, skip COUNT windows forwards. If COUNT is negative,
2090 skip -COUNT windows backwards. COUNT zero means do not skip any
2091 window, so select the selected window. In an interactive call,
2092 COUNT is the numeric prefix argument. Return nil.
2094 This function uses `next-window' for finding the window to select.
2095 The argument ALL-FRAMES has the same meaning as in `next-window',
2096 but the MINIBUF argument of `next-window' is always effectively
2097 nil. */)
2098 (Lisp_Object count, Lisp_Object all_frames)
2100 Lisp_Object window;
2101 int i;
2103 CHECK_NUMBER (count);
2104 window = selected_window;
2106 for (i = XINT (count); i > 0; --i)
2107 window = Fnext_window (window, Qnil, all_frames);
2108 for (; i < 0; ++i)
2109 window = Fprevious_window (window, Qnil, all_frames);
2111 Fselect_window (window, Qnil);
2112 return Qnil;
2116 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2117 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2118 FRAME nil or omitted means use the selected frame.
2119 WINDOW nil or omitted means use the selected window.
2120 MINIBUF t means include the minibuffer window, even if it isn't active.
2121 MINIBUF nil or omitted means include the minibuffer window only
2122 if it's active.
2123 MINIBUF neither nil nor t means never include the minibuffer window. */)
2124 (Lisp_Object frame, Lisp_Object minibuf, Lisp_Object window)
2126 if (NILP (window))
2127 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2128 CHECK_WINDOW (window);
2129 if (NILP (frame))
2130 frame = selected_frame;
2132 if (!EQ (frame, XWINDOW (window)->frame))
2133 error ("Window is on a different frame");
2135 return window_list_1 (window, minibuf, frame);
2139 /* Return a list of windows in cyclic ordering. Arguments are like
2140 for `next-window'. */
2142 static Lisp_Object
2143 window_list_1 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2145 Lisp_Object tail, list, rest;
2147 decode_next_window_args (&window, &minibuf, &all_frames);
2148 list = Qnil;
2150 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2151 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2152 list = Fcons (XCAR (tail), list);
2154 /* Rotate the list to start with WINDOW. */
2155 list = Fnreverse (list);
2156 rest = Fmemq (window, list);
2157 if (!NILP (rest) && !EQ (rest, list))
2159 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2161 XSETCDR (tail, Qnil);
2162 list = nconc2 (rest, list);
2164 return list;
2169 /* Look at all windows, performing an operation specified by TYPE
2170 with argument OBJ.
2171 If FRAMES is Qt, look at all frames;
2172 Qnil, look at just the selected frame;
2173 Qvisible, look at visible frames;
2174 a frame, just look at windows on that frame.
2175 If MINI is non-zero, perform the operation on minibuffer windows too. */
2177 enum window_loop
2179 WINDOW_LOOP_UNUSED,
2180 GET_BUFFER_WINDOW, /* Arg is buffer */
2181 GET_LRU_WINDOW, /* Arg is t for full-width windows only */
2182 DELETE_OTHER_WINDOWS, /* Arg is window not to delete */
2183 DELETE_BUFFER_WINDOWS, /* Arg is buffer */
2184 GET_LARGEST_WINDOW,
2185 UNSHOW_BUFFER, /* Arg is buffer */
2186 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2187 CHECK_ALL_WINDOWS
2190 static Lisp_Object
2191 window_loop (enum window_loop type, Lisp_Object obj, int mini, Lisp_Object frames)
2193 Lisp_Object window, windows, best_window, frame_arg;
2194 struct frame *f;
2195 struct gcpro gcpro1;
2197 /* If we're only looping through windows on a particular frame,
2198 frame points to that frame. If we're looping through windows
2199 on all frames, frame is 0. */
2200 if (FRAMEP (frames))
2201 f = XFRAME (frames);
2202 else if (NILP (frames))
2203 f = SELECTED_FRAME ();
2204 else
2205 f = NULL;
2207 if (f)
2208 frame_arg = Qlambda;
2209 else if (EQ (frames, make_number (0)))
2210 frame_arg = frames;
2211 else if (EQ (frames, Qvisible))
2212 frame_arg = frames;
2213 else
2214 frame_arg = Qt;
2216 /* frame_arg is Qlambda to stick to one frame,
2217 Qvisible to consider all visible frames,
2218 or Qt otherwise. */
2220 /* Pick a window to start with. */
2221 if (WINDOWP (obj))
2222 window = obj;
2223 else if (f)
2224 window = FRAME_SELECTED_WINDOW (f);
2225 else
2226 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2228 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2229 GCPRO1 (windows);
2230 best_window = Qnil;
2232 for (; CONSP (windows); windows = XCDR (windows))
2234 struct window *w;
2236 window = XCAR (windows);
2237 w = XWINDOW (window);
2239 /* Note that we do not pay attention here to whether the frame
2240 is visible, since Fwindow_list skips non-visible frames if
2241 that is desired, under the control of frame_arg. */
2242 if (!MINI_WINDOW_P (w)
2243 /* For UNSHOW_BUFFER, we must always consider all windows. */
2244 || type == UNSHOW_BUFFER
2245 || (mini && minibuf_level > 0))
2246 switch (type)
2248 case GET_BUFFER_WINDOW:
2249 if (EQ (w->buffer, obj)
2250 /* Don't find any minibuffer window
2251 except the one that is currently in use. */
2252 && (MINI_WINDOW_P (w)
2253 ? EQ (window, minibuf_window)
2254 : 1))
2256 if (NILP (best_window))
2257 best_window = window;
2258 else if (EQ (window, selected_window))
2259 /* Prefer to return selected-window. */
2260 RETURN_UNGCPRO (window);
2261 else if (EQ (Fwindow_frame (window), selected_frame))
2262 /* Prefer windows on the current frame. */
2263 best_window = window;
2265 break;
2267 case GET_LRU_WINDOW:
2268 /* `obj' is an integer encoding a bitvector.
2269 `obj & 1' means consider only full-width windows.
2270 `obj & 2' means consider also dedicated windows. */
2271 if (((XINT (obj) & 1) && !WINDOW_FULL_WIDTH_P (w))
2272 || (!(XINT (obj) & 2) && !NILP (w->dedicated))
2273 /* Minibuffer windows are always ignored. */
2274 || MINI_WINDOW_P (w))
2275 break;
2276 if (NILP (best_window)
2277 || (XFASTINT (XWINDOW (best_window)->use_time)
2278 > XFASTINT (w->use_time)))
2279 best_window = window;
2280 break;
2282 case DELETE_OTHER_WINDOWS:
2283 if (!EQ (window, obj))
2284 Fdelete_window (window);
2285 break;
2287 case DELETE_BUFFER_WINDOWS:
2288 if (EQ (w->buffer, obj))
2290 struct frame *f = XFRAME (WINDOW_FRAME (w));
2292 /* If this window is dedicated, and in a frame of its own,
2293 kill the frame. */
2294 if (EQ (window, FRAME_ROOT_WINDOW (f))
2295 && !NILP (w->dedicated)
2296 && other_visible_frames (f))
2298 /* Skip the other windows on this frame.
2299 There might be one, the minibuffer! */
2300 while (CONSP (XCDR (windows))
2301 && EQ (XWINDOW (XCAR (windows))->frame,
2302 XWINDOW (XCAR (XCDR (windows)))->frame))
2303 windows = XCDR (windows);
2305 /* Now we can safely delete the frame. */
2306 delete_frame (w->frame, Qnil);
2308 else if (NILP (w->parent))
2310 /* If we're deleting the buffer displayed in the
2311 only window on the frame, find a new buffer to
2312 display there. */
2313 Lisp_Object buffer;
2314 buffer = Fother_buffer (obj, Qnil, w->frame);
2315 /* Reset dedicated state of window. */
2316 w->dedicated = Qnil;
2317 Fset_window_buffer (window, buffer, Qnil);
2318 if (EQ (window, selected_window))
2319 Fset_buffer (w->buffer);
2321 else
2322 Fdelete_window (window);
2324 break;
2326 case GET_LARGEST_WINDOW:
2327 { /* nil `obj' means to ignore dedicated windows. */
2328 /* Ignore dedicated windows and minibuffers. */
2329 if (MINI_WINDOW_P (w) || (NILP (obj) && !NILP (w->dedicated)))
2330 break;
2332 if (NILP (best_window))
2333 best_window = window;
2334 else
2336 struct window *b = XWINDOW (best_window);
2337 if (XFASTINT (w->total_lines) * XFASTINT (w->total_cols)
2338 > XFASTINT (b->total_lines) * XFASTINT (b->total_cols))
2339 best_window = window;
2342 break;
2344 case UNSHOW_BUFFER:
2345 if (EQ (w->buffer, obj))
2347 Lisp_Object buffer;
2348 struct frame *f = XFRAME (w->frame);
2350 /* Find another buffer to show in this window. */
2351 buffer = Fother_buffer (obj, Qnil, w->frame);
2353 /* If this window is dedicated, and in a frame of its own,
2354 kill the frame. */
2355 if (EQ (window, FRAME_ROOT_WINDOW (f))
2356 && !NILP (w->dedicated)
2357 && other_visible_frames (f))
2359 /* Skip the other windows on this frame.
2360 There might be one, the minibuffer! */
2361 while (CONSP (XCDR (windows))
2362 && EQ (XWINDOW (XCAR (windows))->frame,
2363 XWINDOW (XCAR (XCDR (windows)))->frame))
2364 windows = XCDR (windows);
2366 /* Now we can safely delete the frame. */
2367 delete_frame (w->frame, Qnil);
2369 else if (!NILP (w->dedicated) && !NILP (w->parent))
2371 Lisp_Object window;
2372 XSETWINDOW (window, w);
2373 /* If this window is dedicated and not the only window
2374 in its frame, then kill it. */
2375 Fdelete_window (window);
2377 else
2379 /* Otherwise show a different buffer in the window. */
2380 w->dedicated = Qnil;
2381 Fset_window_buffer (window, buffer, Qnil);
2382 if (EQ (window, selected_window))
2383 Fset_buffer (w->buffer);
2386 break;
2388 case REDISPLAY_BUFFER_WINDOWS:
2389 if (EQ (w->buffer, obj))
2391 mark_window_display_accurate (window, 0);
2392 w->update_mode_line = Qt;
2393 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2394 ++update_mode_lines;
2395 best_window = window;
2397 break;
2399 /* Check for a window that has a killed buffer. */
2400 case CHECK_ALL_WINDOWS:
2401 if (! NILP (w->buffer)
2402 && NILP (XBUFFER (w->buffer)->name))
2403 abort ();
2404 break;
2406 case WINDOW_LOOP_UNUSED:
2407 break;
2411 UNGCPRO;
2412 return best_window;
2415 /* Used for debugging. Abort if any window has a dead buffer. */
2417 void
2418 check_all_windows (void)
2420 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2423 DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 2, 0,
2424 doc: /* Return the window least recently selected or used for display.
2425 \(LRU means Least Recently Used.)
2427 Return a full-width window if possible.
2428 A minibuffer window is never a candidate.
2429 A dedicated window is never a candidate, unless DEDICATED is non-nil,
2430 so if all windows are dedicated, the value is nil.
2431 If optional argument FRAME is `visible', search all visible frames.
2432 If FRAME is 0, search all visible and iconified frames.
2433 If FRAME is t, search all frames.
2434 If FRAME is nil, search only the selected frame.
2435 If FRAME is a frame, search only that frame. */)
2436 (Lisp_Object frame, Lisp_Object dedicated)
2438 register Lisp_Object w;
2439 /* First try for a window that is full-width */
2440 w = window_loop (GET_LRU_WINDOW,
2441 NILP (dedicated) ? make_number (1) : make_number (3),
2442 0, frame);
2443 if (!NILP (w) && !EQ (w, selected_window))
2444 return w;
2445 /* If none of them, try the rest */
2446 return window_loop (GET_LRU_WINDOW,
2447 NILP (dedicated) ? make_number (0) : make_number (2),
2448 0, frame);
2451 DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 2, 0,
2452 doc: /* Return the largest window in area.
2453 A minibuffer window is never a candidate.
2454 A dedicated window is never a candidate unless DEDICATED is non-nil,
2455 so if all windows are dedicated, the value is nil.
2456 If optional argument FRAME is `visible', search all visible frames.
2457 If FRAME is 0, search all visible and iconified frames.
2458 If FRAME is t, search all frames.
2459 If FRAME is nil, search only the selected frame.
2460 If FRAME is a frame, search only that frame. */)
2461 (Lisp_Object frame, Lisp_Object dedicated)
2463 return window_loop (GET_LARGEST_WINDOW, dedicated, 0,
2464 frame);
2467 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 0, 2, 0,
2468 doc: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2469 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to the
2470 current buffer.
2471 If optional argument FRAME is `visible', search all visible frames.
2472 If optional argument FRAME is 0, search all visible and iconified frames.
2473 If FRAME is t, search all frames.
2474 If FRAME is nil, search only the selected frame.
2475 If FRAME is a frame, search only that frame. */)
2476 (Lisp_Object buffer_or_name, Lisp_Object frame)
2478 Lisp_Object buffer;
2480 if (NILP (buffer_or_name))
2481 buffer = Fcurrent_buffer ();
2482 else
2483 buffer = Fget_buffer (buffer_or_name);
2485 if (BUFFERP (buffer))
2486 return window_loop (GET_BUFFER_WINDOW, buffer, 1, frame);
2487 else
2488 return Qnil;
2491 DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
2492 0, 1, "",
2493 doc: /* Make WINDOW (or the selected window) fill its frame.
2494 Only the frame WINDOW is on is affected.
2495 This function tries to reduce display jumps by keeping the text
2496 previously visible in WINDOW in the same place on the frame. Doing this
2497 depends on the value of (window-start WINDOW), so if calling this
2498 function in a program gives strange scrolling, make sure the
2499 window-start value is reasonable when this function is called. */)
2500 (Lisp_Object window)
2502 struct window *w;
2503 EMACS_INT startpos;
2504 int top, new_top;
2506 if (NILP (window))
2507 window = selected_window;
2508 else
2509 CHECK_LIVE_WINDOW (window);
2510 w = XWINDOW (window);
2512 startpos = marker_position (w->start);
2513 top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2515 if (MINI_WINDOW_P (w) && top > 0)
2516 error ("Can't expand minibuffer to full frame");
2518 window_loop (DELETE_OTHER_WINDOWS, window, 0, WINDOW_FRAME (w));
2520 /* Try to minimize scrolling, by setting the window start to the point
2521 will cause the text at the old window start to be at the same place
2522 on the frame. But don't try to do this if the window start is
2523 outside the visible portion (as might happen when the display is
2524 not current, due to typeahead). */
2525 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2526 if (new_top != top
2527 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2528 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2530 struct position pos;
2531 struct buffer *obuf = current_buffer;
2533 Fset_buffer (w->buffer);
2534 /* This computation used to temporarily move point, but that can
2535 have unwanted side effects due to text properties. */
2536 pos = *vmotion (startpos, -top, w);
2538 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2539 w->window_end_valid = Qnil;
2540 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2541 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2542 : Qnil);
2543 /* We need to do this, so that the window-scroll-functions
2544 get called. */
2545 w->optional_new_start = Qt;
2547 set_buffer_internal (obuf);
2550 return Qnil;
2553 DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
2554 0, 2, "bDelete windows on (buffer): ",
2555 doc: /* Delete all windows showing BUFFER-OR-NAME.
2556 BUFFER-OR-NAME may be a buffer or the name of an existing buffer and
2557 defaults to the current buffer.
2559 Optional second argument FRAME controls which frames are affected.
2560 If optional argument FRAME is `visible', search all visible frames.
2561 If FRAME is 0, search all visible and iconified frames.
2562 If FRAME is nil, search all frames.
2563 If FRAME is t, search only the selected frame.
2564 If FRAME is a frame, search only that frame.
2565 When a window showing BUFFER-OR-NAME is dedicated and the only window of
2566 its frame, that frame is deleted when there are other frames left. */)
2567 (Lisp_Object buffer_or_name, Lisp_Object frame)
2569 Lisp_Object buffer;
2571 /* FRAME uses t and nil to mean the opposite of what window_loop
2572 expects. */
2573 if (NILP (frame))
2574 frame = Qt;
2575 else if (EQ (frame, Qt))
2576 frame = Qnil;
2578 if (NILP (buffer_or_name))
2579 buffer = Fcurrent_buffer ();
2580 else
2582 buffer = Fget_buffer (buffer_or_name);
2583 CHECK_BUFFER (buffer);
2586 window_loop (DELETE_BUFFER_WINDOWS, buffer, 0, frame);
2588 return Qnil;
2591 DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows,
2592 Sreplace_buffer_in_windows,
2593 0, 1, "bReplace buffer in windows: ",
2594 doc: /* Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2595 BUFFER-OR-NAME may be a buffer or the name of an existing buffer and
2596 defaults to the current buffer.
2598 When a window showing BUFFER-OR-NAME is dedicated that window is
2599 deleted. If that window is the only window on its frame, that frame is
2600 deleted too when there are other frames left. If there are no other
2601 frames left, some other buffer is displayed in that window. */)
2602 (Lisp_Object buffer_or_name)
2604 Lisp_Object buffer;
2606 if (NILP (buffer_or_name))
2607 buffer = Fcurrent_buffer ();
2608 else
2610 buffer = Fget_buffer (buffer_or_name);
2611 CHECK_BUFFER (buffer);
2614 window_loop (UNSHOW_BUFFER, buffer, 0, Qt);
2616 return Qnil;
2619 /* Replace BUFFER with some other buffer in all windows
2620 of all frames, even those on other keyboards. */
2622 void
2623 replace_buffer_in_all_windows (Lisp_Object buffer)
2625 Lisp_Object tail, frame;
2627 /* A single call to window_loop won't do the job
2628 because it only considers frames on the current keyboard.
2629 So loop manually over frames, and handle each one. */
2630 FOR_EACH_FRAME (tail, frame)
2631 window_loop (UNSHOW_BUFFER, buffer, 1, frame);
2634 /* Set the height of WINDOW and all its inferiors. */
2636 /* The smallest acceptable dimensions for a window. Anything smaller
2637 might crash Emacs. */
2639 #define MIN_SAFE_WINDOW_WIDTH (2)
2640 #define MIN_SAFE_WINDOW_HEIGHT (1)
2642 /* For wp non-zero the total number of columns of window w. Otherwise
2643 the total number of lines of w. */
2645 #define WINDOW_TOTAL_SIZE(w, wp) \
2646 (wp ? WINDOW_TOTAL_COLS (w) : WINDOW_TOTAL_LINES (w))
2648 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2649 minimum allowable size. */
2651 void
2652 check_frame_size (FRAME_PTR frame, int *rows, int *cols)
2654 /* For height, we have to see:
2655 how many windows the frame has at minimum (one or two),
2656 and whether it has a menu bar or other special stuff at the top. */
2657 int min_height
2658 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
2659 ? MIN_SAFE_WINDOW_HEIGHT
2660 : 2 * MIN_SAFE_WINDOW_HEIGHT);
2662 if (FRAME_TOP_MARGIN (frame) > 0)
2663 min_height += FRAME_TOP_MARGIN (frame);
2665 if (*rows < min_height)
2666 *rows = min_height;
2667 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2668 *cols = MIN_SAFE_WINDOW_WIDTH;
2671 /* Value is non-zero if window W is fixed-size. WIDTH_P non-zero means
2672 check if W's width can be changed, otherwise check W's height.
2673 CHECK_SIBLINGS_P non-zero means check resizablity of WINDOW's
2674 siblings, too. If none of the siblings is resizable, WINDOW isn't
2675 either. */
2677 static int
2678 window_fixed_size_p (struct window *w, int width_p, int check_siblings_p)
2680 int fixed_p;
2681 struct window *c;
2683 if (!NILP (w->hchild))
2685 c = XWINDOW (w->hchild);
2687 if (width_p)
2689 /* A horizontal combination is fixed-width if all of if its
2690 children are. */
2691 while (c && window_fixed_size_p (c, width_p, 0))
2692 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2693 fixed_p = c == NULL;
2695 else
2697 /* A horizontal combination is fixed-height if one of if its
2698 children is. */
2699 while (c && !window_fixed_size_p (c, width_p, 0))
2700 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2701 fixed_p = c != NULL;
2704 else if (!NILP (w->vchild))
2706 c = XWINDOW (w->vchild);
2708 if (width_p)
2710 /* A vertical combination is fixed-width if one of if its
2711 children is. */
2712 while (c && !window_fixed_size_p (c, width_p, 0))
2713 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2714 fixed_p = c != NULL;
2716 else
2718 /* A vertical combination is fixed-height if all of if its
2719 children are. */
2720 while (c && window_fixed_size_p (c, width_p, 0))
2721 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2722 fixed_p = c == NULL;
2725 else if (BUFFERP (w->buffer))
2727 struct buffer *old = current_buffer;
2728 Lisp_Object val;
2730 current_buffer = XBUFFER (w->buffer);
2731 val = find_symbol_value (Qwindow_size_fixed);
2732 current_buffer = old;
2734 fixed_p = 0;
2735 if (!EQ (val, Qunbound))
2737 fixed_p = !NILP (val);
2739 if (fixed_p
2740 && ((EQ (val, Qheight) && width_p)
2741 || (EQ (val, Qwidth) && !width_p)))
2742 fixed_p = 0;
2745 /* Can't tell if this one is resizable without looking at
2746 siblings. If all siblings are fixed-size this one is too. */
2747 if (!fixed_p && check_siblings_p && WINDOWP (w->parent))
2749 Lisp_Object child;
2751 for (child = w->prev; WINDOWP (child); child = XWINDOW (child)->prev)
2752 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2753 break;
2755 if (NILP (child))
2756 for (child = w->next; WINDOWP (child); child = XWINDOW (child)->next)
2757 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2758 break;
2760 if (NILP (child))
2761 fixed_p = 1;
2764 else
2765 fixed_p = 1;
2767 return fixed_p;
2770 /* Return minimum size of leaf window W. WIDTH_P non-zero means return
2771 the minimum width of W, WIDTH_P zero means return the minimum height
2772 of W. SAFE_P non-zero means ignore window-min-height|width but just
2773 return values that won't crash Emacs and don't hide components like
2774 fringes, scrollbars, or modelines. If WIDTH_P is zero and W is the
2775 minibuffer window, always return 1. */
2777 static int
2778 window_min_size_2 (struct window *w, int width_p, int safe_p)
2780 /* We should consider buffer-local values of window_min_height and
2781 window_min_width here. */
2782 if (width_p)
2784 int safe_size = (MIN_SAFE_WINDOW_WIDTH
2785 + WINDOW_FRINGE_COLS (w)
2786 + WINDOW_SCROLL_BAR_COLS (w));
2788 return safe_p ? safe_size : max (window_min_width, safe_size);
2790 else if (MINI_WINDOW_P (w))
2791 return 1;
2792 else
2794 int safe_size = (MIN_SAFE_WINDOW_HEIGHT
2795 + ((BUFFERP (w->buffer)
2796 && !NILP (XBUFFER (w->buffer)->mode_line_format))
2797 ? 1 : 0));
2799 return safe_p ? safe_size : max (window_min_height, safe_size);
2803 /* Return minimum size of window W, not taking fixed-width windows into
2804 account. WIDTH_P non-zero means return the minimum width, otherwise
2805 return the minimum height. SAFE_P non-zero means ignore
2806 window-min-height|width but just return values that won't crash Emacs
2807 and don't hide components like fringes, scrollbars, or modelines. If
2808 W is a combination window, compute the minimum size from the minimum
2809 sizes of W's children. */
2811 static int
2812 window_min_size_1 (struct window *w, int width_p, int safe_p)
2814 struct window *c;
2815 int size;
2817 if (!NILP (w->hchild))
2819 /* W is a horizontal combination. */
2820 c = XWINDOW (w->hchild);
2821 size = 0;
2823 if (width_p)
2825 /* The minimum width of a horizontal combination is the sum of
2826 the minimum widths of its children. */
2827 while (c)
2829 size += window_min_size_1 (c, 1, safe_p);
2830 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2833 else
2835 /* The minimum height of a horizontal combination is the
2836 maximum of the minimum heights of its children. */
2837 while (c)
2839 size = max (window_min_size_1 (c, 0, safe_p), size);
2840 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2844 else if (!NILP (w->vchild))
2846 /* W is a vertical combination. */
2847 c = XWINDOW (w->vchild);
2848 size = 0;
2850 if (width_p)
2852 /* The minimum width of a vertical combination is the maximum
2853 of the minimum widths of its children. */
2854 while (c)
2856 size = max (window_min_size_1 (c, 1, safe_p), size);
2857 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2860 else
2862 /* The minimum height of a vertical combination is the sum of
2863 the minimum height of its children. */
2864 while (c)
2866 size += window_min_size_1 (c, 0, safe_p);
2867 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2871 else
2872 /* W is a leaf window. */
2873 size = window_min_size_2 (w, width_p, safe_p);
2875 return size;
2878 /* Return the minimum size of window W, taking fixed-size windows into
2879 account. WIDTH_P non-zero means return the minimum width, otherwise
2880 return the minimum height. SAFE_P non-zero means ignore
2881 window-min-height|width but just return values that won't crash Emacs
2882 and don't hide components like fringes, scrollbars, or modelines.
2883 IGNORE_FIXED_P non-zero means ignore if W is fixed-size. Set *FIXED
2884 to 1 if W is fixed-size unless FIXED is null. */
2886 static int
2887 window_min_size (struct window *w, int width_p, int safe_p, int ignore_fixed_p, int *fixed)
2889 int size, fixed_p;
2891 if (ignore_fixed_p)
2892 fixed_p = 0;
2893 else
2894 fixed_p = window_fixed_size_p (w, width_p, 1);
2896 if (fixed)
2897 *fixed = fixed_p;
2899 if (fixed_p)
2900 size = WINDOW_TOTAL_SIZE (w, width_p);
2901 else
2902 size = window_min_size_1 (w, width_p, safe_p);
2904 return size;
2908 /* Adjust the margins of window W if text area is too small.
2909 Return 1 if window width is ok after adjustment; 0 if window
2910 is still too narrow. */
2912 static int
2913 adjust_window_margins (struct window *w)
2915 int box_cols = (WINDOW_TOTAL_COLS (w)
2916 - WINDOW_FRINGE_COLS (w)
2917 - WINDOW_SCROLL_BAR_COLS (w));
2918 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
2919 + WINDOW_RIGHT_MARGIN_COLS (w));
2921 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
2922 return 1;
2924 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
2925 return 0;
2927 /* Window's text area is too narrow, but reducing the window
2928 margins will fix that. */
2929 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
2930 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
2932 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
2933 w->left_margin_cols = w->right_margin_cols
2934 = make_number (margin_cols/2);
2935 else
2936 w->right_margin_cols = make_number (margin_cols);
2938 else
2939 w->left_margin_cols = make_number (margin_cols);
2940 return 1;
2943 /* Calculate new sizes for windows in the list FORWARD when their
2944 compound size goes from TOTAL to SIZE. TOTAL must be greater than
2945 SIZE. The number of windows in FORWARD is NCHILDREN, and the number
2946 that can shrink is SHRINKABLE. Fixed-size windows may be shrunk if
2947 and only if RESIZE_FIXED_P is non-zero. WIDTH_P non-zero means
2948 shrink columns, otherwise shrink lines.
2950 SAFE_P zero means windows may be sized down to window-min-height
2951 lines (window-min-window columns for WIDTH_P non-zero). SAFE_P
2952 non-zero means windows may be sized down to their minimum safe sizes
2953 taking into account the space needed to display modelines, fringes,
2954 and scrollbars.
2956 This function returns an allocated array of new sizes that the caller
2957 must free. A size -1 means the window is fixed and RESIZE_FIXED_P is
2958 zero. A size zero means the window shall be deleted. Array index 0
2959 refers to the first window in FORWARD, 1 to the second, and so on.
2961 This function resizes windows proportionally to their size. It also
2962 tries to preserve smaller windows by resizing larger windows before
2963 resizing any window to zero. If resize_proportionally is non-nil for
2964 a specific window, it will attempt to strictly resize that window
2965 proportionally, even at the expense of deleting smaller windows. */
2966 static int *
2967 shrink_windows (int total, int size, int nchildren, int shrinkable,
2968 int resize_fixed_p, Lisp_Object forward, int width_p, int safe_p)
2970 int available_resize = 0;
2971 int *new_sizes, *min_sizes;
2972 struct window *c;
2973 Lisp_Object child;
2974 int smallest = total;
2975 int total_removed = 0;
2976 int total_shrink = total - size;
2977 int i;
2979 new_sizes = xmalloc (sizeof (*new_sizes) * nchildren);
2980 min_sizes = xmalloc (sizeof (*min_sizes) * nchildren);
2982 for (i = 0, child = forward; !NILP (child); child = c->next, ++i)
2984 int child_size;
2986 c = XWINDOW (child);
2987 child_size = WINDOW_TOTAL_SIZE (c, width_p);
2989 if (!resize_fixed_p && window_fixed_size_p (c, width_p, 0))
2990 new_sizes[i] = -1;
2991 else
2993 new_sizes[i] = child_size;
2994 min_sizes[i] = window_min_size_1 (c, width_p, safe_p);
2995 if (child_size > min_sizes[i]
2996 && NILP (c->resize_proportionally))
2997 available_resize += child_size - min_sizes[i];
3000 /* We might need to shrink some windows to zero. Find the smallest
3001 windows and set them to 0 until we can fulfil the new size. */
3003 while (shrinkable > 1 && size + available_resize < total)
3005 for (i = 0; i < nchildren; ++i)
3006 if (new_sizes[i] > 0 && smallest > new_sizes[i])
3007 smallest = new_sizes[i];
3009 for (i = 0; i < nchildren; ++i)
3010 if (new_sizes[i] == smallest)
3012 /* Resize this window down to zero. */
3013 new_sizes[i] = 0;
3014 if (smallest > min_sizes[i])
3015 available_resize -= smallest - min_sizes[i];
3016 available_resize += smallest;
3017 --shrinkable;
3018 total_removed += smallest;
3020 /* We don't know what the smallest is now. */
3021 smallest = total;
3023 /* Out of for, just remove one window at the time and
3024 check again if we have enough space. */
3025 break;
3029 /* Now, calculate the new sizes. Try to shrink each window
3030 proportional to its size. */
3031 for (i = 0; i < nchildren; ++i)
3033 if (new_sizes[i] > min_sizes[i])
3035 int to_shrink = total_shrink * new_sizes[i] / total;
3037 if (new_sizes[i] - to_shrink < min_sizes[i])
3038 to_shrink = new_sizes[i] - min_sizes[i];
3039 new_sizes[i] -= to_shrink;
3040 total_removed += to_shrink;
3044 /* Any reminder due to rounding, we just subtract from windows
3045 that are left and still can be shrunk. */
3046 while (total_shrink > total_removed)
3048 int nonzero_sizes = 0;
3049 int nonzero_idx = -1;
3051 for (i = 0; i < nchildren; ++i)
3052 if (new_sizes[i] > 0)
3054 ++nonzero_sizes;
3055 nonzero_idx = i;
3058 for (i = 0; i < nchildren; ++i)
3059 if (new_sizes[i] > min_sizes[i])
3061 --new_sizes[i];
3062 ++total_removed;
3064 /* Out of for, just shrink one window at the time and
3065 check again if we have enough space. */
3066 break;
3069 /* Special case, only one window left. */
3070 if (nonzero_sizes == 1)
3071 break;
3074 /* Any surplus due to rounding, we add to windows that are left. */
3075 while (total_shrink < total_removed)
3077 for (i = 0; i < nchildren; ++i)
3079 if (new_sizes[i] != 0 && total_shrink < total_removed)
3081 ++new_sizes[i];
3082 --total_removed;
3083 break;
3088 xfree (min_sizes);
3090 return new_sizes;
3093 /* Set WINDOW's height or width to SIZE. WIDTH_P non-zero means set
3094 WINDOW's width. Resize WINDOW's children, if any, so that they keep
3095 their proportionate size relative to WINDOW.
3097 If FIRST_ONLY is 1, change only the first of WINDOW's children when
3098 they are in series. If LAST_ONLY is 1, change only the last of
3099 WINDOW's children when they are in series.
3101 Propagate WINDOW's top or left edge position to children. Delete
3102 windows that become too small unless NODELETE_P is 1. When
3103 NODELETE_P equals 2 do not honor settings for window-min-height and
3104 window-min-width when resizing windows but use safe defaults instead.
3105 This should give better behavior when resizing frames. */
3107 static void
3108 size_window (Lisp_Object window, int size, int width_p, int nodelete_p, int first_only, int last_only)
3110 struct window *w = XWINDOW (window);
3111 struct window *c;
3112 Lisp_Object child, *forward, *sideward;
3113 int old_size = WINDOW_TOTAL_SIZE (w, width_p);
3115 size = max (0, size);
3117 /* Delete WINDOW if it's too small. */
3118 if (nodelete_p != 1 && !NILP (w->parent)
3119 && size < window_min_size_1 (w, width_p, nodelete_p == 2))
3121 delete_window (window);
3122 return;
3125 /* Set redisplay hints. */
3126 w->last_modified = make_number (0);
3127 w->last_overlay_modified = make_number (0);
3128 windows_or_buffers_changed++;
3129 FRAME_WINDOW_SIZES_CHANGED (XFRAME (w->frame)) = 1;
3131 if (width_p)
3133 sideward = &w->vchild;
3134 forward = &w->hchild;
3135 w->total_cols = make_number (size);
3136 adjust_window_margins (w);
3138 else
3140 sideward = &w->hchild;
3141 forward = &w->vchild;
3142 w->total_lines = make_number (size);
3143 w->orig_total_lines = Qnil;
3146 if (!NILP (*sideward))
3148 /* We have a chain of parallel siblings whose size should all change. */
3149 for (child = *sideward; !NILP (child); child = c->next)
3151 c = XWINDOW (child);
3152 if (width_p)
3153 c->left_col = w->left_col;
3154 else
3155 c->top_line = w->top_line;
3156 size_window (child, size, width_p, nodelete_p,
3157 first_only, last_only);
3160 else if (!NILP (*forward) && last_only)
3162 /* Change the last in a series of siblings. */
3163 Lisp_Object last_child;
3164 int child_size;
3166 for (child = *forward; !NILP (child); child = c->next)
3168 c = XWINDOW (child);
3169 last_child = child;
3172 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3173 size_window (last_child, size - old_size + child_size,
3174 width_p, nodelete_p, first_only, last_only);
3176 else if (!NILP (*forward) && first_only)
3178 /* Change the first in a series of siblings. */
3179 int child_size;
3181 child = *forward;
3182 c = XWINDOW (child);
3184 if (width_p)
3185 c->left_col = w->left_col;
3186 else
3187 c->top_line = w->top_line;
3189 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3190 size_window (child, size - old_size + child_size,
3191 width_p, nodelete_p, first_only, last_only);
3193 else if (!NILP (*forward))
3195 int fixed_size, each, extra, n;
3196 int resize_fixed_p, nfixed;
3197 int last_pos, first_pos, nchildren, total;
3198 int *new_sizes = NULL;
3200 /* Determine the fixed-size portion of this window, and the
3201 number of child windows. */
3202 fixed_size = nchildren = nfixed = total = 0;
3203 for (child = *forward; !NILP (child); child = c->next, ++nchildren)
3205 int child_size;
3207 c = XWINDOW (child);
3208 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3209 total += child_size;
3211 if (window_fixed_size_p (c, width_p, 0))
3213 fixed_size += child_size;
3214 ++nfixed;
3218 /* If the new size is smaller than fixed_size, or if there
3219 aren't any resizable windows, allow resizing fixed-size
3220 windows. */
3221 resize_fixed_p = nfixed == nchildren || size < fixed_size;
3223 /* Compute how many lines/columns to add/remove to each child. The
3224 value of extra takes care of rounding errors. */
3225 n = resize_fixed_p ? nchildren : nchildren - nfixed;
3226 if (size < total && n > 1)
3227 new_sizes = shrink_windows (total, size, nchildren, n,
3228 resize_fixed_p, *forward, width_p,
3229 nodelete_p == 2);
3230 else
3232 each = (size - total) / n;
3233 extra = (size - total) - n * each;
3236 /* Compute new children heights and edge positions. */
3237 first_pos = width_p ? XINT (w->left_col) : XINT (w->top_line);
3238 last_pos = first_pos;
3239 for (n = 0, child = *forward; !NILP (child); child = c->next, ++n)
3241 int new_size, old_size;
3243 c = XWINDOW (child);
3244 old_size = WINDOW_TOTAL_SIZE (c, width_p);
3245 new_size = old_size;
3247 /* The top or left edge position of this child equals the
3248 bottom or right edge of its predecessor. */
3249 if (width_p)
3250 c->left_col = make_number (last_pos);
3251 else
3252 c->top_line = make_number (last_pos);
3254 /* If this child can be resized, do it. */
3255 if (resize_fixed_p || !window_fixed_size_p (c, width_p, 0))
3257 new_size = new_sizes ? new_sizes[n] : old_size + each + extra;
3258 extra = 0;
3261 /* Set new size. Note that size_window also propagates
3262 edge positions to children, so it's not a no-op if we
3263 didn't change the child's size. */
3264 size_window (child, new_size, width_p, 1, first_only, last_only);
3266 /* Remember the bottom/right edge position of this child; it
3267 will be used to set the top/left edge of the next child. */
3268 last_pos += new_size;
3271 xfree (new_sizes);
3273 /* We should have covered the parent exactly with child windows. */
3274 xassert (size == last_pos - first_pos);
3276 /* Now delete any children that became too small. */
3277 if (nodelete_p != 1)
3278 for (child = *forward; !NILP (child); child = c->next)
3280 int child_size;
3282 c = XWINDOW (child);
3283 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3284 size_window (child, child_size, width_p, nodelete_p,
3285 first_only, last_only);
3290 /* Set WINDOW's height to HEIGHT, and recursively change the height of
3291 WINDOW's children. NODELETE zero means windows that have become
3292 smaller than window-min-height in the process may be deleted.
3293 NODELETE 1 means never delete windows that become too small in the
3294 process. (The caller should check later and do so if appropriate.)
3295 NODELETE 2 means delete only windows that have become too small to be
3296 displayed correctly. */
3298 void
3299 set_window_height (Lisp_Object window, int height, int nodelete)
3301 size_window (window, height, 0, nodelete, 0, 0);
3304 /* Set WINDOW's width to WIDTH, and recursively change the width of
3305 WINDOW's children. NODELETE zero means windows that have become
3306 smaller than window-min-width in the process may be deleted.
3307 NODELETE 1 means never delete windows that become too small in the
3308 process. (The caller should check later and do so if appropriate.)
3309 NODELETE 2 means delete only windows that have become too small to be
3310 displayed correctly. */
3312 void
3313 set_window_width (Lisp_Object window, int width, int nodelete)
3315 size_window (window, width, 1, nodelete, 0, 0);
3318 /* Change window heights in windows rooted in WINDOW by N lines. */
3320 void
3321 change_window_heights (Lisp_Object window, int n)
3323 struct window *w = XWINDOW (window);
3325 XSETFASTINT (w->top_line, XFASTINT (w->top_line) + n);
3326 XSETFASTINT (w->total_lines, XFASTINT (w->total_lines) - n);
3328 if (INTEGERP (w->orig_top_line))
3329 XSETFASTINT (w->orig_top_line, XFASTINT (w->orig_top_line) + n);
3330 if (INTEGERP (w->orig_total_lines))
3331 XSETFASTINT (w->orig_total_lines, XFASTINT (w->orig_total_lines) - n);
3333 /* Handle just the top child in a vertical split. */
3334 if (!NILP (w->vchild))
3335 change_window_heights (w->vchild, n);
3337 /* Adjust all children in a horizontal split. */
3338 for (window = w->hchild; !NILP (window); window = w->next)
3340 w = XWINDOW (window);
3341 change_window_heights (window, n);
3346 int window_select_count;
3348 EXFUN (Fset_window_fringes, 4);
3349 EXFUN (Fset_window_scroll_bars, 4);
3351 static void
3352 run_funs (Lisp_Object funs)
3354 for (; CONSP (funs); funs = XCDR (funs))
3355 if (!EQ (XCAR (funs), Qt))
3356 call0 (XCAR (funs));
3359 static Lisp_Object select_window_norecord (Lisp_Object window);
3360 static Lisp_Object select_frame_norecord (Lisp_Object frame);
3362 void
3363 run_window_configuration_change_hook (struct frame *f)
3365 int count = SPECPDL_INDEX ();
3366 Lisp_Object frame, global_wcch
3367 = Fdefault_value (Qwindow_configuration_change_hook);
3368 XSETFRAME (frame, f);
3370 if (NILP (Vrun_hooks))
3371 return;
3373 if (SELECTED_FRAME () != f)
3375 record_unwind_protect (select_frame_norecord, Fselected_frame ());
3376 Fselect_frame (frame, Qt);
3379 /* Use the right buffer. Matters when running the local hooks. */
3380 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3382 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3383 Fset_buffer (Fwindow_buffer (Qnil));
3386 /* Look for buffer-local values. */
3388 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3389 for (; CONSP (windows); windows = XCDR (windows))
3391 Lisp_Object window = XCAR (windows);
3392 Lisp_Object buffer = Fwindow_buffer (window);
3393 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3394 buffer)))
3396 int count = SPECPDL_INDEX ();
3397 record_unwind_protect (select_window_norecord, Fselected_window ());
3398 select_window_norecord (window);
3399 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3400 buffer));
3401 unbind_to (count, Qnil);
3406 run_funs (global_wcch);
3407 unbind_to (count, Qnil);
3410 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
3411 means it's allowed to run hooks. See make_frame for a case where
3412 it's not allowed. KEEP_MARGINS_P non-zero means that the current
3413 margins, fringes, and scroll-bar settings of the window are not
3414 reset from the buffer's local settings. */
3416 void
3417 set_window_buffer (Lisp_Object window, Lisp_Object buffer, int run_hooks_p, int keep_margins_p)
3419 struct window *w = XWINDOW (window);
3420 struct buffer *b = XBUFFER (buffer);
3421 int count = SPECPDL_INDEX ();
3422 int samebuf = EQ (buffer, w->buffer);
3424 w->buffer = buffer;
3426 if (EQ (window, selected_window))
3427 b->last_selected_window = window;
3429 /* Let redisplay errors through. */
3430 b->display_error_modiff = 0;
3432 /* Update time stamps of buffer display. */
3433 if (INTEGERP (b->display_count))
3434 XSETINT (b->display_count, XINT (b->display_count) + 1);
3435 b->display_time = Fcurrent_time ();
3437 XSETFASTINT (w->window_end_pos, 0);
3438 XSETFASTINT (w->window_end_vpos, 0);
3439 memset (&w->last_cursor, 0, sizeof w->last_cursor);
3440 w->window_end_valid = Qnil;
3441 if (!(keep_margins_p && samebuf))
3442 { /* If we're not actually changing the buffer, don't reset hscroll and
3443 vscroll. This case happens for example when called from
3444 change_frame_size_1, where we use a dummy call to
3445 Fset_window_buffer on the frame's selected window (and no other)
3446 just in order to run window-configuration-change-hook.
3447 Resetting hscroll and vscroll here is problematic for things like
3448 image-mode and doc-view-mode since it resets the image's position
3449 whenever we resize the frame. */
3450 w->hscroll = w->min_hscroll = make_number (0);
3451 w->vscroll = 0;
3452 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3453 set_marker_restricted (w->start,
3454 make_number (b->last_window_start),
3455 buffer);
3456 w->start_at_line_beg = Qnil;
3457 w->force_start = Qnil;
3458 XSETFASTINT (w->last_modified, 0);
3459 XSETFASTINT (w->last_overlay_modified, 0);
3461 /* Maybe we could move this into the `if' but it's not obviously safe and
3462 I doubt it's worth the trouble. */
3463 windows_or_buffers_changed++;
3465 /* We must select BUFFER for running the window-scroll-functions. */
3466 /* We can't check ! NILP (Vwindow_scroll_functions) here
3467 because that might itself be a local variable. */
3468 if (window_initialized)
3470 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3471 Fset_buffer (buffer);
3474 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3476 if (!keep_margins_p)
3478 /* Set left and right marginal area width etc. from buffer. */
3480 /* This may call adjust_window_margins three times, so
3481 temporarily disable window margins. */
3482 Lisp_Object save_left = w->left_margin_cols;
3483 Lisp_Object save_right = w->right_margin_cols;
3485 w->left_margin_cols = w->right_margin_cols = Qnil;
3487 Fset_window_fringes (window,
3488 b->left_fringe_width, b->right_fringe_width,
3489 b->fringes_outside_margins);
3491 Fset_window_scroll_bars (window,
3492 b->scroll_bar_width,
3493 b->vertical_scroll_bar_type, Qnil);
3495 w->left_margin_cols = save_left;
3496 w->right_margin_cols = save_right;
3498 Fset_window_margins (window,
3499 b->left_margin_cols, b->right_margin_cols);
3502 if (run_hooks_p)
3504 if (! NILP (Vwindow_scroll_functions))
3505 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3506 Fmarker_position (w->start));
3507 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3510 unbind_to (count, Qnil);
3514 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3515 doc: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3516 WINDOW defaults to the selected window. BUFFER-OR-NAME must be a buffer
3517 or the name of an existing buffer. Optional third argument KEEP-MARGINS
3518 non-nil means that WINDOW's current display margins, fringe widths, and
3519 scroll bar settings are preserved; the default is to reset these from
3520 the local settings for BUFFER-OR-NAME or the frame defaults. Return nil.
3522 This function throws an error when WINDOW is strongly dedicated to its
3523 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3524 already display BUFFER-OR-NAME.
3526 This function runs `window-scroll-functions' before running
3527 `window-configuration-change-hook'. */)
3528 (register Lisp_Object window, Lisp_Object buffer_or_name, Lisp_Object keep_margins)
3530 register Lisp_Object tem, buffer;
3531 register struct window *w = decode_window (window);
3533 XSETWINDOW (window, w);
3534 buffer = Fget_buffer (buffer_or_name);
3535 CHECK_BUFFER (buffer);
3536 if (NILP (XBUFFER (buffer)->name))
3537 error ("Attempt to display deleted buffer");
3539 tem = w->buffer;
3540 if (NILP (tem))
3541 error ("Window is deleted");
3542 else if (!EQ (tem, Qt))
3543 /* w->buffer is t when the window is first being set up. */
3545 if (!EQ (tem, buffer))
3546 if (EQ (w->dedicated, Qt))
3547 error ("Window is dedicated to `%s'", SDATA (XBUFFER (tem)->name));
3548 else
3549 w->dedicated = Qnil;
3551 unshow_buffer (w);
3554 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3555 return Qnil;
3558 /* Note that selected_window can be nil when this is called from
3559 Fset_window_configuration. */
3561 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
3562 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
3563 If WINDOW is not already selected, make WINDOW's buffer current
3564 and make WINDOW the frame's selected window. Return WINDOW.
3565 Optional second arg NORECORD non-nil means do not put this buffer
3566 at the front of the list of recently selected ones and do not
3567 make this window the most recently selected one.
3569 Note that the main editor command loop selects the buffer of the
3570 selected window before each command. */)
3571 (register Lisp_Object window, Lisp_Object norecord)
3573 register struct window *w;
3574 register struct window *ow;
3575 struct frame *sf;
3577 CHECK_LIVE_WINDOW (window);
3579 w = XWINDOW (window);
3580 w->frozen_window_start_p = 0;
3582 if (NILP (norecord))
3584 ++window_select_count;
3585 XSETFASTINT (w->use_time, window_select_count);
3586 record_buffer (w->buffer);
3589 if (EQ (window, selected_window))
3590 return window;
3592 sf = SELECTED_FRAME ();
3593 if (XFRAME (WINDOW_FRAME (w)) != sf)
3595 XFRAME (WINDOW_FRAME (w))->selected_window = window;
3596 /* Use this rather than Fhandle_switch_frame
3597 so that FRAME_FOCUS_FRAME is moved appropriately as we
3598 move around in the state where a minibuffer in a separate
3599 frame is active. */
3600 Fselect_frame (WINDOW_FRAME (w), norecord);
3601 /* Fselect_frame called us back so we've done all the work already. */
3602 eassert (EQ (window, selected_window));
3603 return window;
3605 else
3606 sf->selected_window = window;
3608 /* Store the current buffer's actual point into the
3609 old selected window. It belongs to that window,
3610 and when the window is not selected, must be in the window. */
3611 if (!NILP (selected_window))
3613 ow = XWINDOW (selected_window);
3614 if (! NILP (ow->buffer))
3615 set_marker_both (ow->pointm, ow->buffer,
3616 BUF_PT (XBUFFER (ow->buffer)),
3617 BUF_PT_BYTE (XBUFFER (ow->buffer)));
3620 selected_window = window;
3622 Fset_buffer (w->buffer);
3624 XBUFFER (w->buffer)->last_selected_window = window;
3626 /* Go to the point recorded in the window.
3627 This is important when the buffer is in more
3628 than one window. It also matters when
3629 redisplay_window has altered point after scrolling,
3630 because it makes the change only in the window. */
3632 register EMACS_INT new_point = marker_position (w->pointm);
3633 if (new_point < BEGV)
3634 SET_PT (BEGV);
3635 else if (new_point > ZV)
3636 SET_PT (ZV);
3637 else
3638 SET_PT (new_point);
3641 windows_or_buffers_changed++;
3642 return window;
3645 static Lisp_Object
3646 select_window_norecord (Lisp_Object window)
3648 return WINDOW_LIVE_P (window)
3649 ? Fselect_window (window, Qt) : selected_window;
3652 static Lisp_Object
3653 select_frame_norecord (Lisp_Object frame)
3655 return FRAME_LIVE_P (XFRAME (frame))
3656 ? Fselect_frame (frame, Qt) : selected_frame;
3659 Lisp_Object
3660 display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame)
3662 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3665 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3666 0, 1, 0,
3667 doc: /* Force all windows to be updated on next redisplay.
3668 If optional arg OBJECT is a window, force redisplay of that window only.
3669 If OBJECT is a buffer or buffer name, force redisplay of all windows
3670 displaying that buffer. */)
3671 (Lisp_Object object)
3673 if (NILP (object))
3675 windows_or_buffers_changed++;
3676 update_mode_lines++;
3677 return Qt;
3680 if (WINDOWP (object))
3682 struct window *w = XWINDOW (object);
3683 mark_window_display_accurate (object, 0);
3684 w->update_mode_line = Qt;
3685 if (BUFFERP (w->buffer))
3686 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3687 ++update_mode_lines;
3688 return Qt;
3691 if (STRINGP (object))
3692 object = Fget_buffer (object);
3693 if (BUFFERP (object) && !NILP (XBUFFER (object)->name))
3695 /* Walk all windows looking for buffer, and force update
3696 of each of those windows. */
3698 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3699 return NILP (object) ? Qnil : Qt;
3702 /* If nothing suitable was found, just return.
3703 We could signal an error, but this feature will typically be used
3704 asynchronously in timers or process sentinels, so we don't. */
3705 return Qnil;
3709 void
3710 temp_output_buffer_show (register Lisp_Object buf)
3712 register struct buffer *old = current_buffer;
3713 register Lisp_Object window;
3714 register struct window *w;
3716 XBUFFER (buf)->directory = current_buffer->directory;
3718 Fset_buffer (buf);
3719 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3720 BEGV = BEG;
3721 ZV = Z;
3722 SET_PT (BEG);
3723 #if 0 /* rms: there should be no reason for this. */
3724 XBUFFER (buf)->prevent_redisplay_optimizations_p = 1;
3725 #endif
3726 set_buffer_internal (old);
3728 if (!NILP (Vtemp_buffer_show_function))
3729 call1 (Vtemp_buffer_show_function, buf);
3730 else
3732 window = display_buffer (buf, Qnil, Qnil);
3734 if (!EQ (XWINDOW (window)->frame, selected_frame))
3735 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3736 Vminibuf_scroll_window = window;
3737 w = XWINDOW (window);
3738 XSETFASTINT (w->hscroll, 0);
3739 XSETFASTINT (w->min_hscroll, 0);
3740 set_marker_restricted_both (w->start, buf, BEG, BEG);
3741 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3743 /* Run temp-buffer-show-hook, with the chosen window selected
3744 and its buffer current. */
3746 if (!NILP (Vrun_hooks)
3747 && !NILP (Fboundp (Qtemp_buffer_show_hook))
3748 && !NILP (Fsymbol_value (Qtemp_buffer_show_hook)))
3750 int count = SPECPDL_INDEX ();
3751 Lisp_Object prev_window, prev_buffer;
3752 prev_window = selected_window;
3753 XSETBUFFER (prev_buffer, old);
3755 /* Select the window that was chosen, for running the hook.
3756 Note: Both Fselect_window and select_window_norecord may
3757 set-buffer to the buffer displayed in the window,
3758 so we need to save the current buffer. --stef */
3759 record_unwind_protect (Fset_buffer, prev_buffer);
3760 record_unwind_protect (select_window_norecord, prev_window);
3761 Fselect_window (window, Qt);
3762 Fset_buffer (w->buffer);
3763 call1 (Vrun_hooks, Qtemp_buffer_show_hook);
3764 unbind_to (count, Qnil);
3769 static void
3770 make_dummy_parent (Lisp_Object window)
3772 Lisp_Object new;
3773 register struct window *o, *p;
3774 int i;
3776 o = XWINDOW (window);
3777 p = allocate_window ();
3778 for (i = 0; i < VECSIZE (struct window); ++i)
3779 ((struct Lisp_Vector *) p)->contents[i]
3780 = ((struct Lisp_Vector *)o)->contents[i];
3781 XSETWINDOW (new, p);
3783 ++sequence_number;
3784 XSETFASTINT (p->sequence_number, sequence_number);
3786 /* Put new into window structure in place of window */
3787 replace_window (window, new);
3789 o->next = Qnil;
3790 o->prev = Qnil;
3791 o->vchild = Qnil;
3792 o->hchild = Qnil;
3793 o->parent = new;
3795 p->start = Qnil;
3796 p->pointm = Qnil;
3797 p->buffer = Qnil;
3800 DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "",
3801 doc: /* Split WINDOW, putting SIZE lines in the first of the pair.
3802 WINDOW defaults to selected one and SIZE to half its size.
3803 If optional third arg HORIZONTAL is non-nil, split side by side and put
3804 SIZE columns in the first of the pair. In that case, SIZE includes that
3805 window's scroll bar, or the divider column to its right.
3806 Interactively, all arguments are nil.
3807 Returns the newly created window (which is the lower or rightmost one).
3808 The upper or leftmost window is the original one, and remains selected
3809 if it was selected before.
3811 See Info node `(elisp)Splitting Windows' for more details and examples. */)
3812 (Lisp_Object window, Lisp_Object size, Lisp_Object horizontal)
3814 register Lisp_Object new;
3815 register struct window *o, *p;
3816 FRAME_PTR fo;
3817 register int size_int;
3819 if (NILP (window))
3820 window = selected_window;
3821 else
3822 CHECK_LIVE_WINDOW (window);
3824 o = XWINDOW (window);
3825 fo = XFRAME (WINDOW_FRAME (o));
3827 if (NILP (size))
3829 if (!NILP (horizontal))
3830 /* Calculate the size of the left-hand window, by dividing
3831 the usable space in columns by two.
3832 We round up, since the left-hand window may include
3833 a dividing line, while the right-hand may not. */
3834 size_int = (XFASTINT (o->total_cols) + 1) >> 1;
3835 else
3836 size_int = XFASTINT (o->total_lines) >> 1;
3838 else
3840 CHECK_NUMBER (size);
3841 size_int = XINT (size);
3844 if (MINI_WINDOW_P (o))
3845 error ("Attempt to split minibuffer window");
3846 else if (window_fixed_size_p (o, !NILP (horizontal), 0))
3847 error ("Attempt to split fixed-size window");
3849 if (NILP (horizontal))
3851 int window_safe_height = window_min_size_2 (o, 0, 0);
3853 if (size_int < window_safe_height)
3854 error ("Window height %d too small (after splitting)", size_int);
3855 if (size_int + window_safe_height > XFASTINT (o->total_lines))
3856 error ("Window height %d too small (after splitting)",
3857 XFASTINT (o->total_lines) - size_int);
3858 if (NILP (o->parent)
3859 || NILP (XWINDOW (o->parent)->vchild))
3861 make_dummy_parent (window);
3862 new = o->parent;
3863 XWINDOW (new)->vchild = window;
3866 else
3868 int window_safe_width = window_min_size_2 (o, 1, 0);
3870 if (size_int < window_safe_width)
3871 error ("Window width %d too small (after splitting)", size_int);
3872 if (size_int + window_safe_width > XFASTINT (o->total_cols))
3873 error ("Window width %d too small (after splitting)",
3874 XFASTINT (o->total_cols) - size_int);
3875 if (NILP (o->parent)
3876 || NILP (XWINDOW (o->parent)->hchild))
3878 make_dummy_parent (window);
3879 new = o->parent;
3880 XWINDOW (new)->hchild = window;
3884 /* Now we know that window's parent is a vertical combination
3885 if we are dividing vertically, or a horizontal combination
3886 if we are making side-by-side windows */
3888 windows_or_buffers_changed++;
3889 FRAME_WINDOW_SIZES_CHANGED (fo) = 1;
3890 new = make_window ();
3891 p = XWINDOW (new);
3893 p->frame = o->frame;
3894 p->next = o->next;
3895 if (!NILP (p->next))
3896 XWINDOW (p->next)->prev = new;
3897 p->prev = window;
3898 o->next = new;
3899 p->parent = o->parent;
3900 p->buffer = Qt;
3901 p->window_end_valid = Qnil;
3902 memset (&p->last_cursor, 0, sizeof p->last_cursor);
3904 /* Duplicate special geometry settings. */
3906 p->left_margin_cols = o->left_margin_cols;
3907 p->right_margin_cols = o->right_margin_cols;
3908 p->left_fringe_width = o->left_fringe_width;
3909 p->right_fringe_width = o->right_fringe_width;
3910 p->fringes_outside_margins = o->fringes_outside_margins;
3911 p->scroll_bar_width = o->scroll_bar_width;
3912 p->vertical_scroll_bar_type = o->vertical_scroll_bar_type;
3914 /* Apportion the available frame space among the two new windows */
3916 if (!NILP (horizontal))
3918 p->total_lines = o->total_lines;
3919 p->top_line = o->top_line;
3920 XSETFASTINT (p->total_cols, XFASTINT (o->total_cols) - size_int);
3921 XSETFASTINT (o->total_cols, size_int);
3922 XSETFASTINT (p->left_col, XFASTINT (o->left_col) + size_int);
3923 adjust_window_margins (p);
3924 adjust_window_margins (o);
3926 else
3928 p->left_col = o->left_col;
3929 p->total_cols = o->total_cols;
3930 XSETFASTINT (p->total_lines, XFASTINT (o->total_lines) - size_int);
3931 XSETFASTINT (o->total_lines, size_int);
3932 XSETFASTINT (p->top_line, XFASTINT (o->top_line) + size_int);
3935 /* Adjust glyph matrices. */
3936 adjust_glyphs (fo);
3938 Fset_window_buffer (new, o->buffer, Qt);
3939 return new;
3942 DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 2, "p",
3943 doc: /* Make selected window SIZE lines taller.
3944 Interactively, if no argument is given, make the selected window one
3945 line taller. If optional argument HORIZONTAL is non-nil, make selected
3946 window wider by SIZE columns. If SIZE is negative, shrink the window by
3947 -SIZE lines or columns. Return nil.
3949 This function can delete windows if they get too small. The size of
3950 fixed size windows is not altered by this function. */)
3951 (Lisp_Object size, Lisp_Object horizontal)
3953 CHECK_NUMBER (size);
3954 enlarge_window (selected_window, XINT (size), !NILP (horizontal));
3956 run_window_configuration_change_hook (SELECTED_FRAME ());
3958 return Qnil;
3961 DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 2, "p",
3962 doc: /* Make selected window SIZE lines smaller.
3963 Interactively, if no argument is given, make the selected window one
3964 line smaller. If optional argument HORIZONTAL is non-nil, make the
3965 window narrower by SIZE columns. If SIZE is negative, enlarge selected
3966 window by -SIZE lines or columns. Return nil.
3968 This function can delete windows if they get too small. The size of
3969 fixed size windows is not altered by this function. */)
3970 (Lisp_Object size, Lisp_Object horizontal)
3972 CHECK_NUMBER (size);
3973 enlarge_window (selected_window, -XINT (size), !NILP (horizontal));
3975 run_window_configuration_change_hook (SELECTED_FRAME ());
3977 return Qnil;
3981 window_height (Lisp_Object window)
3983 register struct window *p = XWINDOW (window);
3984 return WINDOW_TOTAL_LINES (p);
3988 window_width (Lisp_Object window)
3990 register struct window *p = XWINDOW (window);
3991 return WINDOW_TOTAL_COLS (p);
3995 #define CURBEG(w) \
3996 *(horiz_flag ? &(XWINDOW (w)->left_col) : &(XWINDOW (w)->top_line))
3998 #define CURSIZE(w) \
3999 *(horiz_flag ? &(XWINDOW (w)->total_cols) : &(XWINDOW (w)->total_lines))
4002 /* Enlarge WINDOW by DELTA. HORIZ_FLAG nonzero means enlarge it
4003 horizontally; zero means do it vertically.
4005 Siblings of the selected window are resized to fulfill the size
4006 request. If they become too small in the process, they may be
4007 deleted. */
4009 static void
4010 enlarge_window (Lisp_Object window, int delta, int horiz_flag)
4012 Lisp_Object parent, next, prev;
4013 struct window *p;
4014 Lisp_Object *sizep;
4015 int maximum;
4016 int (*sizefun) (Lisp_Object)
4017 = horiz_flag ? window_width : window_height;
4018 void (*setsizefun) (Lisp_Object, int, int)
4019 = (horiz_flag ? set_window_width : set_window_height);
4021 /* Give up if this window cannot be resized. */
4022 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
4023 error ("Window is not resizable");
4025 /* Find the parent of the selected window. */
4026 while (1)
4028 p = XWINDOW (window);
4029 parent = p->parent;
4031 if (NILP (parent))
4033 if (horiz_flag)
4034 error ("No other window to side of this one");
4035 break;
4038 if (horiz_flag
4039 ? !NILP (XWINDOW (parent)->hchild)
4040 : !NILP (XWINDOW (parent)->vchild))
4041 break;
4043 window = parent;
4046 sizep = &CURSIZE (window);
4049 register int maxdelta;
4051 /* Compute the maximum size increment this window can have. */
4053 maxdelta = (!NILP (parent) ? (*sizefun) (parent) - XINT (*sizep)
4054 /* This is a main window followed by a minibuffer. */
4055 : !NILP (p->next) ? ((*sizefun) (p->next)
4056 - window_min_size (XWINDOW (p->next),
4057 horiz_flag, 0, 0, 0))
4058 /* This is a minibuffer following a main window. */
4059 : !NILP (p->prev) ? ((*sizefun) (p->prev)
4060 - window_min_size (XWINDOW (p->prev),
4061 horiz_flag, 0, 0, 0))
4062 /* This is a frame with only one window, a minibuffer-only
4063 or a minibufferless frame. */
4064 : (delta = 0));
4066 if (delta > maxdelta)
4067 /* This case traps trying to make the minibuffer
4068 the full frame, or make the only window aside from the
4069 minibuffer the full frame. */
4070 delta = maxdelta;
4073 if (XINT (*sizep) + delta < window_min_size (XWINDOW (window),
4074 horiz_flag, 0, 0, 0))
4076 delete_window (window);
4077 return;
4080 if (delta == 0)
4081 return;
4083 /* Find the total we can get from other siblings without deleting them. */
4084 maximum = 0;
4085 for (next = p->next; WINDOWP (next); next = XWINDOW (next)->next)
4086 maximum += (*sizefun) (next) - window_min_size (XWINDOW (next),
4087 horiz_flag, 0, 0, 0);
4088 for (prev = p->prev; WINDOWP (prev); prev = XWINDOW (prev)->prev)
4089 maximum += (*sizefun) (prev) - window_min_size (XWINDOW (prev),
4090 horiz_flag, 0, 0, 0);
4092 /* If we can get it all from them without deleting them, do so. */
4093 if (delta <= maximum)
4095 Lisp_Object first_unaffected;
4096 Lisp_Object first_affected;
4097 int fixed_p;
4099 next = p->next;
4100 prev = p->prev;
4101 first_affected = window;
4102 /* Look at one sibling at a time,
4103 moving away from this window in both directions alternately,
4104 and take as much as we can get without deleting that sibling. */
4105 while (delta != 0
4106 && (!NILP (next) || !NILP (prev)))
4108 if (! NILP (next))
4110 int this_one = ((*sizefun) (next)
4111 - window_min_size (XWINDOW (next), horiz_flag,
4112 0, 0, &fixed_p));
4113 if (!fixed_p)
4115 if (this_one > delta)
4116 this_one = delta;
4118 (*setsizefun) (next, (*sizefun) (next) - this_one, 0);
4119 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4121 delta -= this_one;
4124 next = XWINDOW (next)->next;
4127 if (delta == 0)
4128 break;
4130 if (! NILP (prev))
4132 int this_one = ((*sizefun) (prev)
4133 - window_min_size (XWINDOW (prev), horiz_flag,
4134 0, 0, &fixed_p));
4135 if (!fixed_p)
4137 if (this_one > delta)
4138 this_one = delta;
4140 first_affected = prev;
4142 (*setsizefun) (prev, (*sizefun) (prev) - this_one, 0);
4143 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4145 delta -= this_one;
4148 prev = XWINDOW (prev)->prev;
4152 xassert (delta == 0);
4154 /* Now recalculate the edge positions of all the windows affected,
4155 based on the new sizes. */
4156 first_unaffected = next;
4157 prev = first_affected;
4158 for (next = XWINDOW (prev)->next; ! EQ (next, first_unaffected);
4159 prev = next, next = XWINDOW (next)->next)
4161 XSETINT (CURBEG (next), XINT (CURBEG (prev)) + (*sizefun) (prev));
4162 /* This does not change size of NEXT,
4163 but it propagates the new top edge to its children */
4164 (*setsizefun) (next, (*sizefun) (next), 0);
4167 else
4169 register int delta1;
4170 register int opht = (*sizefun) (parent);
4172 if (opht <= XINT (*sizep) + delta)
4174 /* If trying to grow this window to or beyond size of the parent,
4175 just delete all the sibling windows. */
4176 Lisp_Object start, tem, next;
4178 start = XWINDOW (parent)->vchild;
4179 if (NILP (start))
4180 start = XWINDOW (parent)->hchild;
4182 /* Delete any siblings that come after WINDOW. */
4183 tem = XWINDOW (window)->next;
4184 while (! NILP (tem))
4186 next = XWINDOW (tem)->next;
4187 delete_window (tem);
4188 tem = next;
4191 /* Delete any siblings that come after WINDOW.
4192 Note that if START is not WINDOW, then WINDOW still
4193 has siblings, so WINDOW has not yet replaced its parent. */
4194 tem = start;
4195 while (! EQ (tem, window))
4197 next = XWINDOW (tem)->next;
4198 delete_window (tem);
4199 tem = next;
4202 else
4204 /* Otherwise, make delta1 just right so that if we add
4205 delta1 lines to this window and to the parent, and then
4206 shrink the parent back to its original size, the new
4207 proportional size of this window will increase by delta.
4209 The function size_window will compute the new height h'
4210 of the window from delta1 as:
4212 e = delta1/n
4213 x = delta1 - delta1/n * n for the 1st resizable child
4214 h' = h + e + x
4216 where n is the number of children that can be resized.
4217 We can ignore x by choosing a delta1 that is a multiple of
4218 n. We want the height of this window to come out as
4220 h' = h + delta
4222 So, delta1 must be
4224 h + e = h + delta
4225 delta1/n = delta
4226 delta1 = n * delta.
4228 The number of children n equals the number of resizable
4229 children of this window + 1 because we know window itself
4230 is resizable (otherwise we would have signaled an error).
4232 This reasoning is not correct when other windows become too
4233 small and shrink_windows refuses to delete them. Below we
4234 use resize_proportionally to work around this problem. */
4236 struct window *w = XWINDOW (window);
4237 Lisp_Object s;
4238 int n = 1;
4240 for (s = w->next; WINDOWP (s); s = XWINDOW (s)->next)
4241 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4242 ++n;
4243 for (s = w->prev; WINDOWP (s); s = XWINDOW (s)->prev)
4244 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4245 ++n;
4247 delta1 = n * delta;
4249 /* Add delta1 lines or columns to this window, and to the parent,
4250 keeping things consistent while not affecting siblings. */
4251 XSETINT (CURSIZE (parent), opht + delta1);
4252 (*setsizefun) (window, XINT (*sizep) + delta1, 0);
4254 /* Squeeze out delta1 lines or columns from our parent,
4255 shrinking this window and siblings proportionately. This
4256 brings parent back to correct size. Delta1 was calculated
4257 so this makes this window the desired size, taking it all
4258 out of the siblings.
4260 Temporarily set resize_proportionally to Qt to assure that,
4261 if necessary, shrink_windows deletes smaller windows rather
4262 than shrink this window. */
4263 w->resize_proportionally = Qt;
4264 (*setsizefun) (parent, opht, 0);
4265 w->resize_proportionally = Qnil;
4269 XSETFASTINT (p->last_modified, 0);
4270 XSETFASTINT (p->last_overlay_modified, 0);
4272 /* Adjust glyph matrices. */
4273 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4277 /* Adjust the size of WINDOW by DELTA, moving only its trailing edge.
4278 HORIZ_FLAG nonzero means adjust the width, moving the right edge.
4279 zero means adjust the height, moving the bottom edge.
4281 Following siblings of the selected window are resized to fulfill
4282 the size request. If they become too small in the process, they
4283 are not deleted; instead, we signal an error. */
4285 static void
4286 adjust_window_trailing_edge (Lisp_Object window, int delta, int horiz_flag)
4288 Lisp_Object parent, child;
4289 struct window *p;
4290 Lisp_Object old_config = Fcurrent_window_configuration (Qnil);
4291 int delcount = window_deletion_count;
4293 CHECK_WINDOW (window);
4295 /* Give up if this window cannot be resized. */
4296 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
4297 error ("Window is not resizable");
4299 while (1)
4301 Lisp_Object first_parallel = Qnil;
4303 if (NILP (window))
4305 /* This happens if WINDOW on the previous iteration was
4306 at top level of the window tree. */
4307 Fset_window_configuration (old_config);
4308 error ("Specified window edge is fixed");
4311 p = XWINDOW (window);
4312 parent = p->parent;
4314 /* See if this level has windows in parallel in the specified
4315 direction. If so, set FIRST_PARALLEL to the first one. */
4316 if (horiz_flag)
4318 if (! NILP (parent) && !NILP (XWINDOW (parent)->vchild))
4319 first_parallel = XWINDOW (parent)->vchild;
4320 else if (NILP (parent) && !NILP (p->next))
4322 /* Handle the vertical chain of main window and minibuffer
4323 which has no parent. */
4324 first_parallel = window;
4325 while (! NILP (XWINDOW (first_parallel)->prev))
4326 first_parallel = XWINDOW (first_parallel)->prev;
4329 else
4331 if (! NILP (parent) && !NILP (XWINDOW (parent)->hchild))
4332 first_parallel = XWINDOW (parent)->hchild;
4335 /* If this level's succession is in the desired dimension,
4336 and this window is the last one, and there is no higher level,
4337 its trailing edge is fixed. */
4338 if (NILP (XWINDOW (window)->next) && NILP (first_parallel)
4339 && NILP (parent))
4341 Fset_window_configuration (old_config);
4342 error ("Specified window edge is fixed");
4345 /* Don't make this window too small. */
4346 if (XINT (CURSIZE (window)) + delta
4347 < window_min_size_2 (XWINDOW (window), horiz_flag, 0))
4349 Fset_window_configuration (old_config);
4350 error ("Cannot adjust window size as specified");
4353 /* Clear out some redisplay caches. */
4354 XSETFASTINT (p->last_modified, 0);
4355 XSETFASTINT (p->last_overlay_modified, 0);
4357 /* Adjust this window's edge. */
4358 XSETINT (CURSIZE (window),
4359 XINT (CURSIZE (window)) + delta);
4361 /* If this window has following siblings in the desired dimension,
4362 make them smaller, and exit the loop.
4364 (If we reach the top of the tree and can never do this,
4365 we will fail and report an error, above.) */
4366 if (NILP (first_parallel))
4368 if (!NILP (p->next))
4370 /* This may happen for the minibuffer. In that case
4371 the window_deletion_count check below does not work. */
4372 if (XINT (CURSIZE (p->next)) - delta <= 0)
4374 Fset_window_configuration (old_config);
4375 error ("Cannot adjust window size as specified");
4378 XSETINT (CURBEG (p->next),
4379 XINT (CURBEG (p->next)) + delta);
4380 size_window (p->next, XINT (CURSIZE (p->next)) - delta,
4381 horiz_flag, 0, 1, 0);
4382 break;
4385 else
4386 /* Here we have a chain of parallel siblings, in the other dimension.
4387 Change the size of the other siblings. */
4388 for (child = first_parallel;
4389 ! NILP (child);
4390 child = XWINDOW (child)->next)
4391 if (! EQ (child, window))
4392 size_window (child, XINT (CURSIZE (child)) + delta,
4393 horiz_flag, 0, 0, 1);
4395 window = parent;
4398 /* If we made a window so small it got deleted,
4399 we failed. Report failure. */
4400 if (delcount != window_deletion_count)
4402 Fset_window_configuration (old_config);
4403 error ("Cannot adjust window size as specified");
4406 /* Adjust glyph matrices. */
4407 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4410 #undef CURBEG
4411 #undef CURSIZE
4413 DEFUN ("adjust-window-trailing-edge", Fadjust_window_trailing_edge,
4414 Sadjust_window_trailing_edge, 3, 3, 0,
4415 doc: /* Adjust the bottom or right edge of WINDOW by DELTA.
4416 If HORIZONTAL is non-nil, that means adjust the width, moving the right edge.
4417 Otherwise, adjust the height, moving the bottom edge.
4419 Following siblings of the selected window are resized to fulfill
4420 the size request. If they become too small in the process, they
4421 are not deleted; instead, we signal an error. */)
4422 (Lisp_Object window, Lisp_Object delta, Lisp_Object horizontal)
4424 CHECK_NUMBER (delta);
4425 if (NILP (window))
4426 window = selected_window;
4427 adjust_window_trailing_edge (window, XINT (delta), !NILP (horizontal));
4429 run_window_configuration_change_hook
4430 (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4432 return Qnil;
4437 /***********************************************************************
4438 Resizing Mini-Windows
4439 ***********************************************************************/
4441 static void shrink_window_lowest_first (struct window *, int);
4443 enum save_restore_action
4445 CHECK_ORIG_SIZES,
4446 SAVE_ORIG_SIZES,
4447 RESTORE_ORIG_SIZES
4450 static int save_restore_orig_size (struct window *,
4451 enum save_restore_action);
4453 /* Shrink windows rooted in window W to HEIGHT. Take the space needed
4454 from lowest windows first. */
4456 static void
4457 shrink_window_lowest_first (struct window *w, int height)
4459 struct window *c;
4460 Lisp_Object child;
4461 int old_height;
4463 xassert (!MINI_WINDOW_P (w));
4465 /* Set redisplay hints. */
4466 XSETFASTINT (w->last_modified, 0);
4467 XSETFASTINT (w->last_overlay_modified, 0);
4468 windows_or_buffers_changed++;
4469 FRAME_WINDOW_SIZES_CHANGED (XFRAME (WINDOW_FRAME (w))) = 1;
4471 old_height = XFASTINT (w->total_lines);
4472 XSETFASTINT (w->total_lines, height);
4474 if (!NILP (w->hchild))
4476 for (child = w->hchild; !NILP (child); child = c->next)
4478 c = XWINDOW (child);
4479 c->top_line = w->top_line;
4480 shrink_window_lowest_first (c, height);
4483 else if (!NILP (w->vchild))
4485 Lisp_Object last_child;
4486 int delta = old_height - height;
4487 int last_top;
4489 last_child = Qnil;
4491 /* Find the last child. We are taking space from lowest windows
4492 first, so we iterate over children from the last child
4493 backwards. */
4494 for (child = w->vchild; WINDOWP (child); child = XWINDOW (child)->next)
4495 last_child = child;
4497 /* Size children down to their safe heights. */
4498 for (child = last_child; delta && !NILP (child); child = c->prev)
4500 int this_one;
4502 c = XWINDOW (child);
4503 this_one = XFASTINT (c->total_lines) - window_min_size_1 (c, 0, 1);
4505 if (this_one > delta)
4506 this_one = delta;
4508 shrink_window_lowest_first (c, XFASTINT (c->total_lines) - this_one);
4509 delta -= this_one;
4512 /* Compute new positions. */
4513 last_top = XINT (w->top_line);
4514 for (child = w->vchild; !NILP (child); child = c->next)
4516 c = XWINDOW (child);
4517 c->top_line = make_number (last_top);
4518 shrink_window_lowest_first (c, XFASTINT (c->total_lines));
4519 last_top += XFASTINT (c->total_lines);
4525 /* Save, restore, or check positions and sizes in the window tree
4526 rooted at W. ACTION says what to do.
4528 If ACTION is CHECK_ORIG_SIZES, check if orig_top_line and
4529 orig_total_lines members are valid for all windows in the window
4530 tree. Value is non-zero if they are valid.
4532 If ACTION is SAVE_ORIG_SIZES, save members top and height in
4533 orig_top_line and orig_total_lines for all windows in the tree.
4535 If ACTION is RESTORE_ORIG_SIZES, restore top and height from values
4536 stored in orig_top_line and orig_total_lines for all windows. */
4538 static int
4539 save_restore_orig_size (struct window *w, enum save_restore_action action)
4541 int success_p = 1;
4543 while (w)
4545 if (!NILP (w->hchild))
4547 if (!save_restore_orig_size (XWINDOW (w->hchild), action))
4548 success_p = 0;
4550 else if (!NILP (w->vchild))
4552 if (!save_restore_orig_size (XWINDOW (w->vchild), action))
4553 success_p = 0;
4556 switch (action)
4558 case CHECK_ORIG_SIZES:
4559 if (!INTEGERP (w->orig_top_line) || !INTEGERP (w->orig_total_lines))
4560 return 0;
4561 break;
4563 case SAVE_ORIG_SIZES:
4564 w->orig_top_line = w->top_line;
4565 w->orig_total_lines = w->total_lines;
4566 XSETFASTINT (w->last_modified, 0);
4567 XSETFASTINT (w->last_overlay_modified, 0);
4568 break;
4570 case RESTORE_ORIG_SIZES:
4571 xassert (INTEGERP (w->orig_top_line) && INTEGERP (w->orig_total_lines));
4572 w->top_line = w->orig_top_line;
4573 w->total_lines = w->orig_total_lines;
4574 w->orig_total_lines = w->orig_top_line = Qnil;
4575 XSETFASTINT (w->last_modified, 0);
4576 XSETFASTINT (w->last_overlay_modified, 0);
4577 break;
4579 default:
4580 abort ();
4583 w = NILP (w->next) ? NULL : XWINDOW (w->next);
4586 return success_p;
4590 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we can
4591 without deleting other windows. */
4593 void
4594 grow_mini_window (struct window *w, int delta)
4596 struct frame *f = XFRAME (w->frame);
4597 struct window *root;
4599 xassert (MINI_WINDOW_P (w));
4600 /* Commenting out the following assertion goes against the stated interface
4601 of the function, but it currently does not seem to do anything useful.
4602 See discussion of this issue in the thread for bug#4534.
4603 xassert (delta >= 0); */
4605 /* Compute how much we can enlarge the mini-window without deleting
4606 other windows. */
4607 root = XWINDOW (FRAME_ROOT_WINDOW (f));
4608 if (delta > 0)
4610 int min_height = window_min_size (root, 0, 0, 0, 0);
4611 if (XFASTINT (root->total_lines) - delta < min_height)
4612 /* Note that the root window may already be smaller than
4613 min_height. */
4614 delta = max (0, XFASTINT (root->total_lines) - min_height);
4617 if (delta)
4619 /* Save original window sizes and positions, if not already done. */
4620 if (!save_restore_orig_size (root, CHECK_ORIG_SIZES))
4621 save_restore_orig_size (root, SAVE_ORIG_SIZES);
4623 /* Shrink other windows. */
4624 shrink_window_lowest_first (root, XFASTINT (root->total_lines) - delta);
4626 /* Grow the mini-window. */
4627 w->top_line = make_number (XFASTINT (root->top_line) + XFASTINT (root->total_lines));
4628 w->total_lines = make_number (XFASTINT (w->total_lines) + delta);
4629 XSETFASTINT (w->last_modified, 0);
4630 XSETFASTINT (w->last_overlay_modified, 0);
4632 adjust_glyphs (f);
4637 /* Shrink mini-window W. If there is recorded info about window sizes
4638 before a call to grow_mini_window, restore recorded window sizes.
4639 Otherwise, if the mini-window is higher than 1 line, resize it to 1
4640 line. */
4642 void
4643 shrink_mini_window (struct window *w)
4645 struct frame *f = XFRAME (w->frame);
4646 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
4648 if (save_restore_orig_size (root, CHECK_ORIG_SIZES))
4650 save_restore_orig_size (root, RESTORE_ORIG_SIZES);
4651 adjust_glyphs (f);
4652 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4653 windows_or_buffers_changed = 1;
4655 else if (XFASTINT (w->total_lines) > 1)
4657 /* Distribute the additional lines of the mini-window
4658 among the other windows. */
4659 Lisp_Object window;
4660 XSETWINDOW (window, w);
4661 enlarge_window (window, 1 - XFASTINT (w->total_lines), 0);
4667 /* Mark window cursors off for all windows in the window tree rooted
4668 at W by setting their phys_cursor_on_p flag to zero. Called from
4669 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4670 the frame are cleared. */
4672 void
4673 mark_window_cursors_off (struct window *w)
4675 while (w)
4677 if (!NILP (w->hchild))
4678 mark_window_cursors_off (XWINDOW (w->hchild));
4679 else if (!NILP (w->vchild))
4680 mark_window_cursors_off (XWINDOW (w->vchild));
4681 else
4682 w->phys_cursor_on_p = 0;
4684 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4689 /* Return number of lines of text (not counting mode lines) in W. */
4692 window_internal_height (struct window *w)
4694 int ht = XFASTINT (w->total_lines);
4696 if (!MINI_WINDOW_P (w))
4698 if (!NILP (w->parent)
4699 || !NILP (w->vchild)
4700 || !NILP (w->hchild)
4701 || !NILP (w->next)
4702 || !NILP (w->prev)
4703 || WINDOW_WANTS_MODELINE_P (w))
4704 --ht;
4706 if (WINDOW_WANTS_HEADER_LINE_P (w))
4707 --ht;
4710 return ht;
4714 /* Return the number of columns in W.
4715 Don't count columns occupied by scroll bars or the vertical bar
4716 separating W from the sibling to its right. */
4719 window_box_text_cols (struct window *w)
4721 struct frame *f = XFRAME (WINDOW_FRAME (w));
4722 int width = XINT (w->total_cols);
4724 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
4725 /* Scroll bars occupy a few columns. */
4726 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
4727 else if (!FRAME_WINDOW_P (f)
4728 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
4729 /* The column of `|' characters separating side-by-side windows
4730 occupies one column only. */
4731 width -= 1;
4733 if (FRAME_WINDOW_P (f))
4734 /* On window-systems, fringes and display margins cannot be
4735 used for normal text. */
4736 width -= (WINDOW_FRINGE_COLS (w)
4737 + WINDOW_LEFT_MARGIN_COLS (w)
4738 + WINDOW_RIGHT_MARGIN_COLS (w));
4740 return width;
4744 /************************************************************************
4745 Window Scrolling
4746 ***********************************************************************/
4748 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4749 N screen-fulls, which is defined as the height of the window minus
4750 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4751 instead. Negative values of N mean scroll down. NOERROR non-zero
4752 means don't signal an error if we try to move over BEGV or ZV,
4753 respectively. */
4755 static void
4756 window_scroll (Lisp_Object window, int n, int whole, int noerror)
4758 immediate_quit = 1;
4760 /* If we must, use the pixel-based version which is much slower than
4761 the line-based one but can handle varying line heights. */
4762 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4763 window_scroll_pixel_based (window, n, whole, noerror);
4764 else
4765 window_scroll_line_based (window, n, whole, noerror);
4767 immediate_quit = 0;
4771 /* Implementation of window_scroll that works based on pixel line
4772 heights. See the comment of window_scroll for parameter
4773 descriptions. */
4775 static void
4776 window_scroll_pixel_based (Lisp_Object window, int n, int whole, int noerror)
4778 struct it it;
4779 struct window *w = XWINDOW (window);
4780 struct text_pos start;
4781 int this_scroll_margin;
4782 /* True if we fiddled the window vscroll field without really scrolling. */
4783 int vscrolled = 0;
4784 int x, y, rtop, rbot, rowh, vpos;
4786 SET_TEXT_POS_FROM_MARKER (start, w->start);
4788 /* If PT is not visible in WINDOW, move back one half of
4789 the screen. Allow PT to be partially visible, otherwise
4790 something like (scroll-down 1) with PT in the line before
4791 the partially visible one would recenter. */
4793 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4795 /* Move backward half the height of the window. Performance note:
4796 vmotion used here is about 10% faster, but would give wrong
4797 results for variable height lines. */
4798 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4799 it.current_y = it.last_visible_y;
4800 move_it_vertically_backward (&it, window_box_height (w) / 2);
4802 /* The function move_iterator_vertically may move over more than
4803 the specified y-distance. If it->w is small, e.g. a
4804 mini-buffer window, we may end up in front of the window's
4805 display area. This is the case when Start displaying at the
4806 start of the line containing PT in this case. */
4807 if (it.current_y <= 0)
4809 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4810 move_it_vertically_backward (&it, 0);
4811 it.current_y = 0;
4814 start = it.current.pos;
4816 else if (auto_window_vscroll_p)
4818 if (rtop || rbot) /* partially visible */
4820 int px;
4821 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4822 if (whole)
4823 dy = max ((window_box_height (w)
4824 - next_screen_context_lines * dy),
4825 dy);
4826 dy *= n;
4828 if (n < 0)
4830 /* Only vscroll backwards if already vscrolled forwards. */
4831 if (w->vscroll < 0 && rtop > 0)
4833 px = max (0, -w->vscroll - min (rtop, -dy));
4834 Fset_window_vscroll (window, make_number (px), Qt);
4835 return;
4838 if (n > 0)
4840 /* Do vscroll if already vscrolled or only display line. */
4841 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4843 px = max (0, -w->vscroll + min (rbot, dy));
4844 Fset_window_vscroll (window, make_number (px), Qt);
4845 return;
4848 /* Maybe modify window start instead of scrolling. */
4849 if (rbot > 0 || w->vscroll < 0)
4851 EMACS_INT spos;
4853 Fset_window_vscroll (window, make_number (0), Qt);
4854 /* If there are other text lines above the current row,
4855 move window start to current row. Else to next row. */
4856 if (rbot > 0)
4857 spos = XINT (Fline_beginning_position (Qnil));
4858 else
4859 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4860 set_marker_restricted (w->start, make_number (spos),
4861 w->buffer);
4862 w->start_at_line_beg = Qt;
4863 w->update_mode_line = Qt;
4864 XSETFASTINT (w->last_modified, 0);
4865 XSETFASTINT (w->last_overlay_modified, 0);
4866 /* Set force_start so that redisplay_window will run the
4867 window-scroll-functions. */
4868 w->force_start = Qt;
4869 return;
4873 /* Cancel previous vscroll. */
4874 Fset_window_vscroll (window, make_number (0), Qt);
4877 /* If scroll_preserve_screen_position is non-nil, we try to set
4878 point in the same window line as it is now, so get that line. */
4879 if (!NILP (Vscroll_preserve_screen_position))
4881 /* We preserve the goal pixel coordinate across consecutive
4882 calls to scroll-up, scroll-down and other commands that
4883 have the `scroll-command' property. This avoids the
4884 possibility of point becoming "stuck" on a tall line when
4885 scrolling by one line. */
4886 if (window_scroll_pixel_based_preserve_y < 0
4887 || !SYMBOLP (current_kboard->Vlast_command)
4888 || NILP (Fget (current_kboard->Vlast_command, Qscroll_command)))
4890 start_display (&it, w, start);
4891 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4892 window_scroll_pixel_based_preserve_y = it.current_y;
4893 window_scroll_pixel_based_preserve_x = it.current_x;
4896 else
4897 window_scroll_pixel_based_preserve_y
4898 = window_scroll_pixel_based_preserve_x = -1;
4900 /* Move iterator it from start the specified distance forward or
4901 backward. The result is the new window start. */
4902 start_display (&it, w, start);
4903 if (whole)
4905 EMACS_INT start_pos = IT_CHARPOS (it);
4906 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4907 dy = max ((window_box_height (w)
4908 - next_screen_context_lines * dy),
4909 dy) * n;
4911 /* Note that move_it_vertically always moves the iterator to the
4912 start of a line. So, if the last line doesn't have a newline,
4913 we would end up at the start of the line ending at ZV. */
4914 if (dy <= 0)
4916 move_it_vertically_backward (&it, -dy);
4917 /* Ensure we actually do move, e.g. in case we are currently
4918 looking at an image that is taller that the window height. */
4919 while (start_pos == IT_CHARPOS (it)
4920 && start_pos > BEGV)
4921 move_it_by_lines (&it, -1, 1);
4923 else if (dy > 0)
4925 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4926 MOVE_TO_POS | MOVE_TO_Y);
4927 /* Ensure we actually do move, e.g. in case we are currently
4928 looking at an image that is taller that the window height. */
4929 while (start_pos == IT_CHARPOS (it)
4930 && start_pos < ZV)
4931 move_it_by_lines (&it, 1, 1);
4934 else
4935 move_it_by_lines (&it, n, 1);
4937 /* We failed if we find ZV is already on the screen (scrolling up,
4938 means there's nothing past the end), or if we can't start any
4939 earlier (scrolling down, means there's nothing past the top). */
4940 if ((n > 0 && IT_CHARPOS (it) == ZV)
4941 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4943 if (IT_CHARPOS (it) == ZV)
4945 if (it.current_y < it.last_visible_y
4946 && (it.current_y + it.max_ascent + it.max_descent
4947 > it.last_visible_y))
4949 /* The last line was only partially visible, make it fully
4950 visible. */
4951 w->vscroll = (it.last_visible_y
4952 - it.current_y + it.max_ascent + it.max_descent);
4953 adjust_glyphs (it.f);
4955 else if (noerror)
4956 return;
4957 else if (n < 0) /* could happen with empty buffers */
4958 xsignal0 (Qbeginning_of_buffer);
4959 else
4960 xsignal0 (Qend_of_buffer);
4962 else
4964 if (w->vscroll != 0)
4965 /* The first line was only partially visible, make it fully
4966 visible. */
4967 w->vscroll = 0;
4968 else if (noerror)
4969 return;
4970 else
4971 xsignal0 (Qbeginning_of_buffer);
4974 /* If control gets here, then we vscrolled. */
4976 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4978 /* Don't try to change the window start below. */
4979 vscrolled = 1;
4982 if (! vscrolled)
4984 EMACS_INT pos = IT_CHARPOS (it);
4985 EMACS_INT bytepos;
4987 /* If in the middle of a multi-glyph character move forward to
4988 the next character. */
4989 if (in_display_vector_p (&it))
4991 ++pos;
4992 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4995 /* Set the window start, and set up the window for redisplay. */
4996 set_marker_restricted (w->start, make_number (pos),
4997 w->buffer);
4998 bytepos = XMARKER (w->start)->bytepos;
4999 w->start_at_line_beg = ((pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n')
5000 ? Qt : Qnil);
5001 w->update_mode_line = Qt;
5002 XSETFASTINT (w->last_modified, 0);
5003 XSETFASTINT (w->last_overlay_modified, 0);
5004 /* Set force_start so that redisplay_window will run the
5005 window-scroll-functions. */
5006 w->force_start = Qt;
5009 /* The rest of this function uses current_y in a nonstandard way,
5010 not including the height of the header line if any. */
5011 it.current_y = it.vpos = 0;
5013 /* Move PT out of scroll margins.
5014 This code wants current_y to be zero at the window start position
5015 even if there is a header line. */
5016 this_scroll_margin = max (0, scroll_margin);
5017 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
5018 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
5020 if (n > 0)
5022 /* We moved the window start towards ZV, so PT may be now
5023 in the scroll margin at the top. */
5024 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
5025 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
5026 && (NILP (Vscroll_preserve_screen_position)
5027 || EQ (Vscroll_preserve_screen_position, Qt)))
5028 /* We found PT at a legitimate height. Leave it alone. */
5030 else if (window_scroll_pixel_based_preserve_y >= 0)
5032 /* If we have a header line, take account of it.
5033 This is necessary because we set it.current_y to 0, above. */
5034 move_it_to (&it, -1,
5035 window_scroll_pixel_based_preserve_x,
5036 window_scroll_pixel_based_preserve_y
5037 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
5038 -1, MOVE_TO_Y | MOVE_TO_X);
5039 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5041 else
5043 while (it.current_y < this_scroll_margin)
5045 int prev = it.current_y;
5046 move_it_by_lines (&it, 1, 1);
5047 if (prev == it.current_y)
5048 break;
5050 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5053 else if (n < 0)
5055 EMACS_INT charpos, bytepos;
5056 int partial_p;
5058 /* Save our position, for the
5059 window_scroll_pixel_based_preserve_y case. */
5060 charpos = IT_CHARPOS (it);
5061 bytepos = IT_BYTEPOS (it);
5063 /* We moved the window start towards BEGV, so PT may be now
5064 in the scroll margin at the bottom. */
5065 move_it_to (&it, PT, -1,
5066 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
5067 - this_scroll_margin - 1),
5069 MOVE_TO_POS | MOVE_TO_Y);
5071 /* Save our position, in case it's correct. */
5072 charpos = IT_CHARPOS (it);
5073 bytepos = IT_BYTEPOS (it);
5075 /* See if point is on a partially visible line at the end. */
5076 if (it.what == IT_EOB)
5077 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
5078 else
5080 move_it_by_lines (&it, 1, 1);
5081 partial_p = it.current_y > it.last_visible_y;
5084 if (charpos == PT && !partial_p
5085 && (NILP (Vscroll_preserve_screen_position)
5086 || EQ (Vscroll_preserve_screen_position, Qt)))
5087 /* We found PT before we found the display margin, so PT is ok. */
5089 else if (window_scroll_pixel_based_preserve_y >= 0)
5091 SET_TEXT_POS_FROM_MARKER (start, w->start);
5092 start_display (&it, w, start);
5093 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
5094 here because we called start_display again and did not
5095 alter it.current_y this time. */
5096 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
5097 window_scroll_pixel_based_preserve_y, -1,
5098 MOVE_TO_Y | MOVE_TO_X);
5099 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5101 else
5103 if (partial_p)
5104 /* The last line was only partially visible, so back up two
5105 lines to make sure we're on a fully visible line. */
5107 move_it_by_lines (&it, -2, 0);
5108 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5110 else
5111 /* No, the position we saved is OK, so use it. */
5112 SET_PT_BOTH (charpos, bytepos);
5118 /* Implementation of window_scroll that works based on screen lines.
5119 See the comment of window_scroll for parameter descriptions. */
5121 static void
5122 window_scroll_line_based (Lisp_Object window, int n, int whole, int noerror)
5124 register struct window *w = XWINDOW (window);
5125 register EMACS_INT opoint = PT, opoint_byte = PT_BYTE;
5126 register EMACS_INT pos, pos_byte;
5127 register int ht = window_internal_height (w);
5128 register Lisp_Object tem;
5129 int lose;
5130 Lisp_Object bolp;
5131 EMACS_INT startpos;
5132 Lisp_Object original_pos = Qnil;
5134 /* If scrolling screen-fulls, compute the number of lines to
5135 scroll from the window's height. */
5136 if (whole)
5137 n *= max (1, ht - next_screen_context_lines);
5139 startpos = marker_position (w->start);
5141 if (!NILP (Vscroll_preserve_screen_position))
5143 if (window_scroll_preserve_vpos <= 0
5144 || !SYMBOLP (current_kboard->Vlast_command)
5145 || NILP (Fget (current_kboard->Vlast_command, Qscroll_command)))
5147 struct position posit
5148 = *compute_motion (startpos, 0, 0, 0,
5149 PT, ht, 0,
5150 -1, XINT (w->hscroll),
5151 0, w);
5152 window_scroll_preserve_vpos = posit.vpos;
5153 window_scroll_preserve_hpos = posit.hpos + XINT (w->hscroll);
5156 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
5157 make_number (window_scroll_preserve_vpos));
5160 XSETFASTINT (tem, PT);
5161 tem = Fpos_visible_in_window_p (tem, window, Qnil);
5163 if (NILP (tem))
5165 Fvertical_motion (make_number (- (ht / 2)), window);
5166 startpos = PT;
5169 SET_PT (startpos);
5170 lose = n < 0 && PT == BEGV;
5171 Fvertical_motion (make_number (n), window);
5172 pos = PT;
5173 pos_byte = PT_BYTE;
5174 bolp = Fbolp ();
5175 SET_PT_BOTH (opoint, opoint_byte);
5177 if (lose)
5179 if (noerror)
5180 return;
5181 else
5182 xsignal0 (Qbeginning_of_buffer);
5185 if (pos < ZV)
5187 int this_scroll_margin = scroll_margin;
5189 /* Don't use a scroll margin that is negative or too large. */
5190 if (this_scroll_margin < 0)
5191 this_scroll_margin = 0;
5193 if (XINT (w->total_lines) < 4 * scroll_margin)
5194 this_scroll_margin = XINT (w->total_lines) / 4;
5196 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
5197 w->start_at_line_beg = bolp;
5198 w->update_mode_line = Qt;
5199 XSETFASTINT (w->last_modified, 0);
5200 XSETFASTINT (w->last_overlay_modified, 0);
5201 /* Set force_start so that redisplay_window will run
5202 the window-scroll-functions. */
5203 w->force_start = Qt;
5205 if (!NILP (Vscroll_preserve_screen_position)
5206 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
5208 SET_PT_BOTH (pos, pos_byte);
5209 Fvertical_motion (original_pos, window);
5211 /* If we scrolled forward, put point enough lines down
5212 that it is outside the scroll margin. */
5213 else if (n > 0)
5215 int top_margin;
5217 if (this_scroll_margin > 0)
5219 SET_PT_BOTH (pos, pos_byte);
5220 Fvertical_motion (make_number (this_scroll_margin), window);
5221 top_margin = PT;
5223 else
5224 top_margin = pos;
5226 if (top_margin <= opoint)
5227 SET_PT_BOTH (opoint, opoint_byte);
5228 else if (!NILP (Vscroll_preserve_screen_position))
5230 SET_PT_BOTH (pos, pos_byte);
5231 Fvertical_motion (original_pos, window);
5233 else
5234 SET_PT (top_margin);
5236 else if (n < 0)
5238 int bottom_margin;
5240 /* If we scrolled backward, put point near the end of the window
5241 but not within the scroll margin. */
5242 SET_PT_BOTH (pos, pos_byte);
5243 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
5244 if (XFASTINT (tem) == ht - this_scroll_margin)
5245 bottom_margin = PT;
5246 else
5247 bottom_margin = PT + 1;
5249 if (bottom_margin > opoint)
5250 SET_PT_BOTH (opoint, opoint_byte);
5251 else
5253 if (!NILP (Vscroll_preserve_screen_position))
5255 SET_PT_BOTH (pos, pos_byte);
5256 Fvertical_motion (original_pos, window);
5258 else
5259 Fvertical_motion (make_number (-1), window);
5263 else
5265 if (noerror)
5266 return;
5267 else
5268 xsignal0 (Qend_of_buffer);
5273 /* Scroll selected_window up or down. If N is nil, scroll a
5274 screen-full which is defined as the height of the window minus
5275 next_screen_context_lines. If N is the symbol `-', scroll.
5276 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
5277 up. This is the guts of Fscroll_up and Fscroll_down. */
5279 static void
5280 scroll_command (Lisp_Object n, int direction)
5282 int count = SPECPDL_INDEX ();
5284 xassert (eabs (direction) == 1);
5286 /* If selected window's buffer isn't current, make it current for
5287 the moment. But don't screw up if window_scroll gets an error. */
5288 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
5290 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5291 Fset_buffer (XWINDOW (selected_window)->buffer);
5293 /* Make redisplay consider other windows than just selected_window. */
5294 ++windows_or_buffers_changed;
5297 if (NILP (n))
5298 window_scroll (selected_window, direction, 1, 0);
5299 else if (EQ (n, Qminus))
5300 window_scroll (selected_window, -direction, 1, 0);
5301 else
5303 n = Fprefix_numeric_value (n);
5304 window_scroll (selected_window, XINT (n) * direction, 0, 0);
5307 unbind_to (count, Qnil);
5310 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
5311 doc: /* Scroll text of selected window upward ARG lines.
5312 If ARG is omitted or nil, scroll upward by a near full screen.
5313 A near full screen is `next-screen-context-lines' less than a full screen.
5314 Negative ARG means scroll downward.
5315 If ARG is the atom `-', scroll downward by nearly full screen.
5316 When calling from a program, supply as argument a number, nil, or `-'. */)
5317 (Lisp_Object arg)
5319 scroll_command (arg, 1);
5320 return Qnil;
5323 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
5324 doc: /* Scroll text of selected window down ARG lines.
5325 If ARG is omitted or nil, scroll down by a near full screen.
5326 A near full screen is `next-screen-context-lines' less than a full screen.
5327 Negative ARG means scroll upward.
5328 If ARG is the atom `-', scroll upward by nearly full screen.
5329 When calling from a program, supply as argument a number, nil, or `-'. */)
5330 (Lisp_Object arg)
5332 scroll_command (arg, -1);
5333 return Qnil;
5336 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
5337 doc: /* Return the other window for \"other window scroll\" commands.
5338 If `other-window-scroll-buffer' is non-nil, a window
5339 showing that buffer is used.
5340 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5341 specifies the window. This takes precedence over
5342 `other-window-scroll-buffer'. */)
5343 (void)
5345 Lisp_Object window;
5347 if (MINI_WINDOW_P (XWINDOW (selected_window))
5348 && !NILP (Vminibuf_scroll_window))
5349 window = Vminibuf_scroll_window;
5350 /* If buffer is specified, scroll that buffer. */
5351 else if (!NILP (Vother_window_scroll_buffer))
5353 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
5354 if (NILP (window))
5355 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
5357 else
5359 /* Nothing specified; look for a neighboring window on the same
5360 frame. */
5361 window = Fnext_window (selected_window, Qnil, Qnil);
5363 if (EQ (window, selected_window))
5364 /* That didn't get us anywhere; look for a window on another
5365 visible frame. */
5367 window = Fnext_window (window, Qnil, Qt);
5368 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
5369 && ! EQ (window, selected_window));
5372 CHECK_LIVE_WINDOW (window);
5374 if (EQ (window, selected_window))
5375 error ("There is no other window");
5377 return window;
5380 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
5381 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5382 A near full screen is `next-screen-context-lines' less than a full screen.
5383 The next window is the one below the current one; or the one at the top
5384 if the current one is at the bottom. Negative ARG means scroll downward.
5385 If ARG is the atom `-', scroll downward by nearly full screen.
5386 When calling from a program, supply as argument a number, nil, or `-'.
5388 If `other-window-scroll-buffer' is non-nil, scroll the window
5389 showing that buffer, popping the buffer up if necessary.
5390 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5391 specifies the window to scroll. This takes precedence over
5392 `other-window-scroll-buffer'. */)
5393 (Lisp_Object arg)
5395 Lisp_Object window;
5396 struct window *w;
5397 int count = SPECPDL_INDEX ();
5399 window = Fother_window_for_scrolling ();
5400 w = XWINDOW (window);
5402 /* Don't screw up if window_scroll gets an error. */
5403 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5404 ++windows_or_buffers_changed;
5406 Fset_buffer (w->buffer);
5407 SET_PT (marker_position (w->pointm));
5409 if (NILP (arg))
5410 window_scroll (window, 1, 1, 1);
5411 else if (EQ (arg, Qminus))
5412 window_scroll (window, -1, 1, 1);
5413 else
5415 if (CONSP (arg))
5416 arg = Fcar (arg);
5417 CHECK_NUMBER (arg);
5418 window_scroll (window, XINT (arg), 0, 1);
5421 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5422 unbind_to (count, Qnil);
5424 return Qnil;
5427 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5428 doc: /* Scroll selected window display ARG columns left.
5429 Default for ARG is window width minus 2.
5430 Value is the total amount of leftward horizontal scrolling in
5431 effect after the change.
5432 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5433 lower bound for automatic scrolling, i.e. automatic scrolling
5434 will not scroll a window to a column less than the value returned
5435 by this function. This happens in an interactive call. */)
5436 (register Lisp_Object arg, Lisp_Object set_minimum)
5438 Lisp_Object result;
5439 int hscroll;
5440 struct window *w = XWINDOW (selected_window);
5442 if (NILP (arg))
5443 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5444 else
5445 arg = Fprefix_numeric_value (arg);
5447 hscroll = XINT (w->hscroll) + XINT (arg);
5448 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5450 if (!NILP (set_minimum))
5451 w->min_hscroll = w->hscroll;
5453 return result;
5456 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5457 doc: /* Scroll selected window display ARG columns right.
5458 Default for ARG is window width minus 2.
5459 Value is the total amount of leftward horizontal scrolling in
5460 effect after the change.
5461 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5462 lower bound for automatic scrolling, i.e. automatic scrolling
5463 will not scroll a window to a column less than the value returned
5464 by this function. This happens in an interactive call. */)
5465 (register Lisp_Object arg, Lisp_Object set_minimum)
5467 Lisp_Object result;
5468 int hscroll;
5469 struct window *w = XWINDOW (selected_window);
5471 if (NILP (arg))
5472 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5473 else
5474 arg = Fprefix_numeric_value (arg);
5476 hscroll = XINT (w->hscroll) - XINT (arg);
5477 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5479 if (!NILP (set_minimum))
5480 w->min_hscroll = w->hscroll;
5482 return result;
5485 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5486 doc: /* Return the window which was selected when entering the minibuffer.
5487 Returns nil, if selected window is not a minibuffer window. */)
5488 (void)
5490 if (minibuf_level > 0
5491 && MINI_WINDOW_P (XWINDOW (selected_window))
5492 && WINDOW_LIVE_P (minibuf_selected_window))
5493 return minibuf_selected_window;
5495 return Qnil;
5498 /* Value is the number of lines actually displayed in window W,
5499 as opposed to its height. */
5501 static int
5502 displayed_window_lines (struct window *w)
5504 struct it it;
5505 struct text_pos start;
5506 int height = window_box_height (w);
5507 struct buffer *old_buffer;
5508 int bottom_y;
5510 if (XBUFFER (w->buffer) != current_buffer)
5512 old_buffer = current_buffer;
5513 set_buffer_internal (XBUFFER (w->buffer));
5515 else
5516 old_buffer = NULL;
5518 /* In case W->start is out of the accessible range, do something
5519 reasonable. This happens in Info mode when Info-scroll-down
5520 calls (recenter -1) while W->start is 1. */
5521 if (XMARKER (w->start)->charpos < BEGV)
5522 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
5523 else if (XMARKER (w->start)->charpos > ZV)
5524 SET_TEXT_POS (start, ZV, ZV_BYTE);
5525 else
5526 SET_TEXT_POS_FROM_MARKER (start, w->start);
5528 start_display (&it, w, start);
5529 move_it_vertically (&it, height);
5530 bottom_y = line_bottom_y (&it);
5532 /* rms: On a non-window display,
5533 the value of it.vpos at the bottom of the screen
5534 seems to be 1 larger than window_box_height (w).
5535 This kludge fixes a bug whereby (move-to-window-line -1)
5536 when ZV is on the last screen line
5537 moves to the previous screen line instead of the last one. */
5538 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5539 height++;
5541 /* Add in empty lines at the bottom of the window. */
5542 if (bottom_y < height)
5544 int uy = FRAME_LINE_HEIGHT (it.f);
5545 it.vpos += (height - bottom_y + uy - 1) / uy;
5548 if (old_buffer)
5549 set_buffer_internal (old_buffer);
5551 return it.vpos;
5555 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5556 doc: /* Center point in selected window and maybe redisplay frame.
5557 With prefix argument ARG, recenter putting point on screen line ARG
5558 relative to the selected window. If ARG is negative, it counts up from the
5559 bottom of the window. (ARG should be less than the height of the window.)
5561 If ARG is omitted or nil, then recenter with point on the middle line of
5562 the selected window; if the variable `recenter-redisplay' is non-nil,
5563 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5564 is set to `grow-only', this resets the tool-bar's height to the minimum
5565 height needed); if `recenter-redisplay' has the special value `tty',
5566 then only tty frame are redrawn.
5568 Just C-u as prefix means put point in the center of the window
5569 and redisplay normally--don't erase and redraw the frame. */)
5570 (register Lisp_Object arg)
5572 struct window *w = XWINDOW (selected_window);
5573 struct buffer *buf = XBUFFER (w->buffer);
5574 struct buffer *obuf = current_buffer;
5575 int center_p = 0;
5576 EMACS_INT charpos, bytepos;
5577 int iarg;
5578 int this_scroll_margin;
5580 /* If redisplay is suppressed due to an error, try again. */
5581 obuf->display_error_modiff = 0;
5583 if (NILP (arg))
5585 if (!NILP (Vrecenter_redisplay)
5586 && (!EQ (Vrecenter_redisplay, Qtty)
5587 || !NILP (Ftty_type (selected_frame))))
5589 int i;
5591 /* Invalidate pixel data calculated for all compositions. */
5592 for (i = 0; i < n_compositions; i++)
5593 composition_table[i]->font = NULL;
5595 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5597 Fredraw_frame (WINDOW_FRAME (w));
5598 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5601 center_p = 1;
5603 else if (CONSP (arg)) /* Just C-u. */
5604 center_p = 1;
5605 else
5607 arg = Fprefix_numeric_value (arg);
5608 CHECK_NUMBER (arg);
5609 iarg = XINT (arg);
5612 set_buffer_internal (buf);
5614 /* Do this after making BUF current
5615 in case scroll_margin is buffer-local. */
5616 this_scroll_margin = max (0, scroll_margin);
5617 this_scroll_margin = min (this_scroll_margin,
5618 XFASTINT (w->total_lines) / 4);
5620 /* Handle centering on a graphical frame specially. Such frames can
5621 have variable-height lines and centering point on the basis of
5622 line counts would lead to strange effects. */
5623 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5625 if (center_p)
5627 struct it it;
5628 struct text_pos pt;
5630 SET_TEXT_POS (pt, PT, PT_BYTE);
5631 start_display (&it, w, pt);
5632 move_it_vertically_backward (&it, window_box_height (w) / 2);
5633 charpos = IT_CHARPOS (it);
5634 bytepos = IT_BYTEPOS (it);
5636 else if (iarg < 0)
5638 struct it it;
5639 struct text_pos pt;
5640 int nlines = -iarg;
5641 int extra_line_spacing;
5642 int h = window_box_height (w);
5644 iarg = - max (-iarg, this_scroll_margin);
5646 SET_TEXT_POS (pt, PT, PT_BYTE);
5647 start_display (&it, w, pt);
5649 /* Be sure we have the exact height of the full line containing PT. */
5650 move_it_by_lines (&it, 0, 1);
5652 /* The amount of pixels we have to move back is the window
5653 height minus what's displayed in the line containing PT,
5654 and the lines below. */
5655 it.current_y = 0;
5656 it.vpos = 0;
5657 move_it_by_lines (&it, nlines, 1);
5659 if (it.vpos == nlines)
5660 h -= it.current_y;
5661 else
5663 /* Last line has no newline */
5664 h -= line_bottom_y (&it);
5665 it.vpos++;
5668 /* Don't reserve space for extra line spacing of last line. */
5669 extra_line_spacing = it.max_extra_line_spacing;
5671 /* If we can't move down NLINES lines because we hit
5672 the end of the buffer, count in some empty lines. */
5673 if (it.vpos < nlines)
5675 nlines -= it.vpos;
5676 extra_line_spacing = it.extra_line_spacing;
5677 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5679 if (h <= 0)
5680 return Qnil;
5682 /* Now find the new top line (starting position) of the window. */
5683 start_display (&it, w, pt);
5684 it.current_y = 0;
5685 move_it_vertically_backward (&it, h);
5687 /* If extra line spacing is present, we may move too far
5688 back. This causes the last line to be only partially
5689 visible (which triggers redisplay to recenter that line
5690 in the middle), so move forward.
5691 But ignore extra line spacing on last line, as it is not
5692 considered to be part of the visible height of the line.
5694 h += extra_line_spacing;
5695 while (-it.current_y > h)
5696 move_it_by_lines (&it, 1, 1);
5698 charpos = IT_CHARPOS (it);
5699 bytepos = IT_BYTEPOS (it);
5701 else
5703 struct position pos;
5705 iarg = max (iarg, this_scroll_margin);
5707 pos = *vmotion (PT, -iarg, w);
5708 charpos = pos.bufpos;
5709 bytepos = pos.bytepos;
5712 else
5714 struct position pos;
5715 int ht = window_internal_height (w);
5717 if (center_p)
5718 iarg = ht / 2;
5719 else if (iarg < 0)
5720 iarg += ht;
5722 /* Don't let it get into the margin at either top or bottom. */
5723 iarg = max (iarg, this_scroll_margin);
5724 iarg = min (iarg, ht - this_scroll_margin - 1);
5726 pos = *vmotion (PT, - iarg, w);
5727 charpos = pos.bufpos;
5728 bytepos = pos.bytepos;
5731 /* Set the new window start. */
5732 set_marker_both (w->start, w->buffer, charpos, bytepos);
5733 w->window_end_valid = Qnil;
5735 w->optional_new_start = Qt;
5737 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
5738 w->start_at_line_beg = Qt;
5739 else
5740 w->start_at_line_beg = Qnil;
5742 set_buffer_internal (obuf);
5743 return Qnil;
5747 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5748 0, 1, 0,
5749 doc: /* Return the height in lines of the text display area of WINDOW.
5750 WINDOW defaults to the selected window.
5752 The return value does not include the mode line, any header line, nor
5753 any partial-height lines in the text display area. */)
5754 (Lisp_Object window)
5756 struct window *w = decode_window (window);
5757 int pixel_height = window_box_height (w);
5758 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5759 return make_number (line_height);
5764 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5765 1, 1, "P",
5766 doc: /* Position point relative to window.
5767 With no argument, position point at center of window.
5768 An argument specifies vertical position within the window;
5769 zero means top of window, negative means relative to bottom of window. */)
5770 (Lisp_Object arg)
5772 struct window *w = XWINDOW (selected_window);
5773 int lines, start;
5774 Lisp_Object window;
5775 #if 0
5776 int this_scroll_margin;
5777 #endif
5779 window = selected_window;
5780 start = marker_position (w->start);
5781 if (start < BEGV || start > ZV)
5783 int height = window_internal_height (w);
5784 Fvertical_motion (make_number (- (height / 2)), window);
5785 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
5786 w->start_at_line_beg = Fbolp ();
5787 w->force_start = Qt;
5789 else
5790 Fgoto_char (w->start);
5792 lines = displayed_window_lines (w);
5794 #if 0
5795 this_scroll_margin = max (0, scroll_margin);
5796 this_scroll_margin = min (this_scroll_margin, lines / 4);
5797 #endif
5799 if (NILP (arg))
5800 XSETFASTINT (arg, lines / 2);
5801 else
5803 int iarg = XINT (Fprefix_numeric_value (arg));
5805 if (iarg < 0)
5806 iarg = iarg + lines;
5808 #if 0 /* This code would prevent move-to-window-line from moving point
5809 to a place inside the scroll margins (which would cause the
5810 next redisplay to scroll). I wrote this code, but then concluded
5811 it is probably better not to install it. However, it is here
5812 inside #if 0 so as not to lose it. -- rms. */
5814 /* Don't let it get into the margin at either top or bottom. */
5815 iarg = max (iarg, this_scroll_margin);
5816 iarg = min (iarg, lines - this_scroll_margin - 1);
5817 #endif
5819 arg = make_number (iarg);
5822 /* Skip past a partially visible first line. */
5823 if (w->vscroll)
5824 XSETINT (arg, XINT (arg) + 1);
5826 return Fvertical_motion (arg, window);
5831 /***********************************************************************
5832 Window Configuration
5833 ***********************************************************************/
5835 struct save_window_data
5837 EMACS_UINT size;
5838 struct Lisp_Vector *next_from_Lisp_Vector_struct;
5839 Lisp_Object selected_frame;
5840 Lisp_Object current_window;
5841 Lisp_Object current_buffer;
5842 Lisp_Object minibuf_scroll_window;
5843 Lisp_Object minibuf_selected_window;
5844 Lisp_Object root_window;
5845 Lisp_Object focus_frame;
5846 /* A vector, each of whose elements is a struct saved_window
5847 for one window. */
5848 Lisp_Object saved_windows;
5850 /* All fields above are traced by the GC.
5851 From `fame-cols' down, the fields are ignored by the GC. */
5853 int frame_cols, frame_lines, frame_menu_bar_lines;
5854 int frame_tool_bar_lines;
5857 /* This is saved as a Lisp_Vector */
5858 struct saved_window
5860 /* these first two must agree with struct Lisp_Vector in lisp.h */
5861 EMACS_UINT size;
5862 struct Lisp_Vector *next_from_Lisp_Vector_struct;
5864 Lisp_Object window;
5865 Lisp_Object buffer, start, pointm, mark;
5866 Lisp_Object left_col, top_line, total_cols, total_lines;
5867 Lisp_Object hscroll, min_hscroll;
5868 Lisp_Object parent, prev;
5869 Lisp_Object start_at_line_beg;
5870 Lisp_Object display_table;
5871 Lisp_Object orig_top_line, orig_total_lines;
5872 Lisp_Object left_margin_cols, right_margin_cols;
5873 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5874 Lisp_Object scroll_bar_width, vertical_scroll_bar_type;
5875 Lisp_Object dedicated, resize_proportionally;
5878 #define SAVED_WINDOW_N(swv,n) \
5879 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5881 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5882 doc: /* Return t if OBJECT is a window-configuration object. */)
5883 (Lisp_Object object)
5885 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
5888 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5889 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5890 (Lisp_Object config)
5892 register struct save_window_data *data;
5893 struct Lisp_Vector *saved_windows;
5895 CHECK_WINDOW_CONFIGURATION (config);
5897 data = (struct save_window_data *) XVECTOR (config);
5898 saved_windows = XVECTOR (data->saved_windows);
5899 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5902 DEFUN ("set-window-configuration", Fset_window_configuration,
5903 Sset_window_configuration, 1, 1, 0,
5904 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5905 CONFIGURATION must be a value previously returned
5906 by `current-window-configuration' (which see).
5907 If CONFIGURATION was made from a frame that is now deleted,
5908 only frame-independent values can be restored. In this case,
5909 the return value is nil. Otherwise the value is t. */)
5910 (Lisp_Object configuration)
5912 register struct save_window_data *data;
5913 struct Lisp_Vector *saved_windows;
5914 Lisp_Object new_current_buffer;
5915 Lisp_Object frame;
5916 FRAME_PTR f;
5917 EMACS_INT old_point = -1;
5919 CHECK_WINDOW_CONFIGURATION (configuration);
5921 data = (struct save_window_data *) XVECTOR (configuration);
5922 saved_windows = XVECTOR (data->saved_windows);
5924 new_current_buffer = data->current_buffer;
5925 if (NILP (XBUFFER (new_current_buffer)->name))
5926 new_current_buffer = Qnil;
5927 else
5929 if (XBUFFER (new_current_buffer) == current_buffer)
5930 /* The code further down "preserves point" by saving here PT in
5931 old_point and then setting it later back into PT. When the
5932 current-selected-window and the final-selected-window both show
5933 the current buffer, this suffers from the problem that the
5934 current PT is the window-point of the current-selected-window,
5935 while the final PT is the point of the final-selected-window, so
5936 this copy from one PT to the other would end up moving the
5937 window-point of the final-selected-window to the window-point of
5938 the current-selected-window. So we have to be careful which
5939 point of the current-buffer we copy into old_point. */
5940 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5941 && WINDOWP (selected_window)
5942 && EQ (XWINDOW (selected_window)->buffer, new_current_buffer)
5943 && !EQ (selected_window, data->current_window))
5944 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5945 else
5946 old_point = PT;
5947 else
5948 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5949 point in new_current_buffer as of the last time this buffer was
5950 used. This can be non-deterministic since it can be changed by
5951 things like jit-lock by mere temporary selection of some random
5952 window that happens to show this buffer.
5953 So if possible we want this arbitrary choice of "which point" to
5954 be the one from the to-be-selected-window so as to prevent this
5955 window's cursor from being copied from another window. */
5956 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5957 /* If current_window = selected_window, its point is in BUF_PT. */
5958 && !EQ (selected_window, data->current_window))
5959 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5960 else
5961 old_point = BUF_PT (XBUFFER (new_current_buffer));
5964 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5965 f = XFRAME (frame);
5967 /* If f is a dead frame, don't bother rebuilding its window tree.
5968 However, there is other stuff we should still try to do below. */
5969 if (FRAME_LIVE_P (f))
5971 register struct window *w;
5972 register struct saved_window *p;
5973 struct window *root_window;
5974 struct window **leaf_windows;
5975 int n_leaf_windows;
5976 int k, i, n;
5978 /* If the frame has been resized since this window configuration was
5979 made, we change the frame to the size specified in the
5980 configuration, restore the configuration, and then resize it
5981 back. We keep track of the prevailing height in these variables. */
5982 int previous_frame_lines = FRAME_LINES (f);
5983 int previous_frame_cols = FRAME_COLS (f);
5984 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5985 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5987 /* The mouse highlighting code could get screwed up
5988 if it runs during this. */
5989 BLOCK_INPUT;
5991 if (data->frame_lines != previous_frame_lines
5992 || data->frame_cols != previous_frame_cols)
5993 change_frame_size (f, data->frame_lines,
5994 data->frame_cols, 0, 0, 0);
5995 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5996 if (data->frame_menu_bar_lines
5997 != previous_frame_menu_bar_lines)
5998 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
5999 make_number (0));
6000 #ifdef HAVE_WINDOW_SYSTEM
6001 if (data->frame_tool_bar_lines
6002 != previous_frame_tool_bar_lines)
6003 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
6004 make_number (0));
6005 #endif
6006 #endif
6008 /* "Swap out" point from the selected window's buffer
6009 into the window itself. (Normally the pointm of the selected
6010 window holds garbage.) We do this now, before
6011 restoring the window contents, and prevent it from
6012 being done later on when we select a new window. */
6013 if (! NILP (XWINDOW (selected_window)->buffer))
6015 w = XWINDOW (selected_window);
6016 set_marker_both (w->pointm,
6017 w->buffer,
6018 BUF_PT (XBUFFER (w->buffer)),
6019 BUF_PT_BYTE (XBUFFER (w->buffer)));
6022 windows_or_buffers_changed++;
6023 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
6025 /* Problem: Freeing all matrices and later allocating them again
6026 is a serious redisplay flickering problem. What we would
6027 really like to do is to free only those matrices not reused
6028 below. */
6029 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
6030 leaf_windows
6031 = (struct window **) alloca (count_windows (root_window)
6032 * sizeof (struct window *));
6033 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
6035 /* Kludge Alert!
6036 Mark all windows now on frame as "deleted".
6037 Restoring the new configuration "undeletes" any that are in it.
6039 Save their current buffers in their height fields, since we may
6040 need it later, if a buffer saved in the configuration is now
6041 dead. */
6042 delete_all_subwindows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6044 for (k = 0; k < saved_windows->size; k++)
6046 p = SAVED_WINDOW_N (saved_windows, k);
6047 w = XWINDOW (p->window);
6048 w->next = Qnil;
6050 if (!NILP (p->parent))
6051 w->parent = SAVED_WINDOW_N (saved_windows,
6052 XFASTINT (p->parent))->window;
6053 else
6054 w->parent = Qnil;
6056 if (!NILP (p->prev))
6058 w->prev = SAVED_WINDOW_N (saved_windows,
6059 XFASTINT (p->prev))->window;
6060 XWINDOW (w->prev)->next = p->window;
6062 else
6064 w->prev = Qnil;
6065 if (!NILP (w->parent))
6067 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
6069 XWINDOW (w->parent)->vchild = p->window;
6070 XWINDOW (w->parent)->hchild = Qnil;
6072 else
6074 XWINDOW (w->parent)->hchild = p->window;
6075 XWINDOW (w->parent)->vchild = Qnil;
6080 /* If we squirreled away the buffer in the window's height,
6081 restore it now. */
6082 if (BUFFERP (w->total_lines))
6083 w->buffer = w->total_lines;
6084 w->left_col = p->left_col;
6085 w->top_line = p->top_line;
6086 w->total_cols = p->total_cols;
6087 w->total_lines = p->total_lines;
6088 w->hscroll = p->hscroll;
6089 w->min_hscroll = p->min_hscroll;
6090 w->display_table = p->display_table;
6091 w->orig_top_line = p->orig_top_line;
6092 w->orig_total_lines = p->orig_total_lines;
6093 w->left_margin_cols = p->left_margin_cols;
6094 w->right_margin_cols = p->right_margin_cols;
6095 w->left_fringe_width = p->left_fringe_width;
6096 w->right_fringe_width = p->right_fringe_width;
6097 w->fringes_outside_margins = p->fringes_outside_margins;
6098 w->scroll_bar_width = p->scroll_bar_width;
6099 w->vertical_scroll_bar_type = p->vertical_scroll_bar_type;
6100 w->dedicated = p->dedicated;
6101 w->resize_proportionally = p->resize_proportionally;
6102 XSETFASTINT (w->last_modified, 0);
6103 XSETFASTINT (w->last_overlay_modified, 0);
6105 /* Reinstall the saved buffer and pointers into it. */
6106 if (NILP (p->buffer))
6107 w->buffer = p->buffer;
6108 else
6110 if (!NILP (XBUFFER (p->buffer)->name))
6111 /* If saved buffer is alive, install it. */
6113 w->buffer = p->buffer;
6114 w->start_at_line_beg = p->start_at_line_beg;
6115 set_marker_restricted (w->start, p->start, w->buffer);
6116 set_marker_restricted (w->pointm, p->pointm, w->buffer);
6117 Fset_marker (XBUFFER (w->buffer)->mark,
6118 p->mark, w->buffer);
6120 /* As documented in Fcurrent_window_configuration, don't
6121 restore the location of point in the buffer which was
6122 current when the window configuration was recorded. */
6123 if (!EQ (p->buffer, new_current_buffer)
6124 && XBUFFER (p->buffer) == current_buffer)
6125 Fgoto_char (w->pointm);
6127 else if (NILP (w->buffer) || NILP (XBUFFER (w->buffer)->name))
6128 /* Else unless window has a live buffer, get one. */
6130 w->buffer = Fcdr (Fcar (Vbuffer_alist));
6131 /* This will set the markers to beginning of visible
6132 range. */
6133 set_marker_restricted (w->start, make_number (0), w->buffer);
6134 set_marker_restricted (w->pointm, make_number (0),w->buffer);
6135 w->start_at_line_beg = Qt;
6137 else
6138 /* Keeping window's old buffer; make sure the markers
6139 are real. */
6141 /* Set window markers at start of visible range. */
6142 if (XMARKER (w->start)->buffer == 0)
6143 set_marker_restricted (w->start, make_number (0),
6144 w->buffer);
6145 if (XMARKER (w->pointm)->buffer == 0)
6146 set_marker_restricted_both (w->pointm, w->buffer,
6147 BUF_PT (XBUFFER (w->buffer)),
6148 BUF_PT_BYTE (XBUFFER (w->buffer)));
6149 w->start_at_line_beg = Qt;
6154 FRAME_ROOT_WINDOW (f) = data->root_window;
6155 /* Prevent "swapping out point" in the old selected window
6156 using the buffer that has been restored into it.
6157 We already swapped out point that from that window's old buffer. */
6158 selected_window = Qnil;
6160 /* Arrange *not* to restore point in the buffer that was
6161 current when the window configuration was saved. */
6162 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
6163 set_marker_restricted (XWINDOW (data->current_window)->pointm,
6164 make_number (old_point),
6165 XWINDOW (data->current_window)->buffer);
6167 Fselect_window (data->current_window, Qnil);
6168 XBUFFER (XWINDOW (selected_window)->buffer)->last_selected_window
6169 = selected_window;
6171 if (NILP (data->focus_frame)
6172 || (FRAMEP (data->focus_frame)
6173 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
6174 Fredirect_frame_focus (frame, data->focus_frame);
6176 #if 0 /* I don't understand why this is needed, and it causes problems
6177 when the frame's old selected window has been deleted. */
6178 if (f != selected_frame && FRAME_WINDOW_P (f))
6179 do_switch_frame (WINDOW_FRAME (XWINDOW (data->root_window)),
6180 0, 0, Qnil);
6181 #endif
6183 /* Set the screen height to the value it had before this function. */
6184 if (previous_frame_lines != FRAME_LINES (f)
6185 || previous_frame_cols != FRAME_COLS (f))
6186 change_frame_size (f, previous_frame_lines, previous_frame_cols,
6187 0, 0, 0);
6188 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
6189 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
6190 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
6191 make_number (0));
6192 #ifdef HAVE_WINDOW_SYSTEM
6193 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
6194 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
6195 make_number (0));
6196 #endif
6197 #endif
6199 /* Now, free glyph matrices in windows that were not reused. */
6200 for (i = n = 0; i < n_leaf_windows; ++i)
6202 if (NILP (leaf_windows[i]->buffer))
6204 /* Assert it's not reused as a combination. */
6205 xassert (NILP (leaf_windows[i]->hchild)
6206 && NILP (leaf_windows[i]->vchild));
6207 free_window_matrices (leaf_windows[i]);
6209 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
6210 ++n;
6213 adjust_glyphs (f);
6215 UNBLOCK_INPUT;
6217 /* Fselect_window will have made f the selected frame, so we
6218 reselect the proper frame here. Fhandle_switch_frame will change the
6219 selected window too, but that doesn't make the call to
6220 Fselect_window above totally superfluous; it still sets f's
6221 selected window. */
6222 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
6223 do_switch_frame (data->selected_frame, 0, 0, Qnil);
6225 run_window_configuration_change_hook (f);
6228 if (!NILP (new_current_buffer))
6229 Fset_buffer (new_current_buffer);
6231 Vminibuf_scroll_window = data->minibuf_scroll_window;
6232 minibuf_selected_window = data->minibuf_selected_window;
6234 return (FRAME_LIVE_P (f) ? Qt : Qnil);
6237 /* Mark all windows now on frame as deleted
6238 by setting their buffers to nil. */
6240 void
6241 delete_all_subwindows (register struct window *w)
6243 if (!NILP (w->next))
6244 delete_all_subwindows (XWINDOW (w->next));
6245 if (!NILP (w->vchild))
6246 delete_all_subwindows (XWINDOW (w->vchild));
6247 if (!NILP (w->hchild))
6248 delete_all_subwindows (XWINDOW (w->hchild));
6250 w->total_lines = w->buffer; /* See Fset_window_configuration for excuse. */
6252 if (!NILP (w->buffer))
6253 unshow_buffer (w);
6255 /* We set all three of these fields to nil, to make sure that we can
6256 distinguish this dead window from any live window. Live leaf
6257 windows will have buffer set, and combination windows will have
6258 vchild or hchild set. */
6259 w->buffer = Qnil;
6260 w->vchild = Qnil;
6261 w->hchild = Qnil;
6263 Vwindow_list = Qnil;
6266 static int
6267 count_windows (register struct window *window)
6269 register int count = 1;
6270 if (!NILP (window->next))
6271 count += count_windows (XWINDOW (window->next));
6272 if (!NILP (window->vchild))
6273 count += count_windows (XWINDOW (window->vchild));
6274 if (!NILP (window->hchild))
6275 count += count_windows (XWINDOW (window->hchild));
6276 return count;
6280 /* Fill vector FLAT with leaf windows under W, starting at index I.
6281 Value is last index + 1. */
6283 static int
6284 get_leaf_windows (struct window *w, struct window **flat, int i)
6286 while (w)
6288 if (!NILP (w->hchild))
6289 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
6290 else if (!NILP (w->vchild))
6291 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
6292 else
6293 flat[i++] = w;
6295 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6298 return i;
6302 /* Return a pointer to the glyph W's physical cursor is on. Value is
6303 null if W's current matrix is invalid, so that no meaningfull glyph
6304 can be returned. */
6306 struct glyph *
6307 get_phys_cursor_glyph (struct window *w)
6309 struct glyph_row *row;
6310 struct glyph *glyph;
6312 if (w->phys_cursor.vpos >= 0
6313 && w->phys_cursor.vpos < w->current_matrix->nrows
6314 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
6315 row->enabled_p)
6316 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
6317 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
6318 else
6319 glyph = NULL;
6321 return glyph;
6325 static int
6326 save_window_save (Lisp_Object window, struct Lisp_Vector *vector, int i)
6328 register struct saved_window *p;
6329 register struct window *w;
6330 register Lisp_Object tem;
6332 for (;!NILP (window); window = w->next)
6334 p = SAVED_WINDOW_N (vector, i);
6335 w = XWINDOW (window);
6337 XSETFASTINT (w->temslot, i); i++;
6338 p->window = window;
6339 p->buffer = w->buffer;
6340 p->left_col = w->left_col;
6341 p->top_line = w->top_line;
6342 p->total_cols = w->total_cols;
6343 p->total_lines = w->total_lines;
6344 p->hscroll = w->hscroll;
6345 p->min_hscroll = w->min_hscroll;
6346 p->display_table = w->display_table;
6347 p->orig_top_line = w->orig_top_line;
6348 p->orig_total_lines = w->orig_total_lines;
6349 p->left_margin_cols = w->left_margin_cols;
6350 p->right_margin_cols = w->right_margin_cols;
6351 p->left_fringe_width = w->left_fringe_width;
6352 p->right_fringe_width = w->right_fringe_width;
6353 p->fringes_outside_margins = w->fringes_outside_margins;
6354 p->scroll_bar_width = w->scroll_bar_width;
6355 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
6356 p->dedicated = w->dedicated;
6357 p->resize_proportionally = w->resize_proportionally;
6358 if (!NILP (w->buffer))
6360 /* Save w's value of point in the window configuration.
6361 If w is the selected window, then get the value of point
6362 from the buffer; pointm is garbage in the selected window. */
6363 if (EQ (window, selected_window))
6365 p->pointm = Fmake_marker ();
6366 set_marker_both (p->pointm, w->buffer,
6367 BUF_PT (XBUFFER (w->buffer)),
6368 BUF_PT_BYTE (XBUFFER (w->buffer)));
6370 else
6371 p->pointm = Fcopy_marker (w->pointm, Qnil);
6373 p->start = Fcopy_marker (w->start, Qnil);
6374 p->start_at_line_beg = w->start_at_line_beg;
6376 tem = XBUFFER (w->buffer)->mark;
6377 p->mark = Fcopy_marker (tem, Qnil);
6379 else
6381 p->pointm = Qnil;
6382 p->start = Qnil;
6383 p->mark = Qnil;
6384 p->start_at_line_beg = Qnil;
6387 if (NILP (w->parent))
6388 p->parent = Qnil;
6389 else
6390 p->parent = XWINDOW (w->parent)->temslot;
6392 if (NILP (w->prev))
6393 p->prev = Qnil;
6394 else
6395 p->prev = XWINDOW (w->prev)->temslot;
6397 if (!NILP (w->vchild))
6398 i = save_window_save (w->vchild, vector, i);
6399 if (!NILP (w->hchild))
6400 i = save_window_save (w->hchild, vector, i);
6403 return i;
6406 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
6407 Scurrent_window_configuration, 0, 1, 0,
6408 doc: /* Return an object representing the current window configuration of FRAME.
6409 If FRAME is nil or omitted, use the selected frame.
6410 This describes the number of windows, their sizes and current buffers,
6411 and for each displayed buffer, where display starts, and the positions of
6412 point and mark. An exception is made for point in the current buffer:
6413 its value is -not- saved.
6414 This also records the currently selected frame, and FRAME's focus
6415 redirection (see `redirect-frame-focus'). */)
6416 (Lisp_Object frame)
6418 register Lisp_Object tem;
6419 register int n_windows;
6420 register struct save_window_data *data;
6421 register int i;
6422 FRAME_PTR f;
6424 if (NILP (frame))
6425 frame = selected_frame;
6426 CHECK_LIVE_FRAME (frame);
6427 f = XFRAME (frame);
6429 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6430 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6431 PVEC_WINDOW_CONFIGURATION);
6433 data->frame_cols = FRAME_COLS (f);
6434 data->frame_lines = FRAME_LINES (f);
6435 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6436 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6437 data->selected_frame = selected_frame;
6438 data->current_window = FRAME_SELECTED_WINDOW (f);
6439 XSETBUFFER (data->current_buffer, current_buffer);
6440 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6441 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6442 data->root_window = FRAME_ROOT_WINDOW (f);
6443 data->focus_frame = FRAME_FOCUS_FRAME (f);
6444 tem = Fmake_vector (make_number (n_windows), Qnil);
6445 data->saved_windows = tem;
6446 for (i = 0; i < n_windows; i++)
6447 XVECTOR (tem)->contents[i]
6448 = Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil);
6449 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6450 XSETWINDOW_CONFIGURATION (tem, data);
6451 return (tem);
6454 DEFUN ("save-window-excursion", Fsave_window_excursion, Ssave_window_excursion,
6455 0, UNEVALLED, 0,
6456 doc: /* Execute BODY, preserving window sizes and contents.
6457 Return the value of the last form in BODY.
6458 Restore which buffer appears in which window, where display starts,
6459 and the value of point and mark for each window.
6460 Also restore the choice of selected window.
6461 Also restore which buffer is current.
6462 Does not restore the value of point in current buffer.
6463 usage: (save-window-excursion BODY...) */)
6464 (Lisp_Object args)
6466 register Lisp_Object val;
6467 register int count = SPECPDL_INDEX ();
6469 record_unwind_protect (Fset_window_configuration,
6470 Fcurrent_window_configuration (Qnil));
6471 val = Fprogn (args);
6472 return unbind_to (count, val);
6477 /***********************************************************************
6478 Window Split Tree
6479 ***********************************************************************/
6481 static Lisp_Object
6482 window_tree (struct window *w)
6484 Lisp_Object tail = Qnil;
6485 Lisp_Object result = Qnil;
6487 while (w)
6489 Lisp_Object wn;
6491 XSETWINDOW (wn, w);
6492 if (!NILP (w->hchild))
6493 wn = Fcons (Qnil, Fcons (Fwindow_edges (wn),
6494 window_tree (XWINDOW (w->hchild))));
6495 else if (!NILP (w->vchild))
6496 wn = Fcons (Qt, Fcons (Fwindow_edges (wn),
6497 window_tree (XWINDOW (w->vchild))));
6499 if (NILP (result))
6501 result = tail = Fcons (wn, Qnil);
6503 else
6505 XSETCDR (tail, Fcons (wn, Qnil));
6506 tail = XCDR (tail);
6509 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6512 return result;
6517 DEFUN ("window-tree", Fwindow_tree, Swindow_tree,
6518 0, 1, 0,
6519 doc: /* Return the window tree for frame FRAME.
6521 The return value is a list of the form (ROOT MINI), where ROOT
6522 represents the window tree of the frame's root window, and MINI
6523 is the frame's minibuffer window.
6525 If the root window is not split, ROOT is the root window itself.
6526 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil for a
6527 horizontal split, and t for a vertical split, EDGES gives the combined
6528 size and position of the subwindows in the split, and the rest of the
6529 elements are the subwindows in the split. Each of the subwindows may
6530 again be a window or a list representing a window split, and so on.
6531 EDGES is a list \(LEFT TOP RIGHT BOTTOM) as returned by `window-edges'.
6533 If FRAME is nil or omitted, return information on the currently
6534 selected frame. */)
6535 (Lisp_Object frame)
6537 FRAME_PTR f;
6539 if (NILP (frame))
6540 frame = selected_frame;
6542 CHECK_FRAME (frame);
6543 f = XFRAME (frame);
6545 if (!FRAME_LIVE_P (f))
6546 return Qnil;
6548 return window_tree (XWINDOW (FRAME_ROOT_WINDOW (f)));
6552 /***********************************************************************
6553 Marginal Areas
6554 ***********************************************************************/
6556 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6557 2, 3, 0,
6558 doc: /* Set width of marginal areas of window WINDOW.
6559 If WINDOW is nil, set margins of the currently selected window.
6560 Second arg LEFT-WIDTH specifies the number of character cells to
6561 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6562 does the same for the right marginal area. A nil width parameter
6563 means no margin. */)
6564 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width)
6566 struct window *w = decode_window (window);
6568 /* Translate negative or zero widths to nil.
6569 Margins that are too wide have to be checked elsewhere. */
6571 if (!NILP (left_width))
6573 CHECK_NUMBER (left_width);
6574 if (XINT (left_width) <= 0)
6575 left_width = Qnil;
6578 if (!NILP (right_width))
6580 CHECK_NUMBER (right_width);
6581 if (XINT (right_width) <= 0)
6582 right_width = Qnil;
6585 if (!EQ (w->left_margin_cols, left_width)
6586 || !EQ (w->right_margin_cols, right_width))
6588 w->left_margin_cols = left_width;
6589 w->right_margin_cols = right_width;
6591 adjust_window_margins (w);
6593 ++windows_or_buffers_changed;
6594 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6597 return Qnil;
6601 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6602 0, 1, 0,
6603 doc: /* Get width of marginal areas of window WINDOW.
6604 If WINDOW is omitted or nil, use the currently selected window.
6605 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6606 If a marginal area does not exist, its width will be returned
6607 as nil. */)
6608 (Lisp_Object window)
6610 struct window *w = decode_window (window);
6611 return Fcons (w->left_margin_cols, w->right_margin_cols);
6616 /***********************************************************************
6617 Fringes
6618 ***********************************************************************/
6620 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6621 2, 4, 0,
6622 doc: /* Set the fringe widths of window WINDOW.
6623 If WINDOW is nil, set the fringe widths of the currently selected
6624 window.
6625 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6626 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6627 fringe width. If a fringe width arg is nil, that means to use the
6628 frame's default fringe width. Default fringe widths can be set with
6629 the command `set-fringe-style'.
6630 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6631 outside of the display margins. By default, fringes are drawn between
6632 display marginal areas and the text area. */)
6633 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width, Lisp_Object outside_margins)
6635 struct window *w = decode_window (window);
6637 if (!NILP (left_width))
6638 CHECK_NATNUM (left_width);
6639 if (!NILP (right_width))
6640 CHECK_NATNUM (right_width);
6642 /* Do nothing on a tty. */
6643 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6644 && (!EQ (w->left_fringe_width, left_width)
6645 || !EQ (w->right_fringe_width, right_width)
6646 || !EQ (w->fringes_outside_margins, outside_margins)))
6648 w->left_fringe_width = left_width;
6649 w->right_fringe_width = right_width;
6650 w->fringes_outside_margins = outside_margins;
6652 adjust_window_margins (w);
6654 clear_glyph_matrix (w->current_matrix);
6655 w->window_end_valid = Qnil;
6657 ++windows_or_buffers_changed;
6658 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6661 return Qnil;
6665 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6666 0, 1, 0,
6667 doc: /* Get width of fringes of window WINDOW.
6668 If WINDOW is omitted or nil, use the currently selected window.
6669 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6670 (Lisp_Object window)
6672 struct window *w = decode_window (window);
6674 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6675 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6676 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6677 ? Qt : Qnil), Qnil)));
6682 /***********************************************************************
6683 Scroll bars
6684 ***********************************************************************/
6686 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars, Sset_window_scroll_bars,
6687 2, 4, 0,
6688 doc: /* Set width and type of scroll bars of window WINDOW.
6689 If window is nil, set scroll bars of the currently selected window.
6690 Second parameter WIDTH specifies the pixel width for the scroll bar;
6691 this is automatically adjusted to a multiple of the frame column width.
6692 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6693 bar: left, right, or nil.
6694 If WIDTH is nil, use the frame's scroll-bar width.
6695 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6696 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6697 (Lisp_Object window, Lisp_Object width, Lisp_Object vertical_type, Lisp_Object horizontal_type)
6699 struct window *w = decode_window (window);
6701 if (!NILP (width))
6703 CHECK_NATNUM (width);
6705 if (XINT (width) == 0)
6706 vertical_type = Qnil;
6709 if (!(NILP (vertical_type)
6710 || EQ (vertical_type, Qleft)
6711 || EQ (vertical_type, Qright)
6712 || EQ (vertical_type, Qt)))
6713 error ("Invalid type of vertical scroll bar");
6715 if (!EQ (w->scroll_bar_width, width)
6716 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6718 w->scroll_bar_width = width;
6719 w->vertical_scroll_bar_type = vertical_type;
6721 adjust_window_margins (w);
6723 clear_glyph_matrix (w->current_matrix);
6724 w->window_end_valid = Qnil;
6726 ++windows_or_buffers_changed;
6727 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6730 return Qnil;
6734 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6735 0, 1, 0,
6736 doc: /* Get width and type of scroll bars of window WINDOW.
6737 If WINDOW is omitted or nil, use the currently selected window.
6738 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6739 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6740 value. */)
6741 (Lisp_Object window)
6743 struct window *w = decode_window (window);
6744 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6745 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6746 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6747 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
6748 Fcons (w->vertical_scroll_bar_type,
6749 Fcons (Qnil, Qnil))));
6754 /***********************************************************************
6755 Smooth scrolling
6756 ***********************************************************************/
6758 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6759 doc: /* Return the amount by which WINDOW is scrolled vertically.
6760 Use the selected window if WINDOW is nil or omitted.
6761 Normally, value is a multiple of the canonical character height of WINDOW;
6762 optional second arg PIXELS-P means value is measured in pixels. */)
6763 (Lisp_Object window, Lisp_Object pixels_p)
6765 Lisp_Object result;
6766 struct frame *f;
6767 struct window *w;
6769 if (NILP (window))
6770 window = selected_window;
6771 else
6772 CHECK_WINDOW (window);
6773 w = XWINDOW (window);
6774 f = XFRAME (w->frame);
6776 if (FRAME_WINDOW_P (f))
6777 result = (NILP (pixels_p)
6778 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
6779 : make_number (-w->vscroll));
6780 else
6781 result = make_number (0);
6782 return result;
6786 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
6787 2, 3, 0,
6788 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6789 WINDOW nil means use the selected window. Normally, VSCROLL is a
6790 non-negative multiple of the canonical character height of WINDOW;
6791 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6792 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6793 corresponds to an integral number of pixels. The return value is the
6794 result of this rounding.
6795 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6796 (Lisp_Object window, Lisp_Object vscroll, Lisp_Object pixels_p)
6798 struct window *w;
6799 struct frame *f;
6801 if (NILP (window))
6802 window = selected_window;
6803 else
6804 CHECK_WINDOW (window);
6805 CHECK_NUMBER_OR_FLOAT (vscroll);
6807 w = XWINDOW (window);
6808 f = XFRAME (w->frame);
6810 if (FRAME_WINDOW_P (f))
6812 int old_dy = w->vscroll;
6814 w->vscroll = - (NILP (pixels_p)
6815 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6816 : XFLOATINT (vscroll));
6817 w->vscroll = min (w->vscroll, 0);
6819 if (w->vscroll != old_dy)
6821 /* Adjust glyph matrix of the frame if the virtual display
6822 area becomes larger than before. */
6823 if (w->vscroll < 0 && w->vscroll < old_dy)
6824 adjust_glyphs (f);
6826 /* Prevent redisplay shortcuts. */
6827 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
6831 return Fwindow_vscroll (window, pixels_p);
6835 /* Call FN for all leaf windows on frame F. FN is called with the
6836 first argument being a pointer to the leaf window, and with
6837 additional argument USER_DATA. Stops when FN returns 0. */
6839 void
6840 foreach_window (struct frame *f, int (*fn) (struct window *, void *), void *user_data)
6842 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6843 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6844 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6848 /* Helper function for foreach_window. Call FN for all leaf windows
6849 reachable from W. FN is called with the first argument being a
6850 pointer to the leaf window, and with additional argument USER_DATA.
6851 Stop when FN returns 0. Value is 0 if stopped by FN. */
6853 static int
6854 foreach_window_1 (struct window *w, int (*fn) (struct window *, void *), void *user_data)
6856 int cont;
6858 for (cont = 1; w && cont;)
6860 if (!NILP (w->hchild))
6861 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6862 else if (!NILP (w->vchild))
6863 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6864 else
6865 cont = fn (w, user_data);
6867 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6870 return cont;
6874 /* Freeze or unfreeze the window start of W unless it is a
6875 mini-window or the selected window. FREEZE_P non-null means freeze
6876 the window start. */
6878 static int
6879 freeze_window_start (struct window *w, void *freeze_p)
6881 if (MINI_WINDOW_P (w)
6882 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6883 && (w == XWINDOW (selected_window)
6884 || (MINI_WINDOW_P (XWINDOW (selected_window))
6885 && ! NILP (Vminibuf_scroll_window)
6886 && w == XWINDOW (Vminibuf_scroll_window)))))
6887 freeze_p = NULL;
6889 w->frozen_window_start_p = freeze_p != NULL;
6890 return 1;
6894 /* Freeze or unfreeze the window starts of all leaf windows on frame
6895 F, except the selected window and a mini-window. FREEZE_P non-zero
6896 means freeze the window start. */
6898 void
6899 freeze_window_starts (struct frame *f, int freeze_p)
6901 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6905 /***********************************************************************
6906 Initialization
6907 ***********************************************************************/
6909 /* Return 1 if window configurations C1 and C2
6910 describe the same state of affairs. This is used by Fequal. */
6913 compare_window_configurations (Lisp_Object c1, Lisp_Object c2, int ignore_positions)
6915 register struct save_window_data *d1, *d2;
6916 struct Lisp_Vector *sw1, *sw2;
6917 int i;
6919 CHECK_WINDOW_CONFIGURATION (c1);
6920 CHECK_WINDOW_CONFIGURATION (c2);
6922 d1 = (struct save_window_data *) XVECTOR (c1);
6923 d2 = (struct save_window_data *) XVECTOR (c2);
6924 sw1 = XVECTOR (d1->saved_windows);
6925 sw2 = XVECTOR (d2->saved_windows);
6927 if (d1->frame_cols != d2->frame_cols)
6928 return 0;
6929 if (d1->frame_lines != d2->frame_lines)
6930 return 0;
6931 if (d1->frame_menu_bar_lines != d2->frame_menu_bar_lines)
6932 return 0;
6933 if (! EQ (d1->selected_frame, d2->selected_frame))
6934 return 0;
6935 /* Don't compare the current_window field directly.
6936 Instead see w1_is_current and w2_is_current, below. */
6937 if (! EQ (d1->current_buffer, d2->current_buffer))
6938 return 0;
6939 if (! ignore_positions)
6941 if (! EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window))
6942 return 0;
6943 if (! EQ (d1->minibuf_selected_window, d2->minibuf_selected_window))
6944 return 0;
6946 /* Don't compare the root_window field.
6947 We don't require the two configurations
6948 to use the same window object,
6949 and the two root windows must be equivalent
6950 if everything else compares equal. */
6951 if (! EQ (d1->focus_frame, d2->focus_frame))
6952 return 0;
6954 /* Verify that the two confis have the same number of windows. */
6955 if (sw1->size != sw2->size)
6956 return 0;
6958 for (i = 0; i < sw1->size; i++)
6960 struct saved_window *p1, *p2;
6961 int w1_is_current, w2_is_current;
6963 p1 = SAVED_WINDOW_N (sw1, i);
6964 p2 = SAVED_WINDOW_N (sw2, i);
6966 /* Verify that the current windows in the two
6967 configurations correspond to each other. */
6968 w1_is_current = EQ (d1->current_window, p1->window);
6969 w2_is_current = EQ (d2->current_window, p2->window);
6971 if (w1_is_current != w2_is_current)
6972 return 0;
6974 /* Verify that the corresponding windows do match. */
6975 if (! EQ (p1->buffer, p2->buffer))
6976 return 0;
6977 if (! EQ (p1->left_col, p2->left_col))
6978 return 0;
6979 if (! EQ (p1->top_line, p2->top_line))
6980 return 0;
6981 if (! EQ (p1->total_cols, p2->total_cols))
6982 return 0;
6983 if (! EQ (p1->total_lines, p2->total_lines))
6984 return 0;
6985 if (! EQ (p1->display_table, p2->display_table))
6986 return 0;
6987 if (! EQ (p1->parent, p2->parent))
6988 return 0;
6989 if (! EQ (p1->prev, p2->prev))
6990 return 0;
6991 if (! ignore_positions)
6993 if (! EQ (p1->hscroll, p2->hscroll))
6994 return 0;
6995 if (!EQ (p1->min_hscroll, p2->min_hscroll))
6996 return 0;
6997 if (! EQ (p1->start_at_line_beg, p2->start_at_line_beg))
6998 return 0;
6999 if (NILP (Fequal (p1->start, p2->start)))
7000 return 0;
7001 if (NILP (Fequal (p1->pointm, p2->pointm)))
7002 return 0;
7003 if (NILP (Fequal (p1->mark, p2->mark)))
7004 return 0;
7006 if (! EQ (p1->left_margin_cols, p2->left_margin_cols))
7007 return 0;
7008 if (! EQ (p1->right_margin_cols, p2->right_margin_cols))
7009 return 0;
7010 if (! EQ (p1->left_fringe_width, p2->left_fringe_width))
7011 return 0;
7012 if (! EQ (p1->right_fringe_width, p2->right_fringe_width))
7013 return 0;
7014 if (! EQ (p1->fringes_outside_margins, p2->fringes_outside_margins))
7015 return 0;
7016 if (! EQ (p1->scroll_bar_width, p2->scroll_bar_width))
7017 return 0;
7018 if (! EQ (p1->vertical_scroll_bar_type, p2->vertical_scroll_bar_type))
7019 return 0;
7022 return 1;
7025 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
7026 Scompare_window_configurations, 2, 2, 0,
7027 doc: /* Compare two window configurations as regards the structure of windows.
7028 This function ignores details such as the values of point and mark
7029 and scrolling positions. */)
7030 (Lisp_Object x, Lisp_Object y)
7032 if (compare_window_configurations (x, y, 1))
7033 return Qt;
7034 return Qnil;
7037 void
7038 init_window_once (void)
7040 struct frame *f = make_initial_frame ();
7041 XSETFRAME (selected_frame, f);
7042 Vterminal_frame = selected_frame;
7043 minibuf_window = f->minibuffer_window;
7044 selected_window = f->selected_window;
7045 last_nonminibuf_frame = f;
7047 window_initialized = 1;
7050 void
7051 init_window (void)
7053 Vwindow_list = Qnil;
7056 void
7057 syms_of_window (void)
7059 Qscroll_up = intern_c_string ("scroll-up");
7060 staticpro (&Qscroll_up);
7062 Qscroll_down = intern_c_string ("scroll-down");
7063 staticpro (&Qscroll_down);
7065 Qscroll_command = intern_c_string ("scroll-command");
7066 staticpro (&Qscroll_command);
7068 Fput (Qscroll_up, Qscroll_command, Qt);
7069 Fput (Qscroll_down, Qscroll_command, Qt);
7071 Qwindow_size_fixed = intern_c_string ("window-size-fixed");
7072 staticpro (&Qwindow_size_fixed);
7073 Fset (Qwindow_size_fixed, Qnil);
7075 staticpro (&Qwindow_configuration_change_hook);
7076 Qwindow_configuration_change_hook
7077 = intern_c_string ("window-configuration-change-hook");
7079 Qwindowp = intern_c_string ("windowp");
7080 staticpro (&Qwindowp);
7082 Qwindow_configuration_p = intern_c_string ("window-configuration-p");
7083 staticpro (&Qwindow_configuration_p);
7085 Qwindow_live_p = intern_c_string ("window-live-p");
7086 staticpro (&Qwindow_live_p);
7088 Qdisplay_buffer = intern_c_string ("display-buffer");
7089 staticpro (&Qdisplay_buffer);
7091 Qtemp_buffer_show_hook = intern_c_string ("temp-buffer-show-hook");
7092 staticpro (&Qtemp_buffer_show_hook);
7094 staticpro (&Vwindow_list);
7096 minibuf_selected_window = Qnil;
7097 staticpro (&minibuf_selected_window);
7099 window_scroll_pixel_based_preserve_x = -1;
7100 window_scroll_pixel_based_preserve_y = -1;
7101 window_scroll_preserve_hpos = -1;
7102 window_scroll_preserve_vpos = -1;
7104 DEFVAR_LISP ("temp-buffer-show-function", &Vtemp_buffer_show_function,
7105 doc: /* Non-nil means call as function to display a help buffer.
7106 The function is called with one argument, the buffer to be displayed.
7107 Used by `with-output-to-temp-buffer'.
7108 If this function is used, then it must do the entire job of showing
7109 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
7110 Vtemp_buffer_show_function = Qnil;
7112 DEFVAR_LISP ("minibuffer-scroll-window", &Vminibuf_scroll_window,
7113 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
7114 Vminibuf_scroll_window = Qnil;
7116 DEFVAR_BOOL ("mode-line-in-non-selected-windows", &mode_line_in_non_selected_windows,
7117 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
7118 If the minibuffer is active, the `minibuffer-scroll-window' mode line
7119 is displayed in the `mode-line' face. */);
7120 mode_line_in_non_selected_windows = 1;
7122 DEFVAR_LISP ("other-window-scroll-buffer", &Vother_window_scroll_buffer,
7123 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
7124 Vother_window_scroll_buffer = Qnil;
7126 DEFVAR_BOOL ("auto-window-vscroll", &auto_window_vscroll_p,
7127 doc: /* *Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
7128 auto_window_vscroll_p = 1;
7130 DEFVAR_INT ("next-screen-context-lines", &next_screen_context_lines,
7131 doc: /* *Number of lines of continuity when scrolling by screenfuls. */);
7132 next_screen_context_lines = 2;
7134 DEFVAR_INT ("window-min-height", &window_min_height,
7135 doc: /* Allow deleting windows less than this tall.
7136 The value is measured in line units. If a window wants a modeline it
7137 is counted as one line.
7139 Emacs honors settings of this variable when enlarging or shrinking
7140 windows vertically. A value less than 1 is invalid. */);
7141 window_min_height = 4;
7143 DEFVAR_INT ("window-min-width", &window_min_width,
7144 doc: /* Allow deleting windows less than this wide.
7145 The value is measured in characters and includes any fringes or
7146 the scrollbar.
7148 Emacs honors settings of this variable when enlarging or shrinking
7149 windows horizontally. A value less than 2 is invalid. */);
7150 window_min_width = 10;
7152 DEFVAR_LISP ("scroll-preserve-screen-position",
7153 &Vscroll_preserve_screen_position,
7154 doc: /* *Controls if scroll commands move point to keep its screen position unchanged.
7155 A value of nil means point does not keep its screen position except
7156 at the scroll margin or window boundary respectively.
7157 A value of t means point keeps its screen position if the scroll
7158 command moved it vertically out of the window, e.g. when scrolling
7159 by full screens.
7160 Any other value means point always keeps its screen position.
7161 Scroll commands should have the `scroll-command' property
7162 on their symbols to be controlled by this variable. */);
7163 Vscroll_preserve_screen_position = Qnil;
7165 DEFVAR_LISP ("window-point-insertion-type", &Vwindow_point_insertion_type,
7166 doc: /* Type of marker to use for `window-point'. */);
7167 Vwindow_point_insertion_type = Qnil;
7169 DEFVAR_LISP ("window-configuration-change-hook",
7170 &Vwindow_configuration_change_hook,
7171 doc: /* Functions to call when window configuration changes.
7172 The buffer-local part is run once per window, with the relevant window
7173 selected; while the global part is run only once for the modified frame,
7174 with the relevant frame selected. */);
7175 Vwindow_configuration_change_hook = Qnil;
7177 DEFVAR_LISP ("recenter-redisplay", &Vrecenter_redisplay,
7178 doc: /* If non-nil, then the `recenter' command with a nil argument
7179 will redraw the entire frame; the special value `tty' causes the
7180 frame to be redrawn only if it is a tty frame. */);
7181 Vrecenter_redisplay = Qtty;
7184 defsubr (&Sselected_window);
7185 defsubr (&Sminibuffer_window);
7186 defsubr (&Swindow_minibuffer_p);
7187 defsubr (&Swindowp);
7188 defsubr (&Swindow_live_p);
7189 defsubr (&Spos_visible_in_window_p);
7190 defsubr (&Swindow_line_height);
7191 defsubr (&Swindow_buffer);
7192 defsubr (&Swindow_height);
7193 defsubr (&Swindow_width);
7194 defsubr (&Swindow_full_width_p);
7195 defsubr (&Swindow_hscroll);
7196 defsubr (&Sset_window_hscroll);
7197 defsubr (&Swindow_redisplay_end_trigger);
7198 defsubr (&Sset_window_redisplay_end_trigger);
7199 defsubr (&Swindow_edges);
7200 defsubr (&Swindow_pixel_edges);
7201 defsubr (&Swindow_absolute_pixel_edges);
7202 defsubr (&Swindow_inside_edges);
7203 defsubr (&Swindow_inside_pixel_edges);
7204 defsubr (&Swindow_inside_absolute_pixel_edges);
7205 defsubr (&Scoordinates_in_window_p);
7206 defsubr (&Swindow_at);
7207 defsubr (&Swindow_point);
7208 defsubr (&Swindow_start);
7209 defsubr (&Swindow_end);
7210 defsubr (&Sset_window_point);
7211 defsubr (&Sset_window_start);
7212 defsubr (&Swindow_dedicated_p);
7213 defsubr (&Sset_window_dedicated_p);
7214 defsubr (&Swindow_display_table);
7215 defsubr (&Sset_window_display_table);
7216 defsubr (&Snext_window);
7217 defsubr (&Sprevious_window);
7218 defsubr (&Sother_window);
7219 defsubr (&Sget_lru_window);
7220 defsubr (&Sget_largest_window);
7221 defsubr (&Sget_buffer_window);
7222 defsubr (&Sdelete_other_windows);
7223 defsubr (&Sdelete_windows_on);
7224 defsubr (&Sreplace_buffer_in_windows);
7225 defsubr (&Sdelete_window);
7226 defsubr (&Sset_window_buffer);
7227 defsubr (&Sselect_window);
7228 defsubr (&Sforce_window_update);
7229 defsubr (&Ssplit_window);
7230 defsubr (&Senlarge_window);
7231 defsubr (&Sshrink_window);
7232 defsubr (&Sadjust_window_trailing_edge);
7233 defsubr (&Sscroll_up);
7234 defsubr (&Sscroll_down);
7235 defsubr (&Sscroll_left);
7236 defsubr (&Sscroll_right);
7237 defsubr (&Sother_window_for_scrolling);
7238 defsubr (&Sscroll_other_window);
7239 defsubr (&Sminibuffer_selected_window);
7240 defsubr (&Srecenter);
7241 defsubr (&Swindow_text_height);
7242 defsubr (&Smove_to_window_line);
7243 defsubr (&Swindow_configuration_p);
7244 defsubr (&Swindow_configuration_frame);
7245 defsubr (&Sset_window_configuration);
7246 defsubr (&Scurrent_window_configuration);
7247 defsubr (&Ssave_window_excursion);
7248 defsubr (&Swindow_tree);
7249 defsubr (&Sset_window_margins);
7250 defsubr (&Swindow_margins);
7251 defsubr (&Sset_window_fringes);
7252 defsubr (&Swindow_fringes);
7253 defsubr (&Sset_window_scroll_bars);
7254 defsubr (&Swindow_scroll_bars);
7255 defsubr (&Swindow_vscroll);
7256 defsubr (&Sset_window_vscroll);
7257 defsubr (&Scompare_window_configurations);
7258 defsubr (&Swindow_list);
7259 defsubr (&Swindow_parameters);
7260 defsubr (&Swindow_parameter);
7261 defsubr (&Sset_window_parameter);
7265 void
7266 keys_of_window (void)
7268 initial_define_key (control_x_map, '1', "delete-other-windows");
7269 initial_define_key (control_x_map, '2', "split-window");
7270 initial_define_key (control_x_map, '0', "delete-window");
7271 initial_define_key (control_x_map, 'o', "other-window");
7272 initial_define_key (control_x_map, '^', "enlarge-window");
7273 initial_define_key (control_x_map, '<', "scroll-left");
7274 initial_define_key (control_x_map, '>', "scroll-right");
7276 initial_define_key (global_map, Ctl ('V'), "scroll-up-command");
7277 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
7278 initial_define_key (meta_map, 'v', "scroll-down-command");
7281 /* arch-tag: 90a9c576-0590-48f1-a5f1-6c96a0452d9f
7282 (do not change this comment) */