(select_frame_norecord): New function.
[emacs.git] / src / window.c
blob9f71a17c696dded813b37c33f47c9190dd79f738
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 2000,
4 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
5 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <stdio.h>
25 #include "lisp.h"
26 #include "buffer.h"
27 #include "keyboard.h"
28 #include "keymap.h"
29 #include "frame.h"
30 #include "window.h"
31 #include "commands.h"
32 #include "indent.h"
33 #include "termchar.h"
34 #include "disptab.h"
35 #include "dispextern.h"
36 #include "blockinput.h"
37 #include "intervals.h"
38 #include "termhooks.h" /* For FRAME_TERMINAL. */
40 #ifdef HAVE_X_WINDOWS
41 #include "xterm.h"
42 #endif /* HAVE_X_WINDOWS */
43 #ifdef WINDOWSNT
44 #include "w32term.h"
45 #endif
46 #ifdef MSDOS
47 #include "msdos.h"
48 #endif
49 #ifdef HAVE_NS
50 #include "nsterm.h"
51 #endif
54 Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
55 Lisp_Object Qdisplay_buffer;
56 Lisp_Object Qscroll_up, Qscroll_down;
57 Lisp_Object Qwindow_size_fixed;
59 extern Lisp_Object Qleft_margin, Qright_margin;
61 static int displayed_window_lines P_ ((struct window *));
62 static struct window *decode_window P_ ((Lisp_Object));
63 static int count_windows P_ ((struct window *));
64 static int get_leaf_windows P_ ((struct window *, struct window **, int));
65 static void window_scroll P_ ((Lisp_Object, int, int, int));
66 static void window_scroll_pixel_based P_ ((Lisp_Object, int, int, int));
67 static void window_scroll_line_based P_ ((Lisp_Object, int, int, int));
68 static int window_min_size_1 P_ ((struct window *, int, int));
69 static int window_min_size_2 P_ ((struct window *, int, int));
70 static int window_min_size P_ ((struct window *, int, int, int, int *));
71 static void size_window P_ ((Lisp_Object, int, int, int, int, int));
72 static int freeze_window_start P_ ((struct window *, void *));
73 static int window_fixed_size_p P_ ((struct window *, int, int));
74 static void enlarge_window P_ ((Lisp_Object, int, int));
75 static Lisp_Object window_list P_ ((void));
76 static int add_window_to_list P_ ((struct window *, void *));
77 static int candidate_window_p P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
78 Lisp_Object));
79 static Lisp_Object next_window P_ ((Lisp_Object, Lisp_Object,
80 Lisp_Object, int));
81 static void decode_next_window_args P_ ((Lisp_Object *, Lisp_Object *,
82 Lisp_Object *));
83 static int foreach_window_1 P_ ((struct window *,
84 int (* fn) (struct window *, void *),
85 void *));
86 static Lisp_Object window_list_1 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
88 /* This is the window in which the terminal's cursor should
89 be left when nothing is being done with it. This must
90 always be a leaf window, and its buffer is selected by
91 the top level editing loop at the end of each command.
93 This value is always the same as
94 FRAME_SELECTED_WINDOW (selected_frame). */
96 Lisp_Object selected_window;
98 /* A list of all windows for use by next_window and Fwindow_list.
99 Functions creating or deleting windows should invalidate this cache
100 by setting it to nil. */
102 Lisp_Object Vwindow_list;
104 /* The mini-buffer window of the selected frame.
105 Note that you cannot test for mini-bufferness of an arbitrary window
106 by comparing against this; but you can test for mini-bufferness of
107 the selected window. */
109 Lisp_Object minibuf_window;
111 /* Non-nil means it is the window whose mode line should be
112 shown as the selected window when the minibuffer is selected. */
114 Lisp_Object minibuf_selected_window;
116 /* Non-nil means it is the window for C-M-v to scroll
117 when the mini-buffer is selected. */
119 Lisp_Object Vminibuf_scroll_window;
121 /* Non-nil means this is the buffer whose window C-M-v should scroll. */
123 Lisp_Object Vother_window_scroll_buffer;
125 /* Non-nil means it's function to call to display temp buffers. */
127 Lisp_Object Vtemp_buffer_show_function;
129 /* Non-zero means line and page scrolling on tall lines (with images)
130 does partial scrolling by modifying window-vscroll. */
132 int auto_window_vscroll_p;
134 /* Non-zero means to use mode-line-inactive face in all windows but the
135 selected-window and the minibuffer-scroll-window when the
136 minibuffer is active. */
137 int mode_line_in_non_selected_windows;
139 /* If a window gets smaller than either of these, it is removed. */
141 EMACS_INT window_min_height;
142 EMACS_INT window_min_width;
144 /* Hook run at end of temp_output_buffer_show. */
146 Lisp_Object Qtemp_buffer_show_hook;
148 /* Number of lines of continuity in scrolling by screenfuls. */
150 EMACS_INT next_screen_context_lines;
152 /* Incremented for each window created. */
154 static int sequence_number;
156 /* Nonzero after init_window_once has finished. */
158 static int window_initialized;
160 /* Hook to run when window config changes. */
162 static Lisp_Object Qwindow_configuration_change_hook;
163 static Lisp_Object Vwindow_configuration_change_hook;
165 /* Non-nil means scroll commands try to put point
166 at the same screen height as previously. */
168 Lisp_Object Vscroll_preserve_screen_position;
170 /* Non-nil means that text is inserted before window's markers. */
172 Lisp_Object Vwindow_point_insertion_type;
174 /* Incremented by 1 whenever a window is deleted. */
176 int window_deletion_count;
178 /* Used by the function window_scroll_pixel_based */
180 static int window_scroll_pixel_based_preserve_x;
181 static int window_scroll_pixel_based_preserve_y;
183 /* Same for window_scroll_line_based. */
185 static int window_scroll_preserve_hpos;
186 static int window_scroll_preserve_vpos;
188 #if 0 /* This isn't used anywhere. */
189 /* Nonzero means we can split a frame even if it is "unsplittable". */
190 static int inhibit_frame_unsplittable;
191 #endif /* 0 */
193 extern EMACS_INT scroll_margin;
195 extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
197 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
198 doc: /* Return t if OBJECT is a window. */)
199 (object)
200 Lisp_Object object;
202 return WINDOWP (object) ? Qt : Qnil;
205 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
206 doc: /* Return t if OBJECT is a window which is currently visible. */)
207 (object)
208 Lisp_Object object;
210 return WINDOW_LIVE_P (object) ? Qt : Qnil;
213 Lisp_Object
214 make_window ()
216 Lisp_Object val;
217 register struct window *p;
219 p = allocate_window ();
220 ++sequence_number;
221 XSETFASTINT (p->sequence_number, sequence_number);
222 XSETFASTINT (p->left_col, 0);
223 XSETFASTINT (p->top_line, 0);
224 XSETFASTINT (p->total_lines, 0);
225 XSETFASTINT (p->total_cols, 0);
226 XSETFASTINT (p->hscroll, 0);
227 XSETFASTINT (p->min_hscroll, 0);
228 p->orig_top_line = p->orig_total_lines = Qnil;
229 p->start = Fmake_marker ();
230 p->pointm = Fmake_marker ();
231 XSETFASTINT (p->use_time, 0);
232 p->frame = Qnil;
233 p->display_table = Qnil;
234 p->dedicated = Qnil;
235 p->window_parameters = Qnil;
236 p->pseudo_window_p = 0;
237 bzero (&p->cursor, sizeof (p->cursor));
238 bzero (&p->last_cursor, sizeof (p->last_cursor));
239 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
240 p->desired_matrix = p->current_matrix = 0;
241 p->nrows_scale_factor = p->ncols_scale_factor = 1;
242 p->phys_cursor_type = -1;
243 p->phys_cursor_width = -1;
244 p->must_be_updated_p = 0;
245 XSETFASTINT (p->window_end_vpos, 0);
246 XSETFASTINT (p->window_end_pos, 0);
247 p->window_end_valid = Qnil;
248 p->vscroll = 0;
249 XSETWINDOW (val, p);
250 XSETFASTINT (p->last_point, 0);
251 p->frozen_window_start_p = 0;
252 p->last_cursor_off_p = p->cursor_off_p = 0;
253 p->left_margin_cols = Qnil;
254 p->right_margin_cols = Qnil;
255 p->left_fringe_width = Qnil;
256 p->right_fringe_width = Qnil;
257 p->fringes_outside_margins = Qnil;
258 p->scroll_bar_width = Qnil;
259 p->vertical_scroll_bar_type = Qt;
260 p->resize_proportionally = Qnil;
262 Vwindow_list = Qnil;
263 return val;
266 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
267 doc: /* Return the window that the cursor now appears in and commands apply to. */)
270 return selected_window;
273 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
274 doc: /* Return the window used now for minibuffers.
275 If the optional argument FRAME is specified, return the minibuffer window
276 used by that frame. */)
277 (frame)
278 Lisp_Object frame;
280 if (NILP (frame))
281 frame = selected_frame;
282 CHECK_LIVE_FRAME (frame);
283 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
286 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
287 doc: /* Return non-nil if WINDOW is a minibuffer window.
288 WINDOW defaults to the selected window. */)
289 (window)
290 Lisp_Object window;
292 struct window *w = decode_window (window);
293 return MINI_WINDOW_P (w) ? Qt : Qnil;
297 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
298 Spos_visible_in_window_p, 0, 3, 0,
299 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
300 Return nil if that position is scrolled vertically out of view.
301 If a character is only partially visible, nil is returned, unless the
302 optional argument PARTIALLY is non-nil.
303 If POS is only out of view because of horizontal scrolling, return non-nil.
304 If POS is t, it specifies the position of the last visible glyph in WINDOW.
305 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
307 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
308 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
309 where X and Y are the pixel coordinates relative to the top left corner
310 of the window. The remaining elements are omitted if the character after
311 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
312 off-window at the top and bottom of the row, ROWH is the height of the
313 display row, and VPOS is the row number (0-based) containing POS. */)
314 (pos, window, partially)
315 Lisp_Object pos, window, partially;
317 register struct window *w;
318 register int posint;
319 register struct buffer *buf;
320 struct text_pos top;
321 Lisp_Object in_window = Qnil;
322 int rtop, rbot, rowh, vpos, fully_p = 1;
323 int x, y;
325 w = decode_window (window);
326 buf = XBUFFER (w->buffer);
327 SET_TEXT_POS_FROM_MARKER (top, w->start);
329 if (EQ (pos, Qt))
330 posint = -1;
331 else if (!NILP (pos))
333 CHECK_NUMBER_COERCE_MARKER (pos);
334 posint = XINT (pos);
336 else if (w == XWINDOW (selected_window))
337 posint = PT;
338 else
339 posint = XMARKER (w->pointm)->charpos;
341 /* If position is above window start or outside buffer boundaries,
342 or if window start is out of range, position is not visible. */
343 if ((EQ (pos, Qt)
344 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
345 && CHARPOS (top) >= BUF_BEGV (buf)
346 && CHARPOS (top) <= BUF_ZV (buf)
347 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
348 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
349 in_window = Qt;
351 if (!NILP (in_window) && !NILP (partially))
353 Lisp_Object part = Qnil;
354 if (!fully_p)
355 part = list4 (make_number (rtop), make_number (rbot),
356 make_number (rowh), make_number (vpos));
357 in_window = Fcons (make_number (x),
358 Fcons (make_number (y), part));
361 return in_window;
364 DEFUN ("window-line-height", Fwindow_line_height,
365 Swindow_line_height, 0, 2, 0,
366 doc: /* Return height in pixels of text line LINE in window WINDOW.
367 If WINDOW is nil or omitted, use selected window.
369 Return height of current line if LINE is omitted or nil. Return height of
370 header or mode line if LINE is `header-line' and `mode-line'.
371 Otherwise, LINE is a text line number starting from 0. A negative number
372 counts from the end of the window.
374 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
375 in pixels of the visible part of the line, VPOS and YPOS are the
376 vertical position in lines and pixels of the line, relative to the top
377 of the first text line, and OFFBOT is the number of off-window pixels at
378 the bottom of the text line. If there are off-window pixels at the top
379 of the (first) text line, YPOS is negative.
381 Return nil if window display is not up-to-date. In that case, use
382 `pos-visible-in-window-p' to obtain the information. */)
383 (line, window)
384 Lisp_Object line, window;
386 register struct window *w;
387 register struct buffer *b;
388 struct glyph_row *row, *end_row;
389 int max_y, crop, i, n;
391 w = decode_window (window);
393 if (noninteractive
394 || w->pseudo_window_p)
395 return Qnil;
397 CHECK_BUFFER (w->buffer);
398 b = XBUFFER (w->buffer);
400 /* Fail if current matrix is not up-to-date. */
401 if (NILP (w->window_end_valid)
402 || current_buffer->clip_changed
403 || current_buffer->prevent_redisplay_optimizations_p
404 || XFASTINT (w->last_modified) < BUF_MODIFF (b)
405 || XFASTINT (w->last_overlay_modified) < BUF_OVERLAY_MODIFF (b))
406 return Qnil;
408 if (NILP (line))
410 i = w->cursor.vpos;
411 if (i < 0 || i >= w->current_matrix->nrows
412 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
413 return Qnil;
414 max_y = window_text_bottom_y (w);
415 goto found_row;
418 if (EQ (line, Qheader_line))
420 if (!WINDOW_WANTS_HEADER_LINE_P (w))
421 return Qnil;
422 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
423 if (!row->enabled_p)
424 return Qnil;
425 return list4 (make_number (row->height),
426 make_number (0), make_number (0),
427 make_number (0));
430 if (EQ (line, Qmode_line))
432 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
433 if (!row->enabled_p)
434 return Qnil;
435 return list4 (make_number (row->height),
436 make_number (0), /* not accurate */
437 make_number (WINDOW_HEADER_LINE_HEIGHT (w)
438 + window_text_bottom_y (w)),
439 make_number (0));
442 CHECK_NUMBER (line);
443 n = XINT (line);
445 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
446 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
447 max_y = window_text_bottom_y (w);
448 i = 0;
450 while ((n < 0 || i < n)
451 && row <= end_row && row->enabled_p
452 && row->y + row->height < max_y)
453 row++, i++;
455 if (row > end_row || !row->enabled_p)
456 return Qnil;
458 if (++n < 0)
460 if (-n > i)
461 return Qnil;
462 row += n;
463 i += n;
466 found_row:
467 crop = max (0, (row->y + row->height) - max_y);
468 return list4 (make_number (row->height + min (0, row->y) - crop),
469 make_number (i),
470 make_number (row->y),
471 make_number (crop));
476 static struct window *
477 decode_window (window)
478 register Lisp_Object window;
480 if (NILP (window))
481 return XWINDOW (selected_window);
483 CHECK_LIVE_WINDOW (window);
484 return XWINDOW (window);
487 static struct window *
488 decode_any_window (window)
489 register Lisp_Object window;
491 if (NILP (window))
492 return XWINDOW (selected_window);
494 CHECK_WINDOW (window);
495 return XWINDOW (window);
498 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
499 doc: /* Return the buffer that WINDOW is displaying.
500 WINDOW defaults to the selected window. */)
501 (window)
502 Lisp_Object window;
504 return decode_window (window)->buffer;
507 DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
508 doc: /* Return the number of lines in WINDOW.
509 WINDOW defaults to the selected window.
511 The return value includes WINDOW's mode line and header line, if any. */)
512 (window)
513 Lisp_Object window;
515 return decode_any_window (window)->total_lines;
518 DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
519 doc: /* Return the number of display columns in WINDOW.
520 WINDOW defaults to the selected window.
522 Note: The return value is the number of columns available for text in
523 WINDOW. If you want to find out how many columns WINDOW takes up, use
524 (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))). */)
525 (window)
526 Lisp_Object window;
528 return make_number (window_box_text_cols (decode_any_window (window)));
531 DEFUN ("window-full-width-p", Fwindow_full_width_p, Swindow_full_width_p, 0, 1, 0,
532 doc: /* Return t if WINDOW is as wide as its frame.
533 WINDOW defaults to the selected window. */)
534 (window)
535 Lisp_Object window;
537 return WINDOW_FULL_WIDTH_P (decode_any_window (window)) ? Qt : Qnil;
540 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
541 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
542 WINDOW defaults to the selected window. */)
543 (window)
544 Lisp_Object window;
546 return decode_window (window)->hscroll;
549 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
550 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
551 Return NCOL. NCOL should be zero or positive.
553 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
554 window so that the location of point moves off-window. */)
555 (window, ncol)
556 Lisp_Object window, ncol;
558 struct window *w = decode_window (window);
559 int hscroll;
561 CHECK_NUMBER (ncol);
562 hscroll = max (0, XINT (ncol));
564 /* Prevent redisplay shortcuts when changing the hscroll. */
565 if (XINT (w->hscroll) != hscroll)
566 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
568 w->hscroll = make_number (hscroll);
569 return ncol;
572 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
573 Swindow_redisplay_end_trigger, 0, 1, 0,
574 doc: /* Return WINDOW's redisplay end trigger value.
575 WINDOW defaults to the selected window.
576 See `set-window-redisplay-end-trigger' for more information. */)
577 (window)
578 Lisp_Object window;
580 return decode_window (window)->redisplay_end_trigger;
583 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
584 Sset_window_redisplay_end_trigger, 2, 2, 0,
585 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
586 VALUE should be a buffer position (typically a marker) or nil.
587 If it is a buffer position, then if redisplay in WINDOW reaches a position
588 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
589 with two arguments: WINDOW, and the end trigger value.
590 Afterwards the end-trigger value is reset to nil. */)
591 (window, value)
592 register Lisp_Object window, value;
594 register struct window *w;
596 w = decode_window (window);
597 w->redisplay_end_trigger = value;
598 return value;
601 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
602 doc: /* Return a list of the edge coordinates of WINDOW.
603 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
604 RIGHT is one more than the rightmost column occupied by WINDOW,
605 and BOTTOM is one more than the bottommost row occupied by WINDOW.
606 The edges include the space used by the window's scroll bar,
607 display margins, fringes, header line, and mode line, if it has them.
608 To get the edges of the actual text area, use `window-inside-edges'. */)
609 (window)
610 Lisp_Object window;
612 register struct window *w = decode_any_window (window);
614 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
615 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
616 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
617 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
618 Qnil))));
621 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
622 doc: /* Return a list of the edge pixel coordinates of WINDOW.
623 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
624 RIGHT is one more than the rightmost x position occupied by WINDOW,
625 and BOTTOM is one more than the bottommost y position occupied by WINDOW.
626 The pixel edges include the space used by the window's scroll bar,
627 display margins, fringes, header line, and mode line, if it has them.
628 To get the edges of the actual text area, use `window-inside-pixel-edges'. */)
629 (window)
630 Lisp_Object window;
632 register struct window *w = decode_any_window (window);
634 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
635 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
636 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
637 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
638 Qnil))));
641 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
642 doc: /* Return a list of the edge coordinates of WINDOW.
643 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
644 RIGHT is one more than the rightmost column used by text in WINDOW,
645 and BOTTOM is one more than the bottommost row used by text in WINDOW.
646 The inside edges do not include the space used by the window's scroll bar,
647 display margins, fringes, header line, and/or mode line. */)
648 (window)
649 Lisp_Object window;
651 register struct window *w = decode_any_window (window);
653 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
654 + WINDOW_LEFT_MARGIN_COLS (w)
655 + WINDOW_LEFT_FRINGE_COLS (w)),
656 make_number (WINDOW_TOP_EDGE_LINE (w)
657 + WINDOW_HEADER_LINE_LINES (w)),
658 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
659 - WINDOW_RIGHT_MARGIN_COLS (w)
660 - WINDOW_RIGHT_FRINGE_COLS (w)),
661 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
662 - WINDOW_MODE_LINE_LINES (w)));
665 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
666 doc: /* Return a list of the edge pixel coordinates of WINDOW.
667 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
668 RIGHT is one more than the rightmost x position used by text in WINDOW,
669 and BOTTOM is one more than the bottommost y position used by text in WINDOW.
670 The inside edges do not include the space used by the window's scroll bar,
671 display margins, fringes, header line, and/or mode line. */)
672 (window)
673 Lisp_Object window;
675 register struct window *w = decode_any_window (window);
677 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
678 + WINDOW_LEFT_MARGIN_WIDTH (w)
679 + WINDOW_LEFT_FRINGE_WIDTH (w)),
680 make_number (WINDOW_TOP_EDGE_Y (w)
681 + WINDOW_HEADER_LINE_HEIGHT (w)),
682 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
683 - WINDOW_RIGHT_MARGIN_WIDTH (w)
684 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
685 make_number (WINDOW_BOTTOM_EDGE_Y (w)
686 - WINDOW_MODE_LINE_HEIGHT (w)));
689 /* Test if the character at column *X, row *Y is within window W.
690 If it is not, return ON_NOTHING;
691 if it is in the window's text area,
692 set *x and *y to its location relative to the upper left corner
693 of the window, and
694 return ON_TEXT;
695 if it is on the window's modeline, return ON_MODE_LINE;
696 if it is on the border between the window and its right sibling,
697 return ON_VERTICAL_BORDER.
698 if it is on a scroll bar,
699 return ON_SCROLL_BAR.
700 if it is on the window's top line, return ON_HEADER_LINE;
701 if it is in left or right fringe of the window,
702 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE, and convert *X and *Y
703 to window-relative coordinates;
704 if it is in the marginal area to the left/right of the window,
705 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN, and convert *X and *Y
706 to window-relative coordinates.
708 X and Y are frame relative pixel coordinates. */
710 static enum window_part
711 coordinates_in_window (w, x, y)
712 register struct window *w;
713 register int *x, *y;
715 struct frame *f = XFRAME (WINDOW_FRAME (w));
716 int left_x, right_x, top_y, bottom_y;
717 enum window_part part;
718 int ux = FRAME_COLUMN_WIDTH (f);
719 int x0 = WINDOW_LEFT_EDGE_X (w);
720 int x1 = WINDOW_RIGHT_EDGE_X (w);
721 /* The width of the area where the vertical line can be dragged.
722 (Between mode lines for instance. */
723 int grabbable_width = ux;
724 int lmargin_width, rmargin_width, text_left, text_right;
726 /* In what's below, we subtract 1 when computing right_x because we
727 want the rightmost pixel, which is given by left_pixel+width-1. */
728 if (w->pseudo_window_p)
730 left_x = 0;
731 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
732 top_y = WINDOW_TOP_EDGE_Y (w);
733 bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
735 else
737 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
738 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
739 top_y = WINDOW_TOP_EDGE_Y (w);
740 bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
743 /* Outside any interesting row? */
744 if (*y < top_y || *y >= bottom_y)
745 return ON_NOTHING;
747 /* On the mode line or header line? If it's near the start of
748 the mode or header line of window that's has a horizontal
749 sibling, say it's on the vertical line. That's to be able
750 to resize windows horizontally in case we're using toolkit
751 scroll bars. */
753 if (WINDOW_WANTS_MODELINE_P (w)
754 && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
756 part = ON_MODE_LINE;
758 header_vertical_border_check:
759 /* We're somewhere on the mode line. We consider the place
760 between mode lines of horizontally adjacent mode lines
761 as the vertical border. If scroll bars on the left,
762 return the right window. */
763 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
764 || WINDOW_RIGHTMOST_P (w))
766 if (!WINDOW_LEFTMOST_P (w) && eabs (*x - x0) < grabbable_width)
768 /* Convert X and Y to window relative coordinates.
769 Vertical border is at the left edge of window. */
770 *x = max (0, *x - x0);
771 *y -= top_y;
772 return ON_VERTICAL_BORDER;
775 else
777 if (eabs (*x - x1) < grabbable_width)
779 /* Convert X and Y to window relative coordinates.
780 Vertical border is at the right edge of window. */
781 *x = min (x1, *x) - x0;
782 *y -= top_y;
783 return ON_VERTICAL_BORDER;
787 if (*x < x0 || *x >= x1)
788 return ON_NOTHING;
790 /* Convert X and Y to window relative coordinates.
791 Mode line starts at left edge of window. */
792 *x -= x0;
793 *y -= top_y;
794 return part;
797 if (WINDOW_WANTS_HEADER_LINE_P (w)
798 && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
800 part = ON_HEADER_LINE;
801 goto header_vertical_border_check;
804 if (*x < x0 || *x >= x1)
805 return ON_NOTHING;
807 /* Outside any interesting column? */
808 if (*x < left_x || *x > right_x)
810 *y -= top_y;
811 return ON_SCROLL_BAR;
814 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
815 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
817 text_left = window_box_left (w, TEXT_AREA);
818 text_right = text_left + window_box_width (w, TEXT_AREA);
820 if (FRAME_WINDOW_P (f))
822 if (!w->pseudo_window_p
823 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
824 && !WINDOW_RIGHTMOST_P (w)
825 && (eabs (*x - right_x) < grabbable_width))
827 /* Convert X and Y to window relative coordinates.
828 Vertical border is at the right edge of window. */
829 *x = min (right_x, *x) - left_x;
830 *y -= top_y;
831 return ON_VERTICAL_BORDER;
834 else
836 /* Need to say "*x > right_x" rather than >=, since on character
837 terminals, the vertical line's x coordinate is right_x. */
838 if (!w->pseudo_window_p
839 && !WINDOW_RIGHTMOST_P (w)
840 && *x > right_x - ux)
842 /* On the border on the right side of the window? Assume that
843 this area begins at RIGHT_X minus a canonical char width. */
844 *x = min (right_x, *x) - left_x;
845 *y -= top_y;
846 return ON_VERTICAL_BORDER;
850 if (*x < text_left)
852 if (lmargin_width > 0
853 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
854 ? (*x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
855 : (*x < left_x + lmargin_width)))
857 *x -= left_x;
858 if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
859 *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
860 *y -= top_y;
861 return ON_LEFT_MARGIN;
864 /* Convert X and Y to window-relative pixel coordinates. */
865 *x -= left_x;
866 *y -= top_y;
867 return ON_LEFT_FRINGE;
870 if (*x >= text_right)
872 if (rmargin_width > 0
873 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
874 ? (*x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
875 : (*x >= right_x - rmargin_width)))
877 *x -= right_x - rmargin_width;
878 if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
879 *x += WINDOW_RIGHT_FRINGE_WIDTH (w);
880 *y -= top_y;
881 return ON_RIGHT_MARGIN;
884 /* Convert X and Y to window-relative pixel coordinates. */
885 *x -= left_x + WINDOW_LEFT_FRINGE_WIDTH (w);
886 *y -= top_y;
887 return ON_RIGHT_FRINGE;
890 /* Everything special ruled out - must be on text area */
891 *x -= text_left;
892 *y -= top_y;
893 return ON_TEXT;
897 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
898 Scoordinates_in_window_p, 2, 2, 0,
899 doc: /* Return non-nil if COORDINATES are in WINDOW.
900 COORDINATES is a cons of the form (X . Y), X and Y being distances
901 measured in characters from the upper-left corner of the frame.
902 \(0 . 0) denotes the character in the upper left corner of the
903 frame.
904 If COORDINATES are in the text portion of WINDOW,
905 the coordinates relative to the window are returned.
906 If they are in the mode line of WINDOW, `mode-line' is returned.
907 If they are in the top mode line of WINDOW, `header-line' is returned.
908 If they are in the left fringe of WINDOW, `left-fringe' is returned.
909 If they are in the right fringe of WINDOW, `right-fringe' is returned.
910 If they are on the border between WINDOW and its right sibling,
911 `vertical-line' is returned.
912 If they are in the windows's left or right marginal areas, `left-margin'\n\
913 or `right-margin' is returned. */)
914 (coordinates, window)
915 register Lisp_Object coordinates, window;
917 struct window *w;
918 struct frame *f;
919 int x, y;
920 Lisp_Object lx, ly;
922 CHECK_WINDOW (window);
923 w = XWINDOW (window);
924 f = XFRAME (w->frame);
925 CHECK_CONS (coordinates);
926 lx = Fcar (coordinates);
927 ly = Fcdr (coordinates);
928 CHECK_NUMBER_OR_FLOAT (lx);
929 CHECK_NUMBER_OR_FLOAT (ly);
930 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
931 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
933 switch (coordinates_in_window (w, &x, &y))
935 case ON_NOTHING:
936 return Qnil;
938 case ON_TEXT:
939 /* X and Y are now window relative pixel coordinates. Convert
940 them to canonical char units before returning them. */
941 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
942 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
944 case ON_MODE_LINE:
945 return Qmode_line;
947 case ON_VERTICAL_BORDER:
948 return Qvertical_line;
950 case ON_HEADER_LINE:
951 return Qheader_line;
953 case ON_LEFT_FRINGE:
954 return Qleft_fringe;
956 case ON_RIGHT_FRINGE:
957 return Qright_fringe;
959 case ON_LEFT_MARGIN:
960 return Qleft_margin;
962 case ON_RIGHT_MARGIN:
963 return Qright_margin;
965 case ON_SCROLL_BAR:
966 /* Historically we are supposed to return nil in this case. */
967 return Qnil;
969 default:
970 abort ();
975 /* Callback for foreach_window, used in window_from_coordinates.
976 Check if window W contains coordinates specified by USER_DATA which
977 is actually a pointer to a struct check_window_data CW.
979 Check if window W contains coordinates *CW->x and *CW->y. If it
980 does, return W in *CW->window, as Lisp_Object, and return in
981 *CW->part the part of the window under coordinates *X,*Y. Return
982 zero from this function to stop iterating over windows. */
984 struct check_window_data
986 Lisp_Object *window;
987 int *x, *y;
988 enum window_part *part;
991 static int
992 check_window_containing (w, user_data)
993 struct window *w;
994 void *user_data;
996 struct check_window_data *cw = (struct check_window_data *) user_data;
997 enum window_part found;
998 int continue_p = 1;
1000 found = coordinates_in_window (w, cw->x, cw->y);
1001 if (found != ON_NOTHING)
1003 *cw->part = found;
1004 XSETWINDOW (*cw->window, w);
1005 continue_p = 0;
1008 return continue_p;
1012 /* Find the window containing frame-relative pixel position X/Y and
1013 return it as a Lisp_Object.
1015 If X, Y is on one of the window's special `window_part' elements,
1016 set *PART to the id of that element, and return X and Y converted
1017 to window relative coordinates in WX and WY.
1019 If there is no window under X, Y return nil and leave *PART
1020 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1022 This function was previously implemented with a loop cycling over
1023 windows with Fnext_window, and starting with the frame's selected
1024 window. It turned out that this doesn't work with an
1025 implementation of next_window using Vwindow_list, because
1026 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1027 tree of F when this function is called asynchronously from
1028 note_mouse_highlight. The original loop didn't terminate in this
1029 case. */
1031 Lisp_Object
1032 window_from_coordinates (f, x, y, part, wx, wy, tool_bar_p)
1033 struct frame *f;
1034 int x, y;
1035 enum window_part *part;
1036 int *wx, *wy;
1037 int tool_bar_p;
1039 Lisp_Object window;
1040 struct check_window_data cw;
1041 enum window_part dummy;
1043 if (part == 0)
1044 part = &dummy;
1046 window = Qnil;
1047 cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
1048 foreach_window (f, check_window_containing, &cw);
1050 /* If not found above, see if it's in the tool bar window, if a tool
1051 bar exists. */
1052 if (NILP (window)
1053 && tool_bar_p
1054 && WINDOWP (f->tool_bar_window)
1055 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1056 && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
1057 != ON_NOTHING))
1059 *part = ON_TEXT;
1060 window = f->tool_bar_window;
1063 if (wx) *wx = x;
1064 if (wy) *wy = y;
1066 return window;
1069 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1070 doc: /* Return window containing coordinates X and Y on FRAME.
1071 If omitted, FRAME defaults to the currently selected frame.
1072 The top left corner of the frame is considered to be row 0,
1073 column 0. */)
1074 (x, y, frame)
1075 Lisp_Object x, y, frame;
1077 struct frame *f;
1079 if (NILP (frame))
1080 frame = selected_frame;
1081 CHECK_LIVE_FRAME (frame);
1082 f = XFRAME (frame);
1084 /* Check that arguments are integers or floats. */
1085 CHECK_NUMBER_OR_FLOAT (x);
1086 CHECK_NUMBER_OR_FLOAT (y);
1088 return window_from_coordinates (f,
1089 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1090 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1091 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1092 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1093 0, 0, 0, 0);
1096 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1097 doc: /* Return current value of point in WINDOW.
1098 WINDOW defaults to the selected window.
1100 For a nonselected window, this is the value point would have
1101 if that window were selected.
1103 Note that, when WINDOW is the selected window and its buffer
1104 is also currently selected, the value returned is the same as (point).
1105 It would be more strictly correct to return the `top-level' value
1106 of point, outside of any save-excursion forms.
1107 But that is hard to define. */)
1108 (window)
1109 Lisp_Object window;
1111 register struct window *w = decode_window (window);
1113 if (w == XWINDOW (selected_window)
1114 && current_buffer == XBUFFER (w->buffer))
1115 return Fpoint ();
1116 return Fmarker_position (w->pointm);
1119 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1120 doc: /* Return position at which display currently starts in WINDOW.
1121 WINDOW defaults to the selected window.
1122 This is updated by redisplay or by calling `set-window-start'. */)
1123 (window)
1124 Lisp_Object window;
1126 return Fmarker_position (decode_window (window)->start);
1129 /* This is text temporarily removed from the doc string below.
1131 This function returns nil if the position is not currently known.
1132 That happens when redisplay is preempted and doesn't finish.
1133 If in that case you want to compute where the end of the window would
1134 have been if redisplay had finished, do this:
1135 (save-excursion
1136 (goto-char (window-start window))
1137 (vertical-motion (1- (window-height window)) window)
1138 (point))") */
1140 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1141 doc: /* Return position at which display currently ends in WINDOW.
1142 WINDOW defaults to the selected window.
1143 This is updated by redisplay, when it runs to completion.
1144 Simply changing the buffer text or setting `window-start'
1145 does not update this value.
1146 Return nil if there is no recorded value. \(This can happen if the
1147 last redisplay of WINDOW was preempted, and did not finish.)
1148 If UPDATE is non-nil, compute the up-to-date position
1149 if it isn't already recorded. */)
1150 (window, update)
1151 Lisp_Object window, update;
1153 Lisp_Object value;
1154 struct window *w = decode_window (window);
1155 Lisp_Object buf;
1156 struct buffer *b;
1158 buf = w->buffer;
1159 CHECK_BUFFER (buf);
1160 b = XBUFFER (buf);
1162 #if 0 /* This change broke some things. We should make it later. */
1163 /* If we don't know the end position, return nil.
1164 The user can compute it with vertical-motion if he wants to.
1165 It would be nicer to do it automatically,
1166 but that's so slow that it would probably bother people. */
1167 if (NILP (w->window_end_valid))
1168 return Qnil;
1169 #endif
1171 if (! NILP (update)
1172 && ! (! NILP (w->window_end_valid)
1173 && XFASTINT (w->last_modified) >= BUF_MODIFF (b)
1174 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (b))
1175 && !noninteractive)
1177 struct text_pos startp;
1178 struct it it;
1179 struct buffer *old_buffer = NULL;
1181 /* Cannot use Fvertical_motion because that function doesn't
1182 cope with variable-height lines. */
1183 if (b != current_buffer)
1185 old_buffer = current_buffer;
1186 set_buffer_internal (b);
1189 /* In case W->start is out of the range, use something
1190 reasonable. This situation occurred when loading a file with
1191 `-l' containing a call to `rmail' with subsequent other
1192 commands. At the end, W->start happened to be BEG, while
1193 rmail had already narrowed the buffer. */
1194 if (XMARKER (w->start)->charpos < BEGV)
1195 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1196 else if (XMARKER (w->start)->charpos > ZV)
1197 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1198 else
1199 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1201 start_display (&it, w, startp);
1202 move_it_vertically (&it, window_box_height (w));
1203 if (it.current_y < it.last_visible_y)
1204 move_it_past_eol (&it);
1205 value = make_number (IT_CHARPOS (it));
1207 if (old_buffer)
1208 set_buffer_internal (old_buffer);
1210 else
1211 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1213 return value;
1216 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1217 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1218 Return POS. */)
1219 (window, pos)
1220 Lisp_Object window, pos;
1222 register struct window *w = decode_window (window);
1224 CHECK_NUMBER_COERCE_MARKER (pos);
1225 if (w == XWINDOW (selected_window)
1226 && XBUFFER (w->buffer) == current_buffer)
1227 Fgoto_char (pos);
1228 else
1229 set_marker_restricted (w->pointm, pos, w->buffer);
1231 /* We have to make sure that redisplay updates the window to show
1232 the new value of point. */
1233 if (!EQ (window, selected_window))
1234 ++windows_or_buffers_changed;
1236 return pos;
1239 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1240 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1241 WINDOW defaults to the selected window. Return POS.
1242 Optional third arg NOFORCE non-nil inhibits next redisplay from
1243 overriding motion of point in order to display at this exact start. */)
1244 (window, pos, noforce)
1245 Lisp_Object window, pos, noforce;
1247 register struct window *w = decode_window (window);
1249 CHECK_NUMBER_COERCE_MARKER (pos);
1250 set_marker_restricted (w->start, pos, w->buffer);
1251 /* this is not right, but much easier than doing what is right. */
1252 w->start_at_line_beg = Qnil;
1253 if (NILP (noforce))
1254 w->force_start = Qt;
1255 w->update_mode_line = Qt;
1256 XSETFASTINT (w->last_modified, 0);
1257 XSETFASTINT (w->last_overlay_modified, 0);
1258 if (!EQ (window, selected_window))
1259 windows_or_buffers_changed++;
1261 return pos;
1265 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1266 0, 1, 0,
1267 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1268 More precisely, return the value assigned by the last call of
1269 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1270 never called with WINDOW as its argument, or the value set by that
1271 function was internally reset since its last call. WINDOW defaults to
1272 the selected window.
1274 When a window is dedicated to its buffer, `display-buffer' will refrain
1275 from displaying another buffer in it. `get-lru-window' and
1276 `get-largest-window' treat dedicated windows specially.
1277 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1278 `kill-buffer' can delete a dedicated window and the containing frame.
1280 Functions like `set-window-buffer' may change the buffer displayed by a
1281 window, unless that window is "strongly" dedicated to its buffer, that
1282 is the value returned by `window-dedicated-p' is t. */)
1283 (window)
1284 Lisp_Object window;
1286 return decode_window (window)->dedicated;
1289 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1290 Sset_window_dedicated_p, 2, 2, 0,
1291 doc: /* Mark WINDOW as dedicated according to FLAG.
1292 WINDOW defaults to the selected window. FLAG non-nil means mark WINDOW
1293 as dedicated to its buffer. FLAG nil means mark WINDOW as non-dedicated.
1294 Return FLAG.
1296 When a window is dedicated to its buffer, `display-buffer' will refrain
1297 from displaying another buffer in it. `get-lru-window' and
1298 `get-largest-window' treat dedicated windows specially.
1299 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1300 `kill-buffer' can delete a dedicated window and the containing
1301 frame.
1303 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1304 its buffer. Functions like `set-window-buffer' may change the buffer
1305 displayed by a window, unless that window is strongly dedicated to its
1306 buffer. If and when `set-window-buffer' displays another buffer in a
1307 window, it also makes sure that the window is not marked as dedicated. */)
1308 (window, flag)
1309 Lisp_Object window, flag;
1311 register struct window *w = decode_window (window);
1313 w->dedicated = flag;
1314 return w->dedicated;
1318 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1319 0, 1, 0,
1320 doc: /* Return the parameters of WINDOW and their values.
1321 WINDOW defaults to the selected window. The return value is a list of
1322 elements of the form (PARAMETER . VALUE). */)
1323 (window)
1324 Lisp_Object window;
1326 return Fcopy_alist (decode_window (window)->window_parameters);
1329 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1330 2, 2, 0,
1331 doc: /* Return WINDOW's value for PARAMETER.
1332 WINDOW defaults to the selected window. */)
1333 (window, parameter)
1334 Lisp_Object window, parameter;
1336 Lisp_Object result;
1338 result = Fassq (parameter, decode_window (window)->window_parameters);
1339 return CDR_SAFE (result);
1342 DEFUN ("set-window-parameter", Fset_window_parameter,
1343 Sset_window_parameter, 3, 3, 0,
1344 doc: /* Set WINDOW's value of PARAMETER to VALUE.
1345 WINDOW defaults to the selected window. Return VALUE. */)
1346 (window, parameter, value)
1347 Lisp_Object window, parameter, value;
1349 register struct window *w = decode_window (window);
1350 Lisp_Object old_alist_elt;
1352 old_alist_elt = Fassq (parameter, w->window_parameters);
1353 if (NILP (old_alist_elt))
1354 w->window_parameters = Fcons (Fcons (parameter, value), w->window_parameters);
1355 else
1356 Fsetcdr (old_alist_elt, value);
1357 return value;
1361 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1362 0, 1, 0,
1363 doc: /* Return the display-table that WINDOW is using.
1364 WINDOW defaults to the selected window. */)
1365 (window)
1366 Lisp_Object window;
1368 return decode_window (window)->display_table;
1371 /* Get the display table for use on window W. This is either W's
1372 display table or W's buffer's display table. Ignore the specified
1373 tables if they are not valid; if no valid table is specified,
1374 return 0. */
1376 struct Lisp_Char_Table *
1377 window_display_table (w)
1378 struct window *w;
1380 struct Lisp_Char_Table *dp = NULL;
1382 if (DISP_TABLE_P (w->display_table))
1383 dp = XCHAR_TABLE (w->display_table);
1384 else if (BUFFERP (w->buffer))
1386 struct buffer *b = XBUFFER (w->buffer);
1388 if (DISP_TABLE_P (b->display_table))
1389 dp = XCHAR_TABLE (b->display_table);
1390 else if (DISP_TABLE_P (Vstandard_display_table))
1391 dp = XCHAR_TABLE (Vstandard_display_table);
1394 return dp;
1397 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1398 doc: /* Set WINDOW's display-table to TABLE. */)
1399 (window, table)
1400 register Lisp_Object window, table;
1402 register struct window *w;
1404 w = decode_window (window);
1405 w->display_table = table;
1406 return table;
1409 /* Record info on buffer window w is displaying
1410 when it is about to cease to display that buffer. */
1411 static void
1412 unshow_buffer (w)
1413 register struct window *w;
1415 Lisp_Object buf;
1416 struct buffer *b;
1418 buf = w->buffer;
1419 b = XBUFFER (buf);
1420 if (b != XMARKER (w->pointm)->buffer)
1421 abort ();
1423 #if 0
1424 if (w == XWINDOW (selected_window)
1425 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1426 /* Do this except when the selected window's buffer
1427 is being removed from some other window. */
1428 #endif
1429 /* last_window_start records the start position that this buffer
1430 had in the last window to be disconnected from it.
1431 Now that this statement is unconditional,
1432 it is possible for the buffer to be displayed in the
1433 selected window, while last_window_start reflects another
1434 window which was recently showing the same buffer.
1435 Some people might say that might be a good thing. Let's see. */
1436 b->last_window_start = marker_position (w->start);
1438 /* Point in the selected window's buffer
1439 is actually stored in that buffer, and the window's pointm isn't used.
1440 So don't clobber point in that buffer. */
1441 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1442 /* This line helps to fix Horsley's testbug.el bug. */
1443 && !(WINDOWP (b->last_selected_window)
1444 && w != XWINDOW (b->last_selected_window)
1445 && EQ (buf, XWINDOW (b->last_selected_window)->buffer)))
1446 temp_set_point_both (b,
1447 clip_to_bounds (BUF_BEGV (b),
1448 XMARKER (w->pointm)->charpos,
1449 BUF_ZV (b)),
1450 clip_to_bounds (BUF_BEGV_BYTE (b),
1451 marker_byte_position (w->pointm),
1452 BUF_ZV_BYTE (b)));
1454 if (WINDOWP (b->last_selected_window)
1455 && w == XWINDOW (b->last_selected_window))
1456 b->last_selected_window = Qnil;
1459 /* Put replacement into the window structure in place of old. */
1460 static void
1461 replace_window (old, replacement)
1462 Lisp_Object old, replacement;
1464 register Lisp_Object tem;
1465 register struct window *o = XWINDOW (old), *p = XWINDOW (replacement);
1467 /* If OLD is its frame's root_window, then replacement is the new
1468 root_window for that frame. */
1470 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1471 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
1473 p->left_col = o->left_col;
1474 p->top_line = o->top_line;
1475 p->total_cols = o->total_cols;
1476 p->total_lines = o->total_lines;
1477 p->desired_matrix = p->current_matrix = 0;
1478 p->vscroll = 0;
1479 bzero (&p->cursor, sizeof (p->cursor));
1480 bzero (&p->last_cursor, sizeof (p->last_cursor));
1481 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
1482 p->phys_cursor_type = -1;
1483 p->phys_cursor_width = -1;
1484 p->must_be_updated_p = 0;
1485 p->pseudo_window_p = 0;
1486 XSETFASTINT (p->window_end_vpos, 0);
1487 XSETFASTINT (p->window_end_pos, 0);
1488 p->window_end_valid = Qnil;
1489 p->frozen_window_start_p = 0;
1490 p->orig_top_line = p->orig_total_lines = Qnil;
1492 p->next = tem = o->next;
1493 if (!NILP (tem))
1494 XWINDOW (tem)->prev = replacement;
1496 p->prev = tem = o->prev;
1497 if (!NILP (tem))
1498 XWINDOW (tem)->next = replacement;
1500 p->parent = tem = o->parent;
1501 if (!NILP (tem))
1503 if (EQ (XWINDOW (tem)->vchild, old))
1504 XWINDOW (tem)->vchild = replacement;
1505 if (EQ (XWINDOW (tem)->hchild, old))
1506 XWINDOW (tem)->hchild = replacement;
1509 /*** Here, if replacement is a vertical combination
1510 and so is its new parent, we should make replacement's
1511 children be children of that parent instead. ***/
1514 DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
1515 doc: /* Remove WINDOW from its frame.
1516 WINDOW defaults to the selected window. Return nil.
1517 Signal an error when WINDOW is the only window on its frame. */)
1518 (window)
1519 register Lisp_Object window;
1521 struct frame *f;
1522 if (NILP (window))
1523 window = selected_window;
1524 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1525 delete_window (window);
1527 run_window_configuration_change_hook (f);
1529 return Qnil;
1532 void
1533 delete_window (window)
1534 register Lisp_Object window;
1536 register Lisp_Object tem, parent, sib;
1537 register struct window *p;
1538 register struct window *par;
1539 struct frame *f;
1541 /* Because this function is called by other C code on non-leaf
1542 windows, the CHECK_LIVE_WINDOW macro would choke inappropriately,
1543 so we can't decode_window here. */
1544 CHECK_WINDOW (window);
1545 p = XWINDOW (window);
1547 /* It's a no-op to delete an already-deleted window. */
1548 if (NILP (p->buffer)
1549 && NILP (p->hchild)
1550 && NILP (p->vchild))
1551 return;
1553 parent = p->parent;
1554 if (NILP (parent))
1555 error ("Attempt to delete minibuffer or sole ordinary window");
1556 par = XWINDOW (parent);
1558 windows_or_buffers_changed++;
1559 Vwindow_list = Qnil;
1560 f = XFRAME (WINDOW_FRAME (p));
1561 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
1563 /* Are we trying to delete any frame's selected window? */
1565 Lisp_Object swindow, pwindow;
1567 /* See if the frame's selected window is either WINDOW
1568 or any subwindow of it, by finding all that window's parents
1569 and comparing each one with WINDOW. */
1570 swindow = FRAME_SELECTED_WINDOW (f);
1572 while (1)
1574 pwindow = swindow;
1575 while (!NILP (pwindow))
1577 if (EQ (window, pwindow))
1578 break;
1579 pwindow = XWINDOW (pwindow)->parent;
1582 /* If the window being deleted is not a parent of SWINDOW,
1583 then SWINDOW is ok as the new selected window. */
1584 if (!EQ (window, pwindow))
1585 break;
1586 /* Otherwise, try another window for SWINDOW. */
1587 swindow = Fnext_window (swindow, Qlambda, Qnil);
1589 /* If we get back to the frame's selected window,
1590 it means there was no acceptable alternative,
1591 so we cannot delete. */
1592 if (EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1593 error ("Cannot delete window");
1596 /* If we need to change SWINDOW, do it. */
1597 if (! EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1599 /* If we're about to delete the selected window on the
1600 selected frame, then we should use Fselect_window to select
1601 the new window. On the other hand, if we're about to
1602 delete the selected window on any other frame, we shouldn't do
1603 anything but set the frame's selected_window slot. */
1604 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
1605 Fselect_window (swindow, Qnil);
1606 else
1607 FRAME_SELECTED_WINDOW (f) = swindow;
1611 /* Now we know we can delete this one. */
1612 window_deletion_count++;
1614 tem = p->buffer;
1615 /* tem is null for dummy parent windows
1616 (which have inferiors but not any contents themselves) */
1617 if (!NILP (tem))
1619 unshow_buffer (p);
1620 unchain_marker (XMARKER (p->pointm));
1621 unchain_marker (XMARKER (p->start));
1624 /* Free window glyph matrices. It is sure that they are allocated
1625 again when ADJUST_GLYPHS is called. Block input so that expose
1626 events and other events that access glyph matrices are not
1627 processed while we are changing them. */
1628 BLOCK_INPUT;
1629 free_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)));
1631 tem = p->next;
1632 if (!NILP (tem))
1633 XWINDOW (tem)->prev = p->prev;
1635 tem = p->prev;
1636 if (!NILP (tem))
1637 XWINDOW (tem)->next = p->next;
1639 if (EQ (window, par->hchild))
1640 par->hchild = p->next;
1641 if (EQ (window, par->vchild))
1642 par->vchild = p->next;
1644 /* Find one of our siblings to give our space to. */
1645 sib = p->prev;
1646 if (NILP (sib))
1648 /* If p gives its space to its next sibling, that sibling needs
1649 to have its top/left side pulled back to where p's is.
1650 set_window_{height,width} will re-position the sibling's
1651 children. */
1652 sib = p->next;
1653 XWINDOW (sib)->top_line = p->top_line;
1654 XWINDOW (sib)->left_col = p->left_col;
1657 /* Stretch that sibling. */
1658 if (!NILP (par->vchild))
1659 set_window_height (sib,
1660 XFASTINT (XWINDOW (sib)->total_lines) + XFASTINT (p->total_lines),
1662 if (!NILP (par->hchild))
1663 set_window_width (sib,
1664 XFASTINT (XWINDOW (sib)->total_cols) + XFASTINT (p->total_cols),
1667 /* If parent now has only one child,
1668 put the child into the parent's place. */
1669 tem = par->hchild;
1670 if (NILP (tem))
1671 tem = par->vchild;
1672 if (NILP (XWINDOW (tem)->next)) {
1673 replace_window (parent, tem);
1674 par = XWINDOW (tem);
1677 /* Since we may be deleting combination windows, we must make sure that
1678 not only p but all its children have been marked as deleted. */
1679 if (! NILP (p->hchild))
1680 delete_all_subwindows (XWINDOW (p->hchild));
1681 else if (! NILP (p->vchild))
1682 delete_all_subwindows (XWINDOW (p->vchild));
1684 /* Mark this window as deleted. */
1685 p->buffer = p->hchild = p->vchild = Qnil;
1687 if (! NILP (par->parent))
1688 par = XWINDOW (par->parent);
1690 /* Check if we have a v/hchild with a v/hchild. In that case remove
1691 one of them. */
1693 if (! NILP (par->vchild) && ! NILP (XWINDOW (par->vchild)->vchild))
1695 p = XWINDOW (par->vchild);
1696 par->vchild = p->vchild;
1697 tem = p->vchild;
1699 else if (! NILP (par->hchild) && ! NILP (XWINDOW (par->hchild)->hchild))
1701 p = XWINDOW (par->hchild);
1702 par->hchild = p->hchild;
1703 tem = p->hchild;
1705 else
1706 p = 0;
1708 if (p)
1710 while (! NILP (tem)) {
1711 XWINDOW (tem)->parent = p->parent;
1712 if (NILP (XWINDOW (tem)->next))
1713 break;
1714 tem = XWINDOW (tem)->next;
1716 if (! NILP (tem)) {
1717 /* The next of the v/hchild we are removing is now the next of the
1718 last child for the v/hchild:
1719 Before v/hchild -> v/hchild -> next1 -> next2
1721 -> next3
1722 After: v/hchild -> next1 -> next2 -> next3
1724 XWINDOW (tem)->next = p->next;
1725 if (! NILP (p->next))
1726 XWINDOW (p->next)->prev = tem;
1728 p->next = p->prev = p->vchild = p->hchild = p->buffer = Qnil;
1732 /* Adjust glyph matrices. */
1733 adjust_glyphs (f);
1734 UNBLOCK_INPUT;
1739 /***********************************************************************
1740 Window List
1741 ***********************************************************************/
1743 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1744 pointer. This is a callback function for foreach_window, used in
1745 function window_list. */
1747 static int
1748 add_window_to_list (w, user_data)
1749 struct window *w;
1750 void *user_data;
1752 Lisp_Object *list = (Lisp_Object *) user_data;
1753 Lisp_Object window;
1754 XSETWINDOW (window, w);
1755 *list = Fcons (window, *list);
1756 return 1;
1760 /* Return a list of all windows, for use by next_window. If
1761 Vwindow_list is a list, return that list. Otherwise, build a new
1762 list, cache it in Vwindow_list, and return that. */
1764 static Lisp_Object
1765 window_list ()
1767 if (!CONSP (Vwindow_list))
1769 Lisp_Object tail;
1771 Vwindow_list = Qnil;
1772 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1774 Lisp_Object args[2];
1776 /* We are visiting windows in canonical order, and add
1777 new windows at the front of args[1], which means we
1778 have to reverse this list at the end. */
1779 args[1] = Qnil;
1780 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1781 args[0] = Vwindow_list;
1782 args[1] = Fnreverse (args[1]);
1783 Vwindow_list = Fnconc (2, args);
1787 return Vwindow_list;
1791 /* Value is non-zero if WINDOW satisfies the constraints given by
1792 OWINDOW, MINIBUF and ALL_FRAMES.
1794 MINIBUF t means WINDOW may be minibuffer windows.
1795 `lambda' means WINDOW may not be a minibuffer window.
1796 a window means a specific minibuffer window
1798 ALL_FRAMES t means search all frames,
1799 nil means search just current frame,
1800 `visible' means search just visible frames,
1801 0 means search visible and iconified frames,
1802 a window means search the frame that window belongs to,
1803 a frame means consider windows on that frame, only. */
1805 static int
1806 candidate_window_p (window, owindow, minibuf, all_frames)
1807 Lisp_Object window, owindow, minibuf, all_frames;
1809 struct window *w = XWINDOW (window);
1810 struct frame *f = XFRAME (w->frame);
1811 int candidate_p = 1;
1813 if (!BUFFERP (w->buffer))
1814 candidate_p = 0;
1815 else if (MINI_WINDOW_P (w)
1816 && (EQ (minibuf, Qlambda)
1817 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
1819 /* If MINIBUF is `lambda' don't consider any mini-windows.
1820 If it is a window, consider only that one. */
1821 candidate_p = 0;
1823 else if (EQ (all_frames, Qt))
1824 candidate_p = 1;
1825 else if (NILP (all_frames))
1827 xassert (WINDOWP (owindow));
1828 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
1830 else if (EQ (all_frames, Qvisible))
1832 FRAME_SAMPLE_VISIBILITY (f);
1833 candidate_p = FRAME_VISIBLE_P (f)
1834 && (FRAME_TERMINAL (XFRAME (w->frame))
1835 == FRAME_TERMINAL (XFRAME (selected_frame)));
1838 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
1840 FRAME_SAMPLE_VISIBILITY (f);
1841 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
1842 #ifdef HAVE_X_WINDOWS
1843 /* Yuck!! If we've just created the frame and the
1844 window-manager requested the user to place it
1845 manually, the window may still not be considered
1846 `visible'. I'd argue it should be at least
1847 something like `iconified', but don't know how to do
1848 that yet. --Stef */
1849 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
1850 && !f->output_data.x->has_been_visible)
1851 #endif
1853 && (FRAME_TERMINAL (XFRAME (w->frame))
1854 == FRAME_TERMINAL (XFRAME (selected_frame)));
1856 else if (WINDOWP (all_frames))
1857 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
1858 || EQ (XWINDOW (all_frames)->frame, w->frame)
1859 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
1860 else if (FRAMEP (all_frames))
1861 candidate_p = EQ (all_frames, w->frame);
1863 return candidate_p;
1867 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
1868 Fwindow_list. See there for the meaning of WINDOW, MINIBUF, and
1869 ALL_FRAMES. */
1871 static void
1872 decode_next_window_args (window, minibuf, all_frames)
1873 Lisp_Object *window, *minibuf, *all_frames;
1875 if (NILP (*window))
1876 *window = selected_window;
1877 else
1878 CHECK_LIVE_WINDOW (*window);
1880 /* MINIBUF nil may or may not include minibuffers. Decide if it
1881 does. */
1882 if (NILP (*minibuf))
1883 *minibuf = minibuf_level ? minibuf_window : Qlambda;
1884 else if (!EQ (*minibuf, Qt))
1885 *minibuf = Qlambda;
1887 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
1888 => count none of them, or a specific minibuffer window (the
1889 active one) to count. */
1891 /* ALL_FRAMES nil doesn't specify which frames to include. */
1892 if (NILP (*all_frames))
1893 *all_frames = (!EQ (*minibuf, Qlambda)
1894 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
1895 : Qnil);
1896 else if (EQ (*all_frames, Qvisible))
1898 else if (EQ (*all_frames, make_number (0)))
1900 else if (FRAMEP (*all_frames))
1902 else if (!EQ (*all_frames, Qt))
1903 *all_frames = Qnil;
1905 /* Now *ALL_FRAMES is t meaning search all frames, nil meaning
1906 search just current frame, `visible' meaning search just visible
1907 frames, 0 meaning search visible and iconified frames, or a
1908 window, meaning search the frame that window belongs to, or a
1909 frame, meaning consider windows on that frame, only. */
1913 /* Return the next or previous window of WINDOW in cyclic ordering
1914 of windows. NEXT_P non-zero means return the next window. See the
1915 documentation string of next-window for the meaning of MINIBUF and
1916 ALL_FRAMES. */
1918 static Lisp_Object
1919 next_window (window, minibuf, all_frames, next_p)
1920 Lisp_Object window, minibuf, all_frames;
1921 int next_p;
1923 decode_next_window_args (&window, &minibuf, &all_frames);
1925 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
1926 return the first window on the frame. */
1927 if (FRAMEP (all_frames)
1928 && !EQ (all_frames, XWINDOW (window)->frame))
1929 return Fframe_first_window (all_frames);
1931 if (next_p)
1933 Lisp_Object list;
1935 /* Find WINDOW in the list of all windows. */
1936 list = Fmemq (window, window_list ());
1938 /* Scan forward from WINDOW to the end of the window list. */
1939 if (CONSP (list))
1940 for (list = XCDR (list); CONSP (list); list = XCDR (list))
1941 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1942 break;
1944 /* Scan from the start of the window list up to WINDOW. */
1945 if (!CONSP (list))
1946 for (list = Vwindow_list;
1947 CONSP (list) && !EQ (XCAR (list), window);
1948 list = XCDR (list))
1949 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1950 break;
1952 if (CONSP (list))
1953 window = XCAR (list);
1955 else
1957 Lisp_Object candidate, list;
1959 /* Scan through the list of windows for candidates. If there are
1960 candidate windows in front of WINDOW, the last one of these
1961 is the one we want. If there are candidates following WINDOW
1962 in the list, again the last one of these is the one we want. */
1963 candidate = Qnil;
1964 for (list = window_list (); CONSP (list); list = XCDR (list))
1966 if (EQ (XCAR (list), window))
1968 if (WINDOWP (candidate))
1969 break;
1971 else if (candidate_window_p (XCAR (list), window, minibuf,
1972 all_frames))
1973 candidate = XCAR (list);
1976 if (WINDOWP (candidate))
1977 window = candidate;
1980 return window;
1984 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
1985 doc: /* Return window following WINDOW in cyclic ordering of windows.
1986 WINDOW defaults to the selected window. The optional arguments
1987 MINIBUF and ALL-FRAMES specify the set of windows to consider.
1989 MINIBUF t means consider the minibuffer window even if the
1990 minibuffer is not active. MINIBUF nil or omitted means consider
1991 the minibuffer window only if the minibuffer is active. Any
1992 other value means do not consider the minibuffer window even if
1993 the minibuffer is active.
1995 Several frames may share a single minibuffer; if the minibuffer
1996 is active, all windows on all frames that share that minibuffer
1997 are considered too. Therefore, if you are using a separate
1998 minibuffer frame and the minibuffer is active and MINIBUF says it
1999 counts, `next-window' considers the windows in the frame from
2000 which you entered the minibuffer, as well as the minibuffer
2001 window.
2003 ALL-FRAMES nil or omitted means consider all windows on WINDOW's
2004 frame, plus the minibuffer window if specified by the MINIBUF
2005 argument, see above. If the minibuffer counts, consider all
2006 windows on all frames that share that minibuffer too.
2007 ALL-FRAMES t means consider all windows on all existing frames.
2008 ALL-FRAMES `visible' means consider all windows on all visible
2009 frames.
2010 ALL-FRAMES 0 means consider all windows on all visible and
2011 iconified frames.
2012 ALL-FRAMES a frame means consider all windows on that frame only.
2013 Anything else means consider all windows on WINDOW's frame and no
2014 others.
2016 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2017 `next-window' to iterate through the entire cycle of acceptable
2018 windows, eventually ending up back at the window you started with.
2019 `previous-window' traverses the same cycle, in the reverse order. */)
2020 (window, minibuf, all_frames)
2021 Lisp_Object window, minibuf, all_frames;
2023 return next_window (window, minibuf, all_frames, 1);
2027 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
2028 doc: /* Return window preceding WINDOW in cyclic ordering of windows.
2029 WINDOW defaults to the selected window. The optional arguments
2030 MINIBUF and ALL-FRAMES specify the set of windows to consider.
2031 For the precise meaning of these arguments see `next-window'.
2033 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2034 use `previous-window' to iterate through the entire cycle of
2035 acceptable windows, eventually ending up back at the window you
2036 started with. `next-window' traverses the same cycle, in the
2037 reverse order. */)
2038 (window, minibuf, all_frames)
2039 Lisp_Object window, minibuf, all_frames;
2041 return next_window (window, minibuf, all_frames, 0);
2045 DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
2046 doc: /* Select another window in cyclic ordering of windows.
2047 COUNT specifies the number of windows to skip, starting with the
2048 selected window, before making the selection. If COUNT is
2049 positive, skip COUNT windows forwards. If COUNT is negative,
2050 skip -COUNT windows backwards. COUNT zero means do not skip any
2051 window, so select the selected window. In an interactive call,
2052 COUNT is the numeric prefix argument. Return nil.
2054 This function uses `next-window' for finding the window to select.
2055 The argument ALL-FRAMES has the same meaning as in `next-window',
2056 but the MINIBUF argument of `next-window' is always effectively
2057 nil. */)
2058 (count, all_frames)
2059 Lisp_Object count, all_frames;
2061 Lisp_Object window;
2062 int i;
2064 CHECK_NUMBER (count);
2065 window = selected_window;
2067 for (i = XINT (count); i > 0; --i)
2068 window = Fnext_window (window, Qnil, all_frames);
2069 for (; i < 0; ++i)
2070 window = Fprevious_window (window, Qnil, all_frames);
2072 Fselect_window (window, Qnil);
2073 return Qnil;
2077 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2078 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2079 FRAME nil or omitted means use the selected frame.
2080 WINDOW nil or omitted means use the selected window.
2081 MINIBUF t means include the minibuffer window, even if it isn't active.
2082 MINIBUF nil or omitted means include the minibuffer window only
2083 if it's active.
2084 MINIBUF neither nil nor t means never include the minibuffer window. */)
2085 (frame, minibuf, window)
2086 Lisp_Object frame, minibuf, window;
2088 if (NILP (window))
2089 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2090 CHECK_WINDOW (window);
2091 if (NILP (frame))
2092 frame = selected_frame;
2094 if (!EQ (frame, XWINDOW (window)->frame))
2095 error ("Window is on a different frame");
2097 return window_list_1 (window, minibuf, frame);
2101 /* Return a list of windows in cyclic ordering. Arguments are like
2102 for `next-window'. */
2104 static Lisp_Object
2105 window_list_1 (window, minibuf, all_frames)
2106 Lisp_Object window, minibuf, all_frames;
2108 Lisp_Object tail, list, rest;
2110 decode_next_window_args (&window, &minibuf, &all_frames);
2111 list = Qnil;
2113 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2114 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2115 list = Fcons (XCAR (tail), list);
2117 /* Rotate the list to start with WINDOW. */
2118 list = Fnreverse (list);
2119 rest = Fmemq (window, list);
2120 if (!NILP (rest) && !EQ (rest, list))
2122 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2124 XSETCDR (tail, Qnil);
2125 list = nconc2 (rest, list);
2127 return list;
2132 /* Look at all windows, performing an operation specified by TYPE
2133 with argument OBJ.
2134 If FRAMES is Qt, look at all frames;
2135 Qnil, look at just the selected frame;
2136 Qvisible, look at visible frames;
2137 a frame, just look at windows on that frame.
2138 If MINI is non-zero, perform the operation on minibuffer windows too. */
2140 enum window_loop
2142 WINDOW_LOOP_UNUSED,
2143 GET_BUFFER_WINDOW, /* Arg is buffer */
2144 GET_LRU_WINDOW, /* Arg is t for full-width windows only */
2145 DELETE_OTHER_WINDOWS, /* Arg is window not to delete */
2146 DELETE_BUFFER_WINDOWS, /* Arg is buffer */
2147 GET_LARGEST_WINDOW,
2148 UNSHOW_BUFFER, /* Arg is buffer */
2149 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2150 CHECK_ALL_WINDOWS
2153 static Lisp_Object
2154 window_loop (type, obj, mini, frames)
2155 enum window_loop type;
2156 Lisp_Object obj, frames;
2157 int mini;
2159 Lisp_Object window, windows, best_window, frame_arg;
2160 struct frame *f;
2161 struct gcpro gcpro1;
2163 /* If we're only looping through windows on a particular frame,
2164 frame points to that frame. If we're looping through windows
2165 on all frames, frame is 0. */
2166 if (FRAMEP (frames))
2167 f = XFRAME (frames);
2168 else if (NILP (frames))
2169 f = SELECTED_FRAME ();
2170 else
2171 f = NULL;
2173 if (f)
2174 frame_arg = Qlambda;
2175 else if (EQ (frames, make_number (0)))
2176 frame_arg = frames;
2177 else if (EQ (frames, Qvisible))
2178 frame_arg = frames;
2179 else
2180 frame_arg = Qt;
2182 /* frame_arg is Qlambda to stick to one frame,
2183 Qvisible to consider all visible frames,
2184 or Qt otherwise. */
2186 /* Pick a window to start with. */
2187 if (WINDOWP (obj))
2188 window = obj;
2189 else if (f)
2190 window = FRAME_SELECTED_WINDOW (f);
2191 else
2192 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2194 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2195 GCPRO1 (windows);
2196 best_window = Qnil;
2198 for (; CONSP (windows); windows = XCDR (windows))
2200 struct window *w;
2202 window = XCAR (windows);
2203 w = XWINDOW (window);
2205 /* Note that we do not pay attention here to whether the frame
2206 is visible, since Fwindow_list skips non-visible frames if
2207 that is desired, under the control of frame_arg. */
2208 if (!MINI_WINDOW_P (w)
2209 /* For UNSHOW_BUFFER, we must always consider all windows. */
2210 || type == UNSHOW_BUFFER
2211 || (mini && minibuf_level > 0))
2212 switch (type)
2214 case GET_BUFFER_WINDOW:
2215 if (EQ (w->buffer, obj)
2216 /* Don't find any minibuffer window
2217 except the one that is currently in use. */
2218 && (MINI_WINDOW_P (w)
2219 ? EQ (window, minibuf_window)
2220 : 1))
2222 if (NILP (best_window))
2223 best_window = window;
2224 else if (EQ (window, selected_window))
2225 /* Prefer to return selected-window. */
2226 RETURN_UNGCPRO (window);
2227 else if (EQ (Fwindow_frame (window), selected_frame))
2228 /* Prefer windows on the current frame. */
2229 best_window = window;
2231 break;
2233 case GET_LRU_WINDOW:
2234 /* `obj' is an integer encoding a bitvector.
2235 `obj & 1' means consider only full-width windows.
2236 `obj & 2' means consider also dedicated windows. */
2237 if (((XINT (obj) & 1) && !WINDOW_FULL_WIDTH_P (w))
2238 || (!(XINT (obj) & 2) && !NILP (w->dedicated))
2239 /* Minibuffer windows are always ignored. */
2240 || MINI_WINDOW_P (w))
2241 break;
2242 if (NILP (best_window)
2243 || (XFASTINT (XWINDOW (best_window)->use_time)
2244 > XFASTINT (w->use_time)))
2245 best_window = window;
2246 break;
2248 case DELETE_OTHER_WINDOWS:
2249 if (!EQ (window, obj))
2250 Fdelete_window (window);
2251 break;
2253 case DELETE_BUFFER_WINDOWS:
2254 if (EQ (w->buffer, obj))
2256 struct frame *f = XFRAME (WINDOW_FRAME (w));
2258 /* If this window is dedicated, and in a frame of its own,
2259 kill the frame. */
2260 if (EQ (window, FRAME_ROOT_WINDOW (f))
2261 && !NILP (w->dedicated)
2262 && other_visible_frames (f))
2264 /* Skip the other windows on this frame.
2265 There might be one, the minibuffer! */
2266 while (CONSP (XCDR (windows))
2267 && EQ (XWINDOW (XCAR (windows))->frame,
2268 XWINDOW (XCAR (XCDR (windows)))->frame))
2269 windows = XCDR (windows);
2271 /* Now we can safely delete the frame. */
2272 Fdelete_frame (w->frame, Qnil);
2274 else if (NILP (w->parent))
2276 /* If we're deleting the buffer displayed in the
2277 only window on the frame, find a new buffer to
2278 display there. */
2279 Lisp_Object buffer;
2280 buffer = Fother_buffer (obj, Qnil, w->frame);
2281 Fset_window_buffer (window, buffer, Qnil);
2282 if (EQ (window, selected_window))
2283 Fset_buffer (w->buffer);
2285 else
2286 Fdelete_window (window);
2288 break;
2290 case GET_LARGEST_WINDOW:
2291 { /* nil `obj' means to ignore dedicated windows. */
2292 /* Ignore dedicated windows and minibuffers. */
2293 if (MINI_WINDOW_P (w) || (NILP (obj) && !NILP (w->dedicated)))
2294 break;
2296 if (NILP (best_window))
2297 best_window = window;
2298 else
2300 struct window *b = XWINDOW (best_window);
2301 if (XFASTINT (w->total_lines) * XFASTINT (w->total_cols)
2302 > XFASTINT (b->total_lines) * XFASTINT (b->total_cols))
2303 best_window = window;
2306 break;
2308 case UNSHOW_BUFFER:
2309 if (EQ (w->buffer, obj))
2311 Lisp_Object buffer;
2312 struct frame *f = XFRAME (w->frame);
2314 /* Find another buffer to show in this window. */
2315 buffer = Fother_buffer (obj, Qnil, w->frame);
2317 /* If this window is dedicated, and in a frame of its own,
2318 kill the frame. */
2319 if (EQ (window, FRAME_ROOT_WINDOW (f))
2320 && !NILP (w->dedicated)
2321 && other_visible_frames (f))
2323 /* Skip the other windows on this frame.
2324 There might be one, the minibuffer! */
2325 while (CONSP (XCDR (windows))
2326 && EQ (XWINDOW (XCAR (windows))->frame,
2327 XWINDOW (XCAR (XCDR (windows)))->frame))
2328 windows = XCDR (windows);
2330 /* Now we can safely delete the frame. */
2331 Fdelete_frame (w->frame, Qnil);
2333 else if (!NILP (w->dedicated) && !NILP (w->parent))
2335 Lisp_Object window;
2336 XSETWINDOW (window, w);
2337 /* If this window is dedicated and not the only window
2338 in its frame, then kill it. */
2339 Fdelete_window (window);
2341 else
2343 /* Otherwise show a different buffer in the window. */
2344 w->dedicated = Qnil;
2345 Fset_window_buffer (window, buffer, Qnil);
2346 if (EQ (window, selected_window))
2347 Fset_buffer (w->buffer);
2350 break;
2352 case REDISPLAY_BUFFER_WINDOWS:
2353 if (EQ (w->buffer, obj))
2355 mark_window_display_accurate (window, 0);
2356 w->update_mode_line = Qt;
2357 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2358 ++update_mode_lines;
2359 best_window = window;
2361 break;
2363 /* Check for a window that has a killed buffer. */
2364 case CHECK_ALL_WINDOWS:
2365 if (! NILP (w->buffer)
2366 && NILP (XBUFFER (w->buffer)->name))
2367 abort ();
2368 break;
2370 case WINDOW_LOOP_UNUSED:
2371 break;
2375 UNGCPRO;
2376 return best_window;
2379 /* Used for debugging. Abort if any window has a dead buffer. */
2381 void
2382 check_all_windows ()
2384 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2387 DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 2, 0,
2388 doc: /* Return the window least recently selected or used for display.
2389 \(LRU means Least Recently Used.)
2391 Return a full-width window if possible.
2392 A minibuffer window is never a candidate.
2393 A dedicated window is never a candidate, unless DEDICATED is non-nil,
2394 so if all windows are dedicated, the value is nil.
2395 If optional argument FRAME is `visible', search all visible frames.
2396 If FRAME is 0, search all visible and iconified frames.
2397 If FRAME is t, search all frames.
2398 If FRAME is nil, search only the selected frame.
2399 If FRAME is a frame, search only that frame. */)
2400 (frame, dedicated)
2401 Lisp_Object frame, dedicated;
2403 register Lisp_Object w;
2404 /* First try for a window that is full-width */
2405 w = window_loop (GET_LRU_WINDOW,
2406 NILP (dedicated) ? make_number (1) : make_number (3),
2407 0, frame);
2408 if (!NILP (w) && !EQ (w, selected_window))
2409 return w;
2410 /* If none of them, try the rest */
2411 return window_loop (GET_LRU_WINDOW,
2412 NILP (dedicated) ? make_number (0) : make_number (2),
2413 0, frame);
2416 DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 2, 0,
2417 doc: /* Return the largest window in area.
2418 A minibuffer window is never a candidate.
2419 A dedicated window is never a candidate unless DEDICATED is non-nil,
2420 so if all windows are dedicated, the value is nil.
2421 If optional argument FRAME is `visible', search all visible frames.
2422 If FRAME is 0, search all visible and iconified frames.
2423 If FRAME is t, search all frames.
2424 If FRAME is nil, search only the selected frame.
2425 If FRAME is a frame, search only that frame. */)
2426 (frame, dedicated)
2427 Lisp_Object frame, dedicated;
2429 return window_loop (GET_LARGEST_WINDOW, dedicated, 0,
2430 frame);
2433 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 0, 2, 0,
2434 doc: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2435 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to the
2436 current buffer.
2437 If optional argument FRAME is `visible', search all visible frames.
2438 If optional argument FRAME is 0, search all visible and iconified frames.
2439 If FRAME is t, search all frames.
2440 If FRAME is nil, search only the selected frame.
2441 If FRAME is a frame, search only that frame. */)
2442 (buffer_or_name, frame)
2443 Lisp_Object buffer_or_name, frame;
2445 Lisp_Object buffer;
2447 if (NILP (buffer_or_name))
2448 buffer = Fcurrent_buffer ();
2449 else
2450 buffer = Fget_buffer (buffer_or_name);
2452 if (BUFFERP (buffer))
2453 return window_loop (GET_BUFFER_WINDOW, buffer, 1, frame);
2454 else
2455 return Qnil;
2458 DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
2459 0, 1, "",
2460 doc: /* Make WINDOW (or the selected window) fill its frame.
2461 Only the frame WINDOW is on is affected.
2462 This function tries to reduce display jumps by keeping the text
2463 previously visible in WINDOW in the same place on the frame. Doing this
2464 depends on the value of (window-start WINDOW), so if calling this
2465 function in a program gives strange scrolling, make sure the
2466 window-start value is reasonable when this function is called. */)
2467 (window)
2468 Lisp_Object window;
2470 struct window *w;
2471 int startpos;
2472 int top, new_top;
2474 if (NILP (window))
2475 window = selected_window;
2476 else
2477 CHECK_LIVE_WINDOW (window);
2478 w = XWINDOW (window);
2480 startpos = marker_position (w->start);
2481 top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2483 if (MINI_WINDOW_P (w) && top > 0)
2484 error ("Can't expand minibuffer to full frame");
2486 window_loop (DELETE_OTHER_WINDOWS, window, 0, WINDOW_FRAME (w));
2488 /* Try to minimize scrolling, by setting the window start to the point
2489 will cause the text at the old window start to be at the same place
2490 on the frame. But don't try to do this if the window start is
2491 outside the visible portion (as might happen when the display is
2492 not current, due to typeahead). */
2493 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2494 if (new_top != top
2495 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2496 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2498 struct position pos;
2499 struct buffer *obuf = current_buffer;
2501 Fset_buffer (w->buffer);
2502 /* This computation used to temporarily move point, but that can
2503 have unwanted side effects due to text properties. */
2504 pos = *vmotion (startpos, -top, w);
2506 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2507 w->window_end_valid = Qnil;
2508 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2509 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2510 : Qnil);
2511 /* We need to do this, so that the window-scroll-functions
2512 get called. */
2513 w->optional_new_start = Qt;
2515 set_buffer_internal (obuf);
2518 return Qnil;
2521 DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
2522 0, 2, "bDelete windows on (buffer): ",
2523 doc: /* Delete all windows showing BUFFER-OR-NAME.
2524 BUFFER-OR-NAME may be a buffer or the name of an existing buffer and
2525 defaults to the current buffer.
2527 Optional second argument FRAME controls which frames are affected.
2528 If optional argument FRAME is `visible', search all visible frames.
2529 If FRAME is 0, search all visible and iconified frames.
2530 If FRAME is nil, search all frames.
2531 If FRAME is t, search only the selected frame.
2532 If FRAME is a frame, search only that frame.
2533 When a window showing BUFFER-OR-NAME is dedicated and the only window of
2534 its frame, that frame is deleted when there are other frames left. */)
2535 (buffer_or_name, frame)
2536 Lisp_Object buffer_or_name, frame;
2538 Lisp_Object buffer;
2540 /* FRAME uses t and nil to mean the opposite of what window_loop
2541 expects. */
2542 if (NILP (frame))
2543 frame = Qt;
2544 else if (EQ (frame, Qt))
2545 frame = Qnil;
2547 if (NILP (buffer_or_name))
2548 buffer = Fcurrent_buffer ();
2549 else
2551 buffer = Fget_buffer (buffer_or_name);
2552 CHECK_BUFFER (buffer);
2555 window_loop (DELETE_BUFFER_WINDOWS, buffer, 0, frame);
2557 return Qnil;
2560 DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows,
2561 Sreplace_buffer_in_windows,
2562 0, 1, "bReplace buffer in windows: ",
2563 doc: /* Replace BUFFER-OR-NAME with some other buffer in all windows showing it.
2564 BUFFER-OR-NAME may be a buffer or the name of an existing buffer and
2565 defaults to the current buffer.
2567 When a window showing BUFFER-OR-NAME is dedicated that window is
2568 deleted. If that window is the only window on its frame, that frame is
2569 deleted too when there are other frames left. If there are no other
2570 frames left, some other buffer is displayed in that window. */)
2571 (buffer_or_name)
2572 Lisp_Object buffer_or_name;
2574 Lisp_Object buffer;
2576 if (NILP (buffer_or_name))
2577 buffer = Fcurrent_buffer ();
2578 else
2580 buffer = Fget_buffer (buffer_or_name);
2581 CHECK_BUFFER (buffer);
2584 window_loop (UNSHOW_BUFFER, buffer, 0, Qt);
2586 return Qnil;
2589 /* Replace BUFFER with some other buffer in all windows
2590 of all frames, even those on other keyboards. */
2592 void
2593 replace_buffer_in_all_windows (buffer)
2594 Lisp_Object buffer;
2596 Lisp_Object tail, frame;
2598 /* A single call to window_loop won't do the job
2599 because it only considers frames on the current keyboard.
2600 So loop manually over frames, and handle each one. */
2601 FOR_EACH_FRAME (tail, frame)
2602 window_loop (UNSHOW_BUFFER, buffer, 1, frame);
2605 /* Set the height of WINDOW and all its inferiors. */
2607 /* The smallest acceptable dimensions for a window. Anything smaller
2608 might crash Emacs. */
2610 #define MIN_SAFE_WINDOW_WIDTH (2)
2611 #define MIN_SAFE_WINDOW_HEIGHT (1)
2613 /* For wp non-zero the total number of columns of window w. Otherwise
2614 the total number of lines of w. */
2616 #define WINDOW_TOTAL_SIZE(w, wp) \
2617 (wp ? WINDOW_TOTAL_COLS (w) : WINDOW_TOTAL_LINES (w))
2619 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2620 minimum allowable size. */
2622 void
2623 check_frame_size (frame, rows, cols)
2624 FRAME_PTR frame;
2625 int *rows, *cols;
2627 /* For height, we have to see:
2628 how many windows the frame has at minimum (one or two),
2629 and whether it has a menu bar or other special stuff at the top. */
2630 int min_height
2631 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
2632 ? MIN_SAFE_WINDOW_HEIGHT
2633 : 2 * MIN_SAFE_WINDOW_HEIGHT);
2635 if (FRAME_TOP_MARGIN (frame) > 0)
2636 min_height += FRAME_TOP_MARGIN (frame);
2638 if (*rows < min_height)
2639 *rows = min_height;
2640 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2641 *cols = MIN_SAFE_WINDOW_WIDTH;
2644 /* Value is non-zero if window W is fixed-size. WIDTH_P non-zero means
2645 check if W's width can be changed, otherwise check W's height.
2646 CHECK_SIBLINGS_P non-zero means check resizablity of WINDOW's
2647 siblings, too. If none of the siblings is resizable, WINDOW isn't
2648 either. */
2650 static int
2651 window_fixed_size_p (w, width_p, check_siblings_p)
2652 struct window *w;
2653 int width_p, check_siblings_p;
2655 int fixed_p;
2656 struct window *c;
2658 if (!NILP (w->hchild))
2660 c = XWINDOW (w->hchild);
2662 if (width_p)
2664 /* A horizontal combination is fixed-width if all of if its
2665 children are. */
2666 while (c && window_fixed_size_p (c, width_p, 0))
2667 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2668 fixed_p = c == NULL;
2670 else
2672 /* A horizontal combination is fixed-height if one of if its
2673 children is. */
2674 while (c && !window_fixed_size_p (c, width_p, 0))
2675 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2676 fixed_p = c != NULL;
2679 else if (!NILP (w->vchild))
2681 c = XWINDOW (w->vchild);
2683 if (width_p)
2685 /* A vertical combination is fixed-width if one of if its
2686 children is. */
2687 while (c && !window_fixed_size_p (c, width_p, 0))
2688 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2689 fixed_p = c != NULL;
2691 else
2693 /* A vertical combination is fixed-height if all of if its
2694 children are. */
2695 while (c && window_fixed_size_p (c, width_p, 0))
2696 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2697 fixed_p = c == NULL;
2700 else if (BUFFERP (w->buffer))
2702 struct buffer *old = current_buffer;
2703 Lisp_Object val;
2705 current_buffer = XBUFFER (w->buffer);
2706 val = find_symbol_value (Qwindow_size_fixed);
2707 current_buffer = old;
2709 fixed_p = 0;
2710 if (!EQ (val, Qunbound))
2712 fixed_p = !NILP (val);
2714 if (fixed_p
2715 && ((EQ (val, Qheight) && width_p)
2716 || (EQ (val, Qwidth) && !width_p)))
2717 fixed_p = 0;
2720 /* Can't tell if this one is resizable without looking at
2721 siblings. If all siblings are fixed-size this one is too. */
2722 if (!fixed_p && check_siblings_p && WINDOWP (w->parent))
2724 Lisp_Object child;
2726 for (child = w->prev; WINDOWP (child); child = XWINDOW (child)->prev)
2727 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2728 break;
2730 if (NILP (child))
2731 for (child = w->next; WINDOWP (child); child = XWINDOW (child)->next)
2732 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2733 break;
2735 if (NILP (child))
2736 fixed_p = 1;
2739 else
2740 fixed_p = 1;
2742 return fixed_p;
2745 /* Return minimum size of leaf window W. WIDTH_P non-zero means return
2746 the minimum width of W, WIDTH_P zero means return the minimum height
2747 of W. SAFE_P non-zero means ignore window-min-height|width but just
2748 return values that won't crash Emacs and don't hide components like
2749 fringes, scrollbars, or modelines. If WIDTH_P is zero and W is the
2750 minibuffer window, always return 1. */
2752 static int
2753 window_min_size_2 (w, width_p, safe_p)
2754 struct window *w;
2755 int width_p, safe_p;
2757 /* We should consider buffer-local values of window_min_height and
2758 window_min_width here. */
2759 if (width_p)
2761 int safe_size = (MIN_SAFE_WINDOW_WIDTH
2762 + WINDOW_FRINGE_COLS (w)
2763 + WINDOW_SCROLL_BAR_COLS (w));
2765 return safe_p ? safe_size : max (window_min_width, safe_size);
2767 else if (MINI_WINDOW_P (w))
2768 return 1;
2769 else
2771 int safe_size = (MIN_SAFE_WINDOW_HEIGHT
2772 + ((BUFFERP (w->buffer)
2773 && !NILP (XBUFFER (w->buffer)->mode_line_format))
2774 ? 1 : 0));
2776 return safe_p ? safe_size : max (window_min_height, safe_size);
2780 /* Return minimum size of window W, not taking fixed-width windows into
2781 account. WIDTH_P non-zero means return the minimum width, otherwise
2782 return the minimum height. SAFE_P non-zero means ignore
2783 window-min-height|width but just return values that won't crash Emacs
2784 and don't hide components like fringes, scrollbars, or modelines. If
2785 W is a combination window, compute the minimum size from the minimum
2786 sizes of W's children. */
2788 static int
2789 window_min_size_1 (w, width_p, safe_p)
2790 struct window *w;
2791 int width_p, safe_p;
2793 struct window *c;
2794 int size;
2796 if (!NILP (w->hchild))
2798 /* W is a horizontal combination. */
2799 c = XWINDOW (w->hchild);
2800 size = 0;
2802 if (width_p)
2804 /* The minimum width of a horizontal combination is the sum of
2805 the minimum widths of its children. */
2806 while (c)
2808 size += window_min_size_1 (c, 1, safe_p);
2809 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2812 else
2814 /* The minimum height of a horizontal combination is the
2815 maximum of the minimum heights of its children. */
2816 while (c)
2818 size = max (window_min_size_1 (c, 0, safe_p), size);
2819 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2823 else if (!NILP (w->vchild))
2825 /* W is a vertical combination. */
2826 c = XWINDOW (w->vchild);
2827 size = 0;
2829 if (width_p)
2831 /* The minimum width of a vertical combination is the maximum
2832 of the minimum widths of its children. */
2833 while (c)
2835 size = max (window_min_size_1 (c, 1, safe_p), size);
2836 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2839 else
2841 /* The minimum height of a vertical combination is the sum of
2842 the minimum height of its children. */
2843 while (c)
2845 size += window_min_size_1 (c, 0, safe_p);
2846 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2850 else
2851 /* W is a leaf window. */
2852 size = window_min_size_2 (w, width_p, safe_p);
2854 return size;
2857 /* Return the minimum size of window W, taking fixed-size windows into
2858 account. WIDTH_P non-zero means return the minimum width, otherwise
2859 return the minimum height. SAFE_P non-zero means ignore
2860 window-min-height|width but just return values that won't crash Emacs
2861 and don't hide components like fringes, scrollbars, or modelines.
2862 IGNORE_FIXED_P non-zero means ignore if W is fixed-size. Set *FIXED
2863 to 1 if W is fixed-size unless FIXED is null. */
2865 static int
2866 window_min_size (w, width_p, safe_p, ignore_fixed_p, fixed)
2867 struct window *w;
2868 int width_p, safe_p, ignore_fixed_p, *fixed;
2870 int size, fixed_p;
2872 if (ignore_fixed_p)
2873 fixed_p = 0;
2874 else
2875 fixed_p = window_fixed_size_p (w, width_p, 1);
2877 if (fixed)
2878 *fixed = fixed_p;
2880 if (fixed_p)
2881 size = WINDOW_TOTAL_SIZE (w, width_p);
2882 else
2883 size = window_min_size_1 (w, width_p, safe_p);
2885 return size;
2889 /* Adjust the margins of window W if text area is too small.
2890 Return 1 if window width is ok after adjustment; 0 if window
2891 is still too narrow. */
2893 static int
2894 adjust_window_margins (w)
2895 struct window *w;
2897 int box_cols = (WINDOW_TOTAL_COLS (w)
2898 - WINDOW_FRINGE_COLS (w)
2899 - WINDOW_SCROLL_BAR_COLS (w));
2900 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
2901 + WINDOW_RIGHT_MARGIN_COLS (w));
2903 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
2904 return 1;
2906 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
2907 return 0;
2909 /* Window's text area is too narrow, but reducing the window
2910 margins will fix that. */
2911 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
2912 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
2914 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
2915 w->left_margin_cols = w->right_margin_cols
2916 = make_number (margin_cols/2);
2917 else
2918 w->right_margin_cols = make_number (margin_cols);
2920 else
2921 w->left_margin_cols = make_number (margin_cols);
2922 return 1;
2925 /* Calculate new sizes for windows in the list FORWARD when their
2926 compound size goes from TOTAL to SIZE. TOTAL must be greater than
2927 SIZE. The number of windows in FORWARD is NCHILDREN, and the number
2928 that can shrink is SHRINKABLE. Fixed-size windows may be shrunk if
2929 and only if RESIZE_FIXED_P is non-zero. WIDTH_P non-zero means
2930 shrink columns, otherwise shrink lines.
2932 SAFE_P zero means windows may be sized down to window-min-height
2933 lines (window-min-window columns for WIDTH_P non-zero). SAFE_P
2934 non-zero means windows may be sized down to their minimum safe sizes
2935 taking into account the space needed to display modelines, fringes,
2936 and scrollbars.
2938 This function returns an allocated array of new sizes that the caller
2939 must free. A size -1 means the window is fixed and RESIZE_FIXED_P is
2940 zero. A size zero means the window shall be deleted. Array index 0
2941 refers to the first window in FORWARD, 1 to the second, and so on.
2943 This function resizes windows proportionally to their size. It also
2944 tries to preserve smaller windows by resizing larger windows before
2945 resizing any window to zero. If resize_proportionally is non-nil for
2946 a specific window, it will attempt to strictly resize that window
2947 proportionally, even at the expense of deleting smaller windows. */
2948 static int *
2949 shrink_windows (total, size, nchildren, shrinkable, resize_fixed_p,
2950 forward, width_p, safe_p)
2951 int total, size, nchildren, shrinkable;
2952 int resize_fixed_p, width_p, safe_p;
2953 Lisp_Object forward;
2955 int available_resize = 0;
2956 int *new_sizes, *min_sizes;
2957 struct window *c;
2958 Lisp_Object child;
2959 int smallest = total;
2960 int total_removed = 0;
2961 int total_shrink = total - size;
2962 int i;
2964 new_sizes = xmalloc (sizeof (*new_sizes) * nchildren);
2965 min_sizes = xmalloc (sizeof (*min_sizes) * nchildren);
2967 for (i = 0, child = forward; !NILP (child); child = c->next, ++i)
2969 int child_size;
2971 c = XWINDOW (child);
2972 child_size = WINDOW_TOTAL_SIZE (c, width_p);
2974 if (!resize_fixed_p && window_fixed_size_p (c, width_p, 0))
2975 new_sizes[i] = -1;
2976 else
2978 new_sizes[i] = child_size;
2979 min_sizes[i] = window_min_size_1 (c, width_p, safe_p);
2980 if (child_size > min_sizes[i]
2981 && NILP (c->resize_proportionally))
2982 available_resize += child_size - min_sizes[i];
2985 /* We might need to shrink some windows to zero. Find the smallest
2986 windows and set them to 0 until we can fulfil the new size. */
2988 while (shrinkable > 1 && size + available_resize < total)
2990 for (i = 0; i < nchildren; ++i)
2991 if (new_sizes[i] > 0 && smallest > new_sizes[i])
2992 smallest = new_sizes[i];
2994 for (i = 0; i < nchildren; ++i)
2995 if (new_sizes[i] == smallest)
2997 /* Resize this window down to zero. */
2998 new_sizes[i] = 0;
2999 if (smallest > min_sizes[i])
3000 available_resize -= smallest - min_sizes[i];
3001 available_resize += smallest;
3002 --shrinkable;
3003 total_removed += smallest;
3005 /* We don't know what the smallest is now. */
3006 smallest = total;
3008 /* Out of for, just remove one window at the time and
3009 check again if we have enough space. */
3010 break;
3014 /* Now, calculate the new sizes. Try to shrink each window
3015 proportional to its size. */
3016 for (i = 0; i < nchildren; ++i)
3018 if (new_sizes[i] > min_sizes[i])
3020 int to_shrink = total_shrink * new_sizes[i] / total;
3022 if (new_sizes[i] - to_shrink < min_sizes[i])
3023 to_shrink = new_sizes[i] - min_sizes[i];
3024 new_sizes[i] -= to_shrink;
3025 total_removed += to_shrink;
3029 /* Any reminder due to rounding, we just subtract from windows
3030 that are left and still can be shrunk. */
3031 while (total_shrink > total_removed)
3033 int nonzero_sizes = 0;
3034 int nonzero_idx = -1;
3036 for (i = 0; i < nchildren; ++i)
3037 if (new_sizes[i] > 0)
3039 ++nonzero_sizes;
3040 nonzero_idx = i;
3043 for (i = 0; i < nchildren; ++i)
3044 if (new_sizes[i] > min_sizes[i])
3046 --new_sizes[i];
3047 ++total_removed;
3049 /* Out of for, just shrink one window at the time and
3050 check again if we have enough space. */
3051 break;
3054 /* Special case, only one window left. */
3055 if (nonzero_sizes == 1)
3056 break;
3059 /* Any surplus due to rounding, we add to windows that are left. */
3060 while (total_shrink < total_removed)
3062 for (i = 0; i < nchildren; ++i)
3064 if (new_sizes[i] != 0 && total_shrink < total_removed)
3066 ++new_sizes[i];
3067 --total_removed;
3068 break;
3073 xfree (min_sizes);
3075 return new_sizes;
3078 /* Set WINDOW's height or width to SIZE. WIDTH_P non-zero means set
3079 WINDOW's width. Resize WINDOW's children, if any, so that they keep
3080 their proportionate size relative to WINDOW.
3082 If FIRST_ONLY is 1, change only the first of WINDOW's children when
3083 they are in series. If LAST_ONLY is 1, change only the last of
3084 WINDOW's children when they are in series.
3086 Propagate WINDOW's top or left edge position to children. Delete
3087 windows that become too small unless NODELETE_P is 1. When
3088 NODELETE_P equals 2 do not honor settings for window-min-height and
3089 window-min-width when resizing windows but use safe defaults instead.
3090 This should give better behavior when resizing frames. */
3092 static void
3093 size_window (window, size, width_p, nodelete_p, first_only, last_only)
3094 Lisp_Object window;
3095 int size, width_p, nodelete_p;
3096 int first_only, last_only;
3098 struct window *w = XWINDOW (window);
3099 struct window *c;
3100 Lisp_Object child, *forward, *sideward;
3101 int old_size = WINDOW_TOTAL_SIZE (w, width_p);
3103 size = max (0, size);
3105 /* Delete WINDOW if it's too small. */
3106 if (nodelete_p != 1 && !NILP (w->parent)
3107 && size < window_min_size_1 (w, width_p, nodelete_p == 2))
3109 delete_window (window);
3110 return;
3113 /* Set redisplay hints. */
3114 w->last_modified = make_number (0);
3115 w->last_overlay_modified = make_number (0);
3116 windows_or_buffers_changed++;
3117 FRAME_WINDOW_SIZES_CHANGED (XFRAME (w->frame)) = 1;
3119 if (width_p)
3121 sideward = &w->vchild;
3122 forward = &w->hchild;
3123 w->total_cols = make_number (size);
3124 adjust_window_margins (w);
3126 else
3128 sideward = &w->hchild;
3129 forward = &w->vchild;
3130 w->total_lines = make_number (size);
3131 w->orig_total_lines = Qnil;
3134 if (!NILP (*sideward))
3136 /* We have a chain of parallel siblings whose size should all change. */
3137 for (child = *sideward; !NILP (child); child = c->next)
3139 c = XWINDOW (child);
3140 if (width_p)
3141 c->left_col = w->left_col;
3142 else
3143 c->top_line = w->top_line;
3144 size_window (child, size, width_p, nodelete_p,
3145 first_only, last_only);
3148 else if (!NILP (*forward) && last_only)
3150 /* Change the last in a series of siblings. */
3151 Lisp_Object last_child;
3152 int child_size;
3154 for (child = *forward; !NILP (child); child = c->next)
3156 c = XWINDOW (child);
3157 last_child = child;
3160 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3161 size_window (last_child, size - old_size + child_size,
3162 width_p, nodelete_p, first_only, last_only);
3164 else if (!NILP (*forward) && first_only)
3166 /* Change the first in a series of siblings. */
3167 int child_size;
3169 child = *forward;
3170 c = XWINDOW (child);
3172 if (width_p)
3173 c->left_col = w->left_col;
3174 else
3175 c->top_line = w->top_line;
3177 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3178 size_window (child, size - old_size + child_size,
3179 width_p, nodelete_p, first_only, last_only);
3181 else if (!NILP (*forward))
3183 int fixed_size, each, extra, n;
3184 int resize_fixed_p, nfixed;
3185 int last_pos, first_pos, nchildren, total;
3186 int *new_sizes = NULL;
3188 /* Determine the fixed-size portion of this window, and the
3189 number of child windows. */
3190 fixed_size = nchildren = nfixed = total = 0;
3191 for (child = *forward; !NILP (child); child = c->next, ++nchildren)
3193 int child_size;
3195 c = XWINDOW (child);
3196 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3197 total += child_size;
3199 if (window_fixed_size_p (c, width_p, 0))
3201 fixed_size += child_size;
3202 ++nfixed;
3206 /* If the new size is smaller than fixed_size, or if there
3207 aren't any resizable windows, allow resizing fixed-size
3208 windows. */
3209 resize_fixed_p = nfixed == nchildren || size < fixed_size;
3211 /* Compute how many lines/columns to add/remove to each child. The
3212 value of extra takes care of rounding errors. */
3213 n = resize_fixed_p ? nchildren : nchildren - nfixed;
3214 if (size < total && n > 1)
3215 new_sizes = shrink_windows (total, size, nchildren, n,
3216 resize_fixed_p, *forward, width_p,
3217 nodelete_p == 2);
3218 else
3220 each = (size - total) / n;
3221 extra = (size - total) - n * each;
3224 /* Compute new children heights and edge positions. */
3225 first_pos = width_p ? XINT (w->left_col) : XINT (w->top_line);
3226 last_pos = first_pos;
3227 for (n = 0, child = *forward; !NILP (child); child = c->next, ++n)
3229 int new_size, old_size;
3231 c = XWINDOW (child);
3232 old_size = WINDOW_TOTAL_SIZE (c, width_p);
3233 new_size = old_size;
3235 /* The top or left edge position of this child equals the
3236 bottom or right edge of its predecessor. */
3237 if (width_p)
3238 c->left_col = make_number (last_pos);
3239 else
3240 c->top_line = make_number (last_pos);
3242 /* If this child can be resized, do it. */
3243 if (resize_fixed_p || !window_fixed_size_p (c, width_p, 0))
3245 new_size = new_sizes ? new_sizes[n] : old_size + each + extra;
3246 extra = 0;
3249 /* Set new size. Note that size_window also propagates
3250 edge positions to children, so it's not a no-op if we
3251 didn't change the child's size. */
3252 size_window (child, new_size, width_p, 1, first_only, last_only);
3254 /* Remember the bottom/right edge position of this child; it
3255 will be used to set the top/left edge of the next child. */
3256 last_pos += new_size;
3259 xfree (new_sizes);
3261 /* We should have covered the parent exactly with child windows. */
3262 xassert (size == last_pos - first_pos);
3264 /* Now delete any children that became too small. */
3265 if (nodelete_p != 1)
3266 for (child = *forward; !NILP (child); child = c->next)
3268 int child_size;
3270 c = XWINDOW (child);
3271 child_size = WINDOW_TOTAL_SIZE (c, width_p);
3272 size_window (child, child_size, width_p, nodelete_p,
3273 first_only, last_only);
3278 /* Set WINDOW's height to HEIGHT, and recursively change the height of
3279 WINDOW's children. NODELETE zero means windows that have become
3280 smaller than window-min-height in the process may be deleted.
3281 NODELETE 1 means never delete windows that become too small in the
3282 process. (The caller should check later and do so if appropriate.)
3283 NODELETE 2 means delete only windows that have become too small to be
3284 displayed correctly. */
3286 void
3287 set_window_height (window, height, nodelete)
3288 Lisp_Object window;
3289 int height;
3290 int nodelete;
3292 size_window (window, height, 0, nodelete, 0, 0);
3295 /* Set WINDOW's width to WIDTH, and recursively change the width of
3296 WINDOW's children. NODELETE zero means windows that have become
3297 smaller than window-min-width in the process may be deleted.
3298 NODELETE 1 means never delete windows that become too small in the
3299 process. (The caller should check later and do so if appropriate.)
3300 NODELETE 2 means delete only windows that have become too small to be
3301 displayed correctly. */
3303 void
3304 set_window_width (window, width, nodelete)
3305 Lisp_Object window;
3306 int width;
3307 int nodelete;
3309 size_window (window, width, 1, nodelete, 0, 0);
3312 /* Change window heights in windows rooted in WINDOW by N lines. */
3314 void
3315 change_window_heights (window, n)
3316 Lisp_Object window;
3317 int n;
3319 struct window *w = XWINDOW (window);
3321 XSETFASTINT (w->top_line, XFASTINT (w->top_line) + n);
3322 XSETFASTINT (w->total_lines, XFASTINT (w->total_lines) - n);
3324 if (INTEGERP (w->orig_top_line))
3325 XSETFASTINT (w->orig_top_line, XFASTINT (w->orig_top_line) + n);
3326 if (INTEGERP (w->orig_total_lines))
3327 XSETFASTINT (w->orig_total_lines, XFASTINT (w->orig_total_lines) - n);
3329 /* Handle just the top child in a vertical split. */
3330 if (!NILP (w->vchild))
3331 change_window_heights (w->vchild, n);
3333 /* Adjust all children in a horizontal split. */
3334 for (window = w->hchild; !NILP (window); window = w->next)
3336 w = XWINDOW (window);
3337 change_window_heights (window, n);
3342 int window_select_count;
3344 EXFUN (Fset_window_fringes, 4);
3345 EXFUN (Fset_window_scroll_bars, 4);
3347 static void
3348 run_funs (Lisp_Object funs)
3350 for (; CONSP (funs); funs = XCDR (funs))
3351 if (!EQ (XCAR (funs), Qt))
3352 call0 (XCAR (funs));
3355 static Lisp_Object select_window_norecord (Lisp_Object window);
3356 static Lisp_Object select_frame_norecord (Lisp_Object frame);
3358 void
3359 run_window_configuration_change_hook (struct frame *f)
3361 int count = SPECPDL_INDEX ();
3362 Lisp_Object frame, global_wcch
3363 = Fdefault_value (Qwindow_configuration_change_hook);
3364 XSETFRAME (frame, f);
3366 if (NILP (Vrun_hooks))
3367 return;
3369 if (SELECTED_FRAME () != f)
3371 record_unwind_protect (select_frame_norecord, Fselected_frame ());
3372 Fselect_frame (frame, Qt);
3375 /* Use the right buffer. Matters when running the local hooks. */
3376 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3378 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3379 Fset_buffer (Fwindow_buffer (Qnil));
3382 /* Look for buffer-local values. */
3384 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3385 for (; CONSP (windows); windows = XCDR (windows))
3387 Lisp_Object window = XCAR (windows);
3388 Lisp_Object buffer = Fwindow_buffer (window);
3389 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3390 buffer)))
3392 int count = SPECPDL_INDEX ();
3393 record_unwind_protect (select_window_norecord, Fselected_window ());
3394 select_window_norecord (window);
3395 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3396 buffer));
3397 unbind_to (count, Qnil);
3402 run_funs (global_wcch);
3403 unbind_to (count, Qnil);
3406 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
3407 means it's allowed to run hooks. See make_frame for a case where
3408 it's not allowed. KEEP_MARGINS_P non-zero means that the current
3409 margins, fringes, and scroll-bar settings of the window are not
3410 reset from the buffer's local settings. */
3412 void
3413 set_window_buffer (window, buffer, run_hooks_p, keep_margins_p)
3414 Lisp_Object window, buffer;
3415 int run_hooks_p, keep_margins_p;
3417 struct window *w = XWINDOW (window);
3418 struct buffer *b = XBUFFER (buffer);
3419 int count = SPECPDL_INDEX ();
3420 int samebuf = EQ (buffer, w->buffer);
3422 w->buffer = buffer;
3424 if (EQ (window, selected_window))
3425 b->last_selected_window = window;
3427 /* Let redisplay errors through. */
3428 b->display_error_modiff = 0;
3430 /* Update time stamps of buffer display. */
3431 if (INTEGERP (b->display_count))
3432 XSETINT (b->display_count, XINT (b->display_count) + 1);
3433 b->display_time = Fcurrent_time ();
3435 XSETFASTINT (w->window_end_pos, 0);
3436 XSETFASTINT (w->window_end_vpos, 0);
3437 bzero (&w->last_cursor, sizeof w->last_cursor);
3438 w->window_end_valid = Qnil;
3439 if (!(keep_margins_p && samebuf))
3440 { /* If we're not actually changing the buffer, don't reset hscroll and
3441 vscroll. This case happens for example when called from
3442 change_frame_size_1, where we use a dummy call to
3443 Fset_window_buffer on the frame's selected window (and no other)
3444 just in order to run window-configuration-change-hook.
3445 Resetting hscroll and vscroll here is problematic for things like
3446 image-mode and doc-view-mode since it resets the image's position
3447 whenever we resize the frame. */
3448 w->hscroll = w->min_hscroll = make_number (0);
3449 w->vscroll = 0;
3450 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3451 set_marker_restricted (w->start,
3452 make_number (b->last_window_start),
3453 buffer);
3454 w->start_at_line_beg = Qnil;
3455 w->force_start = Qnil;
3456 XSETFASTINT (w->last_modified, 0);
3457 XSETFASTINT (w->last_overlay_modified, 0);
3459 /* Maybe we could move this into the `if' but it's not obviously safe and
3460 I doubt it's worth the trouble. */
3461 windows_or_buffers_changed++;
3463 /* We must select BUFFER for running the window-scroll-functions. */
3464 /* We can't check ! NILP (Vwindow_scroll_functions) here
3465 because that might itself be a local variable. */
3466 if (window_initialized)
3468 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3469 Fset_buffer (buffer);
3472 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3474 if (!keep_margins_p)
3476 /* Set left and right marginal area width etc. from buffer. */
3478 /* This may call adjust_window_margins three times, so
3479 temporarily disable window margins. */
3480 Lisp_Object save_left = w->left_margin_cols;
3481 Lisp_Object save_right = w->right_margin_cols;
3483 w->left_margin_cols = w->right_margin_cols = Qnil;
3485 Fset_window_fringes (window,
3486 b->left_fringe_width, b->right_fringe_width,
3487 b->fringes_outside_margins);
3489 Fset_window_scroll_bars (window,
3490 b->scroll_bar_width,
3491 b->vertical_scroll_bar_type, Qnil);
3493 w->left_margin_cols = save_left;
3494 w->right_margin_cols = save_right;
3496 Fset_window_margins (window,
3497 b->left_margin_cols, b->right_margin_cols);
3500 if (run_hooks_p)
3502 if (! NILP (Vwindow_scroll_functions))
3503 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3504 Fmarker_position (w->start));
3505 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3508 unbind_to (count, Qnil);
3512 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3513 doc: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3514 WINDOW defaults to the selected window. BUFFER-OR-NAME must be a buffer
3515 or the name of an existing buffer. Optional third argument KEEP-MARGINS
3516 non-nil means that WINDOW's current display margins, fringe widths, and
3517 scroll bar settings are preserved; the default is to reset these from
3518 the local settings for BUFFER-OR-NAME or the frame defaults. Return nil.
3520 This function throws an error when WINDOW is strongly dedicated to its
3521 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3522 already display BUFFER-OR-NAME.
3524 This function runs `window-scroll-functions' before running
3525 `window-configuration-change-hook'. */)
3526 (window, buffer_or_name, keep_margins)
3527 register Lisp_Object window, buffer_or_name, keep_margins;
3529 register Lisp_Object tem, buffer;
3530 register struct window *w = decode_window (window);
3532 XSETWINDOW (window, w);
3533 buffer = Fget_buffer (buffer_or_name);
3534 CHECK_BUFFER (buffer);
3535 if (NILP (XBUFFER (buffer)->name))
3536 error ("Attempt to display deleted buffer");
3538 tem = w->buffer;
3539 if (NILP (tem))
3540 error ("Window is deleted");
3541 else if (!EQ (tem, Qt))
3542 /* w->buffer is t when the window is first being set up. */
3544 if (!EQ (tem, buffer))
3545 if (EQ (w->dedicated, Qt))
3546 error ("Window is dedicated to `%s'", SDATA (XBUFFER (tem)->name));
3547 else
3548 w->dedicated = Qnil;
3550 unshow_buffer (w);
3553 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3554 return Qnil;
3557 /* Note that selected_window can be nil when this is called from
3558 Fset_window_configuration. */
3560 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
3561 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
3562 If WINDOW is not already selected, make WINDOW's buffer current
3563 and make WINDOW the frame's selected window. Return WINDOW.
3564 Optional second arg NORECORD non-nil means do not put this buffer
3565 at the front of the list of recently selected ones and do not
3566 make this window the most recently selected one.
3568 Note that the main editor command loop selects the buffer of the
3569 selected window before each command. */)
3570 (window, norecord)
3571 register Lisp_Object window, norecord;
3573 register struct window *w;
3574 register struct window *ow;
3575 struct frame *sf;
3577 CHECK_LIVE_WINDOW (window);
3579 w = XWINDOW (window);
3580 w->frozen_window_start_p = 0;
3582 if (NILP (norecord))
3584 ++window_select_count;
3585 XSETFASTINT (w->use_time, window_select_count);
3588 if (EQ (window, selected_window))
3589 return window;
3591 sf = SELECTED_FRAME ();
3592 if (XFRAME (WINDOW_FRAME (w)) != sf)
3594 XFRAME (WINDOW_FRAME (w))->selected_window = window;
3595 /* Use this rather than Fhandle_switch_frame
3596 so that FRAME_FOCUS_FRAME is moved appropriately as we
3597 move around in the state where a minibuffer in a separate
3598 frame is active. */
3599 Fselect_frame (WINDOW_FRAME (w), norecord);
3600 /* Fselect_frame called us back so we've done all the work already. */
3601 eassert (EQ (window, selected_window));
3602 return window;
3604 else
3605 sf->selected_window = window;
3607 /* Store the current buffer's actual point into the
3608 old selected window. It belongs to that window,
3609 and when the window is not selected, must be in the window. */
3610 if (!NILP (selected_window))
3612 ow = XWINDOW (selected_window);
3613 if (! NILP (ow->buffer))
3614 set_marker_both (ow->pointm, ow->buffer,
3615 BUF_PT (XBUFFER (ow->buffer)),
3616 BUF_PT_BYTE (XBUFFER (ow->buffer)));
3619 selected_window = window;
3621 if (NILP (norecord))
3622 record_buffer (w->buffer);
3623 Fset_buffer (w->buffer);
3625 XBUFFER (w->buffer)->last_selected_window = window;
3627 /* Go to the point recorded in the window.
3628 This is important when the buffer is in more
3629 than one window. It also matters when
3630 redisplay_window has altered point after scrolling,
3631 because it makes the change only in the window. */
3633 register int new_point = marker_position (w->pointm);
3634 if (new_point < BEGV)
3635 SET_PT (BEGV);
3636 else if (new_point > ZV)
3637 SET_PT (ZV);
3638 else
3639 SET_PT (new_point);
3642 windows_or_buffers_changed++;
3643 return window;
3646 static Lisp_Object
3647 select_window_norecord (window)
3648 Lisp_Object window;
3650 return WINDOW_LIVE_P (window)
3651 ? Fselect_window (window, Qt) : selected_window;
3654 static Lisp_Object
3655 select_frame_norecord (frame)
3656 Lisp_Object frame;
3658 return FRAME_LIVE_P (XFRAME (frame))
3659 ? Fselect_frame (frame, Qt) : selected_frame;
3662 Lisp_Object
3663 display_buffer (buffer, not_this_window_p, override_frame)
3664 Lisp_Object buffer, not_this_window_p, override_frame;
3666 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3669 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3670 0, 1, 0,
3671 doc: /* Force all windows to be updated on next redisplay.
3672 If optional arg OBJECT is a window, force redisplay of that window only.
3673 If OBJECT is a buffer or buffer name, force redisplay of all windows
3674 displaying that buffer. */)
3675 (object)
3676 Lisp_Object object;
3678 if (NILP (object))
3680 windows_or_buffers_changed++;
3681 update_mode_lines++;
3682 return Qt;
3685 if (WINDOWP (object))
3687 struct window *w = XWINDOW (object);
3688 mark_window_display_accurate (object, 0);
3689 w->update_mode_line = Qt;
3690 if (BUFFERP (w->buffer))
3691 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3692 ++update_mode_lines;
3693 return Qt;
3696 if (STRINGP (object))
3697 object = Fget_buffer (object);
3698 if (BUFFERP (object) && !NILP (XBUFFER (object)->name))
3700 /* Walk all windows looking for buffer, and force update
3701 of each of those windows. */
3703 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3704 return NILP (object) ? Qnil : Qt;
3707 /* If nothing suitable was found, just return.
3708 We could signal an error, but this feature will typically be used
3709 asynchronously in timers or process sentinels, so we don't. */
3710 return Qnil;
3714 void
3715 temp_output_buffer_show (buf)
3716 register Lisp_Object buf;
3718 register struct buffer *old = current_buffer;
3719 register Lisp_Object window;
3720 register struct window *w;
3722 XBUFFER (buf)->directory = current_buffer->directory;
3724 Fset_buffer (buf);
3725 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3726 BEGV = BEG;
3727 ZV = Z;
3728 SET_PT (BEG);
3729 #if 0 /* rms: there should be no reason for this. */
3730 XBUFFER (buf)->prevent_redisplay_optimizations_p = 1;
3731 #endif
3732 set_buffer_internal (old);
3734 if (!NILP (Vtemp_buffer_show_function))
3735 call1 (Vtemp_buffer_show_function, buf);
3736 else
3738 window = display_buffer (buf, Qnil, Qnil);
3740 if (!EQ (XWINDOW (window)->frame, selected_frame))
3741 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3742 Vminibuf_scroll_window = window;
3743 w = XWINDOW (window);
3744 XSETFASTINT (w->hscroll, 0);
3745 XSETFASTINT (w->min_hscroll, 0);
3746 set_marker_restricted_both (w->start, buf, BEG, BEG);
3747 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3749 /* Run temp-buffer-show-hook, with the chosen window selected
3750 and its buffer current. */
3752 if (!NILP (Vrun_hooks)
3753 && !NILP (Fboundp (Qtemp_buffer_show_hook))
3754 && !NILP (Fsymbol_value (Qtemp_buffer_show_hook)))
3756 int count = SPECPDL_INDEX ();
3757 Lisp_Object prev_window, prev_buffer;
3758 prev_window = selected_window;
3759 XSETBUFFER (prev_buffer, old);
3761 /* Select the window that was chosen, for running the hook.
3762 Note: Both Fselect_window and select_window_norecord may
3763 set-buffer to the buffer displayed in the window,
3764 so we need to save the current buffer. --stef */
3765 record_unwind_protect (Fset_buffer, prev_buffer);
3766 record_unwind_protect (select_window_norecord, prev_window);
3767 Fselect_window (window, Qt);
3768 Fset_buffer (w->buffer);
3769 call1 (Vrun_hooks, Qtemp_buffer_show_hook);
3770 unbind_to (count, Qnil);
3775 static void
3776 make_dummy_parent (window)
3777 Lisp_Object window;
3779 Lisp_Object new;
3780 register struct window *o, *p;
3781 int i;
3783 o = XWINDOW (window);
3784 p = allocate_window ();
3785 for (i = 0; i < VECSIZE (struct window); ++i)
3786 ((struct Lisp_Vector *) p)->contents[i]
3787 = ((struct Lisp_Vector *)o)->contents[i];
3788 XSETWINDOW (new, p);
3790 ++sequence_number;
3791 XSETFASTINT (p->sequence_number, sequence_number);
3793 /* Put new into window structure in place of window */
3794 replace_window (window, new);
3796 o->next = Qnil;
3797 o->prev = Qnil;
3798 o->vchild = Qnil;
3799 o->hchild = Qnil;
3800 o->parent = new;
3802 p->start = Qnil;
3803 p->pointm = Qnil;
3804 p->buffer = Qnil;
3807 DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "",
3808 doc: /* Split WINDOW, putting SIZE lines in the first of the pair.
3809 WINDOW defaults to selected one and SIZE to half its size.
3810 If optional third arg HORIZONTAL is non-nil, split side by side and put
3811 SIZE columns in the first of the pair. In that case, SIZE includes that
3812 window's scroll bar, or the divider column to its right.
3813 Interactively, all arguments are nil.
3814 Returns the newly created window (which is the lower or rightmost one).
3815 The upper or leftmost window is the original one, and remains selected
3816 if it was selected before.
3818 See Info node `(elisp)Splitting Windows' for more details and examples. */)
3819 (window, size, horizontal)
3820 Lisp_Object window, size, horizontal;
3822 register Lisp_Object new;
3823 register struct window *o, *p;
3824 FRAME_PTR fo;
3825 register int size_int;
3827 if (NILP (window))
3828 window = selected_window;
3829 else
3830 CHECK_LIVE_WINDOW (window);
3832 o = XWINDOW (window);
3833 fo = XFRAME (WINDOW_FRAME (o));
3835 if (NILP (size))
3837 if (!NILP (horizontal))
3838 /* Calculate the size of the left-hand window, by dividing
3839 the usable space in columns by two.
3840 We round up, since the left-hand window may include
3841 a dividing line, while the right-hand may not. */
3842 size_int = (XFASTINT (o->total_cols) + 1) >> 1;
3843 else
3844 size_int = XFASTINT (o->total_lines) >> 1;
3846 else
3848 CHECK_NUMBER (size);
3849 size_int = XINT (size);
3852 if (MINI_WINDOW_P (o))
3853 error ("Attempt to split minibuffer window");
3854 else if (window_fixed_size_p (o, !NILP (horizontal), 0))
3855 error ("Attempt to split fixed-size window");
3857 if (NILP (horizontal))
3859 int window_safe_height = window_min_size_2 (o, 0, 0);
3861 if (size_int < window_safe_height)
3862 error ("Window height %d too small (after splitting)", size_int);
3863 if (size_int + window_safe_height > XFASTINT (o->total_lines))
3864 error ("Window height %d too small (after splitting)",
3865 XFASTINT (o->total_lines) - size_int);
3866 if (NILP (o->parent)
3867 || NILP (XWINDOW (o->parent)->vchild))
3869 make_dummy_parent (window);
3870 new = o->parent;
3871 XWINDOW (new)->vchild = window;
3874 else
3876 int window_safe_width = window_min_size_2 (o, 1, 0);
3878 if (size_int < window_safe_width)
3879 error ("Window width %d too small (after splitting)", size_int);
3880 if (size_int + window_safe_width > XFASTINT (o->total_cols))
3881 error ("Window width %d too small (after splitting)",
3882 XFASTINT (o->total_cols) - size_int);
3883 if (NILP (o->parent)
3884 || NILP (XWINDOW (o->parent)->hchild))
3886 make_dummy_parent (window);
3887 new = o->parent;
3888 XWINDOW (new)->hchild = window;
3892 /* Now we know that window's parent is a vertical combination
3893 if we are dividing vertically, or a horizontal combination
3894 if we are making side-by-side windows */
3896 windows_or_buffers_changed++;
3897 FRAME_WINDOW_SIZES_CHANGED (fo) = 1;
3898 new = make_window ();
3899 p = XWINDOW (new);
3901 p->frame = o->frame;
3902 p->next = o->next;
3903 if (!NILP (p->next))
3904 XWINDOW (p->next)->prev = new;
3905 p->prev = window;
3906 o->next = new;
3907 p->parent = o->parent;
3908 p->buffer = Qt;
3909 p->window_end_valid = Qnil;
3910 bzero (&p->last_cursor, sizeof p->last_cursor);
3912 /* Duplicate special geometry settings. */
3914 p->left_margin_cols = o->left_margin_cols;
3915 p->right_margin_cols = o->right_margin_cols;
3916 p->left_fringe_width = o->left_fringe_width;
3917 p->right_fringe_width = o->right_fringe_width;
3918 p->fringes_outside_margins = o->fringes_outside_margins;
3919 p->scroll_bar_width = o->scroll_bar_width;
3920 p->vertical_scroll_bar_type = o->vertical_scroll_bar_type;
3922 /* Apportion the available frame space among the two new windows */
3924 if (!NILP (horizontal))
3926 p->total_lines = o->total_lines;
3927 p->top_line = o->top_line;
3928 XSETFASTINT (p->total_cols, XFASTINT (o->total_cols) - size_int);
3929 XSETFASTINT (o->total_cols, size_int);
3930 XSETFASTINT (p->left_col, XFASTINT (o->left_col) + size_int);
3931 adjust_window_margins (p);
3932 adjust_window_margins (o);
3934 else
3936 p->left_col = o->left_col;
3937 p->total_cols = o->total_cols;
3938 XSETFASTINT (p->total_lines, XFASTINT (o->total_lines) - size_int);
3939 XSETFASTINT (o->total_lines, size_int);
3940 XSETFASTINT (p->top_line, XFASTINT (o->top_line) + size_int);
3943 /* Adjust glyph matrices. */
3944 adjust_glyphs (fo);
3946 Fset_window_buffer (new, o->buffer, Qt);
3947 return new;
3950 DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 2, "p",
3951 doc: /* Make selected window SIZE lines taller.
3952 Interactively, if no argument is given, make the selected window one
3953 line taller. If optional argument HORIZONTAL is non-nil, make selected
3954 window wider by SIZE columns. If SIZE is negative, shrink the window by
3955 -SIZE lines or columns. Return nil.
3957 This function can delete windows if they get too small. The size of
3958 fixed size windows is not altered by this function. */)
3959 (size, horizontal)
3960 Lisp_Object size, horizontal;
3962 CHECK_NUMBER (size);
3963 enlarge_window (selected_window, XINT (size), !NILP (horizontal));
3965 run_window_configuration_change_hook (SELECTED_FRAME ());
3967 return Qnil;
3970 DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 2, "p",
3971 doc: /* Make selected window SIZE lines smaller.
3972 Interactively, if no argument is given, make the selected window one
3973 line smaller. If optional argument HORIZONTAL is non-nil, make the
3974 window narrower by SIZE columns. If SIZE is negative, enlarge selected
3975 window by -SIZE lines or columns. Return nil.
3977 This function can delete windows if they get too small. The size of
3978 fixed size windows is not altered by this function. */)
3979 (size, horizontal)
3980 Lisp_Object size, horizontal;
3982 CHECK_NUMBER (size);
3983 enlarge_window (selected_window, -XINT (size), !NILP (horizontal));
3985 run_window_configuration_change_hook (SELECTED_FRAME ());
3987 return Qnil;
3991 window_height (window)
3992 Lisp_Object window;
3994 register struct window *p = XWINDOW (window);
3995 return WINDOW_TOTAL_LINES (p);
3999 window_width (window)
4000 Lisp_Object window;
4002 register struct window *p = XWINDOW (window);
4003 return WINDOW_TOTAL_COLS (p);
4007 #define CURBEG(w) \
4008 *(horiz_flag ? &(XWINDOW (w)->left_col) : &(XWINDOW (w)->top_line))
4010 #define CURSIZE(w) \
4011 *(horiz_flag ? &(XWINDOW (w)->total_cols) : &(XWINDOW (w)->total_lines))
4014 /* Enlarge WINDOW by DELTA. HORIZ_FLAG nonzero means enlarge it
4015 horizontally; zero means do it vertically.
4017 Siblings of the selected window are resized to fulfill the size
4018 request. If they become too small in the process, they may be
4019 deleted. */
4021 static void
4022 enlarge_window (window, delta, horiz_flag)
4023 Lisp_Object window;
4024 int delta, horiz_flag;
4026 Lisp_Object parent, next, prev;
4027 struct window *p;
4028 Lisp_Object *sizep;
4029 int maximum;
4030 int (*sizefun) P_ ((Lisp_Object))
4031 = horiz_flag ? window_width : window_height;
4032 void (*setsizefun) P_ ((Lisp_Object, int, int))
4033 = (horiz_flag ? set_window_width : set_window_height);
4035 /* Give up if this window cannot be resized. */
4036 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
4037 error ("Window is not resizable");
4039 /* Find the parent of the selected window. */
4040 while (1)
4042 p = XWINDOW (window);
4043 parent = p->parent;
4045 if (NILP (parent))
4047 if (horiz_flag)
4048 error ("No other window to side of this one");
4049 break;
4052 if (horiz_flag
4053 ? !NILP (XWINDOW (parent)->hchild)
4054 : !NILP (XWINDOW (parent)->vchild))
4055 break;
4057 window = parent;
4060 sizep = &CURSIZE (window);
4063 register int maxdelta;
4065 /* Compute the maximum size increment this window can have. */
4067 maxdelta = (!NILP (parent) ? (*sizefun) (parent) - XINT (*sizep)
4068 /* This is a main window followed by a minibuffer. */
4069 : !NILP (p->next) ? ((*sizefun) (p->next)
4070 - window_min_size (XWINDOW (p->next),
4071 horiz_flag, 0, 0, 0))
4072 /* This is a minibuffer following a main window. */
4073 : !NILP (p->prev) ? ((*sizefun) (p->prev)
4074 - window_min_size (XWINDOW (p->prev),
4075 horiz_flag, 0, 0, 0))
4076 /* This is a frame with only one window, a minibuffer-only
4077 or a minibufferless frame. */
4078 : (delta = 0));
4080 if (delta > maxdelta)
4081 /* This case traps trying to make the minibuffer
4082 the full frame, or make the only window aside from the
4083 minibuffer the full frame. */
4084 delta = maxdelta;
4087 if (XINT (*sizep) + delta < window_min_size (XWINDOW (window),
4088 horiz_flag, 0, 0, 0))
4090 delete_window (window);
4091 return;
4094 if (delta == 0)
4095 return;
4097 /* Find the total we can get from other siblings without deleting them. */
4098 maximum = 0;
4099 for (next = p->next; WINDOWP (next); next = XWINDOW (next)->next)
4100 maximum += (*sizefun) (next) - window_min_size (XWINDOW (next),
4101 horiz_flag, 0, 0, 0);
4102 for (prev = p->prev; WINDOWP (prev); prev = XWINDOW (prev)->prev)
4103 maximum += (*sizefun) (prev) - window_min_size (XWINDOW (prev),
4104 horiz_flag, 0, 0, 0);
4106 /* If we can get it all from them without deleting them, do so. */
4107 if (delta <= maximum)
4109 Lisp_Object first_unaffected;
4110 Lisp_Object first_affected;
4111 int fixed_p;
4113 next = p->next;
4114 prev = p->prev;
4115 first_affected = window;
4116 /* Look at one sibling at a time,
4117 moving away from this window in both directions alternately,
4118 and take as much as we can get without deleting that sibling. */
4119 while (delta != 0
4120 && (!NILP (next) || !NILP (prev)))
4122 if (! NILP (next))
4124 int this_one = ((*sizefun) (next)
4125 - window_min_size (XWINDOW (next), horiz_flag,
4126 0, 0, &fixed_p));
4127 if (!fixed_p)
4129 if (this_one > delta)
4130 this_one = delta;
4132 (*setsizefun) (next, (*sizefun) (next) - this_one, 0);
4133 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4135 delta -= this_one;
4138 next = XWINDOW (next)->next;
4141 if (delta == 0)
4142 break;
4144 if (! NILP (prev))
4146 int this_one = ((*sizefun) (prev)
4147 - window_min_size (XWINDOW (prev), horiz_flag,
4148 0, 0, &fixed_p));
4149 if (!fixed_p)
4151 if (this_one > delta)
4152 this_one = delta;
4154 first_affected = prev;
4156 (*setsizefun) (prev, (*sizefun) (prev) - this_one, 0);
4157 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
4159 delta -= this_one;
4162 prev = XWINDOW (prev)->prev;
4166 xassert (delta == 0);
4168 /* Now recalculate the edge positions of all the windows affected,
4169 based on the new sizes. */
4170 first_unaffected = next;
4171 prev = first_affected;
4172 for (next = XWINDOW (prev)->next; ! EQ (next, first_unaffected);
4173 prev = next, next = XWINDOW (next)->next)
4175 XSETINT (CURBEG (next), XINT (CURBEG (prev)) + (*sizefun) (prev));
4176 /* This does not change size of NEXT,
4177 but it propagates the new top edge to its children */
4178 (*setsizefun) (next, (*sizefun) (next), 0);
4181 else
4183 register int delta1;
4184 register int opht = (*sizefun) (parent);
4186 if (opht <= XINT (*sizep) + delta)
4188 /* If trying to grow this window to or beyond size of the parent,
4189 just delete all the sibling windows. */
4190 Lisp_Object start, tem, next;
4192 start = XWINDOW (parent)->vchild;
4193 if (NILP (start))
4194 start = XWINDOW (parent)->hchild;
4196 /* Delete any siblings that come after WINDOW. */
4197 tem = XWINDOW (window)->next;
4198 while (! NILP (tem))
4200 next = XWINDOW (tem)->next;
4201 delete_window (tem);
4202 tem = next;
4205 /* Delete any siblings that come after WINDOW.
4206 Note that if START is not WINDOW, then WINDOW still
4207 has siblings, so WINDOW has not yet replaced its parent. */
4208 tem = start;
4209 while (! EQ (tem, window))
4211 next = XWINDOW (tem)->next;
4212 delete_window (tem);
4213 tem = next;
4216 else
4218 /* Otherwise, make delta1 just right so that if we add
4219 delta1 lines to this window and to the parent, and then
4220 shrink the parent back to its original size, the new
4221 proportional size of this window will increase by delta.
4223 The function size_window will compute the new height h'
4224 of the window from delta1 as:
4226 e = delta1/n
4227 x = delta1 - delta1/n * n for the 1st resizable child
4228 h' = h + e + x
4230 where n is the number of children that can be resized.
4231 We can ignore x by choosing a delta1 that is a multiple of
4232 n. We want the height of this window to come out as
4234 h' = h + delta
4236 So, delta1 must be
4238 h + e = h + delta
4239 delta1/n = delta
4240 delta1 = n * delta.
4242 The number of children n equals the number of resizable
4243 children of this window + 1 because we know window itself
4244 is resizable (otherwise we would have signaled an error).
4246 This reasoning is not correct when other windows become too
4247 small and shrink_windows refuses to delete them. Below we
4248 use resize_proportionally to work around this problem. */
4250 struct window *w = XWINDOW (window);
4251 Lisp_Object s;
4252 int n = 1;
4254 for (s = w->next; WINDOWP (s); s = XWINDOW (s)->next)
4255 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4256 ++n;
4257 for (s = w->prev; WINDOWP (s); s = XWINDOW (s)->prev)
4258 if (!window_fixed_size_p (XWINDOW (s), horiz_flag, 0))
4259 ++n;
4261 delta1 = n * delta;
4263 /* Add delta1 lines or columns to this window, and to the parent,
4264 keeping things consistent while not affecting siblings. */
4265 XSETINT (CURSIZE (parent), opht + delta1);
4266 (*setsizefun) (window, XINT (*sizep) + delta1, 0);
4268 /* Squeeze out delta1 lines or columns from our parent,
4269 shrinking this window and siblings proportionately. This
4270 brings parent back to correct size. Delta1 was calculated
4271 so this makes this window the desired size, taking it all
4272 out of the siblings.
4274 Temporarily set resize_proportionally to Qt to assure that,
4275 if necessary, shrink_windows deletes smaller windows rather
4276 than shrink this window. */
4277 w->resize_proportionally = Qt;
4278 (*setsizefun) (parent, opht, 0);
4279 w->resize_proportionally = Qnil;
4283 XSETFASTINT (p->last_modified, 0);
4284 XSETFASTINT (p->last_overlay_modified, 0);
4286 /* Adjust glyph matrices. */
4287 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4291 /* Adjust the size of WINDOW by DELTA, moving only its trailing edge.
4292 HORIZ_FLAG nonzero means adjust the width, moving the right edge.
4293 zero means adjust the height, moving the bottom edge.
4295 Following siblings of the selected window are resized to fulfill
4296 the size request. If they become too small in the process, they
4297 are not deleted; instead, we signal an error. */
4299 static void
4300 adjust_window_trailing_edge (window, delta, horiz_flag)
4301 Lisp_Object window;
4302 int delta, horiz_flag;
4304 Lisp_Object parent, child;
4305 struct window *p;
4306 Lisp_Object old_config = Fcurrent_window_configuration (Qnil);
4307 int delcount = window_deletion_count;
4309 CHECK_WINDOW (window);
4311 /* Give up if this window cannot be resized. */
4312 if (window_fixed_size_p (XWINDOW (window), horiz_flag, 1))
4313 error ("Window is not resizable");
4315 while (1)
4317 Lisp_Object first_parallel = Qnil;
4319 if (NILP (window))
4321 /* This happens if WINDOW on the previous iteration was
4322 at top level of the window tree. */
4323 Fset_window_configuration (old_config);
4324 error ("Specified window edge is fixed");
4327 p = XWINDOW (window);
4328 parent = p->parent;
4330 /* See if this level has windows in parallel in the specified
4331 direction. If so, set FIRST_PARALLEL to the first one. */
4332 if (horiz_flag)
4334 if (! NILP (parent) && !NILP (XWINDOW (parent)->vchild))
4335 first_parallel = XWINDOW (parent)->vchild;
4336 else if (NILP (parent) && !NILP (p->next))
4338 /* Handle the vertical chain of main window and minibuffer
4339 which has no parent. */
4340 first_parallel = window;
4341 while (! NILP (XWINDOW (first_parallel)->prev))
4342 first_parallel = XWINDOW (first_parallel)->prev;
4345 else
4347 if (! NILP (parent) && !NILP (XWINDOW (parent)->hchild))
4348 first_parallel = XWINDOW (parent)->hchild;
4351 /* If this level's succession is in the desired dimension,
4352 and this window is the last one, and there is no higher level,
4353 its trailing edge is fixed. */
4354 if (NILP (XWINDOW (window)->next) && NILP (first_parallel)
4355 && NILP (parent))
4357 Fset_window_configuration (old_config);
4358 error ("Specified window edge is fixed");
4361 /* Don't make this window too small. */
4362 if (XINT (CURSIZE (window)) + delta
4363 < window_min_size_2 (XWINDOW (window), horiz_flag, 0))
4365 Fset_window_configuration (old_config);
4366 error ("Cannot adjust window size as specified");
4369 /* Clear out some redisplay caches. */
4370 XSETFASTINT (p->last_modified, 0);
4371 XSETFASTINT (p->last_overlay_modified, 0);
4373 /* Adjust this window's edge. */
4374 XSETINT (CURSIZE (window),
4375 XINT (CURSIZE (window)) + delta);
4377 /* If this window has following siblings in the desired dimension,
4378 make them smaller, and exit the loop.
4380 (If we reach the top of the tree and can never do this,
4381 we will fail and report an error, above.) */
4382 if (NILP (first_parallel))
4384 if (!NILP (p->next))
4386 /* This may happen for the minibuffer. In that case
4387 the window_deletion_count check below does not work. */
4388 if (XINT (CURSIZE (p->next)) - delta <= 0)
4390 Fset_window_configuration (old_config);
4391 error ("Cannot adjust window size as specified");
4394 XSETINT (CURBEG (p->next),
4395 XINT (CURBEG (p->next)) + delta);
4396 size_window (p->next, XINT (CURSIZE (p->next)) - delta,
4397 horiz_flag, 0, 1, 0);
4398 break;
4401 else
4402 /* Here we have a chain of parallel siblings, in the other dimension.
4403 Change the size of the other siblings. */
4404 for (child = first_parallel;
4405 ! NILP (child);
4406 child = XWINDOW (child)->next)
4407 if (! EQ (child, window))
4408 size_window (child, XINT (CURSIZE (child)) + delta,
4409 horiz_flag, 0, 0, 1);
4411 window = parent;
4414 /* If we made a window so small it got deleted,
4415 we failed. Report failure. */
4416 if (delcount != window_deletion_count)
4418 Fset_window_configuration (old_config);
4419 error ("Cannot adjust window size as specified");
4422 /* Adjust glyph matrices. */
4423 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4426 #undef CURBEG
4427 #undef CURSIZE
4429 DEFUN ("adjust-window-trailing-edge", Fadjust_window_trailing_edge,
4430 Sadjust_window_trailing_edge, 3, 3, 0,
4431 doc: /* Adjust the bottom or right edge of WINDOW by DELTA.
4432 If HORIZONTAL is non-nil, that means adjust the width, moving the right edge.
4433 Otherwise, adjust the height, moving the bottom edge.
4435 Following siblings of the selected window are resized to fulfill
4436 the size request. If they become too small in the process, they
4437 are not deleted; instead, we signal an error. */)
4438 (window, delta, horizontal)
4439 Lisp_Object window, delta, horizontal;
4441 CHECK_NUMBER (delta);
4442 if (NILP (window))
4443 window = selected_window;
4444 adjust_window_trailing_edge (window, XINT (delta), !NILP (horizontal));
4446 run_window_configuration_change_hook
4447 (XFRAME (WINDOW_FRAME (XWINDOW (window))));
4449 return Qnil;
4454 /***********************************************************************
4455 Resizing Mini-Windows
4456 ***********************************************************************/
4458 static void shrink_window_lowest_first P_ ((struct window *, int));
4460 enum save_restore_action
4462 CHECK_ORIG_SIZES,
4463 SAVE_ORIG_SIZES,
4464 RESTORE_ORIG_SIZES
4467 static int save_restore_orig_size P_ ((struct window *,
4468 enum save_restore_action));
4470 /* Shrink windows rooted in window W to HEIGHT. Take the space needed
4471 from lowest windows first. */
4473 static void
4474 shrink_window_lowest_first (w, height)
4475 struct window *w;
4476 int height;
4478 struct window *c;
4479 Lisp_Object child;
4480 int old_height;
4482 xassert (!MINI_WINDOW_P (w));
4484 /* Set redisplay hints. */
4485 XSETFASTINT (w->last_modified, 0);
4486 XSETFASTINT (w->last_overlay_modified, 0);
4487 windows_or_buffers_changed++;
4488 FRAME_WINDOW_SIZES_CHANGED (XFRAME (WINDOW_FRAME (w))) = 1;
4490 old_height = XFASTINT (w->total_lines);
4491 XSETFASTINT (w->total_lines, height);
4493 if (!NILP (w->hchild))
4495 for (child = w->hchild; !NILP (child); child = c->next)
4497 c = XWINDOW (child);
4498 c->top_line = w->top_line;
4499 shrink_window_lowest_first (c, height);
4502 else if (!NILP (w->vchild))
4504 Lisp_Object last_child;
4505 int delta = old_height - height;
4506 int last_top;
4508 last_child = Qnil;
4510 /* Find the last child. We are taking space from lowest windows
4511 first, so we iterate over children from the last child
4512 backwards. */
4513 for (child = w->vchild; WINDOWP (child); child = XWINDOW (child)->next)
4514 last_child = child;
4516 /* Size children down to their safe heights. */
4517 for (child = last_child; delta && !NILP (child); child = c->prev)
4519 int this_one;
4521 c = XWINDOW (child);
4522 this_one = XFASTINT (c->total_lines) - window_min_size_1 (c, 0, 1);
4524 if (this_one > delta)
4525 this_one = delta;
4527 shrink_window_lowest_first (c, XFASTINT (c->total_lines) - this_one);
4528 delta -= this_one;
4531 /* Compute new positions. */
4532 last_top = XINT (w->top_line);
4533 for (child = w->vchild; !NILP (child); child = c->next)
4535 c = XWINDOW (child);
4536 c->top_line = make_number (last_top);
4537 shrink_window_lowest_first (c, XFASTINT (c->total_lines));
4538 last_top += XFASTINT (c->total_lines);
4544 /* Save, restore, or check positions and sizes in the window tree
4545 rooted at W. ACTION says what to do.
4547 If ACTION is CHECK_ORIG_SIZES, check if orig_top_line and
4548 orig_total_lines members are valid for all windows in the window
4549 tree. Value is non-zero if they are valid.
4551 If ACTION is SAVE_ORIG_SIZES, save members top and height in
4552 orig_top_line and orig_total_lines for all windows in the tree.
4554 If ACTION is RESTORE_ORIG_SIZES, restore top and height from values
4555 stored in orig_top_line and orig_total_lines for all windows. */
4557 static int
4558 save_restore_orig_size (w, action)
4559 struct window *w;
4560 enum save_restore_action action;
4562 int success_p = 1;
4564 while (w)
4566 if (!NILP (w->hchild))
4568 if (!save_restore_orig_size (XWINDOW (w->hchild), action))
4569 success_p = 0;
4571 else if (!NILP (w->vchild))
4573 if (!save_restore_orig_size (XWINDOW (w->vchild), action))
4574 success_p = 0;
4577 switch (action)
4579 case CHECK_ORIG_SIZES:
4580 if (!INTEGERP (w->orig_top_line) || !INTEGERP (w->orig_total_lines))
4581 return 0;
4582 break;
4584 case SAVE_ORIG_SIZES:
4585 w->orig_top_line = w->top_line;
4586 w->orig_total_lines = w->total_lines;
4587 XSETFASTINT (w->last_modified, 0);
4588 XSETFASTINT (w->last_overlay_modified, 0);
4589 break;
4591 case RESTORE_ORIG_SIZES:
4592 xassert (INTEGERP (w->orig_top_line) && INTEGERP (w->orig_total_lines));
4593 w->top_line = w->orig_top_line;
4594 w->total_lines = w->orig_total_lines;
4595 w->orig_total_lines = w->orig_top_line = Qnil;
4596 XSETFASTINT (w->last_modified, 0);
4597 XSETFASTINT (w->last_overlay_modified, 0);
4598 break;
4600 default:
4601 abort ();
4604 w = NILP (w->next) ? NULL : XWINDOW (w->next);
4607 return success_p;
4611 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we can
4612 without deleting other windows. */
4614 void
4615 grow_mini_window (w, delta)
4616 struct window *w;
4617 int delta;
4619 struct frame *f = XFRAME (w->frame);
4620 struct window *root;
4622 xassert (MINI_WINDOW_P (w));
4623 xassert (delta >= 0);
4625 /* Compute how much we can enlarge the mini-window without deleting
4626 other windows. */
4627 root = XWINDOW (FRAME_ROOT_WINDOW (f));
4628 if (delta)
4630 int min_height = window_min_size (root, 0, 0, 0, 0);
4631 if (XFASTINT (root->total_lines) - delta < min_height)
4632 /* Note that the root window may already be smaller than
4633 min_height. */
4634 delta = max (0, XFASTINT (root->total_lines) - min_height);
4637 if (delta)
4639 /* Save original window sizes and positions, if not already done. */
4640 if (!save_restore_orig_size (root, CHECK_ORIG_SIZES))
4641 save_restore_orig_size (root, SAVE_ORIG_SIZES);
4643 /* Shrink other windows. */
4644 shrink_window_lowest_first (root, XFASTINT (root->total_lines) - delta);
4646 /* Grow the mini-window. */
4647 w->top_line = make_number (XFASTINT (root->top_line) + XFASTINT (root->total_lines));
4648 w->total_lines = make_number (XFASTINT (w->total_lines) + delta);
4649 XSETFASTINT (w->last_modified, 0);
4650 XSETFASTINT (w->last_overlay_modified, 0);
4652 adjust_glyphs (f);
4657 /* Shrink mini-window W. If there is recorded info about window sizes
4658 before a call to grow_mini_window, restore recorded window sizes.
4659 Otherwise, if the mini-window is higher than 1 line, resize it to 1
4660 line. */
4662 void
4663 shrink_mini_window (w)
4664 struct window *w;
4666 struct frame *f = XFRAME (w->frame);
4667 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
4669 if (save_restore_orig_size (root, CHECK_ORIG_SIZES))
4671 save_restore_orig_size (root, RESTORE_ORIG_SIZES);
4672 adjust_glyphs (f);
4673 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4674 windows_or_buffers_changed = 1;
4676 else if (XFASTINT (w->total_lines) > 1)
4678 /* Distribute the additional lines of the mini-window
4679 among the other windows. */
4680 Lisp_Object window;
4681 XSETWINDOW (window, w);
4682 enlarge_window (window, 1 - XFASTINT (w->total_lines), 0);
4688 /* Mark window cursors off for all windows in the window tree rooted
4689 at W by setting their phys_cursor_on_p flag to zero. Called from
4690 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4691 the frame are cleared. */
4693 void
4694 mark_window_cursors_off (w)
4695 struct window *w;
4697 while (w)
4699 if (!NILP (w->hchild))
4700 mark_window_cursors_off (XWINDOW (w->hchild));
4701 else if (!NILP (w->vchild))
4702 mark_window_cursors_off (XWINDOW (w->vchild));
4703 else
4704 w->phys_cursor_on_p = 0;
4706 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4711 /* Return number of lines of text (not counting mode lines) in W. */
4714 window_internal_height (w)
4715 struct window *w;
4717 int ht = XFASTINT (w->total_lines);
4719 if (!MINI_WINDOW_P (w))
4721 if (!NILP (w->parent)
4722 || !NILP (w->vchild)
4723 || !NILP (w->hchild)
4724 || !NILP (w->next)
4725 || !NILP (w->prev)
4726 || WINDOW_WANTS_MODELINE_P (w))
4727 --ht;
4729 if (WINDOW_WANTS_HEADER_LINE_P (w))
4730 --ht;
4733 return ht;
4737 /* Return the number of columns in W.
4738 Don't count columns occupied by scroll bars or the vertical bar
4739 separating W from the sibling to its right. */
4742 window_box_text_cols (w)
4743 struct window *w;
4745 struct frame *f = XFRAME (WINDOW_FRAME (w));
4746 int width = XINT (w->total_cols);
4748 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
4749 /* Scroll bars occupy a few columns. */
4750 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
4751 else if (!FRAME_WINDOW_P (f)
4752 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
4753 /* The column of `|' characters separating side-by-side windows
4754 occupies one column only. */
4755 width -= 1;
4757 if (FRAME_WINDOW_P (f))
4758 /* On window-systems, fringes and display margins cannot be
4759 used for normal text. */
4760 width -= (WINDOW_FRINGE_COLS (w)
4761 + WINDOW_LEFT_MARGIN_COLS (w)
4762 + WINDOW_RIGHT_MARGIN_COLS (w));
4764 return width;
4768 /************************************************************************
4769 Window Scrolling
4770 ***********************************************************************/
4772 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4773 N screen-fulls, which is defined as the height of the window minus
4774 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4775 instead. Negative values of N mean scroll down. NOERROR non-zero
4776 means don't signal an error if we try to move over BEGV or ZV,
4777 respectively. */
4779 static void
4780 window_scroll (window, n, whole, noerror)
4781 Lisp_Object window;
4782 int n;
4783 int whole;
4784 int noerror;
4786 immediate_quit = 1;
4788 /* If we must, use the pixel-based version which is much slower than
4789 the line-based one but can handle varying line heights. */
4790 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4791 window_scroll_pixel_based (window, n, whole, noerror);
4792 else
4793 window_scroll_line_based (window, n, whole, noerror);
4795 immediate_quit = 0;
4799 /* Implementation of window_scroll that works based on pixel line
4800 heights. See the comment of window_scroll for parameter
4801 descriptions. */
4803 static void
4804 window_scroll_pixel_based (window, n, whole, noerror)
4805 Lisp_Object window;
4806 int n;
4807 int whole;
4808 int noerror;
4810 struct it it;
4811 struct window *w = XWINDOW (window);
4812 struct text_pos start;
4813 int this_scroll_margin;
4814 /* True if we fiddled the window vscroll field without really scrolling. */
4815 int vscrolled = 0;
4816 int x, y, rtop, rbot, rowh, vpos;
4818 SET_TEXT_POS_FROM_MARKER (start, w->start);
4820 /* If PT is not visible in WINDOW, move back one half of
4821 the screen. Allow PT to be partially visible, otherwise
4822 something like (scroll-down 1) with PT in the line before
4823 the partially visible one would recenter. */
4825 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4827 /* Move backward half the height of the window. Performance note:
4828 vmotion used here is about 10% faster, but would give wrong
4829 results for variable height lines. */
4830 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4831 it.current_y = it.last_visible_y;
4832 move_it_vertically_backward (&it, window_box_height (w) / 2);
4834 /* The function move_iterator_vertically may move over more than
4835 the specified y-distance. If it->w is small, e.g. a
4836 mini-buffer window, we may end up in front of the window's
4837 display area. This is the case when Start displaying at the
4838 start of the line containing PT in this case. */
4839 if (it.current_y <= 0)
4841 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4842 move_it_vertically_backward (&it, 0);
4843 it.current_y = 0;
4846 start = it.current.pos;
4848 else if (auto_window_vscroll_p)
4850 if (rtop || rbot) /* partially visible */
4852 int px;
4853 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4854 if (whole)
4855 dy = max ((window_box_height (w)
4856 - next_screen_context_lines * dy),
4857 dy);
4858 dy *= n;
4860 if (n < 0)
4862 /* Only vscroll backwards if already vscrolled forwards. */
4863 if (w->vscroll < 0 && rtop > 0)
4865 px = max (0, -w->vscroll - min (rtop, -dy));
4866 Fset_window_vscroll (window, make_number (px), Qt);
4867 return;
4870 if (n > 0)
4872 /* Do vscroll if already vscrolled or only display line. */
4873 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4875 px = max (0, -w->vscroll + min (rbot, dy));
4876 Fset_window_vscroll (window, make_number (px), Qt);
4877 return;
4880 /* Maybe modify window start instead of scrolling. */
4881 if (rbot > 0 || w->vscroll < 0)
4883 int spos;
4885 Fset_window_vscroll (window, make_number (0), Qt);
4886 /* If there are other text lines above the current row,
4887 move window start to current row. Else to next row. */
4888 if (rbot > 0)
4889 spos = XINT (Fline_beginning_position (Qnil));
4890 else
4891 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4892 set_marker_restricted (w->start, make_number (spos),
4893 w->buffer);
4894 w->start_at_line_beg = Qt;
4895 w->update_mode_line = Qt;
4896 XSETFASTINT (w->last_modified, 0);
4897 XSETFASTINT (w->last_overlay_modified, 0);
4898 /* Set force_start so that redisplay_window will run the
4899 window-scroll-functions. */
4900 w->force_start = Qt;
4901 return;
4905 /* Cancel previous vscroll. */
4906 Fset_window_vscroll (window, make_number (0), Qt);
4909 /* If scroll_preserve_screen_position is non-nil, we try to set
4910 point in the same window line as it is now, so get that line. */
4911 if (!NILP (Vscroll_preserve_screen_position))
4913 /* We preserve the goal pixel coordinate across consecutive
4914 calls to scroll-up or scroll-down. This avoids the
4915 possibility of point becoming "stuck" on a tall line when
4916 scrolling by one line. */
4917 if (window_scroll_pixel_based_preserve_y < 0
4918 || (!EQ (current_kboard->Vlast_command, Qscroll_up)
4919 && !EQ (current_kboard->Vlast_command, Qscroll_down)))
4921 start_display (&it, w, start);
4922 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4923 window_scroll_pixel_based_preserve_y = it.current_y;
4924 window_scroll_pixel_based_preserve_x = it.current_x;
4927 else
4928 window_scroll_pixel_based_preserve_y
4929 = window_scroll_pixel_based_preserve_x = -1;
4931 /* Move iterator it from start the specified distance forward or
4932 backward. The result is the new window start. */
4933 start_display (&it, w, start);
4934 if (whole)
4936 int start_pos = IT_CHARPOS (it);
4937 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4938 dy = max ((window_box_height (w)
4939 - next_screen_context_lines * dy),
4940 dy) * n;
4942 /* Note that move_it_vertically always moves the iterator to the
4943 start of a line. So, if the last line doesn't have a newline,
4944 we would end up at the start of the line ending at ZV. */
4945 if (dy <= 0)
4947 move_it_vertically_backward (&it, -dy);
4948 /* Ensure we actually do move, e.g. in case we are currently
4949 looking at an image that is taller that the window height. */
4950 while (start_pos == IT_CHARPOS (it)
4951 && start_pos > BEGV)
4952 move_it_by_lines (&it, -1, 1);
4954 else if (dy > 0)
4956 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4957 MOVE_TO_POS | MOVE_TO_Y);
4958 /* Ensure we actually do move, e.g. in case we are currently
4959 looking at an image that is taller that the window height. */
4960 while (start_pos == IT_CHARPOS (it)
4961 && start_pos < ZV)
4962 move_it_by_lines (&it, 1, 1);
4965 else
4966 move_it_by_lines (&it, n, 1);
4968 /* We failed if we find ZV is already on the screen (scrolling up,
4969 means there's nothing past the end), or if we can't start any
4970 earlier (scrolling down, means there's nothing past the top). */
4971 if ((n > 0 && IT_CHARPOS (it) == ZV)
4972 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4974 if (IT_CHARPOS (it) == ZV)
4976 if (it.current_y < it.last_visible_y
4977 && (it.current_y + it.max_ascent + it.max_descent
4978 > it.last_visible_y))
4980 /* The last line was only partially visible, make it fully
4981 visible. */
4982 w->vscroll = (it.last_visible_y
4983 - it.current_y + it.max_ascent + it.max_descent);
4984 adjust_glyphs (it.f);
4986 else if (noerror)
4987 return;
4988 else if (n < 0) /* could happen with empty buffers */
4989 xsignal0 (Qbeginning_of_buffer);
4990 else
4991 xsignal0 (Qend_of_buffer);
4993 else
4995 if (w->vscroll != 0)
4996 /* The first line was only partially visible, make it fully
4997 visible. */
4998 w->vscroll = 0;
4999 else if (noerror)
5000 return;
5001 else
5002 xsignal0 (Qbeginning_of_buffer);
5005 /* If control gets here, then we vscrolled. */
5007 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
5009 /* Don't try to change the window start below. */
5010 vscrolled = 1;
5013 if (! vscrolled)
5015 int pos = IT_CHARPOS (it);
5016 int bytepos;
5018 /* If in the middle of a multi-glyph character move forward to
5019 the next character. */
5020 if (in_display_vector_p (&it))
5022 ++pos;
5023 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
5026 /* Set the window start, and set up the window for redisplay. */
5027 set_marker_restricted (w->start, make_number (pos),
5028 w->buffer);
5029 bytepos = XMARKER (w->start)->bytepos;
5030 w->start_at_line_beg = ((pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n')
5031 ? Qt : Qnil);
5032 w->update_mode_line = Qt;
5033 XSETFASTINT (w->last_modified, 0);
5034 XSETFASTINT (w->last_overlay_modified, 0);
5035 /* Set force_start so that redisplay_window will run the
5036 window-scroll-functions. */
5037 w->force_start = Qt;
5040 /* The rest of this function uses current_y in a nonstandard way,
5041 not including the height of the header line if any. */
5042 it.current_y = it.vpos = 0;
5044 /* Move PT out of scroll margins.
5045 This code wants current_y to be zero at the window start position
5046 even if there is a header line. */
5047 this_scroll_margin = max (0, scroll_margin);
5048 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
5049 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
5051 if (n > 0)
5053 /* We moved the window start towards ZV, so PT may be now
5054 in the scroll margin at the top. */
5055 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
5056 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
5057 && (NILP (Vscroll_preserve_screen_position)
5058 || EQ (Vscroll_preserve_screen_position, Qt)))
5059 /* We found PT at a legitimate height. Leave it alone. */
5061 else if (window_scroll_pixel_based_preserve_y >= 0)
5063 /* If we have a header line, take account of it.
5064 This is necessary because we set it.current_y to 0, above. */
5065 move_it_to (&it, -1,
5066 window_scroll_pixel_based_preserve_x,
5067 window_scroll_pixel_based_preserve_y
5068 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
5069 -1, MOVE_TO_Y | MOVE_TO_X);
5070 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5072 else
5074 while (it.current_y < this_scroll_margin)
5076 int prev = it.current_y;
5077 move_it_by_lines (&it, 1, 1);
5078 if (prev == it.current_y)
5079 break;
5081 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5084 else if (n < 0)
5086 int charpos, bytepos;
5087 int partial_p;
5089 /* Save our position, for the
5090 window_scroll_pixel_based_preserve_y case. */
5091 charpos = IT_CHARPOS (it);
5092 bytepos = IT_BYTEPOS (it);
5094 /* We moved the window start towards BEGV, so PT may be now
5095 in the scroll margin at the bottom. */
5096 move_it_to (&it, PT, -1,
5097 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
5098 - this_scroll_margin - 1),
5100 MOVE_TO_POS | MOVE_TO_Y);
5102 /* Save our position, in case it's correct. */
5103 charpos = IT_CHARPOS (it);
5104 bytepos = IT_BYTEPOS (it);
5106 /* See if point is on a partially visible line at the end. */
5107 if (it.what == IT_EOB)
5108 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
5109 else
5111 move_it_by_lines (&it, 1, 1);
5112 partial_p = it.current_y > it.last_visible_y;
5115 if (charpos == PT && !partial_p
5116 && (NILP (Vscroll_preserve_screen_position)
5117 || EQ (Vscroll_preserve_screen_position, Qt)))
5118 /* We found PT before we found the display margin, so PT is ok. */
5120 else if (window_scroll_pixel_based_preserve_y >= 0)
5122 SET_TEXT_POS_FROM_MARKER (start, w->start);
5123 start_display (&it, w, start);
5124 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
5125 here because we called start_display again and did not
5126 alter it.current_y this time. */
5127 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
5128 window_scroll_pixel_based_preserve_y, -1,
5129 MOVE_TO_Y | MOVE_TO_X);
5130 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5132 else
5134 if (partial_p)
5135 /* The last line was only partially visible, so back up two
5136 lines to make sure we're on a fully visible line. */
5138 move_it_by_lines (&it, -2, 0);
5139 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
5141 else
5142 /* No, the position we saved is OK, so use it. */
5143 SET_PT_BOTH (charpos, bytepos);
5149 /* Implementation of window_scroll that works based on screen lines.
5150 See the comment of window_scroll for parameter descriptions. */
5152 static void
5153 window_scroll_line_based (window, n, whole, noerror)
5154 Lisp_Object window;
5155 int n;
5156 int whole;
5157 int noerror;
5159 register struct window *w = XWINDOW (window);
5160 register int opoint = PT, opoint_byte = PT_BYTE;
5161 register int pos, pos_byte;
5162 register int ht = window_internal_height (w);
5163 register Lisp_Object tem;
5164 int lose;
5165 Lisp_Object bolp;
5166 int startpos;
5167 Lisp_Object original_pos = Qnil;
5169 /* If scrolling screen-fulls, compute the number of lines to
5170 scroll from the window's height. */
5171 if (whole)
5172 n *= max (1, ht - next_screen_context_lines);
5174 startpos = marker_position (w->start);
5176 if (!NILP (Vscroll_preserve_screen_position))
5178 if (window_scroll_preserve_vpos <= 0
5179 || (!EQ (current_kboard->Vlast_command, Qscroll_up)
5180 && !EQ (current_kboard->Vlast_command, Qscroll_down)))
5182 struct position posit
5183 = *compute_motion (startpos, 0, 0, 0,
5184 PT, ht, 0,
5185 -1, XINT (w->hscroll),
5186 0, w);
5187 window_scroll_preserve_vpos = posit.vpos;
5188 window_scroll_preserve_hpos = posit.hpos + XINT (w->hscroll);
5191 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
5192 make_number (window_scroll_preserve_vpos));
5195 XSETFASTINT (tem, PT);
5196 tem = Fpos_visible_in_window_p (tem, window, Qnil);
5198 if (NILP (tem))
5200 Fvertical_motion (make_number (- (ht / 2)), window);
5201 startpos = PT;
5204 SET_PT (startpos);
5205 lose = n < 0 && PT == BEGV;
5206 Fvertical_motion (make_number (n), window);
5207 pos = PT;
5208 pos_byte = PT_BYTE;
5209 bolp = Fbolp ();
5210 SET_PT_BOTH (opoint, opoint_byte);
5212 if (lose)
5214 if (noerror)
5215 return;
5216 else
5217 xsignal0 (Qbeginning_of_buffer);
5220 if (pos < ZV)
5222 int this_scroll_margin = scroll_margin;
5224 /* Don't use a scroll margin that is negative or too large. */
5225 if (this_scroll_margin < 0)
5226 this_scroll_margin = 0;
5228 if (XINT (w->total_lines) < 4 * scroll_margin)
5229 this_scroll_margin = XINT (w->total_lines) / 4;
5231 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
5232 w->start_at_line_beg = bolp;
5233 w->update_mode_line = Qt;
5234 XSETFASTINT (w->last_modified, 0);
5235 XSETFASTINT (w->last_overlay_modified, 0);
5236 /* Set force_start so that redisplay_window will run
5237 the window-scroll-functions. */
5238 w->force_start = Qt;
5240 if (!NILP (Vscroll_preserve_screen_position)
5241 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
5243 SET_PT_BOTH (pos, pos_byte);
5244 Fvertical_motion (original_pos, window);
5246 /* If we scrolled forward, put point enough lines down
5247 that it is outside the scroll margin. */
5248 else if (n > 0)
5250 int top_margin;
5252 if (this_scroll_margin > 0)
5254 SET_PT_BOTH (pos, pos_byte);
5255 Fvertical_motion (make_number (this_scroll_margin), window);
5256 top_margin = PT;
5258 else
5259 top_margin = pos;
5261 if (top_margin <= opoint)
5262 SET_PT_BOTH (opoint, opoint_byte);
5263 else if (!NILP (Vscroll_preserve_screen_position))
5265 SET_PT_BOTH (pos, pos_byte);
5266 Fvertical_motion (original_pos, window);
5268 else
5269 SET_PT (top_margin);
5271 else if (n < 0)
5273 int bottom_margin;
5275 /* If we scrolled backward, put point near the end of the window
5276 but not within the scroll margin. */
5277 SET_PT_BOTH (pos, pos_byte);
5278 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
5279 if (XFASTINT (tem) == ht - this_scroll_margin)
5280 bottom_margin = PT;
5281 else
5282 bottom_margin = PT + 1;
5284 if (bottom_margin > opoint)
5285 SET_PT_BOTH (opoint, opoint_byte);
5286 else
5288 if (!NILP (Vscroll_preserve_screen_position))
5290 SET_PT_BOTH (pos, pos_byte);
5291 Fvertical_motion (original_pos, window);
5293 else
5294 Fvertical_motion (make_number (-1), window);
5298 else
5300 if (noerror)
5301 return;
5302 else
5303 xsignal0 (Qend_of_buffer);
5308 /* Scroll selected_window up or down. If N is nil, scroll a
5309 screen-full which is defined as the height of the window minus
5310 next_screen_context_lines. If N is the symbol `-', scroll.
5311 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
5312 up. This is the guts of Fscroll_up and Fscroll_down. */
5314 static void
5315 scroll_command (n, direction)
5316 Lisp_Object n;
5317 int direction;
5319 int count = SPECPDL_INDEX ();
5321 xassert (eabs (direction) == 1);
5323 /* If selected window's buffer isn't current, make it current for
5324 the moment. But don't screw up if window_scroll gets an error. */
5325 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
5327 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5328 Fset_buffer (XWINDOW (selected_window)->buffer);
5330 /* Make redisplay consider other windows than just selected_window. */
5331 ++windows_or_buffers_changed;
5334 if (NILP (n))
5335 window_scroll (selected_window, direction, 1, 0);
5336 else if (EQ (n, Qminus))
5337 window_scroll (selected_window, -direction, 1, 0);
5338 else
5340 n = Fprefix_numeric_value (n);
5341 window_scroll (selected_window, XINT (n) * direction, 0, 0);
5344 unbind_to (count, Qnil);
5347 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
5348 doc: /* Scroll text of selected window upward ARG lines.
5349 If ARG is omitted or nil, scroll upward by a near full screen.
5350 A near full screen is `next-screen-context-lines' less than a full screen.
5351 Negative ARG means scroll downward.
5352 If ARG is the atom `-', scroll downward by nearly full screen.
5353 When calling from a program, supply as argument a number, nil, or `-'. */)
5354 (arg)
5355 Lisp_Object arg;
5357 scroll_command (arg, 1);
5358 return Qnil;
5361 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
5362 doc: /* Scroll text of selected window down ARG lines.
5363 If ARG is omitted or nil, scroll down by a near full screen.
5364 A near full screen is `next-screen-context-lines' less than a full screen.
5365 Negative ARG means scroll upward.
5366 If ARG is the atom `-', scroll upward by nearly full screen.
5367 When calling from a program, supply as argument a number, nil, or `-'. */)
5368 (arg)
5369 Lisp_Object arg;
5371 scroll_command (arg, -1);
5372 return Qnil;
5375 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
5376 doc: /* Return the other window for \"other window scroll\" commands.
5377 If `other-window-scroll-buffer' is non-nil, a window
5378 showing that buffer is used.
5379 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5380 specifies the window. This takes precedence over
5381 `other-window-scroll-buffer'. */)
5384 Lisp_Object window;
5386 if (MINI_WINDOW_P (XWINDOW (selected_window))
5387 && !NILP (Vminibuf_scroll_window))
5388 window = Vminibuf_scroll_window;
5389 /* If buffer is specified, scroll that buffer. */
5390 else if (!NILP (Vother_window_scroll_buffer))
5392 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
5393 if (NILP (window))
5394 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
5396 else
5398 /* Nothing specified; look for a neighboring window on the same
5399 frame. */
5400 window = Fnext_window (selected_window, Qnil, Qnil);
5402 if (EQ (window, selected_window))
5403 /* That didn't get us anywhere; look for a window on another
5404 visible frame. */
5406 window = Fnext_window (window, Qnil, Qt);
5407 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
5408 && ! EQ (window, selected_window));
5411 CHECK_LIVE_WINDOW (window);
5413 if (EQ (window, selected_window))
5414 error ("There is no other window");
5416 return window;
5419 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
5420 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5421 A near full screen is `next-screen-context-lines' less than a full screen.
5422 The next window is the one below the current one; or the one at the top
5423 if the current one is at the bottom. Negative ARG means scroll downward.
5424 If ARG is the atom `-', scroll downward by nearly full screen.
5425 When calling from a program, supply as argument a number, nil, or `-'.
5427 If `other-window-scroll-buffer' is non-nil, scroll the window
5428 showing that buffer, popping the buffer up if necessary.
5429 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5430 specifies the window to scroll. This takes precedence over
5431 `other-window-scroll-buffer'. */)
5432 (arg)
5433 Lisp_Object arg;
5435 Lisp_Object window;
5436 struct window *w;
5437 int count = SPECPDL_INDEX ();
5439 window = Fother_window_for_scrolling ();
5440 w = XWINDOW (window);
5442 /* Don't screw up if window_scroll gets an error. */
5443 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5444 ++windows_or_buffers_changed;
5446 Fset_buffer (w->buffer);
5447 SET_PT (marker_position (w->pointm));
5449 if (NILP (arg))
5450 window_scroll (window, 1, 1, 1);
5451 else if (EQ (arg, Qminus))
5452 window_scroll (window, -1, 1, 1);
5453 else
5455 if (CONSP (arg))
5456 arg = Fcar (arg);
5457 CHECK_NUMBER (arg);
5458 window_scroll (window, XINT (arg), 0, 1);
5461 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5462 unbind_to (count, Qnil);
5464 return Qnil;
5467 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5468 doc: /* Scroll selected window display ARG columns left.
5469 Default for ARG is window width minus 2.
5470 Value is the total amount of leftward horizontal scrolling in
5471 effect after the change.
5472 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5473 lower bound for automatic scrolling, i.e. automatic scrolling
5474 will not scroll a window to a column less than the value returned
5475 by this function. This happens in an interactive call. */)
5476 (arg, set_minimum)
5477 register Lisp_Object arg, set_minimum;
5479 Lisp_Object result;
5480 int hscroll;
5481 struct window *w = XWINDOW (selected_window);
5483 if (NILP (arg))
5484 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5485 else
5486 arg = Fprefix_numeric_value (arg);
5488 hscroll = XINT (w->hscroll) + XINT (arg);
5489 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5491 if (!NILP (set_minimum))
5492 w->min_hscroll = w->hscroll;
5494 return result;
5497 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5498 doc: /* Scroll selected window display ARG columns right.
5499 Default for ARG is window width minus 2.
5500 Value is the total amount of leftward horizontal scrolling in
5501 effect after the change.
5502 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5503 lower bound for automatic scrolling, i.e. automatic scrolling
5504 will not scroll a window to a column less than the value returned
5505 by this function. This happens in an interactive call. */)
5506 (arg, set_minimum)
5507 register Lisp_Object arg, set_minimum;
5509 Lisp_Object result;
5510 int hscroll;
5511 struct window *w = XWINDOW (selected_window);
5513 if (NILP (arg))
5514 XSETFASTINT (arg, window_box_text_cols (w) - 2);
5515 else
5516 arg = Fprefix_numeric_value (arg);
5518 hscroll = XINT (w->hscroll) - XINT (arg);
5519 result = Fset_window_hscroll (selected_window, make_number (hscroll));
5521 if (!NILP (set_minimum))
5522 w->min_hscroll = w->hscroll;
5524 return result;
5527 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5528 doc: /* Return the window which was selected when entering the minibuffer.
5529 Returns nil, if selected window is not a minibuffer window. */)
5532 if (minibuf_level > 0
5533 && MINI_WINDOW_P (XWINDOW (selected_window))
5534 && WINDOW_LIVE_P (minibuf_selected_window))
5535 return minibuf_selected_window;
5537 return Qnil;
5540 /* Value is the number of lines actually displayed in window W,
5541 as opposed to its height. */
5543 static int
5544 displayed_window_lines (w)
5545 struct window *w;
5547 struct it it;
5548 struct text_pos start;
5549 int height = window_box_height (w);
5550 struct buffer *old_buffer;
5551 int bottom_y;
5553 if (XBUFFER (w->buffer) != current_buffer)
5555 old_buffer = current_buffer;
5556 set_buffer_internal (XBUFFER (w->buffer));
5558 else
5559 old_buffer = NULL;
5561 /* In case W->start is out of the accessible range, do something
5562 reasonable. This happens in Info mode when Info-scroll-down
5563 calls (recenter -1) while W->start is 1. */
5564 if (XMARKER (w->start)->charpos < BEGV)
5565 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
5566 else if (XMARKER (w->start)->charpos > ZV)
5567 SET_TEXT_POS (start, ZV, ZV_BYTE);
5568 else
5569 SET_TEXT_POS_FROM_MARKER (start, w->start);
5571 start_display (&it, w, start);
5572 move_it_vertically (&it, height);
5573 bottom_y = line_bottom_y (&it);
5575 /* rms: On a non-window display,
5576 the value of it.vpos at the bottom of the screen
5577 seems to be 1 larger than window_box_height (w).
5578 This kludge fixes a bug whereby (move-to-window-line -1)
5579 when ZV is on the last screen line
5580 moves to the previous screen line instead of the last one. */
5581 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5582 height++;
5584 /* Add in empty lines at the bottom of the window. */
5585 if (bottom_y < height)
5587 int uy = FRAME_LINE_HEIGHT (it.f);
5588 it.vpos += (height - bottom_y + uy - 1) / uy;
5591 if (old_buffer)
5592 set_buffer_internal (old_buffer);
5594 return it.vpos;
5598 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5599 doc: /* Center point in selected window and redisplay frame.
5600 With prefix argument ARG, recenter putting point on screen line ARG
5601 relative to the selected window. If ARG is negative, it counts up from the
5602 bottom of the window. (ARG should be less than the height of the window.)
5604 If ARG is omitted or nil, erase the entire frame and then redraw with point
5605 in the center of the selected window. If `auto-resize-tool-bars' is set to
5606 `grow-only', this resets the tool-bar's height to the minimum height needed.
5608 Just C-u as prefix means put point in the center of the window
5609 and redisplay normally--don't erase and redraw the frame. */)
5610 (arg)
5611 register Lisp_Object arg;
5613 struct window *w = XWINDOW (selected_window);
5614 struct buffer *buf = XBUFFER (w->buffer);
5615 struct buffer *obuf = current_buffer;
5616 int center_p = 0;
5617 int charpos, bytepos;
5618 int iarg;
5619 int this_scroll_margin;
5621 /* If redisplay is suppressed due to an error, try again. */
5622 obuf->display_error_modiff = 0;
5624 if (NILP (arg))
5626 int i;
5628 /* Invalidate pixel data calculated for all compositions. */
5629 for (i = 0; i < n_compositions; i++)
5630 composition_table[i]->font = NULL;
5632 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5634 Fredraw_frame (WINDOW_FRAME (w));
5635 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5636 center_p = 1;
5638 else if (CONSP (arg)) /* Just C-u. */
5639 center_p = 1;
5640 else
5642 arg = Fprefix_numeric_value (arg);
5643 CHECK_NUMBER (arg);
5644 iarg = XINT (arg);
5647 set_buffer_internal (buf);
5649 /* Do this after making BUF current
5650 in case scroll_margin is buffer-local. */
5651 this_scroll_margin = max (0, scroll_margin);
5652 this_scroll_margin = min (this_scroll_margin,
5653 XFASTINT (w->total_lines) / 4);
5655 /* Handle centering on a graphical frame specially. Such frames can
5656 have variable-height lines and centering point on the basis of
5657 line counts would lead to strange effects. */
5658 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5660 if (center_p)
5662 struct it it;
5663 struct text_pos pt;
5665 SET_TEXT_POS (pt, PT, PT_BYTE);
5666 start_display (&it, w, pt);
5667 move_it_vertically_backward (&it, window_box_height (w) / 2);
5668 charpos = IT_CHARPOS (it);
5669 bytepos = IT_BYTEPOS (it);
5671 else if (iarg < 0)
5673 struct it it;
5674 struct text_pos pt;
5675 int nlines = -iarg;
5676 int extra_line_spacing;
5677 int h = window_box_height (w);
5679 iarg = - max (-iarg, this_scroll_margin);
5681 SET_TEXT_POS (pt, PT, PT_BYTE);
5682 start_display (&it, w, pt);
5684 /* Be sure we have the exact height of the full line containing PT. */
5685 move_it_by_lines (&it, 0, 1);
5687 /* The amount of pixels we have to move back is the window
5688 height minus what's displayed in the line containing PT,
5689 and the lines below. */
5690 it.current_y = 0;
5691 it.vpos = 0;
5692 move_it_by_lines (&it, nlines, 1);
5694 if (it.vpos == nlines)
5695 h -= it.current_y;
5696 else
5698 /* Last line has no newline */
5699 h -= line_bottom_y (&it);
5700 it.vpos++;
5703 /* Don't reserve space for extra line spacing of last line. */
5704 extra_line_spacing = it.max_extra_line_spacing;
5706 /* If we can't move down NLINES lines because we hit
5707 the end of the buffer, count in some empty lines. */
5708 if (it.vpos < nlines)
5710 nlines -= it.vpos;
5711 extra_line_spacing = it.extra_line_spacing;
5712 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5714 if (h <= 0)
5715 return Qnil;
5717 /* Now find the new top line (starting position) of the window. */
5718 start_display (&it, w, pt);
5719 it.current_y = 0;
5720 move_it_vertically_backward (&it, h);
5722 /* If extra line spacing is present, we may move too far
5723 back. This causes the last line to be only partially
5724 visible (which triggers redisplay to recenter that line
5725 in the middle), so move forward.
5726 But ignore extra line spacing on last line, as it is not
5727 considered to be part of the visible height of the line.
5729 h += extra_line_spacing;
5730 while (-it.current_y > h)
5731 move_it_by_lines (&it, 1, 1);
5733 charpos = IT_CHARPOS (it);
5734 bytepos = IT_BYTEPOS (it);
5736 else
5738 struct position pos;
5740 iarg = max (iarg, this_scroll_margin);
5742 pos = *vmotion (PT, -iarg, w);
5743 charpos = pos.bufpos;
5744 bytepos = pos.bytepos;
5747 else
5749 struct position pos;
5750 int ht = window_internal_height (w);
5752 if (center_p)
5753 iarg = ht / 2;
5754 else if (iarg < 0)
5755 iarg += ht;
5757 /* Don't let it get into the margin at either top or bottom. */
5758 iarg = max (iarg, this_scroll_margin);
5759 iarg = min (iarg, ht - this_scroll_margin - 1);
5761 pos = *vmotion (PT, - iarg, w);
5762 charpos = pos.bufpos;
5763 bytepos = pos.bytepos;
5766 /* Set the new window start. */
5767 set_marker_both (w->start, w->buffer, charpos, bytepos);
5768 w->window_end_valid = Qnil;
5770 w->optional_new_start = Qt;
5772 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
5773 w->start_at_line_beg = Qt;
5774 else
5775 w->start_at_line_beg = Qnil;
5777 set_buffer_internal (obuf);
5778 return Qnil;
5782 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5783 0, 1, 0,
5784 doc: /* Return the height in lines of the text display area of WINDOW.
5785 WINDOW defaults to the selected window.
5787 The return value does neither include the mode line or header line, if
5788 any, nor any partial-height lines in the text display area. */)
5789 (window)
5790 Lisp_Object window;
5792 struct window *w = decode_window (window);
5793 int pixel_height = window_box_height (w);
5794 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5795 return make_number (line_height);
5800 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5801 1, 1, "P",
5802 doc: /* Position point relative to window.
5803 With no argument, position point at center of window.
5804 An argument specifies vertical position within the window;
5805 zero means top of window, negative means relative to bottom of window. */)
5806 (arg)
5807 Lisp_Object arg;
5809 struct window *w = XWINDOW (selected_window);
5810 int lines, start;
5811 Lisp_Object window;
5812 #if 0
5813 int this_scroll_margin;
5814 #endif
5816 window = selected_window;
5817 start = marker_position (w->start);
5818 if (start < BEGV || start > ZV)
5820 int height = window_internal_height (w);
5821 Fvertical_motion (make_number (- (height / 2)), window);
5822 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
5823 w->start_at_line_beg = Fbolp ();
5824 w->force_start = Qt;
5826 else
5827 Fgoto_char (w->start);
5829 lines = displayed_window_lines (w);
5831 #if 0
5832 this_scroll_margin = max (0, scroll_margin);
5833 this_scroll_margin = min (this_scroll_margin, lines / 4);
5834 #endif
5836 if (NILP (arg))
5837 XSETFASTINT (arg, lines / 2);
5838 else
5840 int iarg = XINT (Fprefix_numeric_value (arg));
5842 if (iarg < 0)
5843 iarg = iarg + lines;
5845 #if 0 /* This code would prevent move-to-window-line from moving point
5846 to a place inside the scroll margins (which would cause the
5847 next redisplay to scroll). I wrote this code, but then concluded
5848 it is probably better not to install it. However, it is here
5849 inside #if 0 so as not to lose it. -- rms. */
5851 /* Don't let it get into the margin at either top or bottom. */
5852 iarg = max (iarg, this_scroll_margin);
5853 iarg = min (iarg, lines - this_scroll_margin - 1);
5854 #endif
5856 arg = make_number (iarg);
5859 /* Skip past a partially visible first line. */
5860 if (w->vscroll)
5861 XSETINT (arg, XINT (arg) + 1);
5863 return Fvertical_motion (arg, window);
5868 /***********************************************************************
5869 Window Configuration
5870 ***********************************************************************/
5872 struct save_window_data
5874 EMACS_UINT size;
5875 struct Lisp_Vector *next_from_Lisp_Vector_struct;
5876 Lisp_Object selected_frame;
5877 Lisp_Object current_window;
5878 Lisp_Object current_buffer;
5879 Lisp_Object minibuf_scroll_window;
5880 Lisp_Object minibuf_selected_window;
5881 Lisp_Object root_window;
5882 Lisp_Object focus_frame;
5883 /* A vector, each of whose elements is a struct saved_window
5884 for one window. */
5885 Lisp_Object saved_windows;
5887 /* All fields above are traced by the GC.
5888 From `fame-cols' down, the fields are ignored by the GC. */
5890 int frame_cols, frame_lines, frame_menu_bar_lines;
5891 int frame_tool_bar_lines;
5894 /* This is saved as a Lisp_Vector */
5895 struct saved_window
5897 /* these first two must agree with struct Lisp_Vector in lisp.h */
5898 EMACS_UINT size;
5899 struct Lisp_Vector *next_from_Lisp_Vector_struct;
5901 Lisp_Object window;
5902 Lisp_Object buffer, start, pointm, mark;
5903 Lisp_Object left_col, top_line, total_cols, total_lines;
5904 Lisp_Object hscroll, min_hscroll;
5905 Lisp_Object parent, prev;
5906 Lisp_Object start_at_line_beg;
5907 Lisp_Object display_table;
5908 Lisp_Object orig_top_line, orig_total_lines;
5909 Lisp_Object left_margin_cols, right_margin_cols;
5910 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5911 Lisp_Object scroll_bar_width, vertical_scroll_bar_type;
5912 Lisp_Object dedicated, resize_proportionally;
5915 #define SAVED_WINDOW_N(swv,n) \
5916 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5918 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5919 doc: /* Return t if OBJECT is a window-configuration object. */)
5920 (object)
5921 Lisp_Object object;
5923 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
5926 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5927 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5928 (config)
5929 Lisp_Object config;
5931 register struct save_window_data *data;
5932 struct Lisp_Vector *saved_windows;
5934 CHECK_WINDOW_CONFIGURATION (config);
5936 data = (struct save_window_data *) XVECTOR (config);
5937 saved_windows = XVECTOR (data->saved_windows);
5938 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5941 DEFUN ("set-window-configuration", Fset_window_configuration,
5942 Sset_window_configuration, 1, 1, 0,
5943 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5944 CONFIGURATION must be a value previously returned
5945 by `current-window-configuration' (which see).
5946 If CONFIGURATION was made from a frame that is now deleted,
5947 only frame-independent values can be restored. In this case,
5948 the return value is nil. Otherwise the value is t. */)
5949 (configuration)
5950 Lisp_Object configuration;
5952 register struct save_window_data *data;
5953 struct Lisp_Vector *saved_windows;
5954 Lisp_Object new_current_buffer;
5955 Lisp_Object frame;
5956 FRAME_PTR f;
5957 int old_point = -1;
5959 CHECK_WINDOW_CONFIGURATION (configuration);
5961 data = (struct save_window_data *) XVECTOR (configuration);
5962 saved_windows = XVECTOR (data->saved_windows);
5964 new_current_buffer = data->current_buffer;
5965 if (NILP (XBUFFER (new_current_buffer)->name))
5966 new_current_buffer = Qnil;
5967 else
5969 if (XBUFFER (new_current_buffer) == current_buffer)
5970 /* The code further down "preserves point" by saving here PT in
5971 old_point and then setting it later back into PT. When the
5972 current-selected-window and the final-selected-window both show
5973 the current buffer, this suffers from the problem that the
5974 current PT is the window-point of the current-selected-window,
5975 while the final PT is the point of the final-selected-window, so
5976 this copy from one PT to the other would end up moving the
5977 window-point of the final-selected-window to the window-point of
5978 the current-selected-window. So we have to be careful which
5979 point of the current-buffer we copy into old_point. */
5980 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5981 && WINDOWP (selected_window)
5982 && EQ (XWINDOW (selected_window)->buffer, new_current_buffer)
5983 && !EQ (selected_window, data->current_window))
5984 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5985 else
5986 old_point = PT;
5987 else
5988 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5989 point in new_current_buffer as of the last time this buffer was
5990 used. This can be non-deterministic since it can be changed by
5991 things like jit-lock by mere temporary selection of some random
5992 window that happens to show this buffer.
5993 So if possible we want this arbitrary choice of "which point" to
5994 be the one from the to-be-selected-window so as to prevent this
5995 window's cursor from being copied from another window. */
5996 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5997 /* If current_window = selected_window, its point is in BUF_PT. */
5998 && !EQ (selected_window, data->current_window))
5999 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
6000 else
6001 old_point = BUF_PT (XBUFFER (new_current_buffer));
6004 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
6005 f = XFRAME (frame);
6007 /* If f is a dead frame, don't bother rebuilding its window tree.
6008 However, there is other stuff we should still try to do below. */
6009 if (FRAME_LIVE_P (f))
6011 register struct window *w;
6012 register struct saved_window *p;
6013 struct window *root_window;
6014 struct window **leaf_windows;
6015 int n_leaf_windows;
6016 int k, i, n;
6018 /* If the frame has been resized since this window configuration was
6019 made, we change the frame to the size specified in the
6020 configuration, restore the configuration, and then resize it
6021 back. We keep track of the prevailing height in these variables. */
6022 int previous_frame_lines = FRAME_LINES (f);
6023 int previous_frame_cols = FRAME_COLS (f);
6024 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6025 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6027 /* The mouse highlighting code could get screwed up
6028 if it runs during this. */
6029 BLOCK_INPUT;
6031 if (data->frame_lines != previous_frame_lines
6032 || data->frame_cols != previous_frame_cols)
6033 change_frame_size (f, data->frame_lines,
6034 data->frame_cols, 0, 0, 0);
6035 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
6036 if (data->frame_menu_bar_lines
6037 != previous_frame_menu_bar_lines)
6038 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
6039 make_number (0));
6040 #ifdef HAVE_WINDOW_SYSTEM
6041 if (data->frame_tool_bar_lines
6042 != previous_frame_tool_bar_lines)
6043 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
6044 make_number (0));
6045 #endif
6046 #endif
6048 /* "Swap out" point from the selected window's buffer
6049 into the window itself. (Normally the pointm of the selected
6050 window holds garbage.) We do this now, before
6051 restoring the window contents, and prevent it from
6052 being done later on when we select a new window. */
6053 if (! NILP (XWINDOW (selected_window)->buffer))
6055 w = XWINDOW (selected_window);
6056 set_marker_both (w->pointm,
6057 w->buffer,
6058 BUF_PT (XBUFFER (w->buffer)),
6059 BUF_PT_BYTE (XBUFFER (w->buffer)));
6062 windows_or_buffers_changed++;
6063 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
6065 /* Problem: Freeing all matrices and later allocating them again
6066 is a serious redisplay flickering problem. What we would
6067 really like to do is to free only those matrices not reused
6068 below. */
6069 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
6070 leaf_windows
6071 = (struct window **) alloca (count_windows (root_window)
6072 * sizeof (struct window *));
6073 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
6075 /* Kludge Alert!
6076 Mark all windows now on frame as "deleted".
6077 Restoring the new configuration "undeletes" any that are in it.
6079 Save their current buffers in their height fields, since we may
6080 need it later, if a buffer saved in the configuration is now
6081 dead. */
6082 delete_all_subwindows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6084 for (k = 0; k < saved_windows->size; k++)
6086 p = SAVED_WINDOW_N (saved_windows, k);
6087 w = XWINDOW (p->window);
6088 w->next = Qnil;
6090 if (!NILP (p->parent))
6091 w->parent = SAVED_WINDOW_N (saved_windows,
6092 XFASTINT (p->parent))->window;
6093 else
6094 w->parent = Qnil;
6096 if (!NILP (p->prev))
6098 w->prev = SAVED_WINDOW_N (saved_windows,
6099 XFASTINT (p->prev))->window;
6100 XWINDOW (w->prev)->next = p->window;
6102 else
6104 w->prev = Qnil;
6105 if (!NILP (w->parent))
6107 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
6109 XWINDOW (w->parent)->vchild = p->window;
6110 XWINDOW (w->parent)->hchild = Qnil;
6112 else
6114 XWINDOW (w->parent)->hchild = p->window;
6115 XWINDOW (w->parent)->vchild = Qnil;
6120 /* If we squirreled away the buffer in the window's height,
6121 restore it now. */
6122 if (BUFFERP (w->total_lines))
6123 w->buffer = w->total_lines;
6124 w->left_col = p->left_col;
6125 w->top_line = p->top_line;
6126 w->total_cols = p->total_cols;
6127 w->total_lines = p->total_lines;
6128 w->hscroll = p->hscroll;
6129 w->min_hscroll = p->min_hscroll;
6130 w->display_table = p->display_table;
6131 w->orig_top_line = p->orig_top_line;
6132 w->orig_total_lines = p->orig_total_lines;
6133 w->left_margin_cols = p->left_margin_cols;
6134 w->right_margin_cols = p->right_margin_cols;
6135 w->left_fringe_width = p->left_fringe_width;
6136 w->right_fringe_width = p->right_fringe_width;
6137 w->fringes_outside_margins = p->fringes_outside_margins;
6138 w->scroll_bar_width = p->scroll_bar_width;
6139 w->vertical_scroll_bar_type = p->vertical_scroll_bar_type;
6140 w->dedicated = p->dedicated;
6141 w->resize_proportionally = p->resize_proportionally;
6142 XSETFASTINT (w->last_modified, 0);
6143 XSETFASTINT (w->last_overlay_modified, 0);
6145 /* Reinstall the saved buffer and pointers into it. */
6146 if (NILP (p->buffer))
6147 w->buffer = p->buffer;
6148 else
6150 if (!NILP (XBUFFER (p->buffer)->name))
6151 /* If saved buffer is alive, install it. */
6153 w->buffer = p->buffer;
6154 w->start_at_line_beg = p->start_at_line_beg;
6155 set_marker_restricted (w->start, p->start, w->buffer);
6156 set_marker_restricted (w->pointm, p->pointm, w->buffer);
6157 Fset_marker (XBUFFER (w->buffer)->mark,
6158 p->mark, w->buffer);
6160 /* As documented in Fcurrent_window_configuration, don't
6161 restore the location of point in the buffer which was
6162 current when the window configuration was recorded. */
6163 if (!EQ (p->buffer, new_current_buffer)
6164 && XBUFFER (p->buffer) == current_buffer)
6165 Fgoto_char (w->pointm);
6167 else if (NILP (w->buffer) || NILP (XBUFFER (w->buffer)->name))
6168 /* Else unless window has a live buffer, get one. */
6170 w->buffer = Fcdr (Fcar (Vbuffer_alist));
6171 /* This will set the markers to beginning of visible
6172 range. */
6173 set_marker_restricted (w->start, make_number (0), w->buffer);
6174 set_marker_restricted (w->pointm, make_number (0),w->buffer);
6175 w->start_at_line_beg = Qt;
6177 else
6178 /* Keeping window's old buffer; make sure the markers
6179 are real. */
6181 /* Set window markers at start of visible range. */
6182 if (XMARKER (w->start)->buffer == 0)
6183 set_marker_restricted (w->start, make_number (0),
6184 w->buffer);
6185 if (XMARKER (w->pointm)->buffer == 0)
6186 set_marker_restricted_both (w->pointm, w->buffer,
6187 BUF_PT (XBUFFER (w->buffer)),
6188 BUF_PT_BYTE (XBUFFER (w->buffer)));
6189 w->start_at_line_beg = Qt;
6194 FRAME_ROOT_WINDOW (f) = data->root_window;
6195 /* Prevent "swapping out point" in the old selected window
6196 using the buffer that has been restored into it.
6197 We already swapped out point that from that window's old buffer. */
6198 selected_window = Qnil;
6200 /* Arrange *not* to restore point in the buffer that was
6201 current when the window configuration was saved. */
6202 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
6203 set_marker_restricted (XWINDOW (data->current_window)->pointm,
6204 make_number (old_point),
6205 XWINDOW (data->current_window)->buffer);
6207 Fselect_window (data->current_window, Qnil);
6208 XBUFFER (XWINDOW (selected_window)->buffer)->last_selected_window
6209 = selected_window;
6211 if (NILP (data->focus_frame)
6212 || (FRAMEP (data->focus_frame)
6213 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
6214 Fredirect_frame_focus (frame, data->focus_frame);
6216 #if 0 /* I don't understand why this is needed, and it causes problems
6217 when the frame's old selected window has been deleted. */
6218 if (f != selected_frame && FRAME_WINDOW_P (f))
6219 do_switch_frame (WINDOW_FRAME (XWINDOW (data->root_window)),
6220 0, 0, Qnil);
6221 #endif
6223 /* Set the screen height to the value it had before this function. */
6224 if (previous_frame_lines != FRAME_LINES (f)
6225 || previous_frame_cols != FRAME_COLS (f))
6226 change_frame_size (f, previous_frame_lines, previous_frame_cols,
6227 0, 0, 0);
6228 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
6229 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
6230 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
6231 make_number (0));
6232 #ifdef HAVE_WINDOW_SYSTEM
6233 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
6234 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
6235 make_number (0));
6236 #endif
6237 #endif
6239 /* Now, free glyph matrices in windows that were not reused. */
6240 for (i = n = 0; i < n_leaf_windows; ++i)
6242 if (NILP (leaf_windows[i]->buffer))
6244 /* Assert it's not reused as a combination. */
6245 xassert (NILP (leaf_windows[i]->hchild)
6246 && NILP (leaf_windows[i]->vchild));
6247 free_window_matrices (leaf_windows[i]);
6249 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
6250 ++n;
6253 adjust_glyphs (f);
6255 UNBLOCK_INPUT;
6257 /* Fselect_window will have made f the selected frame, so we
6258 reselect the proper frame here. Fhandle_switch_frame will change the
6259 selected window too, but that doesn't make the call to
6260 Fselect_window above totally superfluous; it still sets f's
6261 selected window. */
6262 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
6263 do_switch_frame (data->selected_frame, 0, 0, Qnil);
6265 run_window_configuration_change_hook (f);
6268 if (!NILP (new_current_buffer))
6269 Fset_buffer (new_current_buffer);
6271 Vminibuf_scroll_window = data->minibuf_scroll_window;
6272 minibuf_selected_window = data->minibuf_selected_window;
6274 return (FRAME_LIVE_P (f) ? Qt : Qnil);
6277 /* Mark all windows now on frame as deleted
6278 by setting their buffers to nil. */
6280 void
6281 delete_all_subwindows (w)
6282 register struct window *w;
6284 if (!NILP (w->next))
6285 delete_all_subwindows (XWINDOW (w->next));
6286 if (!NILP (w->vchild))
6287 delete_all_subwindows (XWINDOW (w->vchild));
6288 if (!NILP (w->hchild))
6289 delete_all_subwindows (XWINDOW (w->hchild));
6291 w->total_lines = w->buffer; /* See Fset_window_configuration for excuse. */
6293 if (!NILP (w->buffer))
6294 unshow_buffer (w);
6296 /* We set all three of these fields to nil, to make sure that we can
6297 distinguish this dead window from any live window. Live leaf
6298 windows will have buffer set, and combination windows will have
6299 vchild or hchild set. */
6300 w->buffer = Qnil;
6301 w->vchild = Qnil;
6302 w->hchild = Qnil;
6304 Vwindow_list = Qnil;
6307 static int
6308 count_windows (window)
6309 register struct window *window;
6311 register int count = 1;
6312 if (!NILP (window->next))
6313 count += count_windows (XWINDOW (window->next));
6314 if (!NILP (window->vchild))
6315 count += count_windows (XWINDOW (window->vchild));
6316 if (!NILP (window->hchild))
6317 count += count_windows (XWINDOW (window->hchild));
6318 return count;
6322 /* Fill vector FLAT with leaf windows under W, starting at index I.
6323 Value is last index + 1. */
6325 static int
6326 get_leaf_windows (w, flat, i)
6327 struct window *w;
6328 struct window **flat;
6329 int i;
6331 while (w)
6333 if (!NILP (w->hchild))
6334 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
6335 else if (!NILP (w->vchild))
6336 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
6337 else
6338 flat[i++] = w;
6340 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6343 return i;
6347 /* Return a pointer to the glyph W's physical cursor is on. Value is
6348 null if W's current matrix is invalid, so that no meaningfull glyph
6349 can be returned. */
6351 struct glyph *
6352 get_phys_cursor_glyph (w)
6353 struct window *w;
6355 struct glyph_row *row;
6356 struct glyph *glyph;
6358 if (w->phys_cursor.vpos >= 0
6359 && w->phys_cursor.vpos < w->current_matrix->nrows
6360 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
6361 row->enabled_p)
6362 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
6363 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
6364 else
6365 glyph = NULL;
6367 return glyph;
6371 static int
6372 save_window_save (window, vector, i)
6373 Lisp_Object window;
6374 struct Lisp_Vector *vector;
6375 int i;
6377 register struct saved_window *p;
6378 register struct window *w;
6379 register Lisp_Object tem;
6381 for (;!NILP (window); window = w->next)
6383 p = SAVED_WINDOW_N (vector, i);
6384 w = XWINDOW (window);
6386 XSETFASTINT (w->temslot, i); i++;
6387 p->window = window;
6388 p->buffer = w->buffer;
6389 p->left_col = w->left_col;
6390 p->top_line = w->top_line;
6391 p->total_cols = w->total_cols;
6392 p->total_lines = w->total_lines;
6393 p->hscroll = w->hscroll;
6394 p->min_hscroll = w->min_hscroll;
6395 p->display_table = w->display_table;
6396 p->orig_top_line = w->orig_top_line;
6397 p->orig_total_lines = w->orig_total_lines;
6398 p->left_margin_cols = w->left_margin_cols;
6399 p->right_margin_cols = w->right_margin_cols;
6400 p->left_fringe_width = w->left_fringe_width;
6401 p->right_fringe_width = w->right_fringe_width;
6402 p->fringes_outside_margins = w->fringes_outside_margins;
6403 p->scroll_bar_width = w->scroll_bar_width;
6404 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
6405 p->dedicated = w->dedicated;
6406 p->resize_proportionally = w->resize_proportionally;
6407 if (!NILP (w->buffer))
6409 /* Save w's value of point in the window configuration.
6410 If w is the selected window, then get the value of point
6411 from the buffer; pointm is garbage in the selected window. */
6412 if (EQ (window, selected_window))
6414 p->pointm = Fmake_marker ();
6415 set_marker_both (p->pointm, w->buffer,
6416 BUF_PT (XBUFFER (w->buffer)),
6417 BUF_PT_BYTE (XBUFFER (w->buffer)));
6419 else
6420 p->pointm = Fcopy_marker (w->pointm, Qnil);
6422 p->start = Fcopy_marker (w->start, Qnil);
6423 p->start_at_line_beg = w->start_at_line_beg;
6425 tem = XBUFFER (w->buffer)->mark;
6426 p->mark = Fcopy_marker (tem, Qnil);
6428 else
6430 p->pointm = Qnil;
6431 p->start = Qnil;
6432 p->mark = Qnil;
6433 p->start_at_line_beg = Qnil;
6436 if (NILP (w->parent))
6437 p->parent = Qnil;
6438 else
6439 p->parent = XWINDOW (w->parent)->temslot;
6441 if (NILP (w->prev))
6442 p->prev = Qnil;
6443 else
6444 p->prev = XWINDOW (w->prev)->temslot;
6446 if (!NILP (w->vchild))
6447 i = save_window_save (w->vchild, vector, i);
6448 if (!NILP (w->hchild))
6449 i = save_window_save (w->hchild, vector, i);
6452 return i;
6455 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
6456 Scurrent_window_configuration, 0, 1, 0,
6457 doc: /* Return an object representing the current window configuration of FRAME.
6458 If FRAME is nil or omitted, use the selected frame.
6459 This describes the number of windows, their sizes and current buffers,
6460 and for each displayed buffer, where display starts, and the positions of
6461 point and mark. An exception is made for point in the current buffer:
6462 its value is -not- saved.
6463 This also records the currently selected frame, and FRAME's focus
6464 redirection (see `redirect-frame-focus'). */)
6465 (frame)
6466 Lisp_Object frame;
6468 register Lisp_Object tem;
6469 register int n_windows;
6470 register struct save_window_data *data;
6471 register int i;
6472 FRAME_PTR f;
6474 if (NILP (frame))
6475 frame = selected_frame;
6476 CHECK_LIVE_FRAME (frame);
6477 f = XFRAME (frame);
6479 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6480 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6481 PVEC_WINDOW_CONFIGURATION);
6483 data->frame_cols = FRAME_COLS (f);
6484 data->frame_lines = FRAME_LINES (f);
6485 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6486 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6487 data->selected_frame = selected_frame;
6488 data->current_window = FRAME_SELECTED_WINDOW (f);
6489 XSETBUFFER (data->current_buffer, current_buffer);
6490 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6491 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6492 data->root_window = FRAME_ROOT_WINDOW (f);
6493 data->focus_frame = FRAME_FOCUS_FRAME (f);
6494 tem = Fmake_vector (make_number (n_windows), Qnil);
6495 data->saved_windows = tem;
6496 for (i = 0; i < n_windows; i++)
6497 XVECTOR (tem)->contents[i]
6498 = Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil);
6499 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6500 XSETWINDOW_CONFIGURATION (tem, data);
6501 return (tem);
6504 DEFUN ("save-window-excursion", Fsave_window_excursion, Ssave_window_excursion,
6505 0, UNEVALLED, 0,
6506 doc: /* Execute BODY, preserving window sizes and contents.
6507 Return the value of the last form in BODY.
6508 Restore which buffer appears in which window, where display starts,
6509 and the value of point and mark for each window.
6510 Also restore the choice of selected window.
6511 Also restore which buffer is current.
6512 Does not restore the value of point in current buffer.
6513 usage: (save-window-excursion BODY...) */)
6514 (args)
6515 Lisp_Object args;
6517 register Lisp_Object val;
6518 register int count = SPECPDL_INDEX ();
6520 record_unwind_protect (Fset_window_configuration,
6521 Fcurrent_window_configuration (Qnil));
6522 val = Fprogn (args);
6523 return unbind_to (count, val);
6528 /***********************************************************************
6529 Window Split Tree
6530 ***********************************************************************/
6532 static Lisp_Object
6533 window_tree (w)
6534 struct window *w;
6536 Lisp_Object tail = Qnil;
6537 Lisp_Object result = Qnil;
6539 while (w)
6541 Lisp_Object wn;
6543 XSETWINDOW (wn, w);
6544 if (!NILP (w->hchild))
6545 wn = Fcons (Qnil, Fcons (Fwindow_edges (wn),
6546 window_tree (XWINDOW (w->hchild))));
6547 else if (!NILP (w->vchild))
6548 wn = Fcons (Qt, Fcons (Fwindow_edges (wn),
6549 window_tree (XWINDOW (w->vchild))));
6551 if (NILP (result))
6553 result = tail = Fcons (wn, Qnil);
6555 else
6557 XSETCDR (tail, Fcons (wn, Qnil));
6558 tail = XCDR (tail);
6561 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6564 return result;
6569 DEFUN ("window-tree", Fwindow_tree, Swindow_tree,
6570 0, 1, 0,
6571 doc: /* Return the window tree for frame FRAME.
6573 The return value is a list of the form (ROOT MINI), where ROOT
6574 represents the window tree of the frame's root window, and MINI
6575 is the frame's minibuffer window.
6577 If the root window is not split, ROOT is the root window itself.
6578 Otherwise, ROOT is a list (DIR EDGES W1 W2 ...) where DIR is nil for a
6579 horizontal split, and t for a vertical split, EDGES gives the combined
6580 size and position of the subwindows in the split, and the rest of the
6581 elements are the subwindows in the split. Each of the subwindows may
6582 again be a window or a list representing a window split, and so on.
6583 EDGES is a list \(LEFT TOP RIGHT BOTTOM) as returned by `window-edges'.
6585 If FRAME is nil or omitted, return information on the currently
6586 selected frame. */)
6587 (frame)
6588 Lisp_Object frame;
6590 FRAME_PTR f;
6592 if (NILP (frame))
6593 frame = selected_frame;
6595 CHECK_FRAME (frame);
6596 f = XFRAME (frame);
6598 if (!FRAME_LIVE_P (f))
6599 return Qnil;
6601 return window_tree (XWINDOW (FRAME_ROOT_WINDOW (f)));
6605 /***********************************************************************
6606 Marginal Areas
6607 ***********************************************************************/
6609 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6610 2, 3, 0,
6611 doc: /* Set width of marginal areas of window WINDOW.
6612 If WINDOW is nil, set margins of the currently selected window.
6613 Second arg LEFT-WIDTH specifies the number of character cells to
6614 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6615 does the same for the right marginal area. A nil width parameter
6616 means no margin. */)
6617 (window, left_width, right_width)
6618 Lisp_Object window, left_width, right_width;
6620 struct window *w = decode_window (window);
6622 /* Translate negative or zero widths to nil.
6623 Margins that are too wide have to be checked elsewhere. */
6625 if (!NILP (left_width))
6627 CHECK_NUMBER (left_width);
6628 if (XINT (left_width) <= 0)
6629 left_width = Qnil;
6632 if (!NILP (right_width))
6634 CHECK_NUMBER (right_width);
6635 if (XINT (right_width) <= 0)
6636 right_width = Qnil;
6639 if (!EQ (w->left_margin_cols, left_width)
6640 || !EQ (w->right_margin_cols, right_width))
6642 w->left_margin_cols = left_width;
6643 w->right_margin_cols = right_width;
6645 adjust_window_margins (w);
6647 ++windows_or_buffers_changed;
6648 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6651 return Qnil;
6655 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6656 0, 1, 0,
6657 doc: /* Get width of marginal areas of window WINDOW.
6658 If WINDOW is omitted or nil, use the currently selected window.
6659 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6660 If a marginal area does not exist, its width will be returned
6661 as nil. */)
6662 (window)
6663 Lisp_Object window;
6665 struct window *w = decode_window (window);
6666 return Fcons (w->left_margin_cols, w->right_margin_cols);
6671 /***********************************************************************
6672 Fringes
6673 ***********************************************************************/
6675 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6676 2, 4, 0,
6677 doc: /* Set the fringe widths of window WINDOW.
6678 If WINDOW is nil, set the fringe widths of the currently selected
6679 window.
6680 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6681 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6682 fringe width. If a fringe width arg is nil, that means to use the
6683 frame's default fringe width. Default fringe widths can be set with
6684 the command `set-fringe-style'.
6685 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6686 outside of the display margins. By default, fringes are drawn between
6687 display marginal areas and the text area. */)
6688 (window, left_width, right_width, outside_margins)
6689 Lisp_Object window, left_width, right_width, outside_margins;
6691 struct window *w = decode_window (window);
6693 if (!NILP (left_width))
6694 CHECK_NATNUM (left_width);
6695 if (!NILP (right_width))
6696 CHECK_NATNUM (right_width);
6698 /* Do nothing on a tty. */
6699 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6700 && (!EQ (w->left_fringe_width, left_width)
6701 || !EQ (w->right_fringe_width, right_width)
6702 || !EQ (w->fringes_outside_margins, outside_margins)))
6704 w->left_fringe_width = left_width;
6705 w->right_fringe_width = right_width;
6706 w->fringes_outside_margins = outside_margins;
6708 adjust_window_margins (w);
6710 clear_glyph_matrix (w->current_matrix);
6711 w->window_end_valid = Qnil;
6713 ++windows_or_buffers_changed;
6714 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6717 return Qnil;
6721 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6722 0, 1, 0,
6723 doc: /* Get width of fringes of window WINDOW.
6724 If WINDOW is omitted or nil, use the currently selected window.
6725 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6726 (window)
6727 Lisp_Object window;
6729 struct window *w = decode_window (window);
6731 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6732 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6733 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6734 ? Qt : Qnil), Qnil)));
6739 /***********************************************************************
6740 Scroll bars
6741 ***********************************************************************/
6743 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars, Sset_window_scroll_bars,
6744 2, 4, 0,
6745 doc: /* Set width and type of scroll bars of window WINDOW.
6746 If window is nil, set scroll bars of the currently selected window.
6747 Second parameter WIDTH specifies the pixel width for the scroll bar;
6748 this is automatically adjusted to a multiple of the frame column width.
6749 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6750 bar: left, right, or nil.
6751 If WIDTH is nil, use the frame's scroll-bar width.
6752 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6753 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6754 (window, width, vertical_type, horizontal_type)
6755 Lisp_Object window, width, vertical_type, horizontal_type;
6757 struct window *w = decode_window (window);
6759 if (!NILP (width))
6761 CHECK_NATNUM (width);
6763 if (XINT (width) == 0)
6764 vertical_type = Qnil;
6767 if (!(NILP (vertical_type)
6768 || EQ (vertical_type, Qleft)
6769 || EQ (vertical_type, Qright)
6770 || EQ (vertical_type, Qt)))
6771 error ("Invalid type of vertical scroll bar");
6773 if (!EQ (w->scroll_bar_width, width)
6774 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6776 w->scroll_bar_width = width;
6777 w->vertical_scroll_bar_type = vertical_type;
6779 adjust_window_margins (w);
6781 clear_glyph_matrix (w->current_matrix);
6782 w->window_end_valid = Qnil;
6784 ++windows_or_buffers_changed;
6785 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6788 return Qnil;
6792 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6793 0, 1, 0,
6794 doc: /* Get width and type of scroll bars of window WINDOW.
6795 If WINDOW is omitted or nil, use the currently selected window.
6796 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6797 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6798 value. */)
6799 (window)
6800 Lisp_Object window;
6802 struct window *w = decode_window (window);
6803 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6804 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6805 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6806 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
6807 Fcons (w->vertical_scroll_bar_type,
6808 Fcons (Qnil, Qnil))));
6813 /***********************************************************************
6814 Smooth scrolling
6815 ***********************************************************************/
6817 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6818 doc: /* Return the amount by which WINDOW is scrolled vertically.
6819 Use the selected window if WINDOW is nil or omitted.
6820 Normally, value is a multiple of the canonical character height of WINDOW;
6821 optional second arg PIXELS-P means value is measured in pixels. */)
6822 (window, pixels_p)
6823 Lisp_Object window, pixels_p;
6825 Lisp_Object result;
6826 struct frame *f;
6827 struct window *w;
6829 if (NILP (window))
6830 window = selected_window;
6831 else
6832 CHECK_WINDOW (window);
6833 w = XWINDOW (window);
6834 f = XFRAME (w->frame);
6836 if (FRAME_WINDOW_P (f))
6837 result = (NILP (pixels_p)
6838 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
6839 : make_number (-w->vscroll));
6840 else
6841 result = make_number (0);
6842 return result;
6846 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
6847 2, 3, 0,
6848 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6849 WINDOW nil means use the selected window. Normally, VSCROLL is a
6850 non-negative multiple of the canonical character height of WINDOW;
6851 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6852 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6853 corresponds to an integral number of pixels. The return value is the
6854 result of this rounding.
6855 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6856 (window, vscroll, pixels_p)
6857 Lisp_Object window, vscroll, pixels_p;
6859 struct window *w;
6860 struct frame *f;
6862 if (NILP (window))
6863 window = selected_window;
6864 else
6865 CHECK_WINDOW (window);
6866 CHECK_NUMBER_OR_FLOAT (vscroll);
6868 w = XWINDOW (window);
6869 f = XFRAME (w->frame);
6871 if (FRAME_WINDOW_P (f))
6873 int old_dy = w->vscroll;
6875 w->vscroll = - (NILP (pixels_p)
6876 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6877 : XFLOATINT (vscroll));
6878 w->vscroll = min (w->vscroll, 0);
6880 if (w->vscroll != old_dy)
6882 /* Adjust glyph matrix of the frame if the virtual display
6883 area becomes larger than before. */
6884 if (w->vscroll < 0 && w->vscroll < old_dy)
6885 adjust_glyphs (f);
6887 /* Prevent redisplay shortcuts. */
6888 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
6892 return Fwindow_vscroll (window, pixels_p);
6896 /* Call FN for all leaf windows on frame F. FN is called with the
6897 first argument being a pointer to the leaf window, and with
6898 additional argument USER_DATA. Stops when FN returns 0. */
6900 void
6901 foreach_window (f, fn, user_data)
6902 struct frame *f;
6903 int (* fn) P_ ((struct window *, void *));
6904 void *user_data;
6906 /* Fdelete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6907 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6908 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6912 /* Helper function for foreach_window. Call FN for all leaf windows
6913 reachable from W. FN is called with the first argument being a
6914 pointer to the leaf window, and with additional argument USER_DATA.
6915 Stop when FN returns 0. Value is 0 if stopped by FN. */
6917 static int
6918 foreach_window_1 (w, fn, user_data)
6919 struct window *w;
6920 int (* fn) P_ ((struct window *, void *));
6921 void *user_data;
6923 int cont;
6925 for (cont = 1; w && cont;)
6927 if (!NILP (w->hchild))
6928 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6929 else if (!NILP (w->vchild))
6930 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6931 else
6932 cont = fn (w, user_data);
6934 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6937 return cont;
6941 /* Freeze or unfreeze the window start of W unless it is a
6942 mini-window or the selected window. FREEZE_P non-null means freeze
6943 the window start. */
6945 static int
6946 freeze_window_start (w, freeze_p)
6947 struct window *w;
6948 void *freeze_p;
6950 if (MINI_WINDOW_P (w)
6951 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6952 && (w == XWINDOW (selected_window)
6953 || (MINI_WINDOW_P (XWINDOW (selected_window))
6954 && ! NILP (Vminibuf_scroll_window)
6955 && w == XWINDOW (Vminibuf_scroll_window)))))
6956 freeze_p = NULL;
6958 w->frozen_window_start_p = freeze_p != NULL;
6959 return 1;
6963 /* Freeze or unfreeze the window starts of all leaf windows on frame
6964 F, except the selected window and a mini-window. FREEZE_P non-zero
6965 means freeze the window start. */
6967 void
6968 freeze_window_starts (f, freeze_p)
6969 struct frame *f;
6970 int freeze_p;
6972 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6976 /***********************************************************************
6977 Initialization
6978 ***********************************************************************/
6980 /* Return 1 if window configurations C1 and C2
6981 describe the same state of affairs. This is used by Fequal. */
6984 compare_window_configurations (c1, c2, ignore_positions)
6985 Lisp_Object c1, c2;
6986 int ignore_positions;
6988 register struct save_window_data *d1, *d2;
6989 struct Lisp_Vector *sw1, *sw2;
6990 int i;
6992 CHECK_WINDOW_CONFIGURATION (c1);
6993 CHECK_WINDOW_CONFIGURATION (c2);
6995 d1 = (struct save_window_data *) XVECTOR (c1);
6996 d2 = (struct save_window_data *) XVECTOR (c2);
6997 sw1 = XVECTOR (d1->saved_windows);
6998 sw2 = XVECTOR (d2->saved_windows);
7000 if (d1->frame_cols != d2->frame_cols)
7001 return 0;
7002 if (d1->frame_lines != d2->frame_lines)
7003 return 0;
7004 if (d1->frame_menu_bar_lines != d2->frame_menu_bar_lines)
7005 return 0;
7006 if (! EQ (d1->selected_frame, d2->selected_frame))
7007 return 0;
7008 /* Don't compare the current_window field directly.
7009 Instead see w1_is_current and w2_is_current, below. */
7010 if (! EQ (d1->current_buffer, d2->current_buffer))
7011 return 0;
7012 if (! ignore_positions)
7014 if (! EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window))
7015 return 0;
7016 if (! EQ (d1->minibuf_selected_window, d2->minibuf_selected_window))
7017 return 0;
7019 /* Don't compare the root_window field.
7020 We don't require the two configurations
7021 to use the same window object,
7022 and the two root windows must be equivalent
7023 if everything else compares equal. */
7024 if (! EQ (d1->focus_frame, d2->focus_frame))
7025 return 0;
7027 /* Verify that the two confis have the same number of windows. */
7028 if (sw1->size != sw2->size)
7029 return 0;
7031 for (i = 0; i < sw1->size; i++)
7033 struct saved_window *p1, *p2;
7034 int w1_is_current, w2_is_current;
7036 p1 = SAVED_WINDOW_N (sw1, i);
7037 p2 = SAVED_WINDOW_N (sw2, i);
7039 /* Verify that the current windows in the two
7040 configurations correspond to each other. */
7041 w1_is_current = EQ (d1->current_window, p1->window);
7042 w2_is_current = EQ (d2->current_window, p2->window);
7044 if (w1_is_current != w2_is_current)
7045 return 0;
7047 /* Verify that the corresponding windows do match. */
7048 if (! EQ (p1->buffer, p2->buffer))
7049 return 0;
7050 if (! EQ (p1->left_col, p2->left_col))
7051 return 0;
7052 if (! EQ (p1->top_line, p2->top_line))
7053 return 0;
7054 if (! EQ (p1->total_cols, p2->total_cols))
7055 return 0;
7056 if (! EQ (p1->total_lines, p2->total_lines))
7057 return 0;
7058 if (! EQ (p1->display_table, p2->display_table))
7059 return 0;
7060 if (! EQ (p1->parent, p2->parent))
7061 return 0;
7062 if (! EQ (p1->prev, p2->prev))
7063 return 0;
7064 if (! ignore_positions)
7066 if (! EQ (p1->hscroll, p2->hscroll))
7067 return 0;
7068 if (!EQ (p1->min_hscroll, p2->min_hscroll))
7069 return 0;
7070 if (! EQ (p1->start_at_line_beg, p2->start_at_line_beg))
7071 return 0;
7072 if (NILP (Fequal (p1->start, p2->start)))
7073 return 0;
7074 if (NILP (Fequal (p1->pointm, p2->pointm)))
7075 return 0;
7076 if (NILP (Fequal (p1->mark, p2->mark)))
7077 return 0;
7079 if (! EQ (p1->left_margin_cols, p2->left_margin_cols))
7080 return 0;
7081 if (! EQ (p1->right_margin_cols, p2->right_margin_cols))
7082 return 0;
7083 if (! EQ (p1->left_fringe_width, p2->left_fringe_width))
7084 return 0;
7085 if (! EQ (p1->right_fringe_width, p2->right_fringe_width))
7086 return 0;
7087 if (! EQ (p1->fringes_outside_margins, p2->fringes_outside_margins))
7088 return 0;
7089 if (! EQ (p1->scroll_bar_width, p2->scroll_bar_width))
7090 return 0;
7091 if (! EQ (p1->vertical_scroll_bar_type, p2->vertical_scroll_bar_type))
7092 return 0;
7095 return 1;
7098 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
7099 Scompare_window_configurations, 2, 2, 0,
7100 doc: /* Compare two window configurations as regards the structure of windows.
7101 This function ignores details such as the values of point and mark
7102 and scrolling positions. */)
7103 (x, y)
7104 Lisp_Object x, y;
7106 if (compare_window_configurations (x, y, 1))
7107 return Qt;
7108 return Qnil;
7111 void
7112 init_window_once ()
7114 struct frame *f = make_initial_frame ();
7115 XSETFRAME (selected_frame, f);
7116 Vterminal_frame = selected_frame;
7117 minibuf_window = f->minibuffer_window;
7118 selected_window = f->selected_window;
7119 last_nonminibuf_frame = f;
7121 window_initialized = 1;
7124 void
7125 init_window ()
7127 Vwindow_list = Qnil;
7130 void
7131 syms_of_window ()
7133 Qscroll_up = intern ("scroll-up");
7134 staticpro (&Qscroll_up);
7136 Qscroll_down = intern ("scroll-down");
7137 staticpro (&Qscroll_down);
7139 Qwindow_size_fixed = intern ("window-size-fixed");
7140 staticpro (&Qwindow_size_fixed);
7141 Fset (Qwindow_size_fixed, Qnil);
7143 staticpro (&Qwindow_configuration_change_hook);
7144 Qwindow_configuration_change_hook
7145 = intern ("window-configuration-change-hook");
7147 Qwindowp = intern ("windowp");
7148 staticpro (&Qwindowp);
7150 Qwindow_configuration_p = intern ("window-configuration-p");
7151 staticpro (&Qwindow_configuration_p);
7153 Qwindow_live_p = intern ("window-live-p");
7154 staticpro (&Qwindow_live_p);
7156 Qdisplay_buffer = intern ("display-buffer");
7157 staticpro (&Qdisplay_buffer);
7159 Qtemp_buffer_show_hook = intern ("temp-buffer-show-hook");
7160 staticpro (&Qtemp_buffer_show_hook);
7162 staticpro (&Vwindow_list);
7164 minibuf_selected_window = Qnil;
7165 staticpro (&minibuf_selected_window);
7167 window_scroll_pixel_based_preserve_x = -1;
7168 window_scroll_pixel_based_preserve_y = -1;
7169 window_scroll_preserve_hpos = -1;
7170 window_scroll_preserve_vpos = -1;
7172 DEFVAR_LISP ("temp-buffer-show-function", &Vtemp_buffer_show_function,
7173 doc: /* Non-nil means call as function to display a help buffer.
7174 The function is called with one argument, the buffer to be displayed.
7175 Used by `with-output-to-temp-buffer'.
7176 If this function is used, then it must do the entire job of showing
7177 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
7178 Vtemp_buffer_show_function = Qnil;
7180 DEFVAR_LISP ("minibuffer-scroll-window", &Vminibuf_scroll_window,
7181 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
7182 Vminibuf_scroll_window = Qnil;
7184 DEFVAR_BOOL ("mode-line-in-non-selected-windows", &mode_line_in_non_selected_windows,
7185 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
7186 If the minibuffer is active, the `minibuffer-scroll-window' mode line
7187 is displayed in the `mode-line' face. */);
7188 mode_line_in_non_selected_windows = 1;
7190 DEFVAR_LISP ("other-window-scroll-buffer", &Vother_window_scroll_buffer,
7191 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
7192 Vother_window_scroll_buffer = Qnil;
7194 DEFVAR_BOOL ("auto-window-vscroll", &auto_window_vscroll_p,
7195 doc: /* *Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
7196 auto_window_vscroll_p = 1;
7198 DEFVAR_INT ("next-screen-context-lines", &next_screen_context_lines,
7199 doc: /* *Number of lines of continuity when scrolling by screenfuls. */);
7200 next_screen_context_lines = 2;
7202 DEFVAR_INT ("window-min-height", &window_min_height,
7203 doc: /* Allow deleting windows less than this tall.
7204 The value is measured in line units. If a window wants a modeline it
7205 is counted as one line.
7207 Emacs honors settings of this variable when enlarging or shrinking
7208 windows vertically. A value less than 1 is invalid. */);
7209 window_min_height = 4;
7211 DEFVAR_INT ("window-min-width", &window_min_width,
7212 doc: /* Allow deleting windows less than this wide.
7213 The value is measured in characters and includes any fringes or
7214 the scrollbar.
7216 Emacs honors settings of this variable when enlarging or shrinking
7217 windows horizontally. A value less than 2 is invalid. */);
7218 window_min_width = 10;
7220 DEFVAR_LISP ("scroll-preserve-screen-position",
7221 &Vscroll_preserve_screen_position,
7222 doc: /* *Controls if scroll commands move point to keep its screen position unchanged.
7223 A value of nil means point does not keep its screen position except
7224 at the scroll margin or window boundary respectively.
7225 A value of t means point keeps its screen position if the scroll
7226 command moved it vertically out of the window, e.g. when scrolling
7227 by full screens.
7228 Any other value means point always keeps its screen position. */);
7229 Vscroll_preserve_screen_position = Qnil;
7231 DEFVAR_LISP ("window-point-insertion-type", &Vwindow_point_insertion_type,
7232 doc: /* Type of marker to use for `window-point'. */);
7233 Vwindow_point_insertion_type = Qnil;
7235 DEFVAR_LISP ("window-configuration-change-hook",
7236 &Vwindow_configuration_change_hook,
7237 doc: /* Functions to call when window configuration changes.
7238 The buffer-local part is run once per window, with the relevant window
7239 selected; while the global part is run only once for the modified frame,
7240 with the relevant frame selected. */);
7241 Vwindow_configuration_change_hook = Qnil;
7243 defsubr (&Sselected_window);
7244 defsubr (&Sminibuffer_window);
7245 defsubr (&Swindow_minibuffer_p);
7246 defsubr (&Swindowp);
7247 defsubr (&Swindow_live_p);
7248 defsubr (&Spos_visible_in_window_p);
7249 defsubr (&Swindow_line_height);
7250 defsubr (&Swindow_buffer);
7251 defsubr (&Swindow_height);
7252 defsubr (&Swindow_width);
7253 defsubr (&Swindow_full_width_p);
7254 defsubr (&Swindow_hscroll);
7255 defsubr (&Sset_window_hscroll);
7256 defsubr (&Swindow_redisplay_end_trigger);
7257 defsubr (&Sset_window_redisplay_end_trigger);
7258 defsubr (&Swindow_edges);
7259 defsubr (&Swindow_pixel_edges);
7260 defsubr (&Swindow_inside_edges);
7261 defsubr (&Swindow_inside_pixel_edges);
7262 defsubr (&Scoordinates_in_window_p);
7263 defsubr (&Swindow_at);
7264 defsubr (&Swindow_point);
7265 defsubr (&Swindow_start);
7266 defsubr (&Swindow_end);
7267 defsubr (&Sset_window_point);
7268 defsubr (&Sset_window_start);
7269 defsubr (&Swindow_dedicated_p);
7270 defsubr (&Sset_window_dedicated_p);
7271 defsubr (&Swindow_display_table);
7272 defsubr (&Sset_window_display_table);
7273 defsubr (&Snext_window);
7274 defsubr (&Sprevious_window);
7275 defsubr (&Sother_window);
7276 defsubr (&Sget_lru_window);
7277 defsubr (&Sget_largest_window);
7278 defsubr (&Sget_buffer_window);
7279 defsubr (&Sdelete_other_windows);
7280 defsubr (&Sdelete_windows_on);
7281 defsubr (&Sreplace_buffer_in_windows);
7282 defsubr (&Sdelete_window);
7283 defsubr (&Sset_window_buffer);
7284 defsubr (&Sselect_window);
7285 defsubr (&Sforce_window_update);
7286 defsubr (&Ssplit_window);
7287 defsubr (&Senlarge_window);
7288 defsubr (&Sshrink_window);
7289 defsubr (&Sadjust_window_trailing_edge);
7290 defsubr (&Sscroll_up);
7291 defsubr (&Sscroll_down);
7292 defsubr (&Sscroll_left);
7293 defsubr (&Sscroll_right);
7294 defsubr (&Sother_window_for_scrolling);
7295 defsubr (&Sscroll_other_window);
7296 defsubr (&Sminibuffer_selected_window);
7297 defsubr (&Srecenter);
7298 defsubr (&Swindow_text_height);
7299 defsubr (&Smove_to_window_line);
7300 defsubr (&Swindow_configuration_p);
7301 defsubr (&Swindow_configuration_frame);
7302 defsubr (&Sset_window_configuration);
7303 defsubr (&Scurrent_window_configuration);
7304 defsubr (&Ssave_window_excursion);
7305 defsubr (&Swindow_tree);
7306 defsubr (&Sset_window_margins);
7307 defsubr (&Swindow_margins);
7308 defsubr (&Sset_window_fringes);
7309 defsubr (&Swindow_fringes);
7310 defsubr (&Sset_window_scroll_bars);
7311 defsubr (&Swindow_scroll_bars);
7312 defsubr (&Swindow_vscroll);
7313 defsubr (&Sset_window_vscroll);
7314 defsubr (&Scompare_window_configurations);
7315 defsubr (&Swindow_list);
7316 defsubr (&Swindow_parameters);
7317 defsubr (&Swindow_parameter);
7318 defsubr (&Sset_window_parameter);
7322 void
7323 keys_of_window ()
7325 initial_define_key (control_x_map, '1', "delete-other-windows");
7326 initial_define_key (control_x_map, '2', "split-window");
7327 initial_define_key (control_x_map, '0', "delete-window");
7328 initial_define_key (control_x_map, 'o', "other-window");
7329 initial_define_key (control_x_map, '^', "enlarge-window");
7330 initial_define_key (control_x_map, '<', "scroll-left");
7331 initial_define_key (control_x_map, '>', "scroll-right");
7333 initial_define_key (global_map, Ctl ('V'), "scroll-up");
7334 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
7335 initial_define_key (meta_map, 'v', "scroll-down");
7337 initial_define_key (global_map, Ctl('L'), "recenter");
7338 initial_define_key (meta_map, 'r', "move-to-window-line");
7341 /* arch-tag: 90a9c576-0590-48f1-a5f1-6c96a0452d9f
7342 (do not change this comment) */