Switch to recommended form of GPLv3 permissions notice.
[emacs.git] / src / window.c
blobf93cb6a366e6fe146a487c22ebdb5810054fa931
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, or (at your option)
12 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; see the file COPYING. If not, write to
21 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22 Boston, MA 02110-1301, USA. */
24 #include <config.h>
25 #include <stdio.h>
27 #include "lisp.h"
28 #include "buffer.h"
29 #include "keyboard.h"
30 #include "keymap.h"
31 #include "frame.h"
32 #include "window.h"
33 #include "commands.h"
34 #include "indent.h"
35 #include "termchar.h"
36 #include "disptab.h"
37 #include "dispextern.h"
38 #include "blockinput.h"
39 #include "intervals.h"
40 #include "termhooks.h" /* For FRAME_TERMINAL. */
42 #ifdef HAVE_X_WINDOWS
43 #include "xterm.h"
44 #endif /* HAVE_X_WINDOWS */
45 #ifdef WINDOWSNT
46 #include "w32term.h"
47 #endif
48 #ifdef MSDOS
49 #include "msdos.h"
50 #endif
51 #ifdef MAC_OS
52 #include "macterm.h"
53 #endif
56 Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
57 Lisp_Object Qscroll_up, Qscroll_down;
58 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 /* Nonzero implies Fdisplay_buffer should create windows. */
146 int pop_up_windows;
148 /* Nonzero implies make new frames for Fdisplay_buffer. */
150 int pop_up_frames;
152 /* Nonzero means reuse existing frames for displaying buffers. */
154 int display_buffer_reuse_frames;
156 /* Non-nil means use this function instead of default */
158 Lisp_Object Vpop_up_frame_function;
160 /* Function to call to handle Fdisplay_buffer. */
162 Lisp_Object Vdisplay_buffer_function;
164 /* Non-nil means that Fdisplay_buffer should even the heights of windows. */
166 Lisp_Object Veven_window_heights;
168 /* List of buffer *names* for buffers that should have their own frames. */
170 Lisp_Object Vspecial_display_buffer_names;
172 /* List of regexps for buffer names that should have their own frames. */
174 Lisp_Object Vspecial_display_regexps;
176 /* Function to pop up a special frame. */
178 Lisp_Object Vspecial_display_function;
180 /* List of buffer *names* for buffers to appear in selected window. */
182 Lisp_Object Vsame_window_buffer_names;
184 /* List of regexps for buffer names to appear in selected window. */
186 Lisp_Object Vsame_window_regexps;
188 /* Hook run at end of temp_output_buffer_show. */
190 Lisp_Object Qtemp_buffer_show_hook;
192 /* Fdisplay_buffer always splits the largest window
193 if that window is more than this high. */
195 EMACS_INT split_height_threshold;
197 /* How to split windows (horizontally/vertically/hybrid). */
199 Lisp_Object Vsplit_window_preferred_function;
201 /* Number of lines of continuity in scrolling by screenfuls. */
203 EMACS_INT next_screen_context_lines;
205 /* Incremented for each window created. */
207 static int sequence_number;
209 /* Nonzero after init_window_once has finished. */
211 static int window_initialized;
213 /* Hook to run when window config changes. */
215 static Lisp_Object Qwindow_configuration_change_hook;
216 static Lisp_Object Vwindow_configuration_change_hook;
218 /* Non-nil means scroll commands try to put point
219 at the same screen height as previously. */
221 Lisp_Object Vscroll_preserve_screen_position;
223 /* Incremented by 1 whenever a window is deleted. */
225 int window_deletion_count;
227 /* Used by the function window_scroll_pixel_based */
229 static int window_scroll_pixel_based_preserve_y;
231 #if 0 /* This isn't used anywhere. */
232 /* Nonzero means we can split a frame even if it is "unsplittable". */
233 static int inhibit_frame_unsplittable;
234 #endif /* 0 */
236 extern EMACS_INT scroll_margin;
238 extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
240 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
241 doc: /* Returns t if OBJECT is a window. */)
242 (object)
243 Lisp_Object object;
245 return WINDOWP (object) ? Qt : Qnil;
248 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
249 doc: /* Returns t if OBJECT is a window which is currently visible. */)
250 (object)
251 Lisp_Object object;
253 return WINDOW_LIVE_P (object) ? Qt : Qnil;
256 Lisp_Object
257 make_window ()
259 Lisp_Object val;
260 register struct window *p;
262 p = allocate_window ();
263 ++sequence_number;
264 XSETFASTINT (p->sequence_number, sequence_number);
265 XSETFASTINT (p->left_col, 0);
266 XSETFASTINT (p->top_line, 0);
267 XSETFASTINT (p->total_lines, 0);
268 XSETFASTINT (p->total_cols, 0);
269 XSETFASTINT (p->hscroll, 0);
270 XSETFASTINT (p->min_hscroll, 0);
271 p->orig_top_line = p->orig_total_lines = Qnil;
272 p->start = Fmake_marker ();
273 p->pointm = Fmake_marker ();
274 XSETFASTINT (p->use_time, 0);
275 p->frame = Qnil;
276 p->display_table = Qnil;
277 p->dedicated = Qnil;
278 p->pseudo_window_p = 0;
279 bzero (&p->cursor, sizeof (p->cursor));
280 bzero (&p->last_cursor, sizeof (p->last_cursor));
281 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
282 p->desired_matrix = p->current_matrix = 0;
283 p->nrows_scale_factor = p->ncols_scale_factor = 1;
284 p->phys_cursor_type = -1;
285 p->phys_cursor_width = -1;
286 p->must_be_updated_p = 0;
287 XSETFASTINT (p->window_end_vpos, 0);
288 XSETFASTINT (p->window_end_pos, 0);
289 p->window_end_valid = Qnil;
290 p->vscroll = 0;
291 XSETWINDOW (val, p);
292 XSETFASTINT (p->last_point, 0);
293 p->frozen_window_start_p = 0;
294 p->last_cursor_off_p = p->cursor_off_p = 0;
295 p->left_margin_cols = Qnil;
296 p->right_margin_cols = Qnil;
297 p->left_fringe_width = Qnil;
298 p->right_fringe_width = Qnil;
299 p->fringes_outside_margins = Qnil;
300 p->scroll_bar_width = Qnil;
301 p->vertical_scroll_bar_type = Qt;
302 p->resize_proportionally = Qnil;
304 Vwindow_list = Qnil;
305 return val;
308 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
309 doc: /* Return the window that the cursor now appears in and commands apply to. */)
312 return selected_window;
315 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
316 doc: /* Return the window used now for minibuffers.
317 If the optional argument FRAME is specified, return the minibuffer window
318 used by that frame. */)
319 (frame)
320 Lisp_Object frame;
322 if (NILP (frame))
323 frame = selected_frame;
324 CHECK_LIVE_FRAME (frame);
325 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
328 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
329 doc: /* Returns non-nil if WINDOW is a minibuffer window.
330 WINDOW defaults to the selected window. */)
331 (window)
332 Lisp_Object window;
334 struct window *w = decode_window (window);
335 return MINI_WINDOW_P (w) ? Qt : Qnil;
339 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
340 Spos_visible_in_window_p, 0, 3, 0,
341 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
342 Return nil if that position is scrolled vertically out of view.
343 If a character is only partially visible, nil is returned, unless the
344 optional argument PARTIALLY is non-nil.
345 If POS is only out of view because of horizontal scrolling, return non-nil.
346 If POS is t, it specifies the position of the last visible glyph in WINDOW.
347 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
349 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
350 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
351 where X and Y are the pixel coordinates relative to the top left corner
352 of the window. The remaining elements are omitted if the character after
353 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
354 off-window at the top and bottom of the row, ROWH is the height of the
355 display row, and VPOS is the row number (0-based) containing POS. */)
356 (pos, window, partially)
357 Lisp_Object pos, window, partially;
359 register struct window *w;
360 register int posint;
361 register struct buffer *buf;
362 struct text_pos top;
363 Lisp_Object in_window = Qnil;
364 int rtop, rbot, rowh, vpos, fully_p = 1;
365 int x, y;
367 w = decode_window (window);
368 buf = XBUFFER (w->buffer);
369 SET_TEXT_POS_FROM_MARKER (top, w->start);
371 if (EQ (pos, Qt))
372 posint = -1;
373 else if (!NILP (pos))
375 CHECK_NUMBER_COERCE_MARKER (pos);
376 posint = XINT (pos);
378 else if (w == XWINDOW (selected_window))
379 posint = PT;
380 else
381 posint = XMARKER (w->pointm)->charpos;
383 /* If position is above window start or outside buffer boundaries,
384 or if window start is out of range, position is not visible. */
385 if ((EQ (pos, Qt)
386 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
387 && CHARPOS (top) >= BUF_BEGV (buf)
388 && CHARPOS (top) <= BUF_ZV (buf)
389 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
390 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
391 in_window = Qt;
393 if (!NILP (in_window) && !NILP (partially))
395 Lisp_Object part = Qnil;
396 if (!fully_p)
397 part = list4 (make_number (rtop), make_number (rbot),
398 make_number (rowh), make_number (vpos));
399 in_window = Fcons (make_number (x),
400 Fcons (make_number (y), part));
403 return in_window;
406 DEFUN ("window-line-height", Fwindow_line_height,
407 Swindow_line_height, 0, 2, 0,
408 doc: /* Return height in pixels of text line LINE in window WINDOW.
409 If WINDOW is nil or omitted, use selected window.
411 Return height of current line if LINE is omitted or nil. Return height of
412 header or mode line if LINE is `header-line' and `mode-line'.
413 Otherwise, LINE is a text line number starting from 0. A negative number
414 counts from the end of the window.
416 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
417 in pixels of the visible part of the line, VPOS and YPOS are the
418 vertical position in lines and pixels of the line, relative to the top
419 of the first text line, and OFFBOT is the number of off-window pixels at
420 the bottom of the text line. If there are off-window pixels at the top
421 of the (first) text line, YPOS is negative.
423 Return nil if window display is not up-to-date. In that case, use
424 `pos-visible-in-window-p' to obtain the information. */)
425 (line, window)
426 Lisp_Object line, window;
428 register struct window *w;
429 register struct buffer *b;
430 struct glyph_row *row, *end_row;
431 int max_y, crop, i, n;
433 w = decode_window (window);
435 if (noninteractive
436 || w->pseudo_window_p)
437 return Qnil;
439 CHECK_BUFFER (w->buffer);
440 b = XBUFFER (w->buffer);
442 /* Fail if current matrix is not up-to-date. */
443 if (NILP (w->window_end_valid)
444 || current_buffer->clip_changed
445 || current_buffer->prevent_redisplay_optimizations_p
446 || XFASTINT (w->last_modified) < BUF_MODIFF (b)
447 || XFASTINT (w->last_overlay_modified) < BUF_OVERLAY_MODIFF (b))
448 return Qnil;
450 if (NILP (line))
452 i = w->cursor.vpos;
453 if (i < 0 || i >= w->current_matrix->nrows
454 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
455 return Qnil;
456 max_y = window_text_bottom_y (w);
457 goto found_row;
460 if (EQ (line, Qheader_line))
462 if (!WINDOW_WANTS_HEADER_LINE_P (w))
463 return Qnil;
464 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
465 if (!row->enabled_p)
466 return Qnil;
467 return list4 (make_number (row->height),
468 make_number (0), make_number (0),
469 make_number (0));
472 if (EQ (line, Qmode_line))
474 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
475 if (!row->enabled_p)
476 return Qnil;
477 return list4 (make_number (row->height),
478 make_number (0), /* not accurate */
479 make_number (WINDOW_HEADER_LINE_HEIGHT (w)
480 + window_text_bottom_y (w)),
481 make_number (0));
484 CHECK_NUMBER (line);
485 n = XINT (line);
487 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
488 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
489 max_y = window_text_bottom_y (w);
490 i = 0;
492 while ((n < 0 || i < n)
493 && row <= end_row && row->enabled_p
494 && row->y + row->height < max_y)
495 row++, i++;
497 if (row > end_row || !row->enabled_p)
498 return Qnil;
500 if (++n < 0)
502 if (-n > i)
503 return Qnil;
504 row += n;
505 i += n;
508 found_row:
509 crop = max (0, (row->y + row->height) - max_y);
510 return list4 (make_number (row->height + min (0, row->y) - crop),
511 make_number (i),
512 make_number (row->y),
513 make_number (crop));
518 static struct window *
519 decode_window (window)
520 register Lisp_Object window;
522 if (NILP (window))
523 return XWINDOW (selected_window);
525 CHECK_LIVE_WINDOW (window);
526 return XWINDOW (window);
529 static struct window *
530 decode_any_window (window)
531 register Lisp_Object window;
533 if (NILP (window))
534 return XWINDOW (selected_window);
536 CHECK_WINDOW (window);
537 return XWINDOW (window);
540 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
541 doc: /* Return the buffer that WINDOW is displaying.
542 WINDOW defaults to the selected window. */)
543 (window)
544 Lisp_Object window;
546 return decode_window (window)->buffer;
549 DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
550 doc: /* Return the number of lines in WINDOW (including its mode line).
551 WINDOW defaults to the selected window. */)
552 (window)
553 Lisp_Object window;
555 return decode_any_window (window)->total_lines;
558 DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
559 doc: /* Return the number of display columns in WINDOW.
560 This is the width that is usable columns available for text in WINDOW.
561 If you want to find out how many columns WINDOW takes up,
562 use (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))). */)
563 (window)
564 Lisp_Object window;
566 return make_number (window_box_text_cols (decode_any_window (window)));
569 DEFUN ("window-full-width-p", Fwindow_full_width_p, Swindow_full_width_p, 0, 1, 0,
570 doc: /* Return t if WINDOW is as wide as its frame.
571 WINDOW defaults to the selected window. */)
572 (window)
573 Lisp_Object window;
575 return WINDOW_FULL_WIDTH_P (decode_any_window (window)) ? Qt : Qnil;
578 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
579 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
580 WINDOW defaults to the selected window. */)
581 (window)
582 Lisp_Object window;
584 return decode_window (window)->hscroll;
587 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
588 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
589 Return NCOL. NCOL should be zero or positive.
591 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
592 window so that the location of point moves off-window. */)
593 (window, ncol)
594 Lisp_Object window, ncol;
596 struct window *w = decode_window (window);
597 int hscroll;
599 CHECK_NUMBER (ncol);
600 hscroll = max (0, XINT (ncol));
602 /* Prevent redisplay shortcuts when changing the hscroll. */
603 if (XINT (w->hscroll) != hscroll)
604 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
606 w->hscroll = make_number (hscroll);
607 return ncol;
610 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
611 Swindow_redisplay_end_trigger, 0, 1, 0,
612 doc: /* Return WINDOW's redisplay end trigger value.
613 WINDOW defaults to the selected window.
614 See `set-window-redisplay-end-trigger' for more information. */)
615 (window)
616 Lisp_Object window;
618 return decode_window (window)->redisplay_end_trigger;
621 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
622 Sset_window_redisplay_end_trigger, 2, 2, 0,
623 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
624 VALUE should be a buffer position (typically a marker) or nil.
625 If it is a buffer position, then if redisplay in WINDOW reaches a position
626 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
627 with two arguments: WINDOW, and the end trigger value.
628 Afterwards the end-trigger value is reset to nil. */)
629 (window, value)
630 register Lisp_Object window, value;
632 register struct window *w;
634 w = decode_window (window);
635 w->redisplay_end_trigger = value;
636 return value;
639 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
640 doc: /* Return a list of the edge coordinates of WINDOW.
641 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
642 RIGHT is one more than the rightmost column occupied by WINDOW,
643 and BOTTOM is one more than the bottommost row occupied by WINDOW.
644 The edges include the space used by the window's scroll bar,
645 display margins, fringes, header line, and mode line, if it has them.
646 To get the edges of the actual text area, use `window-inside-edges'. */)
647 (window)
648 Lisp_Object window;
650 register struct window *w = decode_any_window (window);
652 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
653 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
654 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
655 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
656 Qnil))));
659 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
660 doc: /* Return a list of the edge pixel coordinates of WINDOW.
661 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
662 RIGHT is one more than the rightmost x position occupied by WINDOW,
663 and BOTTOM is one more than the bottommost y position occupied by WINDOW.
664 The pixel edges include the space used by the window's scroll bar,
665 display margins, fringes, header line, and mode line, if it has them.
666 To get the edges of the actual text area, use `window-inside-pixel-edges'. */)
667 (window)
668 Lisp_Object window;
670 register struct window *w = decode_any_window (window);
672 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
673 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
674 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
675 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
676 Qnil))));
679 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
680 doc: /* Return a list of the edge coordinates of WINDOW.
681 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
682 RIGHT is one more than the rightmost column used by text in WINDOW,
683 and BOTTOM is one more than the bottommost row used by text in WINDOW.
684 The inside edges do not include the space used by the window's scroll bar,
685 display margins, fringes, header line, and/or mode line. */)
686 (window)
687 Lisp_Object window;
689 register struct window *w = decode_any_window (window);
691 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
692 + WINDOW_LEFT_MARGIN_COLS (w)
693 + WINDOW_LEFT_FRINGE_COLS (w)),
694 make_number (WINDOW_TOP_EDGE_LINE (w)
695 + WINDOW_HEADER_LINE_LINES (w)),
696 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
697 - WINDOW_RIGHT_MARGIN_COLS (w)
698 - WINDOW_RIGHT_FRINGE_COLS (w)),
699 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
700 - WINDOW_MODE_LINE_LINES (w)));
703 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
704 doc: /* Return a list of the edge pixel coordinates of WINDOW.
705 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
706 RIGHT is one more than the rightmost x position used by text in WINDOW,
707 and BOTTOM is one more than the bottommost y position used by text in WINDOW.
708 The inside edges do not include the space used by the window's scroll bar,
709 display margins, fringes, header line, and/or mode line. */)
710 (window)
711 Lisp_Object window;
713 register struct window *w = decode_any_window (window);
715 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
716 + WINDOW_LEFT_MARGIN_WIDTH (w)
717 + WINDOW_LEFT_FRINGE_WIDTH (w)),
718 make_number (WINDOW_TOP_EDGE_Y (w)
719 + WINDOW_HEADER_LINE_HEIGHT (w)),
720 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
721 - WINDOW_RIGHT_MARGIN_WIDTH (w)
722 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
723 make_number (WINDOW_BOTTOM_EDGE_Y (w)
724 - WINDOW_MODE_LINE_HEIGHT (w)));
727 /* Test if the character at column *X, row *Y is within window W.
728 If it is not, return ON_NOTHING;
729 if it is in the window's text area,
730 set *x and *y to its location relative to the upper left corner
731 of the window, and
732 return ON_TEXT;
733 if it is on the window's modeline, return ON_MODE_LINE;
734 if it is on the border between the window and its right sibling,
735 return ON_VERTICAL_BORDER.
736 if it is on a scroll bar,
737 return ON_SCROLL_BAR.
738 if it is on the window's top line, return ON_HEADER_LINE;
739 if it is in left or right fringe of the window,
740 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE, and convert *X and *Y
741 to window-relative coordinates;
742 if it is in the marginal area to the left/right of the window,
743 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN, and convert *X and *Y
744 to window-relative coordinates.
746 X and Y are frame relative pixel coordinates. */
748 static enum window_part
749 coordinates_in_window (w, x, y)
750 register struct window *w;
751 register int *x, *y;
753 struct frame *f = XFRAME (WINDOW_FRAME (w));
754 int left_x, right_x, top_y, bottom_y;
755 enum window_part part;
756 int ux = FRAME_COLUMN_WIDTH (f);
757 int x0 = WINDOW_LEFT_EDGE_X (w);
758 int x1 = WINDOW_RIGHT_EDGE_X (w);
759 /* The width of the area where the vertical line can be dragged.
760 (Between mode lines for instance. */
761 int grabbable_width = ux;
762 int lmargin_width, rmargin_width, text_left, text_right;
764 /* In what's below, we subtract 1 when computing right_x because we
765 want the rightmost pixel, which is given by left_pixel+width-1. */
766 if (w->pseudo_window_p)
768 left_x = 0;
769 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
770 top_y = WINDOW_TOP_EDGE_Y (w);
771 bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
773 else
775 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
776 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
777 top_y = WINDOW_TOP_EDGE_Y (w);
778 bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
781 /* Outside any interesting row? */
782 if (*y < top_y || *y >= bottom_y)
783 return ON_NOTHING;
785 /* On the mode line or header line? If it's near the start of
786 the mode or header line of window that's has a horizontal
787 sibling, say it's on the vertical line. That's to be able
788 to resize windows horizontally in case we're using toolkit
789 scroll bars. */
791 if (WINDOW_WANTS_MODELINE_P (w)
792 && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
794 part = ON_MODE_LINE;
796 header_vertical_border_check:
797 /* We're somewhere on the mode line. We consider the place
798 between mode lines of horizontally adjacent mode lines
799 as the vertical border. If scroll bars on the left,
800 return the right window. */
801 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
802 || WINDOW_RIGHTMOST_P (w))
804 if (!WINDOW_LEFTMOST_P (w) && eabs (*x - x0) < grabbable_width)
806 /* Convert X and Y to window relative coordinates.
807 Vertical border is at the left edge of window. */
808 *x = max (0, *x - x0);
809 *y -= top_y;
810 return ON_VERTICAL_BORDER;
813 else
815 if (eabs (*x - x1) < grabbable_width)
817 /* Convert X and Y to window relative coordinates.
818 Vertical border is at the right edge of window. */
819 *x = min (x1, *x) - x0;
820 *y -= top_y;
821 return ON_VERTICAL_BORDER;
825 if (*x < x0 || *x >= x1)
826 return ON_NOTHING;
828 /* Convert X and Y to window relative coordinates.
829 Mode line starts at left edge of window. */
830 *x -= x0;
831 *y -= top_y;
832 return part;
835 if (WINDOW_WANTS_HEADER_LINE_P (w)
836 && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
838 part = ON_HEADER_LINE;
839 goto header_vertical_border_check;
842 if (*x < x0 || *x >= x1)
843 return ON_NOTHING;
845 /* Outside any interesting column? */
846 if (*x < left_x || *x > right_x)
848 *y -= top_y;
849 return ON_SCROLL_BAR;
852 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
853 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
855 text_left = window_box_left (w, TEXT_AREA);
856 text_right = text_left + window_box_width (w, TEXT_AREA);
858 if (FRAME_WINDOW_P (f))
860 if (!w->pseudo_window_p
861 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
862 && !WINDOW_RIGHTMOST_P (w)
863 && (eabs (*x - right_x) < grabbable_width))
865 /* Convert X and Y to window relative coordinates.
866 Vertical border is at the right edge of window. */
867 *x = min (right_x, *x) - left_x;
868 *y -= top_y;
869 return ON_VERTICAL_BORDER;
872 else
874 /* Need to say "*x > right_x" rather than >=, since on character
875 terminals, the vertical line's x coordinate is right_x. */
876 if (!w->pseudo_window_p
877 && !WINDOW_RIGHTMOST_P (w)
878 && *x > right_x - ux)
880 /* On the border on the right side of the window? Assume that
881 this area begins at RIGHT_X minus a canonical char width. */
882 *x = min (right_x, *x) - left_x;
883 *y -= top_y;
884 return ON_VERTICAL_BORDER;
888 if (*x < text_left)
890 if (lmargin_width > 0
891 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
892 ? (*x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
893 : (*x < left_x + lmargin_width)))
895 *x -= left_x;
896 if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
897 *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
898 *y -= top_y;
899 return ON_LEFT_MARGIN;
902 /* Convert X and Y to window-relative pixel coordinates. */
903 *x -= left_x;
904 *y -= top_y;
905 return ON_LEFT_FRINGE;
908 if (*x >= text_right)
910 if (rmargin_width > 0
911 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
912 ? (*x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
913 : (*x >= right_x - rmargin_width)))
915 *x -= right_x - rmargin_width;
916 if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
917 *x += WINDOW_RIGHT_FRINGE_WIDTH (w);
918 *y -= top_y;
919 return ON_RIGHT_MARGIN;
922 /* Convert X and Y to window-relative pixel coordinates. */
923 *x -= left_x + WINDOW_LEFT_FRINGE_WIDTH (w);
924 *y -= top_y;
925 return ON_RIGHT_FRINGE;
928 /* Everything special ruled out - must be on text area */
929 *x -= text_left;
930 *y -= top_y;
931 return ON_TEXT;
935 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
936 Scoordinates_in_window_p, 2, 2, 0,
937 doc: /* Return non-nil if COORDINATES are in WINDOW.
938 COORDINATES is a cons of the form (X . Y), X and Y being distances
939 measured in characters from the upper-left corner of the frame.
940 \(0 . 0) denotes the character in the upper left corner of the
941 frame.
942 If COORDINATES are in the text portion of WINDOW,
943 the coordinates relative to the window are returned.
944 If they are in the mode line of WINDOW, `mode-line' is returned.
945 If they are in the top mode line of WINDOW, `header-line' is returned.
946 If they are in the left fringe of WINDOW, `left-fringe' is returned.
947 If they are in the right fringe of WINDOW, `right-fringe' is returned.
948 If they are on the border between WINDOW and its right sibling,
949 `vertical-line' is returned.
950 If they are in the windows's left or right marginal areas, `left-margin'\n\
951 or `right-margin' is returned. */)
952 (coordinates, window)
953 register Lisp_Object coordinates, window;
955 struct window *w;
956 struct frame *f;
957 int x, y;
958 Lisp_Object lx, ly;
960 CHECK_WINDOW (window);
961 w = XWINDOW (window);
962 f = XFRAME (w->frame);
963 CHECK_CONS (coordinates);
964 lx = Fcar (coordinates);
965 ly = Fcdr (coordinates);
966 CHECK_NUMBER_OR_FLOAT (lx);
967 CHECK_NUMBER_OR_FLOAT (ly);
968 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
969 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
971 switch (coordinates_in_window (w, &x, &y))
973 case ON_NOTHING:
974 return Qnil;
976 case ON_TEXT:
977 /* X and Y are now window relative pixel coordinates. Convert
978 them to canonical char units before returning them. */
979 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
980 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
982 case ON_MODE_LINE:
983 return Qmode_line;
985 case ON_VERTICAL_BORDER:
986 return Qvertical_line;
988 case ON_HEADER_LINE:
989 return Qheader_line;
991 case ON_LEFT_FRINGE:
992 return Qleft_fringe;
994 case ON_RIGHT_FRINGE:
995 return Qright_fringe;
997 case ON_LEFT_MARGIN:
998 return Qleft_margin;
1000 case ON_RIGHT_MARGIN:
1001 return Qright_margin;
1003 case ON_SCROLL_BAR:
1004 /* Historically we are supposed to return nil in this case. */
1005 return Qnil;
1007 default:
1008 abort ();
1013 /* Callback for foreach_window, used in window_from_coordinates.
1014 Check if window W contains coordinates specified by USER_DATA which
1015 is actually a pointer to a struct check_window_data CW.
1017 Check if window W contains coordinates *CW->x and *CW->y. If it
1018 does, return W in *CW->window, as Lisp_Object, and return in
1019 *CW->part the part of the window under coordinates *X,*Y. Return
1020 zero from this function to stop iterating over windows. */
1022 struct check_window_data
1024 Lisp_Object *window;
1025 int *x, *y;
1026 enum window_part *part;
1029 static int
1030 check_window_containing (w, user_data)
1031 struct window *w;
1032 void *user_data;
1034 struct check_window_data *cw = (struct check_window_data *) user_data;
1035 enum window_part found;
1036 int continue_p = 1;
1038 found = coordinates_in_window (w, cw->x, cw->y);
1039 if (found != ON_NOTHING)
1041 *cw->part = found;
1042 XSETWINDOW (*cw->window, w);
1043 continue_p = 0;
1046 return continue_p;
1050 /* Find the window containing frame-relative pixel position X/Y and
1051 return it as a Lisp_Object.
1053 If X, Y is on one of the window's special `window_part' elements,
1054 set *PART to the id of that element, and return X and Y converted
1055 to window relative coordinates in WX and WY.
1057 If there is no window under X, Y return nil and leave *PART
1058 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1060 This function was previously implemented with a loop cycling over
1061 windows with Fnext_window, and starting with the frame's selected
1062 window. It turned out that this doesn't work with an
1063 implementation of next_window using Vwindow_list, because
1064 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1065 tree of F when this function is called asynchronously from
1066 note_mouse_highlight. The original loop didn't terminate in this
1067 case. */
1069 Lisp_Object
1070 window_from_coordinates (f, x, y, part, wx, wy, tool_bar_p)
1071 struct frame *f;
1072 int x, y;
1073 enum window_part *part;
1074 int *wx, *wy;
1075 int tool_bar_p;
1077 Lisp_Object window;
1078 struct check_window_data cw;
1079 enum window_part dummy;
1081 if (part == 0)
1082 part = &dummy;
1084 window = Qnil;
1085 cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
1086 foreach_window (f, check_window_containing, &cw);
1088 /* If not found above, see if it's in the tool bar window, if a tool
1089 bar exists. */
1090 if (NILP (window)
1091 && tool_bar_p
1092 && WINDOWP (f->tool_bar_window)
1093 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1094 && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
1095 != ON_NOTHING))
1097 *part = ON_TEXT;
1098 window = f->tool_bar_window;
1101 if (wx) *wx = x;
1102 if (wy) *wy = y;
1104 return window;
1107 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1108 doc: /* Return window containing coordinates X and Y on FRAME.
1109 If omitted, FRAME defaults to the currently selected frame.
1110 The top left corner of the frame is considered to be row 0,
1111 column 0. */)
1112 (x, y, frame)
1113 Lisp_Object x, y, frame;
1115 struct frame *f;
1117 if (NILP (frame))
1118 frame = selected_frame;
1119 CHECK_LIVE_FRAME (frame);
1120 f = XFRAME (frame);
1122 /* Check that arguments are integers or floats. */
1123 CHECK_NUMBER_OR_FLOAT (x);
1124 CHECK_NUMBER_OR_FLOAT (y);
1126 return window_from_coordinates (f,
1127 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1128 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1129 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1130 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1131 0, 0, 0, 0);
1134 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1135 doc: /* Return current value of point in WINDOW.
1136 WINDOW defaults to the selected window.
1138 For a nonselected window, this is the value point would have
1139 if that window were selected.
1141 Note that, when WINDOW is the selected window and its buffer
1142 is also currently selected, the value returned is the same as (point).
1143 It would be more strictly correct to return the `top-level' value
1144 of point, outside of any save-excursion forms.
1145 But that is hard to define. */)
1146 (window)
1147 Lisp_Object window;
1149 register struct window *w = decode_window (window);
1151 if (w == XWINDOW (selected_window)
1152 && current_buffer == XBUFFER (w->buffer))
1153 return Fpoint ();
1154 return Fmarker_position (w->pointm);
1157 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1158 doc: /* Return position at which display currently starts in WINDOW.
1159 WINDOW defaults to the selected window.
1160 This is updated by redisplay or by calling `set-window-start'. */)
1161 (window)
1162 Lisp_Object window;
1164 return Fmarker_position (decode_window (window)->start);
1167 /* This is text temporarily removed from the doc string below.
1169 This function returns nil if the position is not currently known.
1170 That happens when redisplay is preempted and doesn't finish.
1171 If in that case you want to compute where the end of the window would
1172 have been if redisplay had finished, do this:
1173 (save-excursion
1174 (goto-char (window-start window))
1175 (vertical-motion (1- (window-height window)) window)
1176 (point))") */
1178 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1179 doc: /* Return position at which display currently ends in WINDOW.
1180 WINDOW defaults to the selected window.
1181 This is updated by redisplay, when it runs to completion.
1182 Simply changing the buffer text or setting `window-start'
1183 does not update this value.
1184 Return nil if there is no recorded value. \(This can happen if the
1185 last redisplay of WINDOW was preempted, and did not finish.)
1186 If UPDATE is non-nil, compute the up-to-date position
1187 if it isn't already recorded. */)
1188 (window, update)
1189 Lisp_Object window, update;
1191 Lisp_Object value;
1192 struct window *w = decode_window (window);
1193 Lisp_Object buf;
1194 struct buffer *b;
1196 buf = w->buffer;
1197 CHECK_BUFFER (buf);
1198 b = XBUFFER (buf);
1200 #if 0 /* This change broke some things. We should make it later. */
1201 /* If we don't know the end position, return nil.
1202 The user can compute it with vertical-motion if he wants to.
1203 It would be nicer to do it automatically,
1204 but that's so slow that it would probably bother people. */
1205 if (NILP (w->window_end_valid))
1206 return Qnil;
1207 #endif
1209 if (! NILP (update)
1210 && ! (! NILP (w->window_end_valid)
1211 && XFASTINT (w->last_modified) >= BUF_MODIFF (b)
1212 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (b))
1213 && !noninteractive)
1215 struct text_pos startp;
1216 struct it it;
1217 struct buffer *old_buffer = NULL;
1219 /* Cannot use Fvertical_motion because that function doesn't
1220 cope with variable-height lines. */
1221 if (b != current_buffer)
1223 old_buffer = current_buffer;
1224 set_buffer_internal (b);
1227 /* In case W->start is out of the range, use something
1228 reasonable. This situation occurred when loading a file with
1229 `-l' containing a call to `rmail' with subsequent other
1230 commands. At the end, W->start happened to be BEG, while
1231 rmail had already narrowed the buffer. */
1232 if (XMARKER (w->start)->charpos < BEGV)
1233 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1234 else if (XMARKER (w->start)->charpos > ZV)
1235 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1236 else
1237 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1239 start_display (&it, w, startp);
1240 move_it_vertically (&it, window_box_height (w));
1241 if (it.current_y < it.last_visible_y)
1242 move_it_past_eol (&it);
1243 value = make_number (IT_CHARPOS (it));
1245 if (old_buffer)
1246 set_buffer_internal (old_buffer);
1248 else
1249 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1251 return value;
1254 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1255 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1256 Return POS. */)
1257 (window, pos)
1258 Lisp_Object window, pos;
1260 register struct window *w = decode_window (window);
1262 CHECK_NUMBER_COERCE_MARKER (pos);
1263 if (w == XWINDOW (selected_window)
1264 && XBUFFER (w->buffer) == current_buffer)
1265 Fgoto_char (pos);
1266 else
1267 set_marker_restricted (w->pointm, pos, w->buffer);
1269 /* We have to make sure that redisplay updates the window to show
1270 the new value of point. */
1271 if (!EQ (window, selected_window))
1272 ++windows_or_buffers_changed;
1274 return pos;
1277 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1278 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1279 Return POS.
1280 Optional third arg NOFORCE non-nil inhibits next redisplay
1281 from overriding motion of point in order to display at this exact start. */)
1282 (window, pos, noforce)
1283 Lisp_Object window, pos, noforce;
1285 register struct window *w = decode_window (window);
1287 CHECK_NUMBER_COERCE_MARKER (pos);
1288 set_marker_restricted (w->start, pos, w->buffer);
1289 /* this is not right, but much easier than doing what is right. */
1290 w->start_at_line_beg = Qnil;
1291 if (NILP (noforce))
1292 w->force_start = Qt;
1293 w->update_mode_line = Qt;
1294 XSETFASTINT (w->last_modified, 0);
1295 XSETFASTINT (w->last_overlay_modified, 0);
1296 if (!EQ (window, selected_window))
1297 windows_or_buffers_changed++;
1299 return pos;
1302 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1303 1, 1, 0,
1304 doc: /* Return WINDOW's dedicated object, usually t or nil.
1305 See also `set-window-dedicated-p'. */)
1306 (window)
1307 Lisp_Object window;
1309 return decode_window (window)->dedicated;
1312 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1313 Sset_window_dedicated_p, 2, 2, 0,
1314 doc: /* Control whether WINDOW is dedicated to the buffer it displays.
1315 If it is dedicated, Emacs will not automatically change
1316 which buffer appears in it.
1317 The second argument is the new value for the dedication flag;
1318 non-nil means yes. */)
1319 (window, arg)
1320 Lisp_Object window, arg;
1322 register struct window *w = decode_window (window);
1324 w->dedicated = arg;
1326 return w->dedicated;
1329 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1330 0, 1, 0,
1331 doc: /* Return the display-table that WINDOW is using.
1332 WINDOW defaults to the selected window. */)
1333 (window)
1334 Lisp_Object window;
1336 return decode_window (window)->display_table;
1339 /* Get the display table for use on window W. This is either W's
1340 display table or W's buffer's display table. Ignore the specified
1341 tables if they are not valid; if no valid table is specified,
1342 return 0. */
1344 struct Lisp_Char_Table *
1345 window_display_table (w)
1346 struct window *w;
1348 struct Lisp_Char_Table *dp = NULL;
1350 if (DISP_TABLE_P (w->display_table))
1351 dp = XCHAR_TABLE (w->display_table);
1352 else if (BUFFERP (w->buffer))
1354 struct buffer *b = XBUFFER (w->buffer);
1356 if (DISP_TABLE_P (b->display_table))
1357 dp = XCHAR_TABLE (b->display_table);
1358 else if (DISP_TABLE_P (Vstandard_display_table))
1359 dp = XCHAR_TABLE (Vstandard_display_table);
1362 return dp;
1365 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1366 doc: /* Set WINDOW's display-table to TABLE. */)
1367 (window, table)
1368 register Lisp_Object window, table;
1370 register struct window *w;
1372 w = decode_window (window);
1373 w->display_table = table;
1374 return table;
1377 /* Record info on buffer window w is displaying
1378 when it is about to cease to display that buffer. */
1379 static void
1380 unshow_buffer (w)
1381 register struct window *w;
1383 Lisp_Object buf;
1384 struct buffer *b;
1386 buf = w->buffer;
1387 b = XBUFFER (buf);
1388 if (b != XMARKER (w->pointm)->buffer)
1389 abort ();
1391 #if 0
1392 if (w == XWINDOW (selected_window)
1393 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1394 /* Do this except when the selected window's buffer
1395 is being removed from some other window. */
1396 #endif
1397 /* last_window_start records the start position that this buffer
1398 had in the last window to be disconnected from it.
1399 Now that this statement is unconditional,
1400 it is possible for the buffer to be displayed in the
1401 selected window, while last_window_start reflects another
1402 window which was recently showing the same buffer.
1403 Some people might say that might be a good thing. Let's see. */
1404 b->last_window_start = marker_position (w->start);
1406 /* Point in the selected window's buffer
1407 is actually stored in that buffer, and the window's pointm isn't used.
1408 So don't clobber point in that buffer. */
1409 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1410 /* This line helps to fix Horsley's testbug.el bug. */
1411 && !(WINDOWP (b->last_selected_window)
1412 && w != XWINDOW (b->last_selected_window)
1413 && EQ (buf, XWINDOW (b->last_selected_window)->buffer)))
1414 temp_set_point_both (b,
1415 clip_to_bounds (BUF_BEGV (b),
1416 XMARKER (w->pointm)->charpos,
1417 BUF_ZV (b)),
1418 clip_to_bounds (BUF_BEGV_BYTE (b),
1419 marker_byte_position (w->pointm),
1420 BUF_ZV_BYTE (b)));
1422 if (WINDOWP (b->last_selected_window)
1423 && w == XWINDOW (b->last_selected_window))
1424 b->last_selected_window = Qnil;
1427 /* Put replacement into the window structure in place of old. */
1428 static void
1429 replace_window (old, replacement)
1430 Lisp_Object old, replacement;
1432 register Lisp_Object tem;
1433 register struct window *o = XWINDOW (old), *p = XWINDOW (replacement);
1435 /* If OLD is its frame's root_window, then replacement is the new
1436 root_window for that frame. */
1438 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1439 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
1441 p->left_col = o->left_col;
1442 p->top_line = o->top_line;
1443 p->total_cols = o->total_cols;
1444 p->total_lines = o->total_lines;
1445 p->desired_matrix = p->current_matrix = 0;
1446 p->vscroll = 0;
1447 bzero (&p->cursor, sizeof (p->cursor));
1448 bzero (&p->last_cursor, sizeof (p->last_cursor));
1449 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
1450 p->phys_cursor_type = -1;
1451 p->phys_cursor_width = -1;
1452 p->must_be_updated_p = 0;
1453 p->pseudo_window_p = 0;
1454 XSETFASTINT (p->window_end_vpos, 0);
1455 XSETFASTINT (p->window_end_pos, 0);
1456 p->window_end_valid = Qnil;
1457 p->frozen_window_start_p = 0;
1458 p->orig_top_line = p->orig_total_lines = Qnil;
1460 p->next = tem = o->next;
1461 if (!NILP (tem))
1462 XWINDOW (tem)->prev = replacement;
1464 p->prev = tem = o->prev;
1465 if (!NILP (tem))
1466 XWINDOW (tem)->next = replacement;
1468 p->parent = tem = o->parent;
1469 if (!NILP (tem))
1471 if (EQ (XWINDOW (tem)->vchild, old))
1472 XWINDOW (tem)->vchild = replacement;
1473 if (EQ (XWINDOW (tem)->hchild, old))
1474 XWINDOW (tem)->hchild = replacement;
1477 /*** Here, if replacement is a vertical combination
1478 and so is its new parent, we should make replacement's
1479 children be children of that parent instead. ***/
1482 DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
1483 doc: /* Remove WINDOW from the display. Default is selected window. */)
1484 (window)
1485 register Lisp_Object window;
1487 struct frame *f;
1488 if (NILP (window))
1489 window = selected_window;
1490 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1491 delete_window (window);
1493 run_window_configuration_change_hook (f);
1495 return Qnil;
1498 void
1499 delete_window (window)
1500 register Lisp_Object window;
1502 register Lisp_Object tem, parent, sib;
1503 register struct window *p;
1504 register struct window *par;
1505 struct frame *f;
1507 /* Because this function is called by other C code on non-leaf
1508 windows, the CHECK_LIVE_WINDOW macro would choke inappropriately,
1509 so we can't decode_window here. */
1510 CHECK_WINDOW (window);
1511 p = XWINDOW (window);
1513 /* It's a no-op to delete an already-deleted window. */
1514 if (NILP (p->buffer)
1515 && NILP (p->hchild)
1516 && NILP (p->vchild))
1517 return;
1519 parent = p->parent;
1520 if (NILP (parent))
1521 error ("Attempt to delete minibuffer or sole ordinary window");
1522 par = XWINDOW (parent);
1524 windows_or_buffers_changed++;
1525 Vwindow_list = Qnil;
1526 f = XFRAME (WINDOW_FRAME (p));
1527 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
1529 /* Are we trying to delete any frame's selected window? */
1531 Lisp_Object swindow, pwindow;
1533 /* See if the frame's selected window is either WINDOW
1534 or any subwindow of it, by finding all that window's parents
1535 and comparing each one with WINDOW. */
1536 swindow = FRAME_SELECTED_WINDOW (f);
1538 while (1)
1540 pwindow = swindow;
1541 while (!NILP (pwindow))
1543 if (EQ (window, pwindow))
1544 break;
1545 pwindow = XWINDOW (pwindow)->parent;
1548 /* If the window being deleted is not a parent of SWINDOW,
1549 then SWINDOW is ok as the new selected window. */
1550 if (!EQ (window, pwindow))
1551 break;
1552 /* Otherwise, try another window for SWINDOW. */
1553 swindow = Fnext_window (swindow, Qlambda, Qnil);
1555 /* If we get back to the frame's selected window,
1556 it means there was no acceptable alternative,
1557 so we cannot delete. */
1558 if (EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1559 error ("Cannot delete window");
1562 /* If we need to change SWINDOW, do it. */
1563 if (! EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1565 /* If we're about to delete the selected window on the
1566 selected frame, then we should use Fselect_window to select
1567 the new window. On the other hand, if we're about to
1568 delete the selected window on any other frame, we shouldn't do
1569 anything but set the frame's selected_window slot. */
1570 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
1571 Fselect_window (swindow, Qnil);
1572 else
1573 FRAME_SELECTED_WINDOW (f) = swindow;
1577 /* Now we know we can delete this one. */
1578 window_deletion_count++;
1580 tem = p->buffer;
1581 /* tem is null for dummy parent windows
1582 (which have inferiors but not any contents themselves) */
1583 if (!NILP (tem))
1585 unshow_buffer (p);
1586 unchain_marker (XMARKER (p->pointm));
1587 unchain_marker (XMARKER (p->start));
1590 /* Free window glyph matrices. It is sure that they are allocated
1591 again when ADJUST_GLYPHS is called. Block input so that expose
1592 events and other events that access glyph matrices are not
1593 processed while we are changing them. */
1594 BLOCK_INPUT;
1595 free_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)));
1597 tem = p->next;
1598 if (!NILP (tem))
1599 XWINDOW (tem)->prev = p->prev;
1601 tem = p->prev;
1602 if (!NILP (tem))
1603 XWINDOW (tem)->next = p->next;
1605 if (EQ (window, par->hchild))
1606 par->hchild = p->next;
1607 if (EQ (window, par->vchild))
1608 par->vchild = p->next;
1610 /* Find one of our siblings to give our space to. */
1611 sib = p->prev;
1612 if (NILP (sib))
1614 /* If p gives its space to its next sibling, that sibling needs
1615 to have its top/left side pulled back to where p's is.
1616 set_window_{height,width} will re-position the sibling's
1617 children. */
1618 sib = p->next;
1619 XWINDOW (sib)->top_line = p->top_line;
1620 XWINDOW (sib)->left_col = p->left_col;
1623 /* Stretch that sibling. */
1624 if (!NILP (par->vchild))
1625 set_window_height (sib,
1626 XFASTINT (XWINDOW (sib)->total_lines) + XFASTINT (p->total_lines),
1628 if (!NILP (par->hchild))
1629 set_window_width (sib,
1630 XFASTINT (XWINDOW (sib)->total_cols) + XFASTINT (p->total_cols),
1633 /* If parent now has only one child,
1634 put the child into the parent's place. */
1635 tem = par->hchild;
1636 if (NILP (tem))
1637 tem = par->vchild;
1638 if (NILP (XWINDOW (tem)->next)) {
1639 replace_window (parent, tem);
1640 par = XWINDOW (tem);
1643 /* Since we may be deleting combination windows, we must make sure that
1644 not only p but all its children have been marked as deleted. */
1645 if (! NILP (p->hchild))
1646 delete_all_subwindows (XWINDOW (p->hchild));
1647 else if (! NILP (p->vchild))
1648 delete_all_subwindows (XWINDOW (p->vchild));
1650 /* Mark this window as deleted. */
1651 p->buffer = p->hchild = p->vchild = Qnil;
1653 if (! NILP (par->parent))
1654 par = XWINDOW (par->parent);
1656 /* Check if we have a v/hchild with a v/hchild. In that case remove
1657 one of them. */
1659 if (! NILP (par->vchild) && ! NILP (XWINDOW (par->vchild)->vchild))
1661 p = XWINDOW (par->vchild);
1662 par->vchild = p->vchild;
1663 tem = p->vchild;
1665 else if (! NILP (par->hchild) && ! NILP (XWINDOW (par->hchild)->hchild))
1667 p = XWINDOW (par->hchild);
1668 par->hchild = p->hchild;
1669 tem = p->hchild;
1671 else
1672 p = 0;
1674 if (p)
1676 while (! NILP (tem)) {
1677 XWINDOW (tem)->parent = p->parent;
1678 if (NILP (XWINDOW (tem)->next))
1679 break;
1680 tem = XWINDOW (tem)->next;
1682 if (! NILP (tem)) {
1683 /* The next of the v/hchild we are removing is now the next of the
1684 last child for the v/hchild:
1685 Before v/hchild -> v/hchild -> next1 -> next2
1687 -> next3
1688 After: v/hchild -> next1 -> next2 -> next3
1690 XWINDOW (tem)->next = p->next;
1691 if (! NILP (p->next))
1692 XWINDOW (p->next)->prev = tem;
1694 p->next = p->prev = p->vchild = p->hchild = p->buffer = Qnil;
1698 /* Adjust glyph matrices. */
1699 adjust_glyphs (f);
1700 UNBLOCK_INPUT;
1705 /***********************************************************************
1706 Window List
1707 ***********************************************************************/
1709 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1710 pointer. This is a callback function for foreach_window, used in
1711 function window_list. */
1713 static int
1714 add_window_to_list (w, user_data)
1715 struct window *w;
1716 void *user_data;
1718 Lisp_Object *list = (Lisp_Object *) user_data;
1719 Lisp_Object window;
1720 XSETWINDOW (window, w);
1721 *list = Fcons (window, *list);
1722 return 1;
1726 /* Return a list of all windows, for use by next_window. If
1727 Vwindow_list is a list, return that list. Otherwise, build a new
1728 list, cache it in Vwindow_list, and return that. */
1730 static Lisp_Object
1731 window_list ()
1733 if (!CONSP (Vwindow_list))
1735 Lisp_Object tail;
1737 Vwindow_list = Qnil;
1738 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1740 Lisp_Object args[2];
1742 /* We are visiting windows in canonical order, and add
1743 new windows at the front of args[1], which means we
1744 have to reverse this list at the end. */
1745 args[1] = Qnil;
1746 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1747 args[0] = Vwindow_list;
1748 args[1] = Fnreverse (args[1]);
1749 Vwindow_list = Fnconc (2, args);
1753 return Vwindow_list;
1757 /* Value is non-zero if WINDOW satisfies the constraints given by
1758 OWINDOW, MINIBUF and ALL_FRAMES.
1760 MINIBUF t means WINDOW may be minibuffer windows.
1761 `lambda' means WINDOW may not be a minibuffer window.
1762 a window means a specific minibuffer window
1764 ALL_FRAMES t means search all frames,
1765 nil means search just current frame,
1766 `visible' means search just visible frames,
1767 0 means search visible and iconified frames,
1768 a window means search the frame that window belongs to,
1769 a frame means consider windows on that frame, only. */
1771 static int
1772 candidate_window_p (window, owindow, minibuf, all_frames)
1773 Lisp_Object window, owindow, minibuf, all_frames;
1775 struct window *w = XWINDOW (window);
1776 struct frame *f = XFRAME (w->frame);
1777 int candidate_p = 1;
1779 if (!BUFFERP (w->buffer))
1780 candidate_p = 0;
1781 else if (MINI_WINDOW_P (w)
1782 && (EQ (minibuf, Qlambda)
1783 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
1785 /* If MINIBUF is `lambda' don't consider any mini-windows.
1786 If it is a window, consider only that one. */
1787 candidate_p = 0;
1789 else if (EQ (all_frames, Qt))
1790 candidate_p = 1;
1791 else if (NILP (all_frames))
1793 xassert (WINDOWP (owindow));
1794 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
1796 else if (EQ (all_frames, Qvisible))
1798 FRAME_SAMPLE_VISIBILITY (f);
1799 candidate_p = FRAME_VISIBLE_P (f)
1800 && (FRAME_TERMINAL (XFRAME (w->frame))
1801 == FRAME_TERMINAL (XFRAME (selected_frame)));
1804 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
1806 FRAME_SAMPLE_VISIBILITY (f);
1807 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
1808 #ifdef HAVE_X_WINDOWS
1809 /* Yuck!! If we've just created the frame and the
1810 window-manager requested the user to place it
1811 manually, the window may still not be considered
1812 `visible'. I'd argue it should be at least
1813 something like `iconified', but don't know how to do
1814 that yet. --Stef */
1815 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
1816 && !f->output_data.x->has_been_visible)
1817 #endif
1819 && (FRAME_TERMINAL (XFRAME (w->frame))
1820 == FRAME_TERMINAL (XFRAME (selected_frame)));
1822 else if (WINDOWP (all_frames))
1823 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
1824 || EQ (XWINDOW (all_frames)->frame, w->frame)
1825 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
1826 else if (FRAMEP (all_frames))
1827 candidate_p = EQ (all_frames, w->frame);
1829 return candidate_p;
1833 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
1834 Fwindow_list. See there for the meaning of WINDOW, MINIBUF, and
1835 ALL_FRAMES. */
1837 static void
1838 decode_next_window_args (window, minibuf, all_frames)
1839 Lisp_Object *window, *minibuf, *all_frames;
1841 if (NILP (*window))
1842 *window = selected_window;
1843 else
1844 CHECK_LIVE_WINDOW (*window);
1846 /* MINIBUF nil may or may not include minibuffers. Decide if it
1847 does. */
1848 if (NILP (*minibuf))
1849 *minibuf = minibuf_level ? minibuf_window : Qlambda;
1850 else if (!EQ (*minibuf, Qt))
1851 *minibuf = Qlambda;
1853 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
1854 => count none of them, or a specific minibuffer window (the
1855 active one) to count. */
1857 /* ALL_FRAMES nil doesn't specify which frames to include. */
1858 if (NILP (*all_frames))
1859 *all_frames = (!EQ (*minibuf, Qlambda)
1860 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
1861 : Qnil);
1862 else if (EQ (*all_frames, Qvisible))
1864 else if (EQ (*all_frames, make_number (0)))
1866 else if (FRAMEP (*all_frames))
1868 else if (!EQ (*all_frames, Qt))
1869 *all_frames = Qnil;
1871 /* Now *ALL_FRAMES is t meaning search all frames, nil meaning
1872 search just current frame, `visible' meaning search just visible
1873 frames, 0 meaning search visible and iconified frames, or a
1874 window, meaning search the frame that window belongs to, or a
1875 frame, meaning consider windows on that frame, only. */
1879 /* Return the next or previous window of WINDOW in canonical ordering
1880 of windows. NEXT_P non-zero means return the next window. See the
1881 documentation string of next-window for the meaning of MINIBUF and
1882 ALL_FRAMES. */
1884 static Lisp_Object
1885 next_window (window, minibuf, all_frames, next_p)
1886 Lisp_Object window, minibuf, all_frames;
1887 int next_p;
1889 decode_next_window_args (&window, &minibuf, &all_frames);
1891 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
1892 return the first window on the frame. */
1893 if (FRAMEP (all_frames)
1894 && !EQ (all_frames, XWINDOW (window)->frame))
1895 return Fframe_first_window (all_frames);
1897 if (next_p)
1899 Lisp_Object list;
1901 /* Find WINDOW in the list of all windows. */
1902 list = Fmemq (window, window_list ());
1904 /* Scan forward from WINDOW to the end of the window list. */
1905 if (CONSP (list))
1906 for (list = XCDR (list); CONSP (list); list = XCDR (list))
1907 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1908 break;
1910 /* Scan from the start of the window list up to WINDOW. */
1911 if (!CONSP (list))
1912 for (list = Vwindow_list;
1913 CONSP (list) && !EQ (XCAR (list), window);
1914 list = XCDR (list))
1915 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1916 break;
1918 if (CONSP (list))
1919 window = XCAR (list);
1921 else
1923 Lisp_Object candidate, list;
1925 /* Scan through the list of windows for candidates. If there are
1926 candidate windows in front of WINDOW, the last one of these
1927 is the one we want. If there are candidates following WINDOW
1928 in the list, again the last one of these is the one we want. */
1929 candidate = Qnil;
1930 for (list = window_list (); CONSP (list); list = XCDR (list))
1932 if (EQ (XCAR (list), window))
1934 if (WINDOWP (candidate))
1935 break;
1937 else if (candidate_window_p (XCAR (list), window, minibuf,
1938 all_frames))
1939 candidate = XCAR (list);
1942 if (WINDOWP (candidate))
1943 window = candidate;
1946 return window;
1950 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
1951 doc: /* Return next window after WINDOW in canonical ordering of windows.
1952 If omitted, WINDOW defaults to the selected window.
1954 Optional second arg MINIBUF t means count the minibuffer window even
1955 if not active. MINIBUF nil or omitted means count the minibuffer iff
1956 it is active. MINIBUF neither t nor nil means not to count the
1957 minibuffer even if it is active.
1959 Several frames may share a single minibuffer; if the minibuffer
1960 counts, all windows on all frames that share that minibuffer count
1961 too. Therefore, `next-window' can be used to iterate through the
1962 set of windows even when the minibuffer is on another frame. If the
1963 minibuffer does not count, only windows from WINDOW's frame count.
1965 Optional third arg ALL-FRAMES t means include windows on all frames.
1966 ALL-FRAMES nil or omitted means cycle within the frames as specified
1967 above. ALL-FRAMES = `visible' means include windows on all visible frames.
1968 ALL-FRAMES = 0 means include windows on all visible and iconified frames.
1969 If ALL-FRAMES is a frame, restrict search to windows on that frame.
1970 Anything else means restrict to WINDOW's frame.
1972 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
1973 `next-window' to iterate through the entire cycle of acceptable
1974 windows, eventually ending up back at the window you started with.
1975 `previous-window' traverses the same cycle, in the reverse order. */)
1976 (window, minibuf, all_frames)
1977 Lisp_Object window, minibuf, all_frames;
1979 return next_window (window, minibuf, all_frames, 1);
1983 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
1984 doc: /* Return the window preceding WINDOW in canonical ordering of windows.
1985 If omitted, WINDOW defaults to the selected window.
1987 Optional second arg MINIBUF t means count the minibuffer window even
1988 if not active. MINIBUF nil or omitted means count the minibuffer iff
1989 it is active. MINIBUF neither t nor nil means not to count the
1990 minibuffer even if it is active.
1992 Several frames may share a single minibuffer; if the minibuffer
1993 counts, all windows on all frames that share that minibuffer count
1994 too. Therefore, `previous-window' can be used to iterate through
1995 the set of windows even when the minibuffer is on another frame. If
1996 the minibuffer does not count, only windows from WINDOW's frame count
1998 Optional third arg ALL-FRAMES t means include windows on all frames.
1999 ALL-FRAMES nil or omitted means cycle within the frames as specified
2000 above. ALL-FRAMES = `visible' means include windows on all visible frames.
2001 ALL-FRAMES = 0 means include windows on all visible and iconified frames.
2002 If ALL-FRAMES is a frame, restrict search to windows on that frame.
2003 Anything else means restrict to WINDOW's frame.
2005 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2006 `previous-window' to iterate through the entire cycle of acceptable
2007 windows, eventually ending up back at the window you started with.
2008 `next-window' traverses the same cycle, in the reverse order. */)
2009 (window, minibuf, all_frames)
2010 Lisp_Object window, minibuf, all_frames;
2012 return next_window (window, minibuf, all_frames, 0);
2016 DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
2017 doc: /* Select the ARG'th different window on this frame.
2018 All windows on current frame are arranged in a cyclic order.
2019 This command selects the window ARG steps away in that order.
2020 A negative ARG moves in the opposite order. The optional second
2021 argument ALL-FRAMES has the same meaning as in `next-window', which see. */)
2022 (arg, all_frames)
2023 Lisp_Object arg, all_frames;
2025 Lisp_Object window;
2026 int i;
2028 CHECK_NUMBER (arg);
2029 window = selected_window;
2031 for (i = XINT (arg); i > 0; --i)
2032 window = Fnext_window (window, Qnil, all_frames);
2033 for (; i < 0; ++i)
2034 window = Fprevious_window (window, Qnil, all_frames);
2036 Fselect_window (window, Qnil);
2037 return Qnil;
2041 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2042 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2043 FRAME nil or omitted means use the selected frame.
2044 WINDOW nil or omitted means use the selected window.
2045 MINIBUF t means include the minibuffer window, even if it isn't active.
2046 MINIBUF nil or omitted means include the minibuffer window only
2047 if it's active.
2048 MINIBUF neither nil nor t means never include the minibuffer window. */)
2049 (frame, minibuf, window)
2050 Lisp_Object frame, minibuf, window;
2052 if (NILP (window))
2053 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2054 CHECK_WINDOW (window);
2055 if (NILP (frame))
2056 frame = selected_frame;
2058 if (!EQ (frame, XWINDOW (window)->frame))
2059 error ("Window is on a different frame");
2061 return window_list_1 (window, minibuf, frame);
2065 /* Return a list of windows in canonical ordering. Arguments are like
2066 for `next-window'. */
2068 static Lisp_Object
2069 window_list_1 (window, minibuf, all_frames)
2070 Lisp_Object window, minibuf, all_frames;
2072 Lisp_Object tail, list, rest;
2074 decode_next_window_args (&window, &minibuf, &all_frames);
2075 list = Qnil;
2077 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2078 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2079 list = Fcons (XCAR (tail), list);
2081 /* Rotate the list to start with WINDOW. */
2082 list = Fnreverse (list);
2083 rest = Fmemq (window, list);
2084 if (!NILP (rest) && !EQ (rest, list))
2086 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2088 XSETCDR (tail, Qnil);
2089 list = nconc2 (rest, list);
2091 return list;
2096 /* Look at all windows, performing an operation specified by TYPE
2097 with argument OBJ.
2098 If FRAMES is Qt, look at all frames;
2099 Qnil, look at just the selected frame;
2100 Qvisible, look at visible frames;
2101 a frame, just look at windows on that frame.
2102 If MINI is non-zero, perform the operation on minibuffer windows too. */
2104 enum window_loop
2106 WINDOW_LOOP_UNUSED,
2107 GET_BUFFER_WINDOW, /* Arg is buffer */
2108 GET_LRU_WINDOW, /* Arg is t for full-width windows only */
2109 DELETE_OTHER_WINDOWS, /* Arg is window not to delete */
2110 DELETE_BUFFER_WINDOWS, /* Arg is buffer */
2111 GET_LARGEST_WINDOW,
2112 UNSHOW_BUFFER, /* Arg is buffer */
2113 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2114 CHECK_ALL_WINDOWS
2117 static Lisp_Object
2118 window_loop (type, obj, mini, frames)
2119 enum window_loop type;
2120 Lisp_Object obj, frames;
2121 int mini;
2123 Lisp_Object window, windows, best_window, frame_arg;
2124 struct frame *f;
2125 struct gcpro gcpro1;
2127 /* If we're only looping through windows on a particular frame,
2128 frame points to that frame. If we're looping through windows
2129 on all frames, frame is 0. */
2130 if (FRAMEP (frames))
2131 f = XFRAME (frames);
2132 else if (NILP (frames))
2133 f = SELECTED_FRAME ();
2134 else
2135 f = NULL;
2137 if (f)
2138 frame_arg = Qlambda;
2139 else if (EQ (frames, make_number (0)))
2140 frame_arg = frames;
2141 else if (EQ (frames, Qvisible))
2142 frame_arg = frames;
2143 else
2144 frame_arg = Qt;
2146 /* frame_arg is Qlambda to stick to one frame,
2147 Qvisible to consider all visible frames,
2148 or Qt otherwise. */
2150 /* Pick a window to start with. */
2151 if (WINDOWP (obj))
2152 window = obj;
2153 else if (f)
2154 window = FRAME_SELECTED_WINDOW (f);
2155 else
2156 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2158 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2159 GCPRO1 (windows);
2160 best_window = Qnil;
2162 for (; CONSP (windows); windows = XCDR (windows))
2164 struct window *w;
2166 window = XCAR (windows);
2167 w = XWINDOW (window);
2169 /* Note that we do not pay attention here to whether the frame
2170 is visible, since Fwindow_list skips non-visible frames if
2171 that is desired, under the control of frame_arg. */
2172 if (!MINI_WINDOW_P (w)
2173 /* For UNSHOW_BUFFER, we must always consider all windows. */
2174 || type == UNSHOW_BUFFER
2175 || (mini && minibuf_level > 0))
2176 switch (type)
2178 case GET_BUFFER_WINDOW:
2179 if (EQ (w->buffer, obj)
2180 /* Don't find any minibuffer window
2181 except the one that is currently in use. */
2182 && (MINI_WINDOW_P (w)
2183 ? EQ (window, minibuf_window)
2184 : 1))
2186 if (NILP (best_window))
2187 best_window = window;
2188 else if (EQ (window, selected_window))
2189 /* Prefer to return selected-window. */
2190 RETURN_UNGCPRO (window);
2191 else if (EQ (Fwindow_frame (window), selected_frame))
2192 /* Prefer windows on the current frame. */
2193 best_window = window;
2195 break;
2197 case GET_LRU_WINDOW:
2198 /* `obj' is an integer encoding a bitvector.
2199 `obj & 1' means consider only full-width windows.
2200 `obj & 2' means consider also dedicated windows. */
2201 if (((XINT (obj) & 1) && !WINDOW_FULL_WIDTH_P (w))
2202 || (!(XINT (obj) & 2) && !NILP (w->dedicated))
2203 /* Minibuffer windows are always ignored. */
2204 || MINI_WINDOW_P (w))
2205 break;
2206 if (NILP (best_window)
2207 || (XFASTINT (XWINDOW (best_window)->use_time)
2208 > XFASTINT (w->use_time)))
2209 best_window = window;
2210 break;
2212 case DELETE_OTHER_WINDOWS:
2213 if (!EQ (window, obj))
2214 Fdelete_window (window);
2215 break;
2217 case DELETE_BUFFER_WINDOWS:
2218 if (EQ (w->buffer, obj))
2220 struct frame *f = XFRAME (WINDOW_FRAME (w));
2222 /* If this window is dedicated, and in a frame of its own,
2223 kill the frame. */
2224 if (EQ (window, FRAME_ROOT_WINDOW (f))
2225 && !NILP (w->dedicated)
2226 && other_visible_frames (f))
2228 /* Skip the other windows on this frame.
2229 There might be one, the minibuffer! */
2230 while (CONSP (XCDR (windows))
2231 && EQ (XWINDOW (XCAR (windows))->frame,
2232 XWINDOW (XCAR (XCDR (windows)))->frame))
2233 windows = XCDR (windows);
2235 /* Now we can safely delete the frame. */
2236 Fdelete_frame (w->frame, Qnil);
2238 else if (NILP (w->parent))
2240 /* If we're deleting the buffer displayed in the
2241 only window on the frame, find a new buffer to
2242 display there. */
2243 Lisp_Object buffer;
2244 buffer = Fother_buffer (obj, Qnil, w->frame);
2245 Fset_window_buffer (window, buffer, Qnil);
2246 if (EQ (window, selected_window))
2247 Fset_buffer (w->buffer);
2249 else
2250 Fdelete_window (window);
2252 break;
2254 case GET_LARGEST_WINDOW:
2255 { /* nil `obj' means to ignore dedicated windows. */
2256 /* Ignore dedicated windows and minibuffers. */
2257 if (MINI_WINDOW_P (w) || (NILP (obj) && !NILP (w->dedicated)))
2258 break;
2260 if (NILP (best_window))
2261 best_window = window;
2262 else
2264 struct window *b = XWINDOW (best_window);
2265 if (XFASTINT (w->total_lines) * XFASTINT (w->total_cols)
2266 > XFASTINT (b->total_lines) * XFASTINT (b->total_cols))
2267 best_window = window;
2270 break;
2272 case UNSHOW_BUFFER:
2273 if (EQ (w->buffer, obj))
2275 Lisp_Object buffer;
2276 struct frame *f = XFRAME (w->frame);
2278 /* Find another buffer to show in this window. */
2279 buffer = Fother_buffer (obj, Qnil, w->frame);
2281 /* If this window is dedicated, and in a frame of its own,
2282 kill the frame. */
2283 if (EQ (window, FRAME_ROOT_WINDOW (f))
2284 && !NILP (w->dedicated)
2285 && other_visible_frames (f))
2287 /* Skip the other windows on this frame.
2288 There might be one, the minibuffer! */
2289 while (CONSP (XCDR (windows))
2290 && EQ (XWINDOW (XCAR (windows))->frame,
2291 XWINDOW (XCAR (XCDR (windows)))->frame))
2292 windows = XCDR (windows);
2294 /* Now we can safely delete the frame. */
2295 Fdelete_frame (w->frame, Qnil);
2297 else if (!NILP (w->dedicated) && !NILP (w->parent))
2299 Lisp_Object window;
2300 XSETWINDOW (window, w);
2301 /* If this window is dedicated and not the only window
2302 in its frame, then kill it. */
2303 Fdelete_window (window);
2305 else
2307 /* Otherwise show a different buffer in the window. */
2308 w->dedicated = Qnil;
2309 Fset_window_buffer (window, buffer, Qnil);
2310 if (EQ (window, selected_window))
2311 Fset_buffer (w->buffer);
2314 break;
2316 case REDISPLAY_BUFFER_WINDOWS:
2317 if (EQ (w->buffer, obj))
2319 mark_window_display_accurate (window, 0);
2320 w->update_mode_line = Qt;
2321 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2322 ++update_mode_lines;
2323 best_window = window;
2325 break;
2327 /* Check for a window that has a killed buffer. */
2328 case CHECK_ALL_WINDOWS:
2329 if (! NILP (w->buffer)
2330 && NILP (XBUFFER (w->buffer)->name))
2331 abort ();
2332 break;
2334 case WINDOW_LOOP_UNUSED:
2335 break;
2339 UNGCPRO;
2340 return best_window;
2343 /* Used for debugging. Abort if any window has a dead buffer. */
2345 void
2346 check_all_windows ()
2348 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2351 DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 2, 0,
2352 doc: /* Return the window least recently selected or used for display.
2353 \(LRU means Least Recently Used.)
2355 Return a full-width window if possible.
2356 A minibuffer window is never a candidate.
2357 A dedicated window is never a candidate, unless DEDICATED is non-nil,
2358 so if all windows are dedicated, the value is nil.
2359 If optional argument FRAME is `visible', search all visible frames.
2360 If FRAME is 0, search all visible and iconified frames.
2361 If FRAME is t, search all frames.
2362 If FRAME is nil, search only the selected frame.
2363 If FRAME is a frame, search only that frame. */)
2364 (frame, dedicated)
2365 Lisp_Object frame, dedicated;
2367 register Lisp_Object w;
2368 /* First try for a window that is full-width */
2369 w = window_loop (GET_LRU_WINDOW,
2370 NILP (dedicated) ? make_number (1) : make_number (3),
2371 0, frame);
2372 if (!NILP (w) && !EQ (w, selected_window))
2373 return w;
2374 /* If none of them, try the rest */
2375 return window_loop (GET_LRU_WINDOW,
2376 NILP (dedicated) ? make_number (0) : make_number (2),
2377 0, frame);
2380 DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 2, 0,
2381 doc: /* Return the largest window in area.
2382 A minibuffer window is never a candidate.
2383 A dedicated window is never a candidate unless DEDICATED is non-nil,
2384 so if all windows are dedicated, the value is nil.
2385 If optional argument FRAME is `visible', search all visible frames.
2386 If FRAME is 0, search all visible and iconified frames.
2387 If FRAME is t, search all frames.
2388 If FRAME is nil, search only the selected frame.
2389 If FRAME is a frame, search only that frame. */)
2390 (frame, dedicated)
2391 Lisp_Object frame, dedicated;
2393 return window_loop (GET_LARGEST_WINDOW, dedicated, 0,
2394 frame);
2397 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 1, 2, 0,
2398 doc: /* Return a window currently displaying BUFFER, or nil if none.
2399 BUFFER can be a buffer or a buffer name.
2400 If optional argument FRAME is `visible', search all visible frames.
2401 If optional argument FRAME is 0, search all visible and iconified frames.
2402 If FRAME is t, search all frames.
2403 If FRAME is nil, search only the selected frame.
2404 If FRAME is a frame, search only that frame. */)
2405 (buffer, frame)
2406 Lisp_Object buffer, frame;
2408 buffer = Fget_buffer (buffer);
2409 if (BUFFERP (buffer))
2410 return window_loop (GET_BUFFER_WINDOW, buffer, 1, frame);
2411 else
2412 return Qnil;
2415 DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
2416 0, 1, "",
2417 doc: /* Make WINDOW (or the selected window) fill its frame.
2418 Only the frame WINDOW is on is affected.
2419 This function tries to reduce display jumps
2420 by keeping the text previously visible in WINDOW
2421 in the same place on the frame. Doing this depends on
2422 the value of (window-start WINDOW), so if calling this function
2423 in a program gives strange scrolling, make sure the window-start
2424 value is reasonable when this function is called. */)
2425 (window)
2426 Lisp_Object window;
2428 struct window *w;
2429 int startpos;
2430 int top, new_top;
2432 if (NILP (window))
2433 window = selected_window;
2434 else
2435 CHECK_LIVE_WINDOW (window);
2436 w = XWINDOW (window);
2438 startpos = marker_position (w->start);
2439 top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2441 if (MINI_WINDOW_P (w) && top > 0)
2442 error ("Can't expand minibuffer to full frame");
2444 window_loop (DELETE_OTHER_WINDOWS, window, 0, WINDOW_FRAME (w));
2446 /* Try to minimize scrolling, by setting the window start to the point
2447 will cause the text at the old window start to be at the same place
2448 on the frame. But don't try to do this if the window start is
2449 outside the visible portion (as might happen when the display is
2450 not current, due to typeahead). */
2451 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2452 if (new_top != top
2453 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2454 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2456 struct position pos;
2457 struct buffer *obuf = current_buffer;
2459 Fset_buffer (w->buffer);
2460 /* This computation used to temporarily move point, but that can
2461 have unwanted side effects due to text properties. */
2462 pos = *vmotion (startpos, -top, w);
2464 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2465 w->window_end_valid = Qnil;
2466 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2467 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2468 : Qnil);
2469 /* We need to do this, so that the window-scroll-functions
2470 get called. */
2471 w->optional_new_start = Qt;
2473 set_buffer_internal (obuf);
2476 return Qnil;
2479 DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
2480 1, 2, "bDelete windows on (buffer): ",
2481 doc: /* Delete all windows showing BUFFER.
2482 BUFFER must be a buffer or the name of an existing buffer.
2483 Optional second argument FRAME controls which frames are affected.
2484 If optional argument FRAME is `visible', search all visible frames.
2485 If FRAME is 0, search all visible and iconified frames.
2486 If FRAME is nil, search all frames.
2487 If FRAME is t, search only the selected frame.
2488 If FRAME is a frame, search only that frame. */)
2489 (buffer, frame)
2490 Lisp_Object buffer, frame;
2492 /* FRAME uses t and nil to mean the opposite of what window_loop
2493 expects. */
2494 if (NILP (frame))
2495 frame = Qt;
2496 else if (EQ (frame, Qt))
2497 frame = Qnil;
2499 if (!NILP (buffer))
2501 buffer = Fget_buffer (buffer);
2502 CHECK_BUFFER (buffer);
2503 window_loop (DELETE_BUFFER_WINDOWS, buffer, 0, frame);
2506 return Qnil;
2509 DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows,
2510 Sreplace_buffer_in_windows,
2511 1, 1, "bReplace buffer in windows: ",
2512 doc: /* Replace BUFFER with some other buffer in all windows showing it.
2513 BUFFER may be a buffer or the name of an existing buffer. */)
2514 (buffer)
2515 Lisp_Object buffer;
2517 if (!NILP (buffer))
2519 buffer = Fget_buffer (buffer);
2520 CHECK_BUFFER (buffer);
2521 window_loop (UNSHOW_BUFFER, buffer, 0, Qt);
2523 return Qnil;
2526 /* Replace BUFFER with some other buffer in all windows
2527 of all frames, even those on other keyboards. */
2529 void
2530 replace_buffer_in_all_windows (buffer)
2531 Lisp_Object buffer;
2533 #ifdef MULTI_KBOARD
2534 Lisp_Object tail, frame;
2536 /* A single call to window_loop won't do the job
2537 because it only considers frames on the current keyboard.
2538 So loop manually over frames, and handle each one. */
2539 FOR_EACH_FRAME (tail, frame)
2540 window_loop (UNSHOW_BUFFER, buffer, 1, frame);
2541 #else
2542 window_loop (UNSHOW_BUFFER, buffer, 1, Qt);
2543 #endif
2546 /* Set the height of WINDOW and all its inferiors. */
2548 /* The smallest acceptable dimensions for a window. Anything smaller
2549 might crash Emacs. */
2551 #define MIN_SAFE_WINDOW_WIDTH (2)
2552 #define MIN_SAFE_WINDOW_HEIGHT (1)
2554 /* For wp non-zero the total number of columns of window w. Otherwise
2555 the total number of lines of w. */
2557 #define WINDOW_TOTAL_SIZE(w, wp) \
2558 (wp ? WINDOW_TOTAL_COLS (w) : WINDOW_TOTAL_LINES (w))
2560 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2561 minimum allowable size. */
2563 void
2564 check_frame_size (frame, rows, cols)
2565 FRAME_PTR frame;
2566 int *rows, *cols;
2568 /* For height, we have to see:
2569 how many windows the frame has at minimum (one or two),
2570 and whether it has a menu bar or other special stuff at the top. */
2571 int min_height
2572 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
2573 ? MIN_SAFE_WINDOW_HEIGHT
2574 : 2 * MIN_SAFE_WINDOW_HEIGHT);
2576 if (FRAME_TOP_MARGIN (frame) > 0)
2577 min_height += FRAME_TOP_MARGIN (frame);
2579 if (*rows < min_height)
2580 *rows = min_height;
2581 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2582 *cols = MIN_SAFE_WINDOW_WIDTH;
2585 /* Value is non-zero if window W is fixed-size. WIDTH_P non-zero means
2586 check if W's width can be changed, otherwise check W's height.
2587 CHECK_SIBLINGS_P non-zero means check resizablity of WINDOW's
2588 siblings, too. If none of the siblings is resizable, WINDOW isn't
2589 either. */
2591 static int
2592 window_fixed_size_p (w, width_p, check_siblings_p)
2593 struct window *w;
2594 int width_p, check_siblings_p;
2596 int fixed_p;
2597 struct window *c;
2599 if (!NILP (w->hchild))
2601 c = XWINDOW (w->hchild);
2603 if (width_p)
2605 /* A horizontal combination is fixed-width if all of if its
2606 children are. */
2607 while (c && window_fixed_size_p (c, width_p, 0))
2608 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2609 fixed_p = c == NULL;
2611 else
2613 /* A horizontal combination is fixed-height if one of if its
2614 children is. */
2615 while (c && !window_fixed_size_p (c, width_p, 0))
2616 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2617 fixed_p = c != NULL;
2620 else if (!NILP (w->vchild))
2622 c = XWINDOW (w->vchild);
2624 if (width_p)
2626 /* A vertical combination is fixed-width if one of if its
2627 children is. */
2628 while (c && !window_fixed_size_p (c, width_p, 0))
2629 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2630 fixed_p = c != NULL;
2632 else
2634 /* A vertical combination is fixed-height if all of if its
2635 children are. */
2636 while (c && window_fixed_size_p (c, width_p, 0))
2637 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2638 fixed_p = c == NULL;
2641 else if (BUFFERP (w->buffer))
2643 struct buffer *old = current_buffer;
2644 Lisp_Object val;
2646 current_buffer = XBUFFER (w->buffer);
2647 val = find_symbol_value (Qwindow_size_fixed);
2648 current_buffer = old;
2650 fixed_p = 0;
2651 if (!EQ (val, Qunbound))
2653 fixed_p = !NILP (val);
2655 if (fixed_p
2656 && ((EQ (val, Qheight) && width_p)
2657 || (EQ (val, Qwidth) && !width_p)))
2658 fixed_p = 0;
2661 /* Can't tell if this one is resizable without looking at
2662 siblings. If all siblings are fixed-size this one is too. */
2663 if (!fixed_p && check_siblings_p && WINDOWP (w->parent))
2665 Lisp_Object child;
2667 for (child = w->prev; WINDOWP (child); child = XWINDOW (child)->prev)
2668 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2669 break;
2671 if (NILP (child))
2672 for (child = w->next; WINDOWP (child); child = XWINDOW (child)->next)
2673 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2674 break;
2676 if (NILP (child))
2677 fixed_p = 1;
2680 else
2681 fixed_p = 1;
2683 return fixed_p;
2686 /* Return minimum size of leaf window W. WIDTH_P non-zero means return
2687 the minimum width of W, WIDTH_P zero means return the minimum height
2688 of W. SAFE_P non-zero means ignore window-min-height|width but just
2689 return values that won't crash Emacs and don't hide components like
2690 fringes, scrollbars, or modelines. If WIDTH_P is zero and W is the
2691 minibuffer window, always return 1. */
2693 static int
2694 window_min_size_2 (w, width_p, safe_p)
2695 struct window *w;
2696 int width_p, safe_p;
2698 /* We should consider buffer-local values of window_min_height and
2699 window_min_width here. */
2700 if (width_p)
2702 int safe_size = (MIN_SAFE_WINDOW_WIDTH
2703 + WINDOW_FRINGE_COLS (w)
2704 + WINDOW_SCROLL_BAR_COLS (w));
2706 return safe_p ? safe_size : max (window_min_width, safe_size);
2708 else if (MINI_WINDOW_P (w))
2709 return 1;
2710 else
2712 int safe_size = (MIN_SAFE_WINDOW_HEIGHT
2713 + ((BUFFERP (w->buffer)
2714 && !NILP (XBUFFER (w->buffer)->mode_line_format))
2715 ? 1 : 0));
2717 return safe_p ? safe_size : max (window_min_height, safe_size);
2721 /* Return minimum size of window W, not taking fixed-width windows into
2722 account. WIDTH_P non-zero means return the minimum width, otherwise
2723 return the minimum height. SAFE_P non-zero means ignore
2724 window-min-height|width but just return values that won't crash Emacs
2725 and don't hide components like fringes, scrollbars, or modelines. If
2726 W is a combination window, compute the minimum size from the minimum
2727 sizes of W's children. */
2729 static int
2730 window_min_size_1 (w, width_p, safe_p)
2731 struct window *w;
2732 int width_p, safe_p;
2734 struct window *c;
2735 int size;
2737 if (!NILP (w->hchild))
2739 /* W is a horizontal combination. */
2740 c = XWINDOW (w->hchild);
2741 size = 0;
2743 if (width_p)
2745 /* The minimum width of a horizontal combination is the sum of
2746 the minimum widths of its children. */
2747 while (c)
2749 size += window_min_size_1 (c, 1, safe_p);
2750 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2753 else
2755 /* The minimum height of a horizontal combination is the
2756 maximum of the minimum heights of its children. */
2757 while (c)
2759 size = max (window_min_size_1 (c, 0, safe_p), size);
2760 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2764 else if (!NILP (w->vchild))
2766 /* W is a vertical combination. */
2767 c = XWINDOW (w->vchild);
2768 size = 0;
2770 if (width_p)
2772 /* The minimum width of a vertical combination is the maximum
2773 of the minimum widths of its children. */
2774 while (c)
2776 size = max (window_min_size_1 (c, 1, safe_p), size);
2777 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2780 else
2782 /* The minimum height of a vertical combination is the sum of
2783 the minimum height of its children. */
2784 while (c)
2786 size += window_min_size_1 (c, 0, safe_p);
2787 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2791 else
2792 /* W is a leaf window. */
2793 size = window_min_size_2 (w, width_p, safe_p);
2795 return size;
2798 /* Return the minimum size of window W, taking fixed-size windows into
2799 account. WIDTH_P non-zero means return the minimum width, otherwise
2800 return the minimum height. SAFE_P non-zero means ignore
2801 window-min-height|width but just return values that won't crash Emacs
2802 and don't hide components like fringes, scrollbars, or modelines.
2803 IGNORE_FIXED_P non-zero means ignore if W is fixed-size. Set *FIXED
2804 to 1 if W is fixed-size unless FIXED is null. */
2806 static int
2807 window_min_size (w, width_p, safe_p, ignore_fixed_p, fixed)
2808 struct window *w;
2809 int width_p, safe_p, ignore_fixed_p, *fixed;
2811 int size, fixed_p;
2813 if (ignore_fixed_p)
2814 fixed_p = 0;
2815 else
2816 fixed_p = window_fixed_size_p (w, width_p, 1);
2818 if (fixed)
2819 *fixed = fixed_p;
2821 if (fixed_p)
2822 size = WINDOW_TOTAL_SIZE (w, width_p);
2823 else
2824 size = window_min_size_1 (w, width_p, safe_p);
2826 return size;
2830 /* Adjust the margins of window W if text area is too small.
2831 Return 1 if window width is ok after adjustment; 0 if window
2832 is still too narrow. */
2834 static int
2835 adjust_window_margins (w)
2836 struct window *w;
2838 int box_cols = (WINDOW_TOTAL_COLS (w)
2839 - WINDOW_FRINGE_COLS (w)
2840 - WINDOW_SCROLL_BAR_COLS (w));
2841 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
2842 + WINDOW_RIGHT_MARGIN_COLS (w));
2844 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
2845 return 1;
2847 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
2848 return 0;
2850 /* Window's text area is too narrow, but reducing the window
2851 margins will fix that. */
2852 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
2853 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
2855 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
2856 w->left_margin_cols = w->right_margin_cols
2857 = make_number (margin_cols/2);
2858 else
2859 w->right_margin_cols = make_number (margin_cols);
2861 else
2862 w->left_margin_cols = make_number (margin_cols);
2863 return 1;
2866 /* Calculate new sizes for windows in the list FORWARD when their
2867 compound size goes from TOTAL to SIZE. TOTAL must be greater than
2868 SIZE. The number of windows in FORWARD is NCHILDREN, and the number
2869 that can shrink is SHRINKABLE. Fixed-size windows may be shrunk if
2870 and only if RESIZE_FIXED_P is non-zero. WIDTH_P non-zero means
2871 shrink columns, otherwise shrink lines.
2873 SAFE_P zero means windows may be sized down to window-min-height
2874 lines (window-min-window columns for WIDTH_P non-zero). SAFE_P
2875 non-zero means windows may be sized down to their minimum safe sizes
2876 taking into account the space needed to display modelines, fringes,
2877 and scrollbars.
2879 This function returns an allocated array of new sizes that the caller
2880 must free. A size -1 means the window is fixed and RESIZE_FIXED_P is
2881 zero. A size zero means the window shall be deleted. Array index 0
2882 refers to the first window in FORWARD, 1 to the second, and so on.
2884 This function resizes windows proportionally to their size. It also
2885 tries to preserve smaller windows by resizing larger windows before
2886 resizing any window to zero. If resize_proportionally is non-nil for
2887 a specific window, it will attempt to strictly resize that window
2888 proportionally, even at the expense of deleting smaller windows. */
2889 static int *
2890 shrink_windows (total, size, nchildren, shrinkable, resize_fixed_p,
2891 forward, width_p, safe_p)
2892 int total, size, nchildren, shrinkable;
2893 int resize_fixed_p, width_p, safe_p;
2894 Lisp_Object forward;
2896 int available_resize = 0;
2897 int *new_sizes, *min_sizes;
2898 struct window *c;
2899 Lisp_Object child;
2900 int smallest = total;
2901 int total_removed = 0;
2902 int total_shrink = total - size;
2903 int i;
2905 new_sizes = xmalloc (sizeof (*new_sizes) * nchildren);
2906 min_sizes = xmalloc (sizeof (*min_sizes) * nchildren);
2908 for (i = 0, child = forward; !NILP (child); child = c->next, ++i)
2910 int child_size;
2912 c = XWINDOW (child);
2913 child_size = WINDOW_TOTAL_SIZE (c, width_p);
2915 if (!resize_fixed_p && window_fixed_size_p (c, width_p, 0))
2916 new_sizes[i] = -1;
2917 else
2919 new_sizes[i] = child_size;
2920 min_sizes[i] = window_min_size_1 (c, width_p, safe_p);
2921 if (child_size > min_sizes[i]
2922 && NILP (c->resize_proportionally))
2923 available_resize += child_size - min_sizes[i];
2926 /* We might need to shrink some windows to zero. Find the smallest
2927 windows and set them to 0 until we can fulfil the new size. */
2929 while (shrinkable > 1 && size + available_resize < total)
2931 for (i = 0; i < nchildren; ++i)
2932 if (new_sizes[i] > 0 && smallest > new_sizes[i])
2933 smallest = new_sizes[i];
2935 for (i = 0; i < nchildren; ++i)
2936 if (new_sizes[i] == smallest)
2938 /* Resize this window down to zero. */
2939 new_sizes[i] = 0;
2940 if (smallest > min_sizes[i])
2941 available_resize -= smallest - min_sizes[i];
2942 available_resize += smallest;
2943 --shrinkable;
2944 total_removed += smallest;
2946 /* We don't know what the smallest is now. */
2947 smallest = total;
2949 /* Out of for, just remove one window at the time and
2950 check again if we have enough space. */
2951 break;
2955 /* Now, calculate the new sizes. Try to shrink each window
2956 proportional to its size. */
2957 for (i = 0; i < nchildren; ++i)
2959 if (new_sizes[i] > min_sizes[i])
2961 int to_shrink = total_shrink * new_sizes[i] / total;
2963 if (new_sizes[i] - to_shrink < min_sizes[i])
2964 to_shrink = new_sizes[i] - min_sizes[i];
2965 new_sizes[i] -= to_shrink;
2966 total_removed += to_shrink;
2970 /* Any reminder due to rounding, we just subtract from windows
2971 that are left and still can be shrunk. */
2972 while (total_shrink > total_removed)
2974 int nonzero_sizes = 0;
2975 int nonzero_idx = -1;
2977 for (i = 0; i < nchildren; ++i)
2978 if (new_sizes[i] > 0)
2980 ++nonzero_sizes;
2981 nonzero_idx = i;
2984 for (i = 0; i < nchildren; ++i)
2985 if (new_sizes[i] > min_sizes[i])
2987 --new_sizes[i];
2988 ++total_removed;
2990 /* Out of for, just shrink one window at the time and
2991 check again if we have enough space. */
2992 break;
2995 /* Special case, only one window left. */
2996 if (nonzero_sizes == 1)
2997 break;
3000 /* Any surplus due to rounding, we add to windows that are left. */
3001 while (total_shrink < total_removed)
3003 for (i = 0; i < nchildren; ++i)
3005 if (new_sizes[i] != 0 && total_shrink < total_removed)
3007 ++new_sizes[i];
3008 --total_removed;
3009 break;
3014 xfree (min_sizes);
3016 return new_sizes;
3019 /* Set WINDOW's height or width to SIZE. WIDTH_P non-zero means set
3020 WINDOW's width. Resize WINDOW's children, if any, so that they keep
3021 their proportionate size relative to WINDOW.
3023 If FIRST_ONLY is 1, change only the first of WINDOW's children when
3024 they are in series. If LAST_ONLY is 1, change only the last of
3025 WINDOW's children when they are in series.
3027 Propagate WINDOW's top or left edge position to children. Delete
3028 windows that become too small unless NODELETE_P is 1. When
3029 NODELETE_P equals 2 do not honor settings for window-min-height and
3030 window-min-width when resizing windows but use safe defaults instead.
3031 This should give better behavior when resizing frames. */
3033 static void
3034 size_window (window, size, width_p, nodelete_p, first_only, last_only)
3035 Lisp_Object window;
3036 int size, width_p, nodelete_p;
3037 int first_only, last_only;
3039 struct window *w = XWINDOW (window);
3040 struct window *c;
3041 Lisp_Object child, *forward, *sideward;
3042 int old_size = WINDOW_TOTAL_SIZE (w, width_p);
3044 size = max (0, size);
3046 /* Delete WINDOW if it's too small. */
3047 if (nodelete_p != 1 && !NILP (w->parent)
3048 && size < window_min_size_1 (w, width_p, nodelete_p == 2))
3050 delete_window (window);
3051 return;
3054 /* Set redisplay hints. */
3055 w->last_modified = make_number (0);
3056 w->last_overlay_modified = make_number (0);
3057 windows_or_buffers_changed++;
3058 FRAME_WINDOW_SIZES_CHANGED (XFRAME (w->frame)) = 1;
3060 if (width_p)
3062 sideward = &w->vchild;
3063 forward = &w->hchild;
3064 w->total_cols = make_number (size);
3065 adjust_window_margins (w);
3067 else
3069 sideward = &w->hchild;
3070 forward = &w->vchild;
3071 w->total_lines = make_number (size);
3072 w->orig_total_lines = Qnil;
3075 if (!NILP (*sideward))
3077 /* We have a chain of parallel siblings whose size should all change. */
3078 for (child = *sideward; !NILP (child); child = c->next)
3080 c = XWINDOW (child);
3081 if (width_p)
3082 c->left_col = w->left_col;
3083 else
3084 c->top_line = w->top_line;
3085 size_window (child, size, width_p, nodelete_p,
3086 first_only, last_only);
3089 else if (!NILP (*forward) && last_only)
3091 /* Change the last in a series of siblings. */
3092 Lisp_Object last_child;
3093 int child_size;
3095 for (child = *forward; !NILP (child); child = c->next)
3097 c = XWINDOW (child);
3098 last_child = child;
3101 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3102 size_window (last_child, size - old_size + child_size,
3103 width_p, nodelete_p, first_only, last_only);
3105 else if (!NILP (*forward) && first_only)
3107 /* Change the first in a series of siblings. */
3108 int child_size;
3110 child = *forward;
3111 c = XWINDOW (child);
3113 if (width_p)
3114 c->left_col = w->left_col;
3115 else
3116 c->top_line = w->top_line;
3118 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3119 size_window (child, size - old_size + child_size,
3120 width_p, nodelete_p, first_only, last_only);
3122 else if (!NILP (*forward))
3124 int fixed_size, each, extra, n;
3125 int resize_fixed_p, nfixed;
3126 int last_pos, first_pos, nchildren, total;
3127 int *new_sizes = NULL;
3129 /* Determine the fixed-size portion of this window, and the
3130 number of child windows. */
3131 fixed_size = nchildren = nfixed = total = 0;
3132 for (child = *forward; !NILP (child); child = c->next, ++nchildren)
3134 int child_size;
3136 c = XWINDOW (child);
3137 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3138 total += child_size;
3140 if (window_fixed_size_p (c, width_p, 0))
3142 fixed_size += child_size;
3143 ++nfixed;
3147 /* If the new size is smaller than fixed_size, or if there
3148 aren't any resizable windows, allow resizing fixed-size
3149 windows. */
3150 resize_fixed_p = nfixed == nchildren || size < fixed_size;
3152 /* Compute how many lines/columns to add/remove to each child. The
3153 value of extra takes care of rounding errors. */
3154 n = resize_fixed_p ? nchildren : nchildren - nfixed;
3155 if (size < total && n > 1)
3156 new_sizes = shrink_windows (total, size, nchildren, n,
3157 resize_fixed_p, *forward, width_p,
3158 nodelete_p == 2);
3159 else
3161 each = (size - total) / n;
3162 extra = (size - total) - n * each;
3165 /* Compute new children heights and edge positions. */
3166 first_pos = width_p ? XINT (w->left_col) : XINT (w->top_line);
3167 last_pos = first_pos;
3168 for (n = 0, child = *forward; !NILP (child); child = c->next, ++n)
3170 int new_size, old_size;
3172 c = XWINDOW (child);
3173 old_size = WINDOW_TOTAL_SIZE (c, width_p);
3174 new_size = old_size;
3176 /* The top or left edge position of this child equals the
3177 bottom or right edge of its predecessor. */
3178 if (width_p)
3179 c->left_col = make_number (last_pos);
3180 else
3181 c->top_line = make_number (last_pos);
3183 /* If this child can be resized, do it. */
3184 if (resize_fixed_p || !window_fixed_size_p (c, width_p, 0))
3186 new_size = new_sizes ? new_sizes[n] : old_size + each + extra;
3187 extra = 0;
3190 /* Set new size. Note that size_window also propagates
3191 edge positions to children, so it's not a no-op if we
3192 didn't change the child's size. */
3193 size_window (child, new_size, width_p, 1, first_only, last_only);
3195 /* Remember the bottom/right edge position of this child; it
3196 will be used to set the top/left edge of the next child. */
3197 last_pos += new_size;
3200 if (new_sizes) xfree (new_sizes);
3202 /* We should have covered the parent exactly with child windows. */
3203 xassert (size == last_pos - first_pos);
3205 /* Now delete any children that became too small. */
3206 if (nodelete_p != 1)
3207 for (child = *forward; !NILP (child); child = c->next)
3209 int child_size;
3211 c = XWINDOW (child);
3212 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3213 size_window (child, child_size, width_p, nodelete_p,
3214 first_only, last_only);
3219 /* Set WINDOW's height to HEIGHT, and recursively change the height of
3220 WINDOW's children. NODELETE zero means windows that have become
3221 smaller than window-min-height in the process may be deleted.
3222 NODELETE 1 means never delete windows that become too small in the
3223 process. (The caller should check later and do so if appropriate.)
3224 NODELETE 2 means delete only windows that have become too small to be
3225 displayed correctly. */
3227 void
3228 set_window_height (window, height, nodelete)
3229 Lisp_Object window;
3230 int height;
3231 int nodelete;
3233 size_window (window, height, 0, nodelete, 0, 0);
3236 /* Set WINDOW's width to WIDTH, and recursively change the width of
3237 WINDOW's children. NODELETE zero means windows that have become
3238 smaller than window-min-width in the process may be deleted.
3239 NODELETE 1 means never delete windows that become too small in the
3240 process. (The caller should check later and do so if appropriate.)
3241 NODELETE 2 means delete only windows that have become too small to be
3242 displayed correctly. */
3244 void
3245 set_window_width (window, width, nodelete)
3246 Lisp_Object window;
3247 int width;
3248 int nodelete;
3250 size_window (window, width, 1, nodelete, 0, 0);
3253 /* Change window heights in windows rooted in WINDOW by N lines. */
3255 void
3256 change_window_heights (window, n)
3257 Lisp_Object window;
3258 int n;
3260 struct window *w = XWINDOW (window);
3262 XSETFASTINT (w->top_line, XFASTINT (w->top_line) + n);
3263 XSETFASTINT (w->total_lines, XFASTINT (w->total_lines) - n);
3265 if (INTEGERP (w->orig_top_line))
3266 XSETFASTINT (w->orig_top_line, XFASTINT (w->orig_top_line) + n);
3267 if (INTEGERP (w->orig_total_lines))
3268 XSETFASTINT (w->orig_total_lines, XFASTINT (w->orig_total_lines) - n);
3270 /* Handle just the top child in a vertical split. */
3271 if (!NILP (w->vchild))
3272 change_window_heights (w->vchild, n);
3274 /* Adjust all children in a horizontal split. */
3275 for (window = w->hchild; !NILP (window); window = w->next)
3277 w = XWINDOW (window);
3278 change_window_heights (window, n);
3283 int window_select_count;
3285 Lisp_Object
3286 Fset_window_buffer_unwind (obuf)
3287 Lisp_Object obuf;
3289 Fset_buffer (obuf);
3290 return Qnil;
3293 EXFUN (Fset_window_fringes, 4);
3294 EXFUN (Fset_window_scroll_bars, 4);
3296 static void
3297 run_funs (Lisp_Object funs)
3299 for (; CONSP (funs); funs = XCDR (funs))
3300 if (!EQ (XCAR (funs), Qt))
3301 call0 (XCAR (funs));
3304 static Lisp_Object select_window_norecord (Lisp_Object window);
3306 void
3307 run_window_configuration_change_hook (struct frame *f)
3309 int count = SPECPDL_INDEX ();
3310 Lisp_Object frame, global_wcch
3311 = Fdefault_value (Qwindow_configuration_change_hook);
3312 XSETFRAME (frame, f);
3314 if (NILP (Vrun_hooks))
3315 return;
3317 if (SELECTED_FRAME () != f)
3319 record_unwind_protect (Fselect_frame, Fselected_frame ());
3320 Fselect_frame (frame);
3323 /* Use the right buffer. Matters when running the local hooks. */
3324 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3326 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3327 Fset_buffer (Fwindow_buffer (Qnil));
3330 /* Look for buffer-local values. */
3332 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3333 for (; CONSP (windows); windows = XCDR (windows))
3335 Lisp_Object window = XCAR (windows);
3336 Lisp_Object buffer = Fwindow_buffer (window);
3337 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3338 buffer)))
3340 int count = SPECPDL_INDEX ();
3341 record_unwind_protect (select_window_norecord, Fselected_window ());
3342 select_window_norecord (window);
3343 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3344 buffer));
3345 unbind_to (count, Qnil);
3350 run_funs (global_wcch);
3351 unbind_to (count, Qnil);
3354 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
3355 means it's allowed to run hooks. See make_frame for a case where
3356 it's not allowed. KEEP_MARGINS_P non-zero means that the current
3357 margins, fringes, and scroll-bar settings of the window are not
3358 reset from the buffer's local settings. */
3360 void
3361 set_window_buffer (window, buffer, run_hooks_p, keep_margins_p)
3362 Lisp_Object window, buffer;
3363 int run_hooks_p, keep_margins_p;
3365 struct window *w = XWINDOW (window);
3366 struct buffer *b = XBUFFER (buffer);
3367 int count = SPECPDL_INDEX ();
3368 int samebuf = EQ (buffer, w->buffer);
3370 w->buffer = buffer;
3372 if (EQ (window, selected_window))
3373 b->last_selected_window = window;
3375 /* Let redisplay errors through. */
3376 b->display_error_modiff = 0;
3378 /* Update time stamps of buffer display. */
3379 if (INTEGERP (b->display_count))
3380 XSETINT (b->display_count, XINT (b->display_count) + 1);
3381 b->display_time = Fcurrent_time ();
3383 XSETFASTINT (w->window_end_pos, 0);
3384 XSETFASTINT (w->window_end_vpos, 0);
3385 bzero (&w->last_cursor, sizeof w->last_cursor);
3386 w->window_end_valid = Qnil;
3387 if (!(keep_margins_p && samebuf))
3388 { /* If we're not actually changing the buffer, Don't reset hscroll and
3389 vscroll. This case happens for example when called from
3390 change_frame_size_1, where we use a dummy call to
3391 Fset_window_buffer on the frame's selected window (and no other)
3392 just in order to run window-configuration-change-hook.
3393 Resetting hscroll and vscroll here is problematic for things like
3394 image-mode and doc-view-mode since it resets the image's position
3395 whenever we resize the frame. */
3396 w->hscroll = w->min_hscroll = make_number (0);
3397 w->vscroll = 0;
3398 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3399 set_marker_restricted (w->start,
3400 make_number (b->last_window_start),
3401 buffer);
3402 w->start_at_line_beg = Qnil;
3403 w->force_start = Qnil;
3404 XSETFASTINT (w->last_modified, 0);
3405 XSETFASTINT (w->last_overlay_modified, 0);
3407 /* Maybe we could move this into the `if' but it's not obviously safe and
3408 I doubt it's worth the trouble. */
3409 windows_or_buffers_changed++;
3411 /* We must select BUFFER for running the window-scroll-functions.
3412 If WINDOW is selected, switch permanently.
3413 Otherwise, switch but go back to the ambient buffer afterward. */
3414 if (EQ (window, selected_window))
3415 Fset_buffer (buffer);
3416 /* We can't check ! NILP (Vwindow_scroll_functions) here
3417 because that might itself be a local variable. */
3418 else if (window_initialized)
3420 record_unwind_protect (Fset_window_buffer_unwind, Fcurrent_buffer ());
3421 Fset_buffer (buffer);
3424 if (!keep_margins_p)
3426 /* Set left and right marginal area width etc. from buffer. */
3428 /* This may call adjust_window_margins three times, so
3429 temporarily disable window margins. */
3430 Lisp_Object save_left = w->left_margin_cols;
3431 Lisp_Object save_right = w->right_margin_cols;
3433 w->left_margin_cols = w->right_margin_cols = Qnil;
3435 Fset_window_fringes (window,
3436 b->left_fringe_width, b->right_fringe_width,
3437 b->fringes_outside_margins);
3439 Fset_window_scroll_bars (window,
3440 b->scroll_bar_width,
3441 b->vertical_scroll_bar_type, Qnil);
3443 w->left_margin_cols = save_left;
3444 w->right_margin_cols = save_right;
3446 Fset_window_margins (window,
3447 b->left_margin_cols, b->right_margin_cols);
3450 if (run_hooks_p)
3452 if (! NILP (Vwindow_scroll_functions))
3453 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3454 Fmarker_position (w->start));
3455 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3458 unbind_to (count, Qnil);
3462 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3463 doc: /* Make WINDOW display BUFFER as its contents.
3464 BUFFER can be a buffer or the name of an existing buffer.
3465 Optional third arg KEEP-MARGINS non-nil means that WINDOW's current
3466 display margins, fringe widths, and scroll bar settings are maintained;
3467 the default is to reset these from BUFFER's local settings or the frame
3468 defaults.
3470 This function runs the hook `window-scroll-functions'. */)
3471 (window, buffer, keep_margins)
3472 register Lisp_Object window, buffer, keep_margins;
3474 register Lisp_Object tem;
3475 register struct window *w = decode_window (window);
3477 XSETWINDOW (window, w);
3478 buffer = Fget_buffer (buffer);
3479 CHECK_BUFFER (buffer);
3481 if (NILP (XBUFFER (buffer)->name))
3482 error ("Attempt to display deleted buffer");
3484 tem = w->buffer;
3485 if (NILP (tem))
3486 error ("Window is deleted");
3487 else if (! EQ (tem, Qt)) /* w->buffer is t when the window
3488 is first being set up. */
3490 if (!NILP (w->dedicated) && !EQ (tem, buffer))
3491 error ("Window is dedicated to `%s'",
3492 SDATA (XBUFFER (tem)->name));
3494 unshow_buffer (w);
3497 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3498 return Qnil;
3501 /* Note that selected_window can be nil
3502 when this is called from Fset_window_configuration. */
3504 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
3505 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
3506 If WINDOW is not already selected, make WINDOW's buffer current
3507 and make WINDOW the frame's selected window. Return WINDOW.
3508 Optional second arg NORECORD non-nil means
3509 do not put this buffer at the front of the list of recently selected ones.
3511 Note that the main editor command loop
3512 selects the buffer of the selected window before each command. */)
3513 (window, norecord)
3514 register Lisp_Object window, norecord;
3516 register struct window *w;
3517 register struct window *ow;
3518 struct frame *sf;
3520 CHECK_LIVE_WINDOW (window);
3522 w = XWINDOW (window);
3523 w->frozen_window_start_p = 0;
3525 ++window_select_count;
3526 XSETFASTINT (w->use_time, window_select_count);
3527 if (EQ (window, selected_window))
3528 return window;
3530 sf = SELECTED_FRAME ();
3531 if (XFRAME (WINDOW_FRAME (w)) != sf)
3533 XFRAME (WINDOW_FRAME (w))->selected_window = window;
3534 /* Use this rather than Fhandle_switch_frame
3535 so that FRAME_FOCUS_FRAME is moved appropriately as we
3536 move around in the state where a minibuffer in a separate
3537 frame is active. */
3538 Fselect_frame (WINDOW_FRAME (w));
3539 /* Fselect_frame called us back so we've done all the work already. */
3540 eassert (EQ (window, selected_window));
3541 return window;
3543 else
3544 sf->selected_window = window;
3546 /* Store the current buffer's actual point into the
3547 old selected window. It belongs to that window,
3548 and when the window is not selected, must be in the window. */
3549 if (!NILP (selected_window))
3551 ow = XWINDOW (selected_window);
3552 if (! NILP (ow->buffer))
3553 set_marker_both (ow->pointm, ow->buffer,
3554 BUF_PT (XBUFFER (ow->buffer)),
3555 BUF_PT_BYTE (XBUFFER (ow->buffer)));
3558 selected_window = window;
3560 if (NILP (norecord))
3561 record_buffer (w->buffer);
3562 Fset_buffer (w->buffer);
3564 XBUFFER (w->buffer)->last_selected_window = window;
3566 /* Go to the point recorded in the window.
3567 This is important when the buffer is in more
3568 than one window. It also matters when
3569 redisplay_window has altered point after scrolling,
3570 because it makes the change only in the window. */
3572 register int new_point = marker_position (w->pointm);
3573 if (new_point < BEGV)
3574 SET_PT (BEGV);
3575 else if (new_point > ZV)
3576 SET_PT (ZV);
3577 else
3578 SET_PT (new_point);
3581 windows_or_buffers_changed++;
3582 return window;
3585 static Lisp_Object
3586 select_window_norecord (window)
3587 Lisp_Object window;
3589 return Fselect_window (window, Qt);
3592 /* Deiconify the frame containing the window WINDOW,
3593 unless it is the selected frame;
3594 then return WINDOW.
3596 The reason for the exception for the selected frame
3597 is that it seems better not to change the selected frames visibility
3598 merely because of displaying a different buffer in it.
3599 The deiconification is useful when a buffer gets shown in
3600 another frame that you were not using lately. */
3602 static Lisp_Object
3603 display_buffer_1 (window)
3604 Lisp_Object window;
3606 Lisp_Object frame = XWINDOW (window)->frame;
3607 FRAME_PTR f = XFRAME (frame);
3609 FRAME_SAMPLE_VISIBILITY (f);
3611 if (EQ (frame, selected_frame))
3612 ; /* Assume the selected frame is already visible enough. */
3613 else if (minibuf_level > 0
3614 && MINI_WINDOW_P (XWINDOW (selected_window))
3615 && WINDOW_LIVE_P (minibuf_selected_window)
3616 && EQ (frame, WINDOW_FRAME (XWINDOW (minibuf_selected_window))))
3617 ; /* Assume the frame from which we invoked the minibuffer is visible. */
3618 else
3620 if (FRAME_ICONIFIED_P (f))
3621 Fmake_frame_visible (frame);
3622 else if (FRAME_VISIBLE_P (f))
3623 Fraise_frame (frame);
3626 return window;
3629 DEFUN ("special-display-p", Fspecial_display_p, Sspecial_display_p, 1, 1, 0,
3630 doc: /* Returns non-nil if a buffer named BUFFER-NAME gets a special frame.
3631 If the value is t, `display-buffer' or `pop-to-buffer' would create a
3632 special frame for that buffer using the default frame parameters.
3634 If the value is a list, it is a list of frame parameters that would be used
3635 to make a frame for that buffer.
3636 The variables `special-display-buffer-names'
3637 and `special-display-regexps' control this. */)
3638 (buffer_name)
3639 Lisp_Object buffer_name;
3641 Lisp_Object tem;
3643 CHECK_STRING (buffer_name);
3645 tem = Fmember (buffer_name, Vspecial_display_buffer_names);
3646 if (!NILP (tem))
3647 return Qt;
3649 tem = Fassoc (buffer_name, Vspecial_display_buffer_names);
3650 if (!NILP (tem))
3651 return XCDR (tem);
3653 for (tem = Vspecial_display_regexps; CONSP (tem); tem = XCDR (tem))
3655 Lisp_Object car = XCAR (tem);
3656 if (STRINGP (car)
3657 && fast_string_match (car, buffer_name) >= 0)
3658 return Qt;
3659 else if (CONSP (car)
3660 && STRINGP (XCAR (car))
3661 && fast_string_match (XCAR (car), buffer_name) >= 0)
3662 return XCDR (car);
3664 return Qnil;
3667 DEFUN ("same-window-p", Fsame_window_p, Ssame_window_p, 1, 1, 0,
3668 doc: /* Returns non-nil if a buffer named BUFFER-NAME would use the same window.
3669 More precisely, if `display-buffer' or `pop-to-buffer' would display
3670 that buffer in the selected window rather than (as usual) in some other window.
3671 See `same-window-buffer-names' and `same-window-regexps'. */)
3672 (buffer_name)
3673 Lisp_Object buffer_name;
3675 Lisp_Object tem;
3677 CHECK_STRING (buffer_name);
3679 tem = Fmember (buffer_name, Vsame_window_buffer_names);
3680 if (!NILP (tem))
3681 return Qt;
3683 tem = Fassoc (buffer_name, Vsame_window_buffer_names);
3684 if (!NILP (tem))
3685 return Qt;
3687 for (tem = Vsame_window_regexps; CONSP (tem); tem = XCDR (tem))
3689 Lisp_Object car = XCAR (tem);
3690 if (STRINGP (car)
3691 && fast_string_match (car, buffer_name) >= 0)
3692 return Qt;
3693 else if (CONSP (car)
3694 && STRINGP (XCAR (car))
3695 && fast_string_match (XCAR (car), buffer_name) >= 0)
3696 return Qt;
3698 return Qnil;
3701 /* Use B so the default is (other-buffer). */
3702 DEFUN ("display-buffer", Fdisplay_buffer, Sdisplay_buffer, 1, 3,
3703 "BDisplay buffer: \nP",
3704 doc: /* Make BUFFER appear in some window but don't select it.
3705 BUFFER must be the name of an existing buffer, or, when called from Lisp,
3706 a buffer.
3707 If BUFFER is shown already in some window, just use that one,
3708 unless the window is the selected window and the optional second
3709 argument NOT-THIS-WINDOW is non-nil (interactively, with prefix arg).
3710 If `pop-up-frames' is non-nil, make a new frame if no window shows BUFFER.
3711 Returns the window displaying BUFFER.
3712 If `display-buffer-reuse-frames' is non-nil, and another frame is currently
3713 displaying BUFFER, then simply raise that frame.
3715 The variables `special-display-buffer-names',
3716 `special-display-regexps', `same-window-buffer-names', and
3717 `same-window-regexps' customize how certain buffer names are handled.
3718 The latter two take effect only if NOT-THIS-WINDOW is nil.
3720 If optional argument FRAME is `visible', check all visible frames
3721 for a window to use.
3722 If FRAME is 0, check all visible and iconified frames.
3723 If FRAME is t, check all frames.
3724 If FRAME is a frame, check only that frame.
3725 If FRAME is nil, check only the selected frame
3726 (actually the last nonminibuffer frame),
3727 unless `pop-up-frames' or `display-buffer-reuse-frames' is non-nil,
3728 which means search visible and iconified frames.
3730 If a full-width window on a splittable frame is available to display
3731 the buffer, it may be split, subject to the value of the variable
3732 `split-height-threshold'.
3734 If `even-window-heights' is non-nil, window heights will be evened out
3735 if displaying the buffer causes two vertically adjacent windows to be
3736 displayed. */)
3737 (buffer, not_this_window, frame)
3738 Lisp_Object buffer, not_this_window, frame;
3740 register Lisp_Object window, tem, swp;
3741 struct frame *f;
3743 swp = Qnil;
3744 buffer = Fget_buffer (buffer);
3745 CHECK_BUFFER (buffer);
3747 if (!NILP (Vdisplay_buffer_function))
3748 return call2 (Vdisplay_buffer_function, buffer, not_this_window);
3750 if (NILP (not_this_window)
3751 && XBUFFER (XWINDOW (selected_window)->buffer) == XBUFFER (buffer))
3752 return display_buffer_1 (selected_window);
3754 /* See if the user has specified this buffer should appear
3755 in the selected window. */
3756 if (NILP (not_this_window))
3758 swp = Fsame_window_p (XBUFFER (buffer)->name);
3759 if (!NILP (swp) && !no_switch_window (selected_window))
3761 Fswitch_to_buffer (buffer, Qnil);
3762 return display_buffer_1 (selected_window);
3766 /* If the user wants pop-up-frames or display-buffer-reuse-frames,
3767 look for a window showing BUFFER on any visible or iconified frame.
3768 Otherwise search only the current frame. */
3769 if (! NILP (frame))
3770 tem = frame;
3771 else if (pop_up_frames
3772 || display_buffer_reuse_frames
3773 || last_nonminibuf_frame == 0)
3774 XSETFASTINT (tem, 0);
3775 else
3776 XSETFRAME (tem, last_nonminibuf_frame);
3778 window = Fget_buffer_window (buffer, tem);
3779 if (!NILP (window)
3780 && (NILP (not_this_window) || !EQ (window, selected_window)))
3781 return display_buffer_1 (window);
3783 /* Certain buffer names get special handling. */
3784 if (!NILP (Vspecial_display_function) && NILP (swp))
3786 tem = Fspecial_display_p (XBUFFER (buffer)->name);
3787 if (EQ (tem, Qt))
3788 return call1 (Vspecial_display_function, buffer);
3789 if (CONSP (tem))
3790 return call2 (Vspecial_display_function, buffer, tem);
3793 /* If there are no frames open that have more than a minibuffer,
3794 we need to create a new frame. */
3795 if (pop_up_frames || last_nonminibuf_frame == 0)
3797 window = Fframe_selected_window (call0 (Vpop_up_frame_function));
3798 Fset_window_buffer (window, buffer, Qnil);
3799 return display_buffer_1 (window);
3802 f = SELECTED_FRAME ();
3803 if (pop_up_windows
3804 || FRAME_MINIBUF_ONLY_P (f)
3805 /* If the current frame is a special display frame,
3806 don't try to reuse its windows. */
3807 || !NILP (XWINDOW (FRAME_ROOT_WINDOW (f))->dedicated))
3809 Lisp_Object frames;
3810 struct gcpro gcpro1;
3811 GCPRO1 (buffer);
3813 frames = Qnil;
3814 if (FRAME_MINIBUF_ONLY_P (f))
3815 XSETFRAME (frames, last_nonminibuf_frame);
3817 /* Note that both Fget_largest_window and Fget_lru_window
3818 ignore minibuffers and dedicated windows.
3819 This means they can return nil. */
3821 /* If the frame we would try to split cannot be split,
3822 try other frames. */
3823 if (FRAME_NO_SPLIT_P (NILP (frames) ? f : last_nonminibuf_frame))
3825 /* Try visible frames first. */
3826 window = Fget_largest_window (Qvisible, Qt);
3827 /* If that didn't work, try iconified frames. */
3828 if (NILP (window))
3829 window = Fget_largest_window (make_number (0), Qt);
3830 #if 0 /* Don't try windows on other displays. */
3831 if (NILP (window))
3832 window = Fget_largest_window (Qt, Qt);
3833 #endif
3835 else
3836 window = Fget_largest_window (frames, Qt);
3838 tem = Qnil;
3839 if (!NILP (Vsplit_window_preferred_function))
3840 tem = call1 (Vsplit_window_preferred_function, window);
3842 if (!NILP (tem))
3843 window = tem;
3844 else
3845 /* If the largest window is tall enough, full-width, and either eligible
3846 for splitting or the only window, split it. */
3847 if (!NILP (window)
3848 && ! FRAME_NO_SPLIT_P (XFRAME (XWINDOW (window)->frame))
3849 && WINDOW_FULL_WIDTH_P (XWINDOW (window))
3850 && (window_height (window) >= split_height_threshold
3851 || (NILP (XWINDOW (window)->parent)))
3852 && (window_height (window)
3853 >= (2 * window_min_size_2 (XWINDOW (window), 0, 0))))
3854 window = Fsplit_window (window, Qnil, Qnil);
3855 else
3857 Lisp_Object upper, other;
3859 window = Fget_lru_window (frames, Qt);
3860 /* If the LRU window is tall enough, and either eligible for
3861 splitting and selected or the only window, split it. */
3862 if (!NILP (window)
3863 && ! FRAME_NO_SPLIT_P (XFRAME (XWINDOW (window)->frame))
3864 && ((EQ (window, selected_window)
3865 && window_height (window) >= split_height_threshold)
3866 || (NILP (XWINDOW (window)->parent)))
3867 && (window_height (window)
3868 >= (2 * window_min_size_2 (XWINDOW (window), 0, 0))))
3869 window = Fsplit_window (window, Qnil, Qnil);
3870 else
3871 window = Fget_lru_window (frames, Qnil);
3872 /* If Fget_lru_window returned nil, try other approaches. */
3874 /* Try visible frames first. */
3875 if (NILP (window))
3876 window = Fget_buffer_window (buffer, Qvisible);
3877 if (NILP (window))
3878 window = Fget_largest_window (Qvisible, Qnil);
3879 /* If that didn't work, try iconified frames. */
3880 if (NILP (window))
3881 window = Fget_buffer_window (buffer, make_number (0));
3882 if (NILP (window))
3883 window = Fget_largest_window (make_number (0), Qnil);
3885 #if 0 /* Don't try frames on other displays. */
3886 if (NILP (window))
3887 window = Fget_buffer_window (buffer, Qt);
3888 if (NILP (window))
3889 window = Fget_largest_window (Qt, Qnil);
3890 #endif
3891 /* As a last resort, make a new frame. */
3892 if (NILP (window))
3893 window = Fframe_selected_window (call0 (Vpop_up_frame_function));
3894 /* If window appears above or below another,
3895 even out their heights. */
3896 other = upper = Qnil;
3897 if (!NILP (XWINDOW (window)->prev))
3898 other = upper = XWINDOW (window)->prev;
3899 if (!NILP (XWINDOW (window)->next))
3900 other = XWINDOW (window)->next, upper = window;
3901 if (!NILP (other)
3902 && !NILP (Veven_window_heights)
3903 /* Check that OTHER and WINDOW are vertically arrayed. */
3904 && !EQ (XWINDOW (other)->top_line, XWINDOW (window)->top_line)
3905 && (XFASTINT (XWINDOW (other)->total_lines)
3906 > XFASTINT (XWINDOW (window)->total_lines)))
3908 int total = (XFASTINT (XWINDOW (other)->total_lines)
3909 + XFASTINT (XWINDOW (window)->total_lines));
3910 enlarge_window (upper,
3911 total / 2 - XFASTINT (XWINDOW (upper)->total_lines),
3915 UNGCPRO;
3917 else
3918 window = Fget_lru_window (Qnil, Qnil);
3920 Fset_window_buffer (window, buffer, Qnil);
3921 return display_buffer_1 (window);
3925 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3926 0, 1, 0,
3927 doc: /* Force all windows to be updated on next redisplay.
3928 If optional arg OBJECT is a window, force redisplay of that window only.
3929 If OBJECT is a buffer or buffer name, force redisplay of all windows
3930 displaying that buffer. */)
3931 (object)
3932 Lisp_Object object;
3934 if (NILP (object))
3936 windows_or_buffers_changed++;
3937 update_mode_lines++;
3938 return Qt;
3941 if (WINDOWP (object))
3943 struct window *w = XWINDOW (object);
3944 mark_window_display_accurate (object, 0);
3945 w->update_mode_line = Qt;
3946 if (BUFFERP (w->buffer))
3947 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3948 ++update_mode_lines;
3949 return Qt;
3952 if (STRINGP (object))
3953 object = Fget_buffer (object);
3954 if (BUFFERP (object) && !NILP (XBUFFER (object)->name))
3956 /* Walk all windows looking for buffer, and force update
3957 of each of those windows. */
3959 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3960 return NILP (object) ? Qnil : Qt;
3963 /* If nothing suitable was found, just return.
3964 We could signal an error, but this feature will typically be used
3965 asynchronously in timers or process sentinels, so we don't. */
3966 return Qnil;
3970 void
3971 temp_output_buffer_show (buf)
3972 register Lisp_Object buf;
3974 register struct buffer *old = current_buffer;
3975 register Lisp_Object window;
3976 register struct window *w;
3978 XBUFFER (buf)->directory = current_buffer->directory;
3980 Fset_buffer (buf);
3981 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3982 BEGV = BEG;
3983 ZV = Z;
3984 SET_PT (BEG);
3985 #if 0 /* rms: there should be no reason for this. */
3986 XBUFFER (buf)->prevent_redisplay_optimizations_p = 1;
3987 #endif
3988 set_buffer_internal (old);
3990 if (!NILP (Vtemp_buffer_show_function))
3991 call1 (Vtemp_buffer_show_function, buf);
3992 else
3994 window = Fdisplay_buffer (buf, Qnil, Qnil);
3996 if (!EQ (XWINDOW (window)->frame, selected_frame))
3997 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3998 Vminibuf_scroll_window = window;
3999 w = XWINDOW (window);
4000 XSETFASTINT (w->hscroll, 0);
4001 XSETFASTINT (w->min_hscroll, 0);
4002 set_marker_restricted_both (w->start, buf, BEG, BEG);
4003 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
4005 /* Run temp-buffer-show-hook, with the chosen window selected
4006 and its buffer current. */
4008 if (!NILP (Vrun_hooks)
4009 && !NILP (Fboundp (Qtemp_buffer_show_hook))
4010 && !NILP (Fsymbol_value (Qtemp_buffer_show_hook)))
4012 int count = SPECPDL_INDEX ();
4013 Lisp_Object prev_window, prev_buffer;
4014 prev_window = selected_window;
4015 XSETBUFFER (prev_buffer, old);
4017 /* Select the window that was chosen, for running the hook.
4018 Note: Both Fselect_window and select_window_norecord may
4019 set-buffer to the buffer displayed in the window,
4020 so we need to save the current buffer. --stef */
4021 record_unwind_protect (Fset_buffer, prev_buffer);
4022 record_unwind_protect (select_window_norecord, prev_window);
4023 Fselect_window (window, Qt);
4024 Fset_buffer (w->buffer);
4025 call1 (Vrun_hooks, Qtemp_buffer_show_hook);
4026 unbind_to (count, Qnil);
4031 static void
4032 make_dummy_parent (window)
4033 Lisp_Object window;
4035 Lisp_Object new;
4036 register struct window *o, *p;
4037 int i;
4039 o = XWINDOW (window);
4040 p = allocate_window ();
4041 for (i = 0; i < VECSIZE (struct window); ++i)
4042 ((struct Lisp_Vector *) p)->contents[i]
4043 = ((struct Lisp_Vector *)o)->contents[i];
4044 XSETWINDOW (new, p);
4046 ++sequence_number;
4047 XSETFASTINT (p->sequence_number, sequence_number);
4049 /* Put new into window structure in place of window */
4050 replace_window (window, new);
4052 o->next = Qnil;
4053 o->prev = Qnil;
4054 o->vchild = Qnil;
4055 o->hchild = Qnil;
4056 o->parent = new;
4058 p->start = Qnil;
4059 p->pointm = Qnil;
4060 p->buffer = Qnil;
4063 DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "",
4064 doc: /* Split WINDOW, putting SIZE lines in the first of the pair.
4065 WINDOW defaults to selected one and SIZE to half its size.
4066 If optional third arg HORFLAG is non-nil, split side by side
4067 and put SIZE columns in the first of the pair. In that case,
4068 SIZE includes that window's scroll bar, or the divider column to its right.
4069 Interactively, all arguments are nil.
4071 Returns the newly created window (which is the lower or rightmost one).
4072 The upper or leftmost window is the original one, and remains selected
4073 if it was selected before.
4075 See Info node `(elisp)Splitting Windows' for more details and examples.*/)
4076 (window, size, horflag)
4077 Lisp_Object window, size, horflag;
4079 register Lisp_Object new;
4080 register struct window *o, *p;
4081 FRAME_PTR fo;
4082 register int size_int;
4084 if (NILP (window))
4085 window = selected_window;
4086 else
4087 CHECK_LIVE_WINDOW (window);
4089 o = XWINDOW (window);
4090 fo = XFRAME (WINDOW_FRAME (o));
4092 if (NILP (size))
4094 if (!NILP (horflag))
4095 /* Calculate the size of the left-hand window, by dividing
4096 the usable space in columns by two.
4097 We round up, since the left-hand window may include
4098 a dividing line, while the right-hand may not. */
4099 size_int = (XFASTINT (o->total_cols) + 1) >> 1;
4100 else
4101 size_int = XFASTINT (o->total_lines) >> 1;
4103 else
4105 CHECK_NUMBER (size);
4106 size_int = XINT (size);
4109 if (MINI_WINDOW_P (o))
4110 error ("Attempt to split minibuffer window");
4111 else if (window_fixed_size_p (o, !NILP (horflag), 0))
4112 error ("Attempt to split fixed-size window");
4114 if (NILP (horflag))
4116 int window_safe_height = window_min_size_2 (o, 0, 0);
4118 if (size_int < window_safe_height)
4119 error ("Window height %d too small (after splitting)", size_int);
4120 if (size_int + window_safe_height > XFASTINT (o->total_lines))
4121 error ("Window height %d too small (after splitting)",
4122 XFASTINT (o->total_lines) - size_int);
4123 if (NILP (o->parent)
4124 || NILP (XWINDOW (o->parent)->vchild))
4126 make_dummy_parent (window);
4127 new = o->parent;
4128 XWINDOW (new)->vchild = window;
4131 else
4133 int window_safe_width = window_min_size_2 (o, 1, 0);
4135 if (size_int < window_safe_width)
4136 error ("Window width %d too small (after splitting)", size_int);
4137 if (size_int + window_safe_width > XFASTINT (o->total_cols))
4138 error ("Window width %d too small (after splitting)",
4139 XFASTINT (o->total_cols) - size_int);
4140 if (NILP (o->parent)
4141 || NILP (XWINDOW (o->parent)->hchild))
4143 make_dummy_parent (window);
4144 new = o->parent;
4145 XWINDOW (new)->hchild = window;
4149 /* Now we know that window's parent is a vertical combination
4150 if we are dividing vertically, or a horizontal combination
4151 if we are making side-by-side windows */
4153 windows_or_buffers_changed++;
4154 FRAME_WINDOW_SIZES_CHANGED (fo) = 1;
4155 new = make_window ();
4156 p = XWINDOW (new);
4158 p->frame = o->frame;
4159 p->next = o->next;
4160 if (!NILP (p->next))
4161 XWINDOW (p->next)->prev = new;
4162 p->prev = window;
4163 o->next = new;
4164 p->parent = o->parent;
4165 p->buffer = Qt;
4166 p->window_end_valid = Qnil;
4167 bzero (&p->last_cursor, sizeof p->last_cursor);
4169 /* Duplicate special geometry settings. */
4171 p->left_margin_cols = o->left_margin_cols;
4172 p->right_margin_cols = o->right_margin_cols;
4173 p->left_fringe_width = o->left_fringe_width;
4174 p->right_fringe_width = o->right_fringe_width;
4175 p->fringes_outside_margins = o->fringes_outside_margins;
4176 p->scroll_bar_width = o->scroll_bar_width;
4177 p->vertical_scroll_bar_type = o->vertical_scroll_bar_type;
4179 /* Apportion the available frame space among the two new windows */
4181 if (!NILP (horflag))
4183 p->total_lines = o->total_lines;
4184 p->top_line = o->top_line;
4185 XSETFASTINT (p->total_cols, XFASTINT (o->total_cols) - size_int);
4186 XSETFASTINT (o->total_cols, size_int);
4187 XSETFASTINT (p->left_col, XFASTINT (o->left_col) + size_int);
4188 adjust_window_margins (p);
4189 adjust_window_margins (o);
4191 else
4193 p->left_col = o->left_col;
4194 p->total_cols = o->total_cols;
4195 XSETFASTINT (p->total_lines, XFASTINT (o->total_lines) - size_int);
4196 XSETFASTINT (o->total_lines, size_int);
4197 XSETFASTINT (p->top_line, XFASTINT (o->top_line) + size_int);
4200 /* Adjust glyph matrices. */
4201 adjust_glyphs (fo);
4203 Fset_window_buffer (new, o->buffer, Qt);
4204 return new;
4207 DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 2, "p",
4208 doc: /* Make current window ARG lines bigger.
4209 From program, optional second arg non-nil means grow sideways ARG columns.
4210 Interactively, if an argument is not given, make the window one line bigger.
4211 If HORIZONTAL is non-nil, enlarge horizontally instead of vertically.
4212 This function can delete windows, even the second window, if they get
4213 too small. */)
4214 (arg, horizontal)
4215 Lisp_Object arg, horizontal;
4217 CHECK_NUMBER (arg);
4218 enlarge_window (selected_window, XINT (arg), !NILP (horizontal));
4220 run_window_configuration_change_hook (SELECTED_FRAME ());
4222 return Qnil;
4225 DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 2, "p",
4226 doc: /* Make current window ARG lines smaller.
4227 From program, optional second arg non-nil means shrink sideways arg columns.
4228 Interactively, if an argument is not given, make the window one line smaller.
4229 Only siblings to the right or below are changed. */)
4230 (arg, side)
4231 Lisp_Object arg, side;
4233 CHECK_NUMBER (arg);
4234 enlarge_window (selected_window, -XINT (arg), !NILP (side));
4236 run_window_configuration_change_hook (SELECTED_FRAME ());
4238 return Qnil;
4242 window_height (window)
4243 Lisp_Object window;
4245 register struct window *p = XWINDOW (window);
4246 return WINDOW_TOTAL_LINES (p);
4250 window_width (window)
4251 Lisp_Object window;
4253 register struct window *p = XWINDOW (window);
4254 return WINDOW_TOTAL_COLS (p);
4258 #define CURBEG(w) \
4259 *(horiz_flag ? &(XWINDOW (w)->left_col) : &(XWINDOW (w)->top_line))
4261 #define CURSIZE(w) \
4262 *(horiz_flag ? &(XWINDOW (w)->total_cols) : &(XWINDOW (w)->total_lines))
4265 /* Enlarge WINDOW by DELTA. HORIZ_FLAG nonzero means enlarge it
4266 horizontally; zero means do it vertically.
4268 Siblings of the selected window are resized to fulfill the size
4269 request. If they become too small in the process, they may be
4270 deleted. */
4272 static void
4273 enlarge_window (window, delta, horiz_flag)
4274 Lisp_Object window;
4275 int delta, horiz_flag;
4277 Lisp_Object parent, next, prev;
4278 struct window *p;
4279 Lisp_Object *sizep;
4280 int maximum;
4281 int (*sizefun) P_ ((Lisp_Object))
4282 = horiz_flag ? window_width : window_height;
4283 void (*setsizefun) P_ ((Lisp_Object, int, int))
4284 = (horiz_flag ? set_window_width : set_window_height);
4286 /* Give up if this window cannot be resized. */
4287 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
4288 error ("Window is not resizable");
4290 /* Find the parent of the selected window. */
4291 while (1)
4293 p = XWINDOW (window);
4294 parent = p->parent;
4296 if (NILP (parent))
4298 if (horiz_flag)
4299 error ("No other window to side of this one");
4300 break;
4303 if (horiz_flag
4304 ? !NILP (XWINDOW (parent)->hchild)
4305 : !NILP (XWINDOW (parent)->vchild))
4306 break;
4308 window = parent;
4311 sizep = &CURSIZE (window);
4314 register int maxdelta;
4316 /* Compute the maximum size increment this window can have. */
4318 maxdelta = (!NILP (parent) ? (*sizefun) (parent) - XINT (*sizep)
4319 /* This is a main window followed by a minibuffer. */
4320 : !NILP (p->next) ? ((*sizefun) (p->next)
4321 - window_min_size (XWINDOW (p->next),
4322 horiz_flag, 0, 0, 0))
4323 /* This is a minibuffer following a main window. */
4324 : !NILP (p->prev) ? ((*sizefun) (p->prev)
4325 - window_min_size (XWINDOW (p->prev),
4326 horiz_flag, 0, 0, 0))
4327 /* This is a frame with only one window, a minibuffer-only
4328 or a minibufferless frame. */
4329 : (delta = 0));
4331 if (delta > maxdelta)
4332 /* This case traps trying to make the minibuffer
4333 the full frame, or make the only window aside from the
4334 minibuffer the full frame. */
4335 delta = maxdelta;
4338 if (XINT (*sizep) + delta < window_min_size (XWINDOW (window),
4339 horiz_flag, 0, 0, 0))
4341 delete_window (window);
4342 return;
4345 if (delta == 0)
4346 return;
4348 /* Find the total we can get from other siblings without deleting them. */
4349 maximum = 0;
4350 for (next = p->next; WINDOWP (next); next = XWINDOW (next)->next)
4351 maximum += (*sizefun) (next) - window_min_size (XWINDOW (next),
4352 horiz_flag, 0, 0, 0);
4353 for (prev = p->prev; WINDOWP (prev); prev = XWINDOW (prev)->prev)
4354 maximum += (*sizefun) (prev) - window_min_size (XWINDOW (prev),
4355 horiz_flag, 0, 0, 0);
4357 /* If we can get it all from them without deleting them, do so. */
4358 if (delta <= maximum)
4360 Lisp_Object first_unaffected;
4361 Lisp_Object first_affected;
4362 int fixed_p;
4364 next = p->next;
4365 prev = p->prev;
4366 first_affected = window;
4367 /* Look at one sibling at a time,
4368 moving away from this window in both directions alternately,
4369 and take as much as we can get without deleting that sibling. */
4370 while (delta != 0
4371 && (!NILP (next) || !NILP (prev)))
4373 if (! NILP (next))
4375 int this_one = ((*sizefun) (next)
4376 - window_min_size (XWINDOW (next), horiz_flag,
4377 0, 0, &fixed_p));
4378 if (!fixed_p)
4380 if (this_one > delta)
4381 this_one = delta;
4383 (*setsizefun) (next, (*sizefun) (next) - this_one, 0);
4384 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4386 delta -= this_one;
4389 next = XWINDOW (next)->next;
4392 if (delta == 0)
4393 break;
4395 if (! NILP (prev))
4397 int this_one = ((*sizefun) (prev)
4398 - window_min_size (XWINDOW (prev), horiz_flag,
4399 0, 0, &fixed_p));
4400 if (!fixed_p)
4402 if (this_one > delta)
4403 this_one = delta;
4405 first_affected = prev;
4407 (*setsizefun) (prev, (*sizefun) (prev) - this_one, 0);
4408 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4410 delta -= this_one;
4413 prev = XWINDOW (prev)->prev;
4417 xassert (delta == 0);
4419 /* Now recalculate the edge positions of all the windows affected,
4420 based on the new sizes. */
4421 first_unaffected = next;
4422 prev = first_affected;
4423 for (next = XWINDOW (prev)->next; ! EQ (next, first_unaffected);
4424 prev = next, next = XWINDOW (next)->next)
4426 XSETINT (CURBEG (next), XINT (CURBEG (prev)) + (*sizefun) (prev));
4427 /* This does not change size of NEXT,
4428 but it propagates the new top edge to its children */
4429 (*setsizefun) (next, (*sizefun) (next), 0);
4432 else
4434 register int delta1;
4435 register int opht = (*sizefun) (parent);
4437 if (opht <= XINT (*sizep) + delta)
4439 /* If trying to grow this window to or beyond size of the parent,
4440 just delete all the sibling windows. */
4441 Lisp_Object start, tem, next;
4443 start = XWINDOW (parent)->vchild;
4444 if (NILP (start))
4445 start = XWINDOW (parent)->hchild;
4447 /* Delete any siblings that come after WINDOW. */
4448 tem = XWINDOW (window)->next;
4449 while (! NILP (tem))
4451 next = XWINDOW (tem)->next;
4452 delete_window (tem);
4453 tem = next;
4456 /* Delete any siblings that come after WINDOW.
4457 Note that if START is not WINDOW, then WINDOW still
4458 has siblings, so WINDOW has not yet replaced its parent. */
4459 tem = start;
4460 while (! EQ (tem, window))
4462 next = XWINDOW (tem)->next;
4463 delete_window (tem);
4464 tem = next;
4467 else
4469 /* Otherwise, make delta1 just right so that if we add
4470 delta1 lines to this window and to the parent, and then
4471 shrink the parent back to its original size, the new
4472 proportional size of this window will increase by delta.
4474 The function size_window will compute the new height h'
4475 of the window from delta1 as:
4477 e = delta1/n
4478 x = delta1 - delta1/n * n for the 1st resizable child
4479 h' = h + e + x
4481 where n is the number of children that can be resized.
4482 We can ignore x by choosing a delta1 that is a multiple of
4483 n. We want the height of this window to come out as
4485 h' = h + delta
4487 So, delta1 must be
4489 h + e = h + delta
4490 delta1/n = delta
4491 delta1 = n * delta.
4493 The number of children n equals the number of resizable
4494 children of this window + 1 because we know window itself
4495 is resizable (otherwise we would have signalled an error).
4497 This reasoning is not correct when other windows become too
4498 small and shrink_windows refuses to delete them. Below we
4499 use resize_proportionally to work around this problem. */
4501 struct window *w = XWINDOW (window);
4502 Lisp_Object s;
4503 int n = 1;
4505 for (s = w->next; WINDOWP (s); s = XWINDOW (s)->next)
4506 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4507 ++n;
4508 for (s = w->prev; WINDOWP (s); s = XWINDOW (s)->prev)
4509 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4510 ++n;
4512 delta1 = n * delta;
4514 /* Add delta1 lines or columns to this window, and to the parent,
4515 keeping things consistent while not affecting siblings. */
4516 XSETINT (CURSIZE (parent), opht + delta1);
4517 (*setsizefun) (window, XINT (*sizep) + delta1, 0);
4519 /* Squeeze out delta1 lines or columns from our parent,
4520 shrinking this window and siblings proportionately. This
4521 brings parent back to correct size. Delta1 was calculated
4522 so this makes this window the desired size, taking it all
4523 out of the siblings.
4525 Temporarily set resize_proportionally to Qt to assure that,
4526 if necessary, shrink_windows deletes smaller windows rather
4527 than shrink this window. */
4528 w->resize_proportionally = Qt;
4529 (*setsizefun) (parent, opht, 0);
4530 w->resize_proportionally = Qnil;
4534 XSETFASTINT (p->last_modified, 0);
4535 XSETFASTINT (p->last_overlay_modified, 0);
4537 /* Adjust glyph matrices. */
4538 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4542 /* Adjust the size of WINDOW by DELTA, moving only its trailing edge.
4543 HORIZ_FLAG nonzero means adjust the width, moving the right edge.
4544 zero means adjust the height, moving the bottom edge.
4546 Following siblings of the selected window are resized to fulfill
4547 the size request. If they become too small in the process, they
4548 are not deleted; instead, we signal an error. */
4550 static void
4551 adjust_window_trailing_edge (window, delta, horiz_flag)
4552 Lisp_Object window;
4553 int delta, horiz_flag;
4555 Lisp_Object parent, child;
4556 struct window *p;
4557 Lisp_Object old_config = Fcurrent_window_configuration (Qnil);
4558 int delcount = window_deletion_count;
4560 CHECK_WINDOW (window);
4562 /* Give up if this window cannot be resized. */
4563 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
4564 error ("Window is not resizable");
4566 while (1)
4568 Lisp_Object first_parallel = Qnil;
4570 if (NILP (window))
4572 /* This happens if WINDOW on the previous iteration was
4573 at top level of the window tree. */
4574 Fset_window_configuration (old_config);
4575 error ("Specified window edge is fixed");
4578 p = XWINDOW (window);
4579 parent = p->parent;
4581 /* See if this level has windows in parallel in the specified
4582 direction. If so, set FIRST_PARALLEL to the first one. */
4583 if (horiz_flag)
4585 if (! NILP (parent) && !NILP (XWINDOW (parent)->vchild))
4586 first_parallel = XWINDOW (parent)->vchild;
4587 else if (NILP (parent) && !NILP (p->next))
4589 /* Handle the vertical chain of main window and minibuffer
4590 which has no parent. */
4591 first_parallel = window;
4592 while (! NILP (XWINDOW (first_parallel)->prev))
4593 first_parallel = XWINDOW (first_parallel)->prev;
4596 else
4598 if (! NILP (parent) && !NILP (XWINDOW (parent)->hchild))
4599 first_parallel = XWINDOW (parent)->hchild;
4602 /* If this level's succession is in the desired dimension,
4603 and this window is the last one, and there is no higher level,
4604 its trailing edge is fixed. */
4605 if (NILP (XWINDOW (window)->next) && NILP (first_parallel)
4606 && NILP (parent))
4608 Fset_window_configuration (old_config);
4609 error ("Specified window edge is fixed");
4612 /* Don't make this window too small. */
4613 if (XINT (CURSIZE (window)) + delta
4614 < window_min_size_2 (XWINDOW (window), horiz_flag, 0))
4616 Fset_window_configuration (old_config);
4617 error ("Cannot adjust window size as specified");
4620 /* Clear out some redisplay caches. */
4621 XSETFASTINT (p->last_modified, 0);
4622 XSETFASTINT (p->last_overlay_modified, 0);
4624 /* Adjust this window's edge. */
4625 XSETINT (CURSIZE (window),
4626 XINT (CURSIZE (window)) + delta);
4628 /* If this window has following siblings in the desired dimension,
4629 make them smaller, and exit the loop.
4631 (If we reach the top of the tree and can never do this,
4632 we will fail and report an error, above.) */
4633 if (NILP (first_parallel))
4635 if (!NILP (p->next))
4637 /* This may happen for the minibuffer. In that case
4638 the window_deletion_count check below does not work. */
4639 if (XINT (CURSIZE (p->next)) - delta <= 0)
4641 Fset_window_configuration (old_config);
4642 error ("Cannot adjust window size as specified");
4645 XSETINT (CURBEG (p->next),
4646 XINT (CURBEG (p->next)) + delta);
4647 size_window (p->next, XINT (CURSIZE (p->next)) - delta,
4648 horiz_flag, 0, 1, 0);
4649 break;
4652 else
4653 /* Here we have a chain of parallel siblings, in the other dimension.
4654 Change the size of the other siblings. */
4655 for (child = first_parallel;
4656 ! NILP (child);
4657 child = XWINDOW (child)->next)
4658 if (! EQ (child, window))
4659 size_window (child, XINT (CURSIZE (child)) + delta,
4660 horiz_flag, 0, 0, 1);
4662 window = parent;
4665 /* If we made a window so small it got deleted,
4666 we failed. Report failure. */
4667 if (delcount != window_deletion_count)
4669 Fset_window_configuration (old_config);
4670 error ("Cannot adjust window size as specified");
4673 /* Adjust glyph matrices. */
4674 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4677 #undef CURBEG
4678 #undef CURSIZE
4680 DEFUN ("adjust-window-trailing-edge", Fadjust_window_trailing_edge,
4681 Sadjust_window_trailing_edge, 3, 3, 0,
4682 doc: /* Adjust the bottom or right edge of WINDOW by DELTA.
4683 If HORIZONTAL is non-nil, that means adjust the width, moving the right edge.
4684 Otherwise, adjust the height, moving the bottom edge.
4686 Following siblings of the selected window are resized to fulfill
4687 the size request. If they become too small in the process, they
4688 are not deleted; instead, we signal an error. */)
4689 (window, delta, horizontal)
4690 Lisp_Object window, delta, horizontal;
4692 CHECK_NUMBER (delta);
4693 if (NILP (window))
4694 window = selected_window;
4695 adjust_window_trailing_edge (window, XINT (delta), !NILP (horizontal));
4697 run_window_configuration_change_hook
4698 (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4700 return Qnil;
4705 /***********************************************************************
4706 Resizing Mini-Windows
4707 ***********************************************************************/
4709 static void shrink_window_lowest_first P_ ((struct window *, int));
4711 enum save_restore_action
4713 CHECK_ORIG_SIZES,
4714 SAVE_ORIG_SIZES,
4715 RESTORE_ORIG_SIZES
4718 static int save_restore_orig_size P_ ((struct window *,
4719 enum save_restore_action));
4721 /* Shrink windows rooted in window W to HEIGHT. Take the space needed
4722 from lowest windows first. */
4724 static void
4725 shrink_window_lowest_first (w, height)
4726 struct window *w;
4727 int height;
4729 struct window *c;
4730 Lisp_Object child;
4731 int old_height;
4733 xassert (!MINI_WINDOW_P (w));
4735 /* Set redisplay hints. */
4736 XSETFASTINT (w->last_modified, 0);
4737 XSETFASTINT (w->last_overlay_modified, 0);
4738 windows_or_buffers_changed++;
4739 FRAME_WINDOW_SIZES_CHANGED (XFRAME (WINDOW_FRAME (w))) = 1;
4741 old_height = XFASTINT (w->total_lines);
4742 XSETFASTINT (w->total_lines, height);
4744 if (!NILP (w->hchild))
4746 for (child = w->hchild; !NILP (child); child = c->next)
4748 c = XWINDOW (child);
4749 c->top_line = w->top_line;
4750 shrink_window_lowest_first (c, height);
4753 else if (!NILP (w->vchild))
4755 Lisp_Object last_child;
4756 int delta = old_height - height;
4757 int last_top;
4759 last_child = Qnil;
4761 /* Find the last child. We are taking space from lowest windows
4762 first, so we iterate over children from the last child
4763 backwards. */
4764 for (child = w->vchild; WINDOWP (child); child = XWINDOW (child)->next)
4765 last_child = child;
4767 /* Size children down to their safe heights. */
4768 for (child = last_child; delta && !NILP (child); child = c->prev)
4770 int this_one;
4772 c = XWINDOW (child);
4773 this_one = XFASTINT (c->total_lines) - window_min_size_1 (c, 0, 1);
4775 if (this_one > delta)
4776 this_one = delta;
4778 shrink_window_lowest_first (c, XFASTINT (c->total_lines) - this_one);
4779 delta -= this_one;
4782 /* Compute new positions. */
4783 last_top = XINT (w->top_line);
4784 for (child = w->vchild; !NILP (child); child = c->next)
4786 c = XWINDOW (child);
4787 c->top_line = make_number (last_top);
4788 shrink_window_lowest_first (c, XFASTINT (c->total_lines));
4789 last_top += XFASTINT (c->total_lines);
4795 /* Save, restore, or check positions and sizes in the window tree
4796 rooted at W. ACTION says what to do.
4798 If ACTION is CHECK_ORIG_SIZES, check if orig_top_line and
4799 orig_total_lines members are valid for all windows in the window
4800 tree. Value is non-zero if they are valid.
4802 If ACTION is SAVE_ORIG_SIZES, save members top and height in
4803 orig_top_line and orig_total_lines for all windows in the tree.
4805 If ACTION is RESTORE_ORIG_SIZES, restore top and height from values
4806 stored in orig_top_line and orig_total_lines for all windows. */
4808 static int
4809 save_restore_orig_size (w, action)
4810 struct window *w;
4811 enum save_restore_action action;
4813 int success_p = 1;
4815 while (w)
4817 if (!NILP (w->hchild))
4819 if (!save_restore_orig_size (XWINDOW (w->hchild), action))
4820 success_p = 0;
4822 else if (!NILP (w->vchild))
4824 if (!save_restore_orig_size (XWINDOW (w->vchild), action))
4825 success_p = 0;
4828 switch (action)
4830 case CHECK_ORIG_SIZES:
4831 if (!INTEGERP (w->orig_top_line) || !INTEGERP (w->orig_total_lines))
4832 return 0;
4833 break;
4835 case SAVE_ORIG_SIZES:
4836 w->orig_top_line = w->top_line;
4837 w->orig_total_lines = w->total_lines;
4838 XSETFASTINT (w->last_modified, 0);
4839 XSETFASTINT (w->last_overlay_modified, 0);
4840 break;
4842 case RESTORE_ORIG_SIZES:
4843 xassert (INTEGERP (w->orig_top_line) && INTEGERP (w->orig_total_lines));
4844 w->top_line = w->orig_top_line;
4845 w->total_lines = w->orig_total_lines;
4846 w->orig_total_lines = w->orig_top_line = Qnil;
4847 XSETFASTINT (w->last_modified, 0);
4848 XSETFASTINT (w->last_overlay_modified, 0);
4849 break;
4851 default:
4852 abort ();
4855 w = NILP (w->next) ? NULL : XWINDOW (w->next);
4858 return success_p;
4862 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we can
4863 without deleting other windows. */
4865 void
4866 grow_mini_window (w, delta)
4867 struct window *w;
4868 int delta;
4870 struct frame *f = XFRAME (w->frame);
4871 struct window *root;
4873 xassert (MINI_WINDOW_P (w));
4874 xassert (delta >= 0);
4876 /* Compute how much we can enlarge the mini-window without deleting
4877 other windows. */
4878 root = XWINDOW (FRAME_ROOT_WINDOW (f));
4879 if (delta)
4881 int min_height = window_min_size (root, 0, 0, 0, 0);
4882 if (XFASTINT (root->total_lines) - delta < min_height)
4883 /* Note that the root window may already be smaller than
4884 min_height. */
4885 delta = max (0, XFASTINT (root->total_lines) - min_height);
4888 if (delta)
4890 /* Save original window sizes and positions, if not already done. */
4891 if (!save_restore_orig_size (root, CHECK_ORIG_SIZES))
4892 save_restore_orig_size (root, SAVE_ORIG_SIZES);
4894 /* Shrink other windows. */
4895 shrink_window_lowest_first (root, XFASTINT (root->total_lines) - delta);
4897 /* Grow the mini-window. */
4898 w->top_line = make_number (XFASTINT (root->top_line) + XFASTINT (root->total_lines));
4899 w->total_lines = make_number (XFASTINT (w->total_lines) + delta);
4900 XSETFASTINT (w->last_modified, 0);
4901 XSETFASTINT (w->last_overlay_modified, 0);
4903 adjust_glyphs (f);
4908 /* Shrink mini-window W. If there is recorded info about window sizes
4909 before a call to grow_mini_window, restore recorded window sizes.
4910 Otherwise, if the mini-window is higher than 1 line, resize it to 1
4911 line. */
4913 void
4914 shrink_mini_window (w)
4915 struct window *w;
4917 struct frame *f = XFRAME (w->frame);
4918 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
4920 if (save_restore_orig_size (root, CHECK_ORIG_SIZES))
4922 save_restore_orig_size (root, RESTORE_ORIG_SIZES);
4923 adjust_glyphs (f);
4924 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4925 windows_or_buffers_changed = 1;
4927 else if (XFASTINT (w->total_lines) > 1)
4929 /* Distribute the additional lines of the mini-window
4930 among the other windows. */
4931 Lisp_Object window;
4932 XSETWINDOW (window, w);
4933 enlarge_window (window, 1 - XFASTINT (w->total_lines), 0);
4939 /* Mark window cursors off for all windows in the window tree rooted
4940 at W by setting their phys_cursor_on_p flag to zero. Called from
4941 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4942 the frame are cleared. */
4944 void
4945 mark_window_cursors_off (w)
4946 struct window *w;
4948 while (w)
4950 if (!NILP (w->hchild))
4951 mark_window_cursors_off (XWINDOW (w->hchild));
4952 else if (!NILP (w->vchild))
4953 mark_window_cursors_off (XWINDOW (w->vchild));
4954 else
4955 w->phys_cursor_on_p = 0;
4957 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4962 /* Return number of lines of text (not counting mode lines) in W. */
4965 window_internal_height (w)
4966 struct window *w;
4968 int ht = XFASTINT (w->total_lines);
4970 if (!MINI_WINDOW_P (w))
4972 if (!NILP (w->parent)
4973 || !NILP (w->vchild)
4974 || !NILP (w->hchild)
4975 || !NILP (w->next)
4976 || !NILP (w->prev)
4977 || WINDOW_WANTS_MODELINE_P (w))
4978 --ht;
4980 if (WINDOW_WANTS_HEADER_LINE_P (w))
4981 --ht;
4984 return ht;
4988 /* Return the number of columns in W.
4989 Don't count columns occupied by scroll bars or the vertical bar
4990 separating W from the sibling to its right. */
4993 window_box_text_cols (w)
4994 struct window *w;
4996 struct frame *f = XFRAME (WINDOW_FRAME (w));
4997 int width = XINT (w->total_cols);
4999 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
5000 /* Scroll bars occupy a few columns. */
5001 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
5002 else if (!FRAME_WINDOW_P (f)
5003 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
5004 /* The column of `|' characters separating side-by-side windows
5005 occupies one column only. */
5006 width -= 1;
5008 if (FRAME_WINDOW_P (f))
5009 /* On window-systems, fringes and display margins cannot be
5010 used for normal text. */
5011 width -= (WINDOW_FRINGE_COLS (w)
5012 + WINDOW_LEFT_MARGIN_COLS (w)
5013 + WINDOW_RIGHT_MARGIN_COLS (w));
5015 return width;
5019 /************************************************************************
5020 Window Scrolling
5021 ***********************************************************************/
5023 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
5024 N screen-fulls, which is defined as the height of the window minus
5025 next_screen_context_lines. If WHOLE is zero, scroll up N lines
5026 instead. Negative values of N mean scroll down. NOERROR non-zero
5027 means don't signal an error if we try to move over BEGV or ZV,
5028 respectively. */
5030 static void
5031 window_scroll (window, n, whole, noerror)
5032 Lisp_Object window;
5033 int n;
5034 int whole;
5035 int noerror;
5037 immediate_quit = 1;
5039 /* If we must, use the pixel-based version which is much slower than
5040 the line-based one but can handle varying line heights. */
5041 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
5042 window_scroll_pixel_based (window, n, whole, noerror);
5043 else
5044 window_scroll_line_based (window, n, whole, noerror);
5046 immediate_quit = 0;
5050 /* Implementation of window_scroll that works based on pixel line
5051 heights. See the comment of window_scroll for parameter
5052 descriptions. */
5054 static void
5055 window_scroll_pixel_based (window, n, whole, noerror)
5056 Lisp_Object window;
5057 int n;
5058 int whole;
5059 int noerror;
5061 struct it it;
5062 struct window *w = XWINDOW (window);
5063 struct text_pos start;
5064 int this_scroll_margin;
5065 /* True if we fiddled the window vscroll field without really scrolling. */
5066 int vscrolled = 0;
5067 int x, y, rtop, rbot, rowh, vpos;
5069 SET_TEXT_POS_FROM_MARKER (start, w->start);
5071 /* If PT is not visible in WINDOW, move back one half of
5072 the screen. Allow PT to be partially visible, otherwise
5073 something like (scroll-down 1) with PT in the line before
5074 the partially visible one would recenter. */
5076 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
5078 /* Move backward half the height of the window. Performance note:
5079 vmotion used here is about 10% faster, but would give wrong
5080 results for variable height lines. */
5081 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
5082 it.current_y = it.last_visible_y;
5083 move_it_vertically_backward (&it, window_box_height (w) / 2);
5085 /* The function move_iterator_vertically may move over more than
5086 the specified y-distance. If it->w is small, e.g. a
5087 mini-buffer window, we may end up in front of the window's
5088 display area. This is the case when Start displaying at the
5089 start of the line containing PT in this case. */
5090 if (it.current_y <= 0)
5092 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
5093 move_it_vertically_backward (&it, 0);
5094 it.current_y = 0;
5097 start = it.current.pos;
5099 else if (auto_window_vscroll_p)
5101 if (rtop || rbot) /* partially visible */
5103 int px;
5104 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
5105 if (whole)
5106 dy = max ((window_box_height (w)
5107 - next_screen_context_lines * dy),
5108 dy);
5109 dy *= n;
5111 if (n < 0)
5113 /* Only vscroll backwards if already vscrolled forwards. */
5114 if (w->vscroll < 0 && rtop > 0)
5116 px = max (0, -w->vscroll - min (rtop, -dy));
5117 Fset_window_vscroll (window, make_number (px), Qt);
5118 return;
5121 if (n > 0)
5123 /* Do vscroll if already vscrolled or only display line. */
5124 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
5126 px = max (0, -w->vscroll + min (rbot, dy));
5127 Fset_window_vscroll (window, make_number (px), Qt);
5128 return;
5131 /* Maybe modify window start instead of scrolling. */
5132 if (rbot > 0 || w->vscroll < 0)
5134 int spos;
5136 Fset_window_vscroll (window, make_number (0), Qt);
5137 /* If there are other text lines above the current row,
5138 move window start to current row. Else to next row. */
5139 if (rbot > 0)
5140 spos = XINT (Fline_beginning_position (Qnil));
5141 else
5142 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
5143 set_marker_restricted (w->start, make_number (spos),
5144 w->buffer);
5145 w->start_at_line_beg = Qt;
5146 w->update_mode_line = Qt;
5147 XSETFASTINT (w->last_modified, 0);
5148 XSETFASTINT (w->last_overlay_modified, 0);
5149 /* Set force_start so that redisplay_window will run the
5150 window-scroll-functions. */
5151 w->force_start = Qt;
5152 return;
5156 /* Cancel previous vscroll. */
5157 Fset_window_vscroll (window, make_number (0), Qt);
5160 /* If scroll_preserve_screen_position is non-nil, we try to set
5161 point in the same window line as it is now, so get that line. */
5162 if (!NILP (Vscroll_preserve_screen_position))
5164 /* We preserve the goal pixel coordinate across consecutive
5165 calls to scroll-up or scroll-down. This avoids the
5166 possibility of point becoming "stuck" on a tall line when
5167 scrolling by one line. */
5168 if (window_scroll_pixel_based_preserve_y < 0
5169 || (!EQ (current_kboard->Vlast_command, Qscroll_up)
5170 && !EQ (current_kboard->Vlast_command, Qscroll_down)))
5172 start_display (&it, w, start);
5173 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
5174 window_scroll_pixel_based_preserve_y = it.current_y;
5177 else
5178 window_scroll_pixel_based_preserve_y = -1;
5180 /* Move iterator it from start the specified distance forward or
5181 backward. The result is the new window start. */
5182 start_display (&it, w, start);
5183 if (whole)
5185 int start_pos = IT_CHARPOS (it);
5186 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
5187 dy = max ((window_box_height (w)
5188 - next_screen_context_lines * dy),
5189 dy) * n;
5191 /* Note that move_it_vertically always moves the iterator to the
5192 start of a line. So, if the last line doesn't have a newline,
5193 we would end up at the start of the line ending at ZV. */
5194 if (dy <= 0)
5196 move_it_vertically_backward (&it, -dy);
5197 /* Ensure we actually do move, e.g. in case we are currently
5198 looking at an image that is taller that the window height. */
5199 while (start_pos == IT_CHARPOS (it)
5200 && start_pos > BEGV)
5201 move_it_by_lines (&it, -1, 1);
5203 else if (dy > 0)
5205 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
5206 MOVE_TO_POS | MOVE_TO_Y);
5207 /* Ensure we actually do move, e.g. in case we are currently
5208 looking at an image that is taller that the window height. */
5209 while (start_pos == IT_CHARPOS (it)
5210 && start_pos < ZV)
5211 move_it_by_lines (&it, 1, 1);
5214 else
5215 move_it_by_lines (&it, n, 1);
5217 /* We failed if we find ZV is already on the screen (scrolling up,
5218 means there's nothing past the end), or if we can't start any
5219 earlier (scrolling down, means there's nothing past the top). */
5220 if ((n > 0 && IT_CHARPOS (it) == ZV)
5221 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
5223 if (IT_CHARPOS (it) == ZV)
5225 if (it.current_y < it.last_visible_y
5226 && (it.current_y + it.max_ascent + it.max_descent
5227 > it.last_visible_y))
5229 /* The last line was only partially visible, make it fully
5230 visible. */
5231 w->vscroll = (it.last_visible_y
5232 - it.current_y + it.max_ascent + it.max_descent);
5233 adjust_glyphs (it.f);
5235 else if (noerror)
5236 return;
5237 else if (n < 0) /* could happen with empty buffers */
5238 xsignal0 (Qbeginning_of_buffer);
5239 else
5240 xsignal0 (Qend_of_buffer);
5242 else
5244 if (w->vscroll != 0)
5245 /* The first line was only partially visible, make it fully
5246 visible. */
5247 w->vscroll = 0;
5248 else if (noerror)
5249 return;
5250 else
5251 xsignal0 (Qbeginning_of_buffer);
5254 /* If control gets here, then we vscrolled. */
5256 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
5258 /* Don't try to change the window start below. */
5259 vscrolled = 1;
5262 if (! vscrolled)
5264 int pos = IT_CHARPOS (it);
5265 int bytepos;
5267 /* If in the middle of a multi-glyph character move forward to
5268 the next character. */
5269 if (in_display_vector_p (&it))
5271 ++pos;
5272 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
5275 /* Set the window start, and set up the window for redisplay. */
5276 set_marker_restricted (w->start, make_number (pos),
5277 w->buffer);
5278 bytepos = XMARKER (w->start)->bytepos;
5279 w->start_at_line_beg = ((pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n')
5280 ? Qt : Qnil);
5281 w->update_mode_line = Qt;
5282 XSETFASTINT (w->last_modified, 0);
5283 XSETFASTINT (w->last_overlay_modified, 0);
5284 /* Set force_start so that redisplay_window will run the
5285 window-scroll-functions. */
5286 w->force_start = Qt;
5289 /* The rest of this function uses current_y in a nonstandard way,
5290 not including the height of the header line if any. */
5291 it.current_y = it.vpos = 0;
5293 /* Move PT out of scroll margins.
5294 This code wants current_y to be zero at the window start position
5295 even if there is a header line. */
5296 this_scroll_margin = max (0, scroll_margin);
5297 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
5298 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
5300 if (n > 0)
5302 /* We moved the window start towards ZV, so PT may be now
5303 in the scroll margin at the top. */
5304 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
5305 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
5306 && (NILP (Vscroll_preserve_screen_position)
5307 || EQ (Vscroll_preserve_screen_position, Qt)))
5308 /* We found PT at a legitimate height. Leave it alone. */
5310 else if (window_scroll_pixel_based_preserve_y >= 0)
5312 /* If we have a header line, take account of it.
5313 This is necessary because we set it.current_y to 0, above. */
5314 move_it_to (&it, -1, -1,
5315 window_scroll_pixel_based_preserve_y
5316 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
5317 -1, MOVE_TO_Y);
5318 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5320 else
5322 while (it.current_y < this_scroll_margin)
5324 int prev = it.current_y;
5325 move_it_by_lines (&it, 1, 1);
5326 if (prev == it.current_y)
5327 break;
5329 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5332 else if (n < 0)
5334 int charpos, bytepos;
5335 int partial_p;
5337 /* Save our position, for the
5338 window_scroll_pixel_based_preserve_y case. */
5339 charpos = IT_CHARPOS (it);
5340 bytepos = IT_BYTEPOS (it);
5342 /* We moved the window start towards BEGV, so PT may be now
5343 in the scroll margin at the bottom. */
5344 move_it_to (&it, PT, -1,
5345 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
5346 - this_scroll_margin - 1),
5348 MOVE_TO_POS | MOVE_TO_Y);
5350 /* Save our position, in case it's correct. */
5351 charpos = IT_CHARPOS (it);
5352 bytepos = IT_BYTEPOS (it);
5354 /* See if point is on a partially visible line at the end. */
5355 if (it.what == IT_EOB)
5356 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
5357 else
5359 move_it_by_lines (&it, 1, 1);
5360 partial_p = it.current_y > it.last_visible_y;
5363 if (charpos == PT && !partial_p
5364 && (NILP (Vscroll_preserve_screen_position)
5365 || EQ (Vscroll_preserve_screen_position, Qt)))
5366 /* We found PT before we found the display margin, so PT is ok. */
5368 else if (window_scroll_pixel_based_preserve_y >= 0)
5370 SET_TEXT_POS_FROM_MARKER (start, w->start);
5371 start_display (&it, w, start);
5372 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
5373 here because we called start_display again and did not
5374 alter it.current_y this time. */
5375 move_it_to (&it, -1, -1, window_scroll_pixel_based_preserve_y, -1,
5376 MOVE_TO_Y);
5377 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5379 else
5381 if (partial_p)
5382 /* The last line was only partially visible, so back up two
5383 lines to make sure we're on a fully visible line. */
5385 move_it_by_lines (&it, -2, 0);
5386 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5388 else
5389 /* No, the position we saved is OK, so use it. */
5390 SET_PT_BOTH (charpos, bytepos);
5396 /* Implementation of window_scroll that works based on screen lines.
5397 See the comment of window_scroll for parameter descriptions. */
5399 static void
5400 window_scroll_line_based (window, n, whole, noerror)
5401 Lisp_Object window;
5402 int n;
5403 int whole;
5404 int noerror;
5406 register struct window *w = XWINDOW (window);
5407 register int opoint = PT, opoint_byte = PT_BYTE;
5408 register int pos, pos_byte;
5409 register int ht = window_internal_height (w);
5410 register Lisp_Object tem;
5411 int lose;
5412 Lisp_Object bolp;
5413 int startpos;
5414 struct position posit;
5415 int original_vpos;
5417 /* If scrolling screen-fulls, compute the number of lines to
5418 scroll from the window's height. */
5419 if (whole)
5420 n *= max (1, ht - next_screen_context_lines);
5422 startpos = marker_position (w->start);
5424 posit = *compute_motion (startpos, 0, 0, 0,
5425 PT, ht, 0,
5426 -1, XINT (w->hscroll),
5427 0, w);
5428 original_vpos = posit.vpos;
5430 XSETFASTINT (tem, PT);
5431 tem = Fpos_visible_in_window_p (tem, window, Qnil);
5433 if (NILP (tem))
5435 Fvertical_motion (make_number (- (ht / 2)), window);
5436 startpos = PT;
5439 SET_PT (startpos);
5440 lose = n < 0 && PT == BEGV;
5441 Fvertical_motion (make_number (n), window);
5442 pos = PT;
5443 pos_byte = PT_BYTE;
5444 bolp = Fbolp ();
5445 SET_PT_BOTH (opoint, opoint_byte);
5447 if (lose)
5449 if (noerror)
5450 return;
5451 else
5452 xsignal0 (Qbeginning_of_buffer);
5455 if (pos < ZV)
5457 int this_scroll_margin = scroll_margin;
5459 /* Don't use a scroll margin that is negative or too large. */
5460 if (this_scroll_margin < 0)
5461 this_scroll_margin = 0;
5463 if (XINT (w->total_lines) < 4 * scroll_margin)
5464 this_scroll_margin = XINT (w->total_lines) / 4;
5466 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
5467 w->start_at_line_beg = bolp;
5468 w->update_mode_line = Qt;
5469 XSETFASTINT (w->last_modified, 0);
5470 XSETFASTINT (w->last_overlay_modified, 0);
5471 /* Set force_start so that redisplay_window will run
5472 the window-scroll-functions. */
5473 w->force_start = Qt;
5475 if (!NILP (Vscroll_preserve_screen_position)
5476 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
5478 SET_PT_BOTH (pos, pos_byte);
5479 Fvertical_motion (make_number (original_vpos), window);
5481 /* If we scrolled forward, put point enough lines down
5482 that it is outside the scroll margin. */
5483 else if (n > 0)
5485 int top_margin;
5487 if (this_scroll_margin > 0)
5489 SET_PT_BOTH (pos, pos_byte);
5490 Fvertical_motion (make_number (this_scroll_margin), window);
5491 top_margin = PT;
5493 else
5494 top_margin = pos;
5496 if (top_margin <= opoint)
5497 SET_PT_BOTH (opoint, opoint_byte);
5498 else if (!NILP (Vscroll_preserve_screen_position))
5500 SET_PT_BOTH (pos, pos_byte);
5501 Fvertical_motion (make_number (original_vpos), window);
5503 else
5504 SET_PT (top_margin);
5506 else if (n < 0)
5508 int bottom_margin;
5510 /* If we scrolled backward, put point near the end of the window
5511 but not within the scroll margin. */
5512 SET_PT_BOTH (pos, pos_byte);
5513 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
5514 if (XFASTINT (tem) == ht - this_scroll_margin)
5515 bottom_margin = PT;
5516 else
5517 bottom_margin = PT + 1;
5519 if (bottom_margin > opoint)
5520 SET_PT_BOTH (opoint, opoint_byte);
5521 else
5523 if (!NILP (Vscroll_preserve_screen_position))
5525 SET_PT_BOTH (pos, pos_byte);
5526 Fvertical_motion (make_number (original_vpos), window);
5528 else
5529 Fvertical_motion (make_number (-1), window);
5533 else
5535 if (noerror)
5536 return;
5537 else
5538 xsignal0 (Qend_of_buffer);
5543 /* Scroll selected_window up or down. If N is nil, scroll a
5544 screen-full which is defined as the height of the window minus
5545 next_screen_context_lines. If N is the symbol `-', scroll.
5546 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
5547 up. This is the guts of Fscroll_up and Fscroll_down. */
5549 static void
5550 scroll_command (n, direction)
5551 Lisp_Object n;
5552 int direction;
5554 int count = SPECPDL_INDEX ();
5556 xassert (eabs (direction) == 1);
5558 /* If selected window's buffer isn't current, make it current for
5559 the moment. But don't screw up if window_scroll gets an error. */
5560 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
5562 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5563 Fset_buffer (XWINDOW (selected_window)->buffer);
5565 /* Make redisplay consider other windows than just selected_window. */
5566 ++windows_or_buffers_changed;
5569 if (NILP (n))
5570 window_scroll (selected_window, direction, 1, 0);
5571 else if (EQ (n, Qminus))
5572 window_scroll (selected_window, -direction, 1, 0);
5573 else
5575 n = Fprefix_numeric_value (n);
5576 window_scroll (selected_window, XINT (n) * direction, 0, 0);
5579 unbind_to (count, Qnil);
5582 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
5583 doc: /* Scroll text of current window upward ARG lines.
5584 If ARG is omitted or nil, scroll upward by a near full screen.
5585 A near full screen is `next-screen-context-lines' less than a full screen.
5586 Negative ARG means scroll downward.
5587 If ARG is the atom `-', scroll downward by nearly full screen.
5588 When calling from a program, supply as argument a number, nil, or `-'. */)
5589 (arg)
5590 Lisp_Object arg;
5592 scroll_command (arg, 1);
5593 return Qnil;
5596 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
5597 doc: /* Scroll text of current window down ARG lines.
5598 If ARG is omitted or nil, scroll down by a near full screen.
5599 A near full screen is `next-screen-context-lines' less than a full screen.
5600 Negative ARG means scroll upward.
5601 If ARG is the atom `-', scroll upward by nearly full screen.
5602 When calling from a program, supply as argument a number, nil, or `-'. */)
5603 (arg)
5604 Lisp_Object arg;
5606 scroll_command (arg, -1);
5607 return Qnil;
5610 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
5611 doc: /* Return the other window for \"other window scroll\" commands.
5612 If `other-window-scroll-buffer' is non-nil, a window
5613 showing that buffer is used.
5614 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5615 specifies the window. This takes precedence over
5616 `other-window-scroll-buffer'. */)
5619 Lisp_Object window;
5621 if (MINI_WINDOW_P (XWINDOW (selected_window))
5622 && !NILP (Vminibuf_scroll_window))
5623 window = Vminibuf_scroll_window;
5624 /* If buffer is specified, scroll that buffer. */
5625 else if (!NILP (Vother_window_scroll_buffer))
5627 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
5628 if (NILP (window))
5629 window = Fdisplay_buffer (Vother_window_scroll_buffer, Qt, Qnil);
5631 else
5633 /* Nothing specified; look for a neighboring window on the same
5634 frame. */
5635 window = Fnext_window (selected_window, Qnil, Qnil);
5637 if (EQ (window, selected_window))
5638 /* That didn't get us anywhere; look for a window on another
5639 visible frame. */
5641 window = Fnext_window (window, Qnil, Qt);
5642 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
5643 && ! EQ (window, selected_window));
5646 CHECK_LIVE_WINDOW (window);
5648 if (EQ (window, selected_window))
5649 error ("There is no other window");
5651 return window;
5654 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
5655 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5656 A near full screen is `next-screen-context-lines' less than a full screen.
5657 The next window is the one below the current one; or the one at the top
5658 if the current one is at the bottom. Negative ARG means scroll downward.
5659 If ARG is the atom `-', scroll downward by nearly full screen.
5660 When calling from a program, supply as argument a number, nil, or `-'.
5662 If `other-window-scroll-buffer' is non-nil, scroll the window
5663 showing that buffer, popping the buffer up if necessary.
5664 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5665 specifies the window to scroll. This takes precedence over
5666 `other-window-scroll-buffer'. */)
5667 (arg)
5668 Lisp_Object arg;
5670 Lisp_Object window;
5671 struct window *w;
5672 int count = SPECPDL_INDEX ();
5674 window = Fother_window_for_scrolling ();
5675 w = XWINDOW (window);
5677 /* Don't screw up if window_scroll gets an error. */
5678 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5679 ++windows_or_buffers_changed;
5681 Fset_buffer (w->buffer);
5682 SET_PT (marker_position (w->pointm));
5684 if (NILP (arg))
5685 window_scroll (window, 1, 1, 1);
5686 else if (EQ (arg, Qminus))
5687 window_scroll (window, -1, 1, 1);
5688 else
5690 if (CONSP (arg))
5691 arg = Fcar (arg);
5692 CHECK_NUMBER (arg);
5693 window_scroll (window, XINT (arg), 0, 1);
5696 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5697 unbind_to (count, Qnil);
5699 return Qnil;
5702 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5703 doc: /* Scroll selected window display ARG columns left.
5704 Default for ARG is window width minus 2.
5705 Value is the total amount of leftward horizontal scrolling in
5706 effect after the change.
5707 If SET_MINIMUM is non-nil, the new scroll amount becomes the
5708 lower bound for automatic scrolling, i.e. automatic scrolling
5709 will not scroll a window to a column less than the value returned
5710 by this function. This happens in an interactive call. */)
5711 (arg, set_minimum)
5712 register Lisp_Object arg, set_minimum;
5714 Lisp_Object result;
5715 int hscroll;
5716 struct window *w = XWINDOW (selected_window);
5718 if (NILP (arg))
5719 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5720 else
5721 arg = Fprefix_numeric_value (arg);
5723 hscroll = XINT (w->hscroll) + XINT (arg);
5724 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5726 if (!NILP (set_minimum))
5727 w->min_hscroll = w->hscroll;
5729 return result;
5732 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5733 doc: /* Scroll selected window display ARG columns right.
5734 Default for ARG is window width minus 2.
5735 Value is the total amount of leftward horizontal scrolling in
5736 effect after the change.
5737 If SET_MINIMUM is non-nil, the new scroll amount becomes the
5738 lower bound for automatic scrolling, i.e. automatic scrolling
5739 will not scroll a window to a column less than the value returned
5740 by this function. This happens in an interactive call. */)
5741 (arg, set_minimum)
5742 register Lisp_Object arg, set_minimum;
5744 Lisp_Object result;
5745 int hscroll;
5746 struct window *w = XWINDOW (selected_window);
5748 if (NILP (arg))
5749 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5750 else
5751 arg = Fprefix_numeric_value (arg);
5753 hscroll = XINT (w->hscroll) - XINT (arg);
5754 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5756 if (!NILP (set_minimum))
5757 w->min_hscroll = w->hscroll;
5759 return result;
5762 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5763 doc: /* Return the window which was selected when entering the minibuffer.
5764 Returns nil, if current window is not a minibuffer window. */)
5767 if (minibuf_level > 0
5768 && MINI_WINDOW_P (XWINDOW (selected_window))
5769 && WINDOW_LIVE_P (minibuf_selected_window))
5770 return minibuf_selected_window;
5772 return Qnil;
5775 /* Value is the number of lines actually displayed in window W,
5776 as opposed to its height. */
5778 static int
5779 displayed_window_lines (w)
5780 struct window *w;
5782 struct it it;
5783 struct text_pos start;
5784 int height = window_box_height (w);
5785 struct buffer *old_buffer;
5786 int bottom_y;
5788 if (XBUFFER (w->buffer) != current_buffer)
5790 old_buffer = current_buffer;
5791 set_buffer_internal (XBUFFER (w->buffer));
5793 else
5794 old_buffer = NULL;
5796 /* In case W->start is out of the accessible range, do something
5797 reasonable. This happens in Info mode when Info-scroll-down
5798 calls (recenter -1) while W->start is 1. */
5799 if (XMARKER (w->start)->charpos < BEGV)
5800 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
5801 else if (XMARKER (w->start)->charpos > ZV)
5802 SET_TEXT_POS (start, ZV, ZV_BYTE);
5803 else
5804 SET_TEXT_POS_FROM_MARKER (start, w->start);
5806 start_display (&it, w, start);
5807 move_it_vertically (&it, height);
5808 bottom_y = line_bottom_y (&it);
5810 /* rms: On a non-window display,
5811 the value of it.vpos at the bottom of the screen
5812 seems to be 1 larger than window_box_height (w).
5813 This kludge fixes a bug whereby (move-to-window-line -1)
5814 when ZV is on the last screen line
5815 moves to the previous screen line instead of the last one. */
5816 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5817 height++;
5819 /* Add in empty lines at the bottom of the window. */
5820 if (bottom_y < height)
5822 int uy = FRAME_LINE_HEIGHT (it.f);
5823 it.vpos += (height - bottom_y + uy - 1) / uy;
5826 if (old_buffer)
5827 set_buffer_internal (old_buffer);
5829 return it.vpos;
5833 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5834 doc: /* Center point in window and redisplay frame.
5835 With prefix argument ARG, recenter putting point on screen line ARG
5836 relative to the current window. If ARG is negative, it counts up from the
5837 bottom of the window. (ARG should be less than the height of the window.)
5839 If ARG is omitted or nil, erase the entire frame and then redraw with point
5840 in the center of the current window. If `auto-resize-tool-bars' is set to
5841 `grow-only', this resets the tool-bar's height to the minimum height needed.
5843 Just C-u as prefix means put point in the center of the window
5844 and redisplay normally--don't erase and redraw the frame. */)
5845 (arg)
5846 register Lisp_Object arg;
5848 struct window *w = XWINDOW (selected_window);
5849 struct buffer *buf = XBUFFER (w->buffer);
5850 struct buffer *obuf = current_buffer;
5851 int center_p = 0;
5852 int charpos, bytepos;
5853 int iarg;
5854 int this_scroll_margin;
5856 /* If redisplay is suppressed due to an error, try again. */
5857 obuf->display_error_modiff = 0;
5859 if (NILP (arg))
5861 int i;
5863 /* Invalidate pixel data calculated for all compositions. */
5864 for (i = 0; i < n_compositions; i++)
5865 composition_table[i]->font = NULL;
5867 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5869 Fredraw_frame (WINDOW_FRAME (w));
5870 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5871 center_p = 1;
5873 else if (CONSP (arg)) /* Just C-u. */
5874 center_p = 1;
5875 else
5877 arg = Fprefix_numeric_value (arg);
5878 CHECK_NUMBER (arg);
5879 iarg = XINT (arg);
5882 set_buffer_internal (buf);
5884 /* Do this after making BUF current
5885 in case scroll_margin is buffer-local. */
5886 this_scroll_margin = max (0, scroll_margin);
5887 this_scroll_margin = min (this_scroll_margin,
5888 XFASTINT (w->total_lines) / 4);
5890 /* Handle centering on a graphical frame specially. Such frames can
5891 have variable-height lines and centering point on the basis of
5892 line counts would lead to strange effects. */
5893 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5895 if (center_p)
5897 struct it it;
5898 struct text_pos pt;
5900 SET_TEXT_POS (pt, PT, PT_BYTE);
5901 start_display (&it, w, pt);
5902 move_it_vertically_backward (&it, window_box_height (w) / 2);
5903 charpos = IT_CHARPOS (it);
5904 bytepos = IT_BYTEPOS (it);
5906 else if (iarg < 0)
5908 struct it it;
5909 struct text_pos pt;
5910 int nlines = -iarg;
5911 int extra_line_spacing;
5912 int h = window_box_height (w);
5914 iarg = - max (-iarg, this_scroll_margin);
5916 SET_TEXT_POS (pt, PT, PT_BYTE);
5917 start_display (&it, w, pt);
5919 /* Be sure we have the exact height of the full line containing PT. */
5920 move_it_by_lines (&it, 0, 1);
5922 /* The amount of pixels we have to move back is the window
5923 height minus what's displayed in the line containing PT,
5924 and the lines below. */
5925 it.current_y = 0;
5926 it.vpos = 0;
5927 move_it_by_lines (&it, nlines, 1);
5929 if (it.vpos == nlines)
5930 h -= it.current_y;
5931 else
5933 /* Last line has no newline */
5934 h -= line_bottom_y (&it);
5935 it.vpos++;
5938 /* Don't reserve space for extra line spacing of last line. */
5939 extra_line_spacing = it.max_extra_line_spacing;
5941 /* If we can't move down NLINES lines because we hit
5942 the end of the buffer, count in some empty lines. */
5943 if (it.vpos < nlines)
5945 nlines -= it.vpos;
5946 extra_line_spacing = it.extra_line_spacing;
5947 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5949 if (h <= 0)
5950 return Qnil;
5952 /* Now find the new top line (starting position) of the window. */
5953 start_display (&it, w, pt);
5954 it.current_y = 0;
5955 move_it_vertically_backward (&it, h);
5957 /* If extra line spacing is present, we may move too far
5958 back. This causes the last line to be only partially
5959 visible (which triggers redisplay to recenter that line
5960 in the middle), so move forward.
5961 But ignore extra line spacing on last line, as it is not
5962 considered to be part of the visible height of the line.
5964 h += extra_line_spacing;
5965 while (-it.current_y > h)
5966 move_it_by_lines (&it, 1, 1);
5968 charpos = IT_CHARPOS (it);
5969 bytepos = IT_BYTEPOS (it);
5971 else
5973 struct position pos;
5975 iarg = max (iarg, this_scroll_margin);
5977 pos = *vmotion (PT, -iarg, w);
5978 charpos = pos.bufpos;
5979 bytepos = pos.bytepos;
5982 else
5984 struct position pos;
5985 int ht = window_internal_height (w);
5987 if (center_p)
5988 iarg = ht / 2;
5989 else if (iarg < 0)
5990 iarg += ht;
5992 /* Don't let it get into the margin at either top or bottom. */
5993 iarg = max (iarg, this_scroll_margin);
5994 iarg = min (iarg, ht - this_scroll_margin - 1);
5996 pos = *vmotion (PT, - iarg, w);
5997 charpos = pos.bufpos;
5998 bytepos = pos.bytepos;
6001 /* Set the new window start. */
6002 set_marker_both (w->start, w->buffer, charpos, bytepos);
6003 w->window_end_valid = Qnil;
6005 w->optional_new_start = Qt;
6007 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
6008 w->start_at_line_beg = Qt;
6009 else
6010 w->start_at_line_beg = Qnil;
6012 set_buffer_internal (obuf);
6013 return Qnil;
6017 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
6018 0, 1, 0,
6019 doc: /* Return the height in lines of the text display area of WINDOW.
6020 WINDOW defaults to the selected window.
6021 This doesn't include the mode-line (or header-line if any) or any
6022 partial-height lines in the text display area. */)
6023 (window)
6024 Lisp_Object window;
6026 struct window *w = decode_window (window);
6027 int pixel_height = window_box_height (w);
6028 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
6029 return make_number (line_height);
6034 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
6035 1, 1, "P",
6036 doc: /* Position point relative to window.
6037 With no argument, position point at center of window.
6038 An argument specifies vertical position within the window;
6039 zero means top of window, negative means relative to bottom of window. */)
6040 (arg)
6041 Lisp_Object arg;
6043 struct window *w = XWINDOW (selected_window);
6044 int lines, start;
6045 Lisp_Object window;
6046 #if 0
6047 int this_scroll_margin;
6048 #endif
6050 window = selected_window;
6051 start = marker_position (w->start);
6052 if (start < BEGV || start > ZV)
6054 int height = window_internal_height (w);
6055 Fvertical_motion (make_number (- (height / 2)), window);
6056 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
6057 w->start_at_line_beg = Fbolp ();
6058 w->force_start = Qt;
6060 else
6061 Fgoto_char (w->start);
6063 lines = displayed_window_lines (w);
6065 #if 0
6066 this_scroll_margin = max (0, scroll_margin);
6067 this_scroll_margin = min (this_scroll_margin, lines / 4);
6068 #endif
6070 if (NILP (arg))
6071 XSETFASTINT (arg, lines / 2);
6072 else
6074 int iarg = XINT (Fprefix_numeric_value (arg));
6076 if (iarg < 0)
6077 iarg = iarg + lines;
6079 #if 0 /* This code would prevent move-to-window-line from moving point
6080 to a place inside the scroll margins (which would cause the
6081 next redisplay to scroll). I wrote this code, but then concluded
6082 it is probably better not to install it. However, it is here
6083 inside #if 0 so as not to lose it. -- rms. */
6085 /* Don't let it get into the margin at either top or bottom. */
6086 iarg = max (iarg, this_scroll_margin);
6087 iarg = min (iarg, lines - this_scroll_margin - 1);
6088 #endif
6090 arg = make_number (iarg);
6093 /* Skip past a partially visible first line. */
6094 if (w->vscroll)
6095 XSETINT (arg, XINT (arg) + 1);
6097 return Fvertical_motion (arg, window);
6102 /***********************************************************************
6103 Window Configuration
6104 ***********************************************************************/
6106 struct save_window_data
6108 EMACS_UINT size;
6109 struct Lisp_Vector *next_from_Lisp_Vector_struct;
6110 Lisp_Object selected_frame;
6111 Lisp_Object current_window;
6112 Lisp_Object current_buffer;
6113 Lisp_Object minibuf_scroll_window;
6114 Lisp_Object minibuf_selected_window;
6115 Lisp_Object root_window;
6116 Lisp_Object focus_frame;
6117 /* A vector, each of whose elements is a struct saved_window
6118 for one window. */
6119 Lisp_Object saved_windows;
6121 /* All fields above are traced by the GC.
6122 From `fame-cols' down, the fields are ignored by the GC. */
6124 int frame_cols, frame_lines, frame_menu_bar_lines;
6125 int frame_tool_bar_lines;
6128 /* This is saved as a Lisp_Vector */
6129 struct saved_window
6131 /* these first two must agree with struct Lisp_Vector in lisp.h */
6132 EMACS_UINT size;
6133 struct Lisp_Vector *next_from_Lisp_Vector_struct;
6135 Lisp_Object window;
6136 Lisp_Object buffer, start, pointm, mark;
6137 Lisp_Object left_col, top_line, total_cols, total_lines;
6138 Lisp_Object hscroll, min_hscroll;
6139 Lisp_Object parent, prev;
6140 Lisp_Object start_at_line_beg;
6141 Lisp_Object display_table;
6142 Lisp_Object orig_top_line, orig_total_lines;
6143 Lisp_Object left_margin_cols, right_margin_cols;
6144 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
6145 Lisp_Object scroll_bar_width, vertical_scroll_bar_type;
6146 Lisp_Object dedicated, resize_proportionally;
6149 #define SAVED_WINDOW_N(swv,n) \
6150 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
6152 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
6153 doc: /* Return t if OBJECT is a window-configuration object. */)
6154 (object)
6155 Lisp_Object object;
6157 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
6160 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
6161 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
6162 (config)
6163 Lisp_Object config;
6165 register struct save_window_data *data;
6166 struct Lisp_Vector *saved_windows;
6168 CHECK_WINDOW_CONFIGURATION (config);
6170 data = (struct save_window_data *) XVECTOR (config);
6171 saved_windows = XVECTOR (data->saved_windows);
6172 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
6175 DEFUN ("set-window-configuration", Fset_window_configuration,
6176 Sset_window_configuration, 1, 1, 0,
6177 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
6178 CONFIGURATION must be a value previously returned
6179 by `current-window-configuration' (which see).
6180 If CONFIGURATION was made from a frame that is now deleted,
6181 only frame-independent values can be restored. In this case,
6182 the return value is nil. Otherwise the value is t. */)
6183 (configuration)
6184 Lisp_Object configuration;
6186 register struct save_window_data *data;
6187 struct Lisp_Vector *saved_windows;
6188 Lisp_Object new_current_buffer;
6189 Lisp_Object frame;
6190 FRAME_PTR f;
6191 int old_point = -1;
6193 CHECK_WINDOW_CONFIGURATION (configuration);
6195 data = (struct save_window_data *) XVECTOR (configuration);
6196 saved_windows = XVECTOR (data->saved_windows);
6198 new_current_buffer = data->current_buffer;
6199 if (NILP (XBUFFER (new_current_buffer)->name))
6200 new_current_buffer = Qnil;
6201 else
6203 if (XBUFFER (new_current_buffer) == current_buffer)
6204 /* The code further down "preserves point" by saving here PT in
6205 old_point and then setting it later back into PT. When the
6206 current-selected-window and the final-selected-window both show
6207 the current buffer, this suffers from the problem that the
6208 current PT is the window-point of the current-selected-window,
6209 while the final PT is the point of the final-selected-window, so
6210 this copy from one PT to the other would end up moving the
6211 window-point of the final-selected-window to the window-point of
6212 the current-selected-window. So we have to be careful which
6213 point of the current-buffer we copy into old_point. */
6214 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
6215 && WINDOWP (selected_window)
6216 && EQ (XWINDOW (selected_window)->buffer, new_current_buffer)
6217 && !EQ (selected_window, data->current_window))
6218 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
6219 else
6220 old_point = PT;
6221 else
6222 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
6223 point in new_current_buffer as of the last time this buffer was
6224 used. This can be non-deterministic since it can be changed by
6225 things like jit-lock by mere temporary selection of some random
6226 window that happens to show this buffer.
6227 So if possible we want this arbitrary choice of "which point" to
6228 be the one from the to-be-selected-window so as to prevent this
6229 window's cursor from being copied from another window. */
6230 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
6231 /* If current_window = selected_window, its point is in BUF_PT. */
6232 && !EQ (selected_window, data->current_window))
6233 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
6234 else
6235 old_point = BUF_PT (XBUFFER (new_current_buffer));
6238 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
6239 f = XFRAME (frame);
6241 /* If f is a dead frame, don't bother rebuilding its window tree.
6242 However, there is other stuff we should still try to do below. */
6243 if (FRAME_LIVE_P (f))
6245 register struct window *w;
6246 register struct saved_window *p;
6247 struct window *root_window;
6248 struct window **leaf_windows;
6249 int n_leaf_windows;
6250 int k, i, n;
6252 /* If the frame has been resized since this window configuration was
6253 made, we change the frame to the size specified in the
6254 configuration, restore the configuration, and then resize it
6255 back. We keep track of the prevailing height in these variables. */
6256 int previous_frame_lines = FRAME_LINES (f);
6257 int previous_frame_cols = FRAME_COLS (f);
6258 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6259 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6261 /* The mouse highlighting code could get screwed up
6262 if it runs during this. */
6263 BLOCK_INPUT;
6265 if (data->frame_lines != previous_frame_lines
6266 || data->frame_cols != previous_frame_cols)
6267 change_frame_size (f, data->frame_lines,
6268 data->frame_cols, 0, 0, 0);
6269 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
6270 if (data->frame_menu_bar_lines
6271 != previous_frame_menu_bar_lines)
6272 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
6273 make_number (0));
6274 #ifdef HAVE_WINDOW_SYSTEM
6275 if (data->frame_tool_bar_lines
6276 != previous_frame_tool_bar_lines)
6277 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
6278 make_number (0));
6279 #endif
6280 #endif
6282 /* "Swap out" point from the selected window's buffer
6283 into the window itself. (Normally the pointm of the selected
6284 window holds garbage.) We do this now, before
6285 restoring the window contents, and prevent it from
6286 being done later on when we select a new window. */
6287 if (! NILP (XWINDOW (selected_window)->buffer))
6289 w = XWINDOW (selected_window);
6290 set_marker_both (w->pointm,
6291 w->buffer,
6292 BUF_PT (XBUFFER (w->buffer)),
6293 BUF_PT_BYTE (XBUFFER (w->buffer)));
6296 windows_or_buffers_changed++;
6297 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
6299 /* Problem: Freeing all matrices and later allocating them again
6300 is a serious redisplay flickering problem. What we would
6301 really like to do is to free only those matrices not reused
6302 below. */
6303 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
6304 leaf_windows
6305 = (struct window **) alloca (count_windows (root_window)
6306 * sizeof (struct window *));
6307 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
6309 /* Kludge Alert!
6310 Mark all windows now on frame as "deleted".
6311 Restoring the new configuration "undeletes" any that are in it.
6313 Save their current buffers in their height fields, since we may
6314 need it later, if a buffer saved in the configuration is now
6315 dead. */
6316 delete_all_subwindows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6318 for (k = 0; k < saved_windows->size; k++)
6320 p = SAVED_WINDOW_N (saved_windows, k);
6321 w = XWINDOW (p->window);
6322 w->next = Qnil;
6324 if (!NILP (p->parent))
6325 w->parent = SAVED_WINDOW_N (saved_windows,
6326 XFASTINT (p->parent))->window;
6327 else
6328 w->parent = Qnil;
6330 if (!NILP (p->prev))
6332 w->prev = SAVED_WINDOW_N (saved_windows,
6333 XFASTINT (p->prev))->window;
6334 XWINDOW (w->prev)->next = p->window;
6336 else
6338 w->prev = Qnil;
6339 if (!NILP (w->parent))
6341 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
6343 XWINDOW (w->parent)->vchild = p->window;
6344 XWINDOW (w->parent)->hchild = Qnil;
6346 else
6348 XWINDOW (w->parent)->hchild = p->window;
6349 XWINDOW (w->parent)->vchild = Qnil;
6354 /* If we squirreled away the buffer in the window's height,
6355 restore it now. */
6356 if (BUFFERP (w->total_lines))
6357 w->buffer = w->total_lines;
6358 w->left_col = p->left_col;
6359 w->top_line = p->top_line;
6360 w->total_cols = p->total_cols;
6361 w->total_lines = p->total_lines;
6362 w->hscroll = p->hscroll;
6363 w->min_hscroll = p->min_hscroll;
6364 w->display_table = p->display_table;
6365 w->orig_top_line = p->orig_top_line;
6366 w->orig_total_lines = p->orig_total_lines;
6367 w->left_margin_cols = p->left_margin_cols;
6368 w->right_margin_cols = p->right_margin_cols;
6369 w->left_fringe_width = p->left_fringe_width;
6370 w->right_fringe_width = p->right_fringe_width;
6371 w->fringes_outside_margins = p->fringes_outside_margins;
6372 w->scroll_bar_width = p->scroll_bar_width;
6373 w->vertical_scroll_bar_type = p->vertical_scroll_bar_type;
6374 w->dedicated = p->dedicated;
6375 w->resize_proportionally = p->resize_proportionally;
6376 XSETFASTINT (w->last_modified, 0);
6377 XSETFASTINT (w->last_overlay_modified, 0);
6379 /* Reinstall the saved buffer and pointers into it. */
6380 if (NILP (p->buffer))
6381 w->buffer = p->buffer;
6382 else
6384 if (!NILP (XBUFFER (p->buffer)->name))
6385 /* If saved buffer is alive, install it. */
6387 w->buffer = p->buffer;
6388 w->start_at_line_beg = p->start_at_line_beg;
6389 set_marker_restricted (w->start, p->start, w->buffer);
6390 set_marker_restricted (w->pointm, p->pointm, w->buffer);
6391 Fset_marker (XBUFFER (w->buffer)->mark,
6392 p->mark, w->buffer);
6394 /* As documented in Fcurrent_window_configuration, don't
6395 restore the location of point in the buffer which was
6396 current when the window configuration was recorded. */
6397 if (!EQ (p->buffer, new_current_buffer)
6398 && XBUFFER (p->buffer) == current_buffer)
6399 Fgoto_char (w->pointm);
6401 else if (NILP (w->buffer) || NILP (XBUFFER (w->buffer)->name))
6402 /* Else unless window has a live buffer, get one. */
6404 w->buffer = Fcdr (Fcar (Vbuffer_alist));
6405 /* This will set the markers to beginning of visible
6406 range. */
6407 set_marker_restricted (w->start, make_number (0), w->buffer);
6408 set_marker_restricted (w->pointm, make_number (0),w->buffer);
6409 w->start_at_line_beg = Qt;
6411 else
6412 /* Keeping window's old buffer; make sure the markers
6413 are real. */
6415 /* Set window markers at start of visible range. */
6416 if (XMARKER (w->start)->buffer == 0)
6417 set_marker_restricted (w->start, make_number (0),
6418 w->buffer);
6419 if (XMARKER (w->pointm)->buffer == 0)
6420 set_marker_restricted_both (w->pointm, w->buffer,
6421 BUF_PT (XBUFFER (w->buffer)),
6422 BUF_PT_BYTE (XBUFFER (w->buffer)));
6423 w->start_at_line_beg = Qt;
6428 FRAME_ROOT_WINDOW (f) = data->root_window;
6429 /* Prevent "swapping out point" in the old selected window
6430 using the buffer that has been restored into it.
6431 We already swapped out point that from that window's old buffer. */
6432 selected_window = Qnil;
6434 /* Arrange *not* to restore point in the buffer that was
6435 current when the window configuration was saved. */
6436 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
6437 set_marker_restricted (XWINDOW (data->current_window)->pointm,
6438 make_number (old_point),
6439 XWINDOW (data->current_window)->buffer);
6441 Fselect_window (data->current_window, Qnil);
6442 XBUFFER (XWINDOW (selected_window)->buffer)->last_selected_window
6443 = selected_window;
6445 if (NILP (data->focus_frame)
6446 || (FRAMEP (data->focus_frame)
6447 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
6448 Fredirect_frame_focus (frame, data->focus_frame);
6450 #if 0 /* I don't understand why this is needed, and it causes problems
6451 when the frame's old selected window has been deleted. */
6452 if (f != selected_frame && FRAME_WINDOW_P (f))
6453 do_switch_frame (WINDOW_FRAME (XWINDOW (data->root_window)),
6454 0, 0);
6455 #endif
6457 /* Set the screen height to the value it had before this function. */
6458 if (previous_frame_lines != FRAME_LINES (f)
6459 || previous_frame_cols != FRAME_COLS (f))
6460 change_frame_size (f, previous_frame_lines, previous_frame_cols,
6461 0, 0, 0);
6462 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
6463 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
6464 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
6465 make_number (0));
6466 #ifdef HAVE_WINDOW_SYSTEM
6467 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
6468 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
6469 make_number (0));
6470 #endif
6471 #endif
6473 /* Now, free glyph matrices in windows that were not reused. */
6474 for (i = n = 0; i < n_leaf_windows; ++i)
6476 if (NILP (leaf_windows[i]->buffer))
6478 /* Assert it's not reused as a combination. */
6479 xassert (NILP (leaf_windows[i]->hchild)
6480 && NILP (leaf_windows[i]->vchild));
6481 free_window_matrices (leaf_windows[i]);
6483 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
6484 ++n;
6487 adjust_glyphs (f);
6489 UNBLOCK_INPUT;
6491 /* Fselect_window will have made f the selected frame, so we
6492 reselect the proper frame here. Fhandle_switch_frame will change the
6493 selected window too, but that doesn't make the call to
6494 Fselect_window above totally superfluous; it still sets f's
6495 selected window. */
6496 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
6497 do_switch_frame (data->selected_frame, 0, 0);
6499 run_window_configuration_change_hook (f);
6502 if (!NILP (new_current_buffer))
6503 Fset_buffer (new_current_buffer);
6505 Vminibuf_scroll_window = data->minibuf_scroll_window;
6506 minibuf_selected_window = data->minibuf_selected_window;
6508 return (FRAME_LIVE_P (f) ? Qt : Qnil);
6511 /* Mark all windows now on frame as deleted
6512 by setting their buffers to nil. */
6514 void
6515 delete_all_subwindows (w)
6516 register struct window *w;
6518 if (!NILP (w->next))
6519 delete_all_subwindows (XWINDOW (w->next));
6520 if (!NILP (w->vchild))
6521 delete_all_subwindows (XWINDOW (w->vchild));
6522 if (!NILP (w->hchild))
6523 delete_all_subwindows (XWINDOW (w->hchild));
6525 w->total_lines = w->buffer; /* See Fset_window_configuration for excuse. */
6527 if (!NILP (w->buffer))
6528 unshow_buffer (w);
6530 /* We set all three of these fields to nil, to make sure that we can
6531 distinguish this dead window from any live window. Live leaf
6532 windows will have buffer set, and combination windows will have
6533 vchild or hchild set. */
6534 w->buffer = Qnil;
6535 w->vchild = Qnil;
6536 w->hchild = Qnil;
6538 Vwindow_list = Qnil;
6541 static int
6542 count_windows (window)
6543 register struct window *window;
6545 register int count = 1;
6546 if (!NILP (window->next))
6547 count += count_windows (XWINDOW (window->next));
6548 if (!NILP (window->vchild))
6549 count += count_windows (XWINDOW (window->vchild));
6550 if (!NILP (window->hchild))
6551 count += count_windows (XWINDOW (window->hchild));
6552 return count;
6556 /* Fill vector FLAT with leaf windows under W, starting at index I.
6557 Value is last index + 1. */
6559 static int
6560 get_leaf_windows (w, flat, i)
6561 struct window *w;
6562 struct window **flat;
6563 int i;
6565 while (w)
6567 if (!NILP (w->hchild))
6568 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
6569 else if (!NILP (w->vchild))
6570 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
6571 else
6572 flat[i++] = w;
6574 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6577 return i;
6581 /* Return a pointer to the glyph W's physical cursor is on. Value is
6582 null if W's current matrix is invalid, so that no meaningfull glyph
6583 can be returned. */
6585 struct glyph *
6586 get_phys_cursor_glyph (w)
6587 struct window *w;
6589 struct glyph_row *row;
6590 struct glyph *glyph;
6592 if (w->phys_cursor.vpos >= 0
6593 && w->phys_cursor.vpos < w->current_matrix->nrows
6594 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
6595 row->enabled_p)
6596 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
6597 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
6598 else
6599 glyph = NULL;
6601 return glyph;
6605 static int
6606 save_window_save (window, vector, i)
6607 Lisp_Object window;
6608 struct Lisp_Vector *vector;
6609 int i;
6611 register struct saved_window *p;
6612 register struct window *w;
6613 register Lisp_Object tem;
6615 for (;!NILP (window); window = w->next)
6617 p = SAVED_WINDOW_N (vector, i);
6618 w = XWINDOW (window);
6620 XSETFASTINT (w->temslot, i); i++;
6621 p->window = window;
6622 p->buffer = w->buffer;
6623 p->left_col = w->left_col;
6624 p->top_line = w->top_line;
6625 p->total_cols = w->total_cols;
6626 p->total_lines = w->total_lines;
6627 p->hscroll = w->hscroll;
6628 p->min_hscroll = w->min_hscroll;
6629 p->display_table = w->display_table;
6630 p->orig_top_line = w->orig_top_line;
6631 p->orig_total_lines = w->orig_total_lines;
6632 p->left_margin_cols = w->left_margin_cols;
6633 p->right_margin_cols = w->right_margin_cols;
6634 p->left_fringe_width = w->left_fringe_width;
6635 p->right_fringe_width = w->right_fringe_width;
6636 p->fringes_outside_margins = w->fringes_outside_margins;
6637 p->scroll_bar_width = w->scroll_bar_width;
6638 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
6639 p->dedicated = w->dedicated;
6640 p->resize_proportionally = w->resize_proportionally;
6641 if (!NILP (w->buffer))
6643 /* Save w's value of point in the window configuration.
6644 If w is the selected window, then get the value of point
6645 from the buffer; pointm is garbage in the selected window. */
6646 if (EQ (window, selected_window))
6648 p->pointm = Fmake_marker ();
6649 set_marker_both (p->pointm, w->buffer,
6650 BUF_PT (XBUFFER (w->buffer)),
6651 BUF_PT_BYTE (XBUFFER (w->buffer)));
6653 else
6654 p->pointm = Fcopy_marker (w->pointm, Qnil);
6656 p->start = Fcopy_marker (w->start, Qnil);
6657 p->start_at_line_beg = w->start_at_line_beg;
6659 tem = XBUFFER (w->buffer)->mark;
6660 p->mark = Fcopy_marker (tem, Qnil);
6662 else
6664 p->pointm = Qnil;
6665 p->start = Qnil;
6666 p->mark = Qnil;
6667 p->start_at_line_beg = Qnil;
6670 if (NILP (w->parent))
6671 p->parent = Qnil;
6672 else
6673 p->parent = XWINDOW (w->parent)->temslot;
6675 if (NILP (w->prev))
6676 p->prev = Qnil;
6677 else
6678 p->prev = XWINDOW (w->prev)->temslot;
6680 if (!NILP (w->vchild))
6681 i = save_window_save (w->vchild, vector, i);
6682 if (!NILP (w->hchild))
6683 i = save_window_save (w->hchild, vector, i);
6686 return i;
6689 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
6690 Scurrent_window_configuration, 0, 1, 0,
6691 doc: /* Return an object representing the current window configuration of FRAME.
6692 If FRAME is nil or omitted, use the selected frame.
6693 This describes the number of windows, their sizes and current buffers,
6694 and for each displayed buffer, where display starts, and the positions of
6695 point and mark. An exception is made for point in the current buffer:
6696 its value is -not- saved.
6697 This also records the currently selected frame, and FRAME's focus
6698 redirection (see `redirect-frame-focus'). */)
6699 (frame)
6700 Lisp_Object frame;
6702 register Lisp_Object tem;
6703 register int n_windows;
6704 register struct save_window_data *data;
6705 register int i;
6706 FRAME_PTR f;
6708 if (NILP (frame))
6709 frame = selected_frame;
6710 CHECK_LIVE_FRAME (frame);
6711 f = XFRAME (frame);
6713 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6714 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6715 PVEC_WINDOW_CONFIGURATION);
6717 data->frame_cols = FRAME_COLS (f);
6718 data->frame_lines = FRAME_LINES (f);
6719 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6720 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6721 data->selected_frame = selected_frame;
6722 data->current_window = FRAME_SELECTED_WINDOW (f);
6723 XSETBUFFER (data->current_buffer, current_buffer);
6724 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6725 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6726 data->root_window = FRAME_ROOT_WINDOW (f);
6727 data->focus_frame = FRAME_FOCUS_FRAME (f);
6728 tem = Fmake_vector (make_number (n_windows), Qnil);
6729 data->saved_windows = tem;
6730 for (i = 0; i < n_windows; i++)
6731 XVECTOR (tem)->contents[i]
6732 = Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil);
6733 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6734 XSETWINDOW_CONFIGURATION (tem, data);
6735 return (tem);
6738 DEFUN ("save-window-excursion", Fsave_window_excursion, Ssave_window_excursion,
6739 0, UNEVALLED, 0,
6740 doc: /* Execute BODY, preserving window sizes and contents.
6741 Return the value of the last form in BODY.
6742 Restore which buffer appears in which window, where display starts,
6743 and the value of point and mark for each window.
6744 Also restore the choice of selected window.
6745 Also restore which buffer is current.
6746 Does not restore the value of point in current buffer.
6747 usage: (save-window-excursion BODY...) */)
6748 (args)
6749 Lisp_Object args;
6751 register Lisp_Object val;
6752 register int count = SPECPDL_INDEX ();
6754 record_unwind_protect (Fset_window_configuration,
6755 Fcurrent_window_configuration (Qnil));
6756 val = Fprogn (args);
6757 return unbind_to (count, val);
6762 /***********************************************************************
6763 Window Split Tree
6764 ***********************************************************************/
6766 static Lisp_Object
6767 window_tree (w)
6768 struct window *w;
6770 Lisp_Object tail = Qnil;
6771 Lisp_Object result = Qnil;
6773 while (w)
6775 Lisp_Object wn;
6777 XSETWINDOW (wn, w);
6778 if (!NILP (w->hchild))
6779 wn = Fcons (Qnil, Fcons (Fwindow_edges (wn),
6780 window_tree (XWINDOW (w->hchild))));
6781 else if (!NILP (w->vchild))
6782 wn = Fcons (Qt, Fcons (Fwindow_edges (wn),
6783 window_tree (XWINDOW (w->vchild))));
6785 if (NILP (result))
6787 result = tail = Fcons (wn, Qnil);
6789 else
6791 XSETCDR (tail, Fcons (wn, Qnil));
6792 tail = XCDR (tail);
6795 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6798 return result;
6803 DEFUN ("window-tree", Fwindow_tree, Swindow_tree,
6804 0, 1, 0,
6805 doc: /* Return the window tree for frame FRAME.
6807 The return value is a list of the form (ROOT MINI), where ROOT
6808 represents the window tree of the frame's root window, and MINI
6809 is the frame's minibuffer window.
6811 If the root window is not split, ROOT is the root window itself.
6812 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil for a
6813 horizontal split, and t for a vertical split, EDGES gives the combined
6814 size and position of the subwindows in the split, and the rest of the
6815 elements are the subwindows in the split. Each of the subwindows may
6816 again be a window or a list representing a window split, and so on.
6817 EDGES is a list \(LEFT TOP RIGHT BOTTOM) as returned by `window-edges'.
6819 If FRAME is nil or omitted, return information on the currently
6820 selected frame. */)
6821 (frame)
6822 Lisp_Object frame;
6824 FRAME_PTR f;
6826 if (NILP (frame))
6827 frame = selected_frame;
6829 CHECK_FRAME (frame);
6830 f = XFRAME (frame);
6832 if (!FRAME_LIVE_P (f))
6833 return Qnil;
6835 return window_tree (XWINDOW (FRAME_ROOT_WINDOW (f)));
6839 /***********************************************************************
6840 Marginal Areas
6841 ***********************************************************************/
6843 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6844 2, 3, 0,
6845 doc: /* Set width of marginal areas of window WINDOW.
6846 If WINDOW is nil, set margins of the currently selected window.
6847 Second arg LEFT-WIDTH specifies the number of character cells to
6848 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6849 does the same for the right marginal area. A nil width parameter
6850 means no margin. */)
6851 (window, left_width, right_width)
6852 Lisp_Object window, left_width, right_width;
6854 struct window *w = decode_window (window);
6856 /* Translate negative or zero widths to nil.
6857 Margins that are too wide have to be checked elsewhere. */
6859 if (!NILP (left_width))
6861 CHECK_NUMBER (left_width);
6862 if (XINT (left_width) <= 0)
6863 left_width = Qnil;
6866 if (!NILP (right_width))
6868 CHECK_NUMBER (right_width);
6869 if (XINT (right_width) <= 0)
6870 right_width = Qnil;
6873 if (!EQ (w->left_margin_cols, left_width)
6874 || !EQ (w->right_margin_cols, right_width))
6876 w->left_margin_cols = left_width;
6877 w->right_margin_cols = right_width;
6879 adjust_window_margins (w);
6881 ++windows_or_buffers_changed;
6882 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6885 return Qnil;
6889 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6890 0, 1, 0,
6891 doc: /* Get width of marginal areas of window WINDOW.
6892 If WINDOW is omitted or nil, use the currently selected window.
6893 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6894 If a marginal area does not exist, its width will be returned
6895 as nil. */)
6896 (window)
6897 Lisp_Object window;
6899 struct window *w = decode_window (window);
6900 return Fcons (w->left_margin_cols, w->right_margin_cols);
6905 /***********************************************************************
6906 Fringes
6907 ***********************************************************************/
6909 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6910 2, 4, 0,
6911 doc: /* Set the fringe widths of window WINDOW.
6912 If WINDOW is nil, set the fringe widths of the currently selected
6913 window.
6914 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6915 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6916 fringe width. If a fringe width arg is nil, that means to use the
6917 frame's default fringe width. Default fringe widths can be set with
6918 the command `set-fringe-style'.
6919 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6920 outside of the display margins. By default, fringes are drawn between
6921 display marginal areas and the text area. */)
6922 (window, left_width, right_width, outside_margins)
6923 Lisp_Object window, left_width, right_width, outside_margins;
6925 struct window *w = decode_window (window);
6927 if (!NILP (left_width))
6928 CHECK_NATNUM (left_width);
6929 if (!NILP (right_width))
6930 CHECK_NATNUM (right_width);
6932 /* Do nothing on a tty. */
6933 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6934 && (!EQ (w->left_fringe_width, left_width)
6935 || !EQ (w->right_fringe_width, right_width)
6936 || !EQ (w->fringes_outside_margins, outside_margins)))
6938 w->left_fringe_width = left_width;
6939 w->right_fringe_width = right_width;
6940 w->fringes_outside_margins = outside_margins;
6942 adjust_window_margins (w);
6944 clear_glyph_matrix (w->current_matrix);
6945 w->window_end_valid = Qnil;
6947 ++windows_or_buffers_changed;
6948 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6951 return Qnil;
6955 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6956 0, 1, 0,
6957 doc: /* Get width of fringes of window WINDOW.
6958 If WINDOW is omitted or nil, use the currently selected window.
6959 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6960 (window)
6961 Lisp_Object window;
6963 struct window *w = decode_window (window);
6965 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6966 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6967 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6968 ? Qt : Qnil), Qnil)));
6973 /***********************************************************************
6974 Scroll bars
6975 ***********************************************************************/
6977 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars, Sset_window_scroll_bars,
6978 2, 4, 0,
6979 doc: /* Set width and type of scroll bars of window WINDOW.
6980 If window is nil, set scroll bars of the currently selected window.
6981 Second parameter WIDTH specifies the pixel width for the scroll bar;
6982 this is automatically adjusted to a multiple of the frame column width.
6983 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6984 bar: left, right, or nil.
6985 If WIDTH is nil, use the frame's scroll-bar width.
6986 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6987 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6988 (window, width, vertical_type, horizontal_type)
6989 Lisp_Object window, width, vertical_type, horizontal_type;
6991 struct window *w = decode_window (window);
6993 if (!NILP (width))
6995 CHECK_NATNUM (width);
6997 if (XINT (width) == 0)
6998 vertical_type = Qnil;
7001 if (!(NILP (vertical_type)
7002 || EQ (vertical_type, Qleft)
7003 || EQ (vertical_type, Qright)
7004 || EQ (vertical_type, Qt)))
7005 error ("Invalid type of vertical scroll bar");
7007 if (!EQ (w->scroll_bar_width, width)
7008 || !EQ (w->vertical_scroll_bar_type, vertical_type))
7010 w->scroll_bar_width = width;
7011 w->vertical_scroll_bar_type = vertical_type;
7013 adjust_window_margins (w);
7015 clear_glyph_matrix (w->current_matrix);
7016 w->window_end_valid = Qnil;
7018 ++windows_or_buffers_changed;
7019 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
7022 return Qnil;
7026 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
7027 0, 1, 0,
7028 doc: /* Get width and type of scroll bars of window WINDOW.
7029 If WINDOW is omitted or nil, use the currently selected window.
7030 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
7031 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
7032 value. */)
7033 (window)
7034 Lisp_Object window;
7036 struct window *w = decode_window (window);
7037 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
7038 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
7039 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
7040 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
7041 Fcons (w->vertical_scroll_bar_type,
7042 Fcons (Qnil, Qnil))));
7047 /***********************************************************************
7048 Smooth scrolling
7049 ***********************************************************************/
7051 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
7052 doc: /* Return the amount by which WINDOW is scrolled vertically.
7053 Use the selected window if WINDOW is nil or omitted.
7054 Normally, value is a multiple of the canonical character height of WINDOW;
7055 optional second arg PIXELS-P means value is measured in pixels. */)
7056 (window, pixels_p)
7057 Lisp_Object window, pixels_p;
7059 Lisp_Object result;
7060 struct frame *f;
7061 struct window *w;
7063 if (NILP (window))
7064 window = selected_window;
7065 else
7066 CHECK_WINDOW (window);
7067 w = XWINDOW (window);
7068 f = XFRAME (w->frame);
7070 if (FRAME_WINDOW_P (f))
7071 result = (NILP (pixels_p)
7072 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
7073 : make_number (-w->vscroll));
7074 else
7075 result = make_number (0);
7076 return result;
7080 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
7081 2, 3, 0,
7082 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
7083 WINDOW nil means use the selected window. Normally, VSCROLL is a
7084 non-negative multiple of the canonical character height of WINDOW;
7085 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
7086 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
7087 corresponds to an integral number of pixels. The return value is the
7088 result of this rounding.
7089 If PIXELS-P is non-nil, the return value is VSCROLL. */)
7090 (window, vscroll, pixels_p)
7091 Lisp_Object window, vscroll, pixels_p;
7093 struct window *w;
7094 struct frame *f;
7096 if (NILP (window))
7097 window = selected_window;
7098 else
7099 CHECK_WINDOW (window);
7100 CHECK_NUMBER_OR_FLOAT (vscroll);
7102 w = XWINDOW (window);
7103 f = XFRAME (w->frame);
7105 if (FRAME_WINDOW_P (f))
7107 int old_dy = w->vscroll;
7109 w->vscroll = - (NILP (pixels_p)
7110 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
7111 : XFLOATINT (vscroll));
7112 w->vscroll = min (w->vscroll, 0);
7114 if (w->vscroll != old_dy)
7116 /* Adjust glyph matrix of the frame if the virtual display
7117 area becomes larger than before. */
7118 if (w->vscroll < 0 && w->vscroll < old_dy)
7119 adjust_glyphs (f);
7121 /* Prevent redisplay shortcuts. */
7122 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
7126 return Fwindow_vscroll (window, pixels_p);
7130 /* Call FN for all leaf windows on frame F. FN is called with the
7131 first argument being a pointer to the leaf window, and with
7132 additional argument USER_DATA. Stops when FN returns 0. */
7134 void
7135 foreach_window (f, fn, user_data)
7136 struct frame *f;
7137 int (* fn) P_ ((struct window *, void *));
7138 void *user_data;
7140 /* Fdelete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
7141 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
7142 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
7146 /* Helper function for foreach_window. Call FN for all leaf windows
7147 reachable from W. FN is called with the first argument being a
7148 pointer to the leaf window, and with additional argument USER_DATA.
7149 Stop when FN returns 0. Value is 0 if stopped by FN. */
7151 static int
7152 foreach_window_1 (w, fn, user_data)
7153 struct window *w;
7154 int (* fn) P_ ((struct window *, void *));
7155 void *user_data;
7157 int cont;
7159 for (cont = 1; w && cont;)
7161 if (!NILP (w->hchild))
7162 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
7163 else if (!NILP (w->vchild))
7164 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
7165 else
7166 cont = fn (w, user_data);
7168 w = NILP (w->next) ? 0 : XWINDOW (w->next);
7171 return cont;
7175 /* Freeze or unfreeze the window start of W unless it is a
7176 mini-window or the selected window. FREEZE_P non-null means freeze
7177 the window start. */
7179 static int
7180 freeze_window_start (w, freeze_p)
7181 struct window *w;
7182 void *freeze_p;
7184 if (MINI_WINDOW_P (w)
7185 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
7186 && (w == XWINDOW (selected_window)
7187 || (MINI_WINDOW_P (XWINDOW (selected_window))
7188 && ! NILP (Vminibuf_scroll_window)
7189 && w == XWINDOW (Vminibuf_scroll_window)))))
7190 freeze_p = NULL;
7192 w->frozen_window_start_p = freeze_p != NULL;
7193 return 1;
7197 /* Freeze or unfreeze the window starts of all leaf windows on frame
7198 F, except the selected window and a mini-window. FREEZE_P non-zero
7199 means freeze the window start. */
7201 void
7202 freeze_window_starts (f, freeze_p)
7203 struct frame *f;
7204 int freeze_p;
7206 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
7210 /***********************************************************************
7211 Initialization
7212 ***********************************************************************/
7214 /* Return 1 if window configurations C1 and C2
7215 describe the same state of affairs. This is used by Fequal. */
7218 compare_window_configurations (c1, c2, ignore_positions)
7219 Lisp_Object c1, c2;
7220 int ignore_positions;
7222 register struct save_window_data *d1, *d2;
7223 struct Lisp_Vector *sw1, *sw2;
7224 int i;
7226 CHECK_WINDOW_CONFIGURATION (c1);
7227 CHECK_WINDOW_CONFIGURATION (c2);
7229 d1 = (struct save_window_data *) XVECTOR (c1);
7230 d2 = (struct save_window_data *) XVECTOR (c2);
7231 sw1 = XVECTOR (d1->saved_windows);
7232 sw2 = XVECTOR (d2->saved_windows);
7234 if (d1->frame_cols != d2->frame_cols)
7235 return 0;
7236 if (d1->frame_lines != d2->frame_lines)
7237 return 0;
7238 if (d1->frame_menu_bar_lines != d2->frame_menu_bar_lines)
7239 return 0;
7240 if (! EQ (d1->selected_frame, d2->selected_frame))
7241 return 0;
7242 /* Don't compare the current_window field directly.
7243 Instead see w1_is_current and w2_is_current, below. */
7244 if (! EQ (d1->current_buffer, d2->current_buffer))
7245 return 0;
7246 if (! ignore_positions)
7248 if (! EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window))
7249 return 0;
7250 if (! EQ (d1->minibuf_selected_window, d2->minibuf_selected_window))
7251 return 0;
7253 /* Don't compare the root_window field.
7254 We don't require the two configurations
7255 to use the same window object,
7256 and the two root windows must be equivalent
7257 if everything else compares equal. */
7258 if (! EQ (d1->focus_frame, d2->focus_frame))
7259 return 0;
7261 /* Verify that the two confis have the same number of windows. */
7262 if (sw1->size != sw2->size)
7263 return 0;
7265 for (i = 0; i < sw1->size; i++)
7267 struct saved_window *p1, *p2;
7268 int w1_is_current, w2_is_current;
7270 p1 = SAVED_WINDOW_N (sw1, i);
7271 p2 = SAVED_WINDOW_N (sw2, i);
7273 /* Verify that the current windows in the two
7274 configurations correspond to each other. */
7275 w1_is_current = EQ (d1->current_window, p1->window);
7276 w2_is_current = EQ (d2->current_window, p2->window);
7278 if (w1_is_current != w2_is_current)
7279 return 0;
7281 /* Verify that the corresponding windows do match. */
7282 if (! EQ (p1->buffer, p2->buffer))
7283 return 0;
7284 if (! EQ (p1->left_col, p2->left_col))
7285 return 0;
7286 if (! EQ (p1->top_line, p2->top_line))
7287 return 0;
7288 if (! EQ (p1->total_cols, p2->total_cols))
7289 return 0;
7290 if (! EQ (p1->total_lines, p2->total_lines))
7291 return 0;
7292 if (! EQ (p1->display_table, p2->display_table))
7293 return 0;
7294 if (! EQ (p1->parent, p2->parent))
7295 return 0;
7296 if (! EQ (p1->prev, p2->prev))
7297 return 0;
7298 if (! ignore_positions)
7300 if (! EQ (p1->hscroll, p2->hscroll))
7301 return 0;
7302 if (!EQ (p1->min_hscroll, p2->min_hscroll))
7303 return 0;
7304 if (! EQ (p1->start_at_line_beg, p2->start_at_line_beg))
7305 return 0;
7306 if (NILP (Fequal (p1->start, p2->start)))
7307 return 0;
7308 if (NILP (Fequal (p1->pointm, p2->pointm)))
7309 return 0;
7310 if (NILP (Fequal (p1->mark, p2->mark)))
7311 return 0;
7313 if (! EQ (p1->left_margin_cols, p2->left_margin_cols))
7314 return 0;
7315 if (! EQ (p1->right_margin_cols, p2->right_margin_cols))
7316 return 0;
7317 if (! EQ (p1->left_fringe_width, p2->left_fringe_width))
7318 return 0;
7319 if (! EQ (p1->right_fringe_width, p2->right_fringe_width))
7320 return 0;
7321 if (! EQ (p1->fringes_outside_margins, p2->fringes_outside_margins))
7322 return 0;
7323 if (! EQ (p1->scroll_bar_width, p2->scroll_bar_width))
7324 return 0;
7325 if (! EQ (p1->vertical_scroll_bar_type, p2->vertical_scroll_bar_type))
7326 return 0;
7329 return 1;
7332 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
7333 Scompare_window_configurations, 2, 2, 0,
7334 doc: /* Compare two window configurations as regards the structure of windows.
7335 This function ignores details such as the values of point and mark
7336 and scrolling positions. */)
7337 (x, y)
7338 Lisp_Object x, y;
7340 if (compare_window_configurations (x, y, 1))
7341 return Qt;
7342 return Qnil;
7345 void
7346 init_window_once ()
7348 struct frame *f = make_initial_frame ();
7349 XSETFRAME (selected_frame, f);
7350 Vterminal_frame = selected_frame;
7351 minibuf_window = f->minibuffer_window;
7352 selected_window = f->selected_window;
7353 last_nonminibuf_frame = f;
7355 window_initialized = 1;
7358 void
7359 init_window ()
7361 Vwindow_list = Qnil;
7364 void
7365 syms_of_window ()
7367 Qscroll_up = intern ("scroll-up");
7368 staticpro (&Qscroll_up);
7370 Qscroll_down = intern ("scroll-down");
7371 staticpro (&Qscroll_down);
7373 Qwindow_size_fixed = intern ("window-size-fixed");
7374 staticpro (&Qwindow_size_fixed);
7375 Fset (Qwindow_size_fixed, Qnil);
7377 staticpro (&Qwindow_configuration_change_hook);
7378 Qwindow_configuration_change_hook
7379 = intern ("window-configuration-change-hook");
7381 Qwindowp = intern ("windowp");
7382 staticpro (&Qwindowp);
7384 Qwindow_configuration_p = intern ("window-configuration-p");
7385 staticpro (&Qwindow_configuration_p);
7387 Qwindow_live_p = intern ("window-live-p");
7388 staticpro (&Qwindow_live_p);
7390 Qtemp_buffer_show_hook = intern ("temp-buffer-show-hook");
7391 staticpro (&Qtemp_buffer_show_hook);
7393 staticpro (&Vwindow_list);
7395 minibuf_selected_window = Qnil;
7396 staticpro (&minibuf_selected_window);
7398 window_scroll_pixel_based_preserve_y = -1;
7400 DEFVAR_LISP ("temp-buffer-show-function", &Vtemp_buffer_show_function,
7401 doc: /* Non-nil means call as function to display a help buffer.
7402 The function is called with one argument, the buffer to be displayed.
7403 Used by `with-output-to-temp-buffer'.
7404 If this function is used, then it must do the entire job of showing
7405 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
7406 Vtemp_buffer_show_function = Qnil;
7408 DEFVAR_LISP ("display-buffer-function", &Vdisplay_buffer_function,
7409 doc: /* If non-nil, function to call to handle `display-buffer'.
7410 It will receive two args, the buffer and a flag which if non-nil means
7411 that the currently selected window is not acceptable.
7412 It should choose or create a window, display the specified buffer in it,
7413 and return the window.
7414 Commands such as `switch-to-buffer-other-window' and `find-file-other-window'
7415 work using this function. */);
7416 Vdisplay_buffer_function = Qnil;
7418 DEFVAR_LISP ("even-window-heights", &Veven_window_heights,
7419 doc: /* *If non-nil, `display-buffer' should even the window heights.
7420 If nil, `display-buffer' will leave the window configuration alone. */);
7421 Veven_window_heights = Qt;
7423 DEFVAR_LISP ("minibuffer-scroll-window", &Vminibuf_scroll_window,
7424 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
7425 Vminibuf_scroll_window = Qnil;
7427 DEFVAR_BOOL ("mode-line-in-non-selected-windows", &mode_line_in_non_selected_windows,
7428 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
7429 If the minibuffer is active, the `minibuffer-scroll-window' mode line
7430 is displayed in the `mode-line' face. */);
7431 mode_line_in_non_selected_windows = 1;
7433 DEFVAR_LISP ("other-window-scroll-buffer", &Vother_window_scroll_buffer,
7434 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
7435 Vother_window_scroll_buffer = Qnil;
7437 DEFVAR_BOOL ("pop-up-frames", &pop_up_frames,
7438 doc: /* *Non-nil means `display-buffer' should make a separate frame. */);
7439 pop_up_frames = 0;
7441 DEFVAR_BOOL ("auto-window-vscroll", &auto_window_vscroll_p,
7442 doc: /* *Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
7443 auto_window_vscroll_p = 1;
7445 DEFVAR_BOOL ("display-buffer-reuse-frames", &display_buffer_reuse_frames,
7446 doc: /* *Non-nil means `display-buffer' should reuse frames.
7447 If the buffer in question is already displayed in a frame, raise that frame. */);
7448 display_buffer_reuse_frames = 0;
7450 DEFVAR_LISP ("pop-up-frame-function", &Vpop_up_frame_function,
7451 doc: /* Function to call to handle automatic new frame creation.
7452 It is called with no arguments and should return a newly created frame.
7454 A typical value might be `(lambda () (new-frame pop-up-frame-alist))'
7455 where `pop-up-frame-alist' would hold the default frame parameters. */);
7456 Vpop_up_frame_function = Qnil;
7458 DEFVAR_LISP ("special-display-buffer-names", &Vspecial_display_buffer_names,
7459 doc: /* *List of buffer names that should have their own special frames.
7460 Displaying a buffer with `display-buffer' or `pop-to-buffer',
7461 if its name is in this list, makes a special frame for it
7462 using `special-display-function'. See also `special-display-regexps'.
7464 An element of the list can be a list instead of just a string.
7465 There are two ways to use a list as an element:
7466 (BUFFER FRAME-PARAMETERS...) (BUFFER FUNCTION OTHER-ARGS...)
7467 In the first case, the FRAME-PARAMETERS are pairs of the form
7468 \(PARAMETER . VALUE); these parameter values are used to create the frame.
7469 In the second case, FUNCTION is called with BUFFER as the first argument,
7470 followed by the OTHER-ARGS--it can display BUFFER in any way it likes.
7471 All this is done by the function found in `special-display-function'.
7473 If the specified frame parameters include (same-buffer . t), the
7474 buffer is displayed in the currently selected window. Otherwise, if
7475 they include (same-frame . t), the buffer is displayed in a new window
7476 in the currently selected frame.
7478 If this variable appears \"not to work\", because you add a name to it
7479 but that buffer still appears in the selected window, look at the
7480 values of `same-window-buffer-names' and `same-window-regexps'.
7481 Those variables take precedence over this one. */);
7482 Vspecial_display_buffer_names = Qnil;
7484 DEFVAR_LISP ("special-display-regexps", &Vspecial_display_regexps,
7485 doc: /* *List of regexps saying which buffers should have their own special frames.
7486 When displaying a buffer with `display-buffer' or `pop-to-buffer',
7487 if any regexp in this list matches the buffer name, it makes a
7488 special frame for the buffer by calling `special-display-function'.
7490 An element of the list can be a list instead of just a string.
7491 There are two ways to use a list as an element:
7492 (REGEXP FRAME-PARAMETERS...) (REGEXP FUNCTION OTHER-ARGS...)
7493 In the first case, the FRAME-PARAMETERS are pairs of the form
7494 \(PARAMETER . VALUE); these parameter values are used to create the frame.
7495 In the second case, FUNCTION is called with BUFFER as the first argument,
7496 followed by the OTHER-ARGS--it can display the buffer in any way it likes.
7497 All this is done by the function found in `special-display-function'.
7499 If the specified frame parameters include (same-buffer . t), the
7500 buffer is displayed in the currently selected window. Otherwise, if
7501 they include (same-frame . t), the buffer is displayed in a new window
7502 in the currently selected frame.
7504 If this variable appears \"not to work\", because you add a regexp to it
7505 but the matching buffers still appear in the selected window, look at the
7506 values of `same-window-buffer-names' and `same-window-regexps'.
7507 Those variables take precedence over this one. */);
7508 Vspecial_display_regexps = Qnil;
7510 DEFVAR_LISP ("special-display-function", &Vspecial_display_function,
7511 doc: /* Function to call to make a new frame for a special buffer.
7512 It is called with two arguments, the buffer and optional buffer specific
7513 data, and should return a window displaying that buffer.
7514 The default value normally makes a separate frame for the buffer,
7515 using `special-display-frame-alist' to specify the frame parameters.
7516 But if the buffer specific data includes (same-buffer . t) then the
7517 buffer is displayed in the current selected window.
7518 Otherwise if it includes (same-frame . t) then the buffer is displayed in
7519 a new window in the currently selected frame.
7521 A buffer is special if it is listed in `special-display-buffer-names'
7522 or matches a regexp in `special-display-regexps'. */);
7523 Vspecial_display_function = Qnil;
7525 DEFVAR_LISP ("same-window-buffer-names", &Vsame_window_buffer_names,
7526 doc: /* *List of buffer names that should appear in the selected window.
7527 Displaying one of these buffers using `display-buffer' or `pop-to-buffer'
7528 switches to it in the selected window, rather than making it appear
7529 in some other window.
7531 An element of the list can be a cons cell instead of just a string.
7532 Then the car must be a string, which specifies the buffer name.
7533 This is for compatibility with `special-display-buffer-names';
7534 the cdr of the cons cell is ignored.
7536 See also `same-window-regexps'. */);
7537 Vsame_window_buffer_names = Qnil;
7539 DEFVAR_LISP ("same-window-regexps", &Vsame_window_regexps,
7540 doc: /* *List of regexps saying which buffers should appear in the selected window.
7541 If a buffer name matches one of these regexps, then displaying it
7542 using `display-buffer' or `pop-to-buffer' switches to it
7543 in the selected window, rather than making it appear in some other window.
7545 An element of the list can be a cons cell instead of just a string.
7546 Then the car must be a string, which specifies the buffer name.
7547 This is for compatibility with `special-display-buffer-names';
7548 the cdr of the cons cell is ignored.
7550 See also `same-window-buffer-names'. */);
7551 Vsame_window_regexps = Qnil;
7553 DEFVAR_BOOL ("pop-up-windows", &pop_up_windows,
7554 doc: /* *Non-nil means display-buffer should make new windows. */);
7555 pop_up_windows = 1;
7557 DEFVAR_INT ("next-screen-context-lines", &next_screen_context_lines,
7558 doc: /* *Number of lines of continuity when scrolling by screenfuls. */);
7559 next_screen_context_lines = 2;
7561 DEFVAR_INT ("split-height-threshold", &split_height_threshold,
7562 doc: /* *A window must be at least this tall to be eligible for splitting
7563 by `display-buffer'. The value is in line units.
7564 If there is only one window, it is split regardless of this value. */);
7565 split_height_threshold = 500;
7567 DEFVAR_LISP ("split-window-preferred-function",
7568 &Vsplit_window_preferred_function,
7569 doc: /* Function to use to split a window.
7570 This is used by `display-buffer' to allow the user to choose whether
7571 to split windows horizontally or vertically or some mix of the two.
7572 When this variable is nil, `display-buffer' splits windows vertically.
7573 Otherwise, `display-buffer' calls this function to split a window.
7574 It is called with a window as single argument and should split it in two
7575 and return the new window, or return an appropriate existing window
7576 if splitting is not eligible. */);
7577 Vsplit_window_preferred_function = Qnil;
7579 DEFVAR_INT ("window-min-height", &window_min_height,
7580 doc: /* Allow deleting windows less than this tall.
7581 The value is measured in line units. If a window wants a modeline it
7582 is counted as one line.
7584 Emacs honors settings of this variable when enlarging or shrinking
7585 windows vertically. A value less than 1 is invalid. */);
7586 window_min_height = 4;
7588 DEFVAR_INT ("window-min-width", &window_min_width,
7589 doc: /* Allow deleting windows less than this wide.
7590 The value is measured in characters and includes any fringes or
7591 the scrollbar.
7593 Emacs honors settings of this variable when enlarging or shrinking
7594 windows horizontally. A value less than 2 is invalid. */);
7595 window_min_width = 10;
7597 DEFVAR_LISP ("scroll-preserve-screen-position",
7598 &Vscroll_preserve_screen_position,
7599 doc: /* *Controls if scroll commands move point to keep its screen line unchanged.
7600 A value of nil means point does not keep its screen position except
7601 at the scroll margin or window boundary respectively.
7602 A value of t means point keeps its screen position if the scroll
7603 command moved it vertically out of the window, e.g. when scrolling
7604 by full screens.
7605 Any other value means point always keeps its screen position. */);
7606 Vscroll_preserve_screen_position = Qnil;
7608 DEFVAR_LISP ("window-configuration-change-hook",
7609 &Vwindow_configuration_change_hook,
7610 doc: /* Functions to call when window configuration changes.
7611 The buffer-local part is run once per window, with the relevant window
7612 selected; while the global part is run only once for the modified frame,
7613 with the relevant frame selected. */);
7614 Vwindow_configuration_change_hook = Qnil;
7616 defsubr (&Sselected_window);
7617 defsubr (&Sminibuffer_window);
7618 defsubr (&Swindow_minibuffer_p);
7619 defsubr (&Swindowp);
7620 defsubr (&Swindow_live_p);
7621 defsubr (&Spos_visible_in_window_p);
7622 defsubr (&Swindow_line_height);
7623 defsubr (&Swindow_buffer);
7624 defsubr (&Swindow_height);
7625 defsubr (&Swindow_width);
7626 defsubr (&Swindow_full_width_p);
7627 defsubr (&Swindow_hscroll);
7628 defsubr (&Sset_window_hscroll);
7629 defsubr (&Swindow_redisplay_end_trigger);
7630 defsubr (&Sset_window_redisplay_end_trigger);
7631 defsubr (&Swindow_edges);
7632 defsubr (&Swindow_pixel_edges);
7633 defsubr (&Swindow_inside_edges);
7634 defsubr (&Swindow_inside_pixel_edges);
7635 defsubr (&Scoordinates_in_window_p);
7636 defsubr (&Swindow_at);
7637 defsubr (&Swindow_point);
7638 defsubr (&Swindow_start);
7639 defsubr (&Swindow_end);
7640 defsubr (&Sset_window_point);
7641 defsubr (&Sset_window_start);
7642 defsubr (&Swindow_dedicated_p);
7643 defsubr (&Sset_window_dedicated_p);
7644 defsubr (&Swindow_display_table);
7645 defsubr (&Sset_window_display_table);
7646 defsubr (&Snext_window);
7647 defsubr (&Sprevious_window);
7648 defsubr (&Sother_window);
7649 defsubr (&Sget_lru_window);
7650 defsubr (&Sget_largest_window);
7651 defsubr (&Sget_buffer_window);
7652 defsubr (&Sdelete_other_windows);
7653 defsubr (&Sdelete_windows_on);
7654 defsubr (&Sreplace_buffer_in_windows);
7655 defsubr (&Sdelete_window);
7656 defsubr (&Sset_window_buffer);
7657 defsubr (&Sselect_window);
7658 defsubr (&Sspecial_display_p);
7659 defsubr (&Ssame_window_p);
7660 defsubr (&Sdisplay_buffer);
7661 defsubr (&Sforce_window_update);
7662 defsubr (&Ssplit_window);
7663 defsubr (&Senlarge_window);
7664 defsubr (&Sshrink_window);
7665 defsubr (&Sadjust_window_trailing_edge);
7666 defsubr (&Sscroll_up);
7667 defsubr (&Sscroll_down);
7668 defsubr (&Sscroll_left);
7669 defsubr (&Sscroll_right);
7670 defsubr (&Sother_window_for_scrolling);
7671 defsubr (&Sscroll_other_window);
7672 defsubr (&Sminibuffer_selected_window);
7673 defsubr (&Srecenter);
7674 defsubr (&Swindow_text_height);
7675 defsubr (&Smove_to_window_line);
7676 defsubr (&Swindow_configuration_p);
7677 defsubr (&Swindow_configuration_frame);
7678 defsubr (&Sset_window_configuration);
7679 defsubr (&Scurrent_window_configuration);
7680 defsubr (&Ssave_window_excursion);
7681 defsubr (&Swindow_tree);
7682 defsubr (&Sset_window_margins);
7683 defsubr (&Swindow_margins);
7684 defsubr (&Sset_window_fringes);
7685 defsubr (&Swindow_fringes);
7686 defsubr (&Sset_window_scroll_bars);
7687 defsubr (&Swindow_scroll_bars);
7688 defsubr (&Swindow_vscroll);
7689 defsubr (&Sset_window_vscroll);
7690 defsubr (&Scompare_window_configurations);
7691 defsubr (&Swindow_list);
7694 void
7695 keys_of_window ()
7697 initial_define_key (control_x_map, '1', "delete-other-windows");
7698 initial_define_key (control_x_map, '2', "split-window");
7699 initial_define_key (control_x_map, '0', "delete-window");
7700 initial_define_key (control_x_map, 'o', "other-window");
7701 initial_define_key (control_x_map, '^', "enlarge-window");
7702 initial_define_key (control_x_map, '<', "scroll-left");
7703 initial_define_key (control_x_map, '>', "scroll-right");
7705 initial_define_key (global_map, Ctl ('V'), "scroll-up");
7706 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
7707 initial_define_key (meta_map, 'v', "scroll-down");
7709 initial_define_key (global_map, Ctl('L'), "recenter");
7710 initial_define_key (meta_map, 'r', "move-to-window-line");
7713 /* arch-tag: 90a9c576-0590-48f1-a5f1-6c96a0452d9f
7714 (do not change this comment) */