(Fwindow_dedicated_p, Fset_window_dedicated_p):
[emacs.git] / src / window.c
blob58b8dd3b843f5ce623fbf2c2107a7356325ce15d
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
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>
25 #include "lisp.h"
26 #include "buffer.h"
27 #include "keyboard.h"
28 #include "keymap.h"
29 #include "frame.h"
30 #include "window.h"
31 #include "commands.h"
32 #include "indent.h"
33 #include "termchar.h"
34 #include "disptab.h"
35 #include "dispextern.h"
36 #include "blockinput.h"
37 #include "intervals.h"
38 #include "termhooks.h" /* For FRAME_TERMINAL. */
40 #ifdef HAVE_X_WINDOWS
41 #include "xterm.h"
42 #endif /* HAVE_X_WINDOWS */
43 #ifdef WINDOWSNT
44 #include "w32term.h"
45 #endif
46 #ifdef MSDOS
47 #include "msdos.h"
48 #endif
49 #ifdef HAVE_NS
50 #include "nsterm.h"
51 #endif
54 Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
55 Lisp_Object Qdisplay_buffer;
56 Lisp_Object Qscroll_up, Qscroll_down;
57 Lisp_Object Qwindow_size_fixed;
59 extern Lisp_Object Qleft_margin, Qright_margin;
61 static int displayed_window_lines P_ ((struct window *));
62 static struct window *decode_window P_ ((Lisp_Object));
63 static int count_windows P_ ((struct window *));
64 static int get_leaf_windows P_ ((struct window *, struct window **, int));
65 static void window_scroll P_ ((Lisp_Object, int, int, int));
66 static void window_scroll_pixel_based P_ ((Lisp_Object, int, int, int));
67 static void window_scroll_line_based P_ ((Lisp_Object, int, int, int));
68 static int window_min_size_1 P_ ((struct window *, int, int));
69 static int window_min_size_2 P_ ((struct window *, int, int));
70 static int window_min_size P_ ((struct window *, int, int, int, int *));
71 static void size_window P_ ((Lisp_Object, int, int, int, int, int));
72 static int freeze_window_start P_ ((struct window *, void *));
73 static int window_fixed_size_p P_ ((struct window *, int, int));
74 static void enlarge_window P_ ((Lisp_Object, int, int));
75 static Lisp_Object window_list P_ ((void));
76 static int add_window_to_list P_ ((struct window *, void *));
77 static int candidate_window_p P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
78 Lisp_Object));
79 static Lisp_Object next_window P_ ((Lisp_Object, Lisp_Object,
80 Lisp_Object, int));
81 static void decode_next_window_args P_ ((Lisp_Object *, Lisp_Object *,
82 Lisp_Object *));
83 static int foreach_window_1 P_ ((struct window *,
84 int (* fn) (struct window *, void *),
85 void *));
86 static Lisp_Object window_list_1 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
88 /* This is the window in which the terminal's cursor should
89 be left when nothing is being done with it. This must
90 always be a leaf window, and its buffer is selected by
91 the top level editing loop at the end of each command.
93 This value is always the same as
94 FRAME_SELECTED_WINDOW (selected_frame). */
96 Lisp_Object selected_window;
98 /* A list of all windows for use by next_window and Fwindow_list.
99 Functions creating or deleting windows should invalidate this cache
100 by setting it to nil. */
102 Lisp_Object Vwindow_list;
104 /* The mini-buffer window of the selected frame.
105 Note that you cannot test for mini-bufferness of an arbitrary window
106 by comparing against this; but you can test for mini-bufferness of
107 the selected window. */
109 Lisp_Object minibuf_window;
111 /* Non-nil means it is the window whose mode line should be
112 shown as the selected window when the minibuffer is selected. */
114 Lisp_Object minibuf_selected_window;
116 /* Non-nil means it is the window for C-M-v to scroll
117 when the mini-buffer is selected. */
119 Lisp_Object Vminibuf_scroll_window;
121 /* Non-nil means this is the buffer whose window C-M-v should scroll. */
123 Lisp_Object Vother_window_scroll_buffer;
125 /* Non-nil means it's function to call to display temp buffers. */
127 Lisp_Object Vtemp_buffer_show_function;
129 /* Non-zero means line and page scrolling on tall lines (with images)
130 does partial scrolling by modifying window-vscroll. */
132 int auto_window_vscroll_p;
134 /* Non-zero means to use mode-line-inactive face in all windows but the
135 selected-window and the minibuffer-scroll-window when the
136 minibuffer is active. */
137 int mode_line_in_non_selected_windows;
139 /* If a window gets smaller than either of these, it is removed. */
141 EMACS_INT window_min_height;
142 EMACS_INT window_min_width;
144 /* Hook run at end of temp_output_buffer_show. */
146 Lisp_Object Qtemp_buffer_show_hook;
148 /* Number of lines of continuity in scrolling by screenfuls. */
150 EMACS_INT next_screen_context_lines;
152 /* Incremented for each window created. */
154 static int sequence_number;
156 /* Nonzero after init_window_once has finished. */
158 static int window_initialized;
160 /* Hook to run when window config changes. */
162 static Lisp_Object Qwindow_configuration_change_hook;
163 static Lisp_Object Vwindow_configuration_change_hook;
165 /* Non-nil means scroll commands try to put point
166 at the same screen height as previously. */
168 Lisp_Object Vscroll_preserve_screen_position;
170 /* Non-nil means that text is inserted before window's markers. */
172 Lisp_Object Vwindow_point_insertion_type;
174 /* Incremented by 1 whenever a window is deleted. */
176 int window_deletion_count;
178 /* Used by the function window_scroll_pixel_based */
180 static int window_scroll_pixel_based_preserve_x;
181 static int window_scroll_pixel_based_preserve_y;
183 /* Same for window_scroll_line_based. */
185 static int window_scroll_preserve_hpos;
186 static int window_scroll_preserve_vpos;
188 #if 0 /* This isn't used anywhere. */
189 /* Nonzero means we can split a frame even if it is "unsplittable". */
190 static int inhibit_frame_unsplittable;
191 #endif /* 0 */
193 extern EMACS_INT scroll_margin;
195 extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
197 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
198 doc: /* Returns t if OBJECT is a window. */)
199 (object)
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: /* Returns t if OBJECT is a window which is currently visible. */)
207 (object)
208 Lisp_Object object;
210 return WINDOW_LIVE_P (object) ? Qt : Qnil;
213 Lisp_Object
214 make_window ()
216 Lisp_Object val;
217 register struct window *p;
219 p = allocate_window ();
220 ++sequence_number;
221 XSETFASTINT (p->sequence_number, sequence_number);
222 XSETFASTINT (p->left_col, 0);
223 XSETFASTINT (p->top_line, 0);
224 XSETFASTINT (p->total_lines, 0);
225 XSETFASTINT (p->total_cols, 0);
226 XSETFASTINT (p->hscroll, 0);
227 XSETFASTINT (p->min_hscroll, 0);
228 p->orig_top_line = p->orig_total_lines = Qnil;
229 p->start = Fmake_marker ();
230 p->pointm = Fmake_marker ();
231 XSETFASTINT (p->use_time, 0);
232 p->frame = Qnil;
233 p->display_table = Qnil;
234 p->dedicated = Qnil;
235 p->window_parameters = Qnil;
236 p->pseudo_window_p = 0;
237 bzero (&p->cursor, sizeof (p->cursor));
238 bzero (&p->last_cursor, sizeof (p->last_cursor));
239 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
240 p->desired_matrix = p->current_matrix = 0;
241 p->nrows_scale_factor = p->ncols_scale_factor = 1;
242 p->phys_cursor_type = -1;
243 p->phys_cursor_width = -1;
244 p->must_be_updated_p = 0;
245 XSETFASTINT (p->window_end_vpos, 0);
246 XSETFASTINT (p->window_end_pos, 0);
247 p->window_end_valid = Qnil;
248 p->vscroll = 0;
249 XSETWINDOW (val, p);
250 XSETFASTINT (p->last_point, 0);
251 p->frozen_window_start_p = 0;
252 p->last_cursor_off_p = p->cursor_off_p = 0;
253 p->left_margin_cols = Qnil;
254 p->right_margin_cols = Qnil;
255 p->left_fringe_width = Qnil;
256 p->right_fringe_width = Qnil;
257 p->fringes_outside_margins = Qnil;
258 p->scroll_bar_width = Qnil;
259 p->vertical_scroll_bar_type = Qt;
260 p->resize_proportionally = Qnil;
262 Vwindow_list = Qnil;
263 return val;
266 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
267 doc: /* Return the window that the cursor now appears in and commands apply to. */)
270 return selected_window;
273 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
274 doc: /* Return the window used now for minibuffers.
275 If the optional argument FRAME is specified, return the minibuffer window
276 used by that frame. */)
277 (frame)
278 Lisp_Object frame;
280 if (NILP (frame))
281 frame = selected_frame;
282 CHECK_LIVE_FRAME (frame);
283 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
286 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
287 doc: /* Returns non-nil if WINDOW is a minibuffer window.
288 WINDOW defaults to the selected window. */)
289 (window)
290 Lisp_Object window;
292 struct window *w = decode_window (window);
293 return MINI_WINDOW_P (w) ? Qt : Qnil;
297 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
298 Spos_visible_in_window_p, 0, 3, 0,
299 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
300 Return nil if that position is scrolled vertically out of view.
301 If a character is only partially visible, nil is returned, unless the
302 optional argument PARTIALLY is non-nil.
303 If POS is only out of view because of horizontal scrolling, return non-nil.
304 If POS is t, it specifies the position of the last visible glyph in WINDOW.
305 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
307 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
308 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
309 where X and Y are the pixel coordinates relative to the top left corner
310 of the window. The remaining elements are omitted if the character after
311 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
312 off-window at the top and bottom of the row, ROWH is the height of the
313 display row, and VPOS is the row number (0-based) containing POS. */)
314 (pos, window, partially)
315 Lisp_Object pos, window, partially;
317 register struct window *w;
318 register int posint;
319 register struct buffer *buf;
320 struct text_pos top;
321 Lisp_Object in_window = Qnil;
322 int rtop, rbot, rowh, vpos, fully_p = 1;
323 int x, y;
325 w = decode_window (window);
326 buf = XBUFFER (w->buffer);
327 SET_TEXT_POS_FROM_MARKER (top, w->start);
329 if (EQ (pos, Qt))
330 posint = -1;
331 else if (!NILP (pos))
333 CHECK_NUMBER_COERCE_MARKER (pos);
334 posint = XINT (pos);
336 else if (w == XWINDOW (selected_window))
337 posint = PT;
338 else
339 posint = XMARKER (w->pointm)->charpos;
341 /* If position is above window start or outside buffer boundaries,
342 or if window start is out of range, position is not visible. */
343 if ((EQ (pos, Qt)
344 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
345 && CHARPOS (top) >= BUF_BEGV (buf)
346 && CHARPOS (top) <= BUF_ZV (buf)
347 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
348 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
349 in_window = Qt;
351 if (!NILP (in_window) && !NILP (partially))
353 Lisp_Object part = Qnil;
354 if (!fully_p)
355 part = list4 (make_number (rtop), make_number (rbot),
356 make_number (rowh), make_number (vpos));
357 in_window = Fcons (make_number (x),
358 Fcons (make_number (y), part));
361 return in_window;
364 DEFUN ("window-line-height", Fwindow_line_height,
365 Swindow_line_height, 0, 2, 0,
366 doc: /* Return height in pixels of text line LINE in window WINDOW.
367 If WINDOW is nil or omitted, use selected window.
369 Return height of current line if LINE is omitted or nil. Return height of
370 header or mode line if LINE is `header-line' and `mode-line'.
371 Otherwise, LINE is a text line number starting from 0. A negative number
372 counts from the end of the window.
374 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
375 in pixels of the visible part of the line, VPOS and YPOS are the
376 vertical position in lines and pixels of the line, relative to the top
377 of the first text line, and OFFBOT is the number of off-window pixels at
378 the bottom of the text line. If there are off-window pixels at the top
379 of the (first) text line, YPOS is negative.
381 Return nil if window display is not up-to-date. In that case, use
382 `pos-visible-in-window-p' to obtain the information. */)
383 (line, window)
384 Lisp_Object line, window;
386 register struct window *w;
387 register struct buffer *b;
388 struct glyph_row *row, *end_row;
389 int max_y, crop, i, n;
391 w = decode_window (window);
393 if (noninteractive
394 || w->pseudo_window_p)
395 return Qnil;
397 CHECK_BUFFER (w->buffer);
398 b = XBUFFER (w->buffer);
400 /* Fail if current matrix is not up-to-date. */
401 if (NILP (w->window_end_valid)
402 || current_buffer->clip_changed
403 || current_buffer->prevent_redisplay_optimizations_p
404 || XFASTINT (w->last_modified) < BUF_MODIFF (b)
405 || XFASTINT (w->last_overlay_modified) < BUF_OVERLAY_MODIFF (b))
406 return Qnil;
408 if (NILP (line))
410 i = w->cursor.vpos;
411 if (i < 0 || i >= w->current_matrix->nrows
412 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
413 return Qnil;
414 max_y = window_text_bottom_y (w);
415 goto found_row;
418 if (EQ (line, Qheader_line))
420 if (!WINDOW_WANTS_HEADER_LINE_P (w))
421 return Qnil;
422 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
423 if (!row->enabled_p)
424 return Qnil;
425 return list4 (make_number (row->height),
426 make_number (0), make_number (0),
427 make_number (0));
430 if (EQ (line, Qmode_line))
432 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
433 if (!row->enabled_p)
434 return Qnil;
435 return list4 (make_number (row->height),
436 make_number (0), /* not accurate */
437 make_number (WINDOW_HEADER_LINE_HEIGHT (w)
438 + window_text_bottom_y (w)),
439 make_number (0));
442 CHECK_NUMBER (line);
443 n = XINT (line);
445 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
446 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
447 max_y = window_text_bottom_y (w);
448 i = 0;
450 while ((n < 0 || i < n)
451 && row <= end_row && row->enabled_p
452 && row->y + row->height < max_y)
453 row++, i++;
455 if (row > end_row || !row->enabled_p)
456 return Qnil;
458 if (++n < 0)
460 if (-n > i)
461 return Qnil;
462 row += n;
463 i += n;
466 found_row:
467 crop = max (0, (row->y + row->height) - max_y);
468 return list4 (make_number (row->height + min (0, row->y) - crop),
469 make_number (i),
470 make_number (row->y),
471 make_number (crop));
476 static struct window *
477 decode_window (window)
478 register Lisp_Object window;
480 if (NILP (window))
481 return XWINDOW (selected_window);
483 CHECK_LIVE_WINDOW (window);
484 return XWINDOW (window);
487 static struct window *
488 decode_any_window (window)
489 register Lisp_Object window;
491 if (NILP (window))
492 return XWINDOW (selected_window);
494 CHECK_WINDOW (window);
495 return XWINDOW (window);
498 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
499 doc: /* Return the buffer that WINDOW is displaying.
500 WINDOW defaults to the selected window. */)
501 (window)
502 Lisp_Object window;
504 return decode_window (window)->buffer;
507 DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
508 doc: /* Return the number of lines in WINDOW (including its mode line).
509 WINDOW defaults to the selected window. */)
510 (window)
511 Lisp_Object window;
513 return decode_any_window (window)->total_lines;
516 DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
517 doc: /* Return the number of display columns in WINDOW.
518 WINDOW defaults to the selected window.
520 Note: The return value is the number of columns available for text in
521 WINDOW. If you want to find out how many columns WINDOW takes up, use
522 (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))). */)
523 (window)
524 Lisp_Object window;
526 return make_number (window_box_text_cols (decode_any_window (window)));
529 DEFUN ("window-full-width-p", Fwindow_full_width_p, Swindow_full_width_p, 0, 1, 0,
530 doc: /* Return t if WINDOW is as wide as its frame.
531 WINDOW defaults to the selected window. */)
532 (window)
533 Lisp_Object window;
535 return WINDOW_FULL_WIDTH_P (decode_any_window (window)) ? Qt : Qnil;
538 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
539 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
540 WINDOW defaults to the selected window. */)
541 (window)
542 Lisp_Object window;
544 return decode_window (window)->hscroll;
547 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
548 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
549 Return NCOL. NCOL should be zero or positive.
551 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
552 window so that the location of point moves off-window. */)
553 (window, ncol)
554 Lisp_Object window, ncol;
556 struct window *w = decode_window (window);
557 int hscroll;
559 CHECK_NUMBER (ncol);
560 hscroll = max (0, XINT (ncol));
562 /* Prevent redisplay shortcuts when changing the hscroll. */
563 if (XINT (w->hscroll) != hscroll)
564 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
566 w->hscroll = make_number (hscroll);
567 return ncol;
570 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
571 Swindow_redisplay_end_trigger, 0, 1, 0,
572 doc: /* Return WINDOW's redisplay end trigger value.
573 WINDOW defaults to the selected window.
574 See `set-window-redisplay-end-trigger' for more information. */)
575 (window)
576 Lisp_Object window;
578 return decode_window (window)->redisplay_end_trigger;
581 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
582 Sset_window_redisplay_end_trigger, 2, 2, 0,
583 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
584 VALUE should be a buffer position (typically a marker) or nil.
585 If it is a buffer position, then if redisplay in WINDOW reaches a position
586 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
587 with two arguments: WINDOW, and the end trigger value.
588 Afterwards the end-trigger value is reset to nil. */)
589 (window, value)
590 register Lisp_Object window, value;
592 register struct window *w;
594 w = decode_window (window);
595 w->redisplay_end_trigger = value;
596 return value;
599 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
600 doc: /* Return a list of the edge coordinates of WINDOW.
601 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
602 RIGHT is one more than the rightmost column occupied by WINDOW,
603 and BOTTOM is one more than the bottommost row occupied by WINDOW.
604 The edges include the space used by the window's scroll bar,
605 display margins, fringes, header line, and mode line, if it has them.
606 To get the edges of the actual text area, use `window-inside-edges'. */)
607 (window)
608 Lisp_Object window;
610 register struct window *w = decode_any_window (window);
612 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
613 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
614 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
615 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
616 Qnil))));
619 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
620 doc: /* Return a list of the edge pixel coordinates of WINDOW.
621 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
622 RIGHT is one more than the rightmost x position occupied by WINDOW,
623 and BOTTOM is one more than the bottommost y position occupied by WINDOW.
624 The pixel edges include the space used by the window's scroll bar,
625 display margins, fringes, header line, and mode line, if it has them.
626 To get the edges of the actual text area, use `window-inside-pixel-edges'. */)
627 (window)
628 Lisp_Object window;
630 register struct window *w = decode_any_window (window);
632 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
633 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
634 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
635 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
636 Qnil))));
639 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
640 doc: /* Return a list of the edge coordinates of WINDOW.
641 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
642 RIGHT is one more than the rightmost column used by text in WINDOW,
643 and BOTTOM is one more than the bottommost row used by text in WINDOW.
644 The inside edges do not include the space used by the window's scroll bar,
645 display margins, fringes, header line, and/or mode line. */)
646 (window)
647 Lisp_Object window;
649 register struct window *w = decode_any_window (window);
651 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
652 + WINDOW_LEFT_MARGIN_COLS (w)
653 + WINDOW_LEFT_FRINGE_COLS (w)),
654 make_number (WINDOW_TOP_EDGE_LINE (w)
655 + WINDOW_HEADER_LINE_LINES (w)),
656 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
657 - WINDOW_RIGHT_MARGIN_COLS (w)
658 - WINDOW_RIGHT_FRINGE_COLS (w)),
659 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
660 - WINDOW_MODE_LINE_LINES (w)));
663 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
664 doc: /* Return a list of the edge pixel coordinates of WINDOW.
665 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
666 RIGHT is one more than the rightmost x position used by text in WINDOW,
667 and BOTTOM is one more than the bottommost y position used by text in WINDOW.
668 The inside edges do not include the space used by the window's scroll bar,
669 display margins, fringes, header line, and/or mode line. */)
670 (window)
671 Lisp_Object window;
673 register struct window *w = decode_any_window (window);
675 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
676 + WINDOW_LEFT_MARGIN_WIDTH (w)
677 + WINDOW_LEFT_FRINGE_WIDTH (w)),
678 make_number (WINDOW_TOP_EDGE_Y (w)
679 + WINDOW_HEADER_LINE_HEIGHT (w)),
680 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
681 - WINDOW_RIGHT_MARGIN_WIDTH (w)
682 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
683 make_number (WINDOW_BOTTOM_EDGE_Y (w)
684 - WINDOW_MODE_LINE_HEIGHT (w)));
687 /* Test if the character at column *X, row *Y is within window W.
688 If it is not, return ON_NOTHING;
689 if it is in the window's text area,
690 set *x and *y to its location relative to the upper left corner
691 of the window, and
692 return ON_TEXT;
693 if it is on the window's modeline, return ON_MODE_LINE;
694 if it is on the border between the window and its right sibling,
695 return ON_VERTICAL_BORDER.
696 if it is on a scroll bar,
697 return ON_SCROLL_BAR.
698 if it is on the window's top line, return ON_HEADER_LINE;
699 if it is in left or right fringe of the window,
700 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE, and convert *X and *Y
701 to window-relative coordinates;
702 if it is in the marginal area to the left/right of the window,
703 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN, and convert *X and *Y
704 to window-relative coordinates.
706 X and Y are frame relative pixel coordinates. */
708 static enum window_part
709 coordinates_in_window (w, x, y)
710 register struct window *w;
711 register int *x, *y;
713 struct frame *f = XFRAME (WINDOW_FRAME (w));
714 int left_x, right_x, top_y, bottom_y;
715 enum window_part part;
716 int ux = FRAME_COLUMN_WIDTH (f);
717 int x0 = WINDOW_LEFT_EDGE_X (w);
718 int x1 = WINDOW_RIGHT_EDGE_X (w);
719 /* The width of the area where the vertical line can be dragged.
720 (Between mode lines for instance. */
721 int grabbable_width = ux;
722 int lmargin_width, rmargin_width, text_left, text_right;
724 /* In what's below, we subtract 1 when computing right_x because we
725 want the rightmost pixel, which is given by left_pixel+width-1. */
726 if (w->pseudo_window_p)
728 left_x = 0;
729 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
730 top_y = WINDOW_TOP_EDGE_Y (w);
731 bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
733 else
735 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
736 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
737 top_y = WINDOW_TOP_EDGE_Y (w);
738 bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
741 /* Outside any interesting row? */
742 if (*y < top_y || *y >= bottom_y)
743 return ON_NOTHING;
745 /* On the mode line or header line? If it's near the start of
746 the mode or header line of window that's has a horizontal
747 sibling, say it's on the vertical line. That's to be able
748 to resize windows horizontally in case we're using toolkit
749 scroll bars. */
751 if (WINDOW_WANTS_MODELINE_P (w)
752 && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
754 part = ON_MODE_LINE;
756 header_vertical_border_check:
757 /* We're somewhere on the mode line. We consider the place
758 between mode lines of horizontally adjacent mode lines
759 as the vertical border. If scroll bars on the left,
760 return the right window. */
761 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
762 || WINDOW_RIGHTMOST_P (w))
764 if (!WINDOW_LEFTMOST_P (w) && eabs (*x - x0) < grabbable_width)
766 /* Convert X and Y to window relative coordinates.
767 Vertical border is at the left edge of window. */
768 *x = max (0, *x - x0);
769 *y -= top_y;
770 return ON_VERTICAL_BORDER;
773 else
775 if (eabs (*x - x1) < grabbable_width)
777 /* Convert X and Y to window relative coordinates.
778 Vertical border is at the right edge of window. */
779 *x = min (x1, *x) - x0;
780 *y -= top_y;
781 return ON_VERTICAL_BORDER;
785 if (*x < x0 || *x >= x1)
786 return ON_NOTHING;
788 /* Convert X and Y to window relative coordinates.
789 Mode line starts at left edge of window. */
790 *x -= x0;
791 *y -= top_y;
792 return part;
795 if (WINDOW_WANTS_HEADER_LINE_P (w)
796 && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
798 part = ON_HEADER_LINE;
799 goto header_vertical_border_check;
802 if (*x < x0 || *x >= x1)
803 return ON_NOTHING;
805 /* Outside any interesting column? */
806 if (*x < left_x || *x > right_x)
808 *y -= top_y;
809 return ON_SCROLL_BAR;
812 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
813 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
815 text_left = window_box_left (w, TEXT_AREA);
816 text_right = text_left + window_box_width (w, TEXT_AREA);
818 if (FRAME_WINDOW_P (f))
820 if (!w->pseudo_window_p
821 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
822 && !WINDOW_RIGHTMOST_P (w)
823 && (eabs (*x - right_x) < grabbable_width))
825 /* Convert X and Y to window relative coordinates.
826 Vertical border is at the right edge of window. */
827 *x = min (right_x, *x) - left_x;
828 *y -= top_y;
829 return ON_VERTICAL_BORDER;
832 else
834 /* Need to say "*x > right_x" rather than >=, since on character
835 terminals, the vertical line's x coordinate is right_x. */
836 if (!w->pseudo_window_p
837 && !WINDOW_RIGHTMOST_P (w)
838 && *x > right_x - ux)
840 /* On the border on the right side of the window? Assume that
841 this area begins at RIGHT_X minus a canonical char width. */
842 *x = min (right_x, *x) - left_x;
843 *y -= top_y;
844 return ON_VERTICAL_BORDER;
848 if (*x < text_left)
850 if (lmargin_width > 0
851 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
852 ? (*x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
853 : (*x < left_x + lmargin_width)))
855 *x -= left_x;
856 if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
857 *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
858 *y -= top_y;
859 return ON_LEFT_MARGIN;
862 /* Convert X and Y to window-relative pixel coordinates. */
863 *x -= left_x;
864 *y -= top_y;
865 return ON_LEFT_FRINGE;
868 if (*x >= text_right)
870 if (rmargin_width > 0
871 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
872 ? (*x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
873 : (*x >= right_x - rmargin_width)))
875 *x -= right_x - rmargin_width;
876 if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
877 *x += WINDOW_RIGHT_FRINGE_WIDTH (w);
878 *y -= top_y;
879 return ON_RIGHT_MARGIN;
882 /* Convert X and Y to window-relative pixel coordinates. */
883 *x -= left_x + WINDOW_LEFT_FRINGE_WIDTH (w);
884 *y -= top_y;
885 return ON_RIGHT_FRINGE;
888 /* Everything special ruled out - must be on text area */
889 *x -= text_left;
890 *y -= top_y;
891 return ON_TEXT;
895 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
896 Scoordinates_in_window_p, 2, 2, 0,
897 doc: /* Return non-nil if COORDINATES are in WINDOW.
898 COORDINATES is a cons of the form (X . Y), X and Y being distances
899 measured in characters from the upper-left corner of the frame.
900 \(0 . 0) denotes the character in the upper left corner of the
901 frame.
902 If COORDINATES are in the text portion of WINDOW,
903 the coordinates relative to the window are returned.
904 If they are in the mode line of WINDOW, `mode-line' is returned.
905 If they are in the top mode line of WINDOW, `header-line' is returned.
906 If they are in the left fringe of WINDOW, `left-fringe' is returned.
907 If they are in the right fringe of WINDOW, `right-fringe' is returned.
908 If they are on the border between WINDOW and its right sibling,
909 `vertical-line' is returned.
910 If they are in the windows's left or right marginal areas, `left-margin'\n\
911 or `right-margin' is returned. */)
912 (coordinates, window)
913 register Lisp_Object coordinates, window;
915 struct window *w;
916 struct frame *f;
917 int x, y;
918 Lisp_Object lx, ly;
920 CHECK_WINDOW (window);
921 w = XWINDOW (window);
922 f = XFRAME (w->frame);
923 CHECK_CONS (coordinates);
924 lx = Fcar (coordinates);
925 ly = Fcdr (coordinates);
926 CHECK_NUMBER_OR_FLOAT (lx);
927 CHECK_NUMBER_OR_FLOAT (ly);
928 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
929 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
931 switch (coordinates_in_window (w, &x, &y))
933 case ON_NOTHING:
934 return Qnil;
936 case ON_TEXT:
937 /* X and Y are now window relative pixel coordinates. Convert
938 them to canonical char units before returning them. */
939 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
940 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
942 case ON_MODE_LINE:
943 return Qmode_line;
945 case ON_VERTICAL_BORDER:
946 return Qvertical_line;
948 case ON_HEADER_LINE:
949 return Qheader_line;
951 case ON_LEFT_FRINGE:
952 return Qleft_fringe;
954 case ON_RIGHT_FRINGE:
955 return Qright_fringe;
957 case ON_LEFT_MARGIN:
958 return Qleft_margin;
960 case ON_RIGHT_MARGIN:
961 return Qright_margin;
963 case ON_SCROLL_BAR:
964 /* Historically we are supposed to return nil in this case. */
965 return Qnil;
967 default:
968 abort ();
973 /* Callback for foreach_window, used in window_from_coordinates.
974 Check if window W contains coordinates specified by USER_DATA which
975 is actually a pointer to a struct check_window_data CW.
977 Check if window W contains coordinates *CW->x and *CW->y. If it
978 does, return W in *CW->window, as Lisp_Object, and return in
979 *CW->part the part of the window under coordinates *X,*Y. Return
980 zero from this function to stop iterating over windows. */
982 struct check_window_data
984 Lisp_Object *window;
985 int *x, *y;
986 enum window_part *part;
989 static int
990 check_window_containing (w, user_data)
991 struct window *w;
992 void *user_data;
994 struct check_window_data *cw = (struct check_window_data *) user_data;
995 enum window_part found;
996 int continue_p = 1;
998 found = coordinates_in_window (w, cw->x, cw->y);
999 if (found != ON_NOTHING)
1001 *cw->part = found;
1002 XSETWINDOW (*cw->window, w);
1003 continue_p = 0;
1006 return continue_p;
1010 /* Find the window containing frame-relative pixel position X/Y and
1011 return it as a Lisp_Object.
1013 If X, Y is on one of the window's special `window_part' elements,
1014 set *PART to the id of that element, and return X and Y converted
1015 to window relative coordinates in WX and WY.
1017 If there is no window under X, Y return nil and leave *PART
1018 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1020 This function was previously implemented with a loop cycling over
1021 windows with Fnext_window, and starting with the frame's selected
1022 window. It turned out that this doesn't work with an
1023 implementation of next_window using Vwindow_list, because
1024 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1025 tree of F when this function is called asynchronously from
1026 note_mouse_highlight. The original loop didn't terminate in this
1027 case. */
1029 Lisp_Object
1030 window_from_coordinates (f, x, y, part, wx, wy, tool_bar_p)
1031 struct frame *f;
1032 int x, y;
1033 enum window_part *part;
1034 int *wx, *wy;
1035 int tool_bar_p;
1037 Lisp_Object window;
1038 struct check_window_data cw;
1039 enum window_part dummy;
1041 if (part == 0)
1042 part = &dummy;
1044 window = Qnil;
1045 cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
1046 foreach_window (f, check_window_containing, &cw);
1048 /* If not found above, see if it's in the tool bar window, if a tool
1049 bar exists. */
1050 if (NILP (window)
1051 && tool_bar_p
1052 && WINDOWP (f->tool_bar_window)
1053 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1054 && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
1055 != ON_NOTHING))
1057 *part = ON_TEXT;
1058 window = f->tool_bar_window;
1061 if (wx) *wx = x;
1062 if (wy) *wy = y;
1064 return window;
1067 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1068 doc: /* Return window containing coordinates X and Y on FRAME.
1069 If omitted, FRAME defaults to the currently selected frame.
1070 The top left corner of the frame is considered to be row 0,
1071 column 0. */)
1072 (x, y, frame)
1073 Lisp_Object x, y, frame;
1075 struct frame *f;
1077 if (NILP (frame))
1078 frame = selected_frame;
1079 CHECK_LIVE_FRAME (frame);
1080 f = XFRAME (frame);
1082 /* Check that arguments are integers or floats. */
1083 CHECK_NUMBER_OR_FLOAT (x);
1084 CHECK_NUMBER_OR_FLOAT (y);
1086 return window_from_coordinates (f,
1087 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1088 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1089 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1090 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1091 0, 0, 0, 0);
1094 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1095 doc: /* Return current value of point in WINDOW.
1096 WINDOW defaults to the selected window.
1098 For a nonselected window, this is the value point would have
1099 if that window were selected.
1101 Note that, when WINDOW is the selected window and its buffer
1102 is also currently selected, the value returned is the same as (point).
1103 It would be more strictly correct to return the `top-level' value
1104 of point, outside of any save-excursion forms.
1105 But that is hard to define. */)
1106 (window)
1107 Lisp_Object window;
1109 register struct window *w = decode_window (window);
1111 if (w == XWINDOW (selected_window)
1112 && current_buffer == XBUFFER (w->buffer))
1113 return Fpoint ();
1114 return Fmarker_position (w->pointm);
1117 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1118 doc: /* Return position at which display currently starts in WINDOW.
1119 WINDOW defaults to the selected window.
1120 This is updated by redisplay or by calling `set-window-start'. */)
1121 (window)
1122 Lisp_Object window;
1124 return Fmarker_position (decode_window (window)->start);
1127 /* This is text temporarily removed from the doc string below.
1129 This function returns nil if the position is not currently known.
1130 That happens when redisplay is preempted and doesn't finish.
1131 If in that case you want to compute where the end of the window would
1132 have been if redisplay had finished, do this:
1133 (save-excursion
1134 (goto-char (window-start window))
1135 (vertical-motion (1- (window-height window)) window)
1136 (point))") */
1138 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1139 doc: /* Return position at which display currently ends in WINDOW.
1140 WINDOW defaults to the selected window.
1141 This is updated by redisplay, when it runs to completion.
1142 Simply changing the buffer text or setting `window-start'
1143 does not update this value.
1144 Return nil if there is no recorded value. \(This can happen if the
1145 last redisplay of WINDOW was preempted, and did not finish.)
1146 If UPDATE is non-nil, compute the up-to-date position
1147 if it isn't already recorded. */)
1148 (window, update)
1149 Lisp_Object window, update;
1151 Lisp_Object value;
1152 struct window *w = decode_window (window);
1153 Lisp_Object buf;
1154 struct buffer *b;
1156 buf = w->buffer;
1157 CHECK_BUFFER (buf);
1158 b = XBUFFER (buf);
1160 #if 0 /* This change broke some things. We should make it later. */
1161 /* If we don't know the end position, return nil.
1162 The user can compute it with vertical-motion if he wants to.
1163 It would be nicer to do it automatically,
1164 but that's so slow that it would probably bother people. */
1165 if (NILP (w->window_end_valid))
1166 return Qnil;
1167 #endif
1169 if (! NILP (update)
1170 && ! (! NILP (w->window_end_valid)
1171 && XFASTINT (w->last_modified) >= BUF_MODIFF (b)
1172 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (b))
1173 && !noninteractive)
1175 struct text_pos startp;
1176 struct it it;
1177 struct buffer *old_buffer = NULL;
1179 /* Cannot use Fvertical_motion because that function doesn't
1180 cope with variable-height lines. */
1181 if (b != current_buffer)
1183 old_buffer = current_buffer;
1184 set_buffer_internal (b);
1187 /* In case W->start is out of the range, use something
1188 reasonable. This situation occurred when loading a file with
1189 `-l' containing a call to `rmail' with subsequent other
1190 commands. At the end, W->start happened to be BEG, while
1191 rmail had already narrowed the buffer. */
1192 if (XMARKER (w->start)->charpos < BEGV)
1193 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1194 else if (XMARKER (w->start)->charpos > ZV)
1195 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1196 else
1197 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1199 start_display (&it, w, startp);
1200 move_it_vertically (&it, window_box_height (w));
1201 if (it.current_y < it.last_visible_y)
1202 move_it_past_eol (&it);
1203 value = make_number (IT_CHARPOS (it));
1205 if (old_buffer)
1206 set_buffer_internal (old_buffer);
1208 else
1209 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1211 return value;
1214 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1215 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1216 Return POS. */)
1217 (window, pos)
1218 Lisp_Object window, pos;
1220 register struct window *w = decode_window (window);
1222 CHECK_NUMBER_COERCE_MARKER (pos);
1223 if (w == XWINDOW (selected_window)
1224 && XBUFFER (w->buffer) == current_buffer)
1225 Fgoto_char (pos);
1226 else
1227 set_marker_restricted (w->pointm, pos, w->buffer);
1229 /* We have to make sure that redisplay updates the window to show
1230 the new value of point. */
1231 if (!EQ (window, selected_window))
1232 ++windows_or_buffers_changed;
1234 return pos;
1237 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1238 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1239 WINDOW defaults to the selected window. Return POS.
1240 Optional third arg NOFORCE non-nil inhibits next redisplay from
1241 overriding motion of point in order to display at this exact start. */)
1242 (window, pos, noforce)
1243 Lisp_Object window, pos, noforce;
1245 register struct window *w = decode_window (window);
1247 CHECK_NUMBER_COERCE_MARKER (pos);
1248 set_marker_restricted (w->start, pos, w->buffer);
1249 /* this is not right, but much easier than doing what is right. */
1250 w->start_at_line_beg = Qnil;
1251 if (NILP (noforce))
1252 w->force_start = Qt;
1253 w->update_mode_line = Qt;
1254 XSETFASTINT (w->last_modified, 0);
1255 XSETFASTINT (w->last_overlay_modified, 0);
1256 if (!EQ (window, selected_window))
1257 windows_or_buffers_changed++;
1259 return pos;
1263 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1264 0, 1, 0,
1265 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1266 WINDOW defaults to the selected window.
1268 When a window is dedicated to its buffer, `display-buffer' and
1269 `set-window-buffer' will refrain from displaying another buffer in it.
1270 `get-lru-window' and `get-largest-window' treat dedicated windows
1271 specially. `delete-windows-on', `replace-buffer-in-windows' and
1272 `kill-buffer' can delete a dedicated window and the containing frame. */)
1273 (window)
1274 Lisp_Object window;
1276 return decode_window (window)->dedicated;
1279 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1280 Sset_window_dedicated_p, 2, 2, 0,
1281 doc: /* Mark WINDOW as dedicated according to FLAG.
1282 WINDOW defaults to the selected window. FLAG non-nil means mark WINDOW
1283 as dedicated to its buffer. FLAG nil means mark WINDOW as nondedicated.
1284 Return FLAG.
1286 When a window is dedicated to its buffer, `display-buffer' and
1287 `set-window-buffer' will refrain from displaying another buffer in it.
1288 `get-lru-window' and `get-largest-window' treat dedicated windows
1289 specially. `delete-windows-on', `replace-buffer-in-windows' and
1290 `kill-buffer' can delete a dedicated window and the containing frame. */)
1291 (window, flag)
1292 Lisp_Object window, flag;
1294 register struct window *w = decode_window (window);
1296 w->dedicated = flag;
1297 return w->dedicated;
1301 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1302 0, 1, 0,
1303 doc: /* Return the parameters of WINDOW and their values.
1304 WINDOW defaults to the selected window. The return value is a list of
1305 elements of the form (PARAMETER . VALUE). */)
1306 (window)
1307 Lisp_Object window;
1309 return Fcopy_alist (decode_window (window)->window_parameters);
1312 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1313 2, 2, 0,
1314 doc: /* Return WINDOW's value for PARAMETER.
1315 WINDOW defaults to the selected window. */)
1316 (window, parameter)
1317 Lisp_Object window, parameter;
1319 Lisp_Object result;
1321 result = Fassq (parameter, decode_window (window)->window_parameters);
1322 return CDR_SAFE (result);
1325 DEFUN ("set-window-parameter", Fset_window_parameter,
1326 Sset_window_parameter, 3, 3, 0,
1327 doc: /* Set WINDOW's value of PARAMETER to VALUE.
1328 WINDOW defaults to the selected window. Return VALUE. */)
1329 (window, parameter, value)
1330 Lisp_Object window, parameter, value;
1332 register struct window *w = decode_window (window);
1333 Lisp_Object old_alist_elt;
1335 old_alist_elt = Fassq (parameter, w->window_parameters);
1336 if (EQ (old_alist_elt, Qnil))
1337 w->window_parameters = Fcons (Fcons (parameter, value), w->window_parameters);
1338 else
1339 Fsetcdr (old_alist_elt, value);
1340 return value;
1344 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1345 0, 1, 0,
1346 doc: /* Return the display-table that WINDOW is using.
1347 WINDOW defaults to the selected window. */)
1348 (window)
1349 Lisp_Object window;
1351 return decode_window (window)->display_table;
1354 /* Get the display table for use on window W. This is either W's
1355 display table or W's buffer's display table. Ignore the specified
1356 tables if they are not valid; if no valid table is specified,
1357 return 0. */
1359 struct Lisp_Char_Table *
1360 window_display_table (w)
1361 struct window *w;
1363 struct Lisp_Char_Table *dp = NULL;
1365 if (DISP_TABLE_P (w->display_table))
1366 dp = XCHAR_TABLE (w->display_table);
1367 else if (BUFFERP (w->buffer))
1369 struct buffer *b = XBUFFER (w->buffer);
1371 if (DISP_TABLE_P (b->display_table))
1372 dp = XCHAR_TABLE (b->display_table);
1373 else if (DISP_TABLE_P (Vstandard_display_table))
1374 dp = XCHAR_TABLE (Vstandard_display_table);
1377 return dp;
1380 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1381 doc: /* Set WINDOW's display-table to TABLE. */)
1382 (window, table)
1383 register Lisp_Object window, table;
1385 register struct window *w;
1387 w = decode_window (window);
1388 w->display_table = table;
1389 return table;
1392 /* Record info on buffer window w is displaying
1393 when it is about to cease to display that buffer. */
1394 static void
1395 unshow_buffer (w)
1396 register struct window *w;
1398 Lisp_Object buf;
1399 struct buffer *b;
1401 buf = w->buffer;
1402 b = XBUFFER (buf);
1403 if (b != XMARKER (w->pointm)->buffer)
1404 abort ();
1406 #if 0
1407 if (w == XWINDOW (selected_window)
1408 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1409 /* Do this except when the selected window's buffer
1410 is being removed from some other window. */
1411 #endif
1412 /* last_window_start records the start position that this buffer
1413 had in the last window to be disconnected from it.
1414 Now that this statement is unconditional,
1415 it is possible for the buffer to be displayed in the
1416 selected window, while last_window_start reflects another
1417 window which was recently showing the same buffer.
1418 Some people might say that might be a good thing. Let's see. */
1419 b->last_window_start = marker_position (w->start);
1421 /* Point in the selected window's buffer
1422 is actually stored in that buffer, and the window's pointm isn't used.
1423 So don't clobber point in that buffer. */
1424 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1425 /* This line helps to fix Horsley's testbug.el bug. */
1426 && !(WINDOWP (b->last_selected_window)
1427 && w != XWINDOW (b->last_selected_window)
1428 && EQ (buf, XWINDOW (b->last_selected_window)->buffer)))
1429 temp_set_point_both (b,
1430 clip_to_bounds (BUF_BEGV (b),
1431 XMARKER (w->pointm)->charpos,
1432 BUF_ZV (b)),
1433 clip_to_bounds (BUF_BEGV_BYTE (b),
1434 marker_byte_position (w->pointm),
1435 BUF_ZV_BYTE (b)));
1437 if (WINDOWP (b->last_selected_window)
1438 && w == XWINDOW (b->last_selected_window))
1439 b->last_selected_window = Qnil;
1442 /* Put replacement into the window structure in place of old. */
1443 static void
1444 replace_window (old, replacement)
1445 Lisp_Object old, replacement;
1447 register Lisp_Object tem;
1448 register struct window *o = XWINDOW (old), *p = XWINDOW (replacement);
1450 /* If OLD is its frame's root_window, then replacement is the new
1451 root_window for that frame. */
1453 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1454 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
1456 p->left_col = o->left_col;
1457 p->top_line = o->top_line;
1458 p->total_cols = o->total_cols;
1459 p->total_lines = o->total_lines;
1460 p->desired_matrix = p->current_matrix = 0;
1461 p->vscroll = 0;
1462 bzero (&p->cursor, sizeof (p->cursor));
1463 bzero (&p->last_cursor, sizeof (p->last_cursor));
1464 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
1465 p->phys_cursor_type = -1;
1466 p->phys_cursor_width = -1;
1467 p->must_be_updated_p = 0;
1468 p->pseudo_window_p = 0;
1469 XSETFASTINT (p->window_end_vpos, 0);
1470 XSETFASTINT (p->window_end_pos, 0);
1471 p->window_end_valid = Qnil;
1472 p->frozen_window_start_p = 0;
1473 p->orig_top_line = p->orig_total_lines = Qnil;
1475 p->next = tem = o->next;
1476 if (!NILP (tem))
1477 XWINDOW (tem)->prev = replacement;
1479 p->prev = tem = o->prev;
1480 if (!NILP (tem))
1481 XWINDOW (tem)->next = replacement;
1483 p->parent = tem = o->parent;
1484 if (!NILP (tem))
1486 if (EQ (XWINDOW (tem)->vchild, old))
1487 XWINDOW (tem)->vchild = replacement;
1488 if (EQ (XWINDOW (tem)->hchild, old))
1489 XWINDOW (tem)->hchild = replacement;
1492 /*** Here, if replacement is a vertical combination
1493 and so is its new parent, we should make replacement's
1494 children be children of that parent instead. ***/
1497 DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
1498 doc: /* Remove WINDOW from the display. Default is selected window. */)
1499 (window)
1500 register Lisp_Object window;
1502 struct frame *f;
1503 if (NILP (window))
1504 window = selected_window;
1505 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1506 delete_window (window);
1508 run_window_configuration_change_hook (f);
1510 return Qnil;
1513 void
1514 delete_window (window)
1515 register Lisp_Object window;
1517 register Lisp_Object tem, parent, sib;
1518 register struct window *p;
1519 register struct window *par;
1520 struct frame *f;
1522 /* Because this function is called by other C code on non-leaf
1523 windows, the CHECK_LIVE_WINDOW macro would choke inappropriately,
1524 so we can't decode_window here. */
1525 CHECK_WINDOW (window);
1526 p = XWINDOW (window);
1528 /* It's a no-op to delete an already-deleted window. */
1529 if (NILP (p->buffer)
1530 && NILP (p->hchild)
1531 && NILP (p->vchild))
1532 return;
1534 parent = p->parent;
1535 if (NILP (parent))
1536 error ("Attempt to delete minibuffer or sole ordinary window");
1537 par = XWINDOW (parent);
1539 windows_or_buffers_changed++;
1540 Vwindow_list = Qnil;
1541 f = XFRAME (WINDOW_FRAME (p));
1542 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
1544 /* Are we trying to delete any frame's selected window? */
1546 Lisp_Object swindow, pwindow;
1548 /* See if the frame's selected window is either WINDOW
1549 or any subwindow of it, by finding all that window's parents
1550 and comparing each one with WINDOW. */
1551 swindow = FRAME_SELECTED_WINDOW (f);
1553 while (1)
1555 pwindow = swindow;
1556 while (!NILP (pwindow))
1558 if (EQ (window, pwindow))
1559 break;
1560 pwindow = XWINDOW (pwindow)->parent;
1563 /* If the window being deleted is not a parent of SWINDOW,
1564 then SWINDOW is ok as the new selected window. */
1565 if (!EQ (window, pwindow))
1566 break;
1567 /* Otherwise, try another window for SWINDOW. */
1568 swindow = Fnext_window (swindow, Qlambda, Qnil);
1570 /* If we get back to the frame's selected window,
1571 it means there was no acceptable alternative,
1572 so we cannot delete. */
1573 if (EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1574 error ("Cannot delete window");
1577 /* If we need to change SWINDOW, do it. */
1578 if (! EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1580 /* If we're about to delete the selected window on the
1581 selected frame, then we should use Fselect_window to select
1582 the new window. On the other hand, if we're about to
1583 delete the selected window on any other frame, we shouldn't do
1584 anything but set the frame's selected_window slot. */
1585 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
1586 Fselect_window (swindow, Qnil);
1587 else
1588 FRAME_SELECTED_WINDOW (f) = swindow;
1592 /* Now we know we can delete this one. */
1593 window_deletion_count++;
1595 tem = p->buffer;
1596 /* tem is null for dummy parent windows
1597 (which have inferiors but not any contents themselves) */
1598 if (!NILP (tem))
1600 unshow_buffer (p);
1601 unchain_marker (XMARKER (p->pointm));
1602 unchain_marker (XMARKER (p->start));
1605 /* Free window glyph matrices. It is sure that they are allocated
1606 again when ADJUST_GLYPHS is called. Block input so that expose
1607 events and other events that access glyph matrices are not
1608 processed while we are changing them. */
1609 BLOCK_INPUT;
1610 free_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)));
1612 tem = p->next;
1613 if (!NILP (tem))
1614 XWINDOW (tem)->prev = p->prev;
1616 tem = p->prev;
1617 if (!NILP (tem))
1618 XWINDOW (tem)->next = p->next;
1620 if (EQ (window, par->hchild))
1621 par->hchild = p->next;
1622 if (EQ (window, par->vchild))
1623 par->vchild = p->next;
1625 /* Find one of our siblings to give our space to. */
1626 sib = p->prev;
1627 if (NILP (sib))
1629 /* If p gives its space to its next sibling, that sibling needs
1630 to have its top/left side pulled back to where p's is.
1631 set_window_{height,width} will re-position the sibling's
1632 children. */
1633 sib = p->next;
1634 XWINDOW (sib)->top_line = p->top_line;
1635 XWINDOW (sib)->left_col = p->left_col;
1638 /* Stretch that sibling. */
1639 if (!NILP (par->vchild))
1640 set_window_height (sib,
1641 XFASTINT (XWINDOW (sib)->total_lines) + XFASTINT (p->total_lines),
1643 if (!NILP (par->hchild))
1644 set_window_width (sib,
1645 XFASTINT (XWINDOW (sib)->total_cols) + XFASTINT (p->total_cols),
1648 /* If parent now has only one child,
1649 put the child into the parent's place. */
1650 tem = par->hchild;
1651 if (NILP (tem))
1652 tem = par->vchild;
1653 if (NILP (XWINDOW (tem)->next)) {
1654 replace_window (parent, tem);
1655 par = XWINDOW (tem);
1658 /* Since we may be deleting combination windows, we must make sure that
1659 not only p but all its children have been marked as deleted. */
1660 if (! NILP (p->hchild))
1661 delete_all_subwindows (XWINDOW (p->hchild));
1662 else if (! NILP (p->vchild))
1663 delete_all_subwindows (XWINDOW (p->vchild));
1665 /* Mark this window as deleted. */
1666 p->buffer = p->hchild = p->vchild = Qnil;
1668 if (! NILP (par->parent))
1669 par = XWINDOW (par->parent);
1671 /* Check if we have a v/hchild with a v/hchild. In that case remove
1672 one of them. */
1674 if (! NILP (par->vchild) && ! NILP (XWINDOW (par->vchild)->vchild))
1676 p = XWINDOW (par->vchild);
1677 par->vchild = p->vchild;
1678 tem = p->vchild;
1680 else if (! NILP (par->hchild) && ! NILP (XWINDOW (par->hchild)->hchild))
1682 p = XWINDOW (par->hchild);
1683 par->hchild = p->hchild;
1684 tem = p->hchild;
1686 else
1687 p = 0;
1689 if (p)
1691 while (! NILP (tem)) {
1692 XWINDOW (tem)->parent = p->parent;
1693 if (NILP (XWINDOW (tem)->next))
1694 break;
1695 tem = XWINDOW (tem)->next;
1697 if (! NILP (tem)) {
1698 /* The next of the v/hchild we are removing is now the next of the
1699 last child for the v/hchild:
1700 Before v/hchild -> v/hchild -> next1 -> next2
1702 -> next3
1703 After: v/hchild -> next1 -> next2 -> next3
1705 XWINDOW (tem)->next = p->next;
1706 if (! NILP (p->next))
1707 XWINDOW (p->next)->prev = tem;
1709 p->next = p->prev = p->vchild = p->hchild = p->buffer = Qnil;
1713 /* Adjust glyph matrices. */
1714 adjust_glyphs (f);
1715 UNBLOCK_INPUT;
1720 /***********************************************************************
1721 Window List
1722 ***********************************************************************/
1724 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1725 pointer. This is a callback function for foreach_window, used in
1726 function window_list. */
1728 static int
1729 add_window_to_list (w, user_data)
1730 struct window *w;
1731 void *user_data;
1733 Lisp_Object *list = (Lisp_Object *) user_data;
1734 Lisp_Object window;
1735 XSETWINDOW (window, w);
1736 *list = Fcons (window, *list);
1737 return 1;
1741 /* Return a list of all windows, for use by next_window. If
1742 Vwindow_list is a list, return that list. Otherwise, build a new
1743 list, cache it in Vwindow_list, and return that. */
1745 static Lisp_Object
1746 window_list ()
1748 if (!CONSP (Vwindow_list))
1750 Lisp_Object tail;
1752 Vwindow_list = Qnil;
1753 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1755 Lisp_Object args[2];
1757 /* We are visiting windows in canonical order, and add
1758 new windows at the front of args[1], which means we
1759 have to reverse this list at the end. */
1760 args[1] = Qnil;
1761 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1762 args[0] = Vwindow_list;
1763 args[1] = Fnreverse (args[1]);
1764 Vwindow_list = Fnconc (2, args);
1768 return Vwindow_list;
1772 /* Value is non-zero if WINDOW satisfies the constraints given by
1773 OWINDOW, MINIBUF and ALL_FRAMES.
1775 MINIBUF t means WINDOW may be minibuffer windows.
1776 `lambda' means WINDOW may not be a minibuffer window.
1777 a window means a specific minibuffer window
1779 ALL_FRAMES t means search all frames,
1780 nil means search just current frame,
1781 `visible' means search just visible frames,
1782 0 means search visible and iconified frames,
1783 a window means search the frame that window belongs to,
1784 a frame means consider windows on that frame, only. */
1786 static int
1787 candidate_window_p (window, owindow, minibuf, all_frames)
1788 Lisp_Object window, owindow, minibuf, all_frames;
1790 struct window *w = XWINDOW (window);
1791 struct frame *f = XFRAME (w->frame);
1792 int candidate_p = 1;
1794 if (!BUFFERP (w->buffer))
1795 candidate_p = 0;
1796 else if (MINI_WINDOW_P (w)
1797 && (EQ (minibuf, Qlambda)
1798 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
1800 /* If MINIBUF is `lambda' don't consider any mini-windows.
1801 If it is a window, consider only that one. */
1802 candidate_p = 0;
1804 else if (EQ (all_frames, Qt))
1805 candidate_p = 1;
1806 else if (NILP (all_frames))
1808 xassert (WINDOWP (owindow));
1809 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
1811 else if (EQ (all_frames, Qvisible))
1813 FRAME_SAMPLE_VISIBILITY (f);
1814 candidate_p = FRAME_VISIBLE_P (f)
1815 && (FRAME_TERMINAL (XFRAME (w->frame))
1816 == FRAME_TERMINAL (XFRAME (selected_frame)));
1819 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
1821 FRAME_SAMPLE_VISIBILITY (f);
1822 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
1823 #ifdef HAVE_X_WINDOWS
1824 /* Yuck!! If we've just created the frame and the
1825 window-manager requested the user to place it
1826 manually, the window may still not be considered
1827 `visible'. I'd argue it should be at least
1828 something like `iconified', but don't know how to do
1829 that yet. --Stef */
1830 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
1831 && !f->output_data.x->has_been_visible)
1832 #endif
1834 && (FRAME_TERMINAL (XFRAME (w->frame))
1835 == FRAME_TERMINAL (XFRAME (selected_frame)));
1837 else if (WINDOWP (all_frames))
1838 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
1839 || EQ (XWINDOW (all_frames)->frame, w->frame)
1840 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
1841 else if (FRAMEP (all_frames))
1842 candidate_p = EQ (all_frames, w->frame);
1844 return candidate_p;
1848 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
1849 Fwindow_list. See there for the meaning of WINDOW, MINIBUF, and
1850 ALL_FRAMES. */
1852 static void
1853 decode_next_window_args (window, minibuf, all_frames)
1854 Lisp_Object *window, *minibuf, *all_frames;
1856 if (NILP (*window))
1857 *window = selected_window;
1858 else
1859 CHECK_LIVE_WINDOW (*window);
1861 /* MINIBUF nil may or may not include minibuffers. Decide if it
1862 does. */
1863 if (NILP (*minibuf))
1864 *minibuf = minibuf_level ? minibuf_window : Qlambda;
1865 else if (!EQ (*minibuf, Qt))
1866 *minibuf = Qlambda;
1868 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
1869 => count none of them, or a specific minibuffer window (the
1870 active one) to count. */
1872 /* ALL_FRAMES nil doesn't specify which frames to include. */
1873 if (NILP (*all_frames))
1874 *all_frames = (!EQ (*minibuf, Qlambda)
1875 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
1876 : Qnil);
1877 else if (EQ (*all_frames, Qvisible))
1879 else if (EQ (*all_frames, make_number (0)))
1881 else if (FRAMEP (*all_frames))
1883 else if (!EQ (*all_frames, Qt))
1884 *all_frames = Qnil;
1886 /* Now *ALL_FRAMES is t meaning search all frames, nil meaning
1887 search just current frame, `visible' meaning search just visible
1888 frames, 0 meaning search visible and iconified frames, or a
1889 window, meaning search the frame that window belongs to, or a
1890 frame, meaning consider windows on that frame, only. */
1894 /* Return the next or previous window of WINDOW in canonical ordering
1895 of windows. NEXT_P non-zero means return the next window. See the
1896 documentation string of next-window for the meaning of MINIBUF and
1897 ALL_FRAMES. */
1899 static Lisp_Object
1900 next_window (window, minibuf, all_frames, next_p)
1901 Lisp_Object window, minibuf, all_frames;
1902 int next_p;
1904 decode_next_window_args (&window, &minibuf, &all_frames);
1906 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
1907 return the first window on the frame. */
1908 if (FRAMEP (all_frames)
1909 && !EQ (all_frames, XWINDOW (window)->frame))
1910 return Fframe_first_window (all_frames);
1912 if (next_p)
1914 Lisp_Object list;
1916 /* Find WINDOW in the list of all windows. */
1917 list = Fmemq (window, window_list ());
1919 /* Scan forward from WINDOW to the end of the window list. */
1920 if (CONSP (list))
1921 for (list = XCDR (list); CONSP (list); list = XCDR (list))
1922 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1923 break;
1925 /* Scan from the start of the window list up to WINDOW. */
1926 if (!CONSP (list))
1927 for (list = Vwindow_list;
1928 CONSP (list) && !EQ (XCAR (list), window);
1929 list = XCDR (list))
1930 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1931 break;
1933 if (CONSP (list))
1934 window = XCAR (list);
1936 else
1938 Lisp_Object candidate, list;
1940 /* Scan through the list of windows for candidates. If there are
1941 candidate windows in front of WINDOW, the last one of these
1942 is the one we want. If there are candidates following WINDOW
1943 in the list, again the last one of these is the one we want. */
1944 candidate = Qnil;
1945 for (list = window_list (); CONSP (list); list = XCDR (list))
1947 if (EQ (XCAR (list), window))
1949 if (WINDOWP (candidate))
1950 break;
1952 else if (candidate_window_p (XCAR (list), window, minibuf,
1953 all_frames))
1954 candidate = XCAR (list);
1957 if (WINDOWP (candidate))
1958 window = candidate;
1961 return window;
1965 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
1966 doc: /* Return next window after WINDOW in canonical ordering of windows.
1967 If omitted, WINDOW defaults to the selected window.
1969 Optional second arg MINIBUF t means count the minibuffer window even
1970 if not active. MINIBUF nil or omitted means count the minibuffer iff
1971 it is active. MINIBUF neither t nor nil means not to count the
1972 minibuffer even if it is active.
1974 Several frames may share a single minibuffer; if the minibuffer
1975 counts, all windows on all frames that share that minibuffer count
1976 too. Therefore, `next-window' can be used to iterate through the
1977 set of windows even when the minibuffer is on another frame. If the
1978 minibuffer does not count, only windows from WINDOW's frame count.
1980 Optional third arg ALL-FRAMES t means include windows on all frames.
1981 ALL-FRAMES nil or omitted means cycle within the frames as specified
1982 above. ALL-FRAMES = `visible' means include windows on all visible frames.
1983 ALL-FRAMES = 0 means include windows on all visible and iconified frames.
1984 If ALL-FRAMES is a frame, restrict search to windows on that frame.
1985 Anything else means restrict to WINDOW's frame.
1987 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
1988 `next-window' to iterate through the entire cycle of acceptable
1989 windows, eventually ending up back at the window you started with.
1990 `previous-window' traverses the same cycle, in the reverse order. */)
1991 (window, minibuf, all_frames)
1992 Lisp_Object window, minibuf, all_frames;
1994 return next_window (window, minibuf, all_frames, 1);
1998 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
1999 doc: /* Return the window preceding WINDOW in canonical ordering of windows.
2000 If omitted, WINDOW defaults to the selected window.
2002 Optional second arg MINIBUF t means count the minibuffer window even
2003 if not active. MINIBUF nil or omitted means count the minibuffer iff
2004 it is active. MINIBUF neither t nor nil means not to count the
2005 minibuffer even if it is active.
2007 Several frames may share a single minibuffer; if the minibuffer
2008 counts, all windows on all frames that share that minibuffer count
2009 too. Therefore, `previous-window' can be used to iterate through
2010 the set of windows even when the minibuffer is on another frame. If
2011 the minibuffer does not count, only windows from WINDOW's frame count
2013 Optional third arg ALL-FRAMES t means include windows on all frames.
2014 ALL-FRAMES nil or omitted means cycle within the frames as specified
2015 above. ALL-FRAMES = `visible' means include windows on all visible frames.
2016 ALL-FRAMES = 0 means include windows on all visible and iconified frames.
2017 If ALL-FRAMES is a frame, restrict search to windows on that frame.
2018 Anything else means restrict to WINDOW's frame.
2020 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2021 `previous-window' to iterate through the entire cycle of acceptable
2022 windows, eventually ending up back at the window you started with.
2023 `next-window' traverses the same cycle, in the reverse order. */)
2024 (window, minibuf, all_frames)
2025 Lisp_Object window, minibuf, all_frames;
2027 return next_window (window, minibuf, all_frames, 0);
2031 DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
2032 doc: /* Select the ARG'th different window on this frame.
2033 All windows on current frame are arranged in a cyclic order.
2034 This command selects the window ARG steps away in that order.
2035 A negative ARG moves in the opposite order. The optional second
2036 argument ALL-FRAMES has the same meaning as in `next-window', which see. */)
2037 (arg, all_frames)
2038 Lisp_Object arg, all_frames;
2040 Lisp_Object window;
2041 int i;
2043 CHECK_NUMBER (arg);
2044 window = selected_window;
2046 for (i = XINT (arg); i > 0; --i)
2047 window = Fnext_window (window, Qnil, all_frames);
2048 for (; i < 0; ++i)
2049 window = Fprevious_window (window, Qnil, all_frames);
2051 Fselect_window (window, Qnil);
2052 return Qnil;
2056 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2057 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2058 FRAME nil or omitted means use the selected frame.
2059 WINDOW nil or omitted means use the selected window.
2060 MINIBUF t means include the minibuffer window, even if it isn't active.
2061 MINIBUF nil or omitted means include the minibuffer window only
2062 if it's active.
2063 MINIBUF neither nil nor t means never include the minibuffer window. */)
2064 (frame, minibuf, window)
2065 Lisp_Object frame, minibuf, window;
2067 if (NILP (window))
2068 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2069 CHECK_WINDOW (window);
2070 if (NILP (frame))
2071 frame = selected_frame;
2073 if (!EQ (frame, XWINDOW (window)->frame))
2074 error ("Window is on a different frame");
2076 return window_list_1 (window, minibuf, frame);
2080 /* Return a list of windows in canonical ordering. Arguments are like
2081 for `next-window'. */
2083 static Lisp_Object
2084 window_list_1 (window, minibuf, all_frames)
2085 Lisp_Object window, minibuf, all_frames;
2087 Lisp_Object tail, list, rest;
2089 decode_next_window_args (&window, &minibuf, &all_frames);
2090 list = Qnil;
2092 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2093 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2094 list = Fcons (XCAR (tail), list);
2096 /* Rotate the list to start with WINDOW. */
2097 list = Fnreverse (list);
2098 rest = Fmemq (window, list);
2099 if (!NILP (rest) && !EQ (rest, list))
2101 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2103 XSETCDR (tail, Qnil);
2104 list = nconc2 (rest, list);
2106 return list;
2111 /* Look at all windows, performing an operation specified by TYPE
2112 with argument OBJ.
2113 If FRAMES is Qt, look at all frames;
2114 Qnil, look at just the selected frame;
2115 Qvisible, look at visible frames;
2116 a frame, just look at windows on that frame.
2117 If MINI is non-zero, perform the operation on minibuffer windows too. */
2119 enum window_loop
2121 WINDOW_LOOP_UNUSED,
2122 GET_BUFFER_WINDOW, /* Arg is buffer */
2123 GET_LRU_WINDOW, /* Arg is t for full-width windows only */
2124 DELETE_OTHER_WINDOWS, /* Arg is window not to delete */
2125 DELETE_BUFFER_WINDOWS, /* Arg is buffer */
2126 GET_LARGEST_WINDOW,
2127 UNSHOW_BUFFER, /* Arg is buffer */
2128 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2129 CHECK_ALL_WINDOWS
2132 static Lisp_Object
2133 window_loop (type, obj, mini, frames)
2134 enum window_loop type;
2135 Lisp_Object obj, frames;
2136 int mini;
2138 Lisp_Object window, windows, best_window, frame_arg;
2139 struct frame *f;
2140 struct gcpro gcpro1;
2142 /* If we're only looping through windows on a particular frame,
2143 frame points to that frame. If we're looping through windows
2144 on all frames, frame is 0. */
2145 if (FRAMEP (frames))
2146 f = XFRAME (frames);
2147 else if (NILP (frames))
2148 f = SELECTED_FRAME ();
2149 else
2150 f = NULL;
2152 if (f)
2153 frame_arg = Qlambda;
2154 else if (EQ (frames, make_number (0)))
2155 frame_arg = frames;
2156 else if (EQ (frames, Qvisible))
2157 frame_arg = frames;
2158 else
2159 frame_arg = Qt;
2161 /* frame_arg is Qlambda to stick to one frame,
2162 Qvisible to consider all visible frames,
2163 or Qt otherwise. */
2165 /* Pick a window to start with. */
2166 if (WINDOWP (obj))
2167 window = obj;
2168 else if (f)
2169 window = FRAME_SELECTED_WINDOW (f);
2170 else
2171 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2173 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2174 GCPRO1 (windows);
2175 best_window = Qnil;
2177 for (; CONSP (windows); windows = XCDR (windows))
2179 struct window *w;
2181 window = XCAR (windows);
2182 w = XWINDOW (window);
2184 /* Note that we do not pay attention here to whether the frame
2185 is visible, since Fwindow_list skips non-visible frames if
2186 that is desired, under the control of frame_arg. */
2187 if (!MINI_WINDOW_P (w)
2188 /* For UNSHOW_BUFFER, we must always consider all windows. */
2189 || type == UNSHOW_BUFFER
2190 || (mini && minibuf_level > 0))
2191 switch (type)
2193 case GET_BUFFER_WINDOW:
2194 if (EQ (w->buffer, obj)
2195 /* Don't find any minibuffer window
2196 except the one that is currently in use. */
2197 && (MINI_WINDOW_P (w)
2198 ? EQ (window, minibuf_window)
2199 : 1))
2201 if (NILP (best_window))
2202 best_window = window;
2203 else if (EQ (window, selected_window))
2204 /* Prefer to return selected-window. */
2205 RETURN_UNGCPRO (window);
2206 else if (EQ (Fwindow_frame (window), selected_frame))
2207 /* Prefer windows on the current frame. */
2208 best_window = window;
2210 break;
2212 case GET_LRU_WINDOW:
2213 /* `obj' is an integer encoding a bitvector.
2214 `obj & 1' means consider only full-width windows.
2215 `obj & 2' means consider also dedicated windows. */
2216 if (((XINT (obj) & 1) && !WINDOW_FULL_WIDTH_P (w))
2217 || (!(XINT (obj) & 2) && !NILP (w->dedicated))
2218 /* Minibuffer windows are always ignored. */
2219 || MINI_WINDOW_P (w))
2220 break;
2221 if (NILP (best_window)
2222 || (XFASTINT (XWINDOW (best_window)->use_time)
2223 > XFASTINT (w->use_time)))
2224 best_window = window;
2225 break;
2227 case DELETE_OTHER_WINDOWS:
2228 if (!EQ (window, obj))
2229 Fdelete_window (window);
2230 break;
2232 case DELETE_BUFFER_WINDOWS:
2233 if (EQ (w->buffer, obj))
2235 struct frame *f = XFRAME (WINDOW_FRAME (w));
2237 /* If this window is dedicated, and in a frame of its own,
2238 kill the frame. */
2239 if (EQ (window, FRAME_ROOT_WINDOW (f))
2240 && !NILP (w->dedicated)
2241 && other_visible_frames (f))
2243 /* Skip the other windows on this frame.
2244 There might be one, the minibuffer! */
2245 while (CONSP (XCDR (windows))
2246 && EQ (XWINDOW (XCAR (windows))->frame,
2247 XWINDOW (XCAR (XCDR (windows)))->frame))
2248 windows = XCDR (windows);
2250 /* Now we can safely delete the frame. */
2251 Fdelete_frame (w->frame, Qnil);
2253 else if (NILP (w->parent))
2255 /* If we're deleting the buffer displayed in the
2256 only window on the frame, find a new buffer to
2257 display there. */
2258 Lisp_Object buffer;
2259 buffer = Fother_buffer (obj, Qnil, w->frame);
2260 Fset_window_buffer (window, buffer, Qnil);
2261 if (EQ (window, selected_window))
2262 Fset_buffer (w->buffer);
2264 else
2265 Fdelete_window (window);
2267 break;
2269 case GET_LARGEST_WINDOW:
2270 { /* nil `obj' means to ignore dedicated windows. */
2271 /* Ignore dedicated windows and minibuffers. */
2272 if (MINI_WINDOW_P (w) || (NILP (obj) && !NILP (w->dedicated)))
2273 break;
2275 if (NILP (best_window))
2276 best_window = window;
2277 else
2279 struct window *b = XWINDOW (best_window);
2280 if (XFASTINT (w->total_lines) * XFASTINT (w->total_cols)
2281 > XFASTINT (b->total_lines) * XFASTINT (b->total_cols))
2282 best_window = window;
2285 break;
2287 case UNSHOW_BUFFER:
2288 if (EQ (w->buffer, obj))
2290 Lisp_Object buffer;
2291 struct frame *f = XFRAME (w->frame);
2293 /* Find another buffer to show in this window. */
2294 buffer = Fother_buffer (obj, Qnil, w->frame);
2296 /* If this window is dedicated, and in a frame of its own,
2297 kill the frame. */
2298 if (EQ (window, FRAME_ROOT_WINDOW (f))
2299 && !NILP (w->dedicated)
2300 && other_visible_frames (f))
2302 /* Skip the other windows on this frame.
2303 There might be one, the minibuffer! */
2304 while (CONSP (XCDR (windows))
2305 && EQ (XWINDOW (XCAR (windows))->frame,
2306 XWINDOW (XCAR (XCDR (windows)))->frame))
2307 windows = XCDR (windows);
2309 /* Now we can safely delete the frame. */
2310 Fdelete_frame (w->frame, Qnil);
2312 else if (!NILP (w->dedicated) && !NILP (w->parent))
2314 Lisp_Object window;
2315 XSETWINDOW (window, w);
2316 /* If this window is dedicated and not the only window
2317 in its frame, then kill it. */
2318 Fdelete_window (window);
2320 else
2322 /* Otherwise show a different buffer in the window. */
2323 w->dedicated = Qnil;
2324 Fset_window_buffer (window, buffer, Qnil);
2325 if (EQ (window, selected_window))
2326 Fset_buffer (w->buffer);
2329 break;
2331 case REDISPLAY_BUFFER_WINDOWS:
2332 if (EQ (w->buffer, obj))
2334 mark_window_display_accurate (window, 0);
2335 w->update_mode_line = Qt;
2336 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2337 ++update_mode_lines;
2338 best_window = window;
2340 break;
2342 /* Check for a window that has a killed buffer. */
2343 case CHECK_ALL_WINDOWS:
2344 if (! NILP (w->buffer)
2345 && NILP (XBUFFER (w->buffer)->name))
2346 abort ();
2347 break;
2349 case WINDOW_LOOP_UNUSED:
2350 break;
2354 UNGCPRO;
2355 return best_window;
2358 /* Used for debugging. Abort if any window has a dead buffer. */
2360 void
2361 check_all_windows ()
2363 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2366 DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 2, 0,
2367 doc: /* Return the window least recently selected or used for display.
2368 \(LRU means Least Recently Used.)
2370 Return a full-width window if possible.
2371 A minibuffer window is never a candidate.
2372 A dedicated window is never a candidate, unless DEDICATED is non-nil,
2373 so if all windows are dedicated, the value is nil.
2374 If optional argument FRAME is `visible', search all visible frames.
2375 If FRAME is 0, search all visible and iconified frames.
2376 If FRAME is t, search all frames.
2377 If FRAME is nil, search only the selected frame.
2378 If FRAME is a frame, search only that frame. */)
2379 (frame, dedicated)
2380 Lisp_Object frame, dedicated;
2382 register Lisp_Object w;
2383 /* First try for a window that is full-width */
2384 w = window_loop (GET_LRU_WINDOW,
2385 NILP (dedicated) ? make_number (1) : make_number (3),
2386 0, frame);
2387 if (!NILP (w) && !EQ (w, selected_window))
2388 return w;
2389 /* If none of them, try the rest */
2390 return window_loop (GET_LRU_WINDOW,
2391 NILP (dedicated) ? make_number (0) : make_number (2),
2392 0, frame);
2395 DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 2, 0,
2396 doc: /* Return the largest window in area.
2397 A minibuffer window is never a candidate.
2398 A dedicated window is never a candidate unless DEDICATED is non-nil,
2399 so if all windows are dedicated, the value is nil.
2400 If optional argument FRAME is `visible', search all visible frames.
2401 If FRAME is 0, search all visible and iconified frames.
2402 If FRAME is t, search all frames.
2403 If FRAME is nil, search only the selected frame.
2404 If FRAME is a frame, search only that frame. */)
2405 (frame, dedicated)
2406 Lisp_Object frame, dedicated;
2408 return window_loop (GET_LARGEST_WINDOW, dedicated, 0,
2409 frame);
2412 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 1, 2, 0,
2413 doc: /* Return a window currently displaying BUFFER, or nil if none.
2414 BUFFER can be a buffer or a buffer name.
2415 If optional argument FRAME is `visible', search all visible frames.
2416 If optional argument FRAME is 0, search all visible and iconified frames.
2417 If FRAME is t, search all frames.
2418 If FRAME is nil, search only the selected frame.
2419 If FRAME is a frame, search only that frame. */)
2420 (buffer, frame)
2421 Lisp_Object buffer, frame;
2423 buffer = Fget_buffer (buffer);
2424 if (BUFFERP (buffer))
2425 return window_loop (GET_BUFFER_WINDOW, buffer, 1, frame);
2426 else
2427 return Qnil;
2430 DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
2431 0, 1, "",
2432 doc: /* Make WINDOW (or the selected window) fill its frame.
2433 Only the frame WINDOW is on is affected.
2434 This function tries to reduce display jumps
2435 by keeping the text previously visible in WINDOW
2436 in the same place on the frame. Doing this depends on
2437 the value of (window-start WINDOW), so if calling this function
2438 in a program gives strange scrolling, make sure the window-start
2439 value is reasonable when this function is called. */)
2440 (window)
2441 Lisp_Object window;
2443 struct window *w;
2444 int startpos;
2445 int top, new_top;
2447 if (NILP (window))
2448 window = selected_window;
2449 else
2450 CHECK_LIVE_WINDOW (window);
2451 w = XWINDOW (window);
2453 startpos = marker_position (w->start);
2454 top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2456 if (MINI_WINDOW_P (w) && top > 0)
2457 error ("Can't expand minibuffer to full frame");
2459 window_loop (DELETE_OTHER_WINDOWS, window, 0, WINDOW_FRAME (w));
2461 /* Try to minimize scrolling, by setting the window start to the point
2462 will cause the text at the old window start to be at the same place
2463 on the frame. But don't try to do this if the window start is
2464 outside the visible portion (as might happen when the display is
2465 not current, due to typeahead). */
2466 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2467 if (new_top != top
2468 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2469 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2471 struct position pos;
2472 struct buffer *obuf = current_buffer;
2474 Fset_buffer (w->buffer);
2475 /* This computation used to temporarily move point, but that can
2476 have unwanted side effects due to text properties. */
2477 pos = *vmotion (startpos, -top, w);
2479 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2480 w->window_end_valid = Qnil;
2481 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2482 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2483 : Qnil);
2484 /* We need to do this, so that the window-scroll-functions
2485 get called. */
2486 w->optional_new_start = Qt;
2488 set_buffer_internal (obuf);
2491 return Qnil;
2494 DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
2495 1, 2, "bDelete windows on (buffer): ",
2496 doc: /* Delete all windows showing BUFFER.
2497 BUFFER must be a buffer or the name of an existing buffer.
2498 Optional second argument FRAME controls which frames are affected.
2499 If optional argument FRAME is `visible', search all visible frames.
2500 If FRAME is 0, search all visible and iconified frames.
2501 If FRAME is nil, search all frames.
2502 If FRAME is t, search only the selected frame.
2503 If FRAME is a frame, search only that frame.
2504 When a window showing BUFFER is dedicated and the only window of its
2505 frame, that frame is deleted when there are other frames left. */)
2506 (buffer, frame)
2507 Lisp_Object buffer, frame;
2509 /* FRAME uses t and nil to mean the opposite of what window_loop
2510 expects. */
2511 if (NILP (frame))
2512 frame = Qt;
2513 else if (EQ (frame, Qt))
2514 frame = Qnil;
2516 if (!NILP (buffer))
2518 buffer = Fget_buffer (buffer);
2519 CHECK_BUFFER (buffer);
2520 window_loop (DELETE_BUFFER_WINDOWS, buffer, 0, frame);
2523 return Qnil;
2526 DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows,
2527 Sreplace_buffer_in_windows,
2528 1, 1, "bReplace buffer in windows: ",
2529 doc: /* Replace BUFFER with some other buffer in all windows showing it.
2530 BUFFER may be a buffer or the name of an existing buffer.
2531 When a window showing BUFFER is dedicated that window is deleted. When
2532 that window is the only window on its frame, that frame is deleted too
2533 when there are other frames left. */)
2534 (buffer)
2535 Lisp_Object buffer;
2537 if (!NILP (buffer))
2539 buffer = Fget_buffer (buffer);
2540 CHECK_BUFFER (buffer);
2541 window_loop (UNSHOW_BUFFER, buffer, 0, Qt);
2543 return Qnil;
2546 /* Replace BUFFER with some other buffer in all windows
2547 of all frames, even those on other keyboards. */
2549 void
2550 replace_buffer_in_all_windows (buffer)
2551 Lisp_Object buffer;
2553 Lisp_Object tail, frame;
2555 /* A single call to window_loop won't do the job
2556 because it only considers frames on the current keyboard.
2557 So loop manually over frames, and handle each one. */
2558 FOR_EACH_FRAME (tail, frame)
2559 window_loop (UNSHOW_BUFFER, buffer, 1, frame);
2562 /* Set the height of WINDOW and all its inferiors. */
2564 /* The smallest acceptable dimensions for a window. Anything smaller
2565 might crash Emacs. */
2567 #define MIN_SAFE_WINDOW_WIDTH (2)
2568 #define MIN_SAFE_WINDOW_HEIGHT (1)
2570 /* For wp non-zero the total number of columns of window w. Otherwise
2571 the total number of lines of w. */
2573 #define WINDOW_TOTAL_SIZE(w, wp) \
2574 (wp ? WINDOW_TOTAL_COLS (w) : WINDOW_TOTAL_LINES (w))
2576 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2577 minimum allowable size. */
2579 void
2580 check_frame_size (frame, rows, cols)
2581 FRAME_PTR frame;
2582 int *rows, *cols;
2584 /* For height, we have to see:
2585 how many windows the frame has at minimum (one or two),
2586 and whether it has a menu bar or other special stuff at the top. */
2587 int min_height
2588 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
2589 ? MIN_SAFE_WINDOW_HEIGHT
2590 : 2 * MIN_SAFE_WINDOW_HEIGHT);
2592 if (FRAME_TOP_MARGIN (frame) > 0)
2593 min_height += FRAME_TOP_MARGIN (frame);
2595 if (*rows < min_height)
2596 *rows = min_height;
2597 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2598 *cols = MIN_SAFE_WINDOW_WIDTH;
2601 /* Value is non-zero if window W is fixed-size. WIDTH_P non-zero means
2602 check if W's width can be changed, otherwise check W's height.
2603 CHECK_SIBLINGS_P non-zero means check resizablity of WINDOW's
2604 siblings, too. If none of the siblings is resizable, WINDOW isn't
2605 either. */
2607 static int
2608 window_fixed_size_p (w, width_p, check_siblings_p)
2609 struct window *w;
2610 int width_p, check_siblings_p;
2612 int fixed_p;
2613 struct window *c;
2615 if (!NILP (w->hchild))
2617 c = XWINDOW (w->hchild);
2619 if (width_p)
2621 /* A horizontal combination is fixed-width if all of if its
2622 children are. */
2623 while (c && window_fixed_size_p (c, width_p, 0))
2624 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2625 fixed_p = c == NULL;
2627 else
2629 /* A horizontal combination is fixed-height if one of if its
2630 children is. */
2631 while (c && !window_fixed_size_p (c, width_p, 0))
2632 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2633 fixed_p = c != NULL;
2636 else if (!NILP (w->vchild))
2638 c = XWINDOW (w->vchild);
2640 if (width_p)
2642 /* A vertical combination is fixed-width if one of if its
2643 children is. */
2644 while (c && !window_fixed_size_p (c, width_p, 0))
2645 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2646 fixed_p = c != NULL;
2648 else
2650 /* A vertical combination is fixed-height if all of if its
2651 children are. */
2652 while (c && window_fixed_size_p (c, width_p, 0))
2653 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2654 fixed_p = c == NULL;
2657 else if (BUFFERP (w->buffer))
2659 struct buffer *old = current_buffer;
2660 Lisp_Object val;
2662 current_buffer = XBUFFER (w->buffer);
2663 val = find_symbol_value (Qwindow_size_fixed);
2664 current_buffer = old;
2666 fixed_p = 0;
2667 if (!EQ (val, Qunbound))
2669 fixed_p = !NILP (val);
2671 if (fixed_p
2672 && ((EQ (val, Qheight) && width_p)
2673 || (EQ (val, Qwidth) && !width_p)))
2674 fixed_p = 0;
2677 /* Can't tell if this one is resizable without looking at
2678 siblings. If all siblings are fixed-size this one is too. */
2679 if (!fixed_p && check_siblings_p && WINDOWP (w->parent))
2681 Lisp_Object child;
2683 for (child = w->prev; WINDOWP (child); child = XWINDOW (child)->prev)
2684 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2685 break;
2687 if (NILP (child))
2688 for (child = w->next; WINDOWP (child); child = XWINDOW (child)->next)
2689 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2690 break;
2692 if (NILP (child))
2693 fixed_p = 1;
2696 else
2697 fixed_p = 1;
2699 return fixed_p;
2702 /* Return minimum size of leaf window W. WIDTH_P non-zero means return
2703 the minimum width of W, WIDTH_P zero means return the minimum height
2704 of W. SAFE_P non-zero means ignore window-min-height|width but just
2705 return values that won't crash Emacs and don't hide components like
2706 fringes, scrollbars, or modelines. If WIDTH_P is zero and W is the
2707 minibuffer window, always return 1. */
2709 static int
2710 window_min_size_2 (w, width_p, safe_p)
2711 struct window *w;
2712 int width_p, safe_p;
2714 /* We should consider buffer-local values of window_min_height and
2715 window_min_width here. */
2716 if (width_p)
2718 int safe_size = (MIN_SAFE_WINDOW_WIDTH
2719 + WINDOW_FRINGE_COLS (w)
2720 + WINDOW_SCROLL_BAR_COLS (w));
2722 return safe_p ? safe_size : max (window_min_width, safe_size);
2724 else if (MINI_WINDOW_P (w))
2725 return 1;
2726 else
2728 int safe_size = (MIN_SAFE_WINDOW_HEIGHT
2729 + ((BUFFERP (w->buffer)
2730 && !NILP (XBUFFER (w->buffer)->mode_line_format))
2731 ? 1 : 0));
2733 return safe_p ? safe_size : max (window_min_height, safe_size);
2737 /* Return minimum size of window W, not taking fixed-width windows into
2738 account. WIDTH_P non-zero means return the minimum width, otherwise
2739 return the minimum height. SAFE_P non-zero means ignore
2740 window-min-height|width but just return values that won't crash Emacs
2741 and don't hide components like fringes, scrollbars, or modelines. If
2742 W is a combination window, compute the minimum size from the minimum
2743 sizes of W's children. */
2745 static int
2746 window_min_size_1 (w, width_p, safe_p)
2747 struct window *w;
2748 int width_p, safe_p;
2750 struct window *c;
2751 int size;
2753 if (!NILP (w->hchild))
2755 /* W is a horizontal combination. */
2756 c = XWINDOW (w->hchild);
2757 size = 0;
2759 if (width_p)
2761 /* The minimum width of a horizontal combination is the sum of
2762 the minimum widths of its children. */
2763 while (c)
2765 size += window_min_size_1 (c, 1, safe_p);
2766 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2769 else
2771 /* The minimum height of a horizontal combination is the
2772 maximum of the minimum heights of its children. */
2773 while (c)
2775 size = max (window_min_size_1 (c, 0, safe_p), size);
2776 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2780 else if (!NILP (w->vchild))
2782 /* W is a vertical combination. */
2783 c = XWINDOW (w->vchild);
2784 size = 0;
2786 if (width_p)
2788 /* The minimum width of a vertical combination is the maximum
2789 of the minimum widths of its children. */
2790 while (c)
2792 size = max (window_min_size_1 (c, 1, safe_p), size);
2793 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2796 else
2798 /* The minimum height of a vertical combination is the sum of
2799 the minimum height of its children. */
2800 while (c)
2802 size += window_min_size_1 (c, 0, safe_p);
2803 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2807 else
2808 /* W is a leaf window. */
2809 size = window_min_size_2 (w, width_p, safe_p);
2811 return size;
2814 /* Return the minimum size of window W, taking fixed-size windows into
2815 account. WIDTH_P non-zero means return the minimum width, otherwise
2816 return the minimum height. SAFE_P non-zero means ignore
2817 window-min-height|width but just return values that won't crash Emacs
2818 and don't hide components like fringes, scrollbars, or modelines.
2819 IGNORE_FIXED_P non-zero means ignore if W is fixed-size. Set *FIXED
2820 to 1 if W is fixed-size unless FIXED is null. */
2822 static int
2823 window_min_size (w, width_p, safe_p, ignore_fixed_p, fixed)
2824 struct window *w;
2825 int width_p, safe_p, ignore_fixed_p, *fixed;
2827 int size, fixed_p;
2829 if (ignore_fixed_p)
2830 fixed_p = 0;
2831 else
2832 fixed_p = window_fixed_size_p (w, width_p, 1);
2834 if (fixed)
2835 *fixed = fixed_p;
2837 if (fixed_p)
2838 size = WINDOW_TOTAL_SIZE (w, width_p);
2839 else
2840 size = window_min_size_1 (w, width_p, safe_p);
2842 return size;
2846 /* Adjust the margins of window W if text area is too small.
2847 Return 1 if window width is ok after adjustment; 0 if window
2848 is still too narrow. */
2850 static int
2851 adjust_window_margins (w)
2852 struct window *w;
2854 int box_cols = (WINDOW_TOTAL_COLS (w)
2855 - WINDOW_FRINGE_COLS (w)
2856 - WINDOW_SCROLL_BAR_COLS (w));
2857 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
2858 + WINDOW_RIGHT_MARGIN_COLS (w));
2860 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
2861 return 1;
2863 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
2864 return 0;
2866 /* Window's text area is too narrow, but reducing the window
2867 margins will fix that. */
2868 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
2869 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
2871 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
2872 w->left_margin_cols = w->right_margin_cols
2873 = make_number (margin_cols/2);
2874 else
2875 w->right_margin_cols = make_number (margin_cols);
2877 else
2878 w->left_margin_cols = make_number (margin_cols);
2879 return 1;
2882 /* Calculate new sizes for windows in the list FORWARD when their
2883 compound size goes from TOTAL to SIZE. TOTAL must be greater than
2884 SIZE. The number of windows in FORWARD is NCHILDREN, and the number
2885 that can shrink is SHRINKABLE. Fixed-size windows may be shrunk if
2886 and only if RESIZE_FIXED_P is non-zero. WIDTH_P non-zero means
2887 shrink columns, otherwise shrink lines.
2889 SAFE_P zero means windows may be sized down to window-min-height
2890 lines (window-min-window columns for WIDTH_P non-zero). SAFE_P
2891 non-zero means windows may be sized down to their minimum safe sizes
2892 taking into account the space needed to display modelines, fringes,
2893 and scrollbars.
2895 This function returns an allocated array of new sizes that the caller
2896 must free. A size -1 means the window is fixed and RESIZE_FIXED_P is
2897 zero. A size zero means the window shall be deleted. Array index 0
2898 refers to the first window in FORWARD, 1 to the second, and so on.
2900 This function resizes windows proportionally to their size. It also
2901 tries to preserve smaller windows by resizing larger windows before
2902 resizing any window to zero. If resize_proportionally is non-nil for
2903 a specific window, it will attempt to strictly resize that window
2904 proportionally, even at the expense of deleting smaller windows. */
2905 static int *
2906 shrink_windows (total, size, nchildren, shrinkable, resize_fixed_p,
2907 forward, width_p, safe_p)
2908 int total, size, nchildren, shrinkable;
2909 int resize_fixed_p, width_p, safe_p;
2910 Lisp_Object forward;
2912 int available_resize = 0;
2913 int *new_sizes, *min_sizes;
2914 struct window *c;
2915 Lisp_Object child;
2916 int smallest = total;
2917 int total_removed = 0;
2918 int total_shrink = total - size;
2919 int i;
2921 new_sizes = xmalloc (sizeof (*new_sizes) * nchildren);
2922 min_sizes = xmalloc (sizeof (*min_sizes) * nchildren);
2924 for (i = 0, child = forward; !NILP (child); child = c->next, ++i)
2926 int child_size;
2928 c = XWINDOW (child);
2929 child_size = WINDOW_TOTAL_SIZE (c, width_p);
2931 if (!resize_fixed_p && window_fixed_size_p (c, width_p, 0))
2932 new_sizes[i] = -1;
2933 else
2935 new_sizes[i] = child_size;
2936 min_sizes[i] = window_min_size_1 (c, width_p, safe_p);
2937 if (child_size > min_sizes[i]
2938 && NILP (c->resize_proportionally))
2939 available_resize += child_size - min_sizes[i];
2942 /* We might need to shrink some windows to zero. Find the smallest
2943 windows and set them to 0 until we can fulfil the new size. */
2945 while (shrinkable > 1 && size + available_resize < total)
2947 for (i = 0; i < nchildren; ++i)
2948 if (new_sizes[i] > 0 && smallest > new_sizes[i])
2949 smallest = new_sizes[i];
2951 for (i = 0; i < nchildren; ++i)
2952 if (new_sizes[i] == smallest)
2954 /* Resize this window down to zero. */
2955 new_sizes[i] = 0;
2956 if (smallest > min_sizes[i])
2957 available_resize -= smallest - min_sizes[i];
2958 available_resize += smallest;
2959 --shrinkable;
2960 total_removed += smallest;
2962 /* We don't know what the smallest is now. */
2963 smallest = total;
2965 /* Out of for, just remove one window at the time and
2966 check again if we have enough space. */
2967 break;
2971 /* Now, calculate the new sizes. Try to shrink each window
2972 proportional to its size. */
2973 for (i = 0; i < nchildren; ++i)
2975 if (new_sizes[i] > min_sizes[i])
2977 int to_shrink = total_shrink * new_sizes[i] / total;
2979 if (new_sizes[i] - to_shrink < min_sizes[i])
2980 to_shrink = new_sizes[i] - min_sizes[i];
2981 new_sizes[i] -= to_shrink;
2982 total_removed += to_shrink;
2986 /* Any reminder due to rounding, we just subtract from windows
2987 that are left and still can be shrunk. */
2988 while (total_shrink > total_removed)
2990 int nonzero_sizes = 0;
2991 int nonzero_idx = -1;
2993 for (i = 0; i < nchildren; ++i)
2994 if (new_sizes[i] > 0)
2996 ++nonzero_sizes;
2997 nonzero_idx = i;
3000 for (i = 0; i < nchildren; ++i)
3001 if (new_sizes[i] > min_sizes[i])
3003 --new_sizes[i];
3004 ++total_removed;
3006 /* Out of for, just shrink one window at the time and
3007 check again if we have enough space. */
3008 break;
3011 /* Special case, only one window left. */
3012 if (nonzero_sizes == 1)
3013 break;
3016 /* Any surplus due to rounding, we add to windows that are left. */
3017 while (total_shrink < total_removed)
3019 for (i = 0; i < nchildren; ++i)
3021 if (new_sizes[i] != 0 && total_shrink < total_removed)
3023 ++new_sizes[i];
3024 --total_removed;
3025 break;
3030 xfree (min_sizes);
3032 return new_sizes;
3035 /* Set WINDOW's height or width to SIZE. WIDTH_P non-zero means set
3036 WINDOW's width. Resize WINDOW's children, if any, so that they keep
3037 their proportionate size relative to WINDOW.
3039 If FIRST_ONLY is 1, change only the first of WINDOW's children when
3040 they are in series. If LAST_ONLY is 1, change only the last of
3041 WINDOW's children when they are in series.
3043 Propagate WINDOW's top or left edge position to children. Delete
3044 windows that become too small unless NODELETE_P is 1. When
3045 NODELETE_P equals 2 do not honor settings for window-min-height and
3046 window-min-width when resizing windows but use safe defaults instead.
3047 This should give better behavior when resizing frames. */
3049 static void
3050 size_window (window, size, width_p, nodelete_p, first_only, last_only)
3051 Lisp_Object window;
3052 int size, width_p, nodelete_p;
3053 int first_only, last_only;
3055 struct window *w = XWINDOW (window);
3056 struct window *c;
3057 Lisp_Object child, *forward, *sideward;
3058 int old_size = WINDOW_TOTAL_SIZE (w, width_p);
3060 size = max (0, size);
3062 /* Delete WINDOW if it's too small. */
3063 if (nodelete_p != 1 && !NILP (w->parent)
3064 && size < window_min_size_1 (w, width_p, nodelete_p == 2))
3066 delete_window (window);
3067 return;
3070 /* Set redisplay hints. */
3071 w->last_modified = make_number (0);
3072 w->last_overlay_modified = make_number (0);
3073 windows_or_buffers_changed++;
3074 FRAME_WINDOW_SIZES_CHANGED (XFRAME (w->frame)) = 1;
3076 if (width_p)
3078 sideward = &w->vchild;
3079 forward = &w->hchild;
3080 w->total_cols = make_number (size);
3081 adjust_window_margins (w);
3083 else
3085 sideward = &w->hchild;
3086 forward = &w->vchild;
3087 w->total_lines = make_number (size);
3088 w->orig_total_lines = Qnil;
3091 if (!NILP (*sideward))
3093 /* We have a chain of parallel siblings whose size should all change. */
3094 for (child = *sideward; !NILP (child); child = c->next)
3096 c = XWINDOW (child);
3097 if (width_p)
3098 c->left_col = w->left_col;
3099 else
3100 c->top_line = w->top_line;
3101 size_window (child, size, width_p, nodelete_p,
3102 first_only, last_only);
3105 else if (!NILP (*forward) && last_only)
3107 /* Change the last in a series of siblings. */
3108 Lisp_Object last_child;
3109 int child_size;
3111 for (child = *forward; !NILP (child); child = c->next)
3113 c = XWINDOW (child);
3114 last_child = child;
3117 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3118 size_window (last_child, size - old_size + child_size,
3119 width_p, nodelete_p, first_only, last_only);
3121 else if (!NILP (*forward) && first_only)
3123 /* Change the first in a series of siblings. */
3124 int child_size;
3126 child = *forward;
3127 c = XWINDOW (child);
3129 if (width_p)
3130 c->left_col = w->left_col;
3131 else
3132 c->top_line = w->top_line;
3134 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3135 size_window (child, size - old_size + child_size,
3136 width_p, nodelete_p, first_only, last_only);
3138 else if (!NILP (*forward))
3140 int fixed_size, each, extra, n;
3141 int resize_fixed_p, nfixed;
3142 int last_pos, first_pos, nchildren, total;
3143 int *new_sizes = NULL;
3145 /* Determine the fixed-size portion of this window, and the
3146 number of child windows. */
3147 fixed_size = nchildren = nfixed = total = 0;
3148 for (child = *forward; !NILP (child); child = c->next, ++nchildren)
3150 int child_size;
3152 c = XWINDOW (child);
3153 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3154 total += child_size;
3156 if (window_fixed_size_p (c, width_p, 0))
3158 fixed_size += child_size;
3159 ++nfixed;
3163 /* If the new size is smaller than fixed_size, or if there
3164 aren't any resizable windows, allow resizing fixed-size
3165 windows. */
3166 resize_fixed_p = nfixed == nchildren || size < fixed_size;
3168 /* Compute how many lines/columns to add/remove to each child. The
3169 value of extra takes care of rounding errors. */
3170 n = resize_fixed_p ? nchildren : nchildren - nfixed;
3171 if (size < total && n > 1)
3172 new_sizes = shrink_windows (total, size, nchildren, n,
3173 resize_fixed_p, *forward, width_p,
3174 nodelete_p == 2);
3175 else
3177 each = (size - total) / n;
3178 extra = (size - total) - n * each;
3181 /* Compute new children heights and edge positions. */
3182 first_pos = width_p ? XINT (w->left_col) : XINT (w->top_line);
3183 last_pos = first_pos;
3184 for (n = 0, child = *forward; !NILP (child); child = c->next, ++n)
3186 int new_size, old_size;
3188 c = XWINDOW (child);
3189 old_size = WINDOW_TOTAL_SIZE (c, width_p);
3190 new_size = old_size;
3192 /* The top or left edge position of this child equals the
3193 bottom or right edge of its predecessor. */
3194 if (width_p)
3195 c->left_col = make_number (last_pos);
3196 else
3197 c->top_line = make_number (last_pos);
3199 /* If this child can be resized, do it. */
3200 if (resize_fixed_p || !window_fixed_size_p (c, width_p, 0))
3202 new_size = new_sizes ? new_sizes[n] : old_size + each + extra;
3203 extra = 0;
3206 /* Set new size. Note that size_window also propagates
3207 edge positions to children, so it's not a no-op if we
3208 didn't change the child's size. */
3209 size_window (child, new_size, width_p, 1, first_only, last_only);
3211 /* Remember the bottom/right edge position of this child; it
3212 will be used to set the top/left edge of the next child. */
3213 last_pos += new_size;
3216 xfree (new_sizes);
3218 /* We should have covered the parent exactly with child windows. */
3219 xassert (size == last_pos - first_pos);
3221 /* Now delete any children that became too small. */
3222 if (nodelete_p != 1)
3223 for (child = *forward; !NILP (child); child = c->next)
3225 int child_size;
3227 c = XWINDOW (child);
3228 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3229 size_window (child, child_size, width_p, nodelete_p,
3230 first_only, last_only);
3235 /* Set WINDOW's height to HEIGHT, and recursively change the height of
3236 WINDOW's children. NODELETE zero means windows that have become
3237 smaller than window-min-height in the process may be deleted.
3238 NODELETE 1 means never delete windows that become too small in the
3239 process. (The caller should check later and do so if appropriate.)
3240 NODELETE 2 means delete only windows that have become too small to be
3241 displayed correctly. */
3243 void
3244 set_window_height (window, height, nodelete)
3245 Lisp_Object window;
3246 int height;
3247 int nodelete;
3249 size_window (window, height, 0, nodelete, 0, 0);
3252 /* Set WINDOW's width to WIDTH, and recursively change the width of
3253 WINDOW's children. NODELETE zero means windows that have become
3254 smaller than window-min-width in the process may be deleted.
3255 NODELETE 1 means never delete windows that become too small in the
3256 process. (The caller should check later and do so if appropriate.)
3257 NODELETE 2 means delete only windows that have become too small to be
3258 displayed correctly. */
3260 void
3261 set_window_width (window, width, nodelete)
3262 Lisp_Object window;
3263 int width;
3264 int nodelete;
3266 size_window (window, width, 1, nodelete, 0, 0);
3269 /* Change window heights in windows rooted in WINDOW by N lines. */
3271 void
3272 change_window_heights (window, n)
3273 Lisp_Object window;
3274 int n;
3276 struct window *w = XWINDOW (window);
3278 XSETFASTINT (w->top_line, XFASTINT (w->top_line) + n);
3279 XSETFASTINT (w->total_lines, XFASTINT (w->total_lines) - n);
3281 if (INTEGERP (w->orig_top_line))
3282 XSETFASTINT (w->orig_top_line, XFASTINT (w->orig_top_line) + n);
3283 if (INTEGERP (w->orig_total_lines))
3284 XSETFASTINT (w->orig_total_lines, XFASTINT (w->orig_total_lines) - n);
3286 /* Handle just the top child in a vertical split. */
3287 if (!NILP (w->vchild))
3288 change_window_heights (w->vchild, n);
3290 /* Adjust all children in a horizontal split. */
3291 for (window = w->hchild; !NILP (window); window = w->next)
3293 w = XWINDOW (window);
3294 change_window_heights (window, n);
3299 int window_select_count;
3301 EXFUN (Fset_window_fringes, 4);
3302 EXFUN (Fset_window_scroll_bars, 4);
3304 static void
3305 run_funs (Lisp_Object funs)
3307 for (; CONSP (funs); funs = XCDR (funs))
3308 if (!EQ (XCAR (funs), Qt))
3309 call0 (XCAR (funs));
3312 static Lisp_Object select_window_norecord (Lisp_Object window);
3314 void
3315 run_window_configuration_change_hook (struct frame *f)
3317 int count = SPECPDL_INDEX ();
3318 Lisp_Object frame, global_wcch
3319 = Fdefault_value (Qwindow_configuration_change_hook);
3320 XSETFRAME (frame, f);
3322 if (NILP (Vrun_hooks))
3323 return;
3325 if (SELECTED_FRAME () != f)
3327 record_unwind_protect (Fselect_frame, Fselected_frame ());
3328 Fselect_frame (frame);
3331 /* Use the right buffer. Matters when running the local hooks. */
3332 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3334 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3335 Fset_buffer (Fwindow_buffer (Qnil));
3338 /* Look for buffer-local values. */
3340 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3341 for (; CONSP (windows); windows = XCDR (windows))
3343 Lisp_Object window = XCAR (windows);
3344 Lisp_Object buffer = Fwindow_buffer (window);
3345 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3346 buffer)))
3348 int count = SPECPDL_INDEX ();
3349 record_unwind_protect (select_window_norecord, Fselected_window ());
3350 select_window_norecord (window);
3351 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3352 buffer));
3353 unbind_to (count, Qnil);
3358 run_funs (global_wcch);
3359 unbind_to (count, Qnil);
3362 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
3363 means it's allowed to run hooks. See make_frame for a case where
3364 it's not allowed. KEEP_MARGINS_P non-zero means that the current
3365 margins, fringes, and scroll-bar settings of the window are not
3366 reset from the buffer's local settings. */
3368 void
3369 set_window_buffer (window, buffer, run_hooks_p, keep_margins_p)
3370 Lisp_Object window, buffer;
3371 int run_hooks_p, keep_margins_p;
3373 struct window *w = XWINDOW (window);
3374 struct buffer *b = XBUFFER (buffer);
3375 int count = SPECPDL_INDEX ();
3376 int samebuf = EQ (buffer, w->buffer);
3378 w->buffer = buffer;
3380 if (EQ (window, selected_window))
3381 b->last_selected_window = window;
3383 /* Let redisplay errors through. */
3384 b->display_error_modiff = 0;
3386 /* Update time stamps of buffer display. */
3387 if (INTEGERP (b->display_count))
3388 XSETINT (b->display_count, XINT (b->display_count) + 1);
3389 b->display_time = Fcurrent_time ();
3391 XSETFASTINT (w->window_end_pos, 0);
3392 XSETFASTINT (w->window_end_vpos, 0);
3393 bzero (&w->last_cursor, sizeof w->last_cursor);
3394 w->window_end_valid = Qnil;
3395 if (!(keep_margins_p && samebuf))
3396 { /* If we're not actually changing the buffer, Don't reset hscroll and
3397 vscroll. This case happens for example when called from
3398 change_frame_size_1, where we use a dummy call to
3399 Fset_window_buffer on the frame's selected window (and no other)
3400 just in order to run window-configuration-change-hook.
3401 Resetting hscroll and vscroll here is problematic for things like
3402 image-mode and doc-view-mode since it resets the image's position
3403 whenever we resize the frame. */
3404 w->hscroll = w->min_hscroll = make_number (0);
3405 w->vscroll = 0;
3406 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3407 set_marker_restricted (w->start,
3408 make_number (b->last_window_start),
3409 buffer);
3410 w->start_at_line_beg = Qnil;
3411 w->force_start = Qnil;
3412 XSETFASTINT (w->last_modified, 0);
3413 XSETFASTINT (w->last_overlay_modified, 0);
3415 /* Maybe we could move this into the `if' but it's not obviously safe and
3416 I doubt it's worth the trouble. */
3417 windows_or_buffers_changed++;
3419 /* We must select BUFFER for running the window-scroll-functions. */
3420 /* We can't check ! NILP (Vwindow_scroll_functions) here
3421 because that might itself be a local variable. */
3422 if (window_initialized)
3424 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3425 Fset_buffer (buffer);
3428 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3430 if (!keep_margins_p)
3432 /* Set left and right marginal area width etc. from buffer. */
3434 /* This may call adjust_window_margins three times, so
3435 temporarily disable window margins. */
3436 Lisp_Object save_left = w->left_margin_cols;
3437 Lisp_Object save_right = w->right_margin_cols;
3439 w->left_margin_cols = w->right_margin_cols = Qnil;
3441 Fset_window_fringes (window,
3442 b->left_fringe_width, b->right_fringe_width,
3443 b->fringes_outside_margins);
3445 Fset_window_scroll_bars (window,
3446 b->scroll_bar_width,
3447 b->vertical_scroll_bar_type, Qnil);
3449 w->left_margin_cols = save_left;
3450 w->right_margin_cols = save_right;
3452 Fset_window_margins (window,
3453 b->left_margin_cols, b->right_margin_cols);
3456 if (run_hooks_p)
3458 if (! NILP (Vwindow_scroll_functions))
3459 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3460 Fmarker_position (w->start));
3461 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3464 unbind_to (count, Qnil);
3468 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3469 doc: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3470 WINDOW defaults to the selected window. BUFFER-OR-NAME must be a buffer
3471 or the name of an existing buffer. Optional third argument KEEP-MARGINS
3472 non-nil means that WINDOW's current display margins, fringe widths, and
3473 scroll bar settings are preserved; the default is to reset these from
3474 the local settings for BUFFER-OR-NAME or the frame defaults. Return nil
3476 This function throws an error when WINDOW is dedicated to its buffer and
3477 does not already display BUFFER-OR-NAME.
3479 This function runs the hook `window-scroll-functions'. */)
3480 (window, buffer_or_name, keep_margins)
3481 register Lisp_Object window, buffer_or_name, keep_margins;
3483 register Lisp_Object tem, buffer;
3484 register struct window *w = decode_window (window);
3486 XSETWINDOW (window, w);
3487 buffer = Fget_buffer (buffer_or_name);
3488 CHECK_BUFFER (buffer);
3489 if (NILP (XBUFFER (buffer)->name))
3490 error ("Attempt to display deleted buffer");
3492 tem = w->buffer;
3493 if (NILP (tem))
3494 error ("Window is deleted");
3495 else if (!EQ (tem, Qt))
3496 /* w->buffer is t when the window is first being set up. */
3498 if (!NILP (w->dedicated) && !EQ (tem, buffer))
3499 error ("Window is dedicated to `%s'", SDATA (XBUFFER (tem)->name));
3501 unshow_buffer (w);
3504 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3505 return Qnil;
3508 /* Note that selected_window can be nil when this is called from
3509 Fset_window_configuration. */
3511 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
3512 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
3513 If WINDOW is not already selected, make WINDOW's buffer current
3514 and make WINDOW the frame's selected window. Return WINDOW.
3515 Optional second arg NORECORD non-nil means do not put this buffer
3516 at the front of the list of recently selected ones.
3518 Note that the main editor command loop selects the buffer of the
3519 selected window before each command. */)
3520 (window, norecord)
3521 register Lisp_Object window, norecord;
3523 register struct window *w;
3524 register struct window *ow;
3525 struct frame *sf;
3527 CHECK_LIVE_WINDOW (window);
3529 w = XWINDOW (window);
3530 w->frozen_window_start_p = 0;
3532 if (NILP (norecord))
3534 ++window_select_count;
3535 XSETFASTINT (w->use_time, window_select_count);
3538 if (EQ (window, selected_window))
3539 return window;
3541 sf = SELECTED_FRAME ();
3542 if (XFRAME (WINDOW_FRAME (w)) != sf)
3544 XFRAME (WINDOW_FRAME (w))->selected_window = window;
3545 /* Use this rather than Fhandle_switch_frame
3546 so that FRAME_FOCUS_FRAME is moved appropriately as we
3547 move around in the state where a minibuffer in a separate
3548 frame is active. */
3549 Fselect_frame (WINDOW_FRAME (w));
3550 /* Fselect_frame called us back so we've done all the work already. */
3551 eassert (EQ (window, selected_window));
3552 return window;
3554 else
3555 sf->selected_window = window;
3557 /* Store the current buffer's actual point into the
3558 old selected window. It belongs to that window,
3559 and when the window is not selected, must be in the window. */
3560 if (!NILP (selected_window))
3562 ow = XWINDOW (selected_window);
3563 if (! NILP (ow->buffer))
3564 set_marker_both (ow->pointm, ow->buffer,
3565 BUF_PT (XBUFFER (ow->buffer)),
3566 BUF_PT_BYTE (XBUFFER (ow->buffer)));
3569 selected_window = window;
3571 if (NILP (norecord))
3572 record_buffer (w->buffer);
3573 Fset_buffer (w->buffer);
3575 XBUFFER (w->buffer)->last_selected_window = window;
3577 /* Go to the point recorded in the window.
3578 This is important when the buffer is in more
3579 than one window. It also matters when
3580 redisplay_window has altered point after scrolling,
3581 because it makes the change only in the window. */
3583 register int new_point = marker_position (w->pointm);
3584 if (new_point < BEGV)
3585 SET_PT (BEGV);
3586 else if (new_point > ZV)
3587 SET_PT (ZV);
3588 else
3589 SET_PT (new_point);
3592 windows_or_buffers_changed++;
3593 return window;
3596 static Lisp_Object
3597 select_window_norecord (window)
3598 Lisp_Object window;
3600 return Fselect_window (window, Qt);
3603 Lisp_Object
3604 display_buffer (buffer, not_this_window_p, override_frame)
3605 Lisp_Object buffer, not_this_window_p, override_frame;
3607 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3610 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3611 0, 1, 0,
3612 doc: /* Force all windows to be updated on next redisplay.
3613 If optional arg OBJECT is a window, force redisplay of that window only.
3614 If OBJECT is a buffer or buffer name, force redisplay of all windows
3615 displaying that buffer. */)
3616 (object)
3617 Lisp_Object object;
3619 if (NILP (object))
3621 windows_or_buffers_changed++;
3622 update_mode_lines++;
3623 return Qt;
3626 if (WINDOWP (object))
3628 struct window *w = XWINDOW (object);
3629 mark_window_display_accurate (object, 0);
3630 w->update_mode_line = Qt;
3631 if (BUFFERP (w->buffer))
3632 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3633 ++update_mode_lines;
3634 return Qt;
3637 if (STRINGP (object))
3638 object = Fget_buffer (object);
3639 if (BUFFERP (object) && !NILP (XBUFFER (object)->name))
3641 /* Walk all windows looking for buffer, and force update
3642 of each of those windows. */
3644 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3645 return NILP (object) ? Qnil : Qt;
3648 /* If nothing suitable was found, just return.
3649 We could signal an error, but this feature will typically be used
3650 asynchronously in timers or process sentinels, so we don't. */
3651 return Qnil;
3655 void
3656 temp_output_buffer_show (buf)
3657 register Lisp_Object buf;
3659 register struct buffer *old = current_buffer;
3660 register Lisp_Object window;
3661 register struct window *w;
3663 XBUFFER (buf)->directory = current_buffer->directory;
3665 Fset_buffer (buf);
3666 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3667 BEGV = BEG;
3668 ZV = Z;
3669 SET_PT (BEG);
3670 #if 0 /* rms: there should be no reason for this. */
3671 XBUFFER (buf)->prevent_redisplay_optimizations_p = 1;
3672 #endif
3673 set_buffer_internal (old);
3675 if (!NILP (Vtemp_buffer_show_function))
3676 call1 (Vtemp_buffer_show_function, buf);
3677 else
3679 window = display_buffer (buf, Qnil, Qnil);
3681 if (!EQ (XWINDOW (window)->frame, selected_frame))
3682 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3683 Vminibuf_scroll_window = window;
3684 w = XWINDOW (window);
3685 XSETFASTINT (w->hscroll, 0);
3686 XSETFASTINT (w->min_hscroll, 0);
3687 set_marker_restricted_both (w->start, buf, BEG, BEG);
3688 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3690 /* Run temp-buffer-show-hook, with the chosen window selected
3691 and its buffer current. */
3693 if (!NILP (Vrun_hooks)
3694 && !NILP (Fboundp (Qtemp_buffer_show_hook))
3695 && !NILP (Fsymbol_value (Qtemp_buffer_show_hook)))
3697 int count = SPECPDL_INDEX ();
3698 Lisp_Object prev_window, prev_buffer;
3699 prev_window = selected_window;
3700 XSETBUFFER (prev_buffer, old);
3702 /* Select the window that was chosen, for running the hook.
3703 Note: Both Fselect_window and select_window_norecord may
3704 set-buffer to the buffer displayed in the window,
3705 so we need to save the current buffer. --stef */
3706 record_unwind_protect (Fset_buffer, prev_buffer);
3707 record_unwind_protect (select_window_norecord, prev_window);
3708 Fselect_window (window, Qt);
3709 Fset_buffer (w->buffer);
3710 call1 (Vrun_hooks, Qtemp_buffer_show_hook);
3711 unbind_to (count, Qnil);
3716 static void
3717 make_dummy_parent (window)
3718 Lisp_Object window;
3720 Lisp_Object new;
3721 register struct window *o, *p;
3722 int i;
3724 o = XWINDOW (window);
3725 p = allocate_window ();
3726 for (i = 0; i < VECSIZE (struct window); ++i)
3727 ((struct Lisp_Vector *) p)->contents[i]
3728 = ((struct Lisp_Vector *)o)->contents[i];
3729 XSETWINDOW (new, p);
3731 ++sequence_number;
3732 XSETFASTINT (p->sequence_number, sequence_number);
3734 /* Put new into window structure in place of window */
3735 replace_window (window, new);
3737 o->next = Qnil;
3738 o->prev = Qnil;
3739 o->vchild = Qnil;
3740 o->hchild = Qnil;
3741 o->parent = new;
3743 p->start = Qnil;
3744 p->pointm = Qnil;
3745 p->buffer = Qnil;
3748 DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "",
3749 doc: /* Split WINDOW, putting SIZE lines in the first of the pair.
3750 WINDOW defaults to selected one and SIZE to half its size.
3751 If optional third arg HORIZONTAL is non-nil, split side by side and put
3752 SIZE columns in the first of the pair. In that case, SIZE includes that
3753 window's scroll bar, or the divider column to its right.
3754 Interactively, all arguments are nil.
3755 Returns the newly created window (which is the lower or rightmost one).
3756 The upper or leftmost window is the original one, and remains selected
3757 if it was selected before.
3759 See Info node `(elisp)Splitting Windows' for more details and examples. */)
3760 (window, size, horizontal)
3761 Lisp_Object window, size, horizontal;
3763 register Lisp_Object new;
3764 register struct window *o, *p;
3765 FRAME_PTR fo;
3766 register int size_int;
3768 if (NILP (window))
3769 window = selected_window;
3770 else
3771 CHECK_LIVE_WINDOW (window);
3773 o = XWINDOW (window);
3774 fo = XFRAME (WINDOW_FRAME (o));
3776 if (NILP (size))
3778 if (!NILP (horizontal))
3779 /* Calculate the size of the left-hand window, by dividing
3780 the usable space in columns by two.
3781 We round up, since the left-hand window may include
3782 a dividing line, while the right-hand may not. */
3783 size_int = (XFASTINT (o->total_cols) + 1) >> 1;
3784 else
3785 size_int = XFASTINT (o->total_lines) >> 1;
3787 else
3789 CHECK_NUMBER (size);
3790 size_int = XINT (size);
3793 if (MINI_WINDOW_P (o))
3794 error ("Attempt to split minibuffer window");
3795 else if (window_fixed_size_p (o, !NILP (horizontal), 0))
3796 error ("Attempt to split fixed-size window");
3798 if (NILP (horizontal))
3800 int window_safe_height = window_min_size_2 (o, 0, 0);
3802 if (size_int < window_safe_height)
3803 error ("Window height %d too small (after splitting)", size_int);
3804 if (size_int + window_safe_height > XFASTINT (o->total_lines))
3805 error ("Window height %d too small (after splitting)",
3806 XFASTINT (o->total_lines) - size_int);
3807 if (NILP (o->parent)
3808 || NILP (XWINDOW (o->parent)->vchild))
3810 make_dummy_parent (window);
3811 new = o->parent;
3812 XWINDOW (new)->vchild = window;
3815 else
3817 int window_safe_width = window_min_size_2 (o, 1, 0);
3819 if (size_int < window_safe_width)
3820 error ("Window width %d too small (after splitting)", size_int);
3821 if (size_int + window_safe_width > XFASTINT (o->total_cols))
3822 error ("Window width %d too small (after splitting)",
3823 XFASTINT (o->total_cols) - size_int);
3824 if (NILP (o->parent)
3825 || NILP (XWINDOW (o->parent)->hchild))
3827 make_dummy_parent (window);
3828 new = o->parent;
3829 XWINDOW (new)->hchild = window;
3833 /* Now we know that window's parent is a vertical combination
3834 if we are dividing vertically, or a horizontal combination
3835 if we are making side-by-side windows */
3837 windows_or_buffers_changed++;
3838 FRAME_WINDOW_SIZES_CHANGED (fo) = 1;
3839 new = make_window ();
3840 p = XWINDOW (new);
3842 p->frame = o->frame;
3843 p->next = o->next;
3844 if (!NILP (p->next))
3845 XWINDOW (p->next)->prev = new;
3846 p->prev = window;
3847 o->next = new;
3848 p->parent = o->parent;
3849 p->buffer = Qt;
3850 p->window_end_valid = Qnil;
3851 bzero (&p->last_cursor, sizeof p->last_cursor);
3853 /* Duplicate special geometry settings. */
3855 p->left_margin_cols = o->left_margin_cols;
3856 p->right_margin_cols = o->right_margin_cols;
3857 p->left_fringe_width = o->left_fringe_width;
3858 p->right_fringe_width = o->right_fringe_width;
3859 p->fringes_outside_margins = o->fringes_outside_margins;
3860 p->scroll_bar_width = o->scroll_bar_width;
3861 p->vertical_scroll_bar_type = o->vertical_scroll_bar_type;
3863 /* Apportion the available frame space among the two new windows */
3865 if (!NILP (horizontal))
3867 p->total_lines = o->total_lines;
3868 p->top_line = o->top_line;
3869 XSETFASTINT (p->total_cols, XFASTINT (o->total_cols) - size_int);
3870 XSETFASTINT (o->total_cols, size_int);
3871 XSETFASTINT (p->left_col, XFASTINT (o->left_col) + size_int);
3872 adjust_window_margins (p);
3873 adjust_window_margins (o);
3875 else
3877 p->left_col = o->left_col;
3878 p->total_cols = o->total_cols;
3879 XSETFASTINT (p->total_lines, XFASTINT (o->total_lines) - size_int);
3880 XSETFASTINT (o->total_lines, size_int);
3881 XSETFASTINT (p->top_line, XFASTINT (o->top_line) + size_int);
3884 /* Adjust glyph matrices. */
3885 adjust_glyphs (fo);
3887 Fset_window_buffer (new, o->buffer, Qt);
3888 return new;
3891 DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 2, "p",
3892 doc: /* Make selected window SIZE lines taller.
3893 Interactively, if no argument is given, make the selected window one
3894 line taller. If optional argument HORIZONTAL is non-nil, make selected
3895 window wider by SIZE columns. If SIZE is negative, shrink the window by
3896 -SIZE lines or columns. Return nil.
3898 This function can delete windows if they get too small. The size of
3899 fixed size windows is not altered by this function. */)
3900 (size, horizontal)
3901 Lisp_Object size, horizontal;
3903 CHECK_NUMBER (size);
3904 enlarge_window (selected_window, XINT (size), !NILP (horizontal));
3906 run_window_configuration_change_hook (SELECTED_FRAME ());
3908 return Qnil;
3911 DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 2, "p",
3912 doc: /* Make selected window SIZE lines smaller.
3913 Interactively, if no argument is given, make the selected window one
3914 line smaller. If optional argument HORIZONTAL is non-nil, make the
3915 window narrower by SIZE columns. If SIZE is negative, enlarge selected
3916 window by -SIZE lines or columns. Return nil.
3918 This function can delete windows if they get too small. The size of
3919 fixed size windows is not altered by this function. */)
3920 (size, horizontal)
3921 Lisp_Object size, horizontal;
3923 CHECK_NUMBER (size);
3924 enlarge_window (selected_window, -XINT (size), !NILP (horizontal));
3926 run_window_configuration_change_hook (SELECTED_FRAME ());
3928 return Qnil;
3932 window_height (window)
3933 Lisp_Object window;
3935 register struct window *p = XWINDOW (window);
3936 return WINDOW_TOTAL_LINES (p);
3940 window_width (window)
3941 Lisp_Object window;
3943 register struct window *p = XWINDOW (window);
3944 return WINDOW_TOTAL_COLS (p);
3948 #define CURBEG(w) \
3949 *(horiz_flag ? &(XWINDOW (w)->left_col) : &(XWINDOW (w)->top_line))
3951 #define CURSIZE(w) \
3952 *(horiz_flag ? &(XWINDOW (w)->total_cols) : &(XWINDOW (w)->total_lines))
3955 /* Enlarge WINDOW by DELTA. HORIZ_FLAG nonzero means enlarge it
3956 horizontally; zero means do it vertically.
3958 Siblings of the selected window are resized to fulfill the size
3959 request. If they become too small in the process, they may be
3960 deleted. */
3962 static void
3963 enlarge_window (window, delta, horiz_flag)
3964 Lisp_Object window;
3965 int delta, horiz_flag;
3967 Lisp_Object parent, next, prev;
3968 struct window *p;
3969 Lisp_Object *sizep;
3970 int maximum;
3971 int (*sizefun) P_ ((Lisp_Object))
3972 = horiz_flag ? window_width : window_height;
3973 void (*setsizefun) P_ ((Lisp_Object, int, int))
3974 = (horiz_flag ? set_window_width : set_window_height);
3976 /* Give up if this window cannot be resized. */
3977 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
3978 error ("Window is not resizable");
3980 /* Find the parent of the selected window. */
3981 while (1)
3983 p = XWINDOW (window);
3984 parent = p->parent;
3986 if (NILP (parent))
3988 if (horiz_flag)
3989 error ("No other window to side of this one");
3990 break;
3993 if (horiz_flag
3994 ? !NILP (XWINDOW (parent)->hchild)
3995 : !NILP (XWINDOW (parent)->vchild))
3996 break;
3998 window = parent;
4001 sizep = &CURSIZE (window);
4004 register int maxdelta;
4006 /* Compute the maximum size increment this window can have. */
4008 maxdelta = (!NILP (parent) ? (*sizefun) (parent) - XINT (*sizep)
4009 /* This is a main window followed by a minibuffer. */
4010 : !NILP (p->next) ? ((*sizefun) (p->next)
4011 - window_min_size (XWINDOW (p->next),
4012 horiz_flag, 0, 0, 0))
4013 /* This is a minibuffer following a main window. */
4014 : !NILP (p->prev) ? ((*sizefun) (p->prev)
4015 - window_min_size (XWINDOW (p->prev),
4016 horiz_flag, 0, 0, 0))
4017 /* This is a frame with only one window, a minibuffer-only
4018 or a minibufferless frame. */
4019 : (delta = 0));
4021 if (delta > maxdelta)
4022 /* This case traps trying to make the minibuffer
4023 the full frame, or make the only window aside from the
4024 minibuffer the full frame. */
4025 delta = maxdelta;
4028 if (XINT (*sizep) + delta < window_min_size (XWINDOW (window),
4029 horiz_flag, 0, 0, 0))
4031 delete_window (window);
4032 return;
4035 if (delta == 0)
4036 return;
4038 /* Find the total we can get from other siblings without deleting them. */
4039 maximum = 0;
4040 for (next = p->next; WINDOWP (next); next = XWINDOW (next)->next)
4041 maximum += (*sizefun) (next) - window_min_size (XWINDOW (next),
4042 horiz_flag, 0, 0, 0);
4043 for (prev = p->prev; WINDOWP (prev); prev = XWINDOW (prev)->prev)
4044 maximum += (*sizefun) (prev) - window_min_size (XWINDOW (prev),
4045 horiz_flag, 0, 0, 0);
4047 /* If we can get it all from them without deleting them, do so. */
4048 if (delta <= maximum)
4050 Lisp_Object first_unaffected;
4051 Lisp_Object first_affected;
4052 int fixed_p;
4054 next = p->next;
4055 prev = p->prev;
4056 first_affected = window;
4057 /* Look at one sibling at a time,
4058 moving away from this window in both directions alternately,
4059 and take as much as we can get without deleting that sibling. */
4060 while (delta != 0
4061 && (!NILP (next) || !NILP (prev)))
4063 if (! NILP (next))
4065 int this_one = ((*sizefun) (next)
4066 - window_min_size (XWINDOW (next), horiz_flag,
4067 0, 0, &fixed_p));
4068 if (!fixed_p)
4070 if (this_one > delta)
4071 this_one = delta;
4073 (*setsizefun) (next, (*sizefun) (next) - this_one, 0);
4074 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4076 delta -= this_one;
4079 next = XWINDOW (next)->next;
4082 if (delta == 0)
4083 break;
4085 if (! NILP (prev))
4087 int this_one = ((*sizefun) (prev)
4088 - window_min_size (XWINDOW (prev), horiz_flag,
4089 0, 0, &fixed_p));
4090 if (!fixed_p)
4092 if (this_one > delta)
4093 this_one = delta;
4095 first_affected = prev;
4097 (*setsizefun) (prev, (*sizefun) (prev) - this_one, 0);
4098 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4100 delta -= this_one;
4103 prev = XWINDOW (prev)->prev;
4107 xassert (delta == 0);
4109 /* Now recalculate the edge positions of all the windows affected,
4110 based on the new sizes. */
4111 first_unaffected = next;
4112 prev = first_affected;
4113 for (next = XWINDOW (prev)->next; ! EQ (next, first_unaffected);
4114 prev = next, next = XWINDOW (next)->next)
4116 XSETINT (CURBEG (next), XINT (CURBEG (prev)) + (*sizefun) (prev));
4117 /* This does not change size of NEXT,
4118 but it propagates the new top edge to its children */
4119 (*setsizefun) (next, (*sizefun) (next), 0);
4122 else
4124 register int delta1;
4125 register int opht = (*sizefun) (parent);
4127 if (opht <= XINT (*sizep) + delta)
4129 /* If trying to grow this window to or beyond size of the parent,
4130 just delete all the sibling windows. */
4131 Lisp_Object start, tem, next;
4133 start = XWINDOW (parent)->vchild;
4134 if (NILP (start))
4135 start = XWINDOW (parent)->hchild;
4137 /* Delete any siblings that come after WINDOW. */
4138 tem = XWINDOW (window)->next;
4139 while (! NILP (tem))
4141 next = XWINDOW (tem)->next;
4142 delete_window (tem);
4143 tem = next;
4146 /* Delete any siblings that come after WINDOW.
4147 Note that if START is not WINDOW, then WINDOW still
4148 has siblings, so WINDOW has not yet replaced its parent. */
4149 tem = start;
4150 while (! EQ (tem, window))
4152 next = XWINDOW (tem)->next;
4153 delete_window (tem);
4154 tem = next;
4157 else
4159 /* Otherwise, make delta1 just right so that if we add
4160 delta1 lines to this window and to the parent, and then
4161 shrink the parent back to its original size, the new
4162 proportional size of this window will increase by delta.
4164 The function size_window will compute the new height h'
4165 of the window from delta1 as:
4167 e = delta1/n
4168 x = delta1 - delta1/n * n for the 1st resizable child
4169 h' = h + e + x
4171 where n is the number of children that can be resized.
4172 We can ignore x by choosing a delta1 that is a multiple of
4173 n. We want the height of this window to come out as
4175 h' = h + delta
4177 So, delta1 must be
4179 h + e = h + delta
4180 delta1/n = delta
4181 delta1 = n * delta.
4183 The number of children n equals the number of resizable
4184 children of this window + 1 because we know window itself
4185 is resizable (otherwise we would have signaled an error).
4187 This reasoning is not correct when other windows become too
4188 small and shrink_windows refuses to delete them. Below we
4189 use resize_proportionally to work around this problem. */
4191 struct window *w = XWINDOW (window);
4192 Lisp_Object s;
4193 int n = 1;
4195 for (s = w->next; WINDOWP (s); s = XWINDOW (s)->next)
4196 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4197 ++n;
4198 for (s = w->prev; WINDOWP (s); s = XWINDOW (s)->prev)
4199 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4200 ++n;
4202 delta1 = n * delta;
4204 /* Add delta1 lines or columns to this window, and to the parent,
4205 keeping things consistent while not affecting siblings. */
4206 XSETINT (CURSIZE (parent), opht + delta1);
4207 (*setsizefun) (window, XINT (*sizep) + delta1, 0);
4209 /* Squeeze out delta1 lines or columns from our parent,
4210 shrinking this window and siblings proportionately. This
4211 brings parent back to correct size. Delta1 was calculated
4212 so this makes this window the desired size, taking it all
4213 out of the siblings.
4215 Temporarily set resize_proportionally to Qt to assure that,
4216 if necessary, shrink_windows deletes smaller windows rather
4217 than shrink this window. */
4218 w->resize_proportionally = Qt;
4219 (*setsizefun) (parent, opht, 0);
4220 w->resize_proportionally = Qnil;
4224 XSETFASTINT (p->last_modified, 0);
4225 XSETFASTINT (p->last_overlay_modified, 0);
4227 /* Adjust glyph matrices. */
4228 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4232 /* Adjust the size of WINDOW by DELTA, moving only its trailing edge.
4233 HORIZ_FLAG nonzero means adjust the width, moving the right edge.
4234 zero means adjust the height, moving the bottom edge.
4236 Following siblings of the selected window are resized to fulfill
4237 the size request. If they become too small in the process, they
4238 are not deleted; instead, we signal an error. */
4240 static void
4241 adjust_window_trailing_edge (window, delta, horiz_flag)
4242 Lisp_Object window;
4243 int delta, horiz_flag;
4245 Lisp_Object parent, child;
4246 struct window *p;
4247 Lisp_Object old_config = Fcurrent_window_configuration (Qnil);
4248 int delcount = window_deletion_count;
4250 CHECK_WINDOW (window);
4252 /* Give up if this window cannot be resized. */
4253 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
4254 error ("Window is not resizable");
4256 while (1)
4258 Lisp_Object first_parallel = Qnil;
4260 if (NILP (window))
4262 /* This happens if WINDOW on the previous iteration was
4263 at top level of the window tree. */
4264 Fset_window_configuration (old_config);
4265 error ("Specified window edge is fixed");
4268 p = XWINDOW (window);
4269 parent = p->parent;
4271 /* See if this level has windows in parallel in the specified
4272 direction. If so, set FIRST_PARALLEL to the first one. */
4273 if (horiz_flag)
4275 if (! NILP (parent) && !NILP (XWINDOW (parent)->vchild))
4276 first_parallel = XWINDOW (parent)->vchild;
4277 else if (NILP (parent) && !NILP (p->next))
4279 /* Handle the vertical chain of main window and minibuffer
4280 which has no parent. */
4281 first_parallel = window;
4282 while (! NILP (XWINDOW (first_parallel)->prev))
4283 first_parallel = XWINDOW (first_parallel)->prev;
4286 else
4288 if (! NILP (parent) && !NILP (XWINDOW (parent)->hchild))
4289 first_parallel = XWINDOW (parent)->hchild;
4292 /* If this level's succession is in the desired dimension,
4293 and this window is the last one, and there is no higher level,
4294 its trailing edge is fixed. */
4295 if (NILP (XWINDOW (window)->next) && NILP (first_parallel)
4296 && NILP (parent))
4298 Fset_window_configuration (old_config);
4299 error ("Specified window edge is fixed");
4302 /* Don't make this window too small. */
4303 if (XINT (CURSIZE (window)) + delta
4304 < window_min_size_2 (XWINDOW (window), horiz_flag, 0))
4306 Fset_window_configuration (old_config);
4307 error ("Cannot adjust window size as specified");
4310 /* Clear out some redisplay caches. */
4311 XSETFASTINT (p->last_modified, 0);
4312 XSETFASTINT (p->last_overlay_modified, 0);
4314 /* Adjust this window's edge. */
4315 XSETINT (CURSIZE (window),
4316 XINT (CURSIZE (window)) + delta);
4318 /* If this window has following siblings in the desired dimension,
4319 make them smaller, and exit the loop.
4321 (If we reach the top of the tree and can never do this,
4322 we will fail and report an error, above.) */
4323 if (NILP (first_parallel))
4325 if (!NILP (p->next))
4327 /* This may happen for the minibuffer. In that case
4328 the window_deletion_count check below does not work. */
4329 if (XINT (CURSIZE (p->next)) - delta <= 0)
4331 Fset_window_configuration (old_config);
4332 error ("Cannot adjust window size as specified");
4335 XSETINT (CURBEG (p->next),
4336 XINT (CURBEG (p->next)) + delta);
4337 size_window (p->next, XINT (CURSIZE (p->next)) - delta,
4338 horiz_flag, 0, 1, 0);
4339 break;
4342 else
4343 /* Here we have a chain of parallel siblings, in the other dimension.
4344 Change the size of the other siblings. */
4345 for (child = first_parallel;
4346 ! NILP (child);
4347 child = XWINDOW (child)->next)
4348 if (! EQ (child, window))
4349 size_window (child, XINT (CURSIZE (child)) + delta,
4350 horiz_flag, 0, 0, 1);
4352 window = parent;
4355 /* If we made a window so small it got deleted,
4356 we failed. Report failure. */
4357 if (delcount != window_deletion_count)
4359 Fset_window_configuration (old_config);
4360 error ("Cannot adjust window size as specified");
4363 /* Adjust glyph matrices. */
4364 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4367 #undef CURBEG
4368 #undef CURSIZE
4370 DEFUN ("adjust-window-trailing-edge", Fadjust_window_trailing_edge,
4371 Sadjust_window_trailing_edge, 3, 3, 0,
4372 doc: /* Adjust the bottom or right edge of WINDOW by DELTA.
4373 If HORIZONTAL is non-nil, that means adjust the width, moving the right edge.
4374 Otherwise, adjust the height, moving the bottom edge.
4376 Following siblings of the selected window are resized to fulfill
4377 the size request. If they become too small in the process, they
4378 are not deleted; instead, we signal an error. */)
4379 (window, delta, horizontal)
4380 Lisp_Object window, delta, horizontal;
4382 CHECK_NUMBER (delta);
4383 if (NILP (window))
4384 window = selected_window;
4385 adjust_window_trailing_edge (window, XINT (delta), !NILP (horizontal));
4387 run_window_configuration_change_hook
4388 (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4390 return Qnil;
4395 /***********************************************************************
4396 Resizing Mini-Windows
4397 ***********************************************************************/
4399 static void shrink_window_lowest_first P_ ((struct window *, int));
4401 enum save_restore_action
4403 CHECK_ORIG_SIZES,
4404 SAVE_ORIG_SIZES,
4405 RESTORE_ORIG_SIZES
4408 static int save_restore_orig_size P_ ((struct window *,
4409 enum save_restore_action));
4411 /* Shrink windows rooted in window W to HEIGHT. Take the space needed
4412 from lowest windows first. */
4414 static void
4415 shrink_window_lowest_first (w, height)
4416 struct window *w;
4417 int height;
4419 struct window *c;
4420 Lisp_Object child;
4421 int old_height;
4423 xassert (!MINI_WINDOW_P (w));
4425 /* Set redisplay hints. */
4426 XSETFASTINT (w->last_modified, 0);
4427 XSETFASTINT (w->last_overlay_modified, 0);
4428 windows_or_buffers_changed++;
4429 FRAME_WINDOW_SIZES_CHANGED (XFRAME (WINDOW_FRAME (w))) = 1;
4431 old_height = XFASTINT (w->total_lines);
4432 XSETFASTINT (w->total_lines, height);
4434 if (!NILP (w->hchild))
4436 for (child = w->hchild; !NILP (child); child = c->next)
4438 c = XWINDOW (child);
4439 c->top_line = w->top_line;
4440 shrink_window_lowest_first (c, height);
4443 else if (!NILP (w->vchild))
4445 Lisp_Object last_child;
4446 int delta = old_height - height;
4447 int last_top;
4449 last_child = Qnil;
4451 /* Find the last child. We are taking space from lowest windows
4452 first, so we iterate over children from the last child
4453 backwards. */
4454 for (child = w->vchild; WINDOWP (child); child = XWINDOW (child)->next)
4455 last_child = child;
4457 /* Size children down to their safe heights. */
4458 for (child = last_child; delta && !NILP (child); child = c->prev)
4460 int this_one;
4462 c = XWINDOW (child);
4463 this_one = XFASTINT (c->total_lines) - window_min_size_1 (c, 0, 1);
4465 if (this_one > delta)
4466 this_one = delta;
4468 shrink_window_lowest_first (c, XFASTINT (c->total_lines) - this_one);
4469 delta -= this_one;
4472 /* Compute new positions. */
4473 last_top = XINT (w->top_line);
4474 for (child = w->vchild; !NILP (child); child = c->next)
4476 c = XWINDOW (child);
4477 c->top_line = make_number (last_top);
4478 shrink_window_lowest_first (c, XFASTINT (c->total_lines));
4479 last_top += XFASTINT (c->total_lines);
4485 /* Save, restore, or check positions and sizes in the window tree
4486 rooted at W. ACTION says what to do.
4488 If ACTION is CHECK_ORIG_SIZES, check if orig_top_line and
4489 orig_total_lines members are valid for all windows in the window
4490 tree. Value is non-zero if they are valid.
4492 If ACTION is SAVE_ORIG_SIZES, save members top and height in
4493 orig_top_line and orig_total_lines for all windows in the tree.
4495 If ACTION is RESTORE_ORIG_SIZES, restore top and height from values
4496 stored in orig_top_line and orig_total_lines for all windows. */
4498 static int
4499 save_restore_orig_size (w, action)
4500 struct window *w;
4501 enum save_restore_action action;
4503 int success_p = 1;
4505 while (w)
4507 if (!NILP (w->hchild))
4509 if (!save_restore_orig_size (XWINDOW (w->hchild), action))
4510 success_p = 0;
4512 else if (!NILP (w->vchild))
4514 if (!save_restore_orig_size (XWINDOW (w->vchild), action))
4515 success_p = 0;
4518 switch (action)
4520 case CHECK_ORIG_SIZES:
4521 if (!INTEGERP (w->orig_top_line) || !INTEGERP (w->orig_total_lines))
4522 return 0;
4523 break;
4525 case SAVE_ORIG_SIZES:
4526 w->orig_top_line = w->top_line;
4527 w->orig_total_lines = w->total_lines;
4528 XSETFASTINT (w->last_modified, 0);
4529 XSETFASTINT (w->last_overlay_modified, 0);
4530 break;
4532 case RESTORE_ORIG_SIZES:
4533 xassert (INTEGERP (w->orig_top_line) && INTEGERP (w->orig_total_lines));
4534 w->top_line = w->orig_top_line;
4535 w->total_lines = w->orig_total_lines;
4536 w->orig_total_lines = w->orig_top_line = Qnil;
4537 XSETFASTINT (w->last_modified, 0);
4538 XSETFASTINT (w->last_overlay_modified, 0);
4539 break;
4541 default:
4542 abort ();
4545 w = NILP (w->next) ? NULL : XWINDOW (w->next);
4548 return success_p;
4552 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we can
4553 without deleting other windows. */
4555 void
4556 grow_mini_window (w, delta)
4557 struct window *w;
4558 int delta;
4560 struct frame *f = XFRAME (w->frame);
4561 struct window *root;
4563 xassert (MINI_WINDOW_P (w));
4564 xassert (delta >= 0);
4566 /* Compute how much we can enlarge the mini-window without deleting
4567 other windows. */
4568 root = XWINDOW (FRAME_ROOT_WINDOW (f));
4569 if (delta)
4571 int min_height = window_min_size (root, 0, 0, 0, 0);
4572 if (XFASTINT (root->total_lines) - delta < min_height)
4573 /* Note that the root window may already be smaller than
4574 min_height. */
4575 delta = max (0, XFASTINT (root->total_lines) - min_height);
4578 if (delta)
4580 /* Save original window sizes and positions, if not already done. */
4581 if (!save_restore_orig_size (root, CHECK_ORIG_SIZES))
4582 save_restore_orig_size (root, SAVE_ORIG_SIZES);
4584 /* Shrink other windows. */
4585 shrink_window_lowest_first (root, XFASTINT (root->total_lines) - delta);
4587 /* Grow the mini-window. */
4588 w->top_line = make_number (XFASTINT (root->top_line) + XFASTINT (root->total_lines));
4589 w->total_lines = make_number (XFASTINT (w->total_lines) + delta);
4590 XSETFASTINT (w->last_modified, 0);
4591 XSETFASTINT (w->last_overlay_modified, 0);
4593 adjust_glyphs (f);
4598 /* Shrink mini-window W. If there is recorded info about window sizes
4599 before a call to grow_mini_window, restore recorded window sizes.
4600 Otherwise, if the mini-window is higher than 1 line, resize it to 1
4601 line. */
4603 void
4604 shrink_mini_window (w)
4605 struct window *w;
4607 struct frame *f = XFRAME (w->frame);
4608 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
4610 if (save_restore_orig_size (root, CHECK_ORIG_SIZES))
4612 save_restore_orig_size (root, RESTORE_ORIG_SIZES);
4613 adjust_glyphs (f);
4614 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4615 windows_or_buffers_changed = 1;
4617 else if (XFASTINT (w->total_lines) > 1)
4619 /* Distribute the additional lines of the mini-window
4620 among the other windows. */
4621 Lisp_Object window;
4622 XSETWINDOW (window, w);
4623 enlarge_window (window, 1 - XFASTINT (w->total_lines), 0);
4629 /* Mark window cursors off for all windows in the window tree rooted
4630 at W by setting their phys_cursor_on_p flag to zero. Called from
4631 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4632 the frame are cleared. */
4634 void
4635 mark_window_cursors_off (w)
4636 struct window *w;
4638 while (w)
4640 if (!NILP (w->hchild))
4641 mark_window_cursors_off (XWINDOW (w->hchild));
4642 else if (!NILP (w->vchild))
4643 mark_window_cursors_off (XWINDOW (w->vchild));
4644 else
4645 w->phys_cursor_on_p = 0;
4647 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4652 /* Return number of lines of text (not counting mode lines) in W. */
4655 window_internal_height (w)
4656 struct window *w;
4658 int ht = XFASTINT (w->total_lines);
4660 if (!MINI_WINDOW_P (w))
4662 if (!NILP (w->parent)
4663 || !NILP (w->vchild)
4664 || !NILP (w->hchild)
4665 || !NILP (w->next)
4666 || !NILP (w->prev)
4667 || WINDOW_WANTS_MODELINE_P (w))
4668 --ht;
4670 if (WINDOW_WANTS_HEADER_LINE_P (w))
4671 --ht;
4674 return ht;
4678 /* Return the number of columns in W.
4679 Don't count columns occupied by scroll bars or the vertical bar
4680 separating W from the sibling to its right. */
4683 window_box_text_cols (w)
4684 struct window *w;
4686 struct frame *f = XFRAME (WINDOW_FRAME (w));
4687 int width = XINT (w->total_cols);
4689 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
4690 /* Scroll bars occupy a few columns. */
4691 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
4692 else if (!FRAME_WINDOW_P (f)
4693 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
4694 /* The column of `|' characters separating side-by-side windows
4695 occupies one column only. */
4696 width -= 1;
4698 if (FRAME_WINDOW_P (f))
4699 /* On window-systems, fringes and display margins cannot be
4700 used for normal text. */
4701 width -= (WINDOW_FRINGE_COLS (w)
4702 + WINDOW_LEFT_MARGIN_COLS (w)
4703 + WINDOW_RIGHT_MARGIN_COLS (w));
4705 return width;
4709 /************************************************************************
4710 Window Scrolling
4711 ***********************************************************************/
4713 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4714 N screen-fulls, which is defined as the height of the window minus
4715 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4716 instead. Negative values of N mean scroll down. NOERROR non-zero
4717 means don't signal an error if we try to move over BEGV or ZV,
4718 respectively. */
4720 static void
4721 window_scroll (window, n, whole, noerror)
4722 Lisp_Object window;
4723 int n;
4724 int whole;
4725 int noerror;
4727 immediate_quit = 1;
4729 /* If we must, use the pixel-based version which is much slower than
4730 the line-based one but can handle varying line heights. */
4731 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4732 window_scroll_pixel_based (window, n, whole, noerror);
4733 else
4734 window_scroll_line_based (window, n, whole, noerror);
4736 immediate_quit = 0;
4740 /* Implementation of window_scroll that works based on pixel line
4741 heights. See the comment of window_scroll for parameter
4742 descriptions. */
4744 static void
4745 window_scroll_pixel_based (window, n, whole, noerror)
4746 Lisp_Object window;
4747 int n;
4748 int whole;
4749 int noerror;
4751 struct it it;
4752 struct window *w = XWINDOW (window);
4753 struct text_pos start;
4754 int this_scroll_margin;
4755 /* True if we fiddled the window vscroll field without really scrolling. */
4756 int vscrolled = 0;
4757 int x, y, rtop, rbot, rowh, vpos;
4759 SET_TEXT_POS_FROM_MARKER (start, w->start);
4761 /* If PT is not visible in WINDOW, move back one half of
4762 the screen. Allow PT to be partially visible, otherwise
4763 something like (scroll-down 1) with PT in the line before
4764 the partially visible one would recenter. */
4766 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4768 /* Move backward half the height of the window. Performance note:
4769 vmotion used here is about 10% faster, but would give wrong
4770 results for variable height lines. */
4771 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4772 it.current_y = it.last_visible_y;
4773 move_it_vertically_backward (&it, window_box_height (w) / 2);
4775 /* The function move_iterator_vertically may move over more than
4776 the specified y-distance. If it->w is small, e.g. a
4777 mini-buffer window, we may end up in front of the window's
4778 display area. This is the case when Start displaying at the
4779 start of the line containing PT in this case. */
4780 if (it.current_y <= 0)
4782 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4783 move_it_vertically_backward (&it, 0);
4784 it.current_y = 0;
4787 start = it.current.pos;
4789 else if (auto_window_vscroll_p)
4791 if (rtop || rbot) /* partially visible */
4793 int px;
4794 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4795 if (whole)
4796 dy = max ((window_box_height (w)
4797 - next_screen_context_lines * dy),
4798 dy);
4799 dy *= n;
4801 if (n < 0)
4803 /* Only vscroll backwards if already vscrolled forwards. */
4804 if (w->vscroll < 0 && rtop > 0)
4806 px = max (0, -w->vscroll - min (rtop, -dy));
4807 Fset_window_vscroll (window, make_number (px), Qt);
4808 return;
4811 if (n > 0)
4813 /* Do vscroll if already vscrolled or only display line. */
4814 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4816 px = max (0, -w->vscroll + min (rbot, dy));
4817 Fset_window_vscroll (window, make_number (px), Qt);
4818 return;
4821 /* Maybe modify window start instead of scrolling. */
4822 if (rbot > 0 || w->vscroll < 0)
4824 int spos;
4826 Fset_window_vscroll (window, make_number (0), Qt);
4827 /* If there are other text lines above the current row,
4828 move window start to current row. Else to next row. */
4829 if (rbot > 0)
4830 spos = XINT (Fline_beginning_position (Qnil));
4831 else
4832 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4833 set_marker_restricted (w->start, make_number (spos),
4834 w->buffer);
4835 w->start_at_line_beg = Qt;
4836 w->update_mode_line = Qt;
4837 XSETFASTINT (w->last_modified, 0);
4838 XSETFASTINT (w->last_overlay_modified, 0);
4839 /* Set force_start so that redisplay_window will run the
4840 window-scroll-functions. */
4841 w->force_start = Qt;
4842 return;
4846 /* Cancel previous vscroll. */
4847 Fset_window_vscroll (window, make_number (0), Qt);
4850 /* If scroll_preserve_screen_position is non-nil, we try to set
4851 point in the same window line as it is now, so get that line. */
4852 if (!NILP (Vscroll_preserve_screen_position))
4854 /* We preserve the goal pixel coordinate across consecutive
4855 calls to scroll-up or scroll-down. This avoids the
4856 possibility of point becoming "stuck" on a tall line when
4857 scrolling by one line. */
4858 if (window_scroll_pixel_based_preserve_y < 0
4859 || (!EQ (current_kboard->Vlast_command, Qscroll_up)
4860 && !EQ (current_kboard->Vlast_command, Qscroll_down)))
4862 start_display (&it, w, start);
4863 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4864 window_scroll_pixel_based_preserve_y = it.current_y;
4865 window_scroll_pixel_based_preserve_x = it.current_x;
4868 else
4869 window_scroll_pixel_based_preserve_y
4870 = window_scroll_pixel_based_preserve_x = -1;
4872 /* Move iterator it from start the specified distance forward or
4873 backward. The result is the new window start. */
4874 start_display (&it, w, start);
4875 if (whole)
4877 int start_pos = IT_CHARPOS (it);
4878 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4879 dy = max ((window_box_height (w)
4880 - next_screen_context_lines * dy),
4881 dy) * n;
4883 /* Note that move_it_vertically always moves the iterator to the
4884 start of a line. So, if the last line doesn't have a newline,
4885 we would end up at the start of the line ending at ZV. */
4886 if (dy <= 0)
4888 move_it_vertically_backward (&it, -dy);
4889 /* Ensure we actually do move, e.g. in case we are currently
4890 looking at an image that is taller that the window height. */
4891 while (start_pos == IT_CHARPOS (it)
4892 && start_pos > BEGV)
4893 move_it_by_lines (&it, -1, 1);
4895 else if (dy > 0)
4897 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4898 MOVE_TO_POS | MOVE_TO_Y);
4899 /* Ensure we actually do move, e.g. in case we are currently
4900 looking at an image that is taller that the window height. */
4901 while (start_pos == IT_CHARPOS (it)
4902 && start_pos < ZV)
4903 move_it_by_lines (&it, 1, 1);
4906 else
4907 move_it_by_lines (&it, n, 1);
4909 /* We failed if we find ZV is already on the screen (scrolling up,
4910 means there's nothing past the end), or if we can't start any
4911 earlier (scrolling down, means there's nothing past the top). */
4912 if ((n > 0 && IT_CHARPOS (it) == ZV)
4913 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4915 if (IT_CHARPOS (it) == ZV)
4917 if (it.current_y < it.last_visible_y
4918 && (it.current_y + it.max_ascent + it.max_descent
4919 > it.last_visible_y))
4921 /* The last line was only partially visible, make it fully
4922 visible. */
4923 w->vscroll = (it.last_visible_y
4924 - it.current_y + it.max_ascent + it.max_descent);
4925 adjust_glyphs (it.f);
4927 else if (noerror)
4928 return;
4929 else if (n < 0) /* could happen with empty buffers */
4930 xsignal0 (Qbeginning_of_buffer);
4931 else
4932 xsignal0 (Qend_of_buffer);
4934 else
4936 if (w->vscroll != 0)
4937 /* The first line was only partially visible, make it fully
4938 visible. */
4939 w->vscroll = 0;
4940 else if (noerror)
4941 return;
4942 else
4943 xsignal0 (Qbeginning_of_buffer);
4946 /* If control gets here, then we vscrolled. */
4948 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4950 /* Don't try to change the window start below. */
4951 vscrolled = 1;
4954 if (! vscrolled)
4956 int pos = IT_CHARPOS (it);
4957 int bytepos;
4959 /* If in the middle of a multi-glyph character move forward to
4960 the next character. */
4961 if (in_display_vector_p (&it))
4963 ++pos;
4964 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4967 /* Set the window start, and set up the window for redisplay. */
4968 set_marker_restricted (w->start, make_number (pos),
4969 w->buffer);
4970 bytepos = XMARKER (w->start)->bytepos;
4971 w->start_at_line_beg = ((pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n')
4972 ? Qt : Qnil);
4973 w->update_mode_line = Qt;
4974 XSETFASTINT (w->last_modified, 0);
4975 XSETFASTINT (w->last_overlay_modified, 0);
4976 /* Set force_start so that redisplay_window will run the
4977 window-scroll-functions. */
4978 w->force_start = Qt;
4981 /* The rest of this function uses current_y in a nonstandard way,
4982 not including the height of the header line if any. */
4983 it.current_y = it.vpos = 0;
4985 /* Move PT out of scroll margins.
4986 This code wants current_y to be zero at the window start position
4987 even if there is a header line. */
4988 this_scroll_margin = max (0, scroll_margin);
4989 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
4990 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
4992 if (n > 0)
4994 /* We moved the window start towards ZV, so PT may be now
4995 in the scroll margin at the top. */
4996 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4997 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
4998 && (NILP (Vscroll_preserve_screen_position)
4999 || EQ (Vscroll_preserve_screen_position, Qt)))
5000 /* We found PT at a legitimate height. Leave it alone. */
5002 else if (window_scroll_pixel_based_preserve_y >= 0)
5004 /* If we have a header line, take account of it.
5005 This is necessary because we set it.current_y to 0, above. */
5006 move_it_to (&it, -1,
5007 window_scroll_pixel_based_preserve_x,
5008 window_scroll_pixel_based_preserve_y
5009 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
5010 -1, MOVE_TO_Y | MOVE_TO_X);
5011 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5013 else
5015 while (it.current_y < this_scroll_margin)
5017 int prev = it.current_y;
5018 move_it_by_lines (&it, 1, 1);
5019 if (prev == it.current_y)
5020 break;
5022 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5025 else if (n < 0)
5027 int charpos, bytepos;
5028 int partial_p;
5030 /* Save our position, for the
5031 window_scroll_pixel_based_preserve_y case. */
5032 charpos = IT_CHARPOS (it);
5033 bytepos = IT_BYTEPOS (it);
5035 /* We moved the window start towards BEGV, so PT may be now
5036 in the scroll margin at the bottom. */
5037 move_it_to (&it, PT, -1,
5038 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
5039 - this_scroll_margin - 1),
5041 MOVE_TO_POS | MOVE_TO_Y);
5043 /* Save our position, in case it's correct. */
5044 charpos = IT_CHARPOS (it);
5045 bytepos = IT_BYTEPOS (it);
5047 /* See if point is on a partially visible line at the end. */
5048 if (it.what == IT_EOB)
5049 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
5050 else
5052 move_it_by_lines (&it, 1, 1);
5053 partial_p = it.current_y > it.last_visible_y;
5056 if (charpos == PT && !partial_p
5057 && (NILP (Vscroll_preserve_screen_position)
5058 || EQ (Vscroll_preserve_screen_position, Qt)))
5059 /* We found PT before we found the display margin, so PT is ok. */
5061 else if (window_scroll_pixel_based_preserve_y >= 0)
5063 SET_TEXT_POS_FROM_MARKER (start, w->start);
5064 start_display (&it, w, start);
5065 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
5066 here because we called start_display again and did not
5067 alter it.current_y this time. */
5068 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
5069 window_scroll_pixel_based_preserve_y, -1,
5070 MOVE_TO_Y | MOVE_TO_X);
5071 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5073 else
5075 if (partial_p)
5076 /* The last line was only partially visible, so back up two
5077 lines to make sure we're on a fully visible line. */
5079 move_it_by_lines (&it, -2, 0);
5080 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5082 else
5083 /* No, the position we saved is OK, so use it. */
5084 SET_PT_BOTH (charpos, bytepos);
5090 /* Implementation of window_scroll that works based on screen lines.
5091 See the comment of window_scroll for parameter descriptions. */
5093 static void
5094 window_scroll_line_based (window, n, whole, noerror)
5095 Lisp_Object window;
5096 int n;
5097 int whole;
5098 int noerror;
5100 register struct window *w = XWINDOW (window);
5101 register int opoint = PT, opoint_byte = PT_BYTE;
5102 register int pos, pos_byte;
5103 register int ht = window_internal_height (w);
5104 register Lisp_Object tem;
5105 int lose;
5106 Lisp_Object bolp;
5107 int startpos;
5108 Lisp_Object original_pos = Qnil;
5110 /* If scrolling screen-fulls, compute the number of lines to
5111 scroll from the window's height. */
5112 if (whole)
5113 n *= max (1, ht - next_screen_context_lines);
5115 startpos = marker_position (w->start);
5117 if (!NILP (Vscroll_preserve_screen_position))
5119 if (window_scroll_preserve_vpos <= 0
5120 || (!EQ (current_kboard->Vlast_command, Qscroll_up)
5121 && !EQ (current_kboard->Vlast_command, Qscroll_down)))
5123 struct position posit
5124 = *compute_motion (startpos, 0, 0, 0,
5125 PT, ht, 0,
5126 -1, XINT (w->hscroll),
5127 0, w);
5128 window_scroll_preserve_vpos = posit.vpos;
5129 window_scroll_preserve_hpos = posit.hpos + XINT (w->hscroll);
5132 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
5133 make_number (window_scroll_preserve_vpos));
5136 XSETFASTINT (tem, PT);
5137 tem = Fpos_visible_in_window_p (tem, window, Qnil);
5139 if (NILP (tem))
5141 Fvertical_motion (make_number (- (ht / 2)), window);
5142 startpos = PT;
5145 SET_PT (startpos);
5146 lose = n < 0 && PT == BEGV;
5147 Fvertical_motion (make_number (n), window);
5148 pos = PT;
5149 pos_byte = PT_BYTE;
5150 bolp = Fbolp ();
5151 SET_PT_BOTH (opoint, opoint_byte);
5153 if (lose)
5155 if (noerror)
5156 return;
5157 else
5158 xsignal0 (Qbeginning_of_buffer);
5161 if (pos < ZV)
5163 int this_scroll_margin = scroll_margin;
5165 /* Don't use a scroll margin that is negative or too large. */
5166 if (this_scroll_margin < 0)
5167 this_scroll_margin = 0;
5169 if (XINT (w->total_lines) < 4 * scroll_margin)
5170 this_scroll_margin = XINT (w->total_lines) / 4;
5172 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
5173 w->start_at_line_beg = bolp;
5174 w->update_mode_line = Qt;
5175 XSETFASTINT (w->last_modified, 0);
5176 XSETFASTINT (w->last_overlay_modified, 0);
5177 /* Set force_start so that redisplay_window will run
5178 the window-scroll-functions. */
5179 w->force_start = Qt;
5181 if (!NILP (Vscroll_preserve_screen_position)
5182 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
5184 SET_PT_BOTH (pos, pos_byte);
5185 Fvertical_motion (original_pos, window);
5187 /* If we scrolled forward, put point enough lines down
5188 that it is outside the scroll margin. */
5189 else if (n > 0)
5191 int top_margin;
5193 if (this_scroll_margin > 0)
5195 SET_PT_BOTH (pos, pos_byte);
5196 Fvertical_motion (make_number (this_scroll_margin), window);
5197 top_margin = PT;
5199 else
5200 top_margin = pos;
5202 if (top_margin <= opoint)
5203 SET_PT_BOTH (opoint, opoint_byte);
5204 else if (!NILP (Vscroll_preserve_screen_position))
5206 SET_PT_BOTH (pos, pos_byte);
5207 Fvertical_motion (original_pos, window);
5209 else
5210 SET_PT (top_margin);
5212 else if (n < 0)
5214 int bottom_margin;
5216 /* If we scrolled backward, put point near the end of the window
5217 but not within the scroll margin. */
5218 SET_PT_BOTH (pos, pos_byte);
5219 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
5220 if (XFASTINT (tem) == ht - this_scroll_margin)
5221 bottom_margin = PT;
5222 else
5223 bottom_margin = PT + 1;
5225 if (bottom_margin > opoint)
5226 SET_PT_BOTH (opoint, opoint_byte);
5227 else
5229 if (!NILP (Vscroll_preserve_screen_position))
5231 SET_PT_BOTH (pos, pos_byte);
5232 Fvertical_motion (original_pos, window);
5234 else
5235 Fvertical_motion (make_number (-1), window);
5239 else
5241 if (noerror)
5242 return;
5243 else
5244 xsignal0 (Qend_of_buffer);
5249 /* Scroll selected_window up or down. If N is nil, scroll a
5250 screen-full which is defined as the height of the window minus
5251 next_screen_context_lines. If N is the symbol `-', scroll.
5252 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
5253 up. This is the guts of Fscroll_up and Fscroll_down. */
5255 static void
5256 scroll_command (n, direction)
5257 Lisp_Object n;
5258 int direction;
5260 int count = SPECPDL_INDEX ();
5262 xassert (eabs (direction) == 1);
5264 /* If selected window's buffer isn't current, make it current for
5265 the moment. But don't screw up if window_scroll gets an error. */
5266 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
5268 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5269 Fset_buffer (XWINDOW (selected_window)->buffer);
5271 /* Make redisplay consider other windows than just selected_window. */
5272 ++windows_or_buffers_changed;
5275 if (NILP (n))
5276 window_scroll (selected_window, direction, 1, 0);
5277 else if (EQ (n, Qminus))
5278 window_scroll (selected_window, -direction, 1, 0);
5279 else
5281 n = Fprefix_numeric_value (n);
5282 window_scroll (selected_window, XINT (n) * direction, 0, 0);
5285 unbind_to (count, Qnil);
5288 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
5289 doc: /* Scroll text of current window upward ARG lines.
5290 If ARG is omitted or nil, scroll upward by a near full screen.
5291 A near full screen is `next-screen-context-lines' less than a full screen.
5292 Negative ARG means scroll downward.
5293 If ARG is the atom `-', scroll downward by nearly full screen.
5294 When calling from a program, supply as argument a number, nil, or `-'. */)
5295 (arg)
5296 Lisp_Object arg;
5298 scroll_command (arg, 1);
5299 return Qnil;
5302 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
5303 doc: /* Scroll text of current window down ARG lines.
5304 If ARG is omitted or nil, scroll down by a near full screen.
5305 A near full screen is `next-screen-context-lines' less than a full screen.
5306 Negative ARG means scroll upward.
5307 If ARG is the atom `-', scroll upward by nearly full screen.
5308 When calling from a program, supply as argument a number, nil, or `-'. */)
5309 (arg)
5310 Lisp_Object arg;
5312 scroll_command (arg, -1);
5313 return Qnil;
5316 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
5317 doc: /* Return the other window for \"other window scroll\" commands.
5318 If `other-window-scroll-buffer' is non-nil, a window
5319 showing that buffer is used.
5320 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5321 specifies the window. This takes precedence over
5322 `other-window-scroll-buffer'. */)
5325 Lisp_Object window;
5327 if (MINI_WINDOW_P (XWINDOW (selected_window))
5328 && !NILP (Vminibuf_scroll_window))
5329 window = Vminibuf_scroll_window;
5330 /* If buffer is specified, scroll that buffer. */
5331 else if (!NILP (Vother_window_scroll_buffer))
5333 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
5334 if (NILP (window))
5335 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
5337 else
5339 /* Nothing specified; look for a neighboring window on the same
5340 frame. */
5341 window = Fnext_window (selected_window, Qnil, Qnil);
5343 if (EQ (window, selected_window))
5344 /* That didn't get us anywhere; look for a window on another
5345 visible frame. */
5347 window = Fnext_window (window, Qnil, Qt);
5348 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
5349 && ! EQ (window, selected_window));
5352 CHECK_LIVE_WINDOW (window);
5354 if (EQ (window, selected_window))
5355 error ("There is no other window");
5357 return window;
5360 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
5361 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5362 A near full screen is `next-screen-context-lines' less than a full screen.
5363 The next window is the one below the current one; or the one at the top
5364 if the current one is at the bottom. Negative ARG means scroll downward.
5365 If ARG is the atom `-', scroll downward by nearly full screen.
5366 When calling from a program, supply as argument a number, nil, or `-'.
5368 If `other-window-scroll-buffer' is non-nil, scroll the window
5369 showing that buffer, popping the buffer up if necessary.
5370 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5371 specifies the window to scroll. This takes precedence over
5372 `other-window-scroll-buffer'. */)
5373 (arg)
5374 Lisp_Object arg;
5376 Lisp_Object window;
5377 struct window *w;
5378 int count = SPECPDL_INDEX ();
5380 window = Fother_window_for_scrolling ();
5381 w = XWINDOW (window);
5383 /* Don't screw up if window_scroll gets an error. */
5384 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5385 ++windows_or_buffers_changed;
5387 Fset_buffer (w->buffer);
5388 SET_PT (marker_position (w->pointm));
5390 if (NILP (arg))
5391 window_scroll (window, 1, 1, 1);
5392 else if (EQ (arg, Qminus))
5393 window_scroll (window, -1, 1, 1);
5394 else
5396 if (CONSP (arg))
5397 arg = Fcar (arg);
5398 CHECK_NUMBER (arg);
5399 window_scroll (window, XINT (arg), 0, 1);
5402 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5403 unbind_to (count, Qnil);
5405 return Qnil;
5408 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5409 doc: /* Scroll selected window display ARG columns left.
5410 Default for ARG is window width minus 2.
5411 Value is the total amount of leftward horizontal scrolling in
5412 effect after the change.
5413 If SET_MINIMUM is non-nil, the new scroll amount becomes the
5414 lower bound for automatic scrolling, i.e. automatic scrolling
5415 will not scroll a window to a column less than the value returned
5416 by this function. This happens in an interactive call. */)
5417 (arg, set_minimum)
5418 register Lisp_Object arg, set_minimum;
5420 Lisp_Object result;
5421 int hscroll;
5422 struct window *w = XWINDOW (selected_window);
5424 if (NILP (arg))
5425 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5426 else
5427 arg = Fprefix_numeric_value (arg);
5429 hscroll = XINT (w->hscroll) + XINT (arg);
5430 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5432 if (!NILP (set_minimum))
5433 w->min_hscroll = w->hscroll;
5435 return result;
5438 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5439 doc: /* Scroll selected window display ARG columns right.
5440 Default for ARG is window width minus 2.
5441 Value is the total amount of leftward horizontal scrolling in
5442 effect after the change.
5443 If SET_MINIMUM is non-nil, the new scroll amount becomes the
5444 lower bound for automatic scrolling, i.e. automatic scrolling
5445 will not scroll a window to a column less than the value returned
5446 by this function. This happens in an interactive call. */)
5447 (arg, set_minimum)
5448 register Lisp_Object arg, set_minimum;
5450 Lisp_Object result;
5451 int hscroll;
5452 struct window *w = XWINDOW (selected_window);
5454 if (NILP (arg))
5455 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5456 else
5457 arg = Fprefix_numeric_value (arg);
5459 hscroll = XINT (w->hscroll) - XINT (arg);
5460 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5462 if (!NILP (set_minimum))
5463 w->min_hscroll = w->hscroll;
5465 return result;
5468 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5469 doc: /* Return the window which was selected when entering the minibuffer.
5470 Returns nil, if current window is not a minibuffer window. */)
5473 if (minibuf_level > 0
5474 && MINI_WINDOW_P (XWINDOW (selected_window))
5475 && WINDOW_LIVE_P (minibuf_selected_window))
5476 return minibuf_selected_window;
5478 return Qnil;
5481 /* Value is the number of lines actually displayed in window W,
5482 as opposed to its height. */
5484 static int
5485 displayed_window_lines (w)
5486 struct window *w;
5488 struct it it;
5489 struct text_pos start;
5490 int height = window_box_height (w);
5491 struct buffer *old_buffer;
5492 int bottom_y;
5494 if (XBUFFER (w->buffer) != current_buffer)
5496 old_buffer = current_buffer;
5497 set_buffer_internal (XBUFFER (w->buffer));
5499 else
5500 old_buffer = NULL;
5502 /* In case W->start is out of the accessible range, do something
5503 reasonable. This happens in Info mode when Info-scroll-down
5504 calls (recenter -1) while W->start is 1. */
5505 if (XMARKER (w->start)->charpos < BEGV)
5506 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
5507 else if (XMARKER (w->start)->charpos > ZV)
5508 SET_TEXT_POS (start, ZV, ZV_BYTE);
5509 else
5510 SET_TEXT_POS_FROM_MARKER (start, w->start);
5512 start_display (&it, w, start);
5513 move_it_vertically (&it, height);
5514 bottom_y = line_bottom_y (&it);
5516 /* rms: On a non-window display,
5517 the value of it.vpos at the bottom of the screen
5518 seems to be 1 larger than window_box_height (w).
5519 This kludge fixes a bug whereby (move-to-window-line -1)
5520 when ZV is on the last screen line
5521 moves to the previous screen line instead of the last one. */
5522 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5523 height++;
5525 /* Add in empty lines at the bottom of the window. */
5526 if (bottom_y < height)
5528 int uy = FRAME_LINE_HEIGHT (it.f);
5529 it.vpos += (height - bottom_y + uy - 1) / uy;
5532 if (old_buffer)
5533 set_buffer_internal (old_buffer);
5535 return it.vpos;
5539 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5540 doc: /* Center point in window and redisplay frame.
5541 With prefix argument ARG, recenter putting point on screen line ARG
5542 relative to the current window. If ARG is negative, it counts up from the
5543 bottom of the window. (ARG should be less than the height of the window.)
5545 If ARG is omitted or nil, erase the entire frame and then redraw with point
5546 in the center of the current window. If `auto-resize-tool-bars' is set to
5547 `grow-only', this resets the tool-bar's height to the minimum height needed.
5549 Just C-u as prefix means put point in the center of the window
5550 and redisplay normally--don't erase and redraw the frame. */)
5551 (arg)
5552 register Lisp_Object arg;
5554 struct window *w = XWINDOW (selected_window);
5555 struct buffer *buf = XBUFFER (w->buffer);
5556 struct buffer *obuf = current_buffer;
5557 int center_p = 0;
5558 int charpos, bytepos;
5559 int iarg;
5560 int this_scroll_margin;
5562 /* If redisplay is suppressed due to an error, try again. */
5563 obuf->display_error_modiff = 0;
5565 if (NILP (arg))
5567 int i;
5569 /* Invalidate pixel data calculated for all compositions. */
5570 for (i = 0; i < n_compositions; i++)
5571 composition_table[i]->font = NULL;
5573 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5575 Fredraw_frame (WINDOW_FRAME (w));
5576 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5577 center_p = 1;
5579 else if (CONSP (arg)) /* Just C-u. */
5580 center_p = 1;
5581 else
5583 arg = Fprefix_numeric_value (arg);
5584 CHECK_NUMBER (arg);
5585 iarg = XINT (arg);
5588 set_buffer_internal (buf);
5590 /* Do this after making BUF current
5591 in case scroll_margin is buffer-local. */
5592 this_scroll_margin = max (0, scroll_margin);
5593 this_scroll_margin = min (this_scroll_margin,
5594 XFASTINT (w->total_lines) / 4);
5596 /* Handle centering on a graphical frame specially. Such frames can
5597 have variable-height lines and centering point on the basis of
5598 line counts would lead to strange effects. */
5599 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5601 if (center_p)
5603 struct it it;
5604 struct text_pos pt;
5606 SET_TEXT_POS (pt, PT, PT_BYTE);
5607 start_display (&it, w, pt);
5608 move_it_vertically_backward (&it, window_box_height (w) / 2);
5609 charpos = IT_CHARPOS (it);
5610 bytepos = IT_BYTEPOS (it);
5612 else if (iarg < 0)
5614 struct it it;
5615 struct text_pos pt;
5616 int nlines = -iarg;
5617 int extra_line_spacing;
5618 int h = window_box_height (w);
5620 iarg = - max (-iarg, this_scroll_margin);
5622 SET_TEXT_POS (pt, PT, PT_BYTE);
5623 start_display (&it, w, pt);
5625 /* Be sure we have the exact height of the full line containing PT. */
5626 move_it_by_lines (&it, 0, 1);
5628 /* The amount of pixels we have to move back is the window
5629 height minus what's displayed in the line containing PT,
5630 and the lines below. */
5631 it.current_y = 0;
5632 it.vpos = 0;
5633 move_it_by_lines (&it, nlines, 1);
5635 if (it.vpos == nlines)
5636 h -= it.current_y;
5637 else
5639 /* Last line has no newline */
5640 h -= line_bottom_y (&it);
5641 it.vpos++;
5644 /* Don't reserve space for extra line spacing of last line. */
5645 extra_line_spacing = it.max_extra_line_spacing;
5647 /* If we can't move down NLINES lines because we hit
5648 the end of the buffer, count in some empty lines. */
5649 if (it.vpos < nlines)
5651 nlines -= it.vpos;
5652 extra_line_spacing = it.extra_line_spacing;
5653 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5655 if (h <= 0)
5656 return Qnil;
5658 /* Now find the new top line (starting position) of the window. */
5659 start_display (&it, w, pt);
5660 it.current_y = 0;
5661 move_it_vertically_backward (&it, h);
5663 /* If extra line spacing is present, we may move too far
5664 back. This causes the last line to be only partially
5665 visible (which triggers redisplay to recenter that line
5666 in the middle), so move forward.
5667 But ignore extra line spacing on last line, as it is not
5668 considered to be part of the visible height of the line.
5670 h += extra_line_spacing;
5671 while (-it.current_y > h)
5672 move_it_by_lines (&it, 1, 1);
5674 charpos = IT_CHARPOS (it);
5675 bytepos = IT_BYTEPOS (it);
5677 else
5679 struct position pos;
5681 iarg = max (iarg, this_scroll_margin);
5683 pos = *vmotion (PT, -iarg, w);
5684 charpos = pos.bufpos;
5685 bytepos = pos.bytepos;
5688 else
5690 struct position pos;
5691 int ht = window_internal_height (w);
5693 if (center_p)
5694 iarg = ht / 2;
5695 else if (iarg < 0)
5696 iarg += ht;
5698 /* Don't let it get into the margin at either top or bottom. */
5699 iarg = max (iarg, this_scroll_margin);
5700 iarg = min (iarg, ht - this_scroll_margin - 1);
5702 pos = *vmotion (PT, - iarg, w);
5703 charpos = pos.bufpos;
5704 bytepos = pos.bytepos;
5707 /* Set the new window start. */
5708 set_marker_both (w->start, w->buffer, charpos, bytepos);
5709 w->window_end_valid = Qnil;
5711 w->optional_new_start = Qt;
5713 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
5714 w->start_at_line_beg = Qt;
5715 else
5716 w->start_at_line_beg = Qnil;
5718 set_buffer_internal (obuf);
5719 return Qnil;
5723 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5724 0, 1, 0,
5725 doc: /* Return the height in lines of the text display area of WINDOW.
5726 WINDOW defaults to the selected window.
5727 This doesn't include the mode-line (or header-line if any) or any
5728 partial-height lines in the text display area. */)
5729 (window)
5730 Lisp_Object window;
5732 struct window *w = decode_window (window);
5733 int pixel_height = window_box_height (w);
5734 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5735 return make_number (line_height);
5740 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5741 1, 1, "P",
5742 doc: /* Position point relative to window.
5743 With no argument, position point at center of window.
5744 An argument specifies vertical position within the window;
5745 zero means top of window, negative means relative to bottom of window. */)
5746 (arg)
5747 Lisp_Object arg;
5749 struct window *w = XWINDOW (selected_window);
5750 int lines, start;
5751 Lisp_Object window;
5752 #if 0
5753 int this_scroll_margin;
5754 #endif
5756 window = selected_window;
5757 start = marker_position (w->start);
5758 if (start < BEGV || start > ZV)
5760 int height = window_internal_height (w);
5761 Fvertical_motion (make_number (- (height / 2)), window);
5762 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
5763 w->start_at_line_beg = Fbolp ();
5764 w->force_start = Qt;
5766 else
5767 Fgoto_char (w->start);
5769 lines = displayed_window_lines (w);
5771 #if 0
5772 this_scroll_margin = max (0, scroll_margin);
5773 this_scroll_margin = min (this_scroll_margin, lines / 4);
5774 #endif
5776 if (NILP (arg))
5777 XSETFASTINT (arg, lines / 2);
5778 else
5780 int iarg = XINT (Fprefix_numeric_value (arg));
5782 if (iarg < 0)
5783 iarg = iarg + lines;
5785 #if 0 /* This code would prevent move-to-window-line from moving point
5786 to a place inside the scroll margins (which would cause the
5787 next redisplay to scroll). I wrote this code, but then concluded
5788 it is probably better not to install it. However, it is here
5789 inside #if 0 so as not to lose it. -- rms. */
5791 /* Don't let it get into the margin at either top or bottom. */
5792 iarg = max (iarg, this_scroll_margin);
5793 iarg = min (iarg, lines - this_scroll_margin - 1);
5794 #endif
5796 arg = make_number (iarg);
5799 /* Skip past a partially visible first line. */
5800 if (w->vscroll)
5801 XSETINT (arg, XINT (arg) + 1);
5803 return Fvertical_motion (arg, window);
5808 /***********************************************************************
5809 Window Configuration
5810 ***********************************************************************/
5812 struct save_window_data
5814 EMACS_UINT size;
5815 struct Lisp_Vector *next_from_Lisp_Vector_struct;
5816 Lisp_Object selected_frame;
5817 Lisp_Object current_window;
5818 Lisp_Object current_buffer;
5819 Lisp_Object minibuf_scroll_window;
5820 Lisp_Object minibuf_selected_window;
5821 Lisp_Object root_window;
5822 Lisp_Object focus_frame;
5823 /* A vector, each of whose elements is a struct saved_window
5824 for one window. */
5825 Lisp_Object saved_windows;
5827 /* All fields above are traced by the GC.
5828 From `fame-cols' down, the fields are ignored by the GC. */
5830 int frame_cols, frame_lines, frame_menu_bar_lines;
5831 int frame_tool_bar_lines;
5834 /* This is saved as a Lisp_Vector */
5835 struct saved_window
5837 /* these first two must agree with struct Lisp_Vector in lisp.h */
5838 EMACS_UINT size;
5839 struct Lisp_Vector *next_from_Lisp_Vector_struct;
5841 Lisp_Object window;
5842 Lisp_Object buffer, start, pointm, mark;
5843 Lisp_Object left_col, top_line, total_cols, total_lines;
5844 Lisp_Object hscroll, min_hscroll;
5845 Lisp_Object parent, prev;
5846 Lisp_Object start_at_line_beg;
5847 Lisp_Object display_table;
5848 Lisp_Object orig_top_line, orig_total_lines;
5849 Lisp_Object left_margin_cols, right_margin_cols;
5850 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5851 Lisp_Object scroll_bar_width, vertical_scroll_bar_type;
5852 Lisp_Object dedicated, resize_proportionally;
5855 #define SAVED_WINDOW_N(swv,n) \
5856 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5858 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5859 doc: /* Return t if OBJECT is a window-configuration object. */)
5860 (object)
5861 Lisp_Object object;
5863 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
5866 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5867 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5868 (config)
5869 Lisp_Object config;
5871 register struct save_window_data *data;
5872 struct Lisp_Vector *saved_windows;
5874 CHECK_WINDOW_CONFIGURATION (config);
5876 data = (struct save_window_data *) XVECTOR (config);
5877 saved_windows = XVECTOR (data->saved_windows);
5878 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5881 DEFUN ("set-window-configuration", Fset_window_configuration,
5882 Sset_window_configuration, 1, 1, 0,
5883 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5884 CONFIGURATION must be a value previously returned
5885 by `current-window-configuration' (which see).
5886 If CONFIGURATION was made from a frame that is now deleted,
5887 only frame-independent values can be restored. In this case,
5888 the return value is nil. Otherwise the value is t. */)
5889 (configuration)
5890 Lisp_Object configuration;
5892 register struct save_window_data *data;
5893 struct Lisp_Vector *saved_windows;
5894 Lisp_Object new_current_buffer;
5895 Lisp_Object frame;
5896 FRAME_PTR f;
5897 int old_point = -1;
5899 CHECK_WINDOW_CONFIGURATION (configuration);
5901 data = (struct save_window_data *) XVECTOR (configuration);
5902 saved_windows = XVECTOR (data->saved_windows);
5904 new_current_buffer = data->current_buffer;
5905 if (NILP (XBUFFER (new_current_buffer)->name))
5906 new_current_buffer = Qnil;
5907 else
5909 if (XBUFFER (new_current_buffer) == current_buffer)
5910 /* The code further down "preserves point" by saving here PT in
5911 old_point and then setting it later back into PT. When the
5912 current-selected-window and the final-selected-window both show
5913 the current buffer, this suffers from the problem that the
5914 current PT is the window-point of the current-selected-window,
5915 while the final PT is the point of the final-selected-window, so
5916 this copy from one PT to the other would end up moving the
5917 window-point of the final-selected-window to the window-point of
5918 the current-selected-window. So we have to be careful which
5919 point of the current-buffer we copy into old_point. */
5920 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5921 && WINDOWP (selected_window)
5922 && EQ (XWINDOW (selected_window)->buffer, new_current_buffer)
5923 && !EQ (selected_window, data->current_window))
5924 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5925 else
5926 old_point = PT;
5927 else
5928 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5929 point in new_current_buffer as of the last time this buffer was
5930 used. This can be non-deterministic since it can be changed by
5931 things like jit-lock by mere temporary selection of some random
5932 window that happens to show this buffer.
5933 So if possible we want this arbitrary choice of "which point" to
5934 be the one from the to-be-selected-window so as to prevent this
5935 window's cursor from being copied from another window. */
5936 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5937 /* If current_window = selected_window, its point is in BUF_PT. */
5938 && !EQ (selected_window, data->current_window))
5939 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5940 else
5941 old_point = BUF_PT (XBUFFER (new_current_buffer));
5944 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5945 f = XFRAME (frame);
5947 /* If f is a dead frame, don't bother rebuilding its window tree.
5948 However, there is other stuff we should still try to do below. */
5949 if (FRAME_LIVE_P (f))
5951 register struct window *w;
5952 register struct saved_window *p;
5953 struct window *root_window;
5954 struct window **leaf_windows;
5955 int n_leaf_windows;
5956 int k, i, n;
5958 /* If the frame has been resized since this window configuration was
5959 made, we change the frame to the size specified in the
5960 configuration, restore the configuration, and then resize it
5961 back. We keep track of the prevailing height in these variables. */
5962 int previous_frame_lines = FRAME_LINES (f);
5963 int previous_frame_cols = FRAME_COLS (f);
5964 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5965 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5967 /* The mouse highlighting code could get screwed up
5968 if it runs during this. */
5969 BLOCK_INPUT;
5971 if (data->frame_lines != previous_frame_lines
5972 || data->frame_cols != previous_frame_cols)
5973 change_frame_size (f, data->frame_lines,
5974 data->frame_cols, 0, 0, 0);
5975 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5976 if (data->frame_menu_bar_lines
5977 != previous_frame_menu_bar_lines)
5978 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
5979 make_number (0));
5980 #ifdef HAVE_WINDOW_SYSTEM
5981 if (data->frame_tool_bar_lines
5982 != previous_frame_tool_bar_lines)
5983 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
5984 make_number (0));
5985 #endif
5986 #endif
5988 /* "Swap out" point from the selected window's buffer
5989 into the window itself. (Normally the pointm of the selected
5990 window holds garbage.) We do this now, before
5991 restoring the window contents, and prevent it from
5992 being done later on when we select a new window. */
5993 if (! NILP (XWINDOW (selected_window)->buffer))
5995 w = XWINDOW (selected_window);
5996 set_marker_both (w->pointm,
5997 w->buffer,
5998 BUF_PT (XBUFFER (w->buffer)),
5999 BUF_PT_BYTE (XBUFFER (w->buffer)));
6002 windows_or_buffers_changed++;
6003 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
6005 /* Problem: Freeing all matrices and later allocating them again
6006 is a serious redisplay flickering problem. What we would
6007 really like to do is to free only those matrices not reused
6008 below. */
6009 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
6010 leaf_windows
6011 = (struct window **) alloca (count_windows (root_window)
6012 * sizeof (struct window *));
6013 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
6015 /* Kludge Alert!
6016 Mark all windows now on frame as "deleted".
6017 Restoring the new configuration "undeletes" any that are in it.
6019 Save their current buffers in their height fields, since we may
6020 need it later, if a buffer saved in the configuration is now
6021 dead. */
6022 delete_all_subwindows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6024 for (k = 0; k < saved_windows->size; k++)
6026 p = SAVED_WINDOW_N (saved_windows, k);
6027 w = XWINDOW (p->window);
6028 w->next = Qnil;
6030 if (!NILP (p->parent))
6031 w->parent = SAVED_WINDOW_N (saved_windows,
6032 XFASTINT (p->parent))->window;
6033 else
6034 w->parent = Qnil;
6036 if (!NILP (p->prev))
6038 w->prev = SAVED_WINDOW_N (saved_windows,
6039 XFASTINT (p->prev))->window;
6040 XWINDOW (w->prev)->next = p->window;
6042 else
6044 w->prev = Qnil;
6045 if (!NILP (w->parent))
6047 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
6049 XWINDOW (w->parent)->vchild = p->window;
6050 XWINDOW (w->parent)->hchild = Qnil;
6052 else
6054 XWINDOW (w->parent)->hchild = p->window;
6055 XWINDOW (w->parent)->vchild = Qnil;
6060 /* If we squirreled away the buffer in the window's height,
6061 restore it now. */
6062 if (BUFFERP (w->total_lines))
6063 w->buffer = w->total_lines;
6064 w->left_col = p->left_col;
6065 w->top_line = p->top_line;
6066 w->total_cols = p->total_cols;
6067 w->total_lines = p->total_lines;
6068 w->hscroll = p->hscroll;
6069 w->min_hscroll = p->min_hscroll;
6070 w->display_table = p->display_table;
6071 w->orig_top_line = p->orig_top_line;
6072 w->orig_total_lines = p->orig_total_lines;
6073 w->left_margin_cols = p->left_margin_cols;
6074 w->right_margin_cols = p->right_margin_cols;
6075 w->left_fringe_width = p->left_fringe_width;
6076 w->right_fringe_width = p->right_fringe_width;
6077 w->fringes_outside_margins = p->fringes_outside_margins;
6078 w->scroll_bar_width = p->scroll_bar_width;
6079 w->vertical_scroll_bar_type = p->vertical_scroll_bar_type;
6080 w->dedicated = p->dedicated;
6081 w->resize_proportionally = p->resize_proportionally;
6082 XSETFASTINT (w->last_modified, 0);
6083 XSETFASTINT (w->last_overlay_modified, 0);
6085 /* Reinstall the saved buffer and pointers into it. */
6086 if (NILP (p->buffer))
6087 w->buffer = p->buffer;
6088 else
6090 if (!NILP (XBUFFER (p->buffer)->name))
6091 /* If saved buffer is alive, install it. */
6093 w->buffer = p->buffer;
6094 w->start_at_line_beg = p->start_at_line_beg;
6095 set_marker_restricted (w->start, p->start, w->buffer);
6096 set_marker_restricted (w->pointm, p->pointm, w->buffer);
6097 Fset_marker (XBUFFER (w->buffer)->mark,
6098 p->mark, w->buffer);
6100 /* As documented in Fcurrent_window_configuration, don't
6101 restore the location of point in the buffer which was
6102 current when the window configuration was recorded. */
6103 if (!EQ (p->buffer, new_current_buffer)
6104 && XBUFFER (p->buffer) == current_buffer)
6105 Fgoto_char (w->pointm);
6107 else if (NILP (w->buffer) || NILP (XBUFFER (w->buffer)->name))
6108 /* Else unless window has a live buffer, get one. */
6110 w->buffer = Fcdr (Fcar (Vbuffer_alist));
6111 /* This will set the markers to beginning of visible
6112 range. */
6113 set_marker_restricted (w->start, make_number (0), w->buffer);
6114 set_marker_restricted (w->pointm, make_number (0),w->buffer);
6115 w->start_at_line_beg = Qt;
6117 else
6118 /* Keeping window's old buffer; make sure the markers
6119 are real. */
6121 /* Set window markers at start of visible range. */
6122 if (XMARKER (w->start)->buffer == 0)
6123 set_marker_restricted (w->start, make_number (0),
6124 w->buffer);
6125 if (XMARKER (w->pointm)->buffer == 0)
6126 set_marker_restricted_both (w->pointm, w->buffer,
6127 BUF_PT (XBUFFER (w->buffer)),
6128 BUF_PT_BYTE (XBUFFER (w->buffer)));
6129 w->start_at_line_beg = Qt;
6134 FRAME_ROOT_WINDOW (f) = data->root_window;
6135 /* Prevent "swapping out point" in the old selected window
6136 using the buffer that has been restored into it.
6137 We already swapped out point that from that window's old buffer. */
6138 selected_window = Qnil;
6140 /* Arrange *not* to restore point in the buffer that was
6141 current when the window configuration was saved. */
6142 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
6143 set_marker_restricted (XWINDOW (data->current_window)->pointm,
6144 make_number (old_point),
6145 XWINDOW (data->current_window)->buffer);
6147 Fselect_window (data->current_window, Qnil);
6148 XBUFFER (XWINDOW (selected_window)->buffer)->last_selected_window
6149 = selected_window;
6151 if (NILP (data->focus_frame)
6152 || (FRAMEP (data->focus_frame)
6153 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
6154 Fredirect_frame_focus (frame, data->focus_frame);
6156 #if 0 /* I don't understand why this is needed, and it causes problems
6157 when the frame's old selected window has been deleted. */
6158 if (f != selected_frame && FRAME_WINDOW_P (f))
6159 do_switch_frame (WINDOW_FRAME (XWINDOW (data->root_window)),
6160 0, 0);
6161 #endif
6163 /* Set the screen height to the value it had before this function. */
6164 if (previous_frame_lines != FRAME_LINES (f)
6165 || previous_frame_cols != FRAME_COLS (f))
6166 change_frame_size (f, previous_frame_lines, previous_frame_cols,
6167 0, 0, 0);
6168 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
6169 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
6170 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
6171 make_number (0));
6172 #ifdef HAVE_WINDOW_SYSTEM
6173 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
6174 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
6175 make_number (0));
6176 #endif
6177 #endif
6179 /* Now, free glyph matrices in windows that were not reused. */
6180 for (i = n = 0; i < n_leaf_windows; ++i)
6182 if (NILP (leaf_windows[i]->buffer))
6184 /* Assert it's not reused as a combination. */
6185 xassert (NILP (leaf_windows[i]->hchild)
6186 && NILP (leaf_windows[i]->vchild));
6187 free_window_matrices (leaf_windows[i]);
6189 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
6190 ++n;
6193 adjust_glyphs (f);
6195 UNBLOCK_INPUT;
6197 /* Fselect_window will have made f the selected frame, so we
6198 reselect the proper frame here. Fhandle_switch_frame will change the
6199 selected window too, but that doesn't make the call to
6200 Fselect_window above totally superfluous; it still sets f's
6201 selected window. */
6202 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
6203 do_switch_frame (data->selected_frame, 0, 0);
6205 run_window_configuration_change_hook (f);
6208 if (!NILP (new_current_buffer))
6209 Fset_buffer (new_current_buffer);
6211 Vminibuf_scroll_window = data->minibuf_scroll_window;
6212 minibuf_selected_window = data->minibuf_selected_window;
6214 return (FRAME_LIVE_P (f) ? Qt : Qnil);
6217 /* Mark all windows now on frame as deleted
6218 by setting their buffers to nil. */
6220 void
6221 delete_all_subwindows (w)
6222 register struct window *w;
6224 if (!NILP (w->next))
6225 delete_all_subwindows (XWINDOW (w->next));
6226 if (!NILP (w->vchild))
6227 delete_all_subwindows (XWINDOW (w->vchild));
6228 if (!NILP (w->hchild))
6229 delete_all_subwindows (XWINDOW (w->hchild));
6231 w->total_lines = w->buffer; /* See Fset_window_configuration for excuse. */
6233 if (!NILP (w->buffer))
6234 unshow_buffer (w);
6236 /* We set all three of these fields to nil, to make sure that we can
6237 distinguish this dead window from any live window. Live leaf
6238 windows will have buffer set, and combination windows will have
6239 vchild or hchild set. */
6240 w->buffer = Qnil;
6241 w->vchild = Qnil;
6242 w->hchild = Qnil;
6244 Vwindow_list = Qnil;
6247 static int
6248 count_windows (window)
6249 register struct window *window;
6251 register int count = 1;
6252 if (!NILP (window->next))
6253 count += count_windows (XWINDOW (window->next));
6254 if (!NILP (window->vchild))
6255 count += count_windows (XWINDOW (window->vchild));
6256 if (!NILP (window->hchild))
6257 count += count_windows (XWINDOW (window->hchild));
6258 return count;
6262 /* Fill vector FLAT with leaf windows under W, starting at index I.
6263 Value is last index + 1. */
6265 static int
6266 get_leaf_windows (w, flat, i)
6267 struct window *w;
6268 struct window **flat;
6269 int i;
6271 while (w)
6273 if (!NILP (w->hchild))
6274 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
6275 else if (!NILP (w->vchild))
6276 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
6277 else
6278 flat[i++] = w;
6280 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6283 return i;
6287 /* Return a pointer to the glyph W's physical cursor is on. Value is
6288 null if W's current matrix is invalid, so that no meaningfull glyph
6289 can be returned. */
6291 struct glyph *
6292 get_phys_cursor_glyph (w)
6293 struct window *w;
6295 struct glyph_row *row;
6296 struct glyph *glyph;
6298 if (w->phys_cursor.vpos >= 0
6299 && w->phys_cursor.vpos < w->current_matrix->nrows
6300 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
6301 row->enabled_p)
6302 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
6303 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
6304 else
6305 glyph = NULL;
6307 return glyph;
6311 static int
6312 save_window_save (window, vector, i)
6313 Lisp_Object window;
6314 struct Lisp_Vector *vector;
6315 int i;
6317 register struct saved_window *p;
6318 register struct window *w;
6319 register Lisp_Object tem;
6321 for (;!NILP (window); window = w->next)
6323 p = SAVED_WINDOW_N (vector, i);
6324 w = XWINDOW (window);
6326 XSETFASTINT (w->temslot, i); i++;
6327 p->window = window;
6328 p->buffer = w->buffer;
6329 p->left_col = w->left_col;
6330 p->top_line = w->top_line;
6331 p->total_cols = w->total_cols;
6332 p->total_lines = w->total_lines;
6333 p->hscroll = w->hscroll;
6334 p->min_hscroll = w->min_hscroll;
6335 p->display_table = w->display_table;
6336 p->orig_top_line = w->orig_top_line;
6337 p->orig_total_lines = w->orig_total_lines;
6338 p->left_margin_cols = w->left_margin_cols;
6339 p->right_margin_cols = w->right_margin_cols;
6340 p->left_fringe_width = w->left_fringe_width;
6341 p->right_fringe_width = w->right_fringe_width;
6342 p->fringes_outside_margins = w->fringes_outside_margins;
6343 p->scroll_bar_width = w->scroll_bar_width;
6344 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
6345 p->dedicated = w->dedicated;
6346 p->resize_proportionally = w->resize_proportionally;
6347 if (!NILP (w->buffer))
6349 /* Save w's value of point in the window configuration.
6350 If w is the selected window, then get the value of point
6351 from the buffer; pointm is garbage in the selected window. */
6352 if (EQ (window, selected_window))
6354 p->pointm = Fmake_marker ();
6355 set_marker_both (p->pointm, w->buffer,
6356 BUF_PT (XBUFFER (w->buffer)),
6357 BUF_PT_BYTE (XBUFFER (w->buffer)));
6359 else
6360 p->pointm = Fcopy_marker (w->pointm, Qnil);
6362 p->start = Fcopy_marker (w->start, Qnil);
6363 p->start_at_line_beg = w->start_at_line_beg;
6365 tem = XBUFFER (w->buffer)->mark;
6366 p->mark = Fcopy_marker (tem, Qnil);
6368 else
6370 p->pointm = Qnil;
6371 p->start = Qnil;
6372 p->mark = Qnil;
6373 p->start_at_line_beg = Qnil;
6376 if (NILP (w->parent))
6377 p->parent = Qnil;
6378 else
6379 p->parent = XWINDOW (w->parent)->temslot;
6381 if (NILP (w->prev))
6382 p->prev = Qnil;
6383 else
6384 p->prev = XWINDOW (w->prev)->temslot;
6386 if (!NILP (w->vchild))
6387 i = save_window_save (w->vchild, vector, i);
6388 if (!NILP (w->hchild))
6389 i = save_window_save (w->hchild, vector, i);
6392 return i;
6395 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
6396 Scurrent_window_configuration, 0, 1, 0,
6397 doc: /* Return an object representing the current window configuration of FRAME.
6398 If FRAME is nil or omitted, use the selected frame.
6399 This describes the number of windows, their sizes and current buffers,
6400 and for each displayed buffer, where display starts, and the positions of
6401 point and mark. An exception is made for point in the current buffer:
6402 its value is -not- saved.
6403 This also records the currently selected frame, and FRAME's focus
6404 redirection (see `redirect-frame-focus'). */)
6405 (frame)
6406 Lisp_Object frame;
6408 register Lisp_Object tem;
6409 register int n_windows;
6410 register struct save_window_data *data;
6411 register int i;
6412 FRAME_PTR f;
6414 if (NILP (frame))
6415 frame = selected_frame;
6416 CHECK_LIVE_FRAME (frame);
6417 f = XFRAME (frame);
6419 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6420 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6421 PVEC_WINDOW_CONFIGURATION);
6423 data->frame_cols = FRAME_COLS (f);
6424 data->frame_lines = FRAME_LINES (f);
6425 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6426 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6427 data->selected_frame = selected_frame;
6428 data->current_window = FRAME_SELECTED_WINDOW (f);
6429 XSETBUFFER (data->current_buffer, current_buffer);
6430 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6431 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6432 data->root_window = FRAME_ROOT_WINDOW (f);
6433 data->focus_frame = FRAME_FOCUS_FRAME (f);
6434 tem = Fmake_vector (make_number (n_windows), Qnil);
6435 data->saved_windows = tem;
6436 for (i = 0; i < n_windows; i++)
6437 XVECTOR (tem)->contents[i]
6438 = Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil);
6439 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6440 XSETWINDOW_CONFIGURATION (tem, data);
6441 return (tem);
6444 DEFUN ("save-window-excursion", Fsave_window_excursion, Ssave_window_excursion,
6445 0, UNEVALLED, 0,
6446 doc: /* Execute BODY, preserving window sizes and contents.
6447 Return the value of the last form in BODY.
6448 Restore which buffer appears in which window, where display starts,
6449 and the value of point and mark for each window.
6450 Also restore the choice of selected window.
6451 Also restore which buffer is current.
6452 Does not restore the value of point in current buffer.
6453 usage: (save-window-excursion BODY...) */)
6454 (args)
6455 Lisp_Object args;
6457 register Lisp_Object val;
6458 register int count = SPECPDL_INDEX ();
6460 record_unwind_protect (Fset_window_configuration,
6461 Fcurrent_window_configuration (Qnil));
6462 val = Fprogn (args);
6463 return unbind_to (count, val);
6468 /***********************************************************************
6469 Window Split Tree
6470 ***********************************************************************/
6472 static Lisp_Object
6473 window_tree (w)
6474 struct window *w;
6476 Lisp_Object tail = Qnil;
6477 Lisp_Object result = Qnil;
6479 while (w)
6481 Lisp_Object wn;
6483 XSETWINDOW (wn, w);
6484 if (!NILP (w->hchild))
6485 wn = Fcons (Qnil, Fcons (Fwindow_edges (wn),
6486 window_tree (XWINDOW (w->hchild))));
6487 else if (!NILP (w->vchild))
6488 wn = Fcons (Qt, Fcons (Fwindow_edges (wn),
6489 window_tree (XWINDOW (w->vchild))));
6491 if (NILP (result))
6493 result = tail = Fcons (wn, Qnil);
6495 else
6497 XSETCDR (tail, Fcons (wn, Qnil));
6498 tail = XCDR (tail);
6501 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6504 return result;
6509 DEFUN ("window-tree", Fwindow_tree, Swindow_tree,
6510 0, 1, 0,
6511 doc: /* Return the window tree for frame FRAME.
6513 The return value is a list of the form (ROOT MINI), where ROOT
6514 represents the window tree of the frame's root window, and MINI
6515 is the frame's minibuffer window.
6517 If the root window is not split, ROOT is the root window itself.
6518 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil for a
6519 horizontal split, and t for a vertical split, EDGES gives the combined
6520 size and position of the subwindows in the split, and the rest of the
6521 elements are the subwindows in the split. Each of the subwindows may
6522 again be a window or a list representing a window split, and so on.
6523 EDGES is a list \(LEFT TOP RIGHT BOTTOM) as returned by `window-edges'.
6525 If FRAME is nil or omitted, return information on the currently
6526 selected frame. */)
6527 (frame)
6528 Lisp_Object frame;
6530 FRAME_PTR f;
6532 if (NILP (frame))
6533 frame = selected_frame;
6535 CHECK_FRAME (frame);
6536 f = XFRAME (frame);
6538 if (!FRAME_LIVE_P (f))
6539 return Qnil;
6541 return window_tree (XWINDOW (FRAME_ROOT_WINDOW (f)));
6545 /***********************************************************************
6546 Marginal Areas
6547 ***********************************************************************/
6549 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6550 2, 3, 0,
6551 doc: /* Set width of marginal areas of window WINDOW.
6552 If WINDOW is nil, set margins of the currently selected window.
6553 Second arg LEFT-WIDTH specifies the number of character cells to
6554 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6555 does the same for the right marginal area. A nil width parameter
6556 means no margin. */)
6557 (window, left_width, right_width)
6558 Lisp_Object window, left_width, right_width;
6560 struct window *w = decode_window (window);
6562 /* Translate negative or zero widths to nil.
6563 Margins that are too wide have to be checked elsewhere. */
6565 if (!NILP (left_width))
6567 CHECK_NUMBER (left_width);
6568 if (XINT (left_width) <= 0)
6569 left_width = Qnil;
6572 if (!NILP (right_width))
6574 CHECK_NUMBER (right_width);
6575 if (XINT (right_width) <= 0)
6576 right_width = Qnil;
6579 if (!EQ (w->left_margin_cols, left_width)
6580 || !EQ (w->right_margin_cols, right_width))
6582 w->left_margin_cols = left_width;
6583 w->right_margin_cols = right_width;
6585 adjust_window_margins (w);
6587 ++windows_or_buffers_changed;
6588 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6591 return Qnil;
6595 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6596 0, 1, 0,
6597 doc: /* Get width of marginal areas of window WINDOW.
6598 If WINDOW is omitted or nil, use the currently selected window.
6599 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6600 If a marginal area does not exist, its width will be returned
6601 as nil. */)
6602 (window)
6603 Lisp_Object window;
6605 struct window *w = decode_window (window);
6606 return Fcons (w->left_margin_cols, w->right_margin_cols);
6611 /***********************************************************************
6612 Fringes
6613 ***********************************************************************/
6615 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6616 2, 4, 0,
6617 doc: /* Set the fringe widths of window WINDOW.
6618 If WINDOW is nil, set the fringe widths of the currently selected
6619 window.
6620 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6621 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6622 fringe width. If a fringe width arg is nil, that means to use the
6623 frame's default fringe width. Default fringe widths can be set with
6624 the command `set-fringe-style'.
6625 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6626 outside of the display margins. By default, fringes are drawn between
6627 display marginal areas and the text area. */)
6628 (window, left_width, right_width, outside_margins)
6629 Lisp_Object window, left_width, right_width, outside_margins;
6631 struct window *w = decode_window (window);
6633 if (!NILP (left_width))
6634 CHECK_NATNUM (left_width);
6635 if (!NILP (right_width))
6636 CHECK_NATNUM (right_width);
6638 /* Do nothing on a tty. */
6639 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6640 && (!EQ (w->left_fringe_width, left_width)
6641 || !EQ (w->right_fringe_width, right_width)
6642 || !EQ (w->fringes_outside_margins, outside_margins)))
6644 w->left_fringe_width = left_width;
6645 w->right_fringe_width = right_width;
6646 w->fringes_outside_margins = outside_margins;
6648 adjust_window_margins (w);
6650 clear_glyph_matrix (w->current_matrix);
6651 w->window_end_valid = Qnil;
6653 ++windows_or_buffers_changed;
6654 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6657 return Qnil;
6661 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6662 0, 1, 0,
6663 doc: /* Get width of fringes of window WINDOW.
6664 If WINDOW is omitted or nil, use the currently selected window.
6665 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6666 (window)
6667 Lisp_Object window;
6669 struct window *w = decode_window (window);
6671 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6672 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6673 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6674 ? Qt : Qnil), Qnil)));
6679 /***********************************************************************
6680 Scroll bars
6681 ***********************************************************************/
6683 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars, Sset_window_scroll_bars,
6684 2, 4, 0,
6685 doc: /* Set width and type of scroll bars of window WINDOW.
6686 If window is nil, set scroll bars of the currently selected window.
6687 Second parameter WIDTH specifies the pixel width for the scroll bar;
6688 this is automatically adjusted to a multiple of the frame column width.
6689 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6690 bar: left, right, or nil.
6691 If WIDTH is nil, use the frame's scroll-bar width.
6692 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6693 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6694 (window, width, vertical_type, horizontal_type)
6695 Lisp_Object window, width, vertical_type, horizontal_type;
6697 struct window *w = decode_window (window);
6699 if (!NILP (width))
6701 CHECK_NATNUM (width);
6703 if (XINT (width) == 0)
6704 vertical_type = Qnil;
6707 if (!(NILP (vertical_type)
6708 || EQ (vertical_type, Qleft)
6709 || EQ (vertical_type, Qright)
6710 || EQ (vertical_type, Qt)))
6711 error ("Invalid type of vertical scroll bar");
6713 if (!EQ (w->scroll_bar_width, width)
6714 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6716 w->scroll_bar_width = width;
6717 w->vertical_scroll_bar_type = vertical_type;
6719 adjust_window_margins (w);
6721 clear_glyph_matrix (w->current_matrix);
6722 w->window_end_valid = Qnil;
6724 ++windows_or_buffers_changed;
6725 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6728 return Qnil;
6732 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6733 0, 1, 0,
6734 doc: /* Get width and type of scroll bars of window WINDOW.
6735 If WINDOW is omitted or nil, use the currently selected window.
6736 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6737 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6738 value. */)
6739 (window)
6740 Lisp_Object window;
6742 struct window *w = decode_window (window);
6743 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6744 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6745 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6746 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
6747 Fcons (w->vertical_scroll_bar_type,
6748 Fcons (Qnil, Qnil))));
6753 /***********************************************************************
6754 Smooth scrolling
6755 ***********************************************************************/
6757 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6758 doc: /* Return the amount by which WINDOW is scrolled vertically.
6759 Use the selected window if WINDOW is nil or omitted.
6760 Normally, value is a multiple of the canonical character height of WINDOW;
6761 optional second arg PIXELS-P means value is measured in pixels. */)
6762 (window, pixels_p)
6763 Lisp_Object window, 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 (window, vscroll, pixels_p)
6797 Lisp_Object window, vscroll, pixels_p;
6799 struct window *w;
6800 struct frame *f;
6802 if (NILP (window))
6803 window = selected_window;
6804 else
6805 CHECK_WINDOW (window);
6806 CHECK_NUMBER_OR_FLOAT (vscroll);
6808 w = XWINDOW (window);
6809 f = XFRAME (w->frame);
6811 if (FRAME_WINDOW_P (f))
6813 int old_dy = w->vscroll;
6815 w->vscroll = - (NILP (pixels_p)
6816 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6817 : XFLOATINT (vscroll));
6818 w->vscroll = min (w->vscroll, 0);
6820 if (w->vscroll != old_dy)
6822 /* Adjust glyph matrix of the frame if the virtual display
6823 area becomes larger than before. */
6824 if (w->vscroll < 0 && w->vscroll < old_dy)
6825 adjust_glyphs (f);
6827 /* Prevent redisplay shortcuts. */
6828 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
6832 return Fwindow_vscroll (window, pixels_p);
6836 /* Call FN for all leaf windows on frame F. FN is called with the
6837 first argument being a pointer to the leaf window, and with
6838 additional argument USER_DATA. Stops when FN returns 0. */
6840 void
6841 foreach_window (f, fn, user_data)
6842 struct frame *f;
6843 int (* fn) P_ ((struct window *, void *));
6844 void *user_data;
6846 /* Fdelete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6847 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6848 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6852 /* Helper function for foreach_window. Call FN for all leaf windows
6853 reachable from W. FN is called with the first argument being a
6854 pointer to the leaf window, and with additional argument USER_DATA.
6855 Stop when FN returns 0. Value is 0 if stopped by FN. */
6857 static int
6858 foreach_window_1 (w, fn, user_data)
6859 struct window *w;
6860 int (* fn) P_ ((struct window *, void *));
6861 void *user_data;
6863 int cont;
6865 for (cont = 1; w && cont;)
6867 if (!NILP (w->hchild))
6868 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6869 else if (!NILP (w->vchild))
6870 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6871 else
6872 cont = fn (w, user_data);
6874 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6877 return cont;
6881 /* Freeze or unfreeze the window start of W unless it is a
6882 mini-window or the selected window. FREEZE_P non-null means freeze
6883 the window start. */
6885 static int
6886 freeze_window_start (w, freeze_p)
6887 struct window *w;
6888 void *freeze_p;
6890 if (MINI_WINDOW_P (w)
6891 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6892 && (w == XWINDOW (selected_window)
6893 || (MINI_WINDOW_P (XWINDOW (selected_window))
6894 && ! NILP (Vminibuf_scroll_window)
6895 && w == XWINDOW (Vminibuf_scroll_window)))))
6896 freeze_p = NULL;
6898 w->frozen_window_start_p = freeze_p != NULL;
6899 return 1;
6903 /* Freeze or unfreeze the window starts of all leaf windows on frame
6904 F, except the selected window and a mini-window. FREEZE_P non-zero
6905 means freeze the window start. */
6907 void
6908 freeze_window_starts (f, freeze_p)
6909 struct frame *f;
6910 int freeze_p;
6912 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6916 /***********************************************************************
6917 Initialization
6918 ***********************************************************************/
6920 /* Return 1 if window configurations C1 and C2
6921 describe the same state of affairs. This is used by Fequal. */
6924 compare_window_configurations (c1, c2, ignore_positions)
6925 Lisp_Object c1, c2;
6926 int ignore_positions;
6928 register struct save_window_data *d1, *d2;
6929 struct Lisp_Vector *sw1, *sw2;
6930 int i;
6932 CHECK_WINDOW_CONFIGURATION (c1);
6933 CHECK_WINDOW_CONFIGURATION (c2);
6935 d1 = (struct save_window_data *) XVECTOR (c1);
6936 d2 = (struct save_window_data *) XVECTOR (c2);
6937 sw1 = XVECTOR (d1->saved_windows);
6938 sw2 = XVECTOR (d2->saved_windows);
6940 if (d1->frame_cols != d2->frame_cols)
6941 return 0;
6942 if (d1->frame_lines != d2->frame_lines)
6943 return 0;
6944 if (d1->frame_menu_bar_lines != d2->frame_menu_bar_lines)
6945 return 0;
6946 if (! EQ (d1->selected_frame, d2->selected_frame))
6947 return 0;
6948 /* Don't compare the current_window field directly.
6949 Instead see w1_is_current and w2_is_current, below. */
6950 if (! EQ (d1->current_buffer, d2->current_buffer))
6951 return 0;
6952 if (! ignore_positions)
6954 if (! EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window))
6955 return 0;
6956 if (! EQ (d1->minibuf_selected_window, d2->minibuf_selected_window))
6957 return 0;
6959 /* Don't compare the root_window field.
6960 We don't require the two configurations
6961 to use the same window object,
6962 and the two root windows must be equivalent
6963 if everything else compares equal. */
6964 if (! EQ (d1->focus_frame, d2->focus_frame))
6965 return 0;
6967 /* Verify that the two confis have the same number of windows. */
6968 if (sw1->size != sw2->size)
6969 return 0;
6971 for (i = 0; i < sw1->size; i++)
6973 struct saved_window *p1, *p2;
6974 int w1_is_current, w2_is_current;
6976 p1 = SAVED_WINDOW_N (sw1, i);
6977 p2 = SAVED_WINDOW_N (sw2, i);
6979 /* Verify that the current windows in the two
6980 configurations correspond to each other. */
6981 w1_is_current = EQ (d1->current_window, p1->window);
6982 w2_is_current = EQ (d2->current_window, p2->window);
6984 if (w1_is_current != w2_is_current)
6985 return 0;
6987 /* Verify that the corresponding windows do match. */
6988 if (! EQ (p1->buffer, p2->buffer))
6989 return 0;
6990 if (! EQ (p1->left_col, p2->left_col))
6991 return 0;
6992 if (! EQ (p1->top_line, p2->top_line))
6993 return 0;
6994 if (! EQ (p1->total_cols, p2->total_cols))
6995 return 0;
6996 if (! EQ (p1->total_lines, p2->total_lines))
6997 return 0;
6998 if (! EQ (p1->display_table, p2->display_table))
6999 return 0;
7000 if (! EQ (p1->parent, p2->parent))
7001 return 0;
7002 if (! EQ (p1->prev, p2->prev))
7003 return 0;
7004 if (! ignore_positions)
7006 if (! EQ (p1->hscroll, p2->hscroll))
7007 return 0;
7008 if (!EQ (p1->min_hscroll, p2->min_hscroll))
7009 return 0;
7010 if (! EQ (p1->start_at_line_beg, p2->start_at_line_beg))
7011 return 0;
7012 if (NILP (Fequal (p1->start, p2->start)))
7013 return 0;
7014 if (NILP (Fequal (p1->pointm, p2->pointm)))
7015 return 0;
7016 if (NILP (Fequal (p1->mark, p2->mark)))
7017 return 0;
7019 if (! EQ (p1->left_margin_cols, p2->left_margin_cols))
7020 return 0;
7021 if (! EQ (p1->right_margin_cols, p2->right_margin_cols))
7022 return 0;
7023 if (! EQ (p1->left_fringe_width, p2->left_fringe_width))
7024 return 0;
7025 if (! EQ (p1->right_fringe_width, p2->right_fringe_width))
7026 return 0;
7027 if (! EQ (p1->fringes_outside_margins, p2->fringes_outside_margins))
7028 return 0;
7029 if (! EQ (p1->scroll_bar_width, p2->scroll_bar_width))
7030 return 0;
7031 if (! EQ (p1->vertical_scroll_bar_type, p2->vertical_scroll_bar_type))
7032 return 0;
7035 return 1;
7038 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
7039 Scompare_window_configurations, 2, 2, 0,
7040 doc: /* Compare two window configurations as regards the structure of windows.
7041 This function ignores details such as the values of point and mark
7042 and scrolling positions. */)
7043 (x, y)
7044 Lisp_Object x, y;
7046 if (compare_window_configurations (x, y, 1))
7047 return Qt;
7048 return Qnil;
7051 void
7052 init_window_once ()
7054 struct frame *f = make_initial_frame ();
7055 XSETFRAME (selected_frame, f);
7056 Vterminal_frame = selected_frame;
7057 minibuf_window = f->minibuffer_window;
7058 selected_window = f->selected_window;
7059 last_nonminibuf_frame = f;
7061 window_initialized = 1;
7064 void
7065 init_window ()
7067 Vwindow_list = Qnil;
7070 void
7071 syms_of_window ()
7073 Qscroll_up = intern ("scroll-up");
7074 staticpro (&Qscroll_up);
7076 Qscroll_down = intern ("scroll-down");
7077 staticpro (&Qscroll_down);
7079 Qwindow_size_fixed = intern ("window-size-fixed");
7080 staticpro (&Qwindow_size_fixed);
7081 Fset (Qwindow_size_fixed, Qnil);
7083 staticpro (&Qwindow_configuration_change_hook);
7084 Qwindow_configuration_change_hook
7085 = intern ("window-configuration-change-hook");
7087 Qwindowp = intern ("windowp");
7088 staticpro (&Qwindowp);
7090 Qwindow_configuration_p = intern ("window-configuration-p");
7091 staticpro (&Qwindow_configuration_p);
7093 Qwindow_live_p = intern ("window-live-p");
7094 staticpro (&Qwindow_live_p);
7096 Qdisplay_buffer = intern ("display-buffer");
7097 staticpro (&Qdisplay_buffer);
7099 Qtemp_buffer_show_hook = intern ("temp-buffer-show-hook");
7100 staticpro (&Qtemp_buffer_show_hook);
7102 staticpro (&Vwindow_list);
7104 minibuf_selected_window = Qnil;
7105 staticpro (&minibuf_selected_window);
7107 window_scroll_pixel_based_preserve_x = -1;
7108 window_scroll_pixel_based_preserve_y = -1;
7109 window_scroll_preserve_hpos = -1;
7110 window_scroll_preserve_vpos = -1;
7112 DEFVAR_LISP ("temp-buffer-show-function", &Vtemp_buffer_show_function,
7113 doc: /* Non-nil means call as function to display a help buffer.
7114 The function is called with one argument, the buffer to be displayed.
7115 Used by `with-output-to-temp-buffer'.
7116 If this function is used, then it must do the entire job of showing
7117 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
7118 Vtemp_buffer_show_function = Qnil;
7120 DEFVAR_LISP ("minibuffer-scroll-window", &Vminibuf_scroll_window,
7121 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
7122 Vminibuf_scroll_window = Qnil;
7124 DEFVAR_BOOL ("mode-line-in-non-selected-windows", &mode_line_in_non_selected_windows,
7125 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
7126 If the minibuffer is active, the `minibuffer-scroll-window' mode line
7127 is displayed in the `mode-line' face. */);
7128 mode_line_in_non_selected_windows = 1;
7130 DEFVAR_LISP ("other-window-scroll-buffer", &Vother_window_scroll_buffer,
7131 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
7132 Vother_window_scroll_buffer = Qnil;
7134 DEFVAR_BOOL ("auto-window-vscroll", &auto_window_vscroll_p,
7135 doc: /* *Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
7136 auto_window_vscroll_p = 1;
7138 DEFVAR_INT ("next-screen-context-lines", &next_screen_context_lines,
7139 doc: /* *Number of lines of continuity when scrolling by screenfuls. */);
7140 next_screen_context_lines = 2;
7142 DEFVAR_INT ("window-min-height", &window_min_height,
7143 doc: /* Allow deleting windows less than this tall.
7144 The value is measured in line units. If a window wants a modeline it
7145 is counted as one line.
7147 Emacs honors settings of this variable when enlarging or shrinking
7148 windows vertically. A value less than 1 is invalid. */);
7149 window_min_height = 4;
7151 DEFVAR_INT ("window-min-width", &window_min_width,
7152 doc: /* Allow deleting windows less than this wide.
7153 The value is measured in characters and includes any fringes or
7154 the scrollbar.
7156 Emacs honors settings of this variable when enlarging or shrinking
7157 windows horizontally. A value less than 2 is invalid. */);
7158 window_min_width = 10;
7160 DEFVAR_LISP ("scroll-preserve-screen-position",
7161 &Vscroll_preserve_screen_position,
7162 doc: /* *Controls if scroll commands move point to keep its screen position unchanged.
7163 A value of nil means point does not keep its screen position except
7164 at the scroll margin or window boundary respectively.
7165 A value of t means point keeps its screen position if the scroll
7166 command moved it vertically out of the window, e.g. when scrolling
7167 by full screens.
7168 Any other value means point always keeps its screen position. */);
7169 Vscroll_preserve_screen_position = Qnil;
7171 DEFVAR_LISP ("window-point-insertion-type", &Vwindow_point_insertion_type,
7172 doc: /* Type of marker to use for `window-point'. */);
7173 Vwindow_point_insertion_type = Qnil;
7175 DEFVAR_LISP ("window-configuration-change-hook",
7176 &Vwindow_configuration_change_hook,
7177 doc: /* Functions to call when window configuration changes.
7178 The buffer-local part is run once per window, with the relevant window
7179 selected; while the global part is run only once for the modified frame,
7180 with the relevant frame selected. */);
7181 Vwindow_configuration_change_hook = Qnil;
7183 defsubr (&Sselected_window);
7184 defsubr (&Sminibuffer_window);
7185 defsubr (&Swindow_minibuffer_p);
7186 defsubr (&Swindowp);
7187 defsubr (&Swindow_live_p);
7188 defsubr (&Spos_visible_in_window_p);
7189 defsubr (&Swindow_line_height);
7190 defsubr (&Swindow_buffer);
7191 defsubr (&Swindow_height);
7192 defsubr (&Swindow_width);
7193 defsubr (&Swindow_full_width_p);
7194 defsubr (&Swindow_hscroll);
7195 defsubr (&Sset_window_hscroll);
7196 defsubr (&Swindow_redisplay_end_trigger);
7197 defsubr (&Sset_window_redisplay_end_trigger);
7198 defsubr (&Swindow_edges);
7199 defsubr (&Swindow_pixel_edges);
7200 defsubr (&Swindow_inside_edges);
7201 defsubr (&Swindow_inside_pixel_edges);
7202 defsubr (&Scoordinates_in_window_p);
7203 defsubr (&Swindow_at);
7204 defsubr (&Swindow_point);
7205 defsubr (&Swindow_start);
7206 defsubr (&Swindow_end);
7207 defsubr (&Sset_window_point);
7208 defsubr (&Sset_window_start);
7209 defsubr (&Swindow_dedicated_p);
7210 defsubr (&Sset_window_dedicated_p);
7211 defsubr (&Swindow_display_table);
7212 defsubr (&Sset_window_display_table);
7213 defsubr (&Snext_window);
7214 defsubr (&Sprevious_window);
7215 defsubr (&Sother_window);
7216 defsubr (&Sget_lru_window);
7217 defsubr (&Sget_largest_window);
7218 defsubr (&Sget_buffer_window);
7219 defsubr (&Sdelete_other_windows);
7220 defsubr (&Sdelete_windows_on);
7221 defsubr (&Sreplace_buffer_in_windows);
7222 defsubr (&Sdelete_window);
7223 defsubr (&Sset_window_buffer);
7224 defsubr (&Sselect_window);
7225 defsubr (&Sforce_window_update);
7226 defsubr (&Ssplit_window);
7227 defsubr (&Senlarge_window);
7228 defsubr (&Sshrink_window);
7229 defsubr (&Sadjust_window_trailing_edge);
7230 defsubr (&Sscroll_up);
7231 defsubr (&Sscroll_down);
7232 defsubr (&Sscroll_left);
7233 defsubr (&Sscroll_right);
7234 defsubr (&Sother_window_for_scrolling);
7235 defsubr (&Sscroll_other_window);
7236 defsubr (&Sminibuffer_selected_window);
7237 defsubr (&Srecenter);
7238 defsubr (&Swindow_text_height);
7239 defsubr (&Smove_to_window_line);
7240 defsubr (&Swindow_configuration_p);
7241 defsubr (&Swindow_configuration_frame);
7242 defsubr (&Sset_window_configuration);
7243 defsubr (&Scurrent_window_configuration);
7244 defsubr (&Ssave_window_excursion);
7245 defsubr (&Swindow_tree);
7246 defsubr (&Sset_window_margins);
7247 defsubr (&Swindow_margins);
7248 defsubr (&Sset_window_fringes);
7249 defsubr (&Swindow_fringes);
7250 defsubr (&Sset_window_scroll_bars);
7251 defsubr (&Swindow_scroll_bars);
7252 defsubr (&Swindow_vscroll);
7253 defsubr (&Sset_window_vscroll);
7254 defsubr (&Scompare_window_configurations);
7255 defsubr (&Swindow_list);
7256 defsubr (&Swindow_parameters);
7257 defsubr (&Swindow_parameter);
7258 defsubr (&Sset_window_parameter);
7262 void
7263 keys_of_window ()
7265 initial_define_key (control_x_map, '1', "delete-other-windows");
7266 initial_define_key (control_x_map, '2', "split-window");
7267 initial_define_key (control_x_map, '0', "delete-window");
7268 initial_define_key (control_x_map, 'o', "other-window");
7269 initial_define_key (control_x_map, '^', "enlarge-window");
7270 initial_define_key (control_x_map, '<', "scroll-left");
7271 initial_define_key (control_x_map, '>', "scroll-right");
7273 initial_define_key (global_map, Ctl ('V'), "scroll-up");
7274 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
7275 initial_define_key (meta_map, 'v', "scroll-down");
7277 initial_define_key (global_map, Ctl('L'), "recenter");
7278 initial_define_key (meta_map, 'r', "move-to-window-line");
7281 /* arch-tag: 90a9c576-0590-48f1-a5f1-6c96a0452d9f
7282 (do not change this comment) */