* window.el (display-buffer-function, special-display-p)
[emacs.git] / src / window.c
blob7af0c6db7112122f527b8043d90578d89290acb2
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 MAC_OS
50 #include "macterm.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 /* Incremented by 1 whenever a window is deleted. */
172 int window_deletion_count;
174 /* Used by the function window_scroll_pixel_based */
176 static int window_scroll_pixel_based_preserve_x;
177 static int window_scroll_pixel_based_preserve_y;
179 /* Same for window_scroll_line_based. */
181 static int window_scroll_preserve_hpos;
182 static int window_scroll_preserve_vpos;
184 #if 0 /* This isn't used anywhere. */
185 /* Nonzero means we can split a frame even if it is "unsplittable". */
186 static int inhibit_frame_unsplittable;
187 #endif /* 0 */
189 extern EMACS_INT scroll_margin;
191 extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
193 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
194 doc: /* Returns t if OBJECT is a window. */)
195 (object)
196 Lisp_Object object;
198 return WINDOWP (object) ? Qt : Qnil;
201 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
202 doc: /* Returns t if OBJECT is a window which is currently visible. */)
203 (object)
204 Lisp_Object object;
206 return WINDOW_LIVE_P (object) ? Qt : Qnil;
209 Lisp_Object
210 make_window ()
212 Lisp_Object val;
213 register struct window *p;
215 p = allocate_window ();
216 ++sequence_number;
217 XSETFASTINT (p->sequence_number, sequence_number);
218 XSETFASTINT (p->left_col, 0);
219 XSETFASTINT (p->top_line, 0);
220 XSETFASTINT (p->total_lines, 0);
221 XSETFASTINT (p->total_cols, 0);
222 XSETFASTINT (p->hscroll, 0);
223 XSETFASTINT (p->min_hscroll, 0);
224 p->orig_top_line = p->orig_total_lines = Qnil;
225 p->start = Fmake_marker ();
226 p->pointm = Fmake_marker ();
227 XSETFASTINT (p->use_time, 0);
228 p->frame = Qnil;
229 p->display_table = Qnil;
230 p->dedicated = Qnil;
231 p->window_parameters = Qnil;
232 p->pseudo_window_p = 0;
233 bzero (&p->cursor, sizeof (p->cursor));
234 bzero (&p->last_cursor, sizeof (p->last_cursor));
235 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
236 p->desired_matrix = p->current_matrix = 0;
237 p->nrows_scale_factor = p->ncols_scale_factor = 1;
238 p->phys_cursor_type = -1;
239 p->phys_cursor_width = -1;
240 p->must_be_updated_p = 0;
241 XSETFASTINT (p->window_end_vpos, 0);
242 XSETFASTINT (p->window_end_pos, 0);
243 p->window_end_valid = Qnil;
244 p->vscroll = 0;
245 XSETWINDOW (val, p);
246 XSETFASTINT (p->last_point, 0);
247 p->frozen_window_start_p = 0;
248 p->last_cursor_off_p = p->cursor_off_p = 0;
249 p->left_margin_cols = Qnil;
250 p->right_margin_cols = Qnil;
251 p->left_fringe_width = Qnil;
252 p->right_fringe_width = Qnil;
253 p->fringes_outside_margins = Qnil;
254 p->scroll_bar_width = Qnil;
255 p->vertical_scroll_bar_type = Qt;
256 p->resize_proportionally = Qnil;
258 Vwindow_list = Qnil;
259 return val;
262 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
263 doc: /* Return the window that the cursor now appears in and commands apply to. */)
266 return selected_window;
269 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
270 doc: /* Return the window used now for minibuffers.
271 If the optional argument FRAME is specified, return the minibuffer window
272 used by that frame. */)
273 (frame)
274 Lisp_Object frame;
276 if (NILP (frame))
277 frame = selected_frame;
278 CHECK_LIVE_FRAME (frame);
279 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
282 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
283 doc: /* Returns non-nil if WINDOW is a minibuffer window.
284 WINDOW defaults to the selected window. */)
285 (window)
286 Lisp_Object window;
288 struct window *w = decode_window (window);
289 return MINI_WINDOW_P (w) ? Qt : Qnil;
293 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
294 Spos_visible_in_window_p, 0, 3, 0,
295 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
296 Return nil if that position is scrolled vertically out of view.
297 If a character is only partially visible, nil is returned, unless the
298 optional argument PARTIALLY is non-nil.
299 If POS is only out of view because of horizontal scrolling, return non-nil.
300 If POS is t, it specifies the position of the last visible glyph in WINDOW.
301 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
303 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
304 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
305 where X and Y are the pixel coordinates relative to the top left corner
306 of the window. The remaining elements are omitted if the character after
307 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
308 off-window at the top and bottom of the row, ROWH is the height of the
309 display row, and VPOS is the row number (0-based) containing POS. */)
310 (pos, window, partially)
311 Lisp_Object pos, window, partially;
313 register struct window *w;
314 register int posint;
315 register struct buffer *buf;
316 struct text_pos top;
317 Lisp_Object in_window = Qnil;
318 int rtop, rbot, rowh, vpos, fully_p = 1;
319 int x, y;
321 w = decode_window (window);
322 buf = XBUFFER (w->buffer);
323 SET_TEXT_POS_FROM_MARKER (top, w->start);
325 if (EQ (pos, Qt))
326 posint = -1;
327 else if (!NILP (pos))
329 CHECK_NUMBER_COERCE_MARKER (pos);
330 posint = XINT (pos);
332 else if (w == XWINDOW (selected_window))
333 posint = PT;
334 else
335 posint = XMARKER (w->pointm)->charpos;
337 /* If position is above window start or outside buffer boundaries,
338 or if window start is out of range, position is not visible. */
339 if ((EQ (pos, Qt)
340 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
341 && CHARPOS (top) >= BUF_BEGV (buf)
342 && CHARPOS (top) <= BUF_ZV (buf)
343 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
344 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
345 in_window = Qt;
347 if (!NILP (in_window) && !NILP (partially))
349 Lisp_Object part = Qnil;
350 if (!fully_p)
351 part = list4 (make_number (rtop), make_number (rbot),
352 make_number (rowh), make_number (vpos));
353 in_window = Fcons (make_number (x),
354 Fcons (make_number (y), part));
357 return in_window;
360 DEFUN ("window-line-height", Fwindow_line_height,
361 Swindow_line_height, 0, 2, 0,
362 doc: /* Return height in pixels of text line LINE in window WINDOW.
363 If WINDOW is nil or omitted, use selected window.
365 Return height of current line if LINE is omitted or nil. Return height of
366 header or mode line if LINE is `header-line' and `mode-line'.
367 Otherwise, LINE is a text line number starting from 0. A negative number
368 counts from the end of the window.
370 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
371 in pixels of the visible part of the line, VPOS and YPOS are the
372 vertical position in lines and pixels of the line, relative to the top
373 of the first text line, and OFFBOT is the number of off-window pixels at
374 the bottom of the text line. If there are off-window pixels at the top
375 of the (first) text line, YPOS is negative.
377 Return nil if window display is not up-to-date. In that case, use
378 `pos-visible-in-window-p' to obtain the information. */)
379 (line, window)
380 Lisp_Object line, window;
382 register struct window *w;
383 register struct buffer *b;
384 struct glyph_row *row, *end_row;
385 int max_y, crop, i, n;
387 w = decode_window (window);
389 if (noninteractive
390 || w->pseudo_window_p)
391 return Qnil;
393 CHECK_BUFFER (w->buffer);
394 b = XBUFFER (w->buffer);
396 /* Fail if current matrix is not up-to-date. */
397 if (NILP (w->window_end_valid)
398 || current_buffer->clip_changed
399 || current_buffer->prevent_redisplay_optimizations_p
400 || XFASTINT (w->last_modified) < BUF_MODIFF (b)
401 || XFASTINT (w->last_overlay_modified) < BUF_OVERLAY_MODIFF (b))
402 return Qnil;
404 if (NILP (line))
406 i = w->cursor.vpos;
407 if (i < 0 || i >= w->current_matrix->nrows
408 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
409 return Qnil;
410 max_y = window_text_bottom_y (w);
411 goto found_row;
414 if (EQ (line, Qheader_line))
416 if (!WINDOW_WANTS_HEADER_LINE_P (w))
417 return Qnil;
418 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
419 if (!row->enabled_p)
420 return Qnil;
421 return list4 (make_number (row->height),
422 make_number (0), make_number (0),
423 make_number (0));
426 if (EQ (line, Qmode_line))
428 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
429 if (!row->enabled_p)
430 return Qnil;
431 return list4 (make_number (row->height),
432 make_number (0), /* not accurate */
433 make_number (WINDOW_HEADER_LINE_HEIGHT (w)
434 + window_text_bottom_y (w)),
435 make_number (0));
438 CHECK_NUMBER (line);
439 n = XINT (line);
441 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
442 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
443 max_y = window_text_bottom_y (w);
444 i = 0;
446 while ((n < 0 || i < n)
447 && row <= end_row && row->enabled_p
448 && row->y + row->height < max_y)
449 row++, i++;
451 if (row > end_row || !row->enabled_p)
452 return Qnil;
454 if (++n < 0)
456 if (-n > i)
457 return Qnil;
458 row += n;
459 i += n;
462 found_row:
463 crop = max (0, (row->y + row->height) - max_y);
464 return list4 (make_number (row->height + min (0, row->y) - crop),
465 make_number (i),
466 make_number (row->y),
467 make_number (crop));
472 static struct window *
473 decode_window (window)
474 register Lisp_Object window;
476 if (NILP (window))
477 return XWINDOW (selected_window);
479 CHECK_LIVE_WINDOW (window);
480 return XWINDOW (window);
483 static struct window *
484 decode_any_window (window)
485 register Lisp_Object window;
487 if (NILP (window))
488 return XWINDOW (selected_window);
490 CHECK_WINDOW (window);
491 return XWINDOW (window);
494 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
495 doc: /* Return the buffer that WINDOW is displaying.
496 WINDOW defaults to the selected window. */)
497 (window)
498 Lisp_Object window;
500 return decode_window (window)->buffer;
503 DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
504 doc: /* Return the number of lines in WINDOW (including its mode line).
505 WINDOW defaults to the selected window. */)
506 (window)
507 Lisp_Object window;
509 return decode_any_window (window)->total_lines;
512 DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
513 doc: /* Return the number of display columns in WINDOW.
514 This is the width that is usable columns available for text in WINDOW.
515 If you want to find out how many columns WINDOW takes up,
516 use (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))). */)
517 (window)
518 Lisp_Object window;
520 return make_number (window_box_text_cols (decode_any_window (window)));
523 DEFUN ("window-full-width-p", Fwindow_full_width_p, Swindow_full_width_p, 0, 1, 0,
524 doc: /* Return t if WINDOW is as wide as its frame.
525 WINDOW defaults to the selected window. */)
526 (window)
527 Lisp_Object window;
529 return WINDOW_FULL_WIDTH_P (decode_any_window (window)) ? Qt : Qnil;
532 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
533 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
534 WINDOW defaults to the selected window. */)
535 (window)
536 Lisp_Object window;
538 return decode_window (window)->hscroll;
541 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
542 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
543 Return NCOL. NCOL should be zero or positive.
545 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
546 window so that the location of point moves off-window. */)
547 (window, ncol)
548 Lisp_Object window, ncol;
550 struct window *w = decode_window (window);
551 int hscroll;
553 CHECK_NUMBER (ncol);
554 hscroll = max (0, XINT (ncol));
556 /* Prevent redisplay shortcuts when changing the hscroll. */
557 if (XINT (w->hscroll) != hscroll)
558 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
560 w->hscroll = make_number (hscroll);
561 return ncol;
564 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
565 Swindow_redisplay_end_trigger, 0, 1, 0,
566 doc: /* Return WINDOW's redisplay end trigger value.
567 WINDOW defaults to the selected window.
568 See `set-window-redisplay-end-trigger' for more information. */)
569 (window)
570 Lisp_Object window;
572 return decode_window (window)->redisplay_end_trigger;
575 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
576 Sset_window_redisplay_end_trigger, 2, 2, 0,
577 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
578 VALUE should be a buffer position (typically a marker) or nil.
579 If it is a buffer position, then if redisplay in WINDOW reaches a position
580 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
581 with two arguments: WINDOW, and the end trigger value.
582 Afterwards the end-trigger value is reset to nil. */)
583 (window, value)
584 register Lisp_Object window, value;
586 register struct window *w;
588 w = decode_window (window);
589 w->redisplay_end_trigger = value;
590 return value;
593 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
594 doc: /* Return a list of the edge coordinates of WINDOW.
595 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
596 RIGHT is one more than the rightmost column occupied by WINDOW,
597 and BOTTOM is one more than the bottommost row occupied by WINDOW.
598 The edges include the space used by the window's scroll bar,
599 display margins, fringes, header line, and mode line, if it has them.
600 To get the edges of the actual text area, use `window-inside-edges'. */)
601 (window)
602 Lisp_Object window;
604 register struct window *w = decode_any_window (window);
606 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
607 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
608 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
609 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
610 Qnil))));
613 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
614 doc: /* Return a list of the edge pixel coordinates of WINDOW.
615 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
616 RIGHT is one more than the rightmost x position occupied by WINDOW,
617 and BOTTOM is one more than the bottommost y position occupied by WINDOW.
618 The pixel edges include the space used by the window's scroll bar,
619 display margins, fringes, header line, and mode line, if it has them.
620 To get the edges of the actual text area, use `window-inside-pixel-edges'. */)
621 (window)
622 Lisp_Object window;
624 register struct window *w = decode_any_window (window);
626 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
627 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
628 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
629 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
630 Qnil))));
633 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
634 doc: /* Return a list of the edge coordinates of WINDOW.
635 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
636 RIGHT is one more than the rightmost column used by text in WINDOW,
637 and BOTTOM is one more than the bottommost row used by text in WINDOW.
638 The inside edges do not include the space used by the window's scroll bar,
639 display margins, fringes, header line, and/or mode line. */)
640 (window)
641 Lisp_Object window;
643 register struct window *w = decode_any_window (window);
645 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
646 + WINDOW_LEFT_MARGIN_COLS (w)
647 + WINDOW_LEFT_FRINGE_COLS (w)),
648 make_number (WINDOW_TOP_EDGE_LINE (w)
649 + WINDOW_HEADER_LINE_LINES (w)),
650 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
651 - WINDOW_RIGHT_MARGIN_COLS (w)
652 - WINDOW_RIGHT_FRINGE_COLS (w)),
653 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
654 - WINDOW_MODE_LINE_LINES (w)));
657 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
658 doc: /* Return a list of the edge pixel coordinates of WINDOW.
659 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
660 RIGHT is one more than the rightmost x position used by text in WINDOW,
661 and BOTTOM is one more than the bottommost y position used by text in WINDOW.
662 The inside edges do not include the space used by the window's scroll bar,
663 display margins, fringes, header line, and/or mode line. */)
664 (window)
665 Lisp_Object window;
667 register struct window *w = decode_any_window (window);
669 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
670 + WINDOW_LEFT_MARGIN_WIDTH (w)
671 + WINDOW_LEFT_FRINGE_WIDTH (w)),
672 make_number (WINDOW_TOP_EDGE_Y (w)
673 + WINDOW_HEADER_LINE_HEIGHT (w)),
674 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
675 - WINDOW_RIGHT_MARGIN_WIDTH (w)
676 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
677 make_number (WINDOW_BOTTOM_EDGE_Y (w)
678 - WINDOW_MODE_LINE_HEIGHT (w)));
681 /* Test if the character at column *X, row *Y is within window W.
682 If it is not, return ON_NOTHING;
683 if it is in the window's text area,
684 set *x and *y to its location relative to the upper left corner
685 of the window, and
686 return ON_TEXT;
687 if it is on the window's modeline, return ON_MODE_LINE;
688 if it is on the border between the window and its right sibling,
689 return ON_VERTICAL_BORDER.
690 if it is on a scroll bar,
691 return ON_SCROLL_BAR.
692 if it is on the window's top line, return ON_HEADER_LINE;
693 if it is in left or right fringe of the window,
694 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE, and convert *X and *Y
695 to window-relative coordinates;
696 if it is in the marginal area to the left/right of the window,
697 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN, and convert *X and *Y
698 to window-relative coordinates.
700 X and Y are frame relative pixel coordinates. */
702 static enum window_part
703 coordinates_in_window (w, x, y)
704 register struct window *w;
705 register int *x, *y;
707 struct frame *f = XFRAME (WINDOW_FRAME (w));
708 int left_x, right_x, top_y, bottom_y;
709 enum window_part part;
710 int ux = FRAME_COLUMN_WIDTH (f);
711 int x0 = WINDOW_LEFT_EDGE_X (w);
712 int x1 = WINDOW_RIGHT_EDGE_X (w);
713 /* The width of the area where the vertical line can be dragged.
714 (Between mode lines for instance. */
715 int grabbable_width = ux;
716 int lmargin_width, rmargin_width, text_left, text_right;
718 /* In what's below, we subtract 1 when computing right_x because we
719 want the rightmost pixel, which is given by left_pixel+width-1. */
720 if (w->pseudo_window_p)
722 left_x = 0;
723 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
724 top_y = WINDOW_TOP_EDGE_Y (w);
725 bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
727 else
729 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
730 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
731 top_y = WINDOW_TOP_EDGE_Y (w);
732 bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
735 /* Outside any interesting row? */
736 if (*y < top_y || *y >= bottom_y)
737 return ON_NOTHING;
739 /* On the mode line or header line? If it's near the start of
740 the mode or header line of window that's has a horizontal
741 sibling, say it's on the vertical line. That's to be able
742 to resize windows horizontally in case we're using toolkit
743 scroll bars. */
745 if (WINDOW_WANTS_MODELINE_P (w)
746 && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
748 part = ON_MODE_LINE;
750 header_vertical_border_check:
751 /* We're somewhere on the mode line. We consider the place
752 between mode lines of horizontally adjacent mode lines
753 as the vertical border. If scroll bars on the left,
754 return the right window. */
755 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
756 || WINDOW_RIGHTMOST_P (w))
758 if (!WINDOW_LEFTMOST_P (w) && eabs (*x - x0) < grabbable_width)
760 /* Convert X and Y to window relative coordinates.
761 Vertical border is at the left edge of window. */
762 *x = max (0, *x - x0);
763 *y -= top_y;
764 return ON_VERTICAL_BORDER;
767 else
769 if (eabs (*x - x1) < grabbable_width)
771 /* Convert X and Y to window relative coordinates.
772 Vertical border is at the right edge of window. */
773 *x = min (x1, *x) - x0;
774 *y -= top_y;
775 return ON_VERTICAL_BORDER;
779 if (*x < x0 || *x >= x1)
780 return ON_NOTHING;
782 /* Convert X and Y to window relative coordinates.
783 Mode line starts at left edge of window. */
784 *x -= x0;
785 *y -= top_y;
786 return part;
789 if (WINDOW_WANTS_HEADER_LINE_P (w)
790 && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
792 part = ON_HEADER_LINE;
793 goto header_vertical_border_check;
796 if (*x < x0 || *x >= x1)
797 return ON_NOTHING;
799 /* Outside any interesting column? */
800 if (*x < left_x || *x > right_x)
802 *y -= top_y;
803 return ON_SCROLL_BAR;
806 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
807 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
809 text_left = window_box_left (w, TEXT_AREA);
810 text_right = text_left + window_box_width (w, TEXT_AREA);
812 if (FRAME_WINDOW_P (f))
814 if (!w->pseudo_window_p
815 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
816 && !WINDOW_RIGHTMOST_P (w)
817 && (eabs (*x - right_x) < grabbable_width))
819 /* Convert X and Y to window relative coordinates.
820 Vertical border is at the right edge of window. */
821 *x = min (right_x, *x) - left_x;
822 *y -= top_y;
823 return ON_VERTICAL_BORDER;
826 else
828 /* Need to say "*x > right_x" rather than >=, since on character
829 terminals, the vertical line's x coordinate is right_x. */
830 if (!w->pseudo_window_p
831 && !WINDOW_RIGHTMOST_P (w)
832 && *x > right_x - ux)
834 /* On the border on the right side of the window? Assume that
835 this area begins at RIGHT_X minus a canonical char width. */
836 *x = min (right_x, *x) - left_x;
837 *y -= top_y;
838 return ON_VERTICAL_BORDER;
842 if (*x < text_left)
844 if (lmargin_width > 0
845 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
846 ? (*x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
847 : (*x < left_x + lmargin_width)))
849 *x -= left_x;
850 if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
851 *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
852 *y -= top_y;
853 return ON_LEFT_MARGIN;
856 /* Convert X and Y to window-relative pixel coordinates. */
857 *x -= left_x;
858 *y -= top_y;
859 return ON_LEFT_FRINGE;
862 if (*x >= text_right)
864 if (rmargin_width > 0
865 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
866 ? (*x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
867 : (*x >= right_x - rmargin_width)))
869 *x -= right_x - rmargin_width;
870 if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
871 *x += WINDOW_RIGHT_FRINGE_WIDTH (w);
872 *y -= top_y;
873 return ON_RIGHT_MARGIN;
876 /* Convert X and Y to window-relative pixel coordinates. */
877 *x -= left_x + WINDOW_LEFT_FRINGE_WIDTH (w);
878 *y -= top_y;
879 return ON_RIGHT_FRINGE;
882 /* Everything special ruled out - must be on text area */
883 *x -= text_left;
884 *y -= top_y;
885 return ON_TEXT;
889 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
890 Scoordinates_in_window_p, 2, 2, 0,
891 doc: /* Return non-nil if COORDINATES are in WINDOW.
892 COORDINATES is a cons of the form (X . Y), X and Y being distances
893 measured in characters from the upper-left corner of the frame.
894 \(0 . 0) denotes the character in the upper left corner of the
895 frame.
896 If COORDINATES are in the text portion of WINDOW,
897 the coordinates relative to the window are returned.
898 If they are in the mode line of WINDOW, `mode-line' is returned.
899 If they are in the top mode line of WINDOW, `header-line' is returned.
900 If they are in the left fringe of WINDOW, `left-fringe' is returned.
901 If they are in the right fringe of WINDOW, `right-fringe' is returned.
902 If they are on the border between WINDOW and its right sibling,
903 `vertical-line' is returned.
904 If they are in the windows's left or right marginal areas, `left-margin'\n\
905 or `right-margin' is returned. */)
906 (coordinates, window)
907 register Lisp_Object coordinates, window;
909 struct window *w;
910 struct frame *f;
911 int x, y;
912 Lisp_Object lx, ly;
914 CHECK_WINDOW (window);
915 w = XWINDOW (window);
916 f = XFRAME (w->frame);
917 CHECK_CONS (coordinates);
918 lx = Fcar (coordinates);
919 ly = Fcdr (coordinates);
920 CHECK_NUMBER_OR_FLOAT (lx);
921 CHECK_NUMBER_OR_FLOAT (ly);
922 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
923 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
925 switch (coordinates_in_window (w, &x, &y))
927 case ON_NOTHING:
928 return Qnil;
930 case ON_TEXT:
931 /* X and Y are now window relative pixel coordinates. Convert
932 them to canonical char units before returning them. */
933 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
934 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
936 case ON_MODE_LINE:
937 return Qmode_line;
939 case ON_VERTICAL_BORDER:
940 return Qvertical_line;
942 case ON_HEADER_LINE:
943 return Qheader_line;
945 case ON_LEFT_FRINGE:
946 return Qleft_fringe;
948 case ON_RIGHT_FRINGE:
949 return Qright_fringe;
951 case ON_LEFT_MARGIN:
952 return Qleft_margin;
954 case ON_RIGHT_MARGIN:
955 return Qright_margin;
957 case ON_SCROLL_BAR:
958 /* Historically we are supposed to return nil in this case. */
959 return Qnil;
961 default:
962 abort ();
967 /* Callback for foreach_window, used in window_from_coordinates.
968 Check if window W contains coordinates specified by USER_DATA which
969 is actually a pointer to a struct check_window_data CW.
971 Check if window W contains coordinates *CW->x and *CW->y. If it
972 does, return W in *CW->window, as Lisp_Object, and return in
973 *CW->part the part of the window under coordinates *X,*Y. Return
974 zero from this function to stop iterating over windows. */
976 struct check_window_data
978 Lisp_Object *window;
979 int *x, *y;
980 enum window_part *part;
983 static int
984 check_window_containing (w, user_data)
985 struct window *w;
986 void *user_data;
988 struct check_window_data *cw = (struct check_window_data *) user_data;
989 enum window_part found;
990 int continue_p = 1;
992 found = coordinates_in_window (w, cw->x, cw->y);
993 if (found != ON_NOTHING)
995 *cw->part = found;
996 XSETWINDOW (*cw->window, w);
997 continue_p = 0;
1000 return continue_p;
1004 /* Find the window containing frame-relative pixel position X/Y and
1005 return it as a Lisp_Object.
1007 If X, Y is on one of the window's special `window_part' elements,
1008 set *PART to the id of that element, and return X and Y converted
1009 to window relative coordinates in WX and WY.
1011 If there is no window under X, Y return nil and leave *PART
1012 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1014 This function was previously implemented with a loop cycling over
1015 windows with Fnext_window, and starting with the frame's selected
1016 window. It turned out that this doesn't work with an
1017 implementation of next_window using Vwindow_list, because
1018 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1019 tree of F when this function is called asynchronously from
1020 note_mouse_highlight. The original loop didn't terminate in this
1021 case. */
1023 Lisp_Object
1024 window_from_coordinates (f, x, y, part, wx, wy, tool_bar_p)
1025 struct frame *f;
1026 int x, y;
1027 enum window_part *part;
1028 int *wx, *wy;
1029 int tool_bar_p;
1031 Lisp_Object window;
1032 struct check_window_data cw;
1033 enum window_part dummy;
1035 if (part == 0)
1036 part = &dummy;
1038 window = Qnil;
1039 cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
1040 foreach_window (f, check_window_containing, &cw);
1042 /* If not found above, see if it's in the tool bar window, if a tool
1043 bar exists. */
1044 if (NILP (window)
1045 && tool_bar_p
1046 && WINDOWP (f->tool_bar_window)
1047 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1048 && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
1049 != ON_NOTHING))
1051 *part = ON_TEXT;
1052 window = f->tool_bar_window;
1055 if (wx) *wx = x;
1056 if (wy) *wy = y;
1058 return window;
1061 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1062 doc: /* Return window containing coordinates X and Y on FRAME.
1063 If omitted, FRAME defaults to the currently selected frame.
1064 The top left corner of the frame is considered to be row 0,
1065 column 0. */)
1066 (x, y, frame)
1067 Lisp_Object x, y, frame;
1069 struct frame *f;
1071 if (NILP (frame))
1072 frame = selected_frame;
1073 CHECK_LIVE_FRAME (frame);
1074 f = XFRAME (frame);
1076 /* Check that arguments are integers or floats. */
1077 CHECK_NUMBER_OR_FLOAT (x);
1078 CHECK_NUMBER_OR_FLOAT (y);
1080 return window_from_coordinates (f,
1081 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1082 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1083 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1084 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1085 0, 0, 0, 0);
1088 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1089 doc: /* Return current value of point in WINDOW.
1090 WINDOW defaults to the selected window.
1092 For a nonselected window, this is the value point would have
1093 if that window were selected.
1095 Note that, when WINDOW is the selected window and its buffer
1096 is also currently selected, the value returned is the same as (point).
1097 It would be more strictly correct to return the `top-level' value
1098 of point, outside of any save-excursion forms.
1099 But that is hard to define. */)
1100 (window)
1101 Lisp_Object window;
1103 register struct window *w = decode_window (window);
1105 if (w == XWINDOW (selected_window)
1106 && current_buffer == XBUFFER (w->buffer))
1107 return Fpoint ();
1108 return Fmarker_position (w->pointm);
1111 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1112 doc: /* Return position at which display currently starts in WINDOW.
1113 WINDOW defaults to the selected window.
1114 This is updated by redisplay or by calling `set-window-start'. */)
1115 (window)
1116 Lisp_Object window;
1118 return Fmarker_position (decode_window (window)->start);
1121 /* This is text temporarily removed from the doc string below.
1123 This function returns nil if the position is not currently known.
1124 That happens when redisplay is preempted and doesn't finish.
1125 If in that case you want to compute where the end of the window would
1126 have been if redisplay had finished, do this:
1127 (save-excursion
1128 (goto-char (window-start window))
1129 (vertical-motion (1- (window-height window)) window)
1130 (point))") */
1132 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1133 doc: /* Return position at which display currently ends in WINDOW.
1134 WINDOW defaults to the selected window.
1135 This is updated by redisplay, when it runs to completion.
1136 Simply changing the buffer text or setting `window-start'
1137 does not update this value.
1138 Return nil if there is no recorded value. \(This can happen if the
1139 last redisplay of WINDOW was preempted, and did not finish.)
1140 If UPDATE is non-nil, compute the up-to-date position
1141 if it isn't already recorded. */)
1142 (window, update)
1143 Lisp_Object window, update;
1145 Lisp_Object value;
1146 struct window *w = decode_window (window);
1147 Lisp_Object buf;
1148 struct buffer *b;
1150 buf = w->buffer;
1151 CHECK_BUFFER (buf);
1152 b = XBUFFER (buf);
1154 #if 0 /* This change broke some things. We should make it later. */
1155 /* If we don't know the end position, return nil.
1156 The user can compute it with vertical-motion if he wants to.
1157 It would be nicer to do it automatically,
1158 but that's so slow that it would probably bother people. */
1159 if (NILP (w->window_end_valid))
1160 return Qnil;
1161 #endif
1163 if (! NILP (update)
1164 && ! (! NILP (w->window_end_valid)
1165 && XFASTINT (w->last_modified) >= BUF_MODIFF (b)
1166 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (b))
1167 && !noninteractive)
1169 struct text_pos startp;
1170 struct it it;
1171 struct buffer *old_buffer = NULL;
1173 /* Cannot use Fvertical_motion because that function doesn't
1174 cope with variable-height lines. */
1175 if (b != current_buffer)
1177 old_buffer = current_buffer;
1178 set_buffer_internal (b);
1181 /* In case W->start is out of the range, use something
1182 reasonable. This situation occurred when loading a file with
1183 `-l' containing a call to `rmail' with subsequent other
1184 commands. At the end, W->start happened to be BEG, while
1185 rmail had already narrowed the buffer. */
1186 if (XMARKER (w->start)->charpos < BEGV)
1187 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1188 else if (XMARKER (w->start)->charpos > ZV)
1189 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1190 else
1191 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1193 start_display (&it, w, startp);
1194 move_it_vertically (&it, window_box_height (w));
1195 if (it.current_y < it.last_visible_y)
1196 move_it_past_eol (&it);
1197 value = make_number (IT_CHARPOS (it));
1199 if (old_buffer)
1200 set_buffer_internal (old_buffer);
1202 else
1203 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1205 return value;
1208 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1209 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1210 Return POS. */)
1211 (window, pos)
1212 Lisp_Object window, pos;
1214 register struct window *w = decode_window (window);
1216 CHECK_NUMBER_COERCE_MARKER (pos);
1217 if (w == XWINDOW (selected_window)
1218 && XBUFFER (w->buffer) == current_buffer)
1219 Fgoto_char (pos);
1220 else
1221 set_marker_restricted (w->pointm, pos, w->buffer);
1223 /* We have to make sure that redisplay updates the window to show
1224 the new value of point. */
1225 if (!EQ (window, selected_window))
1226 ++windows_or_buffers_changed;
1228 return pos;
1231 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1232 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1233 Return POS.
1234 Optional third arg NOFORCE non-nil inhibits next redisplay
1235 from overriding motion of point in order to display at this exact start. */)
1236 (window, pos, noforce)
1237 Lisp_Object window, pos, noforce;
1239 register struct window *w = decode_window (window);
1241 CHECK_NUMBER_COERCE_MARKER (pos);
1242 set_marker_restricted (w->start, pos, w->buffer);
1243 /* this is not right, but much easier than doing what is right. */
1244 w->start_at_line_beg = Qnil;
1245 if (NILP (noforce))
1246 w->force_start = Qt;
1247 w->update_mode_line = Qt;
1248 XSETFASTINT (w->last_modified, 0);
1249 XSETFASTINT (w->last_overlay_modified, 0);
1250 if (!EQ (window, selected_window))
1251 windows_or_buffers_changed++;
1253 return pos;
1256 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1257 1, 1, 0,
1258 doc: /* Return WINDOW's dedicated object, usually t or nil.
1259 See also `set-window-dedicated-p'. */)
1260 (window)
1261 Lisp_Object window;
1263 return decode_window (window)->dedicated;
1266 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1267 Sset_window_dedicated_p, 2, 2, 0,
1268 doc: /* Control whether WINDOW is dedicated to the buffer it displays.
1269 If it is dedicated, Emacs will not automatically change
1270 which buffer appears in it.
1271 The second argument is the new value for the dedication flag;
1272 non-nil means yes. */)
1273 (window, arg)
1274 Lisp_Object window, arg;
1276 register struct window *w = decode_window (window);
1278 w->dedicated = arg;
1280 return w->dedicated;
1283 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1284 0, 1, 0,
1285 doc: /* Return the parameters-alist of window WINDOW.
1286 It is a list of elements of the form (PARAMETER . VALUE).
1287 If WINDOW is omitted, return information on the currently selected window. */)
1288 (window)
1289 Lisp_Object window;
1291 return Fcopy_alist (decode_window (window)->window_parameters);
1294 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1295 2, 2, 0,
1296 doc: /* Return WINDOW's value for parameter PARAMETER.
1297 If WINDOW is nil, describe the currently selected window. */)
1298 (window, parameter)
1299 Lisp_Object window, parameter;
1301 Lisp_Object result;
1303 result = Fassq (parameter, decode_window (window)->window_parameters);
1304 return CDR_SAFE (result);
1308 DEFUN ("set-window-parameter", Fset_window_parameter,
1309 Sset_window_parameter, 3, 3, 0,
1310 doc: /* Set window parameter PARAMETER to VALUE on WINDOW.
1311 If WINDOW is nil, use the currently selected window.
1312 Return VALUE. */)
1313 (window, parameter, value)
1314 Lisp_Object window, parameter, value;
1316 register struct window *w = decode_window (window);
1317 Lisp_Object old_alist_elt;
1319 old_alist_elt = Fassq (parameter, w->window_parameters);
1320 if (EQ (old_alist_elt, Qnil))
1321 w->window_parameters = Fcons (Fcons (parameter, value), w->window_parameters);
1322 else
1323 Fsetcdr (old_alist_elt, value);
1324 return value;
1328 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1329 0, 1, 0,
1330 doc: /* Return the display-table that WINDOW is using.
1331 WINDOW defaults to the selected window. */)
1332 (window)
1333 Lisp_Object window;
1335 return decode_window (window)->display_table;
1338 /* Get the display table for use on window W. This is either W's
1339 display table or W's buffer's display table. Ignore the specified
1340 tables if they are not valid; if no valid table is specified,
1341 return 0. */
1343 struct Lisp_Char_Table *
1344 window_display_table (w)
1345 struct window *w;
1347 struct Lisp_Char_Table *dp = NULL;
1349 if (DISP_TABLE_P (w->display_table))
1350 dp = XCHAR_TABLE (w->display_table);
1351 else if (BUFFERP (w->buffer))
1353 struct buffer *b = XBUFFER (w->buffer);
1355 if (DISP_TABLE_P (b->display_table))
1356 dp = XCHAR_TABLE (b->display_table);
1357 else if (DISP_TABLE_P (Vstandard_display_table))
1358 dp = XCHAR_TABLE (Vstandard_display_table);
1361 return dp;
1364 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1365 doc: /* Set WINDOW's display-table to TABLE. */)
1366 (window, table)
1367 register Lisp_Object window, table;
1369 register struct window *w;
1371 w = decode_window (window);
1372 w->display_table = table;
1373 return table;
1376 /* Record info on buffer window w is displaying
1377 when it is about to cease to display that buffer. */
1378 static void
1379 unshow_buffer (w)
1380 register struct window *w;
1382 Lisp_Object buf;
1383 struct buffer *b;
1385 buf = w->buffer;
1386 b = XBUFFER (buf);
1387 if (b != XMARKER (w->pointm)->buffer)
1388 abort ();
1390 #if 0
1391 if (w == XWINDOW (selected_window)
1392 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1393 /* Do this except when the selected window's buffer
1394 is being removed from some other window. */
1395 #endif
1396 /* last_window_start records the start position that this buffer
1397 had in the last window to be disconnected from it.
1398 Now that this statement is unconditional,
1399 it is possible for the buffer to be displayed in the
1400 selected window, while last_window_start reflects another
1401 window which was recently showing the same buffer.
1402 Some people might say that might be a good thing. Let's see. */
1403 b->last_window_start = marker_position (w->start);
1405 /* Point in the selected window's buffer
1406 is actually stored in that buffer, and the window's pointm isn't used.
1407 So don't clobber point in that buffer. */
1408 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1409 /* This line helps to fix Horsley's testbug.el bug. */
1410 && !(WINDOWP (b->last_selected_window)
1411 && w != XWINDOW (b->last_selected_window)
1412 && EQ (buf, XWINDOW (b->last_selected_window)->buffer)))
1413 temp_set_point_both (b,
1414 clip_to_bounds (BUF_BEGV (b),
1415 XMARKER (w->pointm)->charpos,
1416 BUF_ZV (b)),
1417 clip_to_bounds (BUF_BEGV_BYTE (b),
1418 marker_byte_position (w->pointm),
1419 BUF_ZV_BYTE (b)));
1421 if (WINDOWP (b->last_selected_window)
1422 && w == XWINDOW (b->last_selected_window))
1423 b->last_selected_window = Qnil;
1426 /* Put replacement into the window structure in place of old. */
1427 static void
1428 replace_window (old, replacement)
1429 Lisp_Object old, replacement;
1431 register Lisp_Object tem;
1432 register struct window *o = XWINDOW (old), *p = XWINDOW (replacement);
1434 /* If OLD is its frame's root_window, then replacement is the new
1435 root_window for that frame. */
1437 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1438 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
1440 p->left_col = o->left_col;
1441 p->top_line = o->top_line;
1442 p->total_cols = o->total_cols;
1443 p->total_lines = o->total_lines;
1444 p->desired_matrix = p->current_matrix = 0;
1445 p->vscroll = 0;
1446 bzero (&p->cursor, sizeof (p->cursor));
1447 bzero (&p->last_cursor, sizeof (p->last_cursor));
1448 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
1449 p->phys_cursor_type = -1;
1450 p->phys_cursor_width = -1;
1451 p->must_be_updated_p = 0;
1452 p->pseudo_window_p = 0;
1453 XSETFASTINT (p->window_end_vpos, 0);
1454 XSETFASTINT (p->window_end_pos, 0);
1455 p->window_end_valid = Qnil;
1456 p->frozen_window_start_p = 0;
1457 p->orig_top_line = p->orig_total_lines = Qnil;
1459 p->next = tem = o->next;
1460 if (!NILP (tem))
1461 XWINDOW (tem)->prev = replacement;
1463 p->prev = tem = o->prev;
1464 if (!NILP (tem))
1465 XWINDOW (tem)->next = replacement;
1467 p->parent = tem = o->parent;
1468 if (!NILP (tem))
1470 if (EQ (XWINDOW (tem)->vchild, old))
1471 XWINDOW (tem)->vchild = replacement;
1472 if (EQ (XWINDOW (tem)->hchild, old))
1473 XWINDOW (tem)->hchild = replacement;
1476 /*** Here, if replacement is a vertical combination
1477 and so is its new parent, we should make replacement's
1478 children be children of that parent instead. ***/
1481 DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
1482 doc: /* Remove WINDOW from the display. Default is selected window. */)
1483 (window)
1484 register Lisp_Object window;
1486 struct frame *f;
1487 if (NILP (window))
1488 window = selected_window;
1489 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1490 delete_window (window);
1492 run_window_configuration_change_hook (f);
1494 return Qnil;
1497 void
1498 delete_window (window)
1499 register Lisp_Object window;
1501 register Lisp_Object tem, parent, sib;
1502 register struct window *p;
1503 register struct window *par;
1504 struct frame *f;
1506 /* Because this function is called by other C code on non-leaf
1507 windows, the CHECK_LIVE_WINDOW macro would choke inappropriately,
1508 so we can't decode_window here. */
1509 CHECK_WINDOW (window);
1510 p = XWINDOW (window);
1512 /* It's a no-op to delete an already-deleted window. */
1513 if (NILP (p->buffer)
1514 && NILP (p->hchild)
1515 && NILP (p->vchild))
1516 return;
1518 parent = p->parent;
1519 if (NILP (parent))
1520 error ("Attempt to delete minibuffer or sole ordinary window");
1521 par = XWINDOW (parent);
1523 windows_or_buffers_changed++;
1524 Vwindow_list = Qnil;
1525 f = XFRAME (WINDOW_FRAME (p));
1526 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
1528 /* Are we trying to delete any frame's selected window? */
1530 Lisp_Object swindow, pwindow;
1532 /* See if the frame's selected window is either WINDOW
1533 or any subwindow of it, by finding all that window's parents
1534 and comparing each one with WINDOW. */
1535 swindow = FRAME_SELECTED_WINDOW (f);
1537 while (1)
1539 pwindow = swindow;
1540 while (!NILP (pwindow))
1542 if (EQ (window, pwindow))
1543 break;
1544 pwindow = XWINDOW (pwindow)->parent;
1547 /* If the window being deleted is not a parent of SWINDOW,
1548 then SWINDOW is ok as the new selected window. */
1549 if (!EQ (window, pwindow))
1550 break;
1551 /* Otherwise, try another window for SWINDOW. */
1552 swindow = Fnext_window (swindow, Qlambda, Qnil);
1554 /* If we get back to the frame's selected window,
1555 it means there was no acceptable alternative,
1556 so we cannot delete. */
1557 if (EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1558 error ("Cannot delete window");
1561 /* If we need to change SWINDOW, do it. */
1562 if (! EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1564 /* If we're about to delete the selected window on the
1565 selected frame, then we should use Fselect_window to select
1566 the new window. On the other hand, if we're about to
1567 delete the selected window on any other frame, we shouldn't do
1568 anything but set the frame's selected_window slot. */
1569 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
1570 Fselect_window (swindow, Qnil);
1571 else
1572 FRAME_SELECTED_WINDOW (f) = swindow;
1576 /* Now we know we can delete this one. */
1577 window_deletion_count++;
1579 tem = p->buffer;
1580 /* tem is null for dummy parent windows
1581 (which have inferiors but not any contents themselves) */
1582 if (!NILP (tem))
1584 unshow_buffer (p);
1585 unchain_marker (XMARKER (p->pointm));
1586 unchain_marker (XMARKER (p->start));
1589 /* Free window glyph matrices. It is sure that they are allocated
1590 again when ADJUST_GLYPHS is called. Block input so that expose
1591 events and other events that access glyph matrices are not
1592 processed while we are changing them. */
1593 BLOCK_INPUT;
1594 free_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)));
1596 tem = p->next;
1597 if (!NILP (tem))
1598 XWINDOW (tem)->prev = p->prev;
1600 tem = p->prev;
1601 if (!NILP (tem))
1602 XWINDOW (tem)->next = p->next;
1604 if (EQ (window, par->hchild))
1605 par->hchild = p->next;
1606 if (EQ (window, par->vchild))
1607 par->vchild = p->next;
1609 /* Find one of our siblings to give our space to. */
1610 sib = p->prev;
1611 if (NILP (sib))
1613 /* If p gives its space to its next sibling, that sibling needs
1614 to have its top/left side pulled back to where p's is.
1615 set_window_{height,width} will re-position the sibling's
1616 children. */
1617 sib = p->next;
1618 XWINDOW (sib)->top_line = p->top_line;
1619 XWINDOW (sib)->left_col = p->left_col;
1622 /* Stretch that sibling. */
1623 if (!NILP (par->vchild))
1624 set_window_height (sib,
1625 XFASTINT (XWINDOW (sib)->total_lines) + XFASTINT (p->total_lines),
1627 if (!NILP (par->hchild))
1628 set_window_width (sib,
1629 XFASTINT (XWINDOW (sib)->total_cols) + XFASTINT (p->total_cols),
1632 /* If parent now has only one child,
1633 put the child into the parent's place. */
1634 tem = par->hchild;
1635 if (NILP (tem))
1636 tem = par->vchild;
1637 if (NILP (XWINDOW (tem)->next)) {
1638 replace_window (parent, tem);
1639 par = XWINDOW (tem);
1642 /* Since we may be deleting combination windows, we must make sure that
1643 not only p but all its children have been marked as deleted. */
1644 if (! NILP (p->hchild))
1645 delete_all_subwindows (XWINDOW (p->hchild));
1646 else if (! NILP (p->vchild))
1647 delete_all_subwindows (XWINDOW (p->vchild));
1649 /* Mark this window as deleted. */
1650 p->buffer = p->hchild = p->vchild = Qnil;
1652 if (! NILP (par->parent))
1653 par = XWINDOW (par->parent);
1655 /* Check if we have a v/hchild with a v/hchild. In that case remove
1656 one of them. */
1658 if (! NILP (par->vchild) && ! NILP (XWINDOW (par->vchild)->vchild))
1660 p = XWINDOW (par->vchild);
1661 par->vchild = p->vchild;
1662 tem = p->vchild;
1664 else if (! NILP (par->hchild) && ! NILP (XWINDOW (par->hchild)->hchild))
1666 p = XWINDOW (par->hchild);
1667 par->hchild = p->hchild;
1668 tem = p->hchild;
1670 else
1671 p = 0;
1673 if (p)
1675 while (! NILP (tem)) {
1676 XWINDOW (tem)->parent = p->parent;
1677 if (NILP (XWINDOW (tem)->next))
1678 break;
1679 tem = XWINDOW (tem)->next;
1681 if (! NILP (tem)) {
1682 /* The next of the v/hchild we are removing is now the next of the
1683 last child for the v/hchild:
1684 Before v/hchild -> v/hchild -> next1 -> next2
1686 -> next3
1687 After: v/hchild -> next1 -> next2 -> next3
1689 XWINDOW (tem)->next = p->next;
1690 if (! NILP (p->next))
1691 XWINDOW (p->next)->prev = tem;
1693 p->next = p->prev = p->vchild = p->hchild = p->buffer = Qnil;
1697 /* Adjust glyph matrices. */
1698 adjust_glyphs (f);
1699 UNBLOCK_INPUT;
1704 /***********************************************************************
1705 Window List
1706 ***********************************************************************/
1708 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1709 pointer. This is a callback function for foreach_window, used in
1710 function window_list. */
1712 static int
1713 add_window_to_list (w, user_data)
1714 struct window *w;
1715 void *user_data;
1717 Lisp_Object *list = (Lisp_Object *) user_data;
1718 Lisp_Object window;
1719 XSETWINDOW (window, w);
1720 *list = Fcons (window, *list);
1721 return 1;
1725 /* Return a list of all windows, for use by next_window. If
1726 Vwindow_list is a list, return that list. Otherwise, build a new
1727 list, cache it in Vwindow_list, and return that. */
1729 static Lisp_Object
1730 window_list ()
1732 if (!CONSP (Vwindow_list))
1734 Lisp_Object tail;
1736 Vwindow_list = Qnil;
1737 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1739 Lisp_Object args[2];
1741 /* We are visiting windows in canonical order, and add
1742 new windows at the front of args[1], which means we
1743 have to reverse this list at the end. */
1744 args[1] = Qnil;
1745 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1746 args[0] = Vwindow_list;
1747 args[1] = Fnreverse (args[1]);
1748 Vwindow_list = Fnconc (2, args);
1752 return Vwindow_list;
1756 /* Value is non-zero if WINDOW satisfies the constraints given by
1757 OWINDOW, MINIBUF and ALL_FRAMES.
1759 MINIBUF t means WINDOW may be minibuffer windows.
1760 `lambda' means WINDOW may not be a minibuffer window.
1761 a window means a specific minibuffer window
1763 ALL_FRAMES t means search all frames,
1764 nil means search just current frame,
1765 `visible' means search just visible frames,
1766 0 means search visible and iconified frames,
1767 a window means search the frame that window belongs to,
1768 a frame means consider windows on that frame, only. */
1770 static int
1771 candidate_window_p (window, owindow, minibuf, all_frames)
1772 Lisp_Object window, owindow, minibuf, all_frames;
1774 struct window *w = XWINDOW (window);
1775 struct frame *f = XFRAME (w->frame);
1776 int candidate_p = 1;
1778 if (!BUFFERP (w->buffer))
1779 candidate_p = 0;
1780 else if (MINI_WINDOW_P (w)
1781 && (EQ (minibuf, Qlambda)
1782 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
1784 /* If MINIBUF is `lambda' don't consider any mini-windows.
1785 If it is a window, consider only that one. */
1786 candidate_p = 0;
1788 else if (EQ (all_frames, Qt))
1789 candidate_p = 1;
1790 else if (NILP (all_frames))
1792 xassert (WINDOWP (owindow));
1793 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
1795 else if (EQ (all_frames, Qvisible))
1797 FRAME_SAMPLE_VISIBILITY (f);
1798 candidate_p = FRAME_VISIBLE_P (f)
1799 && (FRAME_TERMINAL (XFRAME (w->frame))
1800 == FRAME_TERMINAL (XFRAME (selected_frame)));
1803 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
1805 FRAME_SAMPLE_VISIBILITY (f);
1806 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
1807 #ifdef HAVE_X_WINDOWS
1808 /* Yuck!! If we've just created the frame and the
1809 window-manager requested the user to place it
1810 manually, the window may still not be considered
1811 `visible'. I'd argue it should be at least
1812 something like `iconified', but don't know how to do
1813 that yet. --Stef */
1814 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
1815 && !f->output_data.x->has_been_visible)
1816 #endif
1818 && (FRAME_TERMINAL (XFRAME (w->frame))
1819 == FRAME_TERMINAL (XFRAME (selected_frame)));
1821 else if (WINDOWP (all_frames))
1822 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
1823 || EQ (XWINDOW (all_frames)->frame, w->frame)
1824 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
1825 else if (FRAMEP (all_frames))
1826 candidate_p = EQ (all_frames, w->frame);
1828 return candidate_p;
1832 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
1833 Fwindow_list. See there for the meaning of WINDOW, MINIBUF, and
1834 ALL_FRAMES. */
1836 static void
1837 decode_next_window_args (window, minibuf, all_frames)
1838 Lisp_Object *window, *minibuf, *all_frames;
1840 if (NILP (*window))
1841 *window = selected_window;
1842 else
1843 CHECK_LIVE_WINDOW (*window);
1845 /* MINIBUF nil may or may not include minibuffers. Decide if it
1846 does. */
1847 if (NILP (*minibuf))
1848 *minibuf = minibuf_level ? minibuf_window : Qlambda;
1849 else if (!EQ (*minibuf, Qt))
1850 *minibuf = Qlambda;
1852 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
1853 => count none of them, or a specific minibuffer window (the
1854 active one) to count. */
1856 /* ALL_FRAMES nil doesn't specify which frames to include. */
1857 if (NILP (*all_frames))
1858 *all_frames = (!EQ (*minibuf, Qlambda)
1859 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
1860 : Qnil);
1861 else if (EQ (*all_frames, Qvisible))
1863 else if (EQ (*all_frames, make_number (0)))
1865 else if (FRAMEP (*all_frames))
1867 else if (!EQ (*all_frames, Qt))
1868 *all_frames = Qnil;
1870 /* Now *ALL_FRAMES is t meaning search all frames, nil meaning
1871 search just current frame, `visible' meaning search just visible
1872 frames, 0 meaning search visible and iconified frames, or a
1873 window, meaning search the frame that window belongs to, or a
1874 frame, meaning consider windows on that frame, only. */
1878 /* Return the next or previous window of WINDOW in canonical ordering
1879 of windows. NEXT_P non-zero means return the next window. See the
1880 documentation string of next-window for the meaning of MINIBUF and
1881 ALL_FRAMES. */
1883 static Lisp_Object
1884 next_window (window, minibuf, all_frames, next_p)
1885 Lisp_Object window, minibuf, all_frames;
1886 int next_p;
1888 decode_next_window_args (&window, &minibuf, &all_frames);
1890 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
1891 return the first window on the frame. */
1892 if (FRAMEP (all_frames)
1893 && !EQ (all_frames, XWINDOW (window)->frame))
1894 return Fframe_first_window (all_frames);
1896 if (next_p)
1898 Lisp_Object list;
1900 /* Find WINDOW in the list of all windows. */
1901 list = Fmemq (window, window_list ());
1903 /* Scan forward from WINDOW to the end of the window list. */
1904 if (CONSP (list))
1905 for (list = XCDR (list); CONSP (list); list = XCDR (list))
1906 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1907 break;
1909 /* Scan from the start of the window list up to WINDOW. */
1910 if (!CONSP (list))
1911 for (list = Vwindow_list;
1912 CONSP (list) && !EQ (XCAR (list), window);
1913 list = XCDR (list))
1914 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1915 break;
1917 if (CONSP (list))
1918 window = XCAR (list);
1920 else
1922 Lisp_Object candidate, list;
1924 /* Scan through the list of windows for candidates. If there are
1925 candidate windows in front of WINDOW, the last one of these
1926 is the one we want. If there are candidates following WINDOW
1927 in the list, again the last one of these is the one we want. */
1928 candidate = Qnil;
1929 for (list = window_list (); CONSP (list); list = XCDR (list))
1931 if (EQ (XCAR (list), window))
1933 if (WINDOWP (candidate))
1934 break;
1936 else if (candidate_window_p (XCAR (list), window, minibuf,
1937 all_frames))
1938 candidate = XCAR (list);
1941 if (WINDOWP (candidate))
1942 window = candidate;
1945 return window;
1949 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
1950 doc: /* Return next window after WINDOW in canonical ordering of windows.
1951 If omitted, WINDOW defaults to the selected window.
1953 Optional second arg MINIBUF t means count the minibuffer window even
1954 if not active. MINIBUF nil or omitted means count the minibuffer iff
1955 it is active. MINIBUF neither t nor nil means not to count the
1956 minibuffer even if it is active.
1958 Several frames may share a single minibuffer; if the minibuffer
1959 counts, all windows on all frames that share that minibuffer count
1960 too. Therefore, `next-window' can be used to iterate through the
1961 set of windows even when the minibuffer is on another frame. If the
1962 minibuffer does not count, only windows from WINDOW's frame count.
1964 Optional third arg ALL-FRAMES t means include windows on all frames.
1965 ALL-FRAMES nil or omitted means cycle within the frames as specified
1966 above. ALL-FRAMES = `visible' means include windows on all visible frames.
1967 ALL-FRAMES = 0 means include windows on all visible and iconified frames.
1968 If ALL-FRAMES is a frame, restrict search to windows on that frame.
1969 Anything else means restrict to WINDOW's frame.
1971 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
1972 `next-window' to iterate through the entire cycle of acceptable
1973 windows, eventually ending up back at the window you started with.
1974 `previous-window' traverses the same cycle, in the reverse order. */)
1975 (window, minibuf, all_frames)
1976 Lisp_Object window, minibuf, all_frames;
1978 return next_window (window, minibuf, all_frames, 1);
1982 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
1983 doc: /* Return the window preceding WINDOW in canonical ordering of windows.
1984 If omitted, WINDOW defaults to the selected window.
1986 Optional second arg MINIBUF t means count the minibuffer window even
1987 if not active. MINIBUF nil or omitted means count the minibuffer iff
1988 it is active. MINIBUF neither t nor nil means not to count the
1989 minibuffer even if it is active.
1991 Several frames may share a single minibuffer; if the minibuffer
1992 counts, all windows on all frames that share that minibuffer count
1993 too. Therefore, `previous-window' can be used to iterate through
1994 the set of windows even when the minibuffer is on another frame. If
1995 the minibuffer does not count, only windows from WINDOW's frame count
1997 Optional third arg ALL-FRAMES t means include windows on all frames.
1998 ALL-FRAMES nil or omitted means cycle within the frames as specified
1999 above. ALL-FRAMES = `visible' means include windows on all visible frames.
2000 ALL-FRAMES = 0 means include windows on all visible and iconified frames.
2001 If ALL-FRAMES is a frame, restrict search to windows on that frame.
2002 Anything else means restrict to WINDOW's frame.
2004 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2005 `previous-window' to iterate through the entire cycle of acceptable
2006 windows, eventually ending up back at the window you started with.
2007 `next-window' traverses the same cycle, in the reverse order. */)
2008 (window, minibuf, all_frames)
2009 Lisp_Object window, minibuf, all_frames;
2011 return next_window (window, minibuf, all_frames, 0);
2015 DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
2016 doc: /* Select the ARG'th different window on this frame.
2017 All windows on current frame are arranged in a cyclic order.
2018 This command selects the window ARG steps away in that order.
2019 A negative ARG moves in the opposite order. The optional second
2020 argument ALL-FRAMES has the same meaning as in `next-window', which see. */)
2021 (arg, all_frames)
2022 Lisp_Object arg, all_frames;
2024 Lisp_Object window;
2025 int i;
2027 CHECK_NUMBER (arg);
2028 window = selected_window;
2030 for (i = XINT (arg); i > 0; --i)
2031 window = Fnext_window (window, Qnil, all_frames);
2032 for (; i < 0; ++i)
2033 window = Fprevious_window (window, Qnil, all_frames);
2035 Fselect_window (window, Qnil);
2036 return Qnil;
2040 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2041 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2042 FRAME nil or omitted means use the selected frame.
2043 WINDOW nil or omitted means use the selected window.
2044 MINIBUF t means include the minibuffer window, even if it isn't active.
2045 MINIBUF nil or omitted means include the minibuffer window only
2046 if it's active.
2047 MINIBUF neither nil nor t means never include the minibuffer window. */)
2048 (frame, minibuf, window)
2049 Lisp_Object frame, minibuf, window;
2051 if (NILP (window))
2052 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2053 CHECK_WINDOW (window);
2054 if (NILP (frame))
2055 frame = selected_frame;
2057 if (!EQ (frame, XWINDOW (window)->frame))
2058 error ("Window is on a different frame");
2060 return window_list_1 (window, minibuf, frame);
2064 /* Return a list of windows in canonical ordering. Arguments are like
2065 for `next-window'. */
2067 static Lisp_Object
2068 window_list_1 (window, minibuf, all_frames)
2069 Lisp_Object window, minibuf, all_frames;
2071 Lisp_Object tail, list, rest;
2073 decode_next_window_args (&window, &minibuf, &all_frames);
2074 list = Qnil;
2076 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2077 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2078 list = Fcons (XCAR (tail), list);
2080 /* Rotate the list to start with WINDOW. */
2081 list = Fnreverse (list);
2082 rest = Fmemq (window, list);
2083 if (!NILP (rest) && !EQ (rest, list))
2085 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2087 XSETCDR (tail, Qnil);
2088 list = nconc2 (rest, list);
2090 return list;
2095 /* Look at all windows, performing an operation specified by TYPE
2096 with argument OBJ.
2097 If FRAMES is Qt, look at all frames;
2098 Qnil, look at just the selected frame;
2099 Qvisible, look at visible frames;
2100 a frame, just look at windows on that frame.
2101 If MINI is non-zero, perform the operation on minibuffer windows too. */
2103 enum window_loop
2105 WINDOW_LOOP_UNUSED,
2106 GET_BUFFER_WINDOW, /* Arg is buffer */
2107 GET_LRU_WINDOW, /* Arg is t for full-width windows only */
2108 DELETE_OTHER_WINDOWS, /* Arg is window not to delete */
2109 DELETE_BUFFER_WINDOWS, /* Arg is buffer */
2110 GET_LARGEST_WINDOW,
2111 UNSHOW_BUFFER, /* Arg is buffer */
2112 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2113 CHECK_ALL_WINDOWS
2116 static Lisp_Object
2117 window_loop (type, obj, mini, frames)
2118 enum window_loop type;
2119 Lisp_Object obj, frames;
2120 int mini;
2122 Lisp_Object window, windows, best_window, frame_arg;
2123 struct frame *f;
2124 struct gcpro gcpro1;
2126 /* If we're only looping through windows on a particular frame,
2127 frame points to that frame. If we're looping through windows
2128 on all frames, frame is 0. */
2129 if (FRAMEP (frames))
2130 f = XFRAME (frames);
2131 else if (NILP (frames))
2132 f = SELECTED_FRAME ();
2133 else
2134 f = NULL;
2136 if (f)
2137 frame_arg = Qlambda;
2138 else if (EQ (frames, make_number (0)))
2139 frame_arg = frames;
2140 else if (EQ (frames, Qvisible))
2141 frame_arg = frames;
2142 else
2143 frame_arg = Qt;
2145 /* frame_arg is Qlambda to stick to one frame,
2146 Qvisible to consider all visible frames,
2147 or Qt otherwise. */
2149 /* Pick a window to start with. */
2150 if (WINDOWP (obj))
2151 window = obj;
2152 else if (f)
2153 window = FRAME_SELECTED_WINDOW (f);
2154 else
2155 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2157 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2158 GCPRO1 (windows);
2159 best_window = Qnil;
2161 for (; CONSP (windows); windows = XCDR (windows))
2163 struct window *w;
2165 window = XCAR (windows);
2166 w = XWINDOW (window);
2168 /* Note that we do not pay attention here to whether the frame
2169 is visible, since Fwindow_list skips non-visible frames if
2170 that is desired, under the control of frame_arg. */
2171 if (!MINI_WINDOW_P (w)
2172 /* For UNSHOW_BUFFER, we must always consider all windows. */
2173 || type == UNSHOW_BUFFER
2174 || (mini && minibuf_level > 0))
2175 switch (type)
2177 case GET_BUFFER_WINDOW:
2178 if (EQ (w->buffer, obj)
2179 /* Don't find any minibuffer window
2180 except the one that is currently in use. */
2181 && (MINI_WINDOW_P (w)
2182 ? EQ (window, minibuf_window)
2183 : 1))
2185 if (NILP (best_window))
2186 best_window = window;
2187 else if (EQ (window, selected_window))
2188 /* Prefer to return selected-window. */
2189 RETURN_UNGCPRO (window);
2190 else if (EQ (Fwindow_frame (window), selected_frame))
2191 /* Prefer windows on the current frame. */
2192 best_window = window;
2194 break;
2196 case GET_LRU_WINDOW:
2197 /* `obj' is an integer encoding a bitvector.
2198 `obj & 1' means consider only full-width windows.
2199 `obj & 2' means consider also dedicated windows. */
2200 if (((XINT (obj) & 1) && !WINDOW_FULL_WIDTH_P (w))
2201 || (!(XINT (obj) & 2) && !NILP (w->dedicated))
2202 /* Minibuffer windows are always ignored. */
2203 || MINI_WINDOW_P (w))
2204 break;
2205 if (NILP (best_window)
2206 || (XFASTINT (XWINDOW (best_window)->use_time)
2207 > XFASTINT (w->use_time)))
2208 best_window = window;
2209 break;
2211 case DELETE_OTHER_WINDOWS:
2212 if (!EQ (window, obj))
2213 Fdelete_window (window);
2214 break;
2216 case DELETE_BUFFER_WINDOWS:
2217 if (EQ (w->buffer, obj))
2219 struct frame *f = XFRAME (WINDOW_FRAME (w));
2221 /* If this window is dedicated, and in a frame of its own,
2222 kill the frame. */
2223 if (EQ (window, FRAME_ROOT_WINDOW (f))
2224 && !NILP (w->dedicated)
2225 && other_visible_frames (f))
2227 /* Skip the other windows on this frame.
2228 There might be one, the minibuffer! */
2229 while (CONSP (XCDR (windows))
2230 && EQ (XWINDOW (XCAR (windows))->frame,
2231 XWINDOW (XCAR (XCDR (windows)))->frame))
2232 windows = XCDR (windows);
2234 /* Now we can safely delete the frame. */
2235 Fdelete_frame (w->frame, Qnil);
2237 else if (NILP (w->parent))
2239 /* If we're deleting the buffer displayed in the
2240 only window on the frame, find a new buffer to
2241 display there. */
2242 Lisp_Object buffer;
2243 buffer = Fother_buffer (obj, Qnil, w->frame);
2244 Fset_window_buffer (window, buffer, Qnil);
2245 if (EQ (window, selected_window))
2246 Fset_buffer (w->buffer);
2248 else
2249 Fdelete_window (window);
2251 break;
2253 case GET_LARGEST_WINDOW:
2254 { /* nil `obj' means to ignore dedicated windows. */
2255 /* Ignore dedicated windows and minibuffers. */
2256 if (MINI_WINDOW_P (w) || (NILP (obj) && !NILP (w->dedicated)))
2257 break;
2259 if (NILP (best_window))
2260 best_window = window;
2261 else
2263 struct window *b = XWINDOW (best_window);
2264 if (XFASTINT (w->total_lines) * XFASTINT (w->total_cols)
2265 > XFASTINT (b->total_lines) * XFASTINT (b->total_cols))
2266 best_window = window;
2269 break;
2271 case UNSHOW_BUFFER:
2272 if (EQ (w->buffer, obj))
2274 Lisp_Object buffer;
2275 struct frame *f = XFRAME (w->frame);
2277 /* Find another buffer to show in this window. */
2278 buffer = Fother_buffer (obj, Qnil, w->frame);
2280 /* If this window is dedicated, and in a frame of its own,
2281 kill the frame. */
2282 if (EQ (window, FRAME_ROOT_WINDOW (f))
2283 && !NILP (w->dedicated)
2284 && other_visible_frames (f))
2286 /* Skip the other windows on this frame.
2287 There might be one, the minibuffer! */
2288 while (CONSP (XCDR (windows))
2289 && EQ (XWINDOW (XCAR (windows))->frame,
2290 XWINDOW (XCAR (XCDR (windows)))->frame))
2291 windows = XCDR (windows);
2293 /* Now we can safely delete the frame. */
2294 Fdelete_frame (w->frame, Qnil);
2296 else if (!NILP (w->dedicated) && !NILP (w->parent))
2298 Lisp_Object window;
2299 XSETWINDOW (window, w);
2300 /* If this window is dedicated and not the only window
2301 in its frame, then kill it. */
2302 Fdelete_window (window);
2304 else
2306 /* Otherwise show a different buffer in the window. */
2307 w->dedicated = Qnil;
2308 Fset_window_buffer (window, buffer, Qnil);
2309 if (EQ (window, selected_window))
2310 Fset_buffer (w->buffer);
2313 break;
2315 case REDISPLAY_BUFFER_WINDOWS:
2316 if (EQ (w->buffer, obj))
2318 mark_window_display_accurate (window, 0);
2319 w->update_mode_line = Qt;
2320 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2321 ++update_mode_lines;
2322 best_window = window;
2324 break;
2326 /* Check for a window that has a killed buffer. */
2327 case CHECK_ALL_WINDOWS:
2328 if (! NILP (w->buffer)
2329 && NILP (XBUFFER (w->buffer)->name))
2330 abort ();
2331 break;
2333 case WINDOW_LOOP_UNUSED:
2334 break;
2338 UNGCPRO;
2339 return best_window;
2342 /* Used for debugging. Abort if any window has a dead buffer. */
2344 void
2345 check_all_windows ()
2347 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2350 DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 2, 0,
2351 doc: /* Return the window least recently selected or used for display.
2352 \(LRU means Least Recently Used.)
2354 Return a full-width window if possible.
2355 A minibuffer window is never a candidate.
2356 A dedicated window is never a candidate, unless DEDICATED is non-nil,
2357 so if all windows are dedicated, the value is nil.
2358 If optional argument FRAME is `visible', search all visible frames.
2359 If FRAME is 0, search all visible and iconified frames.
2360 If FRAME is t, search all frames.
2361 If FRAME is nil, search only the selected frame.
2362 If FRAME is a frame, search only that frame. */)
2363 (frame, dedicated)
2364 Lisp_Object frame, dedicated;
2366 register Lisp_Object w;
2367 /* First try for a window that is full-width */
2368 w = window_loop (GET_LRU_WINDOW,
2369 NILP (dedicated) ? make_number (1) : make_number (3),
2370 0, frame);
2371 if (!NILP (w) && !EQ (w, selected_window))
2372 return w;
2373 /* If none of them, try the rest */
2374 return window_loop (GET_LRU_WINDOW,
2375 NILP (dedicated) ? make_number (0) : make_number (2),
2376 0, frame);
2379 DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 2, 0,
2380 doc: /* Return the largest window in area.
2381 A minibuffer window is never a candidate.
2382 A dedicated window is never a candidate unless DEDICATED is non-nil,
2383 so if all windows are dedicated, the value is nil.
2384 If optional argument FRAME is `visible', search all visible frames.
2385 If FRAME is 0, search all visible and iconified frames.
2386 If FRAME is t, search all frames.
2387 If FRAME is nil, search only the selected frame.
2388 If FRAME is a frame, search only that frame. */)
2389 (frame, dedicated)
2390 Lisp_Object frame, dedicated;
2392 return window_loop (GET_LARGEST_WINDOW, dedicated, 0,
2393 frame);
2396 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 1, 2, 0,
2397 doc: /* Return a window currently displaying BUFFER, or nil if none.
2398 BUFFER can be a buffer or a buffer name.
2399 If optional argument FRAME is `visible', search all visible frames.
2400 If optional argument FRAME is 0, search all visible and iconified frames.
2401 If FRAME is t, search all frames.
2402 If FRAME is nil, search only the selected frame.
2403 If FRAME is a frame, search only that frame. */)
2404 (buffer, frame)
2405 Lisp_Object buffer, frame;
2407 buffer = Fget_buffer (buffer);
2408 if (BUFFERP (buffer))
2409 return window_loop (GET_BUFFER_WINDOW, buffer, 1, frame);
2410 else
2411 return Qnil;
2414 DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
2415 0, 1, "",
2416 doc: /* Make WINDOW (or the selected window) fill its frame.
2417 Only the frame WINDOW is on is affected.
2418 This function tries to reduce display jumps
2419 by keeping the text previously visible in WINDOW
2420 in the same place on the frame. Doing this depends on
2421 the value of (window-start WINDOW), so if calling this function
2422 in a program gives strange scrolling, make sure the window-start
2423 value is reasonable when this function is called. */)
2424 (window)
2425 Lisp_Object window;
2427 struct window *w;
2428 int startpos;
2429 int top, new_top;
2431 if (NILP (window))
2432 window = selected_window;
2433 else
2434 CHECK_LIVE_WINDOW (window);
2435 w = XWINDOW (window);
2437 startpos = marker_position (w->start);
2438 top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2440 if (MINI_WINDOW_P (w) && top > 0)
2441 error ("Can't expand minibuffer to full frame");
2443 window_loop (DELETE_OTHER_WINDOWS, window, 0, WINDOW_FRAME (w));
2445 /* Try to minimize scrolling, by setting the window start to the point
2446 will cause the text at the old window start to be at the same place
2447 on the frame. But don't try to do this if the window start is
2448 outside the visible portion (as might happen when the display is
2449 not current, due to typeahead). */
2450 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2451 if (new_top != top
2452 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2453 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2455 struct position pos;
2456 struct buffer *obuf = current_buffer;
2458 Fset_buffer (w->buffer);
2459 /* This computation used to temporarily move point, but that can
2460 have unwanted side effects due to text properties. */
2461 pos = *vmotion (startpos, -top, w);
2463 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2464 w->window_end_valid = Qnil;
2465 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2466 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2467 : Qnil);
2468 /* We need to do this, so that the window-scroll-functions
2469 get called. */
2470 w->optional_new_start = Qt;
2472 set_buffer_internal (obuf);
2475 return Qnil;
2478 DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
2479 1, 2, "bDelete windows on (buffer): ",
2480 doc: /* Delete all windows showing BUFFER.
2481 BUFFER must be a buffer or the name of an existing buffer.
2482 Optional second argument FRAME controls which frames are affected.
2483 If optional argument FRAME is `visible', search all visible frames.
2484 If FRAME is 0, search all visible and iconified frames.
2485 If FRAME is nil, search all frames.
2486 If FRAME is t, search only the selected frame.
2487 If FRAME is a frame, search only that frame. */)
2488 (buffer, frame)
2489 Lisp_Object buffer, frame;
2491 /* FRAME uses t and nil to mean the opposite of what window_loop
2492 expects. */
2493 if (NILP (frame))
2494 frame = Qt;
2495 else if (EQ (frame, Qt))
2496 frame = Qnil;
2498 if (!NILP (buffer))
2500 buffer = Fget_buffer (buffer);
2501 CHECK_BUFFER (buffer);
2502 window_loop (DELETE_BUFFER_WINDOWS, buffer, 0, frame);
2505 return Qnil;
2508 DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows,
2509 Sreplace_buffer_in_windows,
2510 1, 1, "bReplace buffer in windows: ",
2511 doc: /* Replace BUFFER with some other buffer in all windows showing it.
2512 BUFFER may be a buffer or the name of an existing buffer. */)
2513 (buffer)
2514 Lisp_Object buffer;
2516 if (!NILP (buffer))
2518 buffer = Fget_buffer (buffer);
2519 CHECK_BUFFER (buffer);
2520 window_loop (UNSHOW_BUFFER, buffer, 0, Qt);
2522 return Qnil;
2525 /* Replace BUFFER with some other buffer in all windows
2526 of all frames, even those on other keyboards. */
2528 void
2529 replace_buffer_in_all_windows (buffer)
2530 Lisp_Object buffer;
2532 #ifdef MULTI_KBOARD
2533 Lisp_Object tail, frame;
2535 /* A single call to window_loop won't do the job
2536 because it only considers frames on the current keyboard.
2537 So loop manually over frames, and handle each one. */
2538 FOR_EACH_FRAME (tail, frame)
2539 window_loop (UNSHOW_BUFFER, buffer, 1, frame);
2540 #else
2541 window_loop (UNSHOW_BUFFER, buffer, 1, Qt);
2542 #endif
2545 /* Set the height of WINDOW and all its inferiors. */
2547 /* The smallest acceptable dimensions for a window. Anything smaller
2548 might crash Emacs. */
2550 #define MIN_SAFE_WINDOW_WIDTH (2)
2551 #define MIN_SAFE_WINDOW_HEIGHT (1)
2553 /* For wp non-zero the total number of columns of window w. Otherwise
2554 the total number of lines of w. */
2556 #define WINDOW_TOTAL_SIZE(w, wp) \
2557 (wp ? WINDOW_TOTAL_COLS (w) : WINDOW_TOTAL_LINES (w))
2559 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2560 minimum allowable size. */
2562 void
2563 check_frame_size (frame, rows, cols)
2564 FRAME_PTR frame;
2565 int *rows, *cols;
2567 /* For height, we have to see:
2568 how many windows the frame has at minimum (one or two),
2569 and whether it has a menu bar or other special stuff at the top. */
2570 int min_height
2571 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
2572 ? MIN_SAFE_WINDOW_HEIGHT
2573 : 2 * MIN_SAFE_WINDOW_HEIGHT);
2575 if (FRAME_TOP_MARGIN (frame) > 0)
2576 min_height += FRAME_TOP_MARGIN (frame);
2578 if (*rows < min_height)
2579 *rows = min_height;
2580 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2581 *cols = MIN_SAFE_WINDOW_WIDTH;
2584 /* Value is non-zero if window W is fixed-size. WIDTH_P non-zero means
2585 check if W's width can be changed, otherwise check W's height.
2586 CHECK_SIBLINGS_P non-zero means check resizablity of WINDOW's
2587 siblings, too. If none of the siblings is resizable, WINDOW isn't
2588 either. */
2590 static int
2591 window_fixed_size_p (w, width_p, check_siblings_p)
2592 struct window *w;
2593 int width_p, check_siblings_p;
2595 int fixed_p;
2596 struct window *c;
2598 if (!NILP (w->hchild))
2600 c = XWINDOW (w->hchild);
2602 if (width_p)
2604 /* A horizontal combination is fixed-width if all of if its
2605 children are. */
2606 while (c && window_fixed_size_p (c, width_p, 0))
2607 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2608 fixed_p = c == NULL;
2610 else
2612 /* A horizontal combination is fixed-height if one of if its
2613 children is. */
2614 while (c && !window_fixed_size_p (c, width_p, 0))
2615 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2616 fixed_p = c != NULL;
2619 else if (!NILP (w->vchild))
2621 c = XWINDOW (w->vchild);
2623 if (width_p)
2625 /* A vertical combination is fixed-width if one of if its
2626 children is. */
2627 while (c && !window_fixed_size_p (c, width_p, 0))
2628 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2629 fixed_p = c != NULL;
2631 else
2633 /* A vertical combination is fixed-height if all of if its
2634 children are. */
2635 while (c && window_fixed_size_p (c, width_p, 0))
2636 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2637 fixed_p = c == NULL;
2640 else if (BUFFERP (w->buffer))
2642 struct buffer *old = current_buffer;
2643 Lisp_Object val;
2645 current_buffer = XBUFFER (w->buffer);
2646 val = find_symbol_value (Qwindow_size_fixed);
2647 current_buffer = old;
2649 fixed_p = 0;
2650 if (!EQ (val, Qunbound))
2652 fixed_p = !NILP (val);
2654 if (fixed_p
2655 && ((EQ (val, Qheight) && width_p)
2656 || (EQ (val, Qwidth) && !width_p)))
2657 fixed_p = 0;
2660 /* Can't tell if this one is resizable without looking at
2661 siblings. If all siblings are fixed-size this one is too. */
2662 if (!fixed_p && check_siblings_p && WINDOWP (w->parent))
2664 Lisp_Object child;
2666 for (child = w->prev; WINDOWP (child); child = XWINDOW (child)->prev)
2667 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2668 break;
2670 if (NILP (child))
2671 for (child = w->next; WINDOWP (child); child = XWINDOW (child)->next)
2672 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2673 break;
2675 if (NILP (child))
2676 fixed_p = 1;
2679 else
2680 fixed_p = 1;
2682 return fixed_p;
2685 /* Return minimum size of leaf window W. WIDTH_P non-zero means return
2686 the minimum width of W, WIDTH_P zero means return the minimum height
2687 of W. SAFE_P non-zero means ignore window-min-height|width but just
2688 return values that won't crash Emacs and don't hide components like
2689 fringes, scrollbars, or modelines. If WIDTH_P is zero and W is the
2690 minibuffer window, always return 1. */
2692 static int
2693 window_min_size_2 (w, width_p, safe_p)
2694 struct window *w;
2695 int width_p, safe_p;
2697 /* We should consider buffer-local values of window_min_height and
2698 window_min_width here. */
2699 if (width_p)
2701 int safe_size = (MIN_SAFE_WINDOW_WIDTH
2702 + WINDOW_FRINGE_COLS (w)
2703 + WINDOW_SCROLL_BAR_COLS (w));
2705 return safe_p ? safe_size : max (window_min_width, safe_size);
2707 else if (MINI_WINDOW_P (w))
2708 return 1;
2709 else
2711 int safe_size = (MIN_SAFE_WINDOW_HEIGHT
2712 + ((BUFFERP (w->buffer)
2713 && !NILP (XBUFFER (w->buffer)->mode_line_format))
2714 ? 1 : 0));
2716 return safe_p ? safe_size : max (window_min_height, safe_size);
2720 /* Return minimum size of window W, not taking fixed-width windows into
2721 account. WIDTH_P non-zero means return the minimum width, otherwise
2722 return the minimum height. SAFE_P non-zero means ignore
2723 window-min-height|width but just return values that won't crash Emacs
2724 and don't hide components like fringes, scrollbars, or modelines. If
2725 W is a combination window, compute the minimum size from the minimum
2726 sizes of W's children. */
2728 static int
2729 window_min_size_1 (w, width_p, safe_p)
2730 struct window *w;
2731 int width_p, safe_p;
2733 struct window *c;
2734 int size;
2736 if (!NILP (w->hchild))
2738 /* W is a horizontal combination. */
2739 c = XWINDOW (w->hchild);
2740 size = 0;
2742 if (width_p)
2744 /* The minimum width of a horizontal combination is the sum of
2745 the minimum widths of its children. */
2746 while (c)
2748 size += window_min_size_1 (c, 1, safe_p);
2749 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2752 else
2754 /* The minimum height of a horizontal combination is the
2755 maximum of the minimum heights of its children. */
2756 while (c)
2758 size = max (window_min_size_1 (c, 0, safe_p), size);
2759 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2763 else if (!NILP (w->vchild))
2765 /* W is a vertical combination. */
2766 c = XWINDOW (w->vchild);
2767 size = 0;
2769 if (width_p)
2771 /* The minimum width of a vertical combination is the maximum
2772 of the minimum widths of its children. */
2773 while (c)
2775 size = max (window_min_size_1 (c, 1, safe_p), size);
2776 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2779 else
2781 /* The minimum height of a vertical combination is the sum of
2782 the minimum height of its children. */
2783 while (c)
2785 size += window_min_size_1 (c, 0, safe_p);
2786 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2790 else
2791 /* W is a leaf window. */
2792 size = window_min_size_2 (w, width_p, safe_p);
2794 return size;
2797 /* Return the minimum size of window W, taking fixed-size windows into
2798 account. WIDTH_P non-zero means return the minimum width, otherwise
2799 return the minimum height. SAFE_P non-zero means ignore
2800 window-min-height|width but just return values that won't crash Emacs
2801 and don't hide components like fringes, scrollbars, or modelines.
2802 IGNORE_FIXED_P non-zero means ignore if W is fixed-size. Set *FIXED
2803 to 1 if W is fixed-size unless FIXED is null. */
2805 static int
2806 window_min_size (w, width_p, safe_p, ignore_fixed_p, fixed)
2807 struct window *w;
2808 int width_p, safe_p, ignore_fixed_p, *fixed;
2810 int size, fixed_p;
2812 if (ignore_fixed_p)
2813 fixed_p = 0;
2814 else
2815 fixed_p = window_fixed_size_p (w, width_p, 1);
2817 if (fixed)
2818 *fixed = fixed_p;
2820 if (fixed_p)
2821 size = WINDOW_TOTAL_SIZE (w, width_p);
2822 else
2823 size = window_min_size_1 (w, width_p, safe_p);
2825 return size;
2829 /* Adjust the margins of window W if text area is too small.
2830 Return 1 if window width is ok after adjustment; 0 if window
2831 is still too narrow. */
2833 static int
2834 adjust_window_margins (w)
2835 struct window *w;
2837 int box_cols = (WINDOW_TOTAL_COLS (w)
2838 - WINDOW_FRINGE_COLS (w)
2839 - WINDOW_SCROLL_BAR_COLS (w));
2840 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
2841 + WINDOW_RIGHT_MARGIN_COLS (w));
2843 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
2844 return 1;
2846 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
2847 return 0;
2849 /* Window's text area is too narrow, but reducing the window
2850 margins will fix that. */
2851 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
2852 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
2854 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
2855 w->left_margin_cols = w->right_margin_cols
2856 = make_number (margin_cols/2);
2857 else
2858 w->right_margin_cols = make_number (margin_cols);
2860 else
2861 w->left_margin_cols = make_number (margin_cols);
2862 return 1;
2865 /* Calculate new sizes for windows in the list FORWARD when their
2866 compound size goes from TOTAL to SIZE. TOTAL must be greater than
2867 SIZE. The number of windows in FORWARD is NCHILDREN, and the number
2868 that can shrink is SHRINKABLE. Fixed-size windows may be shrunk if
2869 and only if RESIZE_FIXED_P is non-zero. WIDTH_P non-zero means
2870 shrink columns, otherwise shrink lines.
2872 SAFE_P zero means windows may be sized down to window-min-height
2873 lines (window-min-window columns for WIDTH_P non-zero). SAFE_P
2874 non-zero means windows may be sized down to their minimum safe sizes
2875 taking into account the space needed to display modelines, fringes,
2876 and scrollbars.
2878 This function returns an allocated array of new sizes that the caller
2879 must free. A size -1 means the window is fixed and RESIZE_FIXED_P is
2880 zero. A size zero means the window shall be deleted. Array index 0
2881 refers to the first window in FORWARD, 1 to the second, and so on.
2883 This function resizes windows proportionally to their size. It also
2884 tries to preserve smaller windows by resizing larger windows before
2885 resizing any window to zero. If resize_proportionally is non-nil for
2886 a specific window, it will attempt to strictly resize that window
2887 proportionally, even at the expense of deleting smaller windows. */
2888 static int *
2889 shrink_windows (total, size, nchildren, shrinkable, resize_fixed_p,
2890 forward, width_p, safe_p)
2891 int total, size, nchildren, shrinkable;
2892 int resize_fixed_p, width_p, safe_p;
2893 Lisp_Object forward;
2895 int available_resize = 0;
2896 int *new_sizes, *min_sizes;
2897 struct window *c;
2898 Lisp_Object child;
2899 int smallest = total;
2900 int total_removed = 0;
2901 int total_shrink = total - size;
2902 int i;
2904 new_sizes = xmalloc (sizeof (*new_sizes) * nchildren);
2905 min_sizes = xmalloc (sizeof (*min_sizes) * nchildren);
2907 for (i = 0, child = forward; !NILP (child); child = c->next, ++i)
2909 int child_size;
2911 c = XWINDOW (child);
2912 child_size = WINDOW_TOTAL_SIZE (c, width_p);
2914 if (!resize_fixed_p && window_fixed_size_p (c, width_p, 0))
2915 new_sizes[i] = -1;
2916 else
2918 new_sizes[i] = child_size;
2919 min_sizes[i] = window_min_size_1 (c, width_p, safe_p);
2920 if (child_size > min_sizes[i]
2921 && NILP (c->resize_proportionally))
2922 available_resize += child_size - min_sizes[i];
2925 /* We might need to shrink some windows to zero. Find the smallest
2926 windows and set them to 0 until we can fulfil the new size. */
2928 while (shrinkable > 1 && size + available_resize < total)
2930 for (i = 0; i < nchildren; ++i)
2931 if (new_sizes[i] > 0 && smallest > new_sizes[i])
2932 smallest = new_sizes[i];
2934 for (i = 0; i < nchildren; ++i)
2935 if (new_sizes[i] == smallest)
2937 /* Resize this window down to zero. */
2938 new_sizes[i] = 0;
2939 if (smallest > min_sizes[i])
2940 available_resize -= smallest - min_sizes[i];
2941 available_resize += smallest;
2942 --shrinkable;
2943 total_removed += smallest;
2945 /* We don't know what the smallest is now. */
2946 smallest = total;
2948 /* Out of for, just remove one window at the time and
2949 check again if we have enough space. */
2950 break;
2954 /* Now, calculate the new sizes. Try to shrink each window
2955 proportional to its size. */
2956 for (i = 0; i < nchildren; ++i)
2958 if (new_sizes[i] > min_sizes[i])
2960 int to_shrink = total_shrink * new_sizes[i] / total;
2962 if (new_sizes[i] - to_shrink < min_sizes[i])
2963 to_shrink = new_sizes[i] - min_sizes[i];
2964 new_sizes[i] -= to_shrink;
2965 total_removed += to_shrink;
2969 /* Any reminder due to rounding, we just subtract from windows
2970 that are left and still can be shrunk. */
2971 while (total_shrink > total_removed)
2973 int nonzero_sizes = 0;
2974 int nonzero_idx = -1;
2976 for (i = 0; i < nchildren; ++i)
2977 if (new_sizes[i] > 0)
2979 ++nonzero_sizes;
2980 nonzero_idx = i;
2983 for (i = 0; i < nchildren; ++i)
2984 if (new_sizes[i] > min_sizes[i])
2986 --new_sizes[i];
2987 ++total_removed;
2989 /* Out of for, just shrink one window at the time and
2990 check again if we have enough space. */
2991 break;
2994 /* Special case, only one window left. */
2995 if (nonzero_sizes == 1)
2996 break;
2999 /* Any surplus due to rounding, we add to windows that are left. */
3000 while (total_shrink < total_removed)
3002 for (i = 0; i < nchildren; ++i)
3004 if (new_sizes[i] != 0 && total_shrink < total_removed)
3006 ++new_sizes[i];
3007 --total_removed;
3008 break;
3013 xfree (min_sizes);
3015 return new_sizes;
3018 /* Set WINDOW's height or width to SIZE. WIDTH_P non-zero means set
3019 WINDOW's width. Resize WINDOW's children, if any, so that they keep
3020 their proportionate size relative to WINDOW.
3022 If FIRST_ONLY is 1, change only the first of WINDOW's children when
3023 they are in series. If LAST_ONLY is 1, change only the last of
3024 WINDOW's children when they are in series.
3026 Propagate WINDOW's top or left edge position to children. Delete
3027 windows that become too small unless NODELETE_P is 1. When
3028 NODELETE_P equals 2 do not honor settings for window-min-height and
3029 window-min-width when resizing windows but use safe defaults instead.
3030 This should give better behavior when resizing frames. */
3032 static void
3033 size_window (window, size, width_p, nodelete_p, first_only, last_only)
3034 Lisp_Object window;
3035 int size, width_p, nodelete_p;
3036 int first_only, last_only;
3038 struct window *w = XWINDOW (window);
3039 struct window *c;
3040 Lisp_Object child, *forward, *sideward;
3041 int old_size = WINDOW_TOTAL_SIZE (w, width_p);
3043 size = max (0, size);
3045 /* Delete WINDOW if it's too small. */
3046 if (nodelete_p != 1 && !NILP (w->parent)
3047 && size < window_min_size_1 (w, width_p, nodelete_p == 2))
3049 delete_window (window);
3050 return;
3053 /* Set redisplay hints. */
3054 w->last_modified = make_number (0);
3055 w->last_overlay_modified = make_number (0);
3056 windows_or_buffers_changed++;
3057 FRAME_WINDOW_SIZES_CHANGED (XFRAME (w->frame)) = 1;
3059 if (width_p)
3061 sideward = &w->vchild;
3062 forward = &w->hchild;
3063 w->total_cols = make_number (size);
3064 adjust_window_margins (w);
3066 else
3068 sideward = &w->hchild;
3069 forward = &w->vchild;
3070 w->total_lines = make_number (size);
3071 w->orig_total_lines = Qnil;
3074 if (!NILP (*sideward))
3076 /* We have a chain of parallel siblings whose size should all change. */
3077 for (child = *sideward; !NILP (child); child = c->next)
3079 c = XWINDOW (child);
3080 if (width_p)
3081 c->left_col = w->left_col;
3082 else
3083 c->top_line = w->top_line;
3084 size_window (child, size, width_p, nodelete_p,
3085 first_only, last_only);
3088 else if (!NILP (*forward) && last_only)
3090 /* Change the last in a series of siblings. */
3091 Lisp_Object last_child;
3092 int child_size;
3094 for (child = *forward; !NILP (child); child = c->next)
3096 c = XWINDOW (child);
3097 last_child = child;
3100 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3101 size_window (last_child, size - old_size + child_size,
3102 width_p, nodelete_p, first_only, last_only);
3104 else if (!NILP (*forward) && first_only)
3106 /* Change the first in a series of siblings. */
3107 int child_size;
3109 child = *forward;
3110 c = XWINDOW (child);
3112 if (width_p)
3113 c->left_col = w->left_col;
3114 else
3115 c->top_line = w->top_line;
3117 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3118 size_window (child, size - old_size + child_size,
3119 width_p, nodelete_p, first_only, last_only);
3121 else if (!NILP (*forward))
3123 int fixed_size, each, extra, n;
3124 int resize_fixed_p, nfixed;
3125 int last_pos, first_pos, nchildren, total;
3126 int *new_sizes = NULL;
3128 /* Determine the fixed-size portion of this window, and the
3129 number of child windows. */
3130 fixed_size = nchildren = nfixed = total = 0;
3131 for (child = *forward; !NILP (child); child = c->next, ++nchildren)
3133 int child_size;
3135 c = XWINDOW (child);
3136 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3137 total += child_size;
3139 if (window_fixed_size_p (c, width_p, 0))
3141 fixed_size += child_size;
3142 ++nfixed;
3146 /* If the new size is smaller than fixed_size, or if there
3147 aren't any resizable windows, allow resizing fixed-size
3148 windows. */
3149 resize_fixed_p = nfixed == nchildren || size < fixed_size;
3151 /* Compute how many lines/columns to add/remove to each child. The
3152 value of extra takes care of rounding errors. */
3153 n = resize_fixed_p ? nchildren : nchildren - nfixed;
3154 if (size < total && n > 1)
3155 new_sizes = shrink_windows (total, size, nchildren, n,
3156 resize_fixed_p, *forward, width_p,
3157 nodelete_p == 2);
3158 else
3160 each = (size - total) / n;
3161 extra = (size - total) - n * each;
3164 /* Compute new children heights and edge positions. */
3165 first_pos = width_p ? XINT (w->left_col) : XINT (w->top_line);
3166 last_pos = first_pos;
3167 for (n = 0, child = *forward; !NILP (child); child = c->next, ++n)
3169 int new_size, old_size;
3171 c = XWINDOW (child);
3172 old_size = WINDOW_TOTAL_SIZE (c, width_p);
3173 new_size = old_size;
3175 /* The top or left edge position of this child equals the
3176 bottom or right edge of its predecessor. */
3177 if (width_p)
3178 c->left_col = make_number (last_pos);
3179 else
3180 c->top_line = make_number (last_pos);
3182 /* If this child can be resized, do it. */
3183 if (resize_fixed_p || !window_fixed_size_p (c, width_p, 0))
3185 new_size = new_sizes ? new_sizes[n] : old_size + each + extra;
3186 extra = 0;
3189 /* Set new size. Note that size_window also propagates
3190 edge positions to children, so it's not a no-op if we
3191 didn't change the child's size. */
3192 size_window (child, new_size, width_p, 1, first_only, last_only);
3194 /* Remember the bottom/right edge position of this child; it
3195 will be used to set the top/left edge of the next child. */
3196 last_pos += new_size;
3199 xfree (new_sizes);
3201 /* We should have covered the parent exactly with child windows. */
3202 xassert (size == last_pos - first_pos);
3204 /* Now delete any children that became too small. */
3205 if (nodelete_p != 1)
3206 for (child = *forward; !NILP (child); child = c->next)
3208 int child_size;
3210 c = XWINDOW (child);
3211 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3212 size_window (child, child_size, width_p, nodelete_p,
3213 first_only, last_only);
3218 /* Set WINDOW's height to HEIGHT, and recursively change the height of
3219 WINDOW's children. NODELETE zero means windows that have become
3220 smaller than window-min-height in the process may be deleted.
3221 NODELETE 1 means never delete windows that become too small in the
3222 process. (The caller should check later and do so if appropriate.)
3223 NODELETE 2 means delete only windows that have become too small to be
3224 displayed correctly. */
3226 void
3227 set_window_height (window, height, nodelete)
3228 Lisp_Object window;
3229 int height;
3230 int nodelete;
3232 size_window (window, height, 0, nodelete, 0, 0);
3235 /* Set WINDOW's width to WIDTH, and recursively change the width of
3236 WINDOW's children. NODELETE zero means windows that have become
3237 smaller than window-min-width 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_width (window, width, nodelete)
3245 Lisp_Object window;
3246 int width;
3247 int nodelete;
3249 size_window (window, width, 1, nodelete, 0, 0);
3252 /* Change window heights in windows rooted in WINDOW by N lines. */
3254 void
3255 change_window_heights (window, n)
3256 Lisp_Object window;
3257 int n;
3259 struct window *w = XWINDOW (window);
3261 XSETFASTINT (w->top_line, XFASTINT (w->top_line) + n);
3262 XSETFASTINT (w->total_lines, XFASTINT (w->total_lines) - n);
3264 if (INTEGERP (w->orig_top_line))
3265 XSETFASTINT (w->orig_top_line, XFASTINT (w->orig_top_line) + n);
3266 if (INTEGERP (w->orig_total_lines))
3267 XSETFASTINT (w->orig_total_lines, XFASTINT (w->orig_total_lines) - n);
3269 /* Handle just the top child in a vertical split. */
3270 if (!NILP (w->vchild))
3271 change_window_heights (w->vchild, n);
3273 /* Adjust all children in a horizontal split. */
3274 for (window = w->hchild; !NILP (window); window = w->next)
3276 w = XWINDOW (window);
3277 change_window_heights (window, n);
3282 int window_select_count;
3284 Lisp_Object
3285 Fset_window_buffer_unwind (obuf)
3286 Lisp_Object obuf;
3288 Fset_buffer (obuf);
3289 return Qnil;
3292 EXFUN (Fset_window_fringes, 4);
3293 EXFUN (Fset_window_scroll_bars, 4);
3295 static void
3296 run_funs (Lisp_Object funs)
3298 for (; CONSP (funs); funs = XCDR (funs))
3299 if (!EQ (XCAR (funs), Qt))
3300 call0 (XCAR (funs));
3303 static Lisp_Object select_window_norecord (Lisp_Object window);
3305 void
3306 run_window_configuration_change_hook (struct frame *f)
3308 int count = SPECPDL_INDEX ();
3309 Lisp_Object frame, global_wcch
3310 = Fdefault_value (Qwindow_configuration_change_hook);
3311 XSETFRAME (frame, f);
3313 if (NILP (Vrun_hooks))
3314 return;
3316 if (SELECTED_FRAME () != f)
3318 record_unwind_protect (Fselect_frame, Fselected_frame ());
3319 Fselect_frame (frame);
3322 /* Use the right buffer. Matters when running the local hooks. */
3323 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3325 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3326 Fset_buffer (Fwindow_buffer (Qnil));
3329 /* Look for buffer-local values. */
3331 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3332 for (; CONSP (windows); windows = XCDR (windows))
3334 Lisp_Object window = XCAR (windows);
3335 Lisp_Object buffer = Fwindow_buffer (window);
3336 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3337 buffer)))
3339 int count = SPECPDL_INDEX ();
3340 record_unwind_protect (select_window_norecord, Fselected_window ());
3341 select_window_norecord (window);
3342 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3343 buffer));
3344 unbind_to (count, Qnil);
3349 run_funs (global_wcch);
3350 unbind_to (count, Qnil);
3353 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
3354 means it's allowed to run hooks. See make_frame for a case where
3355 it's not allowed. KEEP_MARGINS_P non-zero means that the current
3356 margins, fringes, and scroll-bar settings of the window are not
3357 reset from the buffer's local settings. */
3359 void
3360 set_window_buffer (window, buffer, run_hooks_p, keep_margins_p)
3361 Lisp_Object window, buffer;
3362 int run_hooks_p, keep_margins_p;
3364 struct window *w = XWINDOW (window);
3365 struct buffer *b = XBUFFER (buffer);
3366 int count = SPECPDL_INDEX ();
3367 int samebuf = EQ (buffer, w->buffer);
3369 w->buffer = buffer;
3371 if (EQ (window, selected_window))
3372 b->last_selected_window = window;
3374 /* Let redisplay errors through. */
3375 b->display_error_modiff = 0;
3377 /* Update time stamps of buffer display. */
3378 if (INTEGERP (b->display_count))
3379 XSETINT (b->display_count, XINT (b->display_count) + 1);
3380 b->display_time = Fcurrent_time ();
3382 XSETFASTINT (w->window_end_pos, 0);
3383 XSETFASTINT (w->window_end_vpos, 0);
3384 bzero (&w->last_cursor, sizeof w->last_cursor);
3385 w->window_end_valid = Qnil;
3386 if (!(keep_margins_p && samebuf))
3387 { /* If we're not actually changing the buffer, Don't reset hscroll and
3388 vscroll. This case happens for example when called from
3389 change_frame_size_1, where we use a dummy call to
3390 Fset_window_buffer on the frame's selected window (and no other)
3391 just in order to run window-configuration-change-hook.
3392 Resetting hscroll and vscroll here is problematic for things like
3393 image-mode and doc-view-mode since it resets the image's position
3394 whenever we resize the frame. */
3395 w->hscroll = w->min_hscroll = make_number (0);
3396 w->vscroll = 0;
3397 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3398 set_marker_restricted (w->start,
3399 make_number (b->last_window_start),
3400 buffer);
3401 w->start_at_line_beg = Qnil;
3402 w->force_start = Qnil;
3403 XSETFASTINT (w->last_modified, 0);
3404 XSETFASTINT (w->last_overlay_modified, 0);
3406 /* Maybe we could move this into the `if' but it's not obviously safe and
3407 I doubt it's worth the trouble. */
3408 windows_or_buffers_changed++;
3410 /* We must select BUFFER for running the window-scroll-functions.
3411 If WINDOW is selected, switch permanently.
3412 Otherwise, switch but go back to the ambient buffer afterward. */
3413 if (EQ (window, selected_window))
3414 Fset_buffer (buffer);
3415 /* We can't check ! NILP (Vwindow_scroll_functions) here
3416 because that might itself be a local variable. */
3417 else if (window_initialized)
3419 record_unwind_protect (Fset_window_buffer_unwind, Fcurrent_buffer ());
3420 Fset_buffer (buffer);
3423 if (!keep_margins_p)
3425 /* Set left and right marginal area width etc. from buffer. */
3427 /* This may call adjust_window_margins three times, so
3428 temporarily disable window margins. */
3429 Lisp_Object save_left = w->left_margin_cols;
3430 Lisp_Object save_right = w->right_margin_cols;
3432 w->left_margin_cols = w->right_margin_cols = Qnil;
3434 Fset_window_fringes (window,
3435 b->left_fringe_width, b->right_fringe_width,
3436 b->fringes_outside_margins);
3438 Fset_window_scroll_bars (window,
3439 b->scroll_bar_width,
3440 b->vertical_scroll_bar_type, Qnil);
3442 w->left_margin_cols = save_left;
3443 w->right_margin_cols = save_right;
3445 Fset_window_margins (window,
3446 b->left_margin_cols, b->right_margin_cols);
3449 if (run_hooks_p)
3451 if (! NILP (Vwindow_scroll_functions))
3452 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3453 Fmarker_position (w->start));
3454 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3457 unbind_to (count, Qnil);
3461 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3462 doc: /* Make WINDOW display BUFFER as its contents.
3463 BUFFER can be a buffer or the name of an existing buffer.
3464 Optional third arg KEEP-MARGINS non-nil means that WINDOW's current
3465 display margins, fringe widths, and scroll bar settings are maintained;
3466 the default is to reset these from BUFFER's local settings or the frame
3467 defaults.
3469 This function runs the hook `window-scroll-functions'. */)
3470 (window, buffer, keep_margins)
3471 register Lisp_Object window, buffer, keep_margins;
3473 register Lisp_Object tem;
3474 register struct window *w = decode_window (window);
3476 XSETWINDOW (window, w);
3477 buffer = Fget_buffer (buffer);
3478 CHECK_BUFFER (buffer);
3480 if (NILP (XBUFFER (buffer)->name))
3481 error ("Attempt to display deleted buffer");
3483 tem = w->buffer;
3484 if (NILP (tem))
3485 error ("Window is deleted");
3486 else if (! EQ (tem, Qt)) /* w->buffer is t when the window
3487 is first being set up. */
3489 if (!NILP (w->dedicated) && !EQ (tem, buffer))
3490 error ("Window is dedicated to `%s'",
3491 SDATA (XBUFFER (tem)->name));
3493 unshow_buffer (w);
3496 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3497 return Qnil;
3500 /* Note that selected_window can be nil
3501 when this is called from Fset_window_configuration. */
3503 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
3504 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
3505 If WINDOW is not already selected, make WINDOW's buffer current
3506 and make WINDOW the frame's selected window. Return WINDOW.
3507 Optional second arg NORECORD non-nil means
3508 do not put this buffer at the front of the list of recently selected ones.
3510 Note that the main editor command loop
3511 selects the buffer of the selected window before each command. */)
3512 (window, norecord)
3513 register Lisp_Object window, norecord;
3515 register struct window *w;
3516 register struct window *ow;
3517 struct frame *sf;
3519 CHECK_LIVE_WINDOW (window);
3521 w = XWINDOW (window);
3522 w->frozen_window_start_p = 0;
3524 ++window_select_count;
3525 XSETFASTINT (w->use_time, window_select_count);
3526 if (EQ (window, selected_window))
3527 return window;
3529 sf = SELECTED_FRAME ();
3530 if (XFRAME (WINDOW_FRAME (w)) != sf)
3532 XFRAME (WINDOW_FRAME (w))->selected_window = window;
3533 /* Use this rather than Fhandle_switch_frame
3534 so that FRAME_FOCUS_FRAME is moved appropriately as we
3535 move around in the state where a minibuffer in a separate
3536 frame is active. */
3537 Fselect_frame (WINDOW_FRAME (w));
3538 /* Fselect_frame called us back so we've done all the work already. */
3539 eassert (EQ (window, selected_window));
3540 return window;
3542 else
3543 sf->selected_window = window;
3545 /* Store the current buffer's actual point into the
3546 old selected window. It belongs to that window,
3547 and when the window is not selected, must be in the window. */
3548 if (!NILP (selected_window))
3550 ow = XWINDOW (selected_window);
3551 if (! NILP (ow->buffer))
3552 set_marker_both (ow->pointm, ow->buffer,
3553 BUF_PT (XBUFFER (ow->buffer)),
3554 BUF_PT_BYTE (XBUFFER (ow->buffer)));
3557 selected_window = window;
3559 if (NILP (norecord))
3560 record_buffer (w->buffer);
3561 Fset_buffer (w->buffer);
3563 XBUFFER (w->buffer)->last_selected_window = window;
3565 /* Go to the point recorded in the window.
3566 This is important when the buffer is in more
3567 than one window. It also matters when
3568 redisplay_window has altered point after scrolling,
3569 because it makes the change only in the window. */
3571 register int new_point = marker_position (w->pointm);
3572 if (new_point < BEGV)
3573 SET_PT (BEGV);
3574 else if (new_point > ZV)
3575 SET_PT (ZV);
3576 else
3577 SET_PT (new_point);
3580 windows_or_buffers_changed++;
3581 return window;
3584 static Lisp_Object
3585 select_window_norecord (window)
3586 Lisp_Object window;
3588 return Fselect_window (window, Qt);
3591 Lisp_Object
3592 display_buffer (buffer, not_this_window_p, override_frame)
3593 Lisp_Object buffer, not_this_window_p, override_frame;
3595 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3598 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3599 0, 1, 0,
3600 doc: /* Force all windows to be updated on next redisplay.
3601 If optional arg OBJECT is a window, force redisplay of that window only.
3602 If OBJECT is a buffer or buffer name, force redisplay of all windows
3603 displaying that buffer. */)
3604 (object)
3605 Lisp_Object object;
3607 if (NILP (object))
3609 windows_or_buffers_changed++;
3610 update_mode_lines++;
3611 return Qt;
3614 if (WINDOWP (object))
3616 struct window *w = XWINDOW (object);
3617 mark_window_display_accurate (object, 0);
3618 w->update_mode_line = Qt;
3619 if (BUFFERP (w->buffer))
3620 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3621 ++update_mode_lines;
3622 return Qt;
3625 if (STRINGP (object))
3626 object = Fget_buffer (object);
3627 if (BUFFERP (object) && !NILP (XBUFFER (object)->name))
3629 /* Walk all windows looking for buffer, and force update
3630 of each of those windows. */
3632 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3633 return NILP (object) ? Qnil : Qt;
3636 /* If nothing suitable was found, just return.
3637 We could signal an error, but this feature will typically be used
3638 asynchronously in timers or process sentinels, so we don't. */
3639 return Qnil;
3643 void
3644 temp_output_buffer_show (buf)
3645 register Lisp_Object buf;
3647 register struct buffer *old = current_buffer;
3648 register Lisp_Object window;
3649 register struct window *w;
3651 XBUFFER (buf)->directory = current_buffer->directory;
3653 Fset_buffer (buf);
3654 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3655 BEGV = BEG;
3656 ZV = Z;
3657 SET_PT (BEG);
3658 #if 0 /* rms: there should be no reason for this. */
3659 XBUFFER (buf)->prevent_redisplay_optimizations_p = 1;
3660 #endif
3661 set_buffer_internal (old);
3663 if (!NILP (Vtemp_buffer_show_function))
3664 call1 (Vtemp_buffer_show_function, buf);
3665 else
3667 window = display_buffer (buf, Qnil, Qnil);
3669 if (!EQ (XWINDOW (window)->frame, selected_frame))
3670 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3671 Vminibuf_scroll_window = window;
3672 w = XWINDOW (window);
3673 XSETFASTINT (w->hscroll, 0);
3674 XSETFASTINT (w->min_hscroll, 0);
3675 set_marker_restricted_both (w->start, buf, BEG, BEG);
3676 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3678 /* Run temp-buffer-show-hook, with the chosen window selected
3679 and its buffer current. */
3681 if (!NILP (Vrun_hooks)
3682 && !NILP (Fboundp (Qtemp_buffer_show_hook))
3683 && !NILP (Fsymbol_value (Qtemp_buffer_show_hook)))
3685 int count = SPECPDL_INDEX ();
3686 Lisp_Object prev_window, prev_buffer;
3687 prev_window = selected_window;
3688 XSETBUFFER (prev_buffer, old);
3690 /* Select the window that was chosen, for running the hook.
3691 Note: Both Fselect_window and select_window_norecord may
3692 set-buffer to the buffer displayed in the window,
3693 so we need to save the current buffer. --stef */
3694 record_unwind_protect (Fset_buffer, prev_buffer);
3695 record_unwind_protect (select_window_norecord, prev_window);
3696 Fselect_window (window, Qt);
3697 Fset_buffer (w->buffer);
3698 call1 (Vrun_hooks, Qtemp_buffer_show_hook);
3699 unbind_to (count, Qnil);
3704 static void
3705 make_dummy_parent (window)
3706 Lisp_Object window;
3708 Lisp_Object new;
3709 register struct window *o, *p;
3710 int i;
3712 o = XWINDOW (window);
3713 p = allocate_window ();
3714 for (i = 0; i < VECSIZE (struct window); ++i)
3715 ((struct Lisp_Vector *) p)->contents[i]
3716 = ((struct Lisp_Vector *)o)->contents[i];
3717 XSETWINDOW (new, p);
3719 ++sequence_number;
3720 XSETFASTINT (p->sequence_number, sequence_number);
3722 /* Put new into window structure in place of window */
3723 replace_window (window, new);
3725 o->next = Qnil;
3726 o->prev = Qnil;
3727 o->vchild = Qnil;
3728 o->hchild = Qnil;
3729 o->parent = new;
3731 p->start = Qnil;
3732 p->pointm = Qnil;
3733 p->buffer = Qnil;
3736 DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "",
3737 doc: /* Split WINDOW, putting SIZE lines in the first of the pair.
3738 WINDOW defaults to selected one and SIZE to half its size.
3739 If optional third arg HORFLAG is non-nil, split side by side
3740 and put SIZE columns in the first of the pair. In that case,
3741 SIZE includes that window's scroll bar, or the divider column to its right.
3742 Interactively, all arguments are nil.
3744 Returns the newly created window (which is the lower or rightmost one).
3745 The upper or leftmost window is the original one, and remains selected
3746 if it was selected before.
3748 See Info node `(elisp)Splitting Windows' for more details and examples.*/)
3749 (window, size, horflag)
3750 Lisp_Object window, size, horflag;
3752 register Lisp_Object new;
3753 register struct window *o, *p;
3754 FRAME_PTR fo;
3755 register int size_int;
3757 if (NILP (window))
3758 window = selected_window;
3759 else
3760 CHECK_LIVE_WINDOW (window);
3762 o = XWINDOW (window);
3763 fo = XFRAME (WINDOW_FRAME (o));
3765 if (NILP (size))
3767 if (!NILP (horflag))
3768 /* Calculate the size of the left-hand window, by dividing
3769 the usable space in columns by two.
3770 We round up, since the left-hand window may include
3771 a dividing line, while the right-hand may not. */
3772 size_int = (XFASTINT (o->total_cols) + 1) >> 1;
3773 else
3774 size_int = XFASTINT (o->total_lines) >> 1;
3776 else
3778 CHECK_NUMBER (size);
3779 size_int = XINT (size);
3782 if (MINI_WINDOW_P (o))
3783 error ("Attempt to split minibuffer window");
3784 else if (window_fixed_size_p (o, !NILP (horflag), 0))
3785 error ("Attempt to split fixed-size window");
3787 if (NILP (horflag))
3789 int window_safe_height = window_min_size_2 (o, 0, 0);
3791 if (size_int < window_safe_height)
3792 error ("Window height %d too small (after splitting)", size_int);
3793 if (size_int + window_safe_height > XFASTINT (o->total_lines))
3794 error ("Window height %d too small (after splitting)",
3795 XFASTINT (o->total_lines) - size_int);
3796 if (NILP (o->parent)
3797 || NILP (XWINDOW (o->parent)->vchild))
3799 make_dummy_parent (window);
3800 new = o->parent;
3801 XWINDOW (new)->vchild = window;
3804 else
3806 int window_safe_width = window_min_size_2 (o, 1, 0);
3808 if (size_int < window_safe_width)
3809 error ("Window width %d too small (after splitting)", size_int);
3810 if (size_int + window_safe_width > XFASTINT (o->total_cols))
3811 error ("Window width %d too small (after splitting)",
3812 XFASTINT (o->total_cols) - size_int);
3813 if (NILP (o->parent)
3814 || NILP (XWINDOW (o->parent)->hchild))
3816 make_dummy_parent (window);
3817 new = o->parent;
3818 XWINDOW (new)->hchild = window;
3822 /* Now we know that window's parent is a vertical combination
3823 if we are dividing vertically, or a horizontal combination
3824 if we are making side-by-side windows */
3826 windows_or_buffers_changed++;
3827 FRAME_WINDOW_SIZES_CHANGED (fo) = 1;
3828 new = make_window ();
3829 p = XWINDOW (new);
3831 p->frame = o->frame;
3832 p->next = o->next;
3833 if (!NILP (p->next))
3834 XWINDOW (p->next)->prev = new;
3835 p->prev = window;
3836 o->next = new;
3837 p->parent = o->parent;
3838 p->buffer = Qt;
3839 p->window_end_valid = Qnil;
3840 bzero (&p->last_cursor, sizeof p->last_cursor);
3842 /* Duplicate special geometry settings. */
3844 p->left_margin_cols = o->left_margin_cols;
3845 p->right_margin_cols = o->right_margin_cols;
3846 p->left_fringe_width = o->left_fringe_width;
3847 p->right_fringe_width = o->right_fringe_width;
3848 p->fringes_outside_margins = o->fringes_outside_margins;
3849 p->scroll_bar_width = o->scroll_bar_width;
3850 p->vertical_scroll_bar_type = o->vertical_scroll_bar_type;
3852 /* Apportion the available frame space among the two new windows */
3854 if (!NILP (horflag))
3856 p->total_lines = o->total_lines;
3857 p->top_line = o->top_line;
3858 XSETFASTINT (p->total_cols, XFASTINT (o->total_cols) - size_int);
3859 XSETFASTINT (o->total_cols, size_int);
3860 XSETFASTINT (p->left_col, XFASTINT (o->left_col) + size_int);
3861 adjust_window_margins (p);
3862 adjust_window_margins (o);
3864 else
3866 p->left_col = o->left_col;
3867 p->total_cols = o->total_cols;
3868 XSETFASTINT (p->total_lines, XFASTINT (o->total_lines) - size_int);
3869 XSETFASTINT (o->total_lines, size_int);
3870 XSETFASTINT (p->top_line, XFASTINT (o->top_line) + size_int);
3873 /* Adjust glyph matrices. */
3874 adjust_glyphs (fo);
3876 Fset_window_buffer (new, o->buffer, Qt);
3877 return new;
3880 DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 2, "p",
3881 doc: /* Make current window ARG lines bigger.
3882 From program, optional second arg non-nil means grow sideways ARG columns.
3883 Interactively, if an argument is not given, make the window one line bigger.
3884 If HORIZONTAL is non-nil, enlarge horizontally instead of vertically.
3885 This function can delete windows, even the second window, if they get
3886 too small. */)
3887 (arg, horizontal)
3888 Lisp_Object arg, horizontal;
3890 CHECK_NUMBER (arg);
3891 enlarge_window (selected_window, XINT (arg), !NILP (horizontal));
3893 run_window_configuration_change_hook (SELECTED_FRAME ());
3895 return Qnil;
3898 DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 2, "p",
3899 doc: /* Make current window ARG lines smaller.
3900 From program, optional second arg non-nil means shrink sideways arg columns.
3901 Interactively, if an argument is not given, make the window one line smaller.
3902 Only siblings to the right or below are changed. */)
3903 (arg, side)
3904 Lisp_Object arg, side;
3906 CHECK_NUMBER (arg);
3907 enlarge_window (selected_window, -XINT (arg), !NILP (side));
3909 run_window_configuration_change_hook (SELECTED_FRAME ());
3911 return Qnil;
3915 window_height (window)
3916 Lisp_Object window;
3918 register struct window *p = XWINDOW (window);
3919 return WINDOW_TOTAL_LINES (p);
3923 window_width (window)
3924 Lisp_Object window;
3926 register struct window *p = XWINDOW (window);
3927 return WINDOW_TOTAL_COLS (p);
3931 #define CURBEG(w) \
3932 *(horiz_flag ? &(XWINDOW (w)->left_col) : &(XWINDOW (w)->top_line))
3934 #define CURSIZE(w) \
3935 *(horiz_flag ? &(XWINDOW (w)->total_cols) : &(XWINDOW (w)->total_lines))
3938 /* Enlarge WINDOW by DELTA. HORIZ_FLAG nonzero means enlarge it
3939 horizontally; zero means do it vertically.
3941 Siblings of the selected window are resized to fulfill the size
3942 request. If they become too small in the process, they may be
3943 deleted. */
3945 static void
3946 enlarge_window (window, delta, horiz_flag)
3947 Lisp_Object window;
3948 int delta, horiz_flag;
3950 Lisp_Object parent, next, prev;
3951 struct window *p;
3952 Lisp_Object *sizep;
3953 int maximum;
3954 int (*sizefun) P_ ((Lisp_Object))
3955 = horiz_flag ? window_width : window_height;
3956 void (*setsizefun) P_ ((Lisp_Object, int, int))
3957 = (horiz_flag ? set_window_width : set_window_height);
3959 /* Give up if this window cannot be resized. */
3960 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
3961 error ("Window is not resizable");
3963 /* Find the parent of the selected window. */
3964 while (1)
3966 p = XWINDOW (window);
3967 parent = p->parent;
3969 if (NILP (parent))
3971 if (horiz_flag)
3972 error ("No other window to side of this one");
3973 break;
3976 if (horiz_flag
3977 ? !NILP (XWINDOW (parent)->hchild)
3978 : !NILP (XWINDOW (parent)->vchild))
3979 break;
3981 window = parent;
3984 sizep = &CURSIZE (window);
3987 register int maxdelta;
3989 /* Compute the maximum size increment this window can have. */
3991 maxdelta = (!NILP (parent) ? (*sizefun) (parent) - XINT (*sizep)
3992 /* This is a main window followed by a minibuffer. */
3993 : !NILP (p->next) ? ((*sizefun) (p->next)
3994 - window_min_size (XWINDOW (p->next),
3995 horiz_flag, 0, 0, 0))
3996 /* This is a minibuffer following a main window. */
3997 : !NILP (p->prev) ? ((*sizefun) (p->prev)
3998 - window_min_size (XWINDOW (p->prev),
3999 horiz_flag, 0, 0, 0))
4000 /* This is a frame with only one window, a minibuffer-only
4001 or a minibufferless frame. */
4002 : (delta = 0));
4004 if (delta > maxdelta)
4005 /* This case traps trying to make the minibuffer
4006 the full frame, or make the only window aside from the
4007 minibuffer the full frame. */
4008 delta = maxdelta;
4011 if (XINT (*sizep) + delta < window_min_size (XWINDOW (window),
4012 horiz_flag, 0, 0, 0))
4014 delete_window (window);
4015 return;
4018 if (delta == 0)
4019 return;
4021 /* Find the total we can get from other siblings without deleting them. */
4022 maximum = 0;
4023 for (next = p->next; WINDOWP (next); next = XWINDOW (next)->next)
4024 maximum += (*sizefun) (next) - window_min_size (XWINDOW (next),
4025 horiz_flag, 0, 0, 0);
4026 for (prev = p->prev; WINDOWP (prev); prev = XWINDOW (prev)->prev)
4027 maximum += (*sizefun) (prev) - window_min_size (XWINDOW (prev),
4028 horiz_flag, 0, 0, 0);
4030 /* If we can get it all from them without deleting them, do so. */
4031 if (delta <= maximum)
4033 Lisp_Object first_unaffected;
4034 Lisp_Object first_affected;
4035 int fixed_p;
4037 next = p->next;
4038 prev = p->prev;
4039 first_affected = window;
4040 /* Look at one sibling at a time,
4041 moving away from this window in both directions alternately,
4042 and take as much as we can get without deleting that sibling. */
4043 while (delta != 0
4044 && (!NILP (next) || !NILP (prev)))
4046 if (! NILP (next))
4048 int this_one = ((*sizefun) (next)
4049 - window_min_size (XWINDOW (next), horiz_flag,
4050 0, 0, &fixed_p));
4051 if (!fixed_p)
4053 if (this_one > delta)
4054 this_one = delta;
4056 (*setsizefun) (next, (*sizefun) (next) - this_one, 0);
4057 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4059 delta -= this_one;
4062 next = XWINDOW (next)->next;
4065 if (delta == 0)
4066 break;
4068 if (! NILP (prev))
4070 int this_one = ((*sizefun) (prev)
4071 - window_min_size (XWINDOW (prev), horiz_flag,
4072 0, 0, &fixed_p));
4073 if (!fixed_p)
4075 if (this_one > delta)
4076 this_one = delta;
4078 first_affected = prev;
4080 (*setsizefun) (prev, (*sizefun) (prev) - this_one, 0);
4081 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4083 delta -= this_one;
4086 prev = XWINDOW (prev)->prev;
4090 xassert (delta == 0);
4092 /* Now recalculate the edge positions of all the windows affected,
4093 based on the new sizes. */
4094 first_unaffected = next;
4095 prev = first_affected;
4096 for (next = XWINDOW (prev)->next; ! EQ (next, first_unaffected);
4097 prev = next, next = XWINDOW (next)->next)
4099 XSETINT (CURBEG (next), XINT (CURBEG (prev)) + (*sizefun) (prev));
4100 /* This does not change size of NEXT,
4101 but it propagates the new top edge to its children */
4102 (*setsizefun) (next, (*sizefun) (next), 0);
4105 else
4107 register int delta1;
4108 register int opht = (*sizefun) (parent);
4110 if (opht <= XINT (*sizep) + delta)
4112 /* If trying to grow this window to or beyond size of the parent,
4113 just delete all the sibling windows. */
4114 Lisp_Object start, tem, next;
4116 start = XWINDOW (parent)->vchild;
4117 if (NILP (start))
4118 start = XWINDOW (parent)->hchild;
4120 /* Delete any siblings that come after WINDOW. */
4121 tem = XWINDOW (window)->next;
4122 while (! NILP (tem))
4124 next = XWINDOW (tem)->next;
4125 delete_window (tem);
4126 tem = next;
4129 /* Delete any siblings that come after WINDOW.
4130 Note that if START is not WINDOW, then WINDOW still
4131 has siblings, so WINDOW has not yet replaced its parent. */
4132 tem = start;
4133 while (! EQ (tem, window))
4135 next = XWINDOW (tem)->next;
4136 delete_window (tem);
4137 tem = next;
4140 else
4142 /* Otherwise, make delta1 just right so that if we add
4143 delta1 lines to this window and to the parent, and then
4144 shrink the parent back to its original size, the new
4145 proportional size of this window will increase by delta.
4147 The function size_window will compute the new height h'
4148 of the window from delta1 as:
4150 e = delta1/n
4151 x = delta1 - delta1/n * n for the 1st resizable child
4152 h' = h + e + x
4154 where n is the number of children that can be resized.
4155 We can ignore x by choosing a delta1 that is a multiple of
4156 n. We want the height of this window to come out as
4158 h' = h + delta
4160 So, delta1 must be
4162 h + e = h + delta
4163 delta1/n = delta
4164 delta1 = n * delta.
4166 The number of children n equals the number of resizable
4167 children of this window + 1 because we know window itself
4168 is resizable (otherwise we would have signalled an error).
4170 This reasoning is not correct when other windows become too
4171 small and shrink_windows refuses to delete them. Below we
4172 use resize_proportionally to work around this problem. */
4174 struct window *w = XWINDOW (window);
4175 Lisp_Object s;
4176 int n = 1;
4178 for (s = w->next; WINDOWP (s); s = XWINDOW (s)->next)
4179 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4180 ++n;
4181 for (s = w->prev; WINDOWP (s); s = XWINDOW (s)->prev)
4182 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4183 ++n;
4185 delta1 = n * delta;
4187 /* Add delta1 lines or columns to this window, and to the parent,
4188 keeping things consistent while not affecting siblings. */
4189 XSETINT (CURSIZE (parent), opht + delta1);
4190 (*setsizefun) (window, XINT (*sizep) + delta1, 0);
4192 /* Squeeze out delta1 lines or columns from our parent,
4193 shrinking this window and siblings proportionately. This
4194 brings parent back to correct size. Delta1 was calculated
4195 so this makes this window the desired size, taking it all
4196 out of the siblings.
4198 Temporarily set resize_proportionally to Qt to assure that,
4199 if necessary, shrink_windows deletes smaller windows rather
4200 than shrink this window. */
4201 w->resize_proportionally = Qt;
4202 (*setsizefun) (parent, opht, 0);
4203 w->resize_proportionally = Qnil;
4207 XSETFASTINT (p->last_modified, 0);
4208 XSETFASTINT (p->last_overlay_modified, 0);
4210 /* Adjust glyph matrices. */
4211 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4215 /* Adjust the size of WINDOW by DELTA, moving only its trailing edge.
4216 HORIZ_FLAG nonzero means adjust the width, moving the right edge.
4217 zero means adjust the height, moving the bottom edge.
4219 Following siblings of the selected window are resized to fulfill
4220 the size request. If they become too small in the process, they
4221 are not deleted; instead, we signal an error. */
4223 static void
4224 adjust_window_trailing_edge (window, delta, horiz_flag)
4225 Lisp_Object window;
4226 int delta, horiz_flag;
4228 Lisp_Object parent, child;
4229 struct window *p;
4230 Lisp_Object old_config = Fcurrent_window_configuration (Qnil);
4231 int delcount = window_deletion_count;
4233 CHECK_WINDOW (window);
4235 /* Give up if this window cannot be resized. */
4236 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
4237 error ("Window is not resizable");
4239 while (1)
4241 Lisp_Object first_parallel = Qnil;
4243 if (NILP (window))
4245 /* This happens if WINDOW on the previous iteration was
4246 at top level of the window tree. */
4247 Fset_window_configuration (old_config);
4248 error ("Specified window edge is fixed");
4251 p = XWINDOW (window);
4252 parent = p->parent;
4254 /* See if this level has windows in parallel in the specified
4255 direction. If so, set FIRST_PARALLEL to the first one. */
4256 if (horiz_flag)
4258 if (! NILP (parent) && !NILP (XWINDOW (parent)->vchild))
4259 first_parallel = XWINDOW (parent)->vchild;
4260 else if (NILP (parent) && !NILP (p->next))
4262 /* Handle the vertical chain of main window and minibuffer
4263 which has no parent. */
4264 first_parallel = window;
4265 while (! NILP (XWINDOW (first_parallel)->prev))
4266 first_parallel = XWINDOW (first_parallel)->prev;
4269 else
4271 if (! NILP (parent) && !NILP (XWINDOW (parent)->hchild))
4272 first_parallel = XWINDOW (parent)->hchild;
4275 /* If this level's succession is in the desired dimension,
4276 and this window is the last one, and there is no higher level,
4277 its trailing edge is fixed. */
4278 if (NILP (XWINDOW (window)->next) && NILP (first_parallel)
4279 && NILP (parent))
4281 Fset_window_configuration (old_config);
4282 error ("Specified window edge is fixed");
4285 /* Don't make this window too small. */
4286 if (XINT (CURSIZE (window)) + delta
4287 < window_min_size_2 (XWINDOW (window), horiz_flag, 0))
4289 Fset_window_configuration (old_config);
4290 error ("Cannot adjust window size as specified");
4293 /* Clear out some redisplay caches. */
4294 XSETFASTINT (p->last_modified, 0);
4295 XSETFASTINT (p->last_overlay_modified, 0);
4297 /* Adjust this window's edge. */
4298 XSETINT (CURSIZE (window),
4299 XINT (CURSIZE (window)) + delta);
4301 /* If this window has following siblings in the desired dimension,
4302 make them smaller, and exit the loop.
4304 (If we reach the top of the tree and can never do this,
4305 we will fail and report an error, above.) */
4306 if (NILP (first_parallel))
4308 if (!NILP (p->next))
4310 /* This may happen for the minibuffer. In that case
4311 the window_deletion_count check below does not work. */
4312 if (XINT (CURSIZE (p->next)) - delta <= 0)
4314 Fset_window_configuration (old_config);
4315 error ("Cannot adjust window size as specified");
4318 XSETINT (CURBEG (p->next),
4319 XINT (CURBEG (p->next)) + delta);
4320 size_window (p->next, XINT (CURSIZE (p->next)) - delta,
4321 horiz_flag, 0, 1, 0);
4322 break;
4325 else
4326 /* Here we have a chain of parallel siblings, in the other dimension.
4327 Change the size of the other siblings. */
4328 for (child = first_parallel;
4329 ! NILP (child);
4330 child = XWINDOW (child)->next)
4331 if (! EQ (child, window))
4332 size_window (child, XINT (CURSIZE (child)) + delta,
4333 horiz_flag, 0, 0, 1);
4335 window = parent;
4338 /* If we made a window so small it got deleted,
4339 we failed. Report failure. */
4340 if (delcount != window_deletion_count)
4342 Fset_window_configuration (old_config);
4343 error ("Cannot adjust window size as specified");
4346 /* Adjust glyph matrices. */
4347 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4350 #undef CURBEG
4351 #undef CURSIZE
4353 DEFUN ("adjust-window-trailing-edge", Fadjust_window_trailing_edge,
4354 Sadjust_window_trailing_edge, 3, 3, 0,
4355 doc: /* Adjust the bottom or right edge of WINDOW by DELTA.
4356 If HORIZONTAL is non-nil, that means adjust the width, moving the right edge.
4357 Otherwise, adjust the height, moving the bottom edge.
4359 Following siblings of the selected window are resized to fulfill
4360 the size request. If they become too small in the process, they
4361 are not deleted; instead, we signal an error. */)
4362 (window, delta, horizontal)
4363 Lisp_Object window, delta, horizontal;
4365 CHECK_NUMBER (delta);
4366 if (NILP (window))
4367 window = selected_window;
4368 adjust_window_trailing_edge (window, XINT (delta), !NILP (horizontal));
4370 run_window_configuration_change_hook
4371 (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4373 return Qnil;
4378 /***********************************************************************
4379 Resizing Mini-Windows
4380 ***********************************************************************/
4382 static void shrink_window_lowest_first P_ ((struct window *, int));
4384 enum save_restore_action
4386 CHECK_ORIG_SIZES,
4387 SAVE_ORIG_SIZES,
4388 RESTORE_ORIG_SIZES
4391 static int save_restore_orig_size P_ ((struct window *,
4392 enum save_restore_action));
4394 /* Shrink windows rooted in window W to HEIGHT. Take the space needed
4395 from lowest windows first. */
4397 static void
4398 shrink_window_lowest_first (w, height)
4399 struct window *w;
4400 int height;
4402 struct window *c;
4403 Lisp_Object child;
4404 int old_height;
4406 xassert (!MINI_WINDOW_P (w));
4408 /* Set redisplay hints. */
4409 XSETFASTINT (w->last_modified, 0);
4410 XSETFASTINT (w->last_overlay_modified, 0);
4411 windows_or_buffers_changed++;
4412 FRAME_WINDOW_SIZES_CHANGED (XFRAME (WINDOW_FRAME (w))) = 1;
4414 old_height = XFASTINT (w->total_lines);
4415 XSETFASTINT (w->total_lines, height);
4417 if (!NILP (w->hchild))
4419 for (child = w->hchild; !NILP (child); child = c->next)
4421 c = XWINDOW (child);
4422 c->top_line = w->top_line;
4423 shrink_window_lowest_first (c, height);
4426 else if (!NILP (w->vchild))
4428 Lisp_Object last_child;
4429 int delta = old_height - height;
4430 int last_top;
4432 last_child = Qnil;
4434 /* Find the last child. We are taking space from lowest windows
4435 first, so we iterate over children from the last child
4436 backwards. */
4437 for (child = w->vchild; WINDOWP (child); child = XWINDOW (child)->next)
4438 last_child = child;
4440 /* Size children down to their safe heights. */
4441 for (child = last_child; delta && !NILP (child); child = c->prev)
4443 int this_one;
4445 c = XWINDOW (child);
4446 this_one = XFASTINT (c->total_lines) - window_min_size_1 (c, 0, 1);
4448 if (this_one > delta)
4449 this_one = delta;
4451 shrink_window_lowest_first (c, XFASTINT (c->total_lines) - this_one);
4452 delta -= this_one;
4455 /* Compute new positions. */
4456 last_top = XINT (w->top_line);
4457 for (child = w->vchild; !NILP (child); child = c->next)
4459 c = XWINDOW (child);
4460 c->top_line = make_number (last_top);
4461 shrink_window_lowest_first (c, XFASTINT (c->total_lines));
4462 last_top += XFASTINT (c->total_lines);
4468 /* Save, restore, or check positions and sizes in the window tree
4469 rooted at W. ACTION says what to do.
4471 If ACTION is CHECK_ORIG_SIZES, check if orig_top_line and
4472 orig_total_lines members are valid for all windows in the window
4473 tree. Value is non-zero if they are valid.
4475 If ACTION is SAVE_ORIG_SIZES, save members top and height in
4476 orig_top_line and orig_total_lines for all windows in the tree.
4478 If ACTION is RESTORE_ORIG_SIZES, restore top and height from values
4479 stored in orig_top_line and orig_total_lines for all windows. */
4481 static int
4482 save_restore_orig_size (w, action)
4483 struct window *w;
4484 enum save_restore_action action;
4486 int success_p = 1;
4488 while (w)
4490 if (!NILP (w->hchild))
4492 if (!save_restore_orig_size (XWINDOW (w->hchild), action))
4493 success_p = 0;
4495 else if (!NILP (w->vchild))
4497 if (!save_restore_orig_size (XWINDOW (w->vchild), action))
4498 success_p = 0;
4501 switch (action)
4503 case CHECK_ORIG_SIZES:
4504 if (!INTEGERP (w->orig_top_line) || !INTEGERP (w->orig_total_lines))
4505 return 0;
4506 break;
4508 case SAVE_ORIG_SIZES:
4509 w->orig_top_line = w->top_line;
4510 w->orig_total_lines = w->total_lines;
4511 XSETFASTINT (w->last_modified, 0);
4512 XSETFASTINT (w->last_overlay_modified, 0);
4513 break;
4515 case RESTORE_ORIG_SIZES:
4516 xassert (INTEGERP (w->orig_top_line) && INTEGERP (w->orig_total_lines));
4517 w->top_line = w->orig_top_line;
4518 w->total_lines = w->orig_total_lines;
4519 w->orig_total_lines = w->orig_top_line = Qnil;
4520 XSETFASTINT (w->last_modified, 0);
4521 XSETFASTINT (w->last_overlay_modified, 0);
4522 break;
4524 default:
4525 abort ();
4528 w = NILP (w->next) ? NULL : XWINDOW (w->next);
4531 return success_p;
4535 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we can
4536 without deleting other windows. */
4538 void
4539 grow_mini_window (w, delta)
4540 struct window *w;
4541 int delta;
4543 struct frame *f = XFRAME (w->frame);
4544 struct window *root;
4546 xassert (MINI_WINDOW_P (w));
4547 xassert (delta >= 0);
4549 /* Compute how much we can enlarge the mini-window without deleting
4550 other windows. */
4551 root = XWINDOW (FRAME_ROOT_WINDOW (f));
4552 if (delta)
4554 int min_height = window_min_size (root, 0, 0, 0, 0);
4555 if (XFASTINT (root->total_lines) - delta < min_height)
4556 /* Note that the root window may already be smaller than
4557 min_height. */
4558 delta = max (0, XFASTINT (root->total_lines) - min_height);
4561 if (delta)
4563 /* Save original window sizes and positions, if not already done. */
4564 if (!save_restore_orig_size (root, CHECK_ORIG_SIZES))
4565 save_restore_orig_size (root, SAVE_ORIG_SIZES);
4567 /* Shrink other windows. */
4568 shrink_window_lowest_first (root, XFASTINT (root->total_lines) - delta);
4570 /* Grow the mini-window. */
4571 w->top_line = make_number (XFASTINT (root->top_line) + XFASTINT (root->total_lines));
4572 w->total_lines = make_number (XFASTINT (w->total_lines) + delta);
4573 XSETFASTINT (w->last_modified, 0);
4574 XSETFASTINT (w->last_overlay_modified, 0);
4576 adjust_glyphs (f);
4581 /* Shrink mini-window W. If there is recorded info about window sizes
4582 before a call to grow_mini_window, restore recorded window sizes.
4583 Otherwise, if the mini-window is higher than 1 line, resize it to 1
4584 line. */
4586 void
4587 shrink_mini_window (w)
4588 struct window *w;
4590 struct frame *f = XFRAME (w->frame);
4591 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
4593 if (save_restore_orig_size (root, CHECK_ORIG_SIZES))
4595 save_restore_orig_size (root, RESTORE_ORIG_SIZES);
4596 adjust_glyphs (f);
4597 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4598 windows_or_buffers_changed = 1;
4600 else if (XFASTINT (w->total_lines) > 1)
4602 /* Distribute the additional lines of the mini-window
4603 among the other windows. */
4604 Lisp_Object window;
4605 XSETWINDOW (window, w);
4606 enlarge_window (window, 1 - XFASTINT (w->total_lines), 0);
4612 /* Mark window cursors off for all windows in the window tree rooted
4613 at W by setting their phys_cursor_on_p flag to zero. Called from
4614 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4615 the frame are cleared. */
4617 void
4618 mark_window_cursors_off (w)
4619 struct window *w;
4621 while (w)
4623 if (!NILP (w->hchild))
4624 mark_window_cursors_off (XWINDOW (w->hchild));
4625 else if (!NILP (w->vchild))
4626 mark_window_cursors_off (XWINDOW (w->vchild));
4627 else
4628 w->phys_cursor_on_p = 0;
4630 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4635 /* Return number of lines of text (not counting mode lines) in W. */
4638 window_internal_height (w)
4639 struct window *w;
4641 int ht = XFASTINT (w->total_lines);
4643 if (!MINI_WINDOW_P (w))
4645 if (!NILP (w->parent)
4646 || !NILP (w->vchild)
4647 || !NILP (w->hchild)
4648 || !NILP (w->next)
4649 || !NILP (w->prev)
4650 || WINDOW_WANTS_MODELINE_P (w))
4651 --ht;
4653 if (WINDOW_WANTS_HEADER_LINE_P (w))
4654 --ht;
4657 return ht;
4661 /* Return the number of columns in W.
4662 Don't count columns occupied by scroll bars or the vertical bar
4663 separating W from the sibling to its right. */
4666 window_box_text_cols (w)
4667 struct window *w;
4669 struct frame *f = XFRAME (WINDOW_FRAME (w));
4670 int width = XINT (w->total_cols);
4672 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
4673 /* Scroll bars occupy a few columns. */
4674 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
4675 else if (!FRAME_WINDOW_P (f)
4676 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
4677 /* The column of `|' characters separating side-by-side windows
4678 occupies one column only. */
4679 width -= 1;
4681 if (FRAME_WINDOW_P (f))
4682 /* On window-systems, fringes and display margins cannot be
4683 used for normal text. */
4684 width -= (WINDOW_FRINGE_COLS (w)
4685 + WINDOW_LEFT_MARGIN_COLS (w)
4686 + WINDOW_RIGHT_MARGIN_COLS (w));
4688 return width;
4692 /************************************************************************
4693 Window Scrolling
4694 ***********************************************************************/
4696 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4697 N screen-fulls, which is defined as the height of the window minus
4698 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4699 instead. Negative values of N mean scroll down. NOERROR non-zero
4700 means don't signal an error if we try to move over BEGV or ZV,
4701 respectively. */
4703 static void
4704 window_scroll (window, n, whole, noerror)
4705 Lisp_Object window;
4706 int n;
4707 int whole;
4708 int noerror;
4710 immediate_quit = 1;
4712 /* If we must, use the pixel-based version which is much slower than
4713 the line-based one but can handle varying line heights. */
4714 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4715 window_scroll_pixel_based (window, n, whole, noerror);
4716 else
4717 window_scroll_line_based (window, n, whole, noerror);
4719 immediate_quit = 0;
4723 /* Implementation of window_scroll that works based on pixel line
4724 heights. See the comment of window_scroll for parameter
4725 descriptions. */
4727 static void
4728 window_scroll_pixel_based (window, n, whole, noerror)
4729 Lisp_Object window;
4730 int n;
4731 int whole;
4732 int noerror;
4734 struct it it;
4735 struct window *w = XWINDOW (window);
4736 struct text_pos start;
4737 int this_scroll_margin;
4738 /* True if we fiddled the window vscroll field without really scrolling. */
4739 int vscrolled = 0;
4740 int x, y, rtop, rbot, rowh, vpos;
4742 SET_TEXT_POS_FROM_MARKER (start, w->start);
4744 /* If PT is not visible in WINDOW, move back one half of
4745 the screen. Allow PT to be partially visible, otherwise
4746 something like (scroll-down 1) with PT in the line before
4747 the partially visible one would recenter. */
4749 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4751 /* Move backward half the height of the window. Performance note:
4752 vmotion used here is about 10% faster, but would give wrong
4753 results for variable height lines. */
4754 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4755 it.current_y = it.last_visible_y;
4756 move_it_vertically_backward (&it, window_box_height (w) / 2);
4758 /* The function move_iterator_vertically may move over more than
4759 the specified y-distance. If it->w is small, e.g. a
4760 mini-buffer window, we may end up in front of the window's
4761 display area. This is the case when Start displaying at the
4762 start of the line containing PT in this case. */
4763 if (it.current_y <= 0)
4765 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4766 move_it_vertically_backward (&it, 0);
4767 it.current_y = 0;
4770 start = it.current.pos;
4772 else if (auto_window_vscroll_p)
4774 if (rtop || rbot) /* partially visible */
4776 int px;
4777 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4778 if (whole)
4779 dy = max ((window_box_height (w)
4780 - next_screen_context_lines * dy),
4781 dy);
4782 dy *= n;
4784 if (n < 0)
4786 /* Only vscroll backwards if already vscrolled forwards. */
4787 if (w->vscroll < 0 && rtop > 0)
4789 px = max (0, -w->vscroll - min (rtop, -dy));
4790 Fset_window_vscroll (window, make_number (px), Qt);
4791 return;
4794 if (n > 0)
4796 /* Do vscroll if already vscrolled or only display line. */
4797 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4799 px = max (0, -w->vscroll + min (rbot, dy));
4800 Fset_window_vscroll (window, make_number (px), Qt);
4801 return;
4804 /* Maybe modify window start instead of scrolling. */
4805 if (rbot > 0 || w->vscroll < 0)
4807 int spos;
4809 Fset_window_vscroll (window, make_number (0), Qt);
4810 /* If there are other text lines above the current row,
4811 move window start to current row. Else to next row. */
4812 if (rbot > 0)
4813 spos = XINT (Fline_beginning_position (Qnil));
4814 else
4815 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4816 set_marker_restricted (w->start, make_number (spos),
4817 w->buffer);
4818 w->start_at_line_beg = Qt;
4819 w->update_mode_line = Qt;
4820 XSETFASTINT (w->last_modified, 0);
4821 XSETFASTINT (w->last_overlay_modified, 0);
4822 /* Set force_start so that redisplay_window will run the
4823 window-scroll-functions. */
4824 w->force_start = Qt;
4825 return;
4829 /* Cancel previous vscroll. */
4830 Fset_window_vscroll (window, make_number (0), Qt);
4833 /* If scroll_preserve_screen_position is non-nil, we try to set
4834 point in the same window line as it is now, so get that line. */
4835 if (!NILP (Vscroll_preserve_screen_position))
4837 /* We preserve the goal pixel coordinate across consecutive
4838 calls to scroll-up or scroll-down. This avoids the
4839 possibility of point becoming "stuck" on a tall line when
4840 scrolling by one line. */
4841 if (window_scroll_pixel_based_preserve_y < 0
4842 || (!EQ (current_kboard->Vlast_command, Qscroll_up)
4843 && !EQ (current_kboard->Vlast_command, Qscroll_down)))
4845 start_display (&it, w, start);
4846 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4847 window_scroll_pixel_based_preserve_y = it.current_y;
4848 window_scroll_pixel_based_preserve_x = it.current_x;
4851 else
4852 window_scroll_pixel_based_preserve_y
4853 = window_scroll_pixel_based_preserve_x = -1;
4855 /* Move iterator it from start the specified distance forward or
4856 backward. The result is the new window start. */
4857 start_display (&it, w, start);
4858 if (whole)
4860 int start_pos = IT_CHARPOS (it);
4861 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4862 dy = max ((window_box_height (w)
4863 - next_screen_context_lines * dy),
4864 dy) * n;
4866 /* Note that move_it_vertically always moves the iterator to the
4867 start of a line. So, if the last line doesn't have a newline,
4868 we would end up at the start of the line ending at ZV. */
4869 if (dy <= 0)
4871 move_it_vertically_backward (&it, -dy);
4872 /* Ensure we actually do move, e.g. in case we are currently
4873 looking at an image that is taller that the window height. */
4874 while (start_pos == IT_CHARPOS (it)
4875 && start_pos > BEGV)
4876 move_it_by_lines (&it, -1, 1);
4878 else if (dy > 0)
4880 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4881 MOVE_TO_POS | MOVE_TO_Y);
4882 /* Ensure we actually do move, e.g. in case we are currently
4883 looking at an image that is taller that the window height. */
4884 while (start_pos == IT_CHARPOS (it)
4885 && start_pos < ZV)
4886 move_it_by_lines (&it, 1, 1);
4889 else
4890 move_it_by_lines (&it, n, 1);
4892 /* We failed if we find ZV is already on the screen (scrolling up,
4893 means there's nothing past the end), or if we can't start any
4894 earlier (scrolling down, means there's nothing past the top). */
4895 if ((n > 0 && IT_CHARPOS (it) == ZV)
4896 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4898 if (IT_CHARPOS (it) == ZV)
4900 if (it.current_y < it.last_visible_y
4901 && (it.current_y + it.max_ascent + it.max_descent
4902 > it.last_visible_y))
4904 /* The last line was only partially visible, make it fully
4905 visible. */
4906 w->vscroll = (it.last_visible_y
4907 - it.current_y + it.max_ascent + it.max_descent);
4908 adjust_glyphs (it.f);
4910 else if (noerror)
4911 return;
4912 else if (n < 0) /* could happen with empty buffers */
4913 xsignal0 (Qbeginning_of_buffer);
4914 else
4915 xsignal0 (Qend_of_buffer);
4917 else
4919 if (w->vscroll != 0)
4920 /* The first line was only partially visible, make it fully
4921 visible. */
4922 w->vscroll = 0;
4923 else if (noerror)
4924 return;
4925 else
4926 xsignal0 (Qbeginning_of_buffer);
4929 /* If control gets here, then we vscrolled. */
4931 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4933 /* Don't try to change the window start below. */
4934 vscrolled = 1;
4937 if (! vscrolled)
4939 int pos = IT_CHARPOS (it);
4940 int bytepos;
4942 /* If in the middle of a multi-glyph character move forward to
4943 the next character. */
4944 if (in_display_vector_p (&it))
4946 ++pos;
4947 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4950 /* Set the window start, and set up the window for redisplay. */
4951 set_marker_restricted (w->start, make_number (pos),
4952 w->buffer);
4953 bytepos = XMARKER (w->start)->bytepos;
4954 w->start_at_line_beg = ((pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n')
4955 ? Qt : Qnil);
4956 w->update_mode_line = Qt;
4957 XSETFASTINT (w->last_modified, 0);
4958 XSETFASTINT (w->last_overlay_modified, 0);
4959 /* Set force_start so that redisplay_window will run the
4960 window-scroll-functions. */
4961 w->force_start = Qt;
4964 /* The rest of this function uses current_y in a nonstandard way,
4965 not including the height of the header line if any. */
4966 it.current_y = it.vpos = 0;
4968 /* Move PT out of scroll margins.
4969 This code wants current_y to be zero at the window start position
4970 even if there is a header line. */
4971 this_scroll_margin = max (0, scroll_margin);
4972 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
4973 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
4975 if (n > 0)
4977 /* We moved the window start towards ZV, so PT may be now
4978 in the scroll margin at the top. */
4979 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4980 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
4981 && (NILP (Vscroll_preserve_screen_position)
4982 || EQ (Vscroll_preserve_screen_position, Qt)))
4983 /* We found PT at a legitimate height. Leave it alone. */
4985 else if (window_scroll_pixel_based_preserve_y >= 0)
4987 /* If we have a header line, take account of it.
4988 This is necessary because we set it.current_y to 0, above. */
4989 move_it_to (&it, -1,
4990 window_scroll_pixel_based_preserve_x,
4991 window_scroll_pixel_based_preserve_y
4992 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
4993 -1, MOVE_TO_Y | MOVE_TO_X);
4994 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4996 else
4998 while (it.current_y < this_scroll_margin)
5000 int prev = it.current_y;
5001 move_it_by_lines (&it, 1, 1);
5002 if (prev == it.current_y)
5003 break;
5005 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5008 else if (n < 0)
5010 int charpos, bytepos;
5011 int partial_p;
5013 /* Save our position, for the
5014 window_scroll_pixel_based_preserve_y case. */
5015 charpos = IT_CHARPOS (it);
5016 bytepos = IT_BYTEPOS (it);
5018 /* We moved the window start towards BEGV, so PT may be now
5019 in the scroll margin at the bottom. */
5020 move_it_to (&it, PT, -1,
5021 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
5022 - this_scroll_margin - 1),
5024 MOVE_TO_POS | MOVE_TO_Y);
5026 /* Save our position, in case it's correct. */
5027 charpos = IT_CHARPOS (it);
5028 bytepos = IT_BYTEPOS (it);
5030 /* See if point is on a partially visible line at the end. */
5031 if (it.what == IT_EOB)
5032 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
5033 else
5035 move_it_by_lines (&it, 1, 1);
5036 partial_p = it.current_y > it.last_visible_y;
5039 if (charpos == PT && !partial_p
5040 && (NILP (Vscroll_preserve_screen_position)
5041 || EQ (Vscroll_preserve_screen_position, Qt)))
5042 /* We found PT before we found the display margin, so PT is ok. */
5044 else if (window_scroll_pixel_based_preserve_y >= 0)
5046 SET_TEXT_POS_FROM_MARKER (start, w->start);
5047 start_display (&it, w, start);
5048 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
5049 here because we called start_display again and did not
5050 alter it.current_y this time. */
5051 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
5052 window_scroll_pixel_based_preserve_y, -1,
5053 MOVE_TO_Y | MOVE_TO_X);
5054 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5056 else
5058 if (partial_p)
5059 /* The last line was only partially visible, so back up two
5060 lines to make sure we're on a fully visible line. */
5062 move_it_by_lines (&it, -2, 0);
5063 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5065 else
5066 /* No, the position we saved is OK, so use it. */
5067 SET_PT_BOTH (charpos, bytepos);
5073 /* Implementation of window_scroll that works based on screen lines.
5074 See the comment of window_scroll for parameter descriptions. */
5076 static void
5077 window_scroll_line_based (window, n, whole, noerror)
5078 Lisp_Object window;
5079 int n;
5080 int whole;
5081 int noerror;
5083 register struct window *w = XWINDOW (window);
5084 register int opoint = PT, opoint_byte = PT_BYTE;
5085 register int pos, pos_byte;
5086 register int ht = window_internal_height (w);
5087 register Lisp_Object tem;
5088 int lose;
5089 Lisp_Object bolp;
5090 int startpos;
5091 Lisp_Object original_pos = Qnil;
5093 /* If scrolling screen-fulls, compute the number of lines to
5094 scroll from the window's height. */
5095 if (whole)
5096 n *= max (1, ht - next_screen_context_lines);
5098 startpos = marker_position (w->start);
5100 if (!NILP (Vscroll_preserve_screen_position))
5102 if (window_scroll_preserve_vpos <= 0
5103 || (!EQ (current_kboard->Vlast_command, Qscroll_up)
5104 && !EQ (current_kboard->Vlast_command, Qscroll_down)))
5106 struct position posit
5107 = *compute_motion (startpos, 0, 0, 0,
5108 PT, ht, 0,
5109 -1, XINT (w->hscroll),
5110 0, w);
5111 window_scroll_preserve_vpos = posit.vpos;
5112 window_scroll_preserve_hpos = posit.hpos + XINT (w->hscroll);
5115 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
5116 make_number (window_scroll_preserve_vpos));
5119 XSETFASTINT (tem, PT);
5120 tem = Fpos_visible_in_window_p (tem, window, Qnil);
5122 if (NILP (tem))
5124 Fvertical_motion (make_number (- (ht / 2)), window);
5125 startpos = PT;
5128 SET_PT (startpos);
5129 lose = n < 0 && PT == BEGV;
5130 Fvertical_motion (make_number (n), window);
5131 pos = PT;
5132 pos_byte = PT_BYTE;
5133 bolp = Fbolp ();
5134 SET_PT_BOTH (opoint, opoint_byte);
5136 if (lose)
5138 if (noerror)
5139 return;
5140 else
5141 xsignal0 (Qbeginning_of_buffer);
5144 if (pos < ZV)
5146 int this_scroll_margin = scroll_margin;
5148 /* Don't use a scroll margin that is negative or too large. */
5149 if (this_scroll_margin < 0)
5150 this_scroll_margin = 0;
5152 if (XINT (w->total_lines) < 4 * scroll_margin)
5153 this_scroll_margin = XINT (w->total_lines) / 4;
5155 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
5156 w->start_at_line_beg = bolp;
5157 w->update_mode_line = Qt;
5158 XSETFASTINT (w->last_modified, 0);
5159 XSETFASTINT (w->last_overlay_modified, 0);
5160 /* Set force_start so that redisplay_window will run
5161 the window-scroll-functions. */
5162 w->force_start = Qt;
5164 if (!NILP (Vscroll_preserve_screen_position)
5165 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
5167 SET_PT_BOTH (pos, pos_byte);
5168 Fvertical_motion (original_pos, window);
5170 /* If we scrolled forward, put point enough lines down
5171 that it is outside the scroll margin. */
5172 else if (n > 0)
5174 int top_margin;
5176 if (this_scroll_margin > 0)
5178 SET_PT_BOTH (pos, pos_byte);
5179 Fvertical_motion (make_number (this_scroll_margin), window);
5180 top_margin = PT;
5182 else
5183 top_margin = pos;
5185 if (top_margin <= opoint)
5186 SET_PT_BOTH (opoint, opoint_byte);
5187 else if (!NILP (Vscroll_preserve_screen_position))
5189 SET_PT_BOTH (pos, pos_byte);
5190 Fvertical_motion (original_pos, window);
5192 else
5193 SET_PT (top_margin);
5195 else if (n < 0)
5197 int bottom_margin;
5199 /* If we scrolled backward, put point near the end of the window
5200 but not within the scroll margin. */
5201 SET_PT_BOTH (pos, pos_byte);
5202 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
5203 if (XFASTINT (tem) == ht - this_scroll_margin)
5204 bottom_margin = PT;
5205 else
5206 bottom_margin = PT + 1;
5208 if (bottom_margin > opoint)
5209 SET_PT_BOTH (opoint, opoint_byte);
5210 else
5212 if (!NILP (Vscroll_preserve_screen_position))
5214 SET_PT_BOTH (pos, pos_byte);
5215 Fvertical_motion (original_pos, window);
5217 else
5218 Fvertical_motion (make_number (-1), window);
5222 else
5224 if (noerror)
5225 return;
5226 else
5227 xsignal0 (Qend_of_buffer);
5232 /* Scroll selected_window up or down. If N is nil, scroll a
5233 screen-full which is defined as the height of the window minus
5234 next_screen_context_lines. If N is the symbol `-', scroll.
5235 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
5236 up. This is the guts of Fscroll_up and Fscroll_down. */
5238 static void
5239 scroll_command (n, direction)
5240 Lisp_Object n;
5241 int direction;
5243 int count = SPECPDL_INDEX ();
5245 xassert (eabs (direction) == 1);
5247 /* If selected window's buffer isn't current, make it current for
5248 the moment. But don't screw up if window_scroll gets an error. */
5249 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
5251 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5252 Fset_buffer (XWINDOW (selected_window)->buffer);
5254 /* Make redisplay consider other windows than just selected_window. */
5255 ++windows_or_buffers_changed;
5258 if (NILP (n))
5259 window_scroll (selected_window, direction, 1, 0);
5260 else if (EQ (n, Qminus))
5261 window_scroll (selected_window, -direction, 1, 0);
5262 else
5264 n = Fprefix_numeric_value (n);
5265 window_scroll (selected_window, XINT (n) * direction, 0, 0);
5268 unbind_to (count, Qnil);
5271 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
5272 doc: /* Scroll text of current window upward ARG lines.
5273 If ARG is omitted or nil, scroll upward by a near full screen.
5274 A near full screen is `next-screen-context-lines' less than a full screen.
5275 Negative ARG means scroll downward.
5276 If ARG is the atom `-', scroll downward by nearly full screen.
5277 When calling from a program, supply as argument a number, nil, or `-'. */)
5278 (arg)
5279 Lisp_Object arg;
5281 scroll_command (arg, 1);
5282 return Qnil;
5285 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
5286 doc: /* Scroll text of current window down ARG lines.
5287 If ARG is omitted or nil, scroll down by a near full screen.
5288 A near full screen is `next-screen-context-lines' less than a full screen.
5289 Negative ARG means scroll upward.
5290 If ARG is the atom `-', scroll upward by nearly full screen.
5291 When calling from a program, supply as argument a number, nil, or `-'. */)
5292 (arg)
5293 Lisp_Object arg;
5295 scroll_command (arg, -1);
5296 return Qnil;
5299 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
5300 doc: /* Return the other window for \"other window scroll\" commands.
5301 If `other-window-scroll-buffer' is non-nil, a window
5302 showing that buffer is used.
5303 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5304 specifies the window. This takes precedence over
5305 `other-window-scroll-buffer'. */)
5308 Lisp_Object window;
5310 if (MINI_WINDOW_P (XWINDOW (selected_window))
5311 && !NILP (Vminibuf_scroll_window))
5312 window = Vminibuf_scroll_window;
5313 /* If buffer is specified, scroll that buffer. */
5314 else if (!NILP (Vother_window_scroll_buffer))
5316 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
5317 if (NILP (window))
5318 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
5320 else
5322 /* Nothing specified; look for a neighboring window on the same
5323 frame. */
5324 window = Fnext_window (selected_window, Qnil, Qnil);
5326 if (EQ (window, selected_window))
5327 /* That didn't get us anywhere; look for a window on another
5328 visible frame. */
5330 window = Fnext_window (window, Qnil, Qt);
5331 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
5332 && ! EQ (window, selected_window));
5335 CHECK_LIVE_WINDOW (window);
5337 if (EQ (window, selected_window))
5338 error ("There is no other window");
5340 return window;
5343 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
5344 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5345 A near full screen is `next-screen-context-lines' less than a full screen.
5346 The next window is the one below the current one; or the one at the top
5347 if the current one is at the bottom. Negative ARG means scroll downward.
5348 If ARG is the atom `-', scroll downward by nearly full screen.
5349 When calling from a program, supply as argument a number, nil, or `-'.
5351 If `other-window-scroll-buffer' is non-nil, scroll the window
5352 showing that buffer, popping the buffer up if necessary.
5353 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5354 specifies the window to scroll. This takes precedence over
5355 `other-window-scroll-buffer'. */)
5356 (arg)
5357 Lisp_Object arg;
5359 Lisp_Object window;
5360 struct window *w;
5361 int count = SPECPDL_INDEX ();
5363 window = Fother_window_for_scrolling ();
5364 w = XWINDOW (window);
5366 /* Don't screw up if window_scroll gets an error. */
5367 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5368 ++windows_or_buffers_changed;
5370 Fset_buffer (w->buffer);
5371 SET_PT (marker_position (w->pointm));
5373 if (NILP (arg))
5374 window_scroll (window, 1, 1, 1);
5375 else if (EQ (arg, Qminus))
5376 window_scroll (window, -1, 1, 1);
5377 else
5379 if (CONSP (arg))
5380 arg = Fcar (arg);
5381 CHECK_NUMBER (arg);
5382 window_scroll (window, XINT (arg), 0, 1);
5385 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5386 unbind_to (count, Qnil);
5388 return Qnil;
5391 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5392 doc: /* Scroll selected window display ARG columns left.
5393 Default for ARG is window width minus 2.
5394 Value is the total amount of leftward horizontal scrolling in
5395 effect after the change.
5396 If SET_MINIMUM is non-nil, the new scroll amount becomes the
5397 lower bound for automatic scrolling, i.e. automatic scrolling
5398 will not scroll a window to a column less than the value returned
5399 by this function. This happens in an interactive call. */)
5400 (arg, set_minimum)
5401 register Lisp_Object arg, set_minimum;
5403 Lisp_Object result;
5404 int hscroll;
5405 struct window *w = XWINDOW (selected_window);
5407 if (NILP (arg))
5408 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5409 else
5410 arg = Fprefix_numeric_value (arg);
5412 hscroll = XINT (w->hscroll) + XINT (arg);
5413 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5415 if (!NILP (set_minimum))
5416 w->min_hscroll = w->hscroll;
5418 return result;
5421 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5422 doc: /* Scroll selected window display ARG columns right.
5423 Default for ARG is window width minus 2.
5424 Value is the total amount of leftward horizontal scrolling in
5425 effect after the change.
5426 If SET_MINIMUM is non-nil, the new scroll amount becomes the
5427 lower bound for automatic scrolling, i.e. automatic scrolling
5428 will not scroll a window to a column less than the value returned
5429 by this function. This happens in an interactive call. */)
5430 (arg, set_minimum)
5431 register Lisp_Object arg, set_minimum;
5433 Lisp_Object result;
5434 int hscroll;
5435 struct window *w = XWINDOW (selected_window);
5437 if (NILP (arg))
5438 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5439 else
5440 arg = Fprefix_numeric_value (arg);
5442 hscroll = XINT (w->hscroll) - XINT (arg);
5443 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5445 if (!NILP (set_minimum))
5446 w->min_hscroll = w->hscroll;
5448 return result;
5451 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5452 doc: /* Return the window which was selected when entering the minibuffer.
5453 Returns nil, if current window is not a minibuffer window. */)
5456 if (minibuf_level > 0
5457 && MINI_WINDOW_P (XWINDOW (selected_window))
5458 && WINDOW_LIVE_P (minibuf_selected_window))
5459 return minibuf_selected_window;
5461 return Qnil;
5464 /* Value is the number of lines actually displayed in window W,
5465 as opposed to its height. */
5467 static int
5468 displayed_window_lines (w)
5469 struct window *w;
5471 struct it it;
5472 struct text_pos start;
5473 int height = window_box_height (w);
5474 struct buffer *old_buffer;
5475 int bottom_y;
5477 if (XBUFFER (w->buffer) != current_buffer)
5479 old_buffer = current_buffer;
5480 set_buffer_internal (XBUFFER (w->buffer));
5482 else
5483 old_buffer = NULL;
5485 /* In case W->start is out of the accessible range, do something
5486 reasonable. This happens in Info mode when Info-scroll-down
5487 calls (recenter -1) while W->start is 1. */
5488 if (XMARKER (w->start)->charpos < BEGV)
5489 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
5490 else if (XMARKER (w->start)->charpos > ZV)
5491 SET_TEXT_POS (start, ZV, ZV_BYTE);
5492 else
5493 SET_TEXT_POS_FROM_MARKER (start, w->start);
5495 start_display (&it, w, start);
5496 move_it_vertically (&it, height);
5497 bottom_y = line_bottom_y (&it);
5499 /* rms: On a non-window display,
5500 the value of it.vpos at the bottom of the screen
5501 seems to be 1 larger than window_box_height (w).
5502 This kludge fixes a bug whereby (move-to-window-line -1)
5503 when ZV is on the last screen line
5504 moves to the previous screen line instead of the last one. */
5505 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5506 height++;
5508 /* Add in empty lines at the bottom of the window. */
5509 if (bottom_y < height)
5511 int uy = FRAME_LINE_HEIGHT (it.f);
5512 it.vpos += (height - bottom_y + uy - 1) / uy;
5515 if (old_buffer)
5516 set_buffer_internal (old_buffer);
5518 return it.vpos;
5522 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5523 doc: /* Center point in window and redisplay frame.
5524 With prefix argument ARG, recenter putting point on screen line ARG
5525 relative to the current window. If ARG is negative, it counts up from the
5526 bottom of the window. (ARG should be less than the height of the window.)
5528 If ARG is omitted or nil, erase the entire frame and then redraw with point
5529 in the center of the current window. If `auto-resize-tool-bars' is set to
5530 `grow-only', this resets the tool-bar's height to the minimum height needed.
5532 Just C-u as prefix means put point in the center of the window
5533 and redisplay normally--don't erase and redraw the frame. */)
5534 (arg)
5535 register Lisp_Object arg;
5537 struct window *w = XWINDOW (selected_window);
5538 struct buffer *buf = XBUFFER (w->buffer);
5539 struct buffer *obuf = current_buffer;
5540 int center_p = 0;
5541 int charpos, bytepos;
5542 int iarg;
5543 int this_scroll_margin;
5545 /* If redisplay is suppressed due to an error, try again. */
5546 obuf->display_error_modiff = 0;
5548 if (NILP (arg))
5550 int i;
5552 /* Invalidate pixel data calculated for all compositions. */
5553 for (i = 0; i < n_compositions; i++)
5554 composition_table[i]->font = NULL;
5556 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5558 Fredraw_frame (WINDOW_FRAME (w));
5559 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5560 center_p = 1;
5562 else if (CONSP (arg)) /* Just C-u. */
5563 center_p = 1;
5564 else
5566 arg = Fprefix_numeric_value (arg);
5567 CHECK_NUMBER (arg);
5568 iarg = XINT (arg);
5571 set_buffer_internal (buf);
5573 /* Do this after making BUF current
5574 in case scroll_margin is buffer-local. */
5575 this_scroll_margin = max (0, scroll_margin);
5576 this_scroll_margin = min (this_scroll_margin,
5577 XFASTINT (w->total_lines) / 4);
5579 /* Handle centering on a graphical frame specially. Such frames can
5580 have variable-height lines and centering point on the basis of
5581 line counts would lead to strange effects. */
5582 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5584 if (center_p)
5586 struct it it;
5587 struct text_pos pt;
5589 SET_TEXT_POS (pt, PT, PT_BYTE);
5590 start_display (&it, w, pt);
5591 move_it_vertically_backward (&it, window_box_height (w) / 2);
5592 charpos = IT_CHARPOS (it);
5593 bytepos = IT_BYTEPOS (it);
5595 else if (iarg < 0)
5597 struct it it;
5598 struct text_pos pt;
5599 int nlines = -iarg;
5600 int extra_line_spacing;
5601 int h = window_box_height (w);
5603 iarg = - max (-iarg, this_scroll_margin);
5605 SET_TEXT_POS (pt, PT, PT_BYTE);
5606 start_display (&it, w, pt);
5608 /* Be sure we have the exact height of the full line containing PT. */
5609 move_it_by_lines (&it, 0, 1);
5611 /* The amount of pixels we have to move back is the window
5612 height minus what's displayed in the line containing PT,
5613 and the lines below. */
5614 it.current_y = 0;
5615 it.vpos = 0;
5616 move_it_by_lines (&it, nlines, 1);
5618 if (it.vpos == nlines)
5619 h -= it.current_y;
5620 else
5622 /* Last line has no newline */
5623 h -= line_bottom_y (&it);
5624 it.vpos++;
5627 /* Don't reserve space for extra line spacing of last line. */
5628 extra_line_spacing = it.max_extra_line_spacing;
5630 /* If we can't move down NLINES lines because we hit
5631 the end of the buffer, count in some empty lines. */
5632 if (it.vpos < nlines)
5634 nlines -= it.vpos;
5635 extra_line_spacing = it.extra_line_spacing;
5636 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5638 if (h <= 0)
5639 return Qnil;
5641 /* Now find the new top line (starting position) of the window. */
5642 start_display (&it, w, pt);
5643 it.current_y = 0;
5644 move_it_vertically_backward (&it, h);
5646 /* If extra line spacing is present, we may move too far
5647 back. This causes the last line to be only partially
5648 visible (which triggers redisplay to recenter that line
5649 in the middle), so move forward.
5650 But ignore extra line spacing on last line, as it is not
5651 considered to be part of the visible height of the line.
5653 h += extra_line_spacing;
5654 while (-it.current_y > h)
5655 move_it_by_lines (&it, 1, 1);
5657 charpos = IT_CHARPOS (it);
5658 bytepos = IT_BYTEPOS (it);
5660 else
5662 struct position pos;
5664 iarg = max (iarg, this_scroll_margin);
5666 pos = *vmotion (PT, -iarg, w);
5667 charpos = pos.bufpos;
5668 bytepos = pos.bytepos;
5671 else
5673 struct position pos;
5674 int ht = window_internal_height (w);
5676 if (center_p)
5677 iarg = ht / 2;
5678 else if (iarg < 0)
5679 iarg += ht;
5681 /* Don't let it get into the margin at either top or bottom. */
5682 iarg = max (iarg, this_scroll_margin);
5683 iarg = min (iarg, ht - this_scroll_margin - 1);
5685 pos = *vmotion (PT, - iarg, w);
5686 charpos = pos.bufpos;
5687 bytepos = pos.bytepos;
5690 /* Set the new window start. */
5691 set_marker_both (w->start, w->buffer, charpos, bytepos);
5692 w->window_end_valid = Qnil;
5694 w->optional_new_start = Qt;
5696 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
5697 w->start_at_line_beg = Qt;
5698 else
5699 w->start_at_line_beg = Qnil;
5701 set_buffer_internal (obuf);
5702 return Qnil;
5706 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5707 0, 1, 0,
5708 doc: /* Return the height in lines of the text display area of WINDOW.
5709 WINDOW defaults to the selected window.
5710 This doesn't include the mode-line (or header-line if any) or any
5711 partial-height lines in the text display area. */)
5712 (window)
5713 Lisp_Object window;
5715 struct window *w = decode_window (window);
5716 int pixel_height = window_box_height (w);
5717 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5718 return make_number (line_height);
5723 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5724 1, 1, "P",
5725 doc: /* Position point relative to window.
5726 With no argument, position point at center of window.
5727 An argument specifies vertical position within the window;
5728 zero means top of window, negative means relative to bottom of window. */)
5729 (arg)
5730 Lisp_Object arg;
5732 struct window *w = XWINDOW (selected_window);
5733 int lines, start;
5734 Lisp_Object window;
5735 #if 0
5736 int this_scroll_margin;
5737 #endif
5739 window = selected_window;
5740 start = marker_position (w->start);
5741 if (start < BEGV || start > ZV)
5743 int height = window_internal_height (w);
5744 Fvertical_motion (make_number (- (height / 2)), window);
5745 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
5746 w->start_at_line_beg = Fbolp ();
5747 w->force_start = Qt;
5749 else
5750 Fgoto_char (w->start);
5752 lines = displayed_window_lines (w);
5754 #if 0
5755 this_scroll_margin = max (0, scroll_margin);
5756 this_scroll_margin = min (this_scroll_margin, lines / 4);
5757 #endif
5759 if (NILP (arg))
5760 XSETFASTINT (arg, lines / 2);
5761 else
5763 int iarg = XINT (Fprefix_numeric_value (arg));
5765 if (iarg < 0)
5766 iarg = iarg + lines;
5768 #if 0 /* This code would prevent move-to-window-line from moving point
5769 to a place inside the scroll margins (which would cause the
5770 next redisplay to scroll). I wrote this code, but then concluded
5771 it is probably better not to install it. However, it is here
5772 inside #if 0 so as not to lose it. -- rms. */
5774 /* Don't let it get into the margin at either top or bottom. */
5775 iarg = max (iarg, this_scroll_margin);
5776 iarg = min (iarg, lines - this_scroll_margin - 1);
5777 #endif
5779 arg = make_number (iarg);
5782 /* Skip past a partially visible first line. */
5783 if (w->vscroll)
5784 XSETINT (arg, XINT (arg) + 1);
5786 return Fvertical_motion (arg, window);
5791 /***********************************************************************
5792 Window Configuration
5793 ***********************************************************************/
5795 struct save_window_data
5797 EMACS_UINT size;
5798 struct Lisp_Vector *next_from_Lisp_Vector_struct;
5799 Lisp_Object selected_frame;
5800 Lisp_Object current_window;
5801 Lisp_Object current_buffer;
5802 Lisp_Object minibuf_scroll_window;
5803 Lisp_Object minibuf_selected_window;
5804 Lisp_Object root_window;
5805 Lisp_Object focus_frame;
5806 /* A vector, each of whose elements is a struct saved_window
5807 for one window. */
5808 Lisp_Object saved_windows;
5810 /* All fields above are traced by the GC.
5811 From `fame-cols' down, the fields are ignored by the GC. */
5813 int frame_cols, frame_lines, frame_menu_bar_lines;
5814 int frame_tool_bar_lines;
5817 /* This is saved as a Lisp_Vector */
5818 struct saved_window
5820 /* these first two must agree with struct Lisp_Vector in lisp.h */
5821 EMACS_UINT size;
5822 struct Lisp_Vector *next_from_Lisp_Vector_struct;
5824 Lisp_Object window;
5825 Lisp_Object buffer, start, pointm, mark;
5826 Lisp_Object left_col, top_line, total_cols, total_lines;
5827 Lisp_Object hscroll, min_hscroll;
5828 Lisp_Object parent, prev;
5829 Lisp_Object start_at_line_beg;
5830 Lisp_Object display_table;
5831 Lisp_Object orig_top_line, orig_total_lines;
5832 Lisp_Object left_margin_cols, right_margin_cols;
5833 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5834 Lisp_Object scroll_bar_width, vertical_scroll_bar_type;
5835 Lisp_Object dedicated, resize_proportionally;
5838 #define SAVED_WINDOW_N(swv,n) \
5839 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5841 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5842 doc: /* Return t if OBJECT is a window-configuration object. */)
5843 (object)
5844 Lisp_Object object;
5846 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
5849 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5850 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5851 (config)
5852 Lisp_Object config;
5854 register struct save_window_data *data;
5855 struct Lisp_Vector *saved_windows;
5857 CHECK_WINDOW_CONFIGURATION (config);
5859 data = (struct save_window_data *) XVECTOR (config);
5860 saved_windows = XVECTOR (data->saved_windows);
5861 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5864 DEFUN ("set-window-configuration", Fset_window_configuration,
5865 Sset_window_configuration, 1, 1, 0,
5866 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5867 CONFIGURATION must be a value previously returned
5868 by `current-window-configuration' (which see).
5869 If CONFIGURATION was made from a frame that is now deleted,
5870 only frame-independent values can be restored. In this case,
5871 the return value is nil. Otherwise the value is t. */)
5872 (configuration)
5873 Lisp_Object configuration;
5875 register struct save_window_data *data;
5876 struct Lisp_Vector *saved_windows;
5877 Lisp_Object new_current_buffer;
5878 Lisp_Object frame;
5879 FRAME_PTR f;
5880 int old_point = -1;
5882 CHECK_WINDOW_CONFIGURATION (configuration);
5884 data = (struct save_window_data *) XVECTOR (configuration);
5885 saved_windows = XVECTOR (data->saved_windows);
5887 new_current_buffer = data->current_buffer;
5888 if (NILP (XBUFFER (new_current_buffer)->name))
5889 new_current_buffer = Qnil;
5890 else
5892 if (XBUFFER (new_current_buffer) == current_buffer)
5893 /* The code further down "preserves point" by saving here PT in
5894 old_point and then setting it later back into PT. When the
5895 current-selected-window and the final-selected-window both show
5896 the current buffer, this suffers from the problem that the
5897 current PT is the window-point of the current-selected-window,
5898 while the final PT is the point of the final-selected-window, so
5899 this copy from one PT to the other would end up moving the
5900 window-point of the final-selected-window to the window-point of
5901 the current-selected-window. So we have to be careful which
5902 point of the current-buffer we copy into old_point. */
5903 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5904 && WINDOWP (selected_window)
5905 && EQ (XWINDOW (selected_window)->buffer, new_current_buffer)
5906 && !EQ (selected_window, data->current_window))
5907 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5908 else
5909 old_point = PT;
5910 else
5911 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5912 point in new_current_buffer as of the last time this buffer was
5913 used. This can be non-deterministic since it can be changed by
5914 things like jit-lock by mere temporary selection of some random
5915 window that happens to show this buffer.
5916 So if possible we want this arbitrary choice of "which point" to
5917 be the one from the to-be-selected-window so as to prevent this
5918 window's cursor from being copied from another window. */
5919 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5920 /* If current_window = selected_window, its point is in BUF_PT. */
5921 && !EQ (selected_window, data->current_window))
5922 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5923 else
5924 old_point = BUF_PT (XBUFFER (new_current_buffer));
5927 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5928 f = XFRAME (frame);
5930 /* If f is a dead frame, don't bother rebuilding its window tree.
5931 However, there is other stuff we should still try to do below. */
5932 if (FRAME_LIVE_P (f))
5934 register struct window *w;
5935 register struct saved_window *p;
5936 struct window *root_window;
5937 struct window **leaf_windows;
5938 int n_leaf_windows;
5939 int k, i, n;
5941 /* If the frame has been resized since this window configuration was
5942 made, we change the frame to the size specified in the
5943 configuration, restore the configuration, and then resize it
5944 back. We keep track of the prevailing height in these variables. */
5945 int previous_frame_lines = FRAME_LINES (f);
5946 int previous_frame_cols = FRAME_COLS (f);
5947 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5948 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5950 /* The mouse highlighting code could get screwed up
5951 if it runs during this. */
5952 BLOCK_INPUT;
5954 if (data->frame_lines != previous_frame_lines
5955 || data->frame_cols != previous_frame_cols)
5956 change_frame_size (f, data->frame_lines,
5957 data->frame_cols, 0, 0, 0);
5958 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5959 if (data->frame_menu_bar_lines
5960 != previous_frame_menu_bar_lines)
5961 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
5962 make_number (0));
5963 #ifdef HAVE_WINDOW_SYSTEM
5964 if (data->frame_tool_bar_lines
5965 != previous_frame_tool_bar_lines)
5966 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
5967 make_number (0));
5968 #endif
5969 #endif
5971 /* "Swap out" point from the selected window's buffer
5972 into the window itself. (Normally the pointm of the selected
5973 window holds garbage.) We do this now, before
5974 restoring the window contents, and prevent it from
5975 being done later on when we select a new window. */
5976 if (! NILP (XWINDOW (selected_window)->buffer))
5978 w = XWINDOW (selected_window);
5979 set_marker_both (w->pointm,
5980 w->buffer,
5981 BUF_PT (XBUFFER (w->buffer)),
5982 BUF_PT_BYTE (XBUFFER (w->buffer)));
5985 windows_or_buffers_changed++;
5986 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
5988 /* Problem: Freeing all matrices and later allocating them again
5989 is a serious redisplay flickering problem. What we would
5990 really like to do is to free only those matrices not reused
5991 below. */
5992 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
5993 leaf_windows
5994 = (struct window **) alloca (count_windows (root_window)
5995 * sizeof (struct window *));
5996 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
5998 /* Kludge Alert!
5999 Mark all windows now on frame as "deleted".
6000 Restoring the new configuration "undeletes" any that are in it.
6002 Save their current buffers in their height fields, since we may
6003 need it later, if a buffer saved in the configuration is now
6004 dead. */
6005 delete_all_subwindows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6007 for (k = 0; k < saved_windows->size; k++)
6009 p = SAVED_WINDOW_N (saved_windows, k);
6010 w = XWINDOW (p->window);
6011 w->next = Qnil;
6013 if (!NILP (p->parent))
6014 w->parent = SAVED_WINDOW_N (saved_windows,
6015 XFASTINT (p->parent))->window;
6016 else
6017 w->parent = Qnil;
6019 if (!NILP (p->prev))
6021 w->prev = SAVED_WINDOW_N (saved_windows,
6022 XFASTINT (p->prev))->window;
6023 XWINDOW (w->prev)->next = p->window;
6025 else
6027 w->prev = Qnil;
6028 if (!NILP (w->parent))
6030 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
6032 XWINDOW (w->parent)->vchild = p->window;
6033 XWINDOW (w->parent)->hchild = Qnil;
6035 else
6037 XWINDOW (w->parent)->hchild = p->window;
6038 XWINDOW (w->parent)->vchild = Qnil;
6043 /* If we squirreled away the buffer in the window's height,
6044 restore it now. */
6045 if (BUFFERP (w->total_lines))
6046 w->buffer = w->total_lines;
6047 w->left_col = p->left_col;
6048 w->top_line = p->top_line;
6049 w->total_cols = p->total_cols;
6050 w->total_lines = p->total_lines;
6051 w->hscroll = p->hscroll;
6052 w->min_hscroll = p->min_hscroll;
6053 w->display_table = p->display_table;
6054 w->orig_top_line = p->orig_top_line;
6055 w->orig_total_lines = p->orig_total_lines;
6056 w->left_margin_cols = p->left_margin_cols;
6057 w->right_margin_cols = p->right_margin_cols;
6058 w->left_fringe_width = p->left_fringe_width;
6059 w->right_fringe_width = p->right_fringe_width;
6060 w->fringes_outside_margins = p->fringes_outside_margins;
6061 w->scroll_bar_width = p->scroll_bar_width;
6062 w->vertical_scroll_bar_type = p->vertical_scroll_bar_type;
6063 w->dedicated = p->dedicated;
6064 w->resize_proportionally = p->resize_proportionally;
6065 XSETFASTINT (w->last_modified, 0);
6066 XSETFASTINT (w->last_overlay_modified, 0);
6068 /* Reinstall the saved buffer and pointers into it. */
6069 if (NILP (p->buffer))
6070 w->buffer = p->buffer;
6071 else
6073 if (!NILP (XBUFFER (p->buffer)->name))
6074 /* If saved buffer is alive, install it. */
6076 w->buffer = p->buffer;
6077 w->start_at_line_beg = p->start_at_line_beg;
6078 set_marker_restricted (w->start, p->start, w->buffer);
6079 set_marker_restricted (w->pointm, p->pointm, w->buffer);
6080 Fset_marker (XBUFFER (w->buffer)->mark,
6081 p->mark, w->buffer);
6083 /* As documented in Fcurrent_window_configuration, don't
6084 restore the location of point in the buffer which was
6085 current when the window configuration was recorded. */
6086 if (!EQ (p->buffer, new_current_buffer)
6087 && XBUFFER (p->buffer) == current_buffer)
6088 Fgoto_char (w->pointm);
6090 else if (NILP (w->buffer) || NILP (XBUFFER (w->buffer)->name))
6091 /* Else unless window has a live buffer, get one. */
6093 w->buffer = Fcdr (Fcar (Vbuffer_alist));
6094 /* This will set the markers to beginning of visible
6095 range. */
6096 set_marker_restricted (w->start, make_number (0), w->buffer);
6097 set_marker_restricted (w->pointm, make_number (0),w->buffer);
6098 w->start_at_line_beg = Qt;
6100 else
6101 /* Keeping window's old buffer; make sure the markers
6102 are real. */
6104 /* Set window markers at start of visible range. */
6105 if (XMARKER (w->start)->buffer == 0)
6106 set_marker_restricted (w->start, make_number (0),
6107 w->buffer);
6108 if (XMARKER (w->pointm)->buffer == 0)
6109 set_marker_restricted_both (w->pointm, w->buffer,
6110 BUF_PT (XBUFFER (w->buffer)),
6111 BUF_PT_BYTE (XBUFFER (w->buffer)));
6112 w->start_at_line_beg = Qt;
6117 FRAME_ROOT_WINDOW (f) = data->root_window;
6118 /* Prevent "swapping out point" in the old selected window
6119 using the buffer that has been restored into it.
6120 We already swapped out point that from that window's old buffer. */
6121 selected_window = Qnil;
6123 /* Arrange *not* to restore point in the buffer that was
6124 current when the window configuration was saved. */
6125 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
6126 set_marker_restricted (XWINDOW (data->current_window)->pointm,
6127 make_number (old_point),
6128 XWINDOW (data->current_window)->buffer);
6130 Fselect_window (data->current_window, Qnil);
6131 XBUFFER (XWINDOW (selected_window)->buffer)->last_selected_window
6132 = selected_window;
6134 if (NILP (data->focus_frame)
6135 || (FRAMEP (data->focus_frame)
6136 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
6137 Fredirect_frame_focus (frame, data->focus_frame);
6139 #if 0 /* I don't understand why this is needed, and it causes problems
6140 when the frame's old selected window has been deleted. */
6141 if (f != selected_frame && FRAME_WINDOW_P (f))
6142 do_switch_frame (WINDOW_FRAME (XWINDOW (data->root_window)),
6143 0, 0);
6144 #endif
6146 /* Set the screen height to the value it had before this function. */
6147 if (previous_frame_lines != FRAME_LINES (f)
6148 || previous_frame_cols != FRAME_COLS (f))
6149 change_frame_size (f, previous_frame_lines, previous_frame_cols,
6150 0, 0, 0);
6151 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
6152 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
6153 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
6154 make_number (0));
6155 #ifdef HAVE_WINDOW_SYSTEM
6156 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
6157 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
6158 make_number (0));
6159 #endif
6160 #endif
6162 /* Now, free glyph matrices in windows that were not reused. */
6163 for (i = n = 0; i < n_leaf_windows; ++i)
6165 if (NILP (leaf_windows[i]->buffer))
6167 /* Assert it's not reused as a combination. */
6168 xassert (NILP (leaf_windows[i]->hchild)
6169 && NILP (leaf_windows[i]->vchild));
6170 free_window_matrices (leaf_windows[i]);
6172 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
6173 ++n;
6176 adjust_glyphs (f);
6178 UNBLOCK_INPUT;
6180 /* Fselect_window will have made f the selected frame, so we
6181 reselect the proper frame here. Fhandle_switch_frame will change the
6182 selected window too, but that doesn't make the call to
6183 Fselect_window above totally superfluous; it still sets f's
6184 selected window. */
6185 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
6186 do_switch_frame (data->selected_frame, 0, 0);
6188 run_window_configuration_change_hook (f);
6191 if (!NILP (new_current_buffer))
6192 Fset_buffer (new_current_buffer);
6194 Vminibuf_scroll_window = data->minibuf_scroll_window;
6195 minibuf_selected_window = data->minibuf_selected_window;
6197 return (FRAME_LIVE_P (f) ? Qt : Qnil);
6200 /* Mark all windows now on frame as deleted
6201 by setting their buffers to nil. */
6203 void
6204 delete_all_subwindows (w)
6205 register struct window *w;
6207 if (!NILP (w->next))
6208 delete_all_subwindows (XWINDOW (w->next));
6209 if (!NILP (w->vchild))
6210 delete_all_subwindows (XWINDOW (w->vchild));
6211 if (!NILP (w->hchild))
6212 delete_all_subwindows (XWINDOW (w->hchild));
6214 w->total_lines = w->buffer; /* See Fset_window_configuration for excuse. */
6216 if (!NILP (w->buffer))
6217 unshow_buffer (w);
6219 /* We set all three of these fields to nil, to make sure that we can
6220 distinguish this dead window from any live window. Live leaf
6221 windows will have buffer set, and combination windows will have
6222 vchild or hchild set. */
6223 w->buffer = Qnil;
6224 w->vchild = Qnil;
6225 w->hchild = Qnil;
6227 Vwindow_list = Qnil;
6230 static int
6231 count_windows (window)
6232 register struct window *window;
6234 register int count = 1;
6235 if (!NILP (window->next))
6236 count += count_windows (XWINDOW (window->next));
6237 if (!NILP (window->vchild))
6238 count += count_windows (XWINDOW (window->vchild));
6239 if (!NILP (window->hchild))
6240 count += count_windows (XWINDOW (window->hchild));
6241 return count;
6245 /* Fill vector FLAT with leaf windows under W, starting at index I.
6246 Value is last index + 1. */
6248 static int
6249 get_leaf_windows (w, flat, i)
6250 struct window *w;
6251 struct window **flat;
6252 int i;
6254 while (w)
6256 if (!NILP (w->hchild))
6257 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
6258 else if (!NILP (w->vchild))
6259 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
6260 else
6261 flat[i++] = w;
6263 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6266 return i;
6270 /* Return a pointer to the glyph W's physical cursor is on. Value is
6271 null if W's current matrix is invalid, so that no meaningfull glyph
6272 can be returned. */
6274 struct glyph *
6275 get_phys_cursor_glyph (w)
6276 struct window *w;
6278 struct glyph_row *row;
6279 struct glyph *glyph;
6281 if (w->phys_cursor.vpos >= 0
6282 && w->phys_cursor.vpos < w->current_matrix->nrows
6283 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
6284 row->enabled_p)
6285 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
6286 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
6287 else
6288 glyph = NULL;
6290 return glyph;
6294 static int
6295 save_window_save (window, vector, i)
6296 Lisp_Object window;
6297 struct Lisp_Vector *vector;
6298 int i;
6300 register struct saved_window *p;
6301 register struct window *w;
6302 register Lisp_Object tem;
6304 for (;!NILP (window); window = w->next)
6306 p = SAVED_WINDOW_N (vector, i);
6307 w = XWINDOW (window);
6309 XSETFASTINT (w->temslot, i); i++;
6310 p->window = window;
6311 p->buffer = w->buffer;
6312 p->left_col = w->left_col;
6313 p->top_line = w->top_line;
6314 p->total_cols = w->total_cols;
6315 p->total_lines = w->total_lines;
6316 p->hscroll = w->hscroll;
6317 p->min_hscroll = w->min_hscroll;
6318 p->display_table = w->display_table;
6319 p->orig_top_line = w->orig_top_line;
6320 p->orig_total_lines = w->orig_total_lines;
6321 p->left_margin_cols = w->left_margin_cols;
6322 p->right_margin_cols = w->right_margin_cols;
6323 p->left_fringe_width = w->left_fringe_width;
6324 p->right_fringe_width = w->right_fringe_width;
6325 p->fringes_outside_margins = w->fringes_outside_margins;
6326 p->scroll_bar_width = w->scroll_bar_width;
6327 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
6328 p->dedicated = w->dedicated;
6329 p->resize_proportionally = w->resize_proportionally;
6330 if (!NILP (w->buffer))
6332 /* Save w's value of point in the window configuration.
6333 If w is the selected window, then get the value of point
6334 from the buffer; pointm is garbage in the selected window. */
6335 if (EQ (window, selected_window))
6337 p->pointm = Fmake_marker ();
6338 set_marker_both (p->pointm, w->buffer,
6339 BUF_PT (XBUFFER (w->buffer)),
6340 BUF_PT_BYTE (XBUFFER (w->buffer)));
6342 else
6343 p->pointm = Fcopy_marker (w->pointm, Qnil);
6345 p->start = Fcopy_marker (w->start, Qnil);
6346 p->start_at_line_beg = w->start_at_line_beg;
6348 tem = XBUFFER (w->buffer)->mark;
6349 p->mark = Fcopy_marker (tem, Qnil);
6351 else
6353 p->pointm = Qnil;
6354 p->start = Qnil;
6355 p->mark = Qnil;
6356 p->start_at_line_beg = Qnil;
6359 if (NILP (w->parent))
6360 p->parent = Qnil;
6361 else
6362 p->parent = XWINDOW (w->parent)->temslot;
6364 if (NILP (w->prev))
6365 p->prev = Qnil;
6366 else
6367 p->prev = XWINDOW (w->prev)->temslot;
6369 if (!NILP (w->vchild))
6370 i = save_window_save (w->vchild, vector, i);
6371 if (!NILP (w->hchild))
6372 i = save_window_save (w->hchild, vector, i);
6375 return i;
6378 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
6379 Scurrent_window_configuration, 0, 1, 0,
6380 doc: /* Return an object representing the current window configuration of FRAME.
6381 If FRAME is nil or omitted, use the selected frame.
6382 This describes the number of windows, their sizes and current buffers,
6383 and for each displayed buffer, where display starts, and the positions of
6384 point and mark. An exception is made for point in the current buffer:
6385 its value is -not- saved.
6386 This also records the currently selected frame, and FRAME's focus
6387 redirection (see `redirect-frame-focus'). */)
6388 (frame)
6389 Lisp_Object frame;
6391 register Lisp_Object tem;
6392 register int n_windows;
6393 register struct save_window_data *data;
6394 register int i;
6395 FRAME_PTR f;
6397 if (NILP (frame))
6398 frame = selected_frame;
6399 CHECK_LIVE_FRAME (frame);
6400 f = XFRAME (frame);
6402 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6403 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6404 PVEC_WINDOW_CONFIGURATION);
6406 data->frame_cols = FRAME_COLS (f);
6407 data->frame_lines = FRAME_LINES (f);
6408 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6409 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6410 data->selected_frame = selected_frame;
6411 data->current_window = FRAME_SELECTED_WINDOW (f);
6412 XSETBUFFER (data->current_buffer, current_buffer);
6413 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6414 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6415 data->root_window = FRAME_ROOT_WINDOW (f);
6416 data->focus_frame = FRAME_FOCUS_FRAME (f);
6417 tem = Fmake_vector (make_number (n_windows), Qnil);
6418 data->saved_windows = tem;
6419 for (i = 0; i < n_windows; i++)
6420 XVECTOR (tem)->contents[i]
6421 = Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil);
6422 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6423 XSETWINDOW_CONFIGURATION (tem, data);
6424 return (tem);
6427 DEFUN ("save-window-excursion", Fsave_window_excursion, Ssave_window_excursion,
6428 0, UNEVALLED, 0,
6429 doc: /* Execute BODY, preserving window sizes and contents.
6430 Return the value of the last form in BODY.
6431 Restore which buffer appears in which window, where display starts,
6432 and the value of point and mark for each window.
6433 Also restore the choice of selected window.
6434 Also restore which buffer is current.
6435 Does not restore the value of point in current buffer.
6436 usage: (save-window-excursion BODY...) */)
6437 (args)
6438 Lisp_Object args;
6440 register Lisp_Object val;
6441 register int count = SPECPDL_INDEX ();
6443 record_unwind_protect (Fset_window_configuration,
6444 Fcurrent_window_configuration (Qnil));
6445 val = Fprogn (args);
6446 return unbind_to (count, val);
6451 /***********************************************************************
6452 Window Split Tree
6453 ***********************************************************************/
6455 static Lisp_Object
6456 window_tree (w)
6457 struct window *w;
6459 Lisp_Object tail = Qnil;
6460 Lisp_Object result = Qnil;
6462 while (w)
6464 Lisp_Object wn;
6466 XSETWINDOW (wn, w);
6467 if (!NILP (w->hchild))
6468 wn = Fcons (Qnil, Fcons (Fwindow_edges (wn),
6469 window_tree (XWINDOW (w->hchild))));
6470 else if (!NILP (w->vchild))
6471 wn = Fcons (Qt, Fcons (Fwindow_edges (wn),
6472 window_tree (XWINDOW (w->vchild))));
6474 if (NILP (result))
6476 result = tail = Fcons (wn, Qnil);
6478 else
6480 XSETCDR (tail, Fcons (wn, Qnil));
6481 tail = XCDR (tail);
6484 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6487 return result;
6492 DEFUN ("window-tree", Fwindow_tree, Swindow_tree,
6493 0, 1, 0,
6494 doc: /* Return the window tree for frame FRAME.
6496 The return value is a list of the form (ROOT MINI), where ROOT
6497 represents the window tree of the frame's root window, and MINI
6498 is the frame's minibuffer window.
6500 If the root window is not split, ROOT is the root window itself.
6501 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil for a
6502 horizontal split, and t for a vertical split, EDGES gives the combined
6503 size and position of the subwindows in the split, and the rest of the
6504 elements are the subwindows in the split. Each of the subwindows may
6505 again be a window or a list representing a window split, and so on.
6506 EDGES is a list \(LEFT TOP RIGHT BOTTOM) as returned by `window-edges'.
6508 If FRAME is nil or omitted, return information on the currently
6509 selected frame. */)
6510 (frame)
6511 Lisp_Object frame;
6513 FRAME_PTR f;
6515 if (NILP (frame))
6516 frame = selected_frame;
6518 CHECK_FRAME (frame);
6519 f = XFRAME (frame);
6521 if (!FRAME_LIVE_P (f))
6522 return Qnil;
6524 return window_tree (XWINDOW (FRAME_ROOT_WINDOW (f)));
6528 /***********************************************************************
6529 Marginal Areas
6530 ***********************************************************************/
6532 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6533 2, 3, 0,
6534 doc: /* Set width of marginal areas of window WINDOW.
6535 If WINDOW is nil, set margins of the currently selected window.
6536 Second arg LEFT-WIDTH specifies the number of character cells to
6537 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6538 does the same for the right marginal area. A nil width parameter
6539 means no margin. */)
6540 (window, left_width, right_width)
6541 Lisp_Object window, left_width, right_width;
6543 struct window *w = decode_window (window);
6545 /* Translate negative or zero widths to nil.
6546 Margins that are too wide have to be checked elsewhere. */
6548 if (!NILP (left_width))
6550 CHECK_NUMBER (left_width);
6551 if (XINT (left_width) <= 0)
6552 left_width = Qnil;
6555 if (!NILP (right_width))
6557 CHECK_NUMBER (right_width);
6558 if (XINT (right_width) <= 0)
6559 right_width = Qnil;
6562 if (!EQ (w->left_margin_cols, left_width)
6563 || !EQ (w->right_margin_cols, right_width))
6565 w->left_margin_cols = left_width;
6566 w->right_margin_cols = right_width;
6568 adjust_window_margins (w);
6570 ++windows_or_buffers_changed;
6571 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6574 return Qnil;
6578 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6579 0, 1, 0,
6580 doc: /* Get width of marginal areas of window WINDOW.
6581 If WINDOW is omitted or nil, use the currently selected window.
6582 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6583 If a marginal area does not exist, its width will be returned
6584 as nil. */)
6585 (window)
6586 Lisp_Object window;
6588 struct window *w = decode_window (window);
6589 return Fcons (w->left_margin_cols, w->right_margin_cols);
6594 /***********************************************************************
6595 Fringes
6596 ***********************************************************************/
6598 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6599 2, 4, 0,
6600 doc: /* Set the fringe widths of window WINDOW.
6601 If WINDOW is nil, set the fringe widths of the currently selected
6602 window.
6603 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6604 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6605 fringe width. If a fringe width arg is nil, that means to use the
6606 frame's default fringe width. Default fringe widths can be set with
6607 the command `set-fringe-style'.
6608 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6609 outside of the display margins. By default, fringes are drawn between
6610 display marginal areas and the text area. */)
6611 (window, left_width, right_width, outside_margins)
6612 Lisp_Object window, left_width, right_width, outside_margins;
6614 struct window *w = decode_window (window);
6616 if (!NILP (left_width))
6617 CHECK_NATNUM (left_width);
6618 if (!NILP (right_width))
6619 CHECK_NATNUM (right_width);
6621 /* Do nothing on a tty. */
6622 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6623 && (!EQ (w->left_fringe_width, left_width)
6624 || !EQ (w->right_fringe_width, right_width)
6625 || !EQ (w->fringes_outside_margins, outside_margins)))
6627 w->left_fringe_width = left_width;
6628 w->right_fringe_width = right_width;
6629 w->fringes_outside_margins = outside_margins;
6631 adjust_window_margins (w);
6633 clear_glyph_matrix (w->current_matrix);
6634 w->window_end_valid = Qnil;
6636 ++windows_or_buffers_changed;
6637 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6640 return Qnil;
6644 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6645 0, 1, 0,
6646 doc: /* Get width of fringes of window WINDOW.
6647 If WINDOW is omitted or nil, use the currently selected window.
6648 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6649 (window)
6650 Lisp_Object window;
6652 struct window *w = decode_window (window);
6654 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6655 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6656 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6657 ? Qt : Qnil), Qnil)));
6662 /***********************************************************************
6663 Scroll bars
6664 ***********************************************************************/
6666 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars, Sset_window_scroll_bars,
6667 2, 4, 0,
6668 doc: /* Set width and type of scroll bars of window WINDOW.
6669 If window is nil, set scroll bars of the currently selected window.
6670 Second parameter WIDTH specifies the pixel width for the scroll bar;
6671 this is automatically adjusted to a multiple of the frame column width.
6672 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6673 bar: left, right, or nil.
6674 If WIDTH is nil, use the frame's scroll-bar width.
6675 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6676 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6677 (window, width, vertical_type, horizontal_type)
6678 Lisp_Object window, width, vertical_type, horizontal_type;
6680 struct window *w = decode_window (window);
6682 if (!NILP (width))
6684 CHECK_NATNUM (width);
6686 if (XINT (width) == 0)
6687 vertical_type = Qnil;
6690 if (!(NILP (vertical_type)
6691 || EQ (vertical_type, Qleft)
6692 || EQ (vertical_type, Qright)
6693 || EQ (vertical_type, Qt)))
6694 error ("Invalid type of vertical scroll bar");
6696 if (!EQ (w->scroll_bar_width, width)
6697 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6699 w->scroll_bar_width = width;
6700 w->vertical_scroll_bar_type = vertical_type;
6702 adjust_window_margins (w);
6704 clear_glyph_matrix (w->current_matrix);
6705 w->window_end_valid = Qnil;
6707 ++windows_or_buffers_changed;
6708 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6711 return Qnil;
6715 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6716 0, 1, 0,
6717 doc: /* Get width and type of scroll bars of window WINDOW.
6718 If WINDOW is omitted or nil, use the currently selected window.
6719 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6720 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6721 value. */)
6722 (window)
6723 Lisp_Object window;
6725 struct window *w = decode_window (window);
6726 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6727 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6728 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6729 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
6730 Fcons (w->vertical_scroll_bar_type,
6731 Fcons (Qnil, Qnil))));
6736 /***********************************************************************
6737 Smooth scrolling
6738 ***********************************************************************/
6740 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6741 doc: /* Return the amount by which WINDOW is scrolled vertically.
6742 Use the selected window if WINDOW is nil or omitted.
6743 Normally, value is a multiple of the canonical character height of WINDOW;
6744 optional second arg PIXELS-P means value is measured in pixels. */)
6745 (window, pixels_p)
6746 Lisp_Object window, pixels_p;
6748 Lisp_Object result;
6749 struct frame *f;
6750 struct window *w;
6752 if (NILP (window))
6753 window = selected_window;
6754 else
6755 CHECK_WINDOW (window);
6756 w = XWINDOW (window);
6757 f = XFRAME (w->frame);
6759 if (FRAME_WINDOW_P (f))
6760 result = (NILP (pixels_p)
6761 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
6762 : make_number (-w->vscroll));
6763 else
6764 result = make_number (0);
6765 return result;
6769 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
6770 2, 3, 0,
6771 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6772 WINDOW nil means use the selected window. Normally, VSCROLL is a
6773 non-negative multiple of the canonical character height of WINDOW;
6774 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6775 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6776 corresponds to an integral number of pixels. The return value is the
6777 result of this rounding.
6778 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6779 (window, vscroll, pixels_p)
6780 Lisp_Object window, vscroll, pixels_p;
6782 struct window *w;
6783 struct frame *f;
6785 if (NILP (window))
6786 window = selected_window;
6787 else
6788 CHECK_WINDOW (window);
6789 CHECK_NUMBER_OR_FLOAT (vscroll);
6791 w = XWINDOW (window);
6792 f = XFRAME (w->frame);
6794 if (FRAME_WINDOW_P (f))
6796 int old_dy = w->vscroll;
6798 w->vscroll = - (NILP (pixels_p)
6799 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6800 : XFLOATINT (vscroll));
6801 w->vscroll = min (w->vscroll, 0);
6803 if (w->vscroll != old_dy)
6805 /* Adjust glyph matrix of the frame if the virtual display
6806 area becomes larger than before. */
6807 if (w->vscroll < 0 && w->vscroll < old_dy)
6808 adjust_glyphs (f);
6810 /* Prevent redisplay shortcuts. */
6811 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
6815 return Fwindow_vscroll (window, pixels_p);
6819 /* Call FN for all leaf windows on frame F. FN is called with the
6820 first argument being a pointer to the leaf window, and with
6821 additional argument USER_DATA. Stops when FN returns 0. */
6823 void
6824 foreach_window (f, fn, user_data)
6825 struct frame *f;
6826 int (* fn) P_ ((struct window *, void *));
6827 void *user_data;
6829 /* Fdelete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6830 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6831 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6835 /* Helper function for foreach_window. Call FN for all leaf windows
6836 reachable from W. FN is called with the first argument being a
6837 pointer to the leaf window, and with additional argument USER_DATA.
6838 Stop when FN returns 0. Value is 0 if stopped by FN. */
6840 static int
6841 foreach_window_1 (w, fn, user_data)
6842 struct window *w;
6843 int (* fn) P_ ((struct window *, void *));
6844 void *user_data;
6846 int cont;
6848 for (cont = 1; w && cont;)
6850 if (!NILP (w->hchild))
6851 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6852 else if (!NILP (w->vchild))
6853 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6854 else
6855 cont = fn (w, user_data);
6857 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6860 return cont;
6864 /* Freeze or unfreeze the window start of W unless it is a
6865 mini-window or the selected window. FREEZE_P non-null means freeze
6866 the window start. */
6868 static int
6869 freeze_window_start (w, freeze_p)
6870 struct window *w;
6871 void *freeze_p;
6873 if (MINI_WINDOW_P (w)
6874 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6875 && (w == XWINDOW (selected_window)
6876 || (MINI_WINDOW_P (XWINDOW (selected_window))
6877 && ! NILP (Vminibuf_scroll_window)
6878 && w == XWINDOW (Vminibuf_scroll_window)))))
6879 freeze_p = NULL;
6881 w->frozen_window_start_p = freeze_p != NULL;
6882 return 1;
6886 /* Freeze or unfreeze the window starts of all leaf windows on frame
6887 F, except the selected window and a mini-window. FREEZE_P non-zero
6888 means freeze the window start. */
6890 void
6891 freeze_window_starts (f, freeze_p)
6892 struct frame *f;
6893 int freeze_p;
6895 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6899 /***********************************************************************
6900 Initialization
6901 ***********************************************************************/
6903 /* Return 1 if window configurations C1 and C2
6904 describe the same state of affairs. This is used by Fequal. */
6907 compare_window_configurations (c1, c2, ignore_positions)
6908 Lisp_Object c1, c2;
6909 int ignore_positions;
6911 register struct save_window_data *d1, *d2;
6912 struct Lisp_Vector *sw1, *sw2;
6913 int i;
6915 CHECK_WINDOW_CONFIGURATION (c1);
6916 CHECK_WINDOW_CONFIGURATION (c2);
6918 d1 = (struct save_window_data *) XVECTOR (c1);
6919 d2 = (struct save_window_data *) XVECTOR (c2);
6920 sw1 = XVECTOR (d1->saved_windows);
6921 sw2 = XVECTOR (d2->saved_windows);
6923 if (d1->frame_cols != d2->frame_cols)
6924 return 0;
6925 if (d1->frame_lines != d2->frame_lines)
6926 return 0;
6927 if (d1->frame_menu_bar_lines != d2->frame_menu_bar_lines)
6928 return 0;
6929 if (! EQ (d1->selected_frame, d2->selected_frame))
6930 return 0;
6931 /* Don't compare the current_window field directly.
6932 Instead see w1_is_current and w2_is_current, below. */
6933 if (! EQ (d1->current_buffer, d2->current_buffer))
6934 return 0;
6935 if (! ignore_positions)
6937 if (! EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window))
6938 return 0;
6939 if (! EQ (d1->minibuf_selected_window, d2->minibuf_selected_window))
6940 return 0;
6942 /* Don't compare the root_window field.
6943 We don't require the two configurations
6944 to use the same window object,
6945 and the two root windows must be equivalent
6946 if everything else compares equal. */
6947 if (! EQ (d1->focus_frame, d2->focus_frame))
6948 return 0;
6950 /* Verify that the two confis have the same number of windows. */
6951 if (sw1->size != sw2->size)
6952 return 0;
6954 for (i = 0; i < sw1->size; i++)
6956 struct saved_window *p1, *p2;
6957 int w1_is_current, w2_is_current;
6959 p1 = SAVED_WINDOW_N (sw1, i);
6960 p2 = SAVED_WINDOW_N (sw2, i);
6962 /* Verify that the current windows in the two
6963 configurations correspond to each other. */
6964 w1_is_current = EQ (d1->current_window, p1->window);
6965 w2_is_current = EQ (d2->current_window, p2->window);
6967 if (w1_is_current != w2_is_current)
6968 return 0;
6970 /* Verify that the corresponding windows do match. */
6971 if (! EQ (p1->buffer, p2->buffer))
6972 return 0;
6973 if (! EQ (p1->left_col, p2->left_col))
6974 return 0;
6975 if (! EQ (p1->top_line, p2->top_line))
6976 return 0;
6977 if (! EQ (p1->total_cols, p2->total_cols))
6978 return 0;
6979 if (! EQ (p1->total_lines, p2->total_lines))
6980 return 0;
6981 if (! EQ (p1->display_table, p2->display_table))
6982 return 0;
6983 if (! EQ (p1->parent, p2->parent))
6984 return 0;
6985 if (! EQ (p1->prev, p2->prev))
6986 return 0;
6987 if (! ignore_positions)
6989 if (! EQ (p1->hscroll, p2->hscroll))
6990 return 0;
6991 if (!EQ (p1->min_hscroll, p2->min_hscroll))
6992 return 0;
6993 if (! EQ (p1->start_at_line_beg, p2->start_at_line_beg))
6994 return 0;
6995 if (NILP (Fequal (p1->start, p2->start)))
6996 return 0;
6997 if (NILP (Fequal (p1->pointm, p2->pointm)))
6998 return 0;
6999 if (NILP (Fequal (p1->mark, p2->mark)))
7000 return 0;
7002 if (! EQ (p1->left_margin_cols, p2->left_margin_cols))
7003 return 0;
7004 if (! EQ (p1->right_margin_cols, p2->right_margin_cols))
7005 return 0;
7006 if (! EQ (p1->left_fringe_width, p2->left_fringe_width))
7007 return 0;
7008 if (! EQ (p1->right_fringe_width, p2->right_fringe_width))
7009 return 0;
7010 if (! EQ (p1->fringes_outside_margins, p2->fringes_outside_margins))
7011 return 0;
7012 if (! EQ (p1->scroll_bar_width, p2->scroll_bar_width))
7013 return 0;
7014 if (! EQ (p1->vertical_scroll_bar_type, p2->vertical_scroll_bar_type))
7015 return 0;
7018 return 1;
7021 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
7022 Scompare_window_configurations, 2, 2, 0,
7023 doc: /* Compare two window configurations as regards the structure of windows.
7024 This function ignores details such as the values of point and mark
7025 and scrolling positions. */)
7026 (x, y)
7027 Lisp_Object x, y;
7029 if (compare_window_configurations (x, y, 1))
7030 return Qt;
7031 return Qnil;
7034 void
7035 init_window_once ()
7037 struct frame *f = make_initial_frame ();
7038 XSETFRAME (selected_frame, f);
7039 Vterminal_frame = selected_frame;
7040 minibuf_window = f->minibuffer_window;
7041 selected_window = f->selected_window;
7042 last_nonminibuf_frame = f;
7044 window_initialized = 1;
7047 void
7048 init_window ()
7050 Vwindow_list = Qnil;
7053 void
7054 syms_of_window ()
7056 Qscroll_up = intern ("scroll-up");
7057 staticpro (&Qscroll_up);
7059 Qscroll_down = intern ("scroll-down");
7060 staticpro (&Qscroll_down);
7062 Qwindow_size_fixed = intern ("window-size-fixed");
7063 staticpro (&Qwindow_size_fixed);
7064 Fset (Qwindow_size_fixed, Qnil);
7066 staticpro (&Qwindow_configuration_change_hook);
7067 Qwindow_configuration_change_hook
7068 = intern ("window-configuration-change-hook");
7070 Qwindowp = intern ("windowp");
7071 staticpro (&Qwindowp);
7073 Qwindow_configuration_p = intern ("window-configuration-p");
7074 staticpro (&Qwindow_configuration_p);
7076 Qwindow_live_p = intern ("window-live-p");
7077 staticpro (&Qwindow_live_p);
7079 Qdisplay_buffer = intern ("display-buffer");
7080 staticpro (&Qdisplay_buffer);
7082 Qtemp_buffer_show_hook = intern ("temp-buffer-show-hook");
7083 staticpro (&Qtemp_buffer_show_hook);
7085 staticpro (&Vwindow_list);
7087 minibuf_selected_window = Qnil;
7088 staticpro (&minibuf_selected_window);
7090 window_scroll_pixel_based_preserve_x = -1;
7091 window_scroll_pixel_based_preserve_y = -1;
7092 window_scroll_preserve_hpos = -1;
7093 window_scroll_preserve_vpos = -1;
7095 DEFVAR_LISP ("temp-buffer-show-function", &Vtemp_buffer_show_function,
7096 doc: /* Non-nil means call as function to display a help buffer.
7097 The function is called with one argument, the buffer to be displayed.
7098 Used by `with-output-to-temp-buffer'.
7099 If this function is used, then it must do the entire job of showing
7100 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
7101 Vtemp_buffer_show_function = Qnil;
7103 DEFVAR_LISP ("minibuffer-scroll-window", &Vminibuf_scroll_window,
7104 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
7105 Vminibuf_scroll_window = Qnil;
7107 DEFVAR_BOOL ("mode-line-in-non-selected-windows", &mode_line_in_non_selected_windows,
7108 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
7109 If the minibuffer is active, the `minibuffer-scroll-window' mode line
7110 is displayed in the `mode-line' face. */);
7111 mode_line_in_non_selected_windows = 1;
7113 DEFVAR_LISP ("other-window-scroll-buffer", &Vother_window_scroll_buffer,
7114 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
7115 Vother_window_scroll_buffer = Qnil;
7117 DEFVAR_BOOL ("auto-window-vscroll", &auto_window_vscroll_p,
7118 doc: /* *Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
7119 auto_window_vscroll_p = 1;
7121 DEFVAR_INT ("next-screen-context-lines", &next_screen_context_lines,
7122 doc: /* *Number of lines of continuity when scrolling by screenfuls. */);
7123 next_screen_context_lines = 2;
7125 DEFVAR_INT ("window-min-height", &window_min_height,
7126 doc: /* Allow deleting windows less than this tall.
7127 The value is measured in line units. If a window wants a modeline it
7128 is counted as one line.
7130 Emacs honors settings of this variable when enlarging or shrinking
7131 windows vertically. A value less than 1 is invalid. */);
7132 window_min_height = 4;
7134 DEFVAR_INT ("window-min-width", &window_min_width,
7135 doc: /* Allow deleting windows less than this wide.
7136 The value is measured in characters and includes any fringes or
7137 the scrollbar.
7139 Emacs honors settings of this variable when enlarging or shrinking
7140 windows horizontally. A value less than 2 is invalid. */);
7141 window_min_width = 10;
7143 DEFVAR_LISP ("scroll-preserve-screen-position",
7144 &Vscroll_preserve_screen_position,
7145 doc: /* *Controls if scroll commands move point to keep its screen position unchanged.
7146 A value of nil means point does not keep its screen position except
7147 at the scroll margin or window boundary respectively.
7148 A value of t means point keeps its screen position if the scroll
7149 command moved it vertically out of the window, e.g. when scrolling
7150 by full screens.
7151 Any other value means point always keeps its screen position. */);
7152 Vscroll_preserve_screen_position = Qnil;
7154 DEFVAR_LISP ("window-configuration-change-hook",
7155 &Vwindow_configuration_change_hook,
7156 doc: /* Functions to call when window configuration changes.
7157 The buffer-local part is run once per window, with the relevant window
7158 selected; while the global part is run only once for the modified frame,
7159 with the relevant frame selected. */);
7160 Vwindow_configuration_change_hook = Qnil;
7162 defsubr (&Sselected_window);
7163 defsubr (&Sminibuffer_window);
7164 defsubr (&Swindow_minibuffer_p);
7165 defsubr (&Swindowp);
7166 defsubr (&Swindow_live_p);
7167 defsubr (&Spos_visible_in_window_p);
7168 defsubr (&Swindow_line_height);
7169 defsubr (&Swindow_buffer);
7170 defsubr (&Swindow_height);
7171 defsubr (&Swindow_width);
7172 defsubr (&Swindow_full_width_p);
7173 defsubr (&Swindow_hscroll);
7174 defsubr (&Sset_window_hscroll);
7175 defsubr (&Swindow_redisplay_end_trigger);
7176 defsubr (&Sset_window_redisplay_end_trigger);
7177 defsubr (&Swindow_edges);
7178 defsubr (&Swindow_pixel_edges);
7179 defsubr (&Swindow_inside_edges);
7180 defsubr (&Swindow_inside_pixel_edges);
7181 defsubr (&Scoordinates_in_window_p);
7182 defsubr (&Swindow_at);
7183 defsubr (&Swindow_point);
7184 defsubr (&Swindow_start);
7185 defsubr (&Swindow_end);
7186 defsubr (&Sset_window_point);
7187 defsubr (&Sset_window_start);
7188 defsubr (&Swindow_dedicated_p);
7189 defsubr (&Sset_window_dedicated_p);
7190 defsubr (&Swindow_display_table);
7191 defsubr (&Sset_window_display_table);
7192 defsubr (&Snext_window);
7193 defsubr (&Sprevious_window);
7194 defsubr (&Sother_window);
7195 defsubr (&Sget_lru_window);
7196 defsubr (&Sget_largest_window);
7197 defsubr (&Sget_buffer_window);
7198 defsubr (&Sdelete_other_windows);
7199 defsubr (&Sdelete_windows_on);
7200 defsubr (&Sreplace_buffer_in_windows);
7201 defsubr (&Sdelete_window);
7202 defsubr (&Sset_window_buffer);
7203 defsubr (&Sselect_window);
7204 defsubr (&Sforce_window_update);
7205 defsubr (&Ssplit_window);
7206 defsubr (&Senlarge_window);
7207 defsubr (&Sshrink_window);
7208 defsubr (&Sadjust_window_trailing_edge);
7209 defsubr (&Sscroll_up);
7210 defsubr (&Sscroll_down);
7211 defsubr (&Sscroll_left);
7212 defsubr (&Sscroll_right);
7213 defsubr (&Sother_window_for_scrolling);
7214 defsubr (&Sscroll_other_window);
7215 defsubr (&Sminibuffer_selected_window);
7216 defsubr (&Srecenter);
7217 defsubr (&Swindow_text_height);
7218 defsubr (&Smove_to_window_line);
7219 defsubr (&Swindow_configuration_p);
7220 defsubr (&Swindow_configuration_frame);
7221 defsubr (&Sset_window_configuration);
7222 defsubr (&Scurrent_window_configuration);
7223 defsubr (&Ssave_window_excursion);
7224 defsubr (&Swindow_tree);
7225 defsubr (&Sset_window_margins);
7226 defsubr (&Swindow_margins);
7227 defsubr (&Sset_window_fringes);
7228 defsubr (&Swindow_fringes);
7229 defsubr (&Sset_window_scroll_bars);
7230 defsubr (&Swindow_scroll_bars);
7231 defsubr (&Swindow_vscroll);
7232 defsubr (&Sset_window_vscroll);
7233 defsubr (&Scompare_window_configurations);
7234 defsubr (&Swindow_list);
7235 defsubr (&Swindow_parameters);
7236 defsubr (&Swindow_parameter);
7237 defsubr (&Sset_window_parameter);
7241 void
7242 keys_of_window ()
7244 initial_define_key (control_x_map, '1', "delete-other-windows");
7245 initial_define_key (control_x_map, '2', "split-window");
7246 initial_define_key (control_x_map, '0', "delete-window");
7247 initial_define_key (control_x_map, 'o', "other-window");
7248 initial_define_key (control_x_map, '^', "enlarge-window");
7249 initial_define_key (control_x_map, '<', "scroll-left");
7250 initial_define_key (control_x_map, '>', "scroll-right");
7252 initial_define_key (global_map, Ctl ('V'), "scroll-up");
7253 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
7254 initial_define_key (meta_map, 'v', "scroll-down");
7256 initial_define_key (global_map, Ctl('L'), "recenter");
7257 initial_define_key (meta_map, 'r', "move-to-window-line");
7260 /* arch-tag: 90a9c576-0590-48f1-a5f1-6c96a0452d9f
7261 (do not change this comment) */