(Optional Mode Line): Document `size-indication-mode'.
[emacs.git] / src / window.c
blob78033c38da1b2552012dc2e755c214f92198d88e
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985,86,87,93,94,95,96,97,1998,2000, 2001, 2002, 2003
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 #include <config.h>
24 #include "lisp.h"
25 #include "buffer.h"
26 #include "keyboard.h"
27 #include "keymap.h"
28 #include "frame.h"
29 #include "window.h"
30 #include "commands.h"
31 #include "indent.h"
32 #include "termchar.h"
33 #include "disptab.h"
34 #include "dispextern.h"
35 #include "blockinput.h"
36 #include "intervals.h"
38 #ifdef HAVE_X_WINDOWS
39 #include "xterm.h"
40 #endif /* HAVE_X_WINDOWS */
41 #ifdef WINDOWSNT
42 #include "w32term.h"
43 #endif
44 #ifdef MSDOS
45 #include "msdos.h"
46 #endif
47 #ifdef MAC_OS
48 #include "macterm.h"
49 #endif
52 Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
53 Lisp_Object Qwindow_size_fixed;
54 extern Lisp_Object Qleft_margin, Qright_margin;
56 static int displayed_window_lines P_ ((struct window *));
57 static struct window *decode_window P_ ((Lisp_Object));
58 static int count_windows P_ ((struct window *));
59 static int get_leaf_windows P_ ((struct window *, struct window **, int));
60 static void window_scroll P_ ((Lisp_Object, int, int, int));
61 static void window_scroll_pixel_based P_ ((Lisp_Object, int, int, int));
62 static void window_scroll_line_based P_ ((Lisp_Object, int, int, int));
63 static int window_min_size_1 P_ ((struct window *, int));
64 static int window_min_size P_ ((struct window *, int, int, int *));
65 static void size_window P_ ((Lisp_Object, int, int, int));
66 static int freeze_window_start P_ ((struct window *, void *));
67 static int window_fixed_size_p P_ ((struct window *, int, int));
68 static void enlarge_window P_ ((Lisp_Object, int, int, int));
69 static Lisp_Object window_list P_ ((void));
70 static int add_window_to_list P_ ((struct window *, void *));
71 static int candidate_window_p P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
72 Lisp_Object));
73 static Lisp_Object next_window P_ ((Lisp_Object, Lisp_Object,
74 Lisp_Object, int));
75 static void decode_next_window_args P_ ((Lisp_Object *, Lisp_Object *,
76 Lisp_Object *));
77 static int foreach_window_1 P_ ((struct window *,
78 int (* fn) (struct window *, void *),
79 void *));
80 static Lisp_Object window_list_1 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
82 /* The value of `window-size-fixed'. */
84 int window_size_fixed;
86 /* This is the window in which the terminal's cursor should
87 be left when nothing is being done with it. This must
88 always be a leaf window, and its buffer is selected by
89 the top level editing loop at the end of each command.
91 This value is always the same as
92 FRAME_SELECTED_WINDOW (selected_frame). */
94 Lisp_Object selected_window;
96 /* A list of all windows for use by next_window and Fwindow_list.
97 Functions creating or deleting windows should invalidate this cache
98 by setting it to nil. */
100 Lisp_Object Vwindow_list;
102 /* The mini-buffer window of the selected frame.
103 Note that you cannot test for mini-bufferness of an arbitrary window
104 by comparing against this; but you can test for mini-bufferness of
105 the selected window. */
107 Lisp_Object minibuf_window;
109 /* Non-nil means it is the window whose mode line should be
110 shown as the selected window when the minibuffer is selected. */
112 Lisp_Object minibuf_selected_window;
114 /* Non-nil means it is the window for C-M-v to scroll
115 when the mini-buffer is selected. */
117 Lisp_Object Vminibuf_scroll_window;
119 /* Non-nil means this is the buffer whose window C-M-v should scroll. */
121 Lisp_Object Vother_window_scroll_buffer;
123 /* Non-nil means it's function to call to display temp buffers. */
125 Lisp_Object Vtemp_buffer_show_function;
127 /* Non-zero means to use mode-line-inactive face in all windows but the
128 selected-window and the minibuffer-scroll-window when the
129 minibuffer is active. */
130 int mode_line_in_non_selected_windows;
132 /* If a window gets smaller than either of these, it is removed. */
134 EMACS_INT window_min_height;
135 EMACS_INT window_min_width;
137 /* Nonzero implies Fdisplay_buffer should create windows. */
139 int pop_up_windows;
141 /* Nonzero implies make new frames for Fdisplay_buffer. */
143 int pop_up_frames;
145 /* Nonzero means reuse existing frames for displaying buffers. */
147 int display_buffer_reuse_frames;
149 /* Non-nil means use this function instead of default */
151 Lisp_Object Vpop_up_frame_function;
153 /* Function to call to handle Fdisplay_buffer. */
155 Lisp_Object Vdisplay_buffer_function;
157 /* Non-nil means that Fdisplay_buffer should even the heights of windows. */
159 Lisp_Object Veven_window_heights;
161 /* List of buffer *names* for buffers that should have their own frames. */
163 Lisp_Object Vspecial_display_buffer_names;
165 /* List of regexps for buffer names that should have their own frames. */
167 Lisp_Object Vspecial_display_regexps;
169 /* Function to pop up a special frame. */
171 Lisp_Object Vspecial_display_function;
173 /* List of buffer *names* for buffers to appear in selected window. */
175 Lisp_Object Vsame_window_buffer_names;
177 /* List of regexps for buffer names to appear in selected window. */
179 Lisp_Object Vsame_window_regexps;
181 /* Hook run at end of temp_output_buffer_show. */
183 Lisp_Object Qtemp_buffer_show_hook;
185 /* Fdisplay_buffer always splits the largest window
186 if that window is more than this high. */
188 EMACS_INT split_height_threshold;
190 /* Number of lines of continuity in scrolling by screenfuls. */
192 EMACS_INT next_screen_context_lines;
194 /* Incremented for each window created. */
196 static int sequence_number;
198 /* Nonzero after init_window_once has finished. */
200 static int window_initialized;
202 /* Hook to run when window config changes. */
204 Lisp_Object Qwindow_configuration_change_hook;
205 Lisp_Object Vwindow_configuration_change_hook;
207 /* Nonzero means scroll commands try to put point
208 at the same screen height as previously. */
210 Lisp_Object Vscroll_preserve_screen_position;
212 #if 0 /* This isn't used anywhere. */
213 /* Nonzero means we can split a frame even if it is "unsplittable". */
214 static int inhibit_frame_unsplittable;
215 #endif /* 0 */
217 extern EMACS_INT scroll_margin;
219 extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
221 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
222 doc: /* Returns t if OBJECT is a window. */)
223 (object)
224 Lisp_Object object;
226 return WINDOWP (object) ? Qt : Qnil;
229 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
230 doc: /* Returns t if OBJECT is a window which is currently visible. */)
231 (object)
232 Lisp_Object object;
234 return WINDOW_LIVE_P (object) ? Qt : Qnil;
237 Lisp_Object
238 make_window ()
240 Lisp_Object val;
241 register struct window *p;
243 p = allocate_window ();
244 XSETFASTINT (p->sequence_number, ++sequence_number);
245 XSETFASTINT (p->left_col, 0);
246 XSETFASTINT (p->top_line, 0);
247 XSETFASTINT (p->total_lines, 0);
248 XSETFASTINT (p->total_cols, 0);
249 XSETFASTINT (p->hscroll, 0);
250 XSETFASTINT (p->min_hscroll, 0);
251 p->orig_top_line = p->orig_total_lines = Qnil;
252 p->start = Fmake_marker ();
253 p->pointm = Fmake_marker ();
254 XSETFASTINT (p->use_time, 0);
255 p->frame = Qnil;
256 p->display_table = Qnil;
257 p->dedicated = Qnil;
258 p->pseudo_window_p = 0;
259 bzero (&p->cursor, sizeof (p->cursor));
260 bzero (&p->last_cursor, sizeof (p->last_cursor));
261 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
262 p->desired_matrix = p->current_matrix = 0;
263 p->phys_cursor_type = -1;
264 p->phys_cursor_width = -1;
265 p->must_be_updated_p = 0;
266 XSETFASTINT (p->window_end_vpos, 0);
267 XSETFASTINT (p->window_end_pos, 0);
268 p->window_end_valid = Qnil;
269 p->vscroll = 0;
270 XSETWINDOW (val, p);
271 XSETFASTINT (p->last_point, 0);
272 p->frozen_window_start_p = 0;
273 p->height_fixed_p = 0;
274 p->last_cursor_off_p = p->cursor_off_p = 0;
275 p->left_margin_cols = Qnil;
276 p->right_margin_cols = Qnil;
277 p->left_fringe_width = Qnil;
278 p->right_fringe_width = Qnil;
279 p->fringes_outside_margins = Qnil;
280 p->scroll_bar_width = Qnil;
281 p->vertical_scroll_bar_type = Qt;
283 Vwindow_list = Qnil;
284 return val;
287 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
288 doc: /* Return the window that the cursor now appears in and commands apply to. */)
291 return selected_window;
294 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
295 doc: /* Return the window used now for minibuffers.
296 If the optional argument FRAME is specified, return the minibuffer window
297 used by that frame. */)
298 (frame)
299 Lisp_Object frame;
301 if (NILP (frame))
302 frame = selected_frame;
303 CHECK_LIVE_FRAME (frame);
304 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
307 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
308 doc: /* Returns non-nil if WINDOW is a minibuffer window. */)
309 (window)
310 Lisp_Object window;
312 struct window *w = decode_window (window);
313 return MINI_WINDOW_P (w) ? Qt : Qnil;
317 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
318 Spos_visible_in_window_p, 0, 3, 0,
319 doc: /* Return t if position POS is currently on the frame in WINDOW.
320 Return nil if that position is scrolled vertically out of view.
321 If a character is only partially visible, nil is returned, unless the
322 optional argument PARTIALLY is non-nil.
323 POS defaults to point in WINDOW; WINDOW defaults to the selected window. */)
324 (pos, window, partially)
325 Lisp_Object pos, window, partially;
327 register struct window *w;
328 register int posint;
329 register struct buffer *buf;
330 struct text_pos top;
331 Lisp_Object in_window;
332 int fully_p;
334 w = decode_window (window);
335 buf = XBUFFER (w->buffer);
336 SET_TEXT_POS_FROM_MARKER (top, w->start);
338 if (!NILP (pos))
340 CHECK_NUMBER_COERCE_MARKER (pos);
341 posint = XINT (pos);
343 else if (w == XWINDOW (selected_window))
344 posint = PT;
345 else
346 posint = XMARKER (w->pointm)->charpos;
348 /* If position is above window start, it's not visible. */
349 if (posint < CHARPOS (top))
350 in_window = Qnil;
351 else if (XFASTINT (w->last_modified) >= BUF_MODIFF (buf)
352 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (buf)
353 && posint < BUF_Z (buf) - XFASTINT (w->window_end_pos))
355 /* If frame is up-to-date, and POSINT is < window end pos, use
356 that info. This doesn't work for POSINT == end pos, because
357 the window end pos is actually the position _after_ the last
358 char in the window. */
359 if (NILP (partially))
361 pos_visible_p (w, posint, &fully_p, NILP (partially));
362 in_window = fully_p ? Qt : Qnil;
364 else
365 in_window = Qt;
367 else if (posint > BUF_ZV (buf))
368 in_window = Qnil;
369 else if (CHARPOS (top) < BUF_BEGV (buf) || CHARPOS (top) > BUF_ZV (buf))
370 /* If window start is out of range, do something reasonable. */
371 in_window = Qnil;
372 else
374 if (pos_visible_p (w, posint, &fully_p, NILP (partially)))
375 in_window = !NILP (partially) || fully_p ? Qt : Qnil;
376 else
377 in_window = Qnil;
380 return in_window;
384 static struct window *
385 decode_window (window)
386 register Lisp_Object window;
388 if (NILP (window))
389 return XWINDOW (selected_window);
391 CHECK_LIVE_WINDOW (window);
392 return XWINDOW (window);
395 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
396 doc: /* Return the buffer that WINDOW is displaying. */)
397 (window)
398 Lisp_Object window;
400 return decode_window (window)->buffer;
403 DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
404 doc: /* Return the number of lines in WINDOW (including its mode line). */)
405 (window)
406 Lisp_Object window;
408 return decode_window (window)->total_lines;
411 DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
412 doc: /* Return the number of display columns in WINDOW.
413 This is the width that is usable columns available for text in WINDOW.
414 If you want to find out how many columns WINDOW takes up,
415 use (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))). */)
416 (window)
417 Lisp_Object window;
419 return make_number (window_box_text_cols (decode_window (window)));
422 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
423 doc: /* Return the number of columns by which WINDOW is scrolled from left margin. */)
424 (window)
425 Lisp_Object window;
427 return decode_window (window)->hscroll;
430 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
431 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
432 NCOL should be zero or positive.
434 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
435 window so that the location of point becomes invisible. */)
436 (window, ncol)
437 Lisp_Object window, ncol;
439 struct window *w = decode_window (window);
440 int hscroll;
442 CHECK_NUMBER (ncol);
443 hscroll = max (0, XINT (ncol));
445 /* Prevent redisplay shortcuts when changing the hscroll. */
446 if (XINT (w->hscroll) != hscroll)
447 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
449 w->hscroll = make_number (hscroll);
450 return ncol;
453 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
454 Swindow_redisplay_end_trigger, 0, 1, 0,
455 doc: /* Return WINDOW's redisplay end trigger value.
456 See `set-window-redisplay-end-trigger' for more information. */)
457 (window)
458 Lisp_Object window;
460 return decode_window (window)->redisplay_end_trigger;
463 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
464 Sset_window_redisplay_end_trigger, 2, 2, 0,
465 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
466 VALUE should be a buffer position (typically a marker) or nil.
467 If it is a buffer position, then if redisplay in WINDOW reaches a position
468 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
469 with two arguments: WINDOW, and the end trigger value.
470 Afterwards the end-trigger value is reset to nil. */)
471 (window, value)
472 register Lisp_Object window, value;
474 register struct window *w;
476 w = decode_window (window);
477 w->redisplay_end_trigger = value;
478 return value;
481 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
482 doc: /* Return a list of the edge coordinates of WINDOW.
483 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
484 RIGHT is one more than the rightmost column occupied by WINDOW,
485 and BOTTOM is one more than the bottommost row occupied by WINDOW.
486 The edges include the space used by the window's scroll bar,
487 display margins, fringes, header line, and mode line, if it has them.
488 To get the edges of the actual text area, use `window-inside-edges'. */)
489 (window)
490 Lisp_Object window;
492 register struct window *w = decode_window (window);
494 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
495 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
496 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
497 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
498 Qnil))));
501 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
502 doc: /* Return a list of the edge pixel coordinates of WINDOW.
503 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
504 RIGHT is one more than the rightmost x position occupied by WINDOW,
505 and BOTTOM is one more than the bottommost y position occupied by WINDOW.
506 The pixel edges include the space used by the window's scroll bar,
507 display margins, fringes, header line, and mode line, if it has them.
508 To get the edges of the actual text area, use `window-inside-pixel-edges'. */)
509 (window)
510 Lisp_Object window;
512 register struct window *w = decode_window (window);
514 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
515 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
516 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
517 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
518 Qnil))));
521 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
522 doc: /* Return a list of the edge coordinates of WINDOW.
523 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
524 RIGHT is one more than the rightmost column used by text in WINDOW,
525 and BOTTOM is one more than the bottommost row used by text in WINDOW.
526 The inside edges do not include the space used by the window's scroll bar,
527 display margins, fringes, header line, and/or mode line. */)
528 (window)
529 Lisp_Object window;
531 register struct window *w = decode_window (window);
533 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
534 + WINDOW_LEFT_MARGIN_COLS (w)
535 + WINDOW_LEFT_FRINGE_COLS (w)),
536 make_number (WINDOW_TOP_EDGE_LINE (w)
537 + WINDOW_HEADER_LINE_LINES (w)),
538 make_number (WINDOW_RIGHT_EDGE_COL (w)
539 - WINDOW_RIGHT_MARGIN_COLS (w)
540 - WINDOW_RIGHT_FRINGE_COLS (w)),
541 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
542 - WINDOW_MODE_LINE_LINES (w)));
545 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
546 doc: /* Return a list of the edge coordinates of WINDOW.
547 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
548 RIGHT is one more than the rightmost x position used by text in WINDOW,
549 and BOTTOM is one more than the bottommost y position used by text in WINDOW.
550 The inside edges do not include the space used by the window's scroll bar,
551 display margins, fringes, header line, and/or mode line. */)
552 (window)
553 Lisp_Object window;
555 register struct window *w = decode_window (window);
557 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
558 + WINDOW_LEFT_MARGIN_WIDTH (w)
559 + WINDOW_LEFT_FRINGE_WIDTH (w)),
560 make_number (WINDOW_TOP_EDGE_Y (w)
561 + WINDOW_HEADER_LINE_HEIGHT (w)),
562 make_number (WINDOW_RIGHT_EDGE_X (w)
563 - WINDOW_RIGHT_MARGIN_WIDTH (w)
564 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
565 make_number (WINDOW_BOTTOM_EDGE_Y (w)
566 - WINDOW_MODE_LINE_HEIGHT (w)));
569 /* Test if the character at column *X, row *Y is within window W.
570 If it is not, return ON_NOTHING;
571 if it is in the window's text area,
572 set *x and *y to its location relative to the upper left corner
573 of the window, and
574 return ON_TEXT;
575 if it is on the window's modeline, return ON_MODE_LINE;
576 if it is on the border between the window and its right sibling,
577 return ON_VERTICAL_BORDER.
578 if it is on the window's top line, return ON_HEADER_LINE;
579 if it is in left or right fringe of the window,
580 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE, and convert *X and *Y
581 to window-relative coordinates;
582 if it is in the marginal area to the left/right of the window,
583 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN, and convert *X and *Y
584 to window-relative coordinates.
586 X and Y are frame relative pixel coordinates. */
588 static enum window_part
589 coordinates_in_window (w, x, y)
590 register struct window *w;
591 register int *x, *y;
593 struct frame *f = XFRAME (WINDOW_FRAME (w));
594 int left_x, right_x, top_y, bottom_y;
595 enum window_part part;
596 int ux = FRAME_COLUMN_WIDTH (f);
597 int x0 = WINDOW_LEFT_EDGE_X (w);
598 int x1 = WINDOW_RIGHT_EDGE_X (w);
599 /* The width of the area where the vertical line can be dragged.
600 (Between mode lines for instance. */
601 int grabbable_width = ux;
602 int lmargin_width, rmargin_width, text_left, text_right;
604 if (*x < x0 || *x >= x1)
605 return ON_NOTHING;
607 /* In what's below, we subtract 1 when computing right_x because we
608 want the rightmost pixel, which is given by left_pixel+width-1. */
609 if (w->pseudo_window_p)
611 left_x = 0;
612 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
613 top_y = WINDOW_TOP_EDGE_Y (w);
614 bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
616 else
618 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
619 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
620 top_y = WINDOW_TOP_EDGE_Y (w);
621 bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
624 /* Outside any interesting row? */
625 if (*y < top_y || *y >= bottom_y)
626 return ON_NOTHING;
628 /* On the mode line or header line? If it's near the start of
629 the mode or header line of window that's has a horizontal
630 sibling, say it's on the vertical line. That's to be able
631 to resize windows horizontally in case we're using toolkit
632 scroll bars. */
634 if (WINDOW_WANTS_MODELINE_P (w)
635 && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
636 && *y < bottom_y)
638 part = ON_MODE_LINE;
640 header_vertical_border_check:
641 /* We're somewhere on the mode line. We consider the place
642 between mode lines of horizontally adjacent mode lines
643 as the vertical border. If scroll bars on the left,
644 return the right window. */
645 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
646 || WINDOW_RIGHTMOST_P (w))
648 if (!WINDOW_LEFTMOST_P (w) && abs (*x - x0) < grabbable_width)
649 return ON_VERTICAL_BORDER;
651 else
653 if (abs (*x - x1) < grabbable_width)
654 return ON_VERTICAL_BORDER;
657 /* Convert X and Y to window relative coordinates.
658 Mode line starts at left edge of window. */
659 *x -= x0;
660 *y -= top_y;
661 return part;
664 if (WINDOW_WANTS_HEADER_LINE_P (w)
665 && *y >= top_y
666 && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
668 part = ON_HEADER_LINE;
669 goto header_vertical_border_check;
672 /* Outside any interesting column? */
673 if (*x < left_x || *x > right_x)
674 return ON_NOTHING;
676 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
677 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
679 text_left = window_box_left (w, TEXT_AREA);
680 text_right = text_left + window_box_width (w, TEXT_AREA);
682 if (FRAME_WINDOW_P (f))
684 if (!w->pseudo_window_p
685 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
686 && !WINDOW_RIGHTMOST_P (w)
687 && (abs (*x - right_x) < grabbable_width))
688 return ON_VERTICAL_BORDER;
690 else
692 /* Need to say "*x > right_x" rather than >=, since on character
693 terminals, the vertical line's x coordinate is right_x. */
694 if (!w->pseudo_window_p
695 && !WINDOW_RIGHTMOST_P (w)
696 && *x > right_x - ux)
698 /* On the border on the right side of the window? Assume that
699 this area begins at RIGHT_X minus a canonical char width. */
700 return ON_VERTICAL_BORDER;
704 if (*x < text_left)
706 if (lmargin_width > 0
707 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
708 ? (*x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
709 : (*x < left_x + lmargin_width)))
711 *x -= x0;
712 if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
713 *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
714 *y -= top_y;
715 return ON_LEFT_MARGIN;
718 /* Convert X and Y to window-relative pixel coordinates. */
719 *x -= left_x;
720 *y -= top_y;
721 return ON_LEFT_FRINGE;
724 if (*x >= text_right)
726 if (rmargin_width > 0
727 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
728 ? (*x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
729 : (*x >= right_x - rmargin_width)))
731 *x -= right_x;
732 if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
733 *x -= WINDOW_RIGHT_FRINGE_WIDTH (w);
734 *y -= top_y;
735 return ON_RIGHT_MARGIN;
738 /* Convert X and Y to window-relative pixel coordinates. */
739 *x -= left_x + WINDOW_LEFT_FRINGE_WIDTH (w);
740 *y -= top_y;
741 return ON_RIGHT_FRINGE;
744 /* Everything special ruled out - must be on text area */
745 *x -= left_x + WINDOW_LEFT_FRINGE_WIDTH (w);
746 *y -= top_y;
747 return ON_TEXT;
751 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
752 Scoordinates_in_window_p, 2, 2, 0,
753 doc: /* Return non-nil if COORDINATES are in WINDOW.
754 COORDINATES is a cons of the form (X . Y), X and Y being distances
755 measured in characters from the upper-left corner of the frame.
756 \(0 . 0) denotes the character in the upper left corner of the
757 frame.
758 If COORDINATES are in the text portion of WINDOW,
759 the coordinates relative to the window are returned.
760 If they are in the mode line of WINDOW, `mode-line' is returned.
761 If they are in the top mode line of WINDOW, `header-line' is returned.
762 If they are in the left fringe of WINDOW, `left-fringe' is returned.
763 If they are in the right fringe of WINDOW, `right-fringe' is returned.
764 If they are on the border between WINDOW and its right sibling,
765 `vertical-line' is returned.
766 If they are in the windows's left or right marginal areas, `left-margin'\n\
767 or `right-margin' is returned. */)
768 (coordinates, window)
769 register Lisp_Object coordinates, window;
771 struct window *w;
772 struct frame *f;
773 int x, y;
774 Lisp_Object lx, ly;
776 CHECK_LIVE_WINDOW (window);
777 w = XWINDOW (window);
778 f = XFRAME (w->frame);
779 CHECK_CONS (coordinates);
780 lx = Fcar (coordinates);
781 ly = Fcdr (coordinates);
782 CHECK_NUMBER_OR_FLOAT (lx);
783 CHECK_NUMBER_OR_FLOAT (ly);
784 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx);
785 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly);
787 switch (coordinates_in_window (w, &x, &y))
789 case ON_NOTHING:
790 return Qnil;
792 case ON_TEXT:
793 /* X and Y are now window relative pixel coordinates. Convert
794 them to canonical char units before returning them. */
795 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
796 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
798 case ON_MODE_LINE:
799 return Qmode_line;
801 case ON_VERTICAL_BORDER:
802 return Qvertical_line;
804 case ON_HEADER_LINE:
805 return Qheader_line;
807 case ON_LEFT_FRINGE:
808 return Qleft_fringe;
810 case ON_RIGHT_FRINGE:
811 return Qright_fringe;
813 case ON_LEFT_MARGIN:
814 return Qleft_margin;
816 case ON_RIGHT_MARGIN:
817 return Qright_margin;
819 default:
820 abort ();
825 /* Callback for foreach_window, used in window_from_coordinates.
826 Check if window W contains coordinates specified by USER_DATA which
827 is actually a pointer to a struct check_window_data CW.
829 Check if window W contains coordinates *CW->x and *CW->y. If it
830 does, return W in *CW->window, as Lisp_Object, and return in
831 *CW->part the part of the window under coordinates *X,*Y. Return
832 zero from this function to stop iterating over windows. */
834 struct check_window_data
836 Lisp_Object *window;
837 int *x, *y;
838 enum window_part *part;
841 static int
842 check_window_containing (w, user_data)
843 struct window *w;
844 void *user_data;
846 struct check_window_data *cw = (struct check_window_data *) user_data;
847 enum window_part found;
848 int continue_p = 1;
850 found = coordinates_in_window (w, cw->x, cw->y);
851 if (found != ON_NOTHING)
853 *cw->part = found;
854 XSETWINDOW (*cw->window, w);
855 continue_p = 0;
858 return continue_p;
862 /* Find the window containing frame-relative pixel position X/Y and
863 return it as a Lisp_Object.
865 If X, Y is on one of the window's special `window_part' elements,
866 set *PART to the id of that element, and return X and Y converted
867 to window relative coordinates in WX and WY.
869 If there is no window under X, Y return nil and leave *PART
870 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
872 This function was previously implemented with a loop cycling over
873 windows with Fnext_window, and starting with the frame's selected
874 window. It turned out that this doesn't work with an
875 implementation of next_window using Vwindow_list, because
876 FRAME_SELECTED_WINDOW (F) is not always contained in the window
877 tree of F when this function is called asynchronously from
878 note_mouse_highlight. The original loop didn't terminate in this
879 case. */
881 Lisp_Object
882 window_from_coordinates (f, x, y, part, wx, wy, tool_bar_p)
883 struct frame *f;
884 int x, y;
885 enum window_part *part;
886 int *wx, *wy;
887 int tool_bar_p;
889 Lisp_Object window;
890 struct check_window_data cw;
891 enum window_part dummy;
893 if (part == 0)
894 part = &dummy;
896 window = Qnil;
897 cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
898 foreach_window (f, check_window_containing, &cw);
900 /* If not found above, see if it's in the tool bar window, if a tool
901 bar exists. */
902 if (NILP (window)
903 && tool_bar_p
904 && WINDOWP (f->tool_bar_window)
905 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
906 && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
907 != ON_NOTHING))
909 *part = ON_TEXT;
910 window = f->tool_bar_window;
913 if (wx) *wx = x;
914 if (wy) *wy = y;
916 return window;
919 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
920 doc: /* Return window containing coordinates X and Y on FRAME.
921 If omitted, FRAME defaults to the currently selected frame.
922 The top left corner of the frame is considered to be row 0,
923 column 0. */)
924 (x, y, frame)
925 Lisp_Object x, y, frame;
927 struct frame *f;
929 if (NILP (frame))
930 frame = selected_frame;
931 CHECK_LIVE_FRAME (frame);
932 f = XFRAME (frame);
934 /* Check that arguments are integers or floats. */
935 CHECK_NUMBER_OR_FLOAT (x);
936 CHECK_NUMBER_OR_FLOAT (y);
938 return window_from_coordinates (f,
939 FRAME_PIXEL_X_FROM_CANON_X (f, x),
940 FRAME_PIXEL_Y_FROM_CANON_Y (f, y),
941 0, 0, 0, 0);
944 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
945 doc: /* Return current value of point in WINDOW.
946 For a nonselected window, this is the value point would have
947 if that window were selected.
949 Note that, when WINDOW is the selected window and its buffer
950 is also currently selected, the value returned is the same as (point).
951 It would be more strictly correct to return the `top-level' value
952 of point, outside of any save-excursion forms.
953 But that is hard to define. */)
954 (window)
955 Lisp_Object window;
957 register struct window *w = decode_window (window);
959 if (w == XWINDOW (selected_window)
960 && current_buffer == XBUFFER (w->buffer))
961 return Fpoint ();
962 return Fmarker_position (w->pointm);
965 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
966 doc: /* Return position at which display currently starts in WINDOW.
967 This is updated by redisplay or by calling `set-window-start'. */)
968 (window)
969 Lisp_Object window;
971 return Fmarker_position (decode_window (window)->start);
974 /* This is text temporarily removed from the doc string below.
976 This function returns nil if the position is not currently known.
977 That happens when redisplay is preempted and doesn't finish.
978 If in that case you want to compute where the end of the window would
979 have been if redisplay had finished, do this:
980 (save-excursion
981 (goto-char (window-start window))
982 (vertical-motion (1- (window-height window)) window)
983 (point))") */
985 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
986 doc: /* Return position at which display currently ends in WINDOW.
987 This is updated by redisplay, when it runs to completion.
988 Simply changing the buffer text or setting `window-start'
989 does not update this value.
990 If UPDATE is non-nil, compute the up-to-date position
991 if it isn't already recorded. */)
992 (window, update)
993 Lisp_Object window, update;
995 Lisp_Object value;
996 struct window *w = decode_window (window);
997 Lisp_Object buf;
999 buf = w->buffer;
1000 CHECK_BUFFER (buf);
1002 #if 0 /* This change broke some things. We should make it later. */
1003 /* If we don't know the end position, return nil.
1004 The user can compute it with vertical-motion if he wants to.
1005 It would be nicer to do it automatically,
1006 but that's so slow that it would probably bother people. */
1007 if (NILP (w->window_end_valid))
1008 return Qnil;
1009 #endif
1011 if (! NILP (update)
1012 && ! (! NILP (w->window_end_valid)
1013 && XFASTINT (w->last_modified) >= MODIFF))
1015 struct text_pos startp;
1016 struct it it;
1017 struct buffer *old_buffer = NULL, *b = XBUFFER (buf);
1019 /* In case W->start is out of the range, use something
1020 reasonable. This situation occurred when loading a file with
1021 `-l' containing a call to `rmail' with subsequent other
1022 commands. At the end, W->start happened to be BEG, while
1023 rmail had already narrowed the buffer. */
1024 if (XMARKER (w->start)->charpos < BEGV)
1025 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1026 else if (XMARKER (w->start)->charpos > ZV)
1027 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1028 else
1029 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1031 /* Cannot use Fvertical_motion because that function doesn't
1032 cope with variable-height lines. */
1033 if (b != current_buffer)
1035 old_buffer = current_buffer;
1036 set_buffer_internal (b);
1039 start_display (&it, w, startp);
1040 move_it_vertically (&it, window_box_height (w));
1041 if (it.current_y < it.last_visible_y)
1042 move_it_past_eol (&it);
1043 value = make_number (IT_CHARPOS (it));
1045 if (old_buffer)
1046 set_buffer_internal (old_buffer);
1048 else
1049 XSETINT (value, BUF_Z (XBUFFER (buf)) - XFASTINT (w->window_end_pos));
1051 return value;
1054 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1055 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer. */)
1056 (window, pos)
1057 Lisp_Object window, pos;
1059 register struct window *w = decode_window (window);
1061 CHECK_NUMBER_COERCE_MARKER (pos);
1062 if (w == XWINDOW (selected_window)
1063 && XBUFFER (w->buffer) == current_buffer)
1064 Fgoto_char (pos);
1065 else
1066 set_marker_restricted (w->pointm, pos, w->buffer);
1068 /* We have to make sure that redisplay updates the window to show
1069 the new value of point. */
1070 if (!EQ (window, selected_window))
1071 ++windows_or_buffers_changed;
1073 return pos;
1076 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1077 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1078 Optional third arg NOFORCE non-nil inhibits next redisplay
1079 from overriding motion of point in order to display at this exact start. */)
1080 (window, pos, noforce)
1081 Lisp_Object window, pos, noforce;
1083 register struct window *w = decode_window (window);
1085 CHECK_NUMBER_COERCE_MARKER (pos);
1086 set_marker_restricted (w->start, pos, w->buffer);
1087 /* this is not right, but much easier than doing what is right. */
1088 w->start_at_line_beg = Qnil;
1089 if (NILP (noforce))
1090 w->force_start = Qt;
1091 w->update_mode_line = Qt;
1092 XSETFASTINT (w->last_modified, 0);
1093 XSETFASTINT (w->last_overlay_modified, 0);
1094 if (!EQ (window, selected_window))
1095 windows_or_buffers_changed++;
1097 return pos;
1100 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1101 1, 1, 0,
1102 doc: /* Return WINDOW's dedicated object, usually t or nil.
1103 See also `set-window-dedicated-p'. */)
1104 (window)
1105 Lisp_Object window;
1107 return decode_window (window)->dedicated;
1110 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1111 Sset_window_dedicated_p, 2, 2, 0,
1112 doc: /* Control whether WINDOW is dedicated to the buffer it displays.
1113 If it is dedicated, Emacs will not automatically change
1114 which buffer appears in it.
1115 The second argument is the new value for the dedication flag;
1116 non-nil means yes. */)
1117 (window, arg)
1118 Lisp_Object window, arg;
1120 register struct window *w = decode_window (window);
1122 w->dedicated = arg;
1124 return w->dedicated;
1127 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1128 0, 1, 0,
1129 doc: /* Return the display-table that WINDOW is using. */)
1130 (window)
1131 Lisp_Object window;
1133 return decode_window (window)->display_table;
1136 /* Get the display table for use on window W. This is either W's
1137 display table or W's buffer's display table. Ignore the specified
1138 tables if they are not valid; if no valid table is specified,
1139 return 0. */
1141 struct Lisp_Char_Table *
1142 window_display_table (w)
1143 struct window *w;
1145 struct Lisp_Char_Table *dp = NULL;
1147 if (DISP_TABLE_P (w->display_table))
1148 dp = XCHAR_TABLE (w->display_table);
1149 else if (BUFFERP (w->buffer))
1151 struct buffer *b = XBUFFER (w->buffer);
1153 if (DISP_TABLE_P (b->display_table))
1154 dp = XCHAR_TABLE (b->display_table);
1155 else if (DISP_TABLE_P (Vstandard_display_table))
1156 dp = XCHAR_TABLE (Vstandard_display_table);
1159 return dp;
1162 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1163 doc: /* Set WINDOW's display-table to TABLE. */)
1164 (window, table)
1165 register Lisp_Object window, table;
1167 register struct window *w;
1169 w = decode_window (window);
1170 w->display_table = table;
1171 return table;
1174 /* Record info on buffer window w is displaying
1175 when it is about to cease to display that buffer. */
1176 static void
1177 unshow_buffer (w)
1178 register struct window *w;
1180 Lisp_Object buf;
1181 struct buffer *b;
1183 buf = w->buffer;
1184 b = XBUFFER (buf);
1185 if (b != XMARKER (w->pointm)->buffer)
1186 abort ();
1188 #if 0
1189 if (w == XWINDOW (selected_window)
1190 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1191 /* Do this except when the selected window's buffer
1192 is being removed from some other window. */
1193 #endif
1194 /* last_window_start records the start position that this buffer
1195 had in the last window to be disconnected from it.
1196 Now that this statement is unconditional,
1197 it is possible for the buffer to be displayed in the
1198 selected window, while last_window_start reflects another
1199 window which was recently showing the same buffer.
1200 Some people might say that might be a good thing. Let's see. */
1201 b->last_window_start = marker_position (w->start);
1203 /* Point in the selected window's buffer
1204 is actually stored in that buffer, and the window's pointm isn't used.
1205 So don't clobber point in that buffer. */
1206 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1207 /* This line helps to fix Horsley's testbug.el bug. */
1208 && !(WINDOWP (b->last_selected_window)
1209 && w != XWINDOW (b->last_selected_window)
1210 && EQ (buf, XWINDOW (b->last_selected_window)->buffer)))
1211 temp_set_point_both (b,
1212 clip_to_bounds (BUF_BEGV (b),
1213 XMARKER (w->pointm)->charpos,
1214 BUF_ZV (b)),
1215 clip_to_bounds (BUF_BEGV_BYTE (b),
1216 marker_byte_position (w->pointm),
1217 BUF_ZV_BYTE (b)));
1219 if (WINDOWP (b->last_selected_window)
1220 && w == XWINDOW (b->last_selected_window))
1221 b->last_selected_window = Qnil;
1224 /* Put replacement into the window structure in place of old. */
1225 static void
1226 replace_window (old, replacement)
1227 Lisp_Object old, replacement;
1229 register Lisp_Object tem;
1230 register struct window *o = XWINDOW (old), *p = XWINDOW (replacement);
1232 /* If OLD is its frame's root_window, then replacement is the new
1233 root_window for that frame. */
1235 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1236 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
1238 p->left_col = o->left_col;
1239 p->top_line = o->top_line;
1240 p->total_cols = o->total_cols;
1241 p->total_lines = o->total_lines;
1242 p->desired_matrix = p->current_matrix = 0;
1243 p->vscroll = 0;
1244 bzero (&p->cursor, sizeof (p->cursor));
1245 bzero (&p->last_cursor, sizeof (p->last_cursor));
1246 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
1247 p->phys_cursor_type = -1;
1248 p->phys_cursor_width = -1;
1249 p->must_be_updated_p = 0;
1250 p->pseudo_window_p = 0;
1251 XSETFASTINT (p->window_end_vpos, 0);
1252 XSETFASTINT (p->window_end_pos, 0);
1253 p->window_end_valid = Qnil;
1254 p->frozen_window_start_p = 0;
1255 p->orig_top_line = p->orig_total_lines = Qnil;
1257 p->next = tem = o->next;
1258 if (!NILP (tem))
1259 XWINDOW (tem)->prev = replacement;
1261 p->prev = tem = o->prev;
1262 if (!NILP (tem))
1263 XWINDOW (tem)->next = replacement;
1265 p->parent = tem = o->parent;
1266 if (!NILP (tem))
1268 if (EQ (XWINDOW (tem)->vchild, old))
1269 XWINDOW (tem)->vchild = replacement;
1270 if (EQ (XWINDOW (tem)->hchild, old))
1271 XWINDOW (tem)->hchild = replacement;
1274 /*** Here, if replacement is a vertical combination
1275 and so is its new parent, we should make replacement's
1276 children be children of that parent instead. ***/
1279 DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
1280 doc: /* Remove WINDOW from the display. Default is selected window. */)
1281 (window)
1282 register Lisp_Object window;
1284 delete_window (window);
1286 if (! NILP (Vwindow_configuration_change_hook)
1287 && ! NILP (Vrun_hooks))
1288 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
1290 return Qnil;
1293 void
1294 delete_window (window)
1295 register Lisp_Object window;
1297 register Lisp_Object tem, parent, sib;
1298 register struct window *p;
1299 register struct window *par;
1300 struct frame *f;
1302 /* Because this function is called by other C code on non-leaf
1303 windows, the CHECK_LIVE_WINDOW macro would choke inappropriately,
1304 so we can't decode_window here. */
1305 if (NILP (window))
1306 window = selected_window;
1307 else
1308 CHECK_WINDOW (window);
1309 p = XWINDOW (window);
1311 /* It's okay to delete an already-deleted window. */
1312 if (NILP (p->buffer)
1313 && NILP (p->hchild)
1314 && NILP (p->vchild))
1315 return;
1317 parent = p->parent;
1318 if (NILP (parent))
1319 error ("Attempt to delete minibuffer or sole ordinary window");
1320 par = XWINDOW (parent);
1322 windows_or_buffers_changed++;
1323 Vwindow_list = Qnil;
1324 f = XFRAME (WINDOW_FRAME (p));
1325 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
1327 /* Are we trying to delete any frame's selected window? */
1329 Lisp_Object swindow, pwindow;
1331 /* See if the frame's selected window is either WINDOW
1332 or any subwindow of it, by finding all that window's parents
1333 and comparing each one with WINDOW. */
1334 swindow = FRAME_SELECTED_WINDOW (f);
1336 while (1)
1338 pwindow = swindow;
1339 while (!NILP (pwindow))
1341 if (EQ (window, pwindow))
1342 break;
1343 pwindow = XWINDOW (pwindow)->parent;
1346 /* If the window being deleted is not a parent of SWINDOW,
1347 then SWINDOW is ok as the new selected window. */
1348 if (!EQ (window, pwindow))
1349 break;
1350 /* Otherwise, try another window for SWINDOW. */
1351 swindow = Fnext_window (swindow, Qlambda, Qnil);;
1353 /* If we get back to the frame's selected window,
1354 it means there was no acceptable alternative,
1355 so we cannot delete. */
1356 if (EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1357 error ("Cannot delete window");
1360 /* If we need to change SWINDOW, do it. */
1361 if (! EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1363 /* If we're about to delete the selected window on the
1364 selected frame, then we should use Fselect_window to select
1365 the new window. On the other hand, if we're about to
1366 delete the selected window on any other frame, we shouldn't do
1367 anything but set the frame's selected_window slot. */
1368 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
1369 Fselect_window (swindow, Qnil);
1370 else
1371 FRAME_SELECTED_WINDOW (f) = swindow;
1375 tem = p->buffer;
1376 /* tem is null for dummy parent windows
1377 (which have inferiors but not any contents themselves) */
1378 if (!NILP (tem))
1380 unshow_buffer (p);
1381 unchain_marker (XMARKER (p->pointm));
1382 unchain_marker (XMARKER (p->start));
1385 /* Free window glyph matrices. It is sure that they are allocated
1386 again when ADJUST_GLYPHS is called. Block input so that expose
1387 events and other events that access glyph matrices are not
1388 processed while we are changing them. */
1389 BLOCK_INPUT;
1390 free_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)));
1392 tem = p->next;
1393 if (!NILP (tem))
1394 XWINDOW (tem)->prev = p->prev;
1396 tem = p->prev;
1397 if (!NILP (tem))
1398 XWINDOW (tem)->next = p->next;
1400 if (EQ (window, par->hchild))
1401 par->hchild = p->next;
1402 if (EQ (window, par->vchild))
1403 par->vchild = p->next;
1405 /* Find one of our siblings to give our space to. */
1406 sib = p->prev;
1407 if (NILP (sib))
1409 /* If p gives its space to its next sibling, that sibling needs
1410 to have its top/left side pulled back to where p's is.
1411 set_window_{height,width} will re-position the sibling's
1412 children. */
1413 sib = p->next;
1414 XWINDOW (sib)->top_line = p->top_line;
1415 XWINDOW (sib)->left_col = p->left_col;
1418 /* Stretch that sibling. */
1419 if (!NILP (par->vchild))
1420 set_window_height (sib,
1421 XFASTINT (XWINDOW (sib)->total_lines) + XFASTINT (p->total_lines),
1423 if (!NILP (par->hchild))
1424 set_window_width (sib,
1425 XFASTINT (XWINDOW (sib)->total_cols) + XFASTINT (p->total_cols),
1428 /* If parent now has only one child,
1429 put the child into the parent's place. */
1430 tem = par->hchild;
1431 if (NILP (tem))
1432 tem = par->vchild;
1433 if (NILP (XWINDOW (tem)->next))
1434 replace_window (parent, tem);
1436 /* Since we may be deleting combination windows, we must make sure that
1437 not only p but all its children have been marked as deleted. */
1438 if (! NILP (p->hchild))
1439 delete_all_subwindows (XWINDOW (p->hchild));
1440 else if (! NILP (p->vchild))
1441 delete_all_subwindows (XWINDOW (p->vchild));
1443 /* Mark this window as deleted. */
1444 p->buffer = p->hchild = p->vchild = Qnil;
1446 /* Adjust glyph matrices. */
1447 adjust_glyphs (f);
1448 UNBLOCK_INPUT;
1453 /***********************************************************************
1454 Window List
1455 ***********************************************************************/
1457 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1458 pointer. This is a callback function for foreach_window, used in
1459 function window_list. */
1461 static int
1462 add_window_to_list (w, user_data)
1463 struct window *w;
1464 void *user_data;
1466 Lisp_Object *list = (Lisp_Object *) user_data;
1467 Lisp_Object window;
1468 XSETWINDOW (window, w);
1469 *list = Fcons (window, *list);
1470 return 1;
1474 /* Return a list of all windows, for use by next_window. If
1475 Vwindow_list is a list, return that list. Otherwise, build a new
1476 list, cache it in Vwindow_list, and return that. */
1478 static Lisp_Object
1479 window_list ()
1481 if (!CONSP (Vwindow_list))
1483 Lisp_Object tail;
1485 Vwindow_list = Qnil;
1486 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1488 Lisp_Object args[2];
1490 /* We are visiting windows in canonical order, and add
1491 new windows at the front of args[1], which means we
1492 have to reverse this list at the end. */
1493 args[1] = Qnil;
1494 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1495 args[0] = Vwindow_list;
1496 args[1] = Fnreverse (args[1]);
1497 Vwindow_list = Fnconc (2, args);
1501 return Vwindow_list;
1505 /* Value is non-zero if WINDOW satisfies the constraints given by
1506 OWINDOW, MINIBUF and ALL_FRAMES.
1508 MINIBUF t means WINDOW may be minibuffer windows.
1509 `lambda' means WINDOW may not be a minibuffer window.
1510 a window means a specific minibuffer window
1512 ALL_FRAMES t means search all frames,
1513 nil means search just current frame,
1514 `visible' means search just visible frames,
1515 0 means search visible and iconified frames,
1516 a window means search the frame that window belongs to,
1517 a frame means consider windows on that frame, only. */
1519 static int
1520 candidate_window_p (window, owindow, minibuf, all_frames)
1521 Lisp_Object window, owindow, minibuf, all_frames;
1523 struct window *w = XWINDOW (window);
1524 struct frame *f = XFRAME (w->frame);
1525 int candidate_p = 1;
1527 if (!BUFFERP (w->buffer))
1528 candidate_p = 0;
1529 else if (MINI_WINDOW_P (w)
1530 && (EQ (minibuf, Qlambda)
1531 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
1533 /* If MINIBUF is `lambda' don't consider any mini-windows.
1534 If it is a window, consider only that one. */
1535 candidate_p = 0;
1537 else if (EQ (all_frames, Qt))
1538 candidate_p = 1;
1539 else if (NILP (all_frames))
1541 xassert (WINDOWP (owindow));
1542 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
1544 else if (EQ (all_frames, Qvisible))
1546 FRAME_SAMPLE_VISIBILITY (f);
1547 candidate_p = FRAME_VISIBLE_P (f);
1549 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
1551 FRAME_SAMPLE_VISIBILITY (f);
1552 candidate_p = FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f);
1554 else if (WINDOWP (all_frames))
1555 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
1556 || EQ (XWINDOW (all_frames)->frame, w->frame)
1557 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
1558 else if (FRAMEP (all_frames))
1559 candidate_p = EQ (all_frames, w->frame);
1561 return candidate_p;
1565 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
1566 Fwindow_list. See there for the meaning of WINDOW, MINIBUF, and
1567 ALL_FRAMES. */
1569 static void
1570 decode_next_window_args (window, minibuf, all_frames)
1571 Lisp_Object *window, *minibuf, *all_frames;
1573 if (NILP (*window))
1574 *window = selected_window;
1575 else
1576 CHECK_LIVE_WINDOW (*window);
1578 /* MINIBUF nil may or may not include minibuffers. Decide if it
1579 does. */
1580 if (NILP (*minibuf))
1581 *minibuf = minibuf_level ? minibuf_window : Qlambda;
1582 else if (!EQ (*minibuf, Qt))
1583 *minibuf = Qlambda;
1585 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
1586 => count none of them, or a specific minibuffer window (the
1587 active one) to count. */
1589 /* ALL_FRAMES nil doesn't specify which frames to include. */
1590 if (NILP (*all_frames))
1591 *all_frames = (!EQ (*minibuf, Qlambda)
1592 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
1593 : Qnil);
1594 else if (EQ (*all_frames, Qvisible))
1596 else if (XFASTINT (*all_frames) == 0)
1598 else if (FRAMEP (*all_frames))
1600 else if (!EQ (*all_frames, Qt))
1601 *all_frames = Qnil;
1603 /* Now *ALL_FRAMES is t meaning search all frames, nil meaning
1604 search just current frame, `visible' meaning search just visible
1605 frames, 0 meaning search visible and iconified frames, or a
1606 window, meaning search the frame that window belongs to, or a
1607 frame, meaning consider windows on that frame, only. */
1611 /* Return the next or previous window of WINDOW in canonical ordering
1612 of windows. NEXT_P non-zero means return the next window. See the
1613 documentation string of next-window for the meaning of MINIBUF and
1614 ALL_FRAMES. */
1616 static Lisp_Object
1617 next_window (window, minibuf, all_frames, next_p)
1618 Lisp_Object window, minibuf, all_frames;
1619 int next_p;
1621 decode_next_window_args (&window, &minibuf, &all_frames);
1623 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
1624 return the first window on the frame. */
1625 if (FRAMEP (all_frames)
1626 && !EQ (all_frames, XWINDOW (window)->frame))
1627 return Fframe_first_window (all_frames);
1629 if (next_p)
1631 Lisp_Object list;
1633 /* Find WINDOW in the list of all windows. */
1634 list = Fmemq (window, window_list ());
1636 /* Scan forward from WINDOW to the end of the window list. */
1637 if (CONSP (list))
1638 for (list = XCDR (list); CONSP (list); list = XCDR (list))
1639 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1640 break;
1642 /* Scan from the start of the window list up to WINDOW. */
1643 if (!CONSP (list))
1644 for (list = Vwindow_list;
1645 CONSP (list) && !EQ (XCAR (list), window);
1646 list = XCDR (list))
1647 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1648 break;
1650 if (CONSP (list))
1651 window = XCAR (list);
1653 else
1655 Lisp_Object candidate, list;
1657 /* Scan through the list of windows for candidates. If there are
1658 candidate windows in front of WINDOW, the last one of these
1659 is the one we want. If there are candidates following WINDOW
1660 in the list, again the last one of these is the one we want. */
1661 candidate = Qnil;
1662 for (list = window_list (); CONSP (list); list = XCDR (list))
1664 if (EQ (XCAR (list), window))
1666 if (WINDOWP (candidate))
1667 break;
1669 else if (candidate_window_p (XCAR (list), window, minibuf,
1670 all_frames))
1671 candidate = XCAR (list);
1674 if (WINDOWP (candidate))
1675 window = candidate;
1678 return window;
1682 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
1683 doc: /* Return next window after WINDOW in canonical ordering of windows.
1684 If omitted, WINDOW defaults to the selected window.
1686 Optional second arg MINIBUF t means count the minibuffer window even
1687 if not active. MINIBUF nil or omitted means count the minibuffer iff
1688 it is active. MINIBUF neither t nor nil means not to count the
1689 minibuffer even if it is active.
1691 Several frames may share a single minibuffer; if the minibuffer
1692 counts, all windows on all frames that share that minibuffer count
1693 too. Therefore, `next-window' can be used to iterate through the
1694 set of windows even when the minibuffer is on another frame. If the
1695 minibuffer does not count, only windows from WINDOW's frame count.
1697 Optional third arg ALL-FRAMES t means include windows on all frames.
1698 ALL-FRAMES nil or omitted means cycle within the frames as specified
1699 above. ALL-FRAMES = `visible' means include windows on all visible frames.
1700 ALL-FRAMES = 0 means include windows on all visible and iconified frames.
1701 If ALL-FRAMES is a frame, restrict search to windows on that frame.
1702 Anything else means restrict to WINDOW's frame.
1704 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
1705 `next-window' to iterate through the entire cycle of acceptable
1706 windows, eventually ending up back at the window you started with.
1707 `previous-window' traverses the same cycle, in the reverse order. */)
1708 (window, minibuf, all_frames)
1709 Lisp_Object window, minibuf, all_frames;
1711 return next_window (window, minibuf, all_frames, 1);
1715 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
1716 doc: /* Return the window preceding WINDOW in canonical ordering of windows.
1717 If omitted, WINDOW defaults to the selected window.
1719 Optional second arg MINIBUF t means count the minibuffer window even
1720 if not active. MINIBUF nil or omitted means count the minibuffer iff
1721 it is active. MINIBUF neither t nor nil means not to count the
1722 minibuffer even if it is active.
1724 Several frames may share a single minibuffer; if the minibuffer
1725 counts, all windows on all frames that share that minibuffer count
1726 too. Therefore, `previous-window' can be used to iterate through
1727 the set of windows even when the minibuffer is on another frame. If
1728 the minibuffer does not count, only windows from WINDOW's frame count
1730 Optional third arg ALL-FRAMES t means include windows on all frames.
1731 ALL-FRAMES nil or omitted means cycle within the frames as specified
1732 above. ALL-FRAMES = `visible' means include windows on all visible frames.
1733 ALL-FRAMES = 0 means include windows on all visible and iconified frames.
1734 If ALL-FRAMES is a frame, restrict search to windows on that frame.
1735 Anything else means restrict to WINDOW's frame.
1737 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
1738 `previous-window' to iterate through the entire cycle of acceptable
1739 windows, eventually ending up back at the window you started with.
1740 `next-window' traverses the same cycle, in the reverse order. */)
1741 (window, minibuf, all_frames)
1742 Lisp_Object window, minibuf, all_frames;
1744 return next_window (window, minibuf, all_frames, 0);
1748 DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
1749 doc: /* Select the ARG'th different window on this frame.
1750 All windows on current frame are arranged in a cyclic order.
1751 This command selects the window ARG steps away in that order.
1752 A negative ARG moves in the opposite order. If the optional second
1753 argument ALL_FRAMES is non-nil, cycle through all frames. */)
1754 (arg, all_frames)
1755 Lisp_Object arg, all_frames;
1757 Lisp_Object window;
1758 int i;
1760 CHECK_NUMBER (arg);
1761 window = selected_window;
1763 for (i = XINT (arg); i > 0; --i)
1764 window = Fnext_window (window, Qnil, all_frames);
1765 for (; i < 0; ++i)
1766 window = Fprevious_window (window, Qnil, all_frames);
1768 Fselect_window (window, Qnil);
1769 return Qnil;
1773 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
1774 doc: /* Return a list of windows on FRAME, starting with WINDOW.
1775 FRAME nil or omitted means use the selected frame.
1776 WINDOW nil or omitted means use the selected window.
1777 MINIBUF t means include the minibuffer window, even if it isn't active.
1778 MINIBUF nil or omitted means include the minibuffer window only
1779 if it's active.
1780 MINIBUF neither nil nor t means never include the minibuffer window. */)
1781 (frame, minibuf, window)
1782 Lisp_Object frame, minibuf, window;
1784 if (NILP (window))
1785 window = selected_window;
1786 if (NILP (frame))
1787 frame = selected_frame;
1789 if (!EQ (frame, XWINDOW (window)->frame))
1790 error ("Window is on a different frame");
1792 return window_list_1 (window, minibuf, frame);
1796 /* Return a list of windows in canonical ordering. Arguments are like
1797 for `next-window'. */
1799 static Lisp_Object
1800 window_list_1 (window, minibuf, all_frames)
1801 Lisp_Object window, minibuf, all_frames;
1803 Lisp_Object tail, list;
1805 decode_next_window_args (&window, &minibuf, &all_frames);
1806 list = Qnil;
1808 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
1809 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
1810 list = Fcons (XCAR (tail), list);
1812 return Fnreverse (list);
1817 /* Look at all windows, performing an operation specified by TYPE
1818 with argument OBJ.
1819 If FRAMES is Qt, look at all frames;
1820 Qnil, look at just the selected frame;
1821 Qvisible, look at visible frames;
1822 a frame, just look at windows on that frame.
1823 If MINI is non-zero, perform the operation on minibuffer windows too. */
1825 enum window_loop
1827 WINDOW_LOOP_UNUSED,
1828 GET_BUFFER_WINDOW, /* Arg is buffer */
1829 GET_LRU_WINDOW, /* Arg is t for full-width windows only */
1830 DELETE_OTHER_WINDOWS, /* Arg is window not to delete */
1831 DELETE_BUFFER_WINDOWS, /* Arg is buffer */
1832 GET_LARGEST_WINDOW,
1833 UNSHOW_BUFFER, /* Arg is buffer */
1834 CHECK_ALL_WINDOWS
1837 static Lisp_Object
1838 window_loop (type, obj, mini, frames)
1839 enum window_loop type;
1840 Lisp_Object obj, frames;
1841 int mini;
1843 Lisp_Object window, windows, best_window, frame_arg;
1844 struct frame *f;
1845 struct gcpro gcpro1;
1847 /* If we're only looping through windows on a particular frame,
1848 frame points to that frame. If we're looping through windows
1849 on all frames, frame is 0. */
1850 if (FRAMEP (frames))
1851 f = XFRAME (frames);
1852 else if (NILP (frames))
1853 f = SELECTED_FRAME ();
1854 else
1855 f = NULL;
1857 if (f)
1858 frame_arg = Qlambda;
1859 else if (XFASTINT (frames) == 0)
1860 frame_arg = frames;
1861 else if (EQ (frames, Qvisible))
1862 frame_arg = frames;
1863 else
1864 frame_arg = Qt;
1866 /* frame_arg is Qlambda to stick to one frame,
1867 Qvisible to consider all visible frames,
1868 or Qt otherwise. */
1870 /* Pick a window to start with. */
1871 if (WINDOWP (obj))
1872 window = obj;
1873 else if (f)
1874 window = FRAME_SELECTED_WINDOW (f);
1875 else
1876 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
1878 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
1879 GCPRO1 (windows);
1880 best_window = Qnil;
1882 for (; CONSP (windows); windows = CDR (windows))
1884 struct window *w;
1886 window = XCAR (windows);
1887 w = XWINDOW (window);
1889 /* Note that we do not pay attention here to whether the frame
1890 is visible, since Fwindow_list skips non-visible frames if
1891 that is desired, under the control of frame_arg. */
1892 if (!MINI_WINDOW_P (w)
1893 /* For UNSHOW_BUFFER, we must always consider all windows. */
1894 || type == UNSHOW_BUFFER
1895 || (mini && minibuf_level > 0))
1896 switch (type)
1898 case GET_BUFFER_WINDOW:
1899 if (EQ (w->buffer, obj)
1900 /* Don't find any minibuffer window
1901 except the one that is currently in use. */
1902 && (MINI_WINDOW_P (w)
1903 ? EQ (window, minibuf_window)
1904 : 1))
1906 if (NILP (best_window))
1907 best_window = window;
1908 else if (EQ (window, selected_window))
1909 /* For compatibility with 20.x, prefer to return
1910 selected-window. */
1911 best_window = window;
1913 break;
1915 case GET_LRU_WINDOW:
1916 /* t as arg means consider only full-width windows */
1917 if (!NILP (obj) && !WINDOW_FULL_WIDTH_P (w))
1918 break;
1919 /* Ignore dedicated windows and minibuffers. */
1920 if (MINI_WINDOW_P (w) || EQ (w->dedicated, Qt))
1921 break;
1922 if (NILP (best_window)
1923 || (XFASTINT (XWINDOW (best_window)->use_time)
1924 > XFASTINT (w->use_time)))
1925 best_window = window;
1926 break;
1928 case DELETE_OTHER_WINDOWS:
1929 if (!EQ (window, obj))
1930 Fdelete_window (window);
1931 break;
1933 case DELETE_BUFFER_WINDOWS:
1934 if (EQ (w->buffer, obj))
1936 struct frame *f = XFRAME (WINDOW_FRAME (w));
1938 /* If this window is dedicated, and in a frame of its own,
1939 kill the frame. */
1940 if (EQ (window, FRAME_ROOT_WINDOW (f))
1941 && !NILP (w->dedicated)
1942 && other_visible_frames (f))
1944 /* Skip the other windows on this frame.
1945 There might be one, the minibuffer! */
1946 while (CONSP (XCDR (windows))
1947 && EQ (XWINDOW (XCAR (windows))->frame,
1948 XWINDOW (XCAR (XCDR (windows)))->frame))
1949 windows = XCDR (windows);
1951 /* Now we can safely delete the frame. */
1952 Fdelete_frame (w->frame, Qnil);
1954 else if (NILP (w->parent))
1956 /* If we're deleting the buffer displayed in the
1957 only window on the frame, find a new buffer to
1958 display there. */
1959 Lisp_Object buffer;
1960 buffer = Fother_buffer (obj, Qnil, w->frame);
1961 Fset_window_buffer (window, buffer, Qnil);
1962 if (EQ (window, selected_window))
1963 Fset_buffer (w->buffer);
1965 else
1966 Fdelete_window (window);
1968 break;
1970 case GET_LARGEST_WINDOW:
1972 /* Ignore dedicated windows and minibuffers. */
1973 if (MINI_WINDOW_P (w) || EQ (w->dedicated, Qt))
1974 break;
1976 if (NILP (best_window))
1977 best_window = window;
1978 else
1980 struct window *b = XWINDOW (best_window);
1981 if (XFASTINT (w->total_lines) * XFASTINT (w->total_cols)
1982 > XFASTINT (b->total_lines) * XFASTINT (b->total_cols))
1983 best_window = window;
1986 break;
1988 case UNSHOW_BUFFER:
1989 if (EQ (w->buffer, obj))
1991 Lisp_Object buffer;
1992 struct frame *f = XFRAME (w->frame);
1994 /* Find another buffer to show in this window. */
1995 buffer = Fother_buffer (obj, Qnil, w->frame);
1997 /* If this window is dedicated, and in a frame of its own,
1998 kill the frame. */
1999 if (EQ (window, FRAME_ROOT_WINDOW (f))
2000 && !NILP (w->dedicated)
2001 && other_visible_frames (f))
2003 /* Skip the other windows on this frame.
2004 There might be one, the minibuffer! */
2005 while (CONSP (XCDR (windows))
2006 && EQ (XWINDOW (XCAR (windows))->frame,
2007 XWINDOW (XCAR (XCDR (windows)))->frame))
2008 windows = XCDR (windows);
2010 /* Now we can safely delete the frame. */
2011 Fdelete_frame (w->frame, Qnil);
2013 else if (!NILP (w->dedicated) && !NILP (w->parent))
2015 Lisp_Object window;
2016 XSETWINDOW (window, w);
2017 /* If this window is dedicated and not the only window
2018 in its frame, then kill it. */
2019 Fdelete_window (window);
2021 else
2023 /* Otherwise show a different buffer in the window. */
2024 w->dedicated = Qnil;
2025 Fset_window_buffer (window, buffer, Qnil);
2026 if (EQ (window, selected_window))
2027 Fset_buffer (w->buffer);
2030 break;
2032 /* Check for a window that has a killed buffer. */
2033 case CHECK_ALL_WINDOWS:
2034 if (! NILP (w->buffer)
2035 && NILP (XBUFFER (w->buffer)->name))
2036 abort ();
2037 break;
2039 case WINDOW_LOOP_UNUSED:
2040 break;
2044 UNGCPRO;
2045 return best_window;
2048 /* Used for debugging. Abort if any window has a dead buffer. */
2050 void
2051 check_all_windows ()
2053 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2056 DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 1, 0,
2057 doc: /* Return the window least recently selected or used for display.
2058 If optional argument FRAME is `visible', search all visible frames.
2059 If FRAME is 0, search all visible and iconified frames.
2060 If FRAME is t, search all frames.
2061 If FRAME is nil, search only the selected frame.
2062 If FRAME is a frame, search only that frame. */)
2063 (frame)
2064 Lisp_Object frame;
2066 register Lisp_Object w;
2067 /* First try for a window that is full-width */
2068 w = window_loop (GET_LRU_WINDOW, Qt, 0, frame);
2069 if (!NILP (w) && !EQ (w, selected_window))
2070 return w;
2071 /* If none of them, try the rest */
2072 return window_loop (GET_LRU_WINDOW, Qnil, 0, frame);
2075 DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 1, 0,
2076 doc: /* Return the largest window in area.
2077 If optional argument FRAME is `visible', search all visible frames.
2078 If FRAME is 0, search all visible and iconified frames.
2079 If FRAME is t, search all frames.
2080 If FRAME is nil, search only the selected frame.
2081 If FRAME is a frame, search only that frame. */)
2082 (frame)
2083 Lisp_Object frame;
2085 return window_loop (GET_LARGEST_WINDOW, Qnil, 0,
2086 frame);
2089 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 1, 2, 0,
2090 doc: /* Return a window currently displaying BUFFER, or nil if none.
2091 If optional argument FRAME is `visible', search all visible frames.
2092 If optional argument FRAME is 0, search all visible and iconified frames.
2093 If FRAME is t, search all frames.
2094 If FRAME is nil, search only the selected frame.
2095 If FRAME is a frame, search only that frame. */)
2096 (buffer, frame)
2097 Lisp_Object buffer, frame;
2099 buffer = Fget_buffer (buffer);
2100 if (BUFFERP (buffer))
2101 return window_loop (GET_BUFFER_WINDOW, buffer, 1, frame);
2102 else
2103 return Qnil;
2106 DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
2107 0, 1, "",
2108 doc: /* Make WINDOW (or the selected window) fill its frame.
2109 Only the frame WINDOW is on is affected.
2110 This function tries to reduce display jumps
2111 by keeping the text previously visible in WINDOW
2112 in the same place on the frame. Doing this depends on
2113 the value of (window-start WINDOW), so if calling this function
2114 in a program gives strange scrolling, make sure the window-start
2115 value is reasonable when this function is called. */)
2116 (window)
2117 Lisp_Object window;
2119 struct window *w;
2120 int startpos;
2121 int top, new_top;
2123 if (NILP (window))
2124 window = selected_window;
2125 else
2126 CHECK_LIVE_WINDOW (window);
2127 w = XWINDOW (window);
2129 startpos = marker_position (w->start);
2130 top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2132 if (MINI_WINDOW_P (w) && top > 0)
2133 error ("Can't expand minibuffer to full frame");
2135 window_loop (DELETE_OTHER_WINDOWS, window, 0, WINDOW_FRAME (w));
2137 /* Try to minimize scrolling, by setting the window start to the point
2138 will cause the text at the old window start to be at the same place
2139 on the frame. But don't try to do this if the window start is
2140 outside the visible portion (as might happen when the display is
2141 not current, due to typeahead). */
2142 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2143 if (new_top != top
2144 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2145 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2147 struct position pos;
2148 struct buffer *obuf = current_buffer;
2150 Fset_buffer (w->buffer);
2151 /* This computation used to temporarily move point, but that can
2152 have unwanted side effects due to text properties. */
2153 pos = *vmotion (startpos, -top, w);
2155 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2156 w->window_end_valid = Qnil;
2157 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2158 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2159 : Qnil);
2160 /* We need to do this, so that the window-scroll-functions
2161 get called. */
2162 w->optional_new_start = Qt;
2164 set_buffer_internal (obuf);
2167 return Qnil;
2170 DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
2171 1, 2, "bDelete windows on (buffer): ",
2172 doc: /* Delete all windows showing BUFFER.
2173 Optional second argument FRAME controls which frames are affected.
2174 If optional argument FRAME is `visible', search all visible frames.
2175 If FRAME is 0, search all visible and iconified frames.
2176 If FRAME is nil, search all frames.
2177 If FRAME is t, search only the selected frame.
2178 If FRAME is a frame, search only that frame. */)
2179 (buffer, frame)
2180 Lisp_Object buffer, frame;
2182 /* FRAME uses t and nil to mean the opposite of what window_loop
2183 expects. */
2184 if (NILP (frame))
2185 frame = Qt;
2186 else if (EQ (frame, Qt))
2187 frame = Qnil;
2189 if (!NILP (buffer))
2191 buffer = Fget_buffer (buffer);
2192 CHECK_BUFFER (buffer);
2193 window_loop (DELETE_BUFFER_WINDOWS, buffer, 0, frame);
2196 return Qnil;
2199 DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows,
2200 Sreplace_buffer_in_windows,
2201 1, 1, "bReplace buffer in windows: ",
2202 doc: /* Replace BUFFER with some other buffer in all windows showing it. */)
2203 (buffer)
2204 Lisp_Object buffer;
2206 if (!NILP (buffer))
2208 buffer = Fget_buffer (buffer);
2209 CHECK_BUFFER (buffer);
2210 window_loop (UNSHOW_BUFFER, buffer, 0, Qt);
2212 return Qnil;
2215 /* Replace BUFFER with some other buffer in all windows
2216 of all frames, even those on other keyboards. */
2218 void
2219 replace_buffer_in_all_windows (buffer)
2220 Lisp_Object buffer;
2222 #ifdef MULTI_KBOARD
2223 Lisp_Object tail, frame;
2225 /* A single call to window_loop won't do the job
2226 because it only considers frames on the current keyboard.
2227 So loop manually over frames, and handle each one. */
2228 FOR_EACH_FRAME (tail, frame)
2229 window_loop (UNSHOW_BUFFER, buffer, 1, frame);
2230 #else
2231 window_loop (UNSHOW_BUFFER, buffer, 1, Qt);
2232 #endif
2235 /* Set the height of WINDOW and all its inferiors. */
2237 /* The smallest acceptable dimensions for a window. Anything smaller
2238 might crash Emacs. */
2240 #define MIN_SAFE_WINDOW_WIDTH (2)
2241 #define MIN_SAFE_WINDOW_HEIGHT (1)
2243 /* Make sure that window_min_height and window_min_width are
2244 not too small; if they are, set them to safe minima. */
2246 static void
2247 check_min_window_sizes ()
2249 /* Smaller values might permit a crash. */
2250 if (window_min_width < MIN_SAFE_WINDOW_WIDTH)
2251 window_min_width = MIN_SAFE_WINDOW_WIDTH;
2252 if (window_min_height < MIN_SAFE_WINDOW_HEIGHT)
2253 window_min_height = MIN_SAFE_WINDOW_HEIGHT;
2256 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2257 minimum allowable size. */
2259 void
2260 check_frame_size (frame, rows, cols)
2261 FRAME_PTR frame;
2262 int *rows, *cols;
2264 /* For height, we have to see:
2265 how many windows the frame has at minimum (one or two),
2266 and whether it has a menu bar or other special stuff at the top. */
2267 int min_height
2268 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
2269 ? MIN_SAFE_WINDOW_HEIGHT
2270 : 2 * MIN_SAFE_WINDOW_HEIGHT);
2272 if (FRAME_TOP_MARGIN (frame) > 0)
2273 min_height += FRAME_TOP_MARGIN (frame);
2275 if (*rows < min_height)
2276 *rows = min_height;
2277 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2278 *cols = MIN_SAFE_WINDOW_WIDTH;
2282 /* Value is non-zero if window W is fixed-size. WIDTH_P non-zero means
2283 check if W's width can be changed, otherwise check W's height.
2284 CHECK_SIBLINGS_P non-zero means check resizablity of WINDOW's
2285 siblings, too. If none of the siblings is resizable, WINDOW isn't
2286 either. */
2288 static int
2289 window_fixed_size_p (w, width_p, check_siblings_p)
2290 struct window *w;
2291 int width_p, check_siblings_p;
2293 int fixed_p;
2294 struct window *c;
2296 if (!NILP (w->hchild))
2298 c = XWINDOW (w->hchild);
2300 if (width_p)
2302 /* A horiz. combination is fixed-width if all of if its
2303 children are. */
2304 while (c && window_fixed_size_p (c, width_p, 0))
2305 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2306 fixed_p = c == NULL;
2308 else
2310 /* A horiz. combination is fixed-height if one of if its
2311 children is. */
2312 while (c && !window_fixed_size_p (c, width_p, 0))
2313 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2314 fixed_p = c != NULL;
2317 else if (!NILP (w->vchild))
2319 c = XWINDOW (w->vchild);
2321 if (width_p)
2323 /* A vert. combination is fixed-width if one of if its
2324 children is. */
2325 while (c && !window_fixed_size_p (c, width_p, 0))
2326 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2327 fixed_p = c != NULL;
2329 else
2331 /* A vert. combination is fixed-height if all of if its
2332 children are. */
2333 while (c && window_fixed_size_p (c, width_p, 0))
2334 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2335 fixed_p = c == NULL;
2338 else if (BUFFERP (w->buffer))
2340 if (w->height_fixed_p && !width_p)
2341 fixed_p = 1;
2342 else
2344 struct buffer *old = current_buffer;
2345 Lisp_Object val;
2347 current_buffer = XBUFFER (w->buffer);
2348 val = find_symbol_value (Qwindow_size_fixed);
2349 current_buffer = old;
2351 fixed_p = 0;
2352 if (!EQ (val, Qunbound))
2354 fixed_p = !NILP (val);
2356 if (fixed_p
2357 && ((EQ (val, Qheight) && width_p)
2358 || (EQ (val, Qwidth) && !width_p)))
2359 fixed_p = 0;
2363 /* Can't tell if this one is resizable without looking at
2364 siblings. If all siblings are fixed-size this one is too. */
2365 if (!fixed_p && check_siblings_p && WINDOWP (w->parent))
2367 Lisp_Object child;
2369 for (child = w->prev; !NILP (child); child = XWINDOW (child)->prev)
2370 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2371 break;
2373 if (NILP (child))
2374 for (child = w->next; !NILP (child); child = XWINDOW (child)->next)
2375 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2376 break;
2378 if (NILP (child))
2379 fixed_p = 1;
2382 else
2383 fixed_p = 1;
2385 return fixed_p;
2389 /* Return the minimum size of window W, not taking fixed-width windows
2390 into account. WIDTH_P non-zero means return the minimum width,
2391 otherwise return the minimum height. If W is a combination window,
2392 compute the minimum size from the minimum sizes of W's children. */
2394 static int
2395 window_min_size_1 (w, width_p)
2396 struct window *w;
2397 int width_p;
2399 struct window *c;
2400 int size;
2402 if (!NILP (w->hchild))
2404 c = XWINDOW (w->hchild);
2405 size = 0;
2407 if (width_p)
2409 /* The min width of a horizontal combination is
2410 the sum of the min widths of its children. */
2411 while (c)
2413 size += window_min_size_1 (c, width_p);
2414 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2417 else
2419 /* The min height a horizontal combination equals
2420 the maximum of all min height of its children. */
2421 while (c)
2423 int min_size = window_min_size_1 (c, width_p);
2424 size = max (min_size, size);
2425 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2429 else if (!NILP (w->vchild))
2431 c = XWINDOW (w->vchild);
2432 size = 0;
2434 if (width_p)
2436 /* The min width of a vertical combination is
2437 the maximum of the min widths of its children. */
2438 while (c)
2440 int min_size = window_min_size_1 (c, width_p);
2441 size = max (min_size, size);
2442 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2445 else
2447 /* The min height of a vertical combination equals
2448 the sum of the min height of its children. */
2449 while (c)
2451 size += window_min_size_1 (c, width_p);
2452 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2456 else
2458 if (width_p)
2459 size = window_min_width;
2460 else
2462 if (MINI_WINDOW_P (w)
2463 || (!WINDOW_WANTS_MODELINE_P (w)
2464 && !WINDOW_WANTS_HEADER_LINE_P (w)))
2465 size = 1;
2466 else
2467 size = window_min_height;
2471 return size;
2475 /* Return the minimum size of window W, taking fixed-size windows into
2476 account. WIDTH_P non-zero means return the minimum width,
2477 otherwise return the minimum height. IGNORE_FIXED_P non-zero means
2478 ignore if W is fixed-size. Set *FIXED to 1 if W is fixed-size
2479 unless FIXED is null. */
2481 static int
2482 window_min_size (w, width_p, ignore_fixed_p, fixed)
2483 struct window *w;
2484 int width_p, ignore_fixed_p, *fixed;
2486 int size, fixed_p;
2488 if (ignore_fixed_p)
2489 fixed_p = 0;
2490 else
2491 fixed_p = window_fixed_size_p (w, width_p, 1);
2493 if (fixed)
2494 *fixed = fixed_p;
2496 if (fixed_p)
2497 size = width_p ? XFASTINT (w->total_cols) : XFASTINT (w->total_lines);
2498 else
2499 size = window_min_size_1 (w, width_p);
2501 return size;
2505 /* Adjust the margins of window W if text area is too small.
2506 Return 1 if window width is ok after adjustment; 0 if window
2507 is still too narrow. */
2509 static int
2510 adjust_window_margins (w)
2511 struct window *w;
2513 int box_cols = (WINDOW_TOTAL_COLS (w)
2514 - WINDOW_FRINGE_COLS (w)
2515 - WINDOW_SCROLL_BAR_COLS (w));
2516 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
2517 + WINDOW_RIGHT_MARGIN_COLS (w));
2519 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
2520 return 1;
2522 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
2523 return 0;
2525 /* Window's text area is too narrow, but reducing the window
2526 margins will fix that. */
2527 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
2528 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
2530 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
2531 w->left_margin_cols = w->right_margin_cols
2532 = make_number (margin_cols/2);
2533 else
2534 w->right_margin_cols = make_number (margin_cols);
2536 else
2537 w->left_margin_cols = make_number (margin_cols);
2538 return 1;
2542 /* Set WINDOW's height or width to SIZE. WIDTH_P non-zero means set
2543 WINDOW's width. Resize WINDOW's children, if any, so that they
2544 keep their proportionate size relative to WINDOW. Propagate
2545 WINDOW's top or left edge position to children. Delete windows
2546 that become too small unless NODELETE_P is non-zero.
2548 If NODELETE_P is 2, that means we do delete windows that are
2549 too small, even if they were too small before! */
2551 static void
2552 size_window (window, size, width_p, nodelete_p)
2553 Lisp_Object window;
2554 int size, width_p, nodelete_p;
2556 struct window *w = XWINDOW (window);
2557 struct window *c;
2558 Lisp_Object child, *forward, *sideward;
2559 int old_size, min_size, safe_min_size;
2561 /* We test nodelete_p != 2 and nodelete_p != 1 below, so it
2562 seems like it's too soon to do this here. ++KFS. */
2563 if (nodelete_p == 2)
2564 nodelete_p = 0;
2566 check_min_window_sizes ();
2567 size = max (0, size);
2569 /* If the window has been "too small" at one point,
2570 don't delete it for being "too small" in the future.
2571 Preserve it as long as that is at all possible. */
2572 if (width_p)
2574 old_size = WINDOW_TOTAL_COLS (w);
2575 min_size = window_min_width;
2576 /* Ensure that there is room for the scroll bar and fringes!
2577 We may reduce display margins though. */
2578 safe_min_size = (MIN_SAFE_WINDOW_WIDTH
2579 + WINDOW_FRINGE_COLS (w)
2580 + WINDOW_SCROLL_BAR_COLS (w));
2582 else
2584 old_size = XINT (w->total_lines);
2585 min_size = window_min_height;
2586 safe_min_size = MIN_SAFE_WINDOW_HEIGHT;
2589 if (old_size < min_size && nodelete_p != 2)
2590 w->too_small_ok = Qt;
2592 /* Maybe delete WINDOW if it's too small. */
2593 if (nodelete_p != 1 && !NILP (w->parent))
2595 if (!MINI_WINDOW_P (w) && !NILP (w->too_small_ok))
2596 min_size = width_p ? MIN_SAFE_WINDOW_WIDTH : MIN_SAFE_WINDOW_HEIGHT;
2597 if (min_size < safe_min_size)
2598 min_size = safe_min_size;
2599 if (size < min_size)
2601 delete_window (window);
2602 return;
2606 /* Set redisplay hints. */
2607 w->last_modified = make_number (0);
2608 w->last_overlay_modified = make_number (0);
2609 windows_or_buffers_changed++;
2610 FRAME_WINDOW_SIZES_CHANGED (XFRAME (w->frame)) = 1;
2612 if (width_p)
2614 sideward = &w->vchild;
2615 forward = &w->hchild;
2616 w->total_cols = make_number (size);
2617 adjust_window_margins (w);
2619 else
2621 sideward = &w->hchild;
2622 forward = &w->vchild;
2623 w->total_lines = make_number (size);
2624 w->orig_total_lines = Qnil;
2627 if (!NILP (*sideward))
2629 for (child = *sideward; !NILP (child); child = c->next)
2631 c = XWINDOW (child);
2632 if (width_p)
2633 c->left_col = w->left_col;
2634 else
2635 c->top_line = w->top_line;
2636 size_window (child, size, width_p, nodelete_p);
2639 else if (!NILP (*forward))
2641 int fixed_size, each, extra, n;
2642 int resize_fixed_p, nfixed;
2643 int last_pos, first_pos, nchildren, total;
2645 /* Determine the fixed-size portion of the this window, and the
2646 number of child windows. */
2647 fixed_size = nchildren = nfixed = total = 0;
2648 for (child = *forward; !NILP (child); child = c->next, ++nchildren)
2650 int child_size;
2652 c = XWINDOW (child);
2653 child_size = width_p ? XINT (c->total_cols) : XINT (c->total_lines);
2654 total += child_size;
2656 if (window_fixed_size_p (c, width_p, 0))
2658 fixed_size += child_size;
2659 ++nfixed;
2663 /* If the new size is smaller than fixed_size, or if there
2664 aren't any resizable windows, allow resizing fixed-size
2665 windows. */
2666 resize_fixed_p = nfixed == nchildren || size < fixed_size;
2668 /* Compute how many lines/columns to add to each child. The
2669 value of extra takes care of rounding errors. */
2670 n = resize_fixed_p ? nchildren : nchildren - nfixed;
2671 each = (size - total) / n;
2672 extra = (size - total) - n * each;
2674 /* Compute new children heights and edge positions. */
2675 first_pos = width_p ? XINT (w->left_col) : XINT (w->top_line);
2676 last_pos = first_pos;
2677 for (child = *forward; !NILP (child); child = c->next)
2679 int new_size, old_size;
2681 c = XWINDOW (child);
2682 old_size = width_p ? XFASTINT (c->total_cols) : XFASTINT (c->total_lines);
2683 new_size = old_size;
2685 /* The top or left edge position of this child equals the
2686 bottom or right edge of its predecessor. */
2687 if (width_p)
2688 c->left_col = make_number (last_pos);
2689 else
2690 c->top_line = make_number (last_pos);
2692 /* If this child can be resized, do it. */
2693 if (resize_fixed_p || !window_fixed_size_p (c, width_p, 0))
2695 new_size = old_size + each + extra;
2696 extra = 0;
2699 /* Set new height. Note that size_window also propagates
2700 edge positions to children, so it's not a no-op if we
2701 didn't change the child's size. */
2702 size_window (child, new_size, width_p, 1);
2704 /* Remember the bottom/right edge position of this child; it
2705 will be used to set the top/left edge of the next child. */
2706 last_pos += new_size;
2709 /* We should have covered the parent exactly with child windows. */
2710 xassert (size == last_pos - first_pos);
2712 /* Now delete any children that became too small. */
2713 if (!nodelete_p)
2714 for (child = *forward; !NILP (child); child = c->next)
2716 int child_size;
2717 c = XWINDOW (child);
2718 child_size = width_p ? XINT (c->total_cols) : XINT (c->total_lines);
2719 size_window (child, child_size, width_p, 2);
2724 /* Set WINDOW's height to HEIGHT, and recursively change the height of
2725 WINDOW's children. NODELETE non-zero means don't delete windows
2726 that become too small in the process. (The caller should check
2727 later and do so if appropriate.) */
2729 void
2730 set_window_height (window, height, nodelete)
2731 Lisp_Object window;
2732 int height;
2733 int nodelete;
2735 size_window (window, height, 0, nodelete);
2739 /* Set WINDOW's width to WIDTH, and recursively change the width of
2740 WINDOW's children. NODELETE non-zero means don't delete windows
2741 that become too small in the process. (The caller should check
2742 later and do so if appropriate.) */
2744 void
2745 set_window_width (window, width, nodelete)
2746 Lisp_Object window;
2747 int width;
2748 int nodelete;
2750 size_window (window, width, 1, nodelete);
2753 /* Change window heights in windows rooted in WINDOW by N lines. */
2755 void
2756 change_window_heights (window, n)
2757 Lisp_Object window;
2758 int n;
2760 struct window *w = XWINDOW (window);
2762 XSETFASTINT (w->top_line, XFASTINT (w->top_line) + n);
2763 XSETFASTINT (w->total_lines, XFASTINT (w->total_lines) - n);
2765 if (INTEGERP (w->orig_top_line))
2766 XSETFASTINT (w->orig_top_line, XFASTINT (w->orig_top_line) + n);
2767 if (INTEGERP (w->orig_total_lines))
2768 XSETFASTINT (w->orig_total_lines, XFASTINT (w->orig_total_lines) - n);
2770 /* Handle just the top child in a vertical split. */
2771 if (!NILP (w->vchild))
2772 change_window_heights (w->vchild, n);
2774 /* Adjust all children in a horizontal split. */
2775 for (window = w->hchild; !NILP (window); window = w->next)
2777 w = XWINDOW (window);
2778 change_window_heights (window, n);
2783 int window_select_count;
2785 Lisp_Object
2786 Fset_window_buffer_unwind (obuf)
2787 Lisp_Object obuf;
2789 Fset_buffer (obuf);
2790 return Qnil;
2793 EXFUN (Fset_window_fringes, 4);
2794 EXFUN (Fset_window_scroll_bars, 4);
2796 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
2797 means it's allowed to run hooks. See make_frame for a case where
2798 it's not allowed. KEEP_MARGINS_P non-zero means that the current
2799 margins, fringes, and scroll-bar settings of the window are not
2800 reset from the buffer's local settings. */
2802 void
2803 set_window_buffer (window, buffer, run_hooks_p, keep_margins_p)
2804 Lisp_Object window, buffer;
2805 int run_hooks_p, keep_margins_p;
2807 struct window *w = XWINDOW (window);
2808 struct buffer *b = XBUFFER (buffer);
2809 int count = SPECPDL_INDEX ();
2811 w->buffer = buffer;
2813 if (EQ (window, selected_window))
2814 b->last_selected_window = window;
2816 /* Update time stamps of buffer display. */
2817 if (INTEGERP (b->display_count))
2818 XSETINT (b->display_count, XINT (b->display_count) + 1);
2819 b->display_time = Fcurrent_time ();
2821 XSETFASTINT (w->window_end_pos, 0);
2822 XSETFASTINT (w->window_end_vpos, 0);
2823 bzero (&w->last_cursor, sizeof w->last_cursor);
2824 w->window_end_valid = Qnil;
2825 w->hscroll = w->min_hscroll = make_number (0);
2826 w->vscroll = 0;
2827 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
2828 set_marker_restricted (w->start,
2829 make_number (b->last_window_start),
2830 buffer);
2831 w->start_at_line_beg = Qnil;
2832 w->force_start = Qnil;
2833 XSETFASTINT (w->last_modified, 0);
2834 XSETFASTINT (w->last_overlay_modified, 0);
2835 windows_or_buffers_changed++;
2837 /* We must select BUFFER for running the window-scroll-functions.
2838 If WINDOW is selected, switch permanently.
2839 Otherwise, switch but go back to the ambient buffer afterward. */
2840 if (EQ (window, selected_window))
2841 Fset_buffer (buffer);
2842 /* We can't check ! NILP (Vwindow_scroll_functions) here
2843 because that might itself be a local variable. */
2844 else if (window_initialized)
2846 record_unwind_protect (Fset_window_buffer_unwind, Fcurrent_buffer ());
2847 Fset_buffer (buffer);
2850 if (!keep_margins_p)
2852 /* Set left and right marginal area width etc. from buffer. */
2854 /* This may call adjust_window_margins three times, so
2855 temporarily disable window margins. */
2856 w->left_margin_cols = w->right_margin_cols = Qnil;
2858 Fset_window_fringes (window,
2859 b->left_fringe_width, b->right_fringe_width,
2860 b->fringes_outside_margins);
2862 Fset_window_scroll_bars (window,
2863 b->scroll_bar_width,
2864 b->vertical_scroll_bar_type, Qnil);
2866 Fset_window_margins (window,
2867 b->left_margin_cols, b->right_margin_cols);
2870 if (run_hooks_p)
2872 if (! NILP (Vwindow_scroll_functions))
2873 run_hook_with_args_2 (Qwindow_scroll_functions, window,
2874 Fmarker_position (w->start));
2876 if (! NILP (Vwindow_configuration_change_hook)
2877 && ! NILP (Vrun_hooks))
2878 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
2881 unbind_to (count, Qnil);
2885 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
2886 doc: /* Make WINDOW display BUFFER as its contents.
2887 BUFFER can be a buffer or buffer name.
2888 Optional third arg KEEP_MARGINS non-nil means that WINDOW's current
2889 display margins, fringe widths, and scroll bar settings are maintained;
2890 the default is to reset these from BUFFER's local settings or the frame
2891 defaults. */)
2892 (window, buffer, keep_margins)
2893 register Lisp_Object window, buffer, keep_margins;
2895 register Lisp_Object tem;
2896 register struct window *w = decode_window (window);
2898 XSETWINDOW (window, w);
2899 buffer = Fget_buffer (buffer);
2900 CHECK_BUFFER (buffer);
2902 if (NILP (XBUFFER (buffer)->name))
2903 error ("Attempt to display deleted buffer");
2905 tem = w->buffer;
2906 if (NILP (tem))
2907 error ("Window is deleted");
2908 else if (! EQ (tem, Qt)) /* w->buffer is t when the window
2909 is first being set up. */
2911 if (!NILP (w->dedicated) && !EQ (tem, buffer))
2912 error ("Window is dedicated to `%s'",
2913 SDATA (XBUFFER (tem)->name));
2915 unshow_buffer (w);
2918 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
2919 return Qnil;
2922 /* Note that selected_window can be nil
2923 when this is called from Fset_window_configuration. */
2925 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
2926 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
2927 If WINDOW is not already selected, also make WINDOW's buffer current.
2928 Also make WINDOW the frame's selected window.
2929 Optional second arg NORECORD non-nil means
2930 do not put this buffer at the front of the list of recently selected ones.
2932 Note that the main editor command loop
2933 selects the buffer of the selected window before each command. */)
2934 (window, norecord)
2935 register Lisp_Object window, norecord;
2937 register struct window *w;
2938 register struct window *ow;
2939 struct frame *sf;
2941 CHECK_LIVE_WINDOW (window);
2943 w = XWINDOW (window);
2944 w->frozen_window_start_p = 0;
2946 XSETFASTINT (w->use_time, ++window_select_count);
2947 if (EQ (window, selected_window))
2948 return window;
2950 if (!NILP (selected_window))
2952 ow = XWINDOW (selected_window);
2953 if (! NILP (ow->buffer))
2954 set_marker_both (ow->pointm, ow->buffer,
2955 BUF_PT (XBUFFER (ow->buffer)),
2956 BUF_PT_BYTE (XBUFFER (ow->buffer)));
2959 selected_window = window;
2960 sf = SELECTED_FRAME ();
2961 if (XFRAME (WINDOW_FRAME (w)) != sf)
2963 XFRAME (WINDOW_FRAME (w))->selected_window = window;
2964 /* Use this rather than Fhandle_switch_frame
2965 so that FRAME_FOCUS_FRAME is moved appropriately as we
2966 move around in the state where a minibuffer in a separate
2967 frame is active. */
2968 Fselect_frame (WINDOW_FRAME (w), Qnil);
2970 else
2971 sf->selected_window = window;
2973 if (NILP (norecord))
2974 record_buffer (w->buffer);
2975 Fset_buffer (w->buffer);
2977 XBUFFER (w->buffer)->last_selected_window = window;
2979 /* Go to the point recorded in the window.
2980 This is important when the buffer is in more
2981 than one window. It also matters when
2982 redisplay_window has altered point after scrolling,
2983 because it makes the change only in the window. */
2985 register int new_point = marker_position (w->pointm);
2986 if (new_point < BEGV)
2987 SET_PT (BEGV);
2988 else if (new_point > ZV)
2989 SET_PT (ZV);
2990 else
2991 SET_PT (new_point);
2994 windows_or_buffers_changed++;
2995 return window;
2998 static Lisp_Object
2999 select_window_norecord (window)
3000 Lisp_Object window;
3002 return Fselect_window (window, Qt);
3005 /* Deiconify the frame containing the window WINDOW,
3006 unless it is the selected frame;
3007 then return WINDOW.
3009 The reason for the exception for the selected frame
3010 is that it seems better not to change the selected frames visibility
3011 merely because of displaying a different buffer in it.
3012 The deiconification is useful when a buffer gets shown in
3013 another frame that you were not using lately. */
3015 static Lisp_Object
3016 display_buffer_1 (window)
3017 Lisp_Object window;
3019 Lisp_Object frame = XWINDOW (window)->frame;
3020 FRAME_PTR f = XFRAME (frame);
3022 FRAME_SAMPLE_VISIBILITY (f);
3024 if (EQ (frame, selected_frame))
3025 ; /* Assume the selected frame is already visible enough. */
3026 else if (minibuf_level > 0
3027 && MINI_WINDOW_P (XWINDOW (selected_window))
3028 && WINDOW_LIVE_P (minibuf_selected_window)
3029 && EQ (frame, WINDOW_FRAME (XWINDOW (minibuf_selected_window))))
3030 ; /* Assume the frame from which we invoked the minibuffer is visible. */
3031 else
3033 if (FRAME_ICONIFIED_P (f))
3034 Fmake_frame_visible (frame);
3035 else if (FRAME_VISIBLE_P (f))
3036 Fraise_frame (frame);
3039 return window;
3042 DEFUN ("special-display-p", Fspecial_display_p, Sspecial_display_p, 1, 1, 0,
3043 doc: /* Returns non-nil if a buffer named BUFFER-NAME would be created specially.
3044 The value is actually t if the frame should be called with default frame
3045 parameters, and a list of frame parameters if they were specified.
3046 See `special-display-buffer-names', and `special-display-regexps'. */)
3047 (buffer_name)
3048 Lisp_Object buffer_name;
3050 Lisp_Object tem;
3052 CHECK_STRING (buffer_name);
3054 tem = Fmember (buffer_name, Vspecial_display_buffer_names);
3055 if (!NILP (tem))
3056 return Qt;
3058 tem = Fassoc (buffer_name, Vspecial_display_buffer_names);
3059 if (!NILP (tem))
3060 return XCDR (tem);
3062 for (tem = Vspecial_display_regexps; CONSP (tem); tem = XCDR (tem))
3064 Lisp_Object car = XCAR (tem);
3065 if (STRINGP (car)
3066 && fast_string_match (car, buffer_name) >= 0)
3067 return Qt;
3068 else if (CONSP (car)
3069 && STRINGP (XCAR (car))
3070 && fast_string_match (XCAR (car), buffer_name) >= 0)
3071 return XCDR (car);
3073 return Qnil;
3076 DEFUN ("same-window-p", Fsame_window_p, Ssame_window_p, 1, 1, 0,
3077 doc: /* Returns non-nil if a new buffer named BUFFER-NAME would use the same window.
3078 See `same-window-buffer-names' and `same-window-regexps'. */)
3079 (buffer_name)
3080 Lisp_Object buffer_name;
3082 Lisp_Object tem;
3084 CHECK_STRING (buffer_name);
3086 tem = Fmember (buffer_name, Vsame_window_buffer_names);
3087 if (!NILP (tem))
3088 return Qt;
3090 tem = Fassoc (buffer_name, Vsame_window_buffer_names);
3091 if (!NILP (tem))
3092 return Qt;
3094 for (tem = Vsame_window_regexps; CONSP (tem); tem = XCDR (tem))
3096 Lisp_Object car = XCAR (tem);
3097 if (STRINGP (car)
3098 && fast_string_match (car, buffer_name) >= 0)
3099 return Qt;
3100 else if (CONSP (car)
3101 && STRINGP (XCAR (car))
3102 && fast_string_match (XCAR (car), buffer_name) >= 0)
3103 return Qt;
3105 return Qnil;
3108 /* Use B so the default is (other-buffer). */
3109 DEFUN ("display-buffer", Fdisplay_buffer, Sdisplay_buffer, 1, 3,
3110 "BDisplay buffer: \nP",
3111 doc: /* Make BUFFER appear in some window but don't select it.
3112 BUFFER can be a buffer or a buffer name.
3113 If BUFFER is shown already in some window, just use that one,
3114 unless the window is the selected window and the optional second
3115 argument NOT-THIS-WINDOW is non-nil (interactively, with prefix arg).
3116 If `pop-up-frames' is non-nil, make a new frame if no window shows BUFFER.
3117 Returns the window displaying BUFFER.
3118 If `display-buffer-reuse-frames' is non-nil, and another frame is currently
3119 displaying BUFFER, then simply raise that frame.
3121 The variables `special-display-buffer-names', `special-display-regexps',
3122 `same-window-buffer-names', and `same-window-regexps' customize how certain
3123 buffer names are handled.
3125 If optional argument FRAME is `visible', search all visible frames.
3126 If FRAME is 0, search all visible and iconified frames.
3127 If FRAME is t, search all frames.
3128 If FRAME is a frame, search only that frame.
3129 If FRAME is nil, search only the selected frame
3130 (actually the last nonminibuffer frame),
3131 unless `pop-up-frames' or `display-buffer-reuse-frames' is non-nil,
3132 which means search visible and iconified frames.
3134 If `even-window-heights' is non-nil, window heights will be evened out
3135 if displaying the buffer causes two vertically adjacent windows to be
3136 displayed. */)
3137 (buffer, not_this_window, frame)
3138 register Lisp_Object buffer, not_this_window, frame;
3140 register Lisp_Object window, tem, swp;
3141 struct frame *f;
3143 swp = Qnil;
3144 buffer = Fget_buffer (buffer);
3145 CHECK_BUFFER (buffer);
3147 if (!NILP (Vdisplay_buffer_function))
3148 return call2 (Vdisplay_buffer_function, buffer, not_this_window);
3150 if (NILP (not_this_window)
3151 && XBUFFER (XWINDOW (selected_window)->buffer) == XBUFFER (buffer))
3152 return display_buffer_1 (selected_window);
3154 /* See if the user has specified this buffer should appear
3155 in the selected window. */
3156 if (NILP (not_this_window))
3158 swp = Fsame_window_p (XBUFFER (buffer)->name);
3159 if (!NILP (swp) && !no_switch_window (selected_window))
3161 Fswitch_to_buffer (buffer, Qnil);
3162 return display_buffer_1 (selected_window);
3166 /* If the user wants pop-up-frames or display-buffer-reuse-frames,
3167 look for a window showing BUFFER on any visible or iconified frame.
3168 Otherwise search only the current frame. */
3169 if (! NILP (frame))
3170 tem = frame;
3171 else if (pop_up_frames
3172 || display_buffer_reuse_frames
3173 || last_nonminibuf_frame == 0)
3174 XSETFASTINT (tem, 0);
3175 else
3176 XSETFRAME (tem, last_nonminibuf_frame);
3178 window = Fget_buffer_window (buffer, tem);
3179 if (!NILP (window)
3180 && (NILP (not_this_window) || !EQ (window, selected_window)))
3181 return display_buffer_1 (window);
3183 /* Certain buffer names get special handling. */
3184 if (!NILP (Vspecial_display_function) && NILP (swp))
3186 tem = Fspecial_display_p (XBUFFER (buffer)->name);
3187 if (EQ (tem, Qt))
3188 return call1 (Vspecial_display_function, buffer);
3189 if (CONSP (tem))
3190 return call2 (Vspecial_display_function, buffer, tem);
3193 /* If there are no frames open that have more than a minibuffer,
3194 we need to create a new frame. */
3195 if (pop_up_frames || last_nonminibuf_frame == 0)
3197 window = Fframe_selected_window (call0 (Vpop_up_frame_function));
3198 Fset_window_buffer (window, buffer, Qnil);
3199 return display_buffer_1 (window);
3202 f = SELECTED_FRAME ();
3203 if (pop_up_windows
3204 || FRAME_MINIBUF_ONLY_P (f)
3205 /* If the current frame is a special display frame,
3206 don't try to reuse its windows. */
3207 || !NILP (XWINDOW (FRAME_ROOT_WINDOW (f))->dedicated))
3209 Lisp_Object frames;
3211 frames = Qnil;
3212 if (FRAME_MINIBUF_ONLY_P (f))
3213 XSETFRAME (frames, last_nonminibuf_frame);
3214 /* Don't try to create a window if we would get an error. */
3215 if (split_height_threshold < window_min_height << 1)
3216 split_height_threshold = window_min_height << 1;
3218 /* Note that both Fget_largest_window and Fget_lru_window
3219 ignore minibuffers and dedicated windows.
3220 This means they can return nil. */
3222 /* If the frame we would try to split cannot be split,
3223 try other frames. */
3224 if (FRAME_NO_SPLIT_P (NILP (frames) ? f : last_nonminibuf_frame))
3226 /* Try visible frames first. */
3227 window = Fget_largest_window (Qvisible);
3228 /* If that didn't work, try iconified frames. */
3229 if (NILP (window))
3230 window = Fget_largest_window (make_number (0));
3231 if (NILP (window))
3232 window = Fget_largest_window (Qt);
3234 else
3235 window = Fget_largest_window (frames);
3237 /* If we got a tall enough full-width window that can be split,
3238 split it. */
3239 if (!NILP (window)
3240 && ! FRAME_NO_SPLIT_P (XFRAME (XWINDOW (window)->frame))
3241 && window_height (window) >= split_height_threshold
3242 && WINDOW_FULL_WIDTH_P (XWINDOW (window)))
3243 window = Fsplit_window (window, Qnil, Qnil);
3244 else
3246 Lisp_Object upper, lower, other;
3248 window = Fget_lru_window (frames);
3249 /* If the LRU window is selected, and big enough,
3250 and can be split, split it. */
3251 if (!NILP (window)
3252 && ! FRAME_NO_SPLIT_P (XFRAME (XWINDOW (window)->frame))
3253 && (EQ (window, selected_window)
3254 || EQ (XWINDOW (window)->parent, Qnil))
3255 && window_height (window) >= window_min_height << 1)
3256 window = Fsplit_window (window, Qnil, Qnil);
3257 /* If Fget_lru_window returned nil, try other approaches. */
3259 /* Try visible frames first. */
3260 if (NILP (window))
3261 window = Fget_buffer_window (buffer, Qvisible);
3262 if (NILP (window))
3263 window = Fget_largest_window (Qvisible);
3264 /* If that didn't work, try iconified frames. */
3265 if (NILP (window))
3266 window = Fget_buffer_window (buffer, make_number (0));
3267 if (NILP (window))
3268 window = Fget_largest_window (make_number (0));
3269 /* Try invisible frames. */
3270 if (NILP (window))
3271 window = Fget_buffer_window (buffer, Qt);
3272 if (NILP (window))
3273 window = Fget_largest_window (Qt);
3274 /* As a last resort, make a new frame. */
3275 if (NILP (window))
3276 window = Fframe_selected_window (call0 (Vpop_up_frame_function));
3277 /* If window appears above or below another,
3278 even out their heights. */
3279 other = upper = lower = Qnil;
3280 if (!NILP (XWINDOW (window)->prev))
3281 other = upper = XWINDOW (window)->prev, lower = window;
3282 if (!NILP (XWINDOW (window)->next))
3283 other = lower = XWINDOW (window)->next, upper = window;
3284 if (!NILP (other)
3285 && !NILP (Veven_window_heights)
3286 /* Check that OTHER and WINDOW are vertically arrayed. */
3287 && !EQ (XWINDOW (other)->top_line, XWINDOW (window)->top_line)
3288 && (XFASTINT (XWINDOW (other)->total_lines)
3289 > XFASTINT (XWINDOW (window)->total_lines)))
3291 int total = (XFASTINT (XWINDOW (other)->total_lines)
3292 + XFASTINT (XWINDOW (window)->total_lines));
3293 enlarge_window (upper,
3294 total / 2 - XFASTINT (XWINDOW (upper)->total_lines),
3295 0, 0);
3299 else
3300 window = Fget_lru_window (Qnil);
3302 Fset_window_buffer (window, buffer, Qnil);
3303 return display_buffer_1 (window);
3306 void
3307 temp_output_buffer_show (buf)
3308 register Lisp_Object buf;
3310 register struct buffer *old = current_buffer;
3311 register Lisp_Object window;
3312 register struct window *w;
3314 XBUFFER (buf)->directory = current_buffer->directory;
3316 Fset_buffer (buf);
3317 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3318 BEGV = BEG;
3319 ZV = Z;
3320 SET_PT (BEG);
3321 #if 0 /* rms: there should be no reason for this. */
3322 XBUFFER (buf)->prevent_redisplay_optimizations_p = 1;
3323 #endif
3324 set_buffer_internal (old);
3326 if (!EQ (Vtemp_buffer_show_function, Qnil))
3327 call1 (Vtemp_buffer_show_function, buf);
3328 else
3330 window = Fdisplay_buffer (buf, Qnil, Qnil);
3332 if (!EQ (XWINDOW (window)->frame, selected_frame))
3333 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3334 Vminibuf_scroll_window = window;
3335 w = XWINDOW (window);
3336 XSETFASTINT (w->hscroll, 0);
3337 XSETFASTINT (w->min_hscroll, 0);
3338 set_marker_restricted_both (w->start, buf, BEG, BEG);
3339 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3341 /* Run temp-buffer-show-hook, with the chosen window selected
3342 and its buffer current. */
3344 if (!NILP (Vrun_hooks)
3345 && !NILP (Fboundp (Qtemp_buffer_show_hook))
3346 && !NILP (Fsymbol_value (Qtemp_buffer_show_hook)))
3348 int count = SPECPDL_INDEX ();
3349 Lisp_Object prev_window, prev_buffer;
3350 prev_window = selected_window;
3351 XSETBUFFER (prev_buffer, old);
3353 /* Select the window that was chosen, for running the hook.
3354 Note: Both Fselect_window and select_window_norecord may
3355 set-buffer to the buffer displayed in the window,
3356 so we need to save the current buffer. --stef */
3357 record_unwind_protect (Fset_buffer, prev_buffer);
3358 record_unwind_protect (select_window_norecord, prev_window);
3359 Fselect_window (window, Qt);
3360 Fset_buffer (w->buffer);
3361 call1 (Vrun_hooks, Qtemp_buffer_show_hook);
3362 unbind_to (count, Qnil);
3367 static void
3368 make_dummy_parent (window)
3369 Lisp_Object window;
3371 Lisp_Object new;
3372 register struct window *o, *p;
3373 int i;
3375 o = XWINDOW (window);
3376 p = allocate_window ();
3377 for (i = 0; i < VECSIZE (struct window); ++i)
3378 ((struct Lisp_Vector *) p)->contents[i]
3379 = ((struct Lisp_Vector *)o)->contents[i];
3380 XSETWINDOW (new, p);
3382 XSETFASTINT (p->sequence_number, ++sequence_number);
3384 /* Put new into window structure in place of window */
3385 replace_window (window, new);
3387 o->next = Qnil;
3388 o->prev = Qnil;
3389 o->vchild = Qnil;
3390 o->hchild = Qnil;
3391 o->parent = new;
3393 p->start = Qnil;
3394 p->pointm = Qnil;
3395 p->buffer = Qnil;
3398 DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "",
3399 doc: /* Split WINDOW, putting SIZE lines in the first of the pair.
3400 WINDOW defaults to selected one and SIZE to half its size.
3401 If optional third arg HORFLAG is non-nil, split side by side
3402 and put SIZE columns in the first of the pair. In that case,
3403 SIZE includes that window's scroll bar, or the divider column to its right. */)
3404 (window, size, horflag)
3405 Lisp_Object window, size, horflag;
3407 register Lisp_Object new;
3408 register struct window *o, *p;
3409 FRAME_PTR fo;
3410 register int size_int;
3412 if (NILP (window))
3413 window = selected_window;
3414 else
3415 CHECK_LIVE_WINDOW (window);
3417 o = XWINDOW (window);
3418 fo = XFRAME (WINDOW_FRAME (o));
3420 if (NILP (size))
3422 if (!NILP (horflag))
3423 /* Calculate the size of the left-hand window, by dividing
3424 the usable space in columns by two.
3425 We round up, since the left-hand window may include
3426 a dividing line, while the right-hand may not. */
3427 size_int = (XFASTINT (o->total_cols) + 1) >> 1;
3428 else
3429 size_int = XFASTINT (o->total_lines) >> 1;
3431 else
3433 CHECK_NUMBER (size);
3434 size_int = XINT (size);
3437 if (MINI_WINDOW_P (o))
3438 error ("Attempt to split minibuffer window");
3439 else if (window_fixed_size_p (o, !NILP (horflag), 0))
3440 error ("Attempt to split fixed-size window");
3442 check_min_window_sizes ();
3444 if (NILP (horflag))
3446 if (size_int < window_min_height)
3447 error ("Window height %d too small (after splitting)", size_int);
3448 if (size_int + window_min_height > XFASTINT (o->total_lines))
3449 error ("Window height %d too small (after splitting)",
3450 XFASTINT (o->total_lines) - size_int);
3451 if (NILP (o->parent)
3452 || NILP (XWINDOW (o->parent)->vchild))
3454 make_dummy_parent (window);
3455 new = o->parent;
3456 XWINDOW (new)->vchild = window;
3459 else
3461 if (size_int < window_min_width)
3462 error ("Window width %d too small (after splitting)", size_int);
3464 if (size_int + window_min_width > XFASTINT (o->total_cols))
3465 error ("Window width %d too small (after splitting)",
3466 XFASTINT (o->total_cols) - size_int);
3467 if (NILP (o->parent)
3468 || NILP (XWINDOW (o->parent)->hchild))
3470 make_dummy_parent (window);
3471 new = o->parent;
3472 XWINDOW (new)->hchild = window;
3476 /* Now we know that window's parent is a vertical combination
3477 if we are dividing vertically, or a horizontal combination
3478 if we are making side-by-side windows */
3480 windows_or_buffers_changed++;
3481 FRAME_WINDOW_SIZES_CHANGED (fo) = 1;
3482 new = make_window ();
3483 p = XWINDOW (new);
3485 p->frame = o->frame;
3486 p->next = o->next;
3487 if (!NILP (p->next))
3488 XWINDOW (p->next)->prev = new;
3489 p->prev = window;
3490 o->next = new;
3491 p->parent = o->parent;
3492 p->buffer = Qt;
3493 p->window_end_valid = Qnil;
3494 bzero (&p->last_cursor, sizeof p->last_cursor);
3496 /* Duplicate special geometry settings. */
3498 p->left_margin_cols = o->left_margin_cols;
3499 p->right_margin_cols = o->right_margin_cols;
3500 p->left_fringe_width = o->left_fringe_width;
3501 p->right_fringe_width = o->right_fringe_width;
3502 p->fringes_outside_margins = o->fringes_outside_margins;
3503 p->scroll_bar_width = o->scroll_bar_width;
3504 p->vertical_scroll_bar_type = o->vertical_scroll_bar_type;
3506 /* Apportion the available frame space among the two new windows */
3508 if (!NILP (horflag))
3510 p->total_lines = o->total_lines;
3511 p->top_line = o->top_line;
3512 XSETFASTINT (p->total_cols, XFASTINT (o->total_cols) - size_int);
3513 XSETFASTINT (o->total_cols, size_int);
3514 XSETFASTINT (p->left_col, XFASTINT (o->left_col) + size_int);
3515 adjust_window_margins (p);
3516 adjust_window_margins (o);
3518 else
3520 p->left_col = o->left_col;
3521 p->total_cols = o->total_cols;
3522 XSETFASTINT (p->total_lines, XFASTINT (o->total_lines) - size_int);
3523 XSETFASTINT (o->total_lines, size_int);
3524 XSETFASTINT (p->top_line, XFASTINT (o->top_line) + size_int);
3527 /* Adjust glyph matrices. */
3528 adjust_glyphs (fo);
3530 Fset_window_buffer (new, o->buffer, Qt);
3531 return new;
3534 DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 3, "p",
3535 doc: /* Make current window ARG lines bigger.
3536 From program, optional second arg non-nil means grow sideways ARG columns.
3537 Interactively, if an argument is not given, make the window one line bigger.
3539 Optional third arg PRESERVE-BEFORE, if non-nil, means do not change the size
3540 of the siblings above or to the left of the selected window. Only
3541 siblings to the right or below are changed. */)
3542 (arg, side, preserve_before)
3543 register Lisp_Object arg, side, preserve_before;
3545 CHECK_NUMBER (arg);
3546 enlarge_window (selected_window, XINT (arg), !NILP (side),
3547 !NILP (preserve_before));
3549 if (! NILP (Vwindow_configuration_change_hook))
3550 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
3552 return Qnil;
3555 DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 3, "p",
3556 doc: /* Make current window ARG lines smaller.
3557 From program, optional second arg non-nil means shrink sideways arg columns.
3558 Interactively, if an argument is not given, make the window one line smaller.
3560 Optional third arg PRESERVE-BEFORE, if non-nil, means do not change the size
3561 of the siblings above or to the left of the selected window. Only
3562 siblings to the right or below are changed. */)
3563 (arg, side, preserve_before)
3564 register Lisp_Object arg, side, preserve_before;
3566 CHECK_NUMBER (arg);
3567 enlarge_window (selected_window, -XINT (arg), !NILP (side),
3568 !NILP (preserve_before));
3570 if (! NILP (Vwindow_configuration_change_hook))
3571 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
3573 return Qnil;
3577 window_height (window)
3578 Lisp_Object window;
3580 register struct window *p = XWINDOW (window);
3581 return WINDOW_TOTAL_LINES (p);
3585 window_width (window)
3586 Lisp_Object window;
3588 register struct window *p = XWINDOW (window);
3589 return WINDOW_TOTAL_COLS (p);
3593 #define CURBEG(w) \
3594 *(widthflag ? &(XWINDOW (w)->left_col) : &(XWINDOW (w)->top_line))
3596 #define CURSIZE(w) \
3597 *(widthflag ? &(XWINDOW (w)->total_cols) : &(XWINDOW (w)->total_lines))
3600 /* Enlarge WINDOW by DELTA. WIDTHFLAG non-zero means
3601 increase its width. Siblings of the selected window are resized to
3602 fulfill the size request. If they become too small in the process,
3603 they will be deleted.
3605 If PRESERVE_BEFORE is nonzero, that means don't alter
3606 the siblings to the left or above WINDOW. */
3608 static void
3609 enlarge_window (window, delta, widthflag, preserve_before)
3610 Lisp_Object window;
3611 int delta, widthflag, preserve_before;
3613 Lisp_Object parent, next, prev;
3614 struct window *p;
3615 Lisp_Object *sizep;
3616 int maximum;
3617 int (*sizefun) P_ ((Lisp_Object))
3618 = widthflag ? window_width : window_height;
3619 void (*setsizefun) P_ ((Lisp_Object, int, int))
3620 = (widthflag ? set_window_width : set_window_height);
3622 /* Check values of window_min_width and window_min_height for
3623 validity. */
3624 check_min_window_sizes ();
3626 /* Give up if this window cannot be resized. */
3627 if (window_fixed_size_p (XWINDOW (window), widthflag, 1))
3628 error ("Window is not resizable");
3630 /* Find the parent of the selected window. */
3631 while (1)
3633 p = XWINDOW (window);
3634 parent = p->parent;
3636 if (NILP (parent))
3638 if (widthflag)
3639 error ("No other window to side of this one");
3640 break;
3643 if (widthflag
3644 ? !NILP (XWINDOW (parent)->hchild)
3645 : !NILP (XWINDOW (parent)->vchild))
3646 break;
3648 window = parent;
3651 sizep = &CURSIZE (window);
3654 register int maxdelta;
3656 /* Compute the maximum size increment this window can have. */
3658 if (preserve_before)
3660 if (!NILP (parent))
3662 maxdelta = (*sizefun) (parent) - XINT (*sizep);
3663 /* Subtract size of siblings before, since we can't take that. */
3664 maxdelta -= XINT (CURBEG (window)) - XINT (CURBEG (parent));
3666 else
3667 maxdelta = (!NILP (p->next) ? ((*sizefun) (p->next)
3668 - window_min_size (XWINDOW (p->next),
3669 widthflag, 0, 0))
3670 : (delta = 0));
3672 else
3673 maxdelta = (!NILP (parent) ? (*sizefun) (parent) - XINT (*sizep)
3674 /* This is a main window followed by a minibuffer. */
3675 : !NILP (p->next) ? ((*sizefun) (p->next)
3676 - window_min_size (XWINDOW (p->next),
3677 widthflag, 0, 0))
3678 /* This is a minibuffer following a main window. */
3679 : !NILP (p->prev) ? ((*sizefun) (p->prev)
3680 - window_min_size (XWINDOW (p->prev),
3681 widthflag, 0, 0))
3682 /* This is a frame with only one window, a minibuffer-only
3683 or a minibufferless frame. */
3684 : (delta = 0));
3686 if (delta > maxdelta)
3687 /* This case traps trying to make the minibuffer
3688 the full frame, or make the only window aside from the
3689 minibuffer the full frame. */
3690 delta = maxdelta;
3693 if (XINT (*sizep) + delta < window_min_size (XWINDOW (window), widthflag, 0, 0))
3695 delete_window (window);
3696 return;
3699 if (delta == 0)
3700 return;
3702 /* Find the total we can get from other siblings without deleting them. */
3703 maximum = 0;
3704 for (next = p->next; ! NILP (next); next = XWINDOW (next)->next)
3705 maximum += (*sizefun) (next) - window_min_size (XWINDOW (next),
3706 widthflag, 0, 0);
3707 if (! preserve_before)
3708 for (prev = p->prev; ! NILP (prev); prev = XWINDOW (prev)->prev)
3709 maximum += (*sizefun) (prev) - window_min_size (XWINDOW (prev),
3710 widthflag, 0, 0);
3712 /* If we can get it all from them without deleting them, do so. */
3713 if (delta <= maximum)
3715 Lisp_Object first_unaffected;
3716 Lisp_Object first_affected;
3717 int fixed_p;
3719 next = p->next;
3720 prev = p->prev;
3721 first_affected = window;
3722 /* Look at one sibling at a time,
3723 moving away from this window in both directions alternately,
3724 and take as much as we can get without deleting that sibling. */
3725 while (delta != 0
3726 && (!NILP (next) || (!preserve_before && !NILP (prev))))
3728 if (! NILP (next))
3730 int this_one = ((*sizefun) (next)
3731 - window_min_size (XWINDOW (next),
3732 widthflag, 0, &fixed_p));
3733 if (!fixed_p)
3735 if (this_one > delta)
3736 this_one = delta;
3738 (*setsizefun) (next, (*sizefun) (next) - this_one, 0);
3739 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
3741 delta -= this_one;
3744 next = XWINDOW (next)->next;
3747 if (delta == 0)
3748 break;
3750 if (!preserve_before && ! NILP (prev))
3752 int this_one = ((*sizefun) (prev)
3753 - window_min_size (XWINDOW (prev),
3754 widthflag, 0, &fixed_p));
3755 if (!fixed_p)
3757 if (this_one > delta)
3758 this_one = delta;
3760 first_affected = prev;
3762 (*setsizefun) (prev, (*sizefun) (prev) - this_one, 0);
3763 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
3765 delta -= this_one;
3768 prev = XWINDOW (prev)->prev;
3772 xassert (delta == 0);
3774 /* Now recalculate the edge positions of all the windows affected,
3775 based on the new sizes. */
3776 first_unaffected = next;
3777 prev = first_affected;
3778 for (next = XWINDOW (prev)->next; ! EQ (next, first_unaffected);
3779 prev = next, next = XWINDOW (next)->next)
3781 XSETINT (CURBEG (next), XINT (CURBEG (prev)) + (*sizefun) (prev));
3782 /* This does not change size of NEXT,
3783 but it propagates the new top edge to its children */
3784 (*setsizefun) (next, (*sizefun) (next), 0);
3787 else
3789 register int delta1;
3790 register int opht = (*sizefun) (parent);
3792 if (opht <= XINT (*sizep) + delta)
3794 /* If trying to grow this window to or beyond size of the parent,
3795 just delete all the sibling windows. */
3796 Lisp_Object start, tem, next;
3798 start = XWINDOW (parent)->vchild;
3799 if (NILP (start))
3800 start = XWINDOW (parent)->hchild;
3802 /* Delete any siblings that come after WINDOW. */
3803 tem = XWINDOW (window)->next;
3804 while (! NILP (tem))
3806 next = XWINDOW (tem)->next;
3807 delete_window (tem);
3808 tem = next;
3811 /* Delete any siblings that come after WINDOW.
3812 Note that if START is not WINDOW, then WINDOW still
3813 Fhas siblings, so WINDOW has not yet replaced its parent. */
3814 tem = start;
3815 while (! EQ (tem, window))
3817 next = XWINDOW (tem)->next;
3818 delete_window (tem);
3819 tem = next;
3822 else
3824 /* Otherwise, make delta1 just right so that if we add
3825 delta1 lines to this window and to the parent, and then
3826 shrink the parent back to its original size, the new
3827 proportional size of this window will increase by delta.
3829 The function size_window will compute the new height h'
3830 of the window from delta1 as:
3832 e = delta1/n
3833 x = delta1 - delta1/n * n for the 1st resizable child
3834 h' = h + e + x
3836 where n is the number of children that can be resized.
3837 We can ignore x by choosing a delta1 that is a multiple of
3838 n. We want the height of this window to come out as
3840 h' = h + delta
3842 So, delta1 must be
3844 h + e = h + delta
3845 delta1/n = delta
3846 delta1 = n * delta.
3848 The number of children n equals the number of resizable
3849 children of this window + 1 because we know window itself
3850 is resizable (otherwise we would have signalled an error. */
3852 struct window *w = XWINDOW (window);
3853 Lisp_Object s;
3854 int n = 1;
3856 for (s = w->next; !NILP (s); s = XWINDOW (s)->next)
3857 if (!window_fixed_size_p (XWINDOW (s), widthflag, 0))
3858 ++n;
3859 for (s = w->prev; !NILP (s); s = XWINDOW (s)->prev)
3860 if (!window_fixed_size_p (XWINDOW (s), widthflag, 0))
3861 ++n;
3863 delta1 = n * delta;
3865 /* Add delta1 lines or columns to this window, and to the parent,
3866 keeping things consistent while not affecting siblings. */
3867 XSETINT (CURSIZE (parent), opht + delta1);
3868 (*setsizefun) (window, XINT (*sizep) + delta1, 0);
3870 /* Squeeze out delta1 lines or columns from our parent,
3871 shriking this window and siblings proportionately.
3872 This brings parent back to correct size.
3873 Delta1 was calculated so this makes this window the desired size,
3874 taking it all out of the siblings. */
3875 (*setsizefun) (parent, opht, 0);
3880 XSETFASTINT (p->last_modified, 0);
3881 XSETFASTINT (p->last_overlay_modified, 0);
3883 /* Adjust glyph matrices. */
3884 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
3887 #undef CURBEG
3888 #undef CURSIZE
3892 /***********************************************************************
3893 Resizing Mini-Windows
3894 ***********************************************************************/
3896 static void shrink_window_lowest_first P_ ((struct window *, int));
3898 enum save_restore_action
3900 CHECK_ORIG_SIZES,
3901 SAVE_ORIG_SIZES,
3902 RESTORE_ORIG_SIZES
3905 static int save_restore_orig_size P_ ((struct window *,
3906 enum save_restore_action));
3908 /* Shrink windows rooted in window W to HEIGHT. Take the space needed
3909 from lowest windows first. */
3911 static void
3912 shrink_window_lowest_first (w, height)
3913 struct window *w;
3914 int height;
3916 struct window *c;
3917 Lisp_Object child;
3918 int old_height;
3920 xassert (!MINI_WINDOW_P (w));
3922 /* Set redisplay hints. */
3923 XSETFASTINT (w->last_modified, 0);
3924 XSETFASTINT (w->last_overlay_modified, 0);
3925 windows_or_buffers_changed++;
3926 FRAME_WINDOW_SIZES_CHANGED (XFRAME (WINDOW_FRAME (w))) = 1;
3928 old_height = XFASTINT (w->total_lines);
3929 XSETFASTINT (w->total_lines, height);
3931 if (!NILP (w->hchild))
3933 for (child = w->hchild; !NILP (child); child = c->next)
3935 c = XWINDOW (child);
3936 c->top_line = w->top_line;
3937 shrink_window_lowest_first (c, height);
3940 else if (!NILP (w->vchild))
3942 Lisp_Object last_child;
3943 int delta = old_height - height;
3944 int last_top;
3946 last_child = Qnil;
3948 /* Find the last child. We are taking space from lowest windows
3949 first, so we iterate over children from the last child
3950 backwards. */
3951 for (child = w->vchild; !NILP (child); child = XWINDOW (child)->next)
3952 last_child = child;
3954 /* Assign new heights. We leave only MIN_SAFE_WINDOW_HEIGHT. */
3955 for (child = last_child; delta && !NILP (child); child = c->prev)
3957 int this_one;
3959 c = XWINDOW (child);
3960 this_one = XFASTINT (c->total_lines) - MIN_SAFE_WINDOW_HEIGHT;
3962 if (this_one > delta)
3963 this_one = delta;
3965 shrink_window_lowest_first (c, XFASTINT (c->total_lines) - this_one);
3966 delta -= this_one;
3969 /* Compute new positions. */
3970 last_top = XINT (w->top_line);
3971 for (child = w->vchild; !NILP (child); child = c->next)
3973 c = XWINDOW (child);
3974 c->top_line = make_number (last_top);
3975 shrink_window_lowest_first (c, XFASTINT (c->total_lines));
3976 last_top += XFASTINT (c->total_lines);
3982 /* Save, restore, or check positions and sizes in the window tree
3983 rooted at W. ACTION says what to do.
3985 If ACTION is CHECK_ORIG_SIZES, check if orig_top_line and
3986 orig_total_lines members are valid for all windows in the window
3987 tree. Value is non-zero if they are valid.
3989 If ACTION is SAVE_ORIG_SIZES, save members top and height in
3990 orig_top_line and orig_total_lines for all windows in the tree.
3992 If ACTION is RESTORE_ORIG_SIZES, restore top and height from values
3993 stored in orig_top_line and orig_total_lines for all windows. */
3995 static int
3996 save_restore_orig_size (w, action)
3997 struct window *w;
3998 enum save_restore_action action;
4000 int success_p = 1;
4002 while (w)
4004 if (!NILP (w->hchild))
4006 if (!save_restore_orig_size (XWINDOW (w->hchild), action))
4007 success_p = 0;
4009 else if (!NILP (w->vchild))
4011 if (!save_restore_orig_size (XWINDOW (w->vchild), action))
4012 success_p = 0;
4015 switch (action)
4017 case CHECK_ORIG_SIZES:
4018 if (!INTEGERP (w->orig_top_line) || !INTEGERP (w->orig_total_lines))
4019 return 0;
4020 break;
4022 case SAVE_ORIG_SIZES:
4023 w->orig_top_line = w->top_line;
4024 w->orig_total_lines = w->total_lines;
4025 XSETFASTINT (w->last_modified, 0);
4026 XSETFASTINT (w->last_overlay_modified, 0);
4027 break;
4029 case RESTORE_ORIG_SIZES:
4030 xassert (INTEGERP (w->orig_top_line) && INTEGERP (w->orig_total_lines));
4031 w->top_line = w->orig_top_line;
4032 w->total_lines = w->orig_total_lines;
4033 w->orig_total_lines = w->orig_top_line = Qnil;
4034 XSETFASTINT (w->last_modified, 0);
4035 XSETFASTINT (w->last_overlay_modified, 0);
4036 break;
4038 default:
4039 abort ();
4042 w = NILP (w->next) ? NULL : XWINDOW (w->next);
4045 return success_p;
4049 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we can
4050 without deleting other windows. */
4052 void
4053 grow_mini_window (w, delta)
4054 struct window *w;
4055 int delta;
4057 struct frame *f = XFRAME (w->frame);
4058 struct window *root;
4060 xassert (MINI_WINDOW_P (w));
4061 xassert (delta >= 0);
4063 /* Check values of window_min_width and window_min_height for
4064 validity. */
4065 check_min_window_sizes ();
4067 /* Compute how much we can enlarge the mini-window without deleting
4068 other windows. */
4069 root = XWINDOW (FRAME_ROOT_WINDOW (f));
4070 if (delta)
4072 int min_height = window_min_size (root, 0, 0, 0);
4073 if (XFASTINT (root->total_lines) - delta < min_height)
4074 /* Note that the root window may already be smaller than
4075 min_height. */
4076 delta = max (0, XFASTINT (root->total_lines) - min_height);
4079 if (delta)
4081 /* Save original window sizes and positions, if not already done. */
4082 if (!save_restore_orig_size (root, CHECK_ORIG_SIZES))
4083 save_restore_orig_size (root, SAVE_ORIG_SIZES);
4085 /* Shrink other windows. */
4086 shrink_window_lowest_first (root, XFASTINT (root->total_lines) - delta);
4088 /* Grow the mini-window. */
4089 w->top_line = make_number (XFASTINT (root->top_line) + XFASTINT (root->total_lines));
4090 w->total_lines = make_number (XFASTINT (w->total_lines) + delta);
4091 XSETFASTINT (w->last_modified, 0);
4092 XSETFASTINT (w->last_overlay_modified, 0);
4094 adjust_glyphs (f);
4099 /* Shrink mini-window W. If there is recorded info about window sizes
4100 before a call to grow_mini_window, restore recorded window sizes.
4101 Otherwise, if the mini-window is higher than 1 line, resize it to 1
4102 line. */
4104 void
4105 shrink_mini_window (w)
4106 struct window *w;
4108 struct frame *f = XFRAME (w->frame);
4109 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
4111 if (save_restore_orig_size (root, CHECK_ORIG_SIZES))
4113 save_restore_orig_size (root, RESTORE_ORIG_SIZES);
4114 adjust_glyphs (f);
4115 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4116 windows_or_buffers_changed = 1;
4118 else if (XFASTINT (w->total_lines) > 1)
4120 /* Distribute the additional lines of the mini-window
4121 among the other windows. */
4122 Lisp_Object window;
4123 XSETWINDOW (window, w);
4124 enlarge_window (window, 1 - XFASTINT (w->total_lines), 0, 0);
4130 /* Mark window cursors off for all windows in the window tree rooted
4131 at W by setting their phys_cursor_on_p flag to zero. Called from
4132 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4133 the frame are cleared. */
4135 void
4136 mark_window_cursors_off (w)
4137 struct window *w;
4139 while (w)
4141 if (!NILP (w->hchild))
4142 mark_window_cursors_off (XWINDOW (w->hchild));
4143 else if (!NILP (w->vchild))
4144 mark_window_cursors_off (XWINDOW (w->vchild));
4145 else
4146 w->phys_cursor_on_p = 0;
4148 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4153 /* Return number of lines of text (not counting mode lines) in W. */
4156 window_internal_height (w)
4157 struct window *w;
4159 int ht = XFASTINT (w->total_lines);
4161 if (!MINI_WINDOW_P (w))
4163 if (!NILP (w->parent)
4164 || !NILP (w->vchild)
4165 || !NILP (w->hchild)
4166 || !NILP (w->next)
4167 || !NILP (w->prev)
4168 || WINDOW_WANTS_MODELINE_P (w))
4169 --ht;
4171 if (WINDOW_WANTS_HEADER_LINE_P (w))
4172 --ht;
4175 return ht;
4179 /* Return the number of columns in W.
4180 Don't count columns occupied by scroll bars or the vertical bar
4181 separating W from the sibling to its right. */
4184 window_box_text_cols (w)
4185 struct window *w;
4187 struct frame *f = XFRAME (WINDOW_FRAME (w));
4188 int width = XINT (w->total_cols);
4190 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
4191 /* Scroll bars occupy a few columns. */
4192 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
4193 else if (!FRAME_WINDOW_P (f)
4194 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
4195 /* The column of `|' characters separating side-by-side windows
4196 occupies one column only. */
4197 width -= 1;
4199 if (FRAME_WINDOW_P (f))
4200 /* On window-systems, fringes and display margins cannot be
4201 used for normal text. */
4202 width -= (WINDOW_FRINGE_COLS (w)
4203 + WINDOW_LEFT_MARGIN_COLS (w)
4204 + WINDOW_RIGHT_MARGIN_COLS (w));
4206 return width;
4210 /************************************************************************
4211 Window Scrolling
4212 ***********************************************************************/
4214 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4215 N screen-fulls, which is defined as the height of the window minus
4216 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4217 instead. Negative values of N mean scroll down. NOERROR non-zero
4218 means don't signal an error if we try to move over BEGV or ZV,
4219 respectively. */
4221 static void
4222 window_scroll (window, n, whole, noerror)
4223 Lisp_Object window;
4224 int n;
4225 int whole;
4226 int noerror;
4228 immediate_quit = 1;
4230 /* If we must, use the pixel-based version which is much slower than
4231 the line-based one but can handle varying line heights. */
4232 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4233 window_scroll_pixel_based (window, n, whole, noerror);
4234 else
4235 window_scroll_line_based (window, n, whole, noerror);
4237 immediate_quit = 0;
4241 /* Implementation of window_scroll that works based on pixel line
4242 heights. See the comment of window_scroll for parameter
4243 descriptions. */
4245 static void
4246 window_scroll_pixel_based (window, n, whole, noerror)
4247 Lisp_Object window;
4248 int n;
4249 int whole;
4250 int noerror;
4252 struct it it;
4253 struct window *w = XWINDOW (window);
4254 struct text_pos start;
4255 Lisp_Object tem;
4256 int this_scroll_margin;
4257 int preserve_y;
4258 /* True if we fiddled the window vscroll field without really scrolling. */
4259 int vscrolled = 0;
4261 SET_TEXT_POS_FROM_MARKER (start, w->start);
4263 /* If PT is not visible in WINDOW, move back one half of
4264 the screen. Allow PT to be partially visible, otherwise
4265 something like (scroll-down 1) with PT in the line before
4266 the partially visible one would recenter. */
4267 tem = Fpos_visible_in_window_p (make_number (PT), window, Qt);
4268 if (NILP (tem))
4270 /* Move backward half the height of the window. Performance note:
4271 vmotion used here is about 10% faster, but would give wrong
4272 results for variable height lines. */
4273 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4274 it.current_y = it.last_visible_y;
4275 move_it_vertically (&it, - window_box_height (w) / 2);
4277 /* The function move_iterator_vertically may move over more than
4278 the specified y-distance. If it->w is small, e.g. a
4279 mini-buffer window, we may end up in front of the window's
4280 display area. This is the case when Start displaying at the
4281 start of the line containing PT in this case. */
4282 if (it.current_y <= 0)
4284 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4285 move_it_vertically (&it, 0);
4286 it.current_y = 0;
4289 start = it.current.pos;
4292 /* If scroll_preserve_screen_position is non-zero, we try to set
4293 point in the same window line as it is now, so get that line. */
4294 if (!NILP (Vscroll_preserve_screen_position))
4296 start_display (&it, w, start);
4297 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4298 preserve_y = it.current_y;
4300 else
4301 preserve_y = -1;
4303 /* Move iterator it from start the specified distance forward or
4304 backward. The result is the new window start. */
4305 start_display (&it, w, start);
4306 if (whole)
4308 int screen_full = (window_box_height (w)
4309 - next_screen_context_lines * FRAME_LINE_HEIGHT (it.f));
4310 int dy = n * screen_full;
4312 /* Note that move_it_vertically always moves the iterator to the
4313 start of a line. So, if the last line doesn't have a newline,
4314 we would end up at the start of the line ending at ZV. */
4315 if (dy <= 0)
4316 move_it_vertically_backward (&it, -dy);
4317 else if (dy > 0)
4318 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4319 MOVE_TO_POS | MOVE_TO_Y);
4321 else
4322 move_it_by_lines (&it, n, 1);
4324 /* We failed if we find ZV is already on the screen (scrolling up,
4325 means there's nothing past the end), or if we can't start any
4326 earlier (scrolling down, means there's nothing past the top). */
4327 if ((n > 0 && IT_CHARPOS (it) == ZV)
4328 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4330 if (IT_CHARPOS (it) == ZV)
4332 if (it.current_y < it.last_visible_y
4333 && (it.current_y + it.max_ascent + it.max_descent
4334 >= it.last_visible_y))
4336 /* The last line was only partially visible, make it fully
4337 visible. */
4338 w->vscroll = (it.last_visible_y
4339 - it.current_y + it.max_ascent + it.max_descent);
4340 adjust_glyphs (it.f);
4342 else if (noerror)
4343 return;
4344 else
4345 Fsignal (Qend_of_buffer, Qnil);
4347 else
4349 if (w->vscroll != 0)
4350 /* The first line was only partially visible, make it fully
4351 visible. */
4352 w->vscroll = 0;
4353 else if (noerror)
4354 return;
4355 else
4356 Fsignal (Qbeginning_of_buffer, Qnil);
4359 /* If control gets here, then we vscrolled. */
4361 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4363 /* Don't try to change the window start below. */
4364 vscrolled = 1;
4367 if (! vscrolled)
4369 int pos = IT_CHARPOS (it);
4370 int bytepos;
4372 /* If in the middle of a multi-glyph character move forward to
4373 the next character. */
4374 if (in_display_vector_p (&it))
4376 ++pos;
4377 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4380 /* Set the window start, and set up the window for redisplay. */
4381 set_marker_restricted (w->start, make_number (pos),
4382 w->buffer);
4383 bytepos = XMARKER (w->start)->bytepos;
4384 w->start_at_line_beg = ((pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n')
4385 ? Qt : Qnil);
4386 w->update_mode_line = Qt;
4387 XSETFASTINT (w->last_modified, 0);
4388 XSETFASTINT (w->last_overlay_modified, 0);
4389 /* Set force_start so that redisplay_window will run the
4390 window-scroll-functions. */
4391 w->force_start = Qt;
4394 it.current_y = it.vpos = 0;
4396 /* Preserve the screen position if we must. */
4397 if (preserve_y >= 0)
4399 move_it_to (&it, -1, -1, preserve_y, -1, MOVE_TO_Y);
4400 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4402 else
4404 /* Move PT out of scroll margins. */
4405 this_scroll_margin = max (0, scroll_margin);
4406 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
4407 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
4409 if (n > 0)
4411 /* We moved the window start towards ZV, so PT may be now
4412 in the scroll margin at the top. */
4413 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4414 while (it.current_y < this_scroll_margin)
4416 int prev = it.current_y;
4417 move_it_by_lines (&it, 1, 1);
4418 if (prev == it.current_y)
4419 break;
4421 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4423 else if (n < 0)
4425 int charpos, bytepos;
4427 /* We moved the window start towards BEGV, so PT may be now
4428 in the scroll margin at the bottom. */
4429 move_it_to (&it, PT, -1,
4430 it.last_visible_y - this_scroll_margin - 1, -1,
4431 MOVE_TO_POS | MOVE_TO_Y);
4433 /* Save our position, in case it's correct. */
4434 charpos = IT_CHARPOS (it);
4435 bytepos = IT_BYTEPOS (it);
4437 /* See if point is on a partially visible line at the end. */
4438 move_it_by_lines (&it, 1, 1);
4439 if (it.current_y > it.last_visible_y)
4440 /* The last line was only partially visible, so back up two
4441 lines to make sure we're on a fully visible line. */
4443 move_it_by_lines (&it, -2, 0);
4444 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4446 else
4447 /* No, the position we saved is OK, so use it. */
4448 SET_PT_BOTH (charpos, bytepos);
4454 /* Implementation of window_scroll that works based on screen lines.
4455 See the comment of window_scroll for parameter descriptions. */
4457 static void
4458 window_scroll_line_based (window, n, whole, noerror)
4459 Lisp_Object window;
4460 int n;
4461 int whole;
4462 int noerror;
4464 register struct window *w = XWINDOW (window);
4465 register int opoint = PT, opoint_byte = PT_BYTE;
4466 register int pos, pos_byte;
4467 register int ht = window_internal_height (w);
4468 register Lisp_Object tem;
4469 int lose;
4470 Lisp_Object bolp;
4471 int startpos;
4472 struct position posit;
4473 int original_vpos;
4475 /* If scrolling screen-fulls, compute the number of lines to
4476 scroll from the window's height. */
4477 if (whole)
4478 n *= max (1, ht - next_screen_context_lines);
4480 startpos = marker_position (w->start);
4482 posit = *compute_motion (startpos, 0, 0, 0,
4483 PT, ht, 0,
4484 window_box_text_cols (w), XINT (w->hscroll),
4485 0, w);
4486 original_vpos = posit.vpos;
4488 XSETFASTINT (tem, PT);
4489 tem = Fpos_visible_in_window_p (tem, window, Qnil);
4491 if (NILP (tem))
4493 Fvertical_motion (make_number (- (ht / 2)), window);
4494 startpos = PT;
4497 SET_PT (startpos);
4498 lose = n < 0 && PT == BEGV;
4499 Fvertical_motion (make_number (n), window);
4500 pos = PT;
4501 pos_byte = PT_BYTE;
4502 bolp = Fbolp ();
4503 SET_PT_BOTH (opoint, opoint_byte);
4505 if (lose)
4507 if (noerror)
4508 return;
4509 else
4510 Fsignal (Qbeginning_of_buffer, Qnil);
4513 if (pos < ZV)
4515 int this_scroll_margin = scroll_margin;
4517 /* Don't use a scroll margin that is negative or too large. */
4518 if (this_scroll_margin < 0)
4519 this_scroll_margin = 0;
4521 if (XINT (w->total_lines) < 4 * scroll_margin)
4522 this_scroll_margin = XINT (w->total_lines) / 4;
4524 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
4525 w->start_at_line_beg = bolp;
4526 w->update_mode_line = Qt;
4527 XSETFASTINT (w->last_modified, 0);
4528 XSETFASTINT (w->last_overlay_modified, 0);
4529 /* Set force_start so that redisplay_window will run
4530 the window-scroll-functions. */
4531 w->force_start = Qt;
4533 if (whole && !NILP (Vscroll_preserve_screen_position))
4535 SET_PT_BOTH (pos, pos_byte);
4536 Fvertical_motion (make_number (original_vpos), window);
4538 /* If we scrolled forward, put point enough lines down
4539 that it is outside the scroll margin. */
4540 else if (n > 0)
4542 int top_margin;
4544 if (this_scroll_margin > 0)
4546 SET_PT_BOTH (pos, pos_byte);
4547 Fvertical_motion (make_number (this_scroll_margin), window);
4548 top_margin = PT;
4550 else
4551 top_margin = pos;
4553 if (top_margin <= opoint)
4554 SET_PT_BOTH (opoint, opoint_byte);
4555 else if (!NILP (Vscroll_preserve_screen_position))
4557 SET_PT_BOTH (pos, pos_byte);
4558 Fvertical_motion (make_number (original_vpos), window);
4560 else
4561 SET_PT (top_margin);
4563 else if (n < 0)
4565 int bottom_margin;
4567 /* If we scrolled backward, put point near the end of the window
4568 but not within the scroll margin. */
4569 SET_PT_BOTH (pos, pos_byte);
4570 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
4571 if (XFASTINT (tem) == ht - this_scroll_margin)
4572 bottom_margin = PT;
4573 else
4574 bottom_margin = PT + 1;
4576 if (bottom_margin > opoint)
4577 SET_PT_BOTH (opoint, opoint_byte);
4578 else
4580 if (!NILP (Vscroll_preserve_screen_position))
4582 SET_PT_BOTH (pos, pos_byte);
4583 Fvertical_motion (make_number (original_vpos), window);
4585 else
4586 Fvertical_motion (make_number (-1), window);
4590 else
4592 if (noerror)
4593 return;
4594 else
4595 Fsignal (Qend_of_buffer, Qnil);
4600 /* Scroll selected_window up or down. If N is nil, scroll a
4601 screen-full which is defined as the height of the window minus
4602 next_screen_context_lines. If N is the symbol `-', scroll.
4603 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4604 up. This is the guts of Fscroll_up and Fscroll_down. */
4606 static void
4607 scroll_command (n, direction)
4608 Lisp_Object n;
4609 int direction;
4611 int count = SPECPDL_INDEX ();
4613 xassert (abs (direction) == 1);
4615 /* If selected window's buffer isn't current, make it current for
4616 the moment. But don't screw up if window_scroll gets an error. */
4617 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
4619 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4620 Fset_buffer (XWINDOW (selected_window)->buffer);
4622 /* Make redisplay consider other windows than just selected_window. */
4623 ++windows_or_buffers_changed;
4626 if (NILP (n))
4627 window_scroll (selected_window, direction, 1, 0);
4628 else if (EQ (n, Qminus))
4629 window_scroll (selected_window, -direction, 1, 0);
4630 else
4632 n = Fprefix_numeric_value (n);
4633 window_scroll (selected_window, XINT (n) * direction, 0, 0);
4636 unbind_to (count, Qnil);
4639 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "P",
4640 doc: /* Scroll text of current window upward ARG lines; or near full screen if no ARG.
4641 A near full screen is `next-screen-context-lines' less than a full screen.
4642 Negative ARG means scroll downward.
4643 If ARG is the atom `-', scroll downward by nearly full screen.
4644 When calling from a program, supply as argument a number, nil, or `-'. */)
4645 (arg)
4646 Lisp_Object arg;
4648 scroll_command (arg, 1);
4649 return Qnil;
4652 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "P",
4653 doc: /* Scroll text of current window down ARG lines; or near full screen if no ARG.
4654 A near full screen is `next-screen-context-lines' less than a full screen.
4655 Negative ARG means scroll upward.
4656 If ARG is the atom `-', scroll upward by nearly full screen.
4657 When calling from a program, supply as argument a number, nil, or `-'. */)
4658 (arg)
4659 Lisp_Object arg;
4661 scroll_command (arg, -1);
4662 return Qnil;
4665 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
4666 doc: /* Return the other window for \"other window scroll\" commands.
4667 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4668 specifies the window.
4669 If `other-window-scroll-buffer' is non-nil, a window
4670 showing that buffer is used. */)
4673 Lisp_Object window;
4675 if (MINI_WINDOW_P (XWINDOW (selected_window))
4676 && !NILP (Vminibuf_scroll_window))
4677 window = Vminibuf_scroll_window;
4678 /* If buffer is specified, scroll that buffer. */
4679 else if (!NILP (Vother_window_scroll_buffer))
4681 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
4682 if (NILP (window))
4683 window = Fdisplay_buffer (Vother_window_scroll_buffer, Qt, Qnil);
4685 else
4687 /* Nothing specified; look for a neighboring window on the same
4688 frame. */
4689 window = Fnext_window (selected_window, Qnil, Qnil);
4691 if (EQ (window, selected_window))
4692 /* That didn't get us anywhere; look for a window on another
4693 visible frame. */
4695 window = Fnext_window (window, Qnil, Qt);
4696 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
4697 && ! EQ (window, selected_window));
4700 CHECK_LIVE_WINDOW (window);
4702 if (EQ (window, selected_window))
4703 error ("There is no other window");
4705 return window;
4708 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
4709 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
4710 A near full screen is `next-screen-context-lines' less than a full screen.
4711 The next window is the one below the current one; or the one at the top
4712 if the current one is at the bottom. Negative ARG means scroll downward.
4713 If ARG is the atom `-', scroll downward by nearly full screen.
4714 When calling from a program, supply as argument a number, nil, or `-'.
4716 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4717 specifies the window to scroll.
4718 If `other-window-scroll-buffer' is non-nil, scroll the window
4719 showing that buffer, popping the buffer up if necessary. */)
4720 (arg)
4721 Lisp_Object arg;
4723 Lisp_Object window;
4724 struct window *w;
4725 int count = SPECPDL_INDEX ();
4727 window = Fother_window_for_scrolling ();
4728 w = XWINDOW (window);
4730 /* Don't screw up if window_scroll gets an error. */
4731 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4732 ++windows_or_buffers_changed;
4734 Fset_buffer (w->buffer);
4735 SET_PT (marker_position (w->pointm));
4737 if (NILP (arg))
4738 window_scroll (window, 1, 1, 1);
4739 else if (EQ (arg, Qminus))
4740 window_scroll (window, -1, 1, 1);
4741 else
4743 if (CONSP (arg))
4744 arg = Fcar (arg);
4745 CHECK_NUMBER (arg);
4746 window_scroll (window, XINT (arg), 0, 1);
4749 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
4750 unbind_to (count, Qnil);
4752 return Qnil;
4755 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 1, "P",
4756 doc: /* Scroll selected window display ARG columns left.
4757 Default for ARG is window width minus 2.
4758 Value is the total amount of leftward horizontal scrolling in
4759 effect after the change.
4760 If `automatic-hscrolling' is non-nil, the argument ARG modifies
4761 a lower bound for automatic scrolling, i.e. automatic scrolling
4762 will not scroll a window to a column less than the value returned
4763 by this function. */)
4764 (arg)
4765 register Lisp_Object arg;
4767 Lisp_Object result;
4768 int hscroll;
4769 struct window *w = XWINDOW (selected_window);
4771 if (NILP (arg))
4772 XSETFASTINT (arg, window_box_text_cols (w) - 2);
4773 else
4774 arg = Fprefix_numeric_value (arg);
4776 hscroll = XINT (w->hscroll) + XINT (arg);
4777 result = Fset_window_hscroll (selected_window, make_number (hscroll));
4779 if (interactive_p (0))
4780 w->min_hscroll = w->hscroll;
4782 return result;
4785 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 1, "P",
4786 doc: /* Scroll selected window display ARG columns right.
4787 Default for ARG is window width minus 2.
4788 Value is the total amount of leftward horizontal scrolling in
4789 effect after the change.
4790 If `automatic-hscrolling' is non-nil, the argument ARG modifies
4791 a lower bound for automatic scrolling, i.e. automatic scrolling
4792 will not scroll a window to a column less than the value returned
4793 by this function. */)
4794 (arg)
4795 register Lisp_Object arg;
4797 Lisp_Object result;
4798 int hscroll;
4799 struct window *w = XWINDOW (selected_window);
4801 if (NILP (arg))
4802 XSETFASTINT (arg, window_box_text_cols (w) - 2);
4803 else
4804 arg = Fprefix_numeric_value (arg);
4806 hscroll = XINT (w->hscroll) - XINT (arg);
4807 result = Fset_window_hscroll (selected_window, make_number (hscroll));
4809 if (interactive_p (0))
4810 w->min_hscroll = w->hscroll;
4812 return result;
4815 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
4816 doc: /* Return the window which was selected when entering the minibuffer.
4817 Returns nil, if current window is not a minibuffer window. */)
4820 if (minibuf_level > 0
4821 && MINI_WINDOW_P (XWINDOW (selected_window))
4822 && WINDOW_LIVE_P (minibuf_selected_window))
4823 return minibuf_selected_window;
4825 return Qnil;
4828 /* Value is the number of lines actually displayed in window W,
4829 as opposed to its height. */
4831 static int
4832 displayed_window_lines (w)
4833 struct window *w;
4835 struct it it;
4836 struct text_pos start;
4837 int height = window_box_height (w);
4838 struct buffer *old_buffer;
4839 int bottom_y;
4841 if (XBUFFER (w->buffer) != current_buffer)
4843 old_buffer = current_buffer;
4844 set_buffer_internal (XBUFFER (w->buffer));
4846 else
4847 old_buffer = NULL;
4849 /* In case W->start is out of the accessible range, do something
4850 reasonable. This happens in Info mode when Info-scroll-down
4851 calls (recenter -1) while W->start is 1. */
4852 if (XMARKER (w->start)->charpos < BEGV)
4853 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
4854 else if (XMARKER (w->start)->charpos > ZV)
4855 SET_TEXT_POS (start, ZV, ZV_BYTE);
4856 else
4857 SET_TEXT_POS_FROM_MARKER (start, w->start);
4859 start_display (&it, w, start);
4860 move_it_vertically (&it, height);
4861 bottom_y = line_bottom_y (&it);
4863 /* rms: On a non-window display,
4864 the value of it.vpos at the bottom of the screen
4865 seems to be 1 larger than window_box_height (w).
4866 This kludge fixes a bug whereby (move-to-window-line -1)
4867 when ZV is on the last screen line
4868 moves to the previous screen line instead of the last one. */
4869 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
4870 height++;
4872 /* Add in empty lines at the bottom of the window. */
4873 if (bottom_y < height)
4875 int uy = FRAME_LINE_HEIGHT (it.f);
4876 it.vpos += (height - bottom_y + uy - 1) / uy;
4879 if (old_buffer)
4880 set_buffer_internal (old_buffer);
4882 return it.vpos;
4886 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
4887 doc: /* Center point in window and redisplay frame.
4888 With prefix argument ARG, recenter putting point on screen line ARG
4889 relative to the current window. If ARG is negative, it counts up from the
4890 bottom of the window. (ARG should be less than the height of the window.)
4892 If ARG is omitted or nil, erase the entire frame and then
4893 redraw with point in the center of the current window.
4894 Just C-u as prefix means put point in the center of the window
4895 and redisplay normally--don't erase and redraw the frame. */)
4896 (arg)
4897 register Lisp_Object arg;
4899 struct window *w = XWINDOW (selected_window);
4900 struct buffer *buf = XBUFFER (w->buffer);
4901 struct buffer *obuf = current_buffer;
4902 int center_p = 0;
4903 int charpos, bytepos;
4905 /* If redisplay is suppressed due to an error, try again. */
4906 obuf->display_error_modiff = 0;
4908 if (NILP (arg))
4910 int i;
4912 /* Invalidate pixel data calculated for all compositions. */
4913 for (i = 0; i < n_compositions; i++)
4914 composition_table[i]->font = NULL;
4916 Fredraw_frame (w->frame);
4917 SET_FRAME_GARBAGED (XFRAME (WINDOW_FRAME (w)));
4918 center_p = 1;
4920 else if (CONSP (arg)) /* Just C-u. */
4921 center_p = 1;
4922 else
4924 arg = Fprefix_numeric_value (arg);
4925 CHECK_NUMBER (arg);
4928 set_buffer_internal (buf);
4930 /* Handle centering on a graphical frame specially. Such frames can
4931 have variable-height lines and centering point on the basis of
4932 line counts would lead to strange effects. */
4933 if (FRAME_WINDOW_P (XFRAME (w->frame)))
4935 if (center_p)
4937 struct it it;
4938 struct text_pos pt;
4940 SET_TEXT_POS (pt, PT, PT_BYTE);
4941 start_display (&it, w, pt);
4942 move_it_vertically (&it, - window_box_height (w) / 2);
4943 charpos = IT_CHARPOS (it);
4944 bytepos = IT_BYTEPOS (it);
4946 else if (XINT (arg) < 0)
4948 struct it it;
4949 struct text_pos pt;
4950 int y0, y1, h, nlines;
4952 SET_TEXT_POS (pt, PT, PT_BYTE);
4953 start_display (&it, w, pt);
4954 y0 = it.current_y;
4956 /* The amount of pixels we have to move back is the window
4957 height minus what's displayed in the line containing PT,
4958 and the lines below. */
4959 nlines = - XINT (arg) - 1;
4960 move_it_by_lines (&it, nlines, 1);
4962 y1 = line_bottom_y (&it);
4964 /* If we can't move down NLINES lines because we hit
4965 the end of the buffer, count in some empty lines. */
4966 if (it.vpos < nlines)
4967 y1 += (nlines - it.vpos) * FRAME_LINE_HEIGHT (it.f);
4969 h = window_box_height (w) - (y1 - y0);
4971 start_display (&it, w, pt);
4972 move_it_vertically (&it, - h);
4973 charpos = IT_CHARPOS (it);
4974 bytepos = IT_BYTEPOS (it);
4976 else
4978 struct position pos;
4979 pos = *vmotion (PT, - XINT (arg), w);
4980 charpos = pos.bufpos;
4981 bytepos = pos.bytepos;
4984 else
4986 struct position pos;
4987 int ht = window_internal_height (w);
4989 if (center_p)
4990 arg = make_number (ht / 2);
4991 else if (XINT (arg) < 0)
4992 arg = make_number (XINT (arg) + ht);
4994 pos = *vmotion (PT, - XINT (arg), w);
4995 charpos = pos.bufpos;
4996 bytepos = pos.bytepos;
4999 /* Set the new window start. */
5000 set_marker_both (w->start, w->buffer, charpos, bytepos);
5001 w->window_end_valid = Qnil;
5003 w->optional_new_start = Qt;
5005 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
5006 w->start_at_line_beg = Qt;
5007 else
5008 w->start_at_line_beg = Qnil;
5010 set_buffer_internal (obuf);
5011 return Qnil;
5015 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5016 0, 1, 0,
5017 doc: /* Return the height in lines of the text display area of WINDOW.
5018 This doesn't include the mode-line (or header-line if any) or any
5019 partial-height lines in the text display area. */)
5020 (window)
5021 Lisp_Object window;
5023 struct window *w = decode_window (window);
5024 int pixel_height = window_box_height (w);
5025 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5026 return make_number (line_height);
5031 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5032 1, 1, "P",
5033 doc: /* Position point relative to window.
5034 With no argument, position point at center of window.
5035 An argument specifies vertical position within the window;
5036 zero means top of window, negative means relative to bottom of window. */)
5037 (arg)
5038 Lisp_Object arg;
5040 struct window *w = XWINDOW (selected_window);
5041 int lines, start;
5042 Lisp_Object window;
5044 window = selected_window;
5045 start = marker_position (w->start);
5046 if (start < BEGV || start > ZV)
5048 int height = window_internal_height (w);
5049 Fvertical_motion (make_number (- (height / 2)), window);
5050 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
5051 w->start_at_line_beg = Fbolp ();
5052 w->force_start = Qt;
5054 else
5055 Fgoto_char (w->start);
5057 lines = displayed_window_lines (w);
5058 if (NILP (arg))
5059 XSETFASTINT (arg, lines / 2);
5060 else
5062 arg = Fprefix_numeric_value (arg);
5063 if (XINT (arg) < 0)
5064 XSETINT (arg, XINT (arg) + lines);
5067 /* Skip past a partially visible first line. */
5068 if (w->vscroll)
5069 XSETINT (arg, XINT (arg) + 1);
5071 return Fvertical_motion (arg, window);
5076 /***********************************************************************
5077 Window Configuration
5078 ***********************************************************************/
5080 struct save_window_data
5082 EMACS_INT size_from_Lisp_Vector_struct;
5083 struct Lisp_Vector *next_from_Lisp_Vector_struct;
5084 Lisp_Object frame_cols, frame_lines, frame_menu_bar_lines;
5085 Lisp_Object frame_tool_bar_lines;
5086 Lisp_Object selected_frame;
5087 Lisp_Object current_window;
5088 Lisp_Object current_buffer;
5089 Lisp_Object minibuf_scroll_window;
5090 Lisp_Object minibuf_selected_window;
5091 Lisp_Object root_window;
5092 Lisp_Object focus_frame;
5093 /* Record the values of window-min-width and window-min-height
5094 so that window sizes remain consistent with them. */
5095 Lisp_Object min_width, min_height;
5096 /* A vector, each of whose elements is a struct saved_window
5097 for one window. */
5098 Lisp_Object saved_windows;
5101 /* This is saved as a Lisp_Vector */
5102 struct saved_window
5104 /* these first two must agree with struct Lisp_Vector in lisp.h */
5105 EMACS_INT size_from_Lisp_Vector_struct;
5106 struct Lisp_Vector *next_from_Lisp_Vector_struct;
5108 Lisp_Object window;
5109 Lisp_Object buffer, start, pointm, mark;
5110 Lisp_Object left_col, top_line, total_cols, total_lines;
5111 Lisp_Object hscroll, min_hscroll;
5112 Lisp_Object parent, prev;
5113 Lisp_Object start_at_line_beg;
5114 Lisp_Object display_table;
5115 Lisp_Object orig_top_line, orig_total_lines;
5116 Lisp_Object left_margin_cols, right_margin_cols;
5117 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5118 Lisp_Object scroll_bar_width, vertical_scroll_bar_type;
5121 #define SAVED_WINDOW_VECTOR_SIZE 24 /* Arg to Fmake_vector */
5123 #define SAVED_WINDOW_N(swv,n) \
5124 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5126 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5127 doc: /* Return t if OBJECT is a window-configuration object. */)
5128 (object)
5129 Lisp_Object object;
5131 if (WINDOW_CONFIGURATIONP (object))
5132 return Qt;
5133 return Qnil;
5136 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5137 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5138 (config)
5139 Lisp_Object config;
5141 register struct save_window_data *data;
5142 struct Lisp_Vector *saved_windows;
5144 if (! WINDOW_CONFIGURATIONP (config))
5145 wrong_type_argument (Qwindow_configuration_p, config);
5147 data = (struct save_window_data *) XVECTOR (config);
5148 saved_windows = XVECTOR (data->saved_windows);
5149 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5152 DEFUN ("set-window-configuration", Fset_window_configuration,
5153 Sset_window_configuration, 1, 1, 0,
5154 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5155 CONFIGURATION must be a value previously returned
5156 by `current-window-configuration' (which see).
5157 If CONFIGURATION was made from a frame that is now deleted,
5158 only frame-independent values can be restored. In this case,
5159 the return value is nil. Otherwise the value is t. */)
5160 (configuration)
5161 Lisp_Object configuration;
5163 register struct save_window_data *data;
5164 struct Lisp_Vector *saved_windows;
5165 Lisp_Object new_current_buffer;
5166 Lisp_Object frame;
5167 FRAME_PTR f;
5168 int old_point = -1;
5170 while (!WINDOW_CONFIGURATIONP (configuration))
5171 wrong_type_argument (Qwindow_configuration_p, configuration);
5173 data = (struct save_window_data *) XVECTOR (configuration);
5174 saved_windows = XVECTOR (data->saved_windows);
5176 new_current_buffer = data->current_buffer;
5177 if (NILP (XBUFFER (new_current_buffer)->name))
5178 new_current_buffer = Qnil;
5179 else
5181 if (XBUFFER (new_current_buffer) == current_buffer)
5182 old_point = PT;
5183 else
5184 old_point = BUF_PT (XBUFFER (new_current_buffer));
5187 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5188 f = XFRAME (frame);
5190 /* If f is a dead frame, don't bother rebuilding its window tree.
5191 However, there is other stuff we should still try to do below. */
5192 if (FRAME_LIVE_P (f))
5194 register struct window *w;
5195 register struct saved_window *p;
5196 struct window *root_window;
5197 struct window **leaf_windows;
5198 int n_leaf_windows;
5199 int k, i, n;
5201 /* If the frame has been resized since this window configuration was
5202 made, we change the frame to the size specified in the
5203 configuration, restore the configuration, and then resize it
5204 back. We keep track of the prevailing height in these variables. */
5205 int previous_frame_lines = FRAME_LINES (f);
5206 int previous_frame_cols = FRAME_COLS (f);
5207 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5208 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5210 /* The mouse highlighting code could get screwed up
5211 if it runs during this. */
5212 BLOCK_INPUT;
5214 if (XFASTINT (data->frame_lines) != previous_frame_lines
5215 || XFASTINT (data->frame_cols) != previous_frame_cols)
5216 change_frame_size (f, XFASTINT (data->frame_lines),
5217 XFASTINT (data->frame_cols), 0, 0, 0);
5218 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5219 if (XFASTINT (data->frame_menu_bar_lines)
5220 != previous_frame_menu_bar_lines)
5221 x_set_menu_bar_lines (f, data->frame_menu_bar_lines, make_number (0));
5222 #ifdef HAVE_WINDOW_SYSTEM
5223 if (XFASTINT (data->frame_tool_bar_lines)
5224 != previous_frame_tool_bar_lines)
5225 x_set_tool_bar_lines (f, data->frame_tool_bar_lines, make_number (0));
5226 #endif
5227 #endif
5229 /* "Swap out" point from the selected window
5230 into its buffer. We do this now, before
5231 restoring the window contents, and prevent it from
5232 being done later on when we select a new window. */
5233 if (! NILP (XWINDOW (selected_window)->buffer))
5235 w = XWINDOW (selected_window);
5236 set_marker_both (w->pointm,
5237 w->buffer,
5238 BUF_PT (XBUFFER (w->buffer)),
5239 BUF_PT_BYTE (XBUFFER (w->buffer)));
5242 windows_or_buffers_changed++;
5243 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
5245 /* Problem: Freeing all matrices and later allocating them again
5246 is a serious redisplay flickering problem. What we would
5247 really like to do is to free only those matrices not reused
5248 below. */
5249 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
5250 leaf_windows
5251 = (struct window **) alloca (count_windows (root_window)
5252 * sizeof (struct window *));
5253 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
5255 /* Temporarily avoid any problems with windows that are smaller
5256 than they are supposed to be. */
5257 window_min_height = 1;
5258 window_min_width = 1;
5260 /* Kludge Alert!
5261 Mark all windows now on frame as "deleted".
5262 Restoring the new configuration "undeletes" any that are in it.
5264 Save their current buffers in their height fields, since we may
5265 need it later, if a buffer saved in the configuration is now
5266 dead. */
5267 delete_all_subwindows (XWINDOW (FRAME_ROOT_WINDOW (f)));
5269 for (k = 0; k < saved_windows->size; k++)
5271 p = SAVED_WINDOW_N (saved_windows, k);
5272 w = XWINDOW (p->window);
5273 w->next = Qnil;
5275 if (!NILP (p->parent))
5276 w->parent = SAVED_WINDOW_N (saved_windows,
5277 XFASTINT (p->parent))->window;
5278 else
5279 w->parent = Qnil;
5281 if (!NILP (p->prev))
5283 w->prev = SAVED_WINDOW_N (saved_windows,
5284 XFASTINT (p->prev))->window;
5285 XWINDOW (w->prev)->next = p->window;
5287 else
5289 w->prev = Qnil;
5290 if (!NILP (w->parent))
5292 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
5294 XWINDOW (w->parent)->vchild = p->window;
5295 XWINDOW (w->parent)->hchild = Qnil;
5297 else
5299 XWINDOW (w->parent)->hchild = p->window;
5300 XWINDOW (w->parent)->vchild = Qnil;
5305 /* If we squirreled away the buffer in the window's height,
5306 restore it now. */
5307 if (BUFFERP (w->total_lines))
5308 w->buffer = w->total_lines;
5309 w->left_col = p->left_col;
5310 w->top_line = p->top_line;
5311 w->total_cols = p->total_cols;
5312 w->total_lines = p->total_lines;
5313 w->hscroll = p->hscroll;
5314 w->min_hscroll = p->min_hscroll;
5315 w->display_table = p->display_table;
5316 w->orig_top_line = p->orig_top_line;
5317 w->orig_total_lines = p->orig_total_lines;
5318 w->left_margin_cols = p->left_margin_cols;
5319 w->right_margin_cols = p->right_margin_cols;
5320 w->left_fringe_width = p->left_fringe_width;
5321 w->right_fringe_width = p->right_fringe_width;
5322 w->fringes_outside_margins = p->fringes_outside_margins;
5323 w->scroll_bar_width = p->scroll_bar_width;
5324 w->vertical_scroll_bar_type = p->vertical_scroll_bar_type;
5325 XSETFASTINT (w->last_modified, 0);
5326 XSETFASTINT (w->last_overlay_modified, 0);
5328 /* Reinstall the saved buffer and pointers into it. */
5329 if (NILP (p->buffer))
5330 w->buffer = p->buffer;
5331 else
5333 if (!NILP (XBUFFER (p->buffer)->name))
5334 /* If saved buffer is alive, install it. */
5336 w->buffer = p->buffer;
5337 w->start_at_line_beg = p->start_at_line_beg;
5338 set_marker_restricted (w->start, p->start, w->buffer);
5339 set_marker_restricted (w->pointm, p->pointm, w->buffer);
5340 Fset_marker (XBUFFER (w->buffer)->mark,
5341 p->mark, w->buffer);
5343 /* As documented in Fcurrent_window_configuration, don't
5344 restore the location of point in the buffer which was
5345 current when the window configuration was recorded. */
5346 if (!EQ (p->buffer, new_current_buffer)
5347 && XBUFFER (p->buffer) == current_buffer)
5348 Fgoto_char (w->pointm);
5350 else if (NILP (w->buffer) || NILP (XBUFFER (w->buffer)->name))
5351 /* Else unless window has a live buffer, get one. */
5353 w->buffer = Fcdr (Fcar (Vbuffer_alist));
5354 /* This will set the markers to beginning of visible
5355 range. */
5356 set_marker_restricted (w->start, make_number (0), w->buffer);
5357 set_marker_restricted (w->pointm, make_number (0),w->buffer);
5358 w->start_at_line_beg = Qt;
5360 else
5361 /* Keeping window's old buffer; make sure the markers
5362 are real. */
5364 /* Set window markers at start of visible range. */
5365 if (XMARKER (w->start)->buffer == 0)
5366 set_marker_restricted (w->start, make_number (0),
5367 w->buffer);
5368 if (XMARKER (w->pointm)->buffer == 0)
5369 set_marker_restricted_both (w->pointm, w->buffer,
5370 BUF_PT (XBUFFER (w->buffer)),
5371 BUF_PT_BYTE (XBUFFER (w->buffer)));
5372 w->start_at_line_beg = Qt;
5377 FRAME_ROOT_WINDOW (f) = data->root_window;
5378 /* Prevent "swapping out point" in the old selected window
5379 using the buffer that has been restored into it.
5380 Use the point value from the beginning of this function
5381 since unshow_buffer (called from delete_all_subwindows)
5382 could have altered it. */
5383 selected_window = Qnil;
5384 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
5385 set_marker_restricted (XWINDOW (data->current_window)->pointm,
5386 make_number (old_point),
5387 XWINDOW (data->current_window)->buffer);
5389 Fselect_window (data->current_window, Qnil);
5390 XBUFFER (XWINDOW (selected_window)->buffer)->last_selected_window
5391 = selected_window;
5393 if (NILP (data->focus_frame)
5394 || (FRAMEP (data->focus_frame)
5395 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
5396 Fredirect_frame_focus (frame, data->focus_frame);
5398 #if 0 /* I don't understand why this is needed, and it causes problems
5399 when the frame's old selected window has been deleted. */
5400 if (f != selected_frame && FRAME_WINDOW_P (f))
5401 do_switch_frame (WINDOW_FRAME (XWINDOW (data->root_window)),
5402 0, 0);
5403 #endif
5405 /* Set the screen height to the value it had before this function. */
5406 if (previous_frame_lines != FRAME_LINES (f)
5407 || previous_frame_cols != FRAME_COLS (f))
5408 change_frame_size (f, previous_frame_lines, previous_frame_cols,
5409 0, 0, 0);
5410 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5411 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
5412 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
5413 make_number (0));
5414 #ifdef HAVE_WINDOW_SYSTEM
5415 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
5416 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
5417 make_number (0));
5418 #endif
5419 #endif
5421 /* Now, free glyph matrices in windows that were not reused. */
5422 for (i = n = 0; i < n_leaf_windows; ++i)
5424 if (NILP (leaf_windows[i]->buffer))
5426 /* Assert it's not reused as a combination. */
5427 xassert (NILP (leaf_windows[i]->hchild)
5428 && NILP (leaf_windows[i]->vchild));
5429 free_window_matrices (leaf_windows[i]);
5431 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
5432 ++n;
5435 adjust_glyphs (f);
5437 UNBLOCK_INPUT;
5439 /* Fselect_window will have made f the selected frame, so we
5440 reselect the proper frame here. Fhandle_switch_frame will change the
5441 selected window too, but that doesn't make the call to
5442 Fselect_window above totally superfluous; it still sets f's
5443 selected window. */
5444 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
5445 do_switch_frame (data->selected_frame, 0, 0);
5447 if (! NILP (Vwindow_configuration_change_hook)
5448 && ! NILP (Vrun_hooks))
5449 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
5452 if (!NILP (new_current_buffer))
5453 Fset_buffer (new_current_buffer);
5455 /* Restore the minimum heights recorded in the configuration. */
5456 window_min_height = XINT (data->min_height);
5457 window_min_width = XINT (data->min_width);
5459 Vminibuf_scroll_window = data->minibuf_scroll_window;
5460 minibuf_selected_window = data->minibuf_selected_window;
5462 return (FRAME_LIVE_P (f) ? Qt : Qnil);
5465 /* Mark all windows now on frame as deleted
5466 by setting their buffers to nil. */
5468 void
5469 delete_all_subwindows (w)
5470 register struct window *w;
5472 if (!NILP (w->next))
5473 delete_all_subwindows (XWINDOW (w->next));
5474 if (!NILP (w->vchild))
5475 delete_all_subwindows (XWINDOW (w->vchild));
5476 if (!NILP (w->hchild))
5477 delete_all_subwindows (XWINDOW (w->hchild));
5479 w->total_lines = w->buffer; /* See Fset_window_configuration for excuse. */
5481 if (!NILP (w->buffer))
5482 unshow_buffer (w);
5484 /* We set all three of these fields to nil, to make sure that we can
5485 distinguish this dead window from any live window. Live leaf
5486 windows will have buffer set, and combination windows will have
5487 vchild or hchild set. */
5488 w->buffer = Qnil;
5489 w->vchild = Qnil;
5490 w->hchild = Qnil;
5492 Vwindow_list = Qnil;
5495 static int
5496 count_windows (window)
5497 register struct window *window;
5499 register int count = 1;
5500 if (!NILP (window->next))
5501 count += count_windows (XWINDOW (window->next));
5502 if (!NILP (window->vchild))
5503 count += count_windows (XWINDOW (window->vchild));
5504 if (!NILP (window->hchild))
5505 count += count_windows (XWINDOW (window->hchild));
5506 return count;
5510 /* Fill vector FLAT with leaf windows under W, starting at index I.
5511 Value is last index + 1. */
5513 static int
5514 get_leaf_windows (w, flat, i)
5515 struct window *w;
5516 struct window **flat;
5517 int i;
5519 while (w)
5521 if (!NILP (w->hchild))
5522 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
5523 else if (!NILP (w->vchild))
5524 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
5525 else
5526 flat[i++] = w;
5528 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5531 return i;
5535 /* Return a pointer to the glyph W's physical cursor is on. Value is
5536 null if W's current matrix is invalid, so that no meaningfull glyph
5537 can be returned. */
5539 struct glyph *
5540 get_phys_cursor_glyph (w)
5541 struct window *w;
5543 struct glyph_row *row;
5544 struct glyph *glyph;
5546 if (w->phys_cursor.vpos >= 0
5547 && w->phys_cursor.vpos < w->current_matrix->nrows
5548 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
5549 row->enabled_p)
5550 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
5551 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
5552 else
5553 glyph = NULL;
5555 return glyph;
5559 static int
5560 save_window_save (window, vector, i)
5561 Lisp_Object window;
5562 struct Lisp_Vector *vector;
5563 int i;
5565 register struct saved_window *p;
5566 register struct window *w;
5567 register Lisp_Object tem;
5569 for (;!NILP (window); window = w->next)
5571 p = SAVED_WINDOW_N (vector, i);
5572 w = XWINDOW (window);
5574 XSETFASTINT (w->temslot, i++);
5575 p->window = window;
5576 p->buffer = w->buffer;
5577 p->left_col = w->left_col;
5578 p->top_line = w->top_line;
5579 p->total_cols = w->total_cols;
5580 p->total_lines = w->total_lines;
5581 p->hscroll = w->hscroll;
5582 p->min_hscroll = w->min_hscroll;
5583 p->display_table = w->display_table;
5584 p->orig_top_line = w->orig_top_line;
5585 p->orig_total_lines = w->orig_total_lines;
5586 p->left_margin_cols = w->left_margin_cols;
5587 p->right_margin_cols = w->right_margin_cols;
5588 p->left_fringe_width = w->left_fringe_width;
5589 p->right_fringe_width = w->right_fringe_width;
5590 p->fringes_outside_margins = w->fringes_outside_margins;
5591 p->scroll_bar_width = w->scroll_bar_width;
5592 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
5593 if (!NILP (w->buffer))
5595 /* Save w's value of point in the window configuration.
5596 If w is the selected window, then get the value of point
5597 from the buffer; pointm is garbage in the selected window. */
5598 if (EQ (window, selected_window))
5600 p->pointm = Fmake_marker ();
5601 set_marker_both (p->pointm, w->buffer,
5602 BUF_PT (XBUFFER (w->buffer)),
5603 BUF_PT_BYTE (XBUFFER (w->buffer)));
5605 else
5606 p->pointm = Fcopy_marker (w->pointm, Qnil);
5608 p->start = Fcopy_marker (w->start, Qnil);
5609 p->start_at_line_beg = w->start_at_line_beg;
5611 tem = XBUFFER (w->buffer)->mark;
5612 p->mark = Fcopy_marker (tem, Qnil);
5614 else
5616 p->pointm = Qnil;
5617 p->start = Qnil;
5618 p->mark = Qnil;
5619 p->start_at_line_beg = Qnil;
5622 if (NILP (w->parent))
5623 p->parent = Qnil;
5624 else
5625 p->parent = XWINDOW (w->parent)->temslot;
5627 if (NILP (w->prev))
5628 p->prev = Qnil;
5629 else
5630 p->prev = XWINDOW (w->prev)->temslot;
5632 if (!NILP (w->vchild))
5633 i = save_window_save (w->vchild, vector, i);
5634 if (!NILP (w->hchild))
5635 i = save_window_save (w->hchild, vector, i);
5638 return i;
5641 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
5642 Scurrent_window_configuration, 0, 1, 0,
5643 doc: /* Return an object representing the current window configuration of FRAME.
5644 If FRAME is nil or omitted, use the selected frame.
5645 This describes the number of windows, their sizes and current buffers,
5646 and for each displayed buffer, where display starts, and the positions of
5647 point and mark. An exception is made for point in the current buffer:
5648 its value is -not- saved.
5649 This also records the currently selected frame, and FRAME's focus
5650 redirection (see `redirect-frame-focus'). */)
5651 (frame)
5652 Lisp_Object frame;
5654 register Lisp_Object tem;
5655 register int n_windows;
5656 register struct save_window_data *data;
5657 register struct Lisp_Vector *vec;
5658 register int i;
5659 FRAME_PTR f;
5661 if (NILP (frame))
5662 frame = selected_frame;
5663 CHECK_LIVE_FRAME (frame);
5664 f = XFRAME (frame);
5666 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
5667 vec = allocate_other_vector (VECSIZE (struct save_window_data));
5668 data = (struct save_window_data *)vec;
5670 XSETFASTINT (data->frame_cols, FRAME_COLS (f));
5671 XSETFASTINT (data->frame_lines, FRAME_LINES (f));
5672 XSETFASTINT (data->frame_menu_bar_lines, FRAME_MENU_BAR_LINES (f));
5673 XSETFASTINT (data->frame_tool_bar_lines, FRAME_TOOL_BAR_LINES (f));
5674 data->selected_frame = selected_frame;
5675 data->current_window = FRAME_SELECTED_WINDOW (f);
5676 XSETBUFFER (data->current_buffer, current_buffer);
5677 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
5678 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
5679 data->root_window = FRAME_ROOT_WINDOW (f);
5680 data->focus_frame = FRAME_FOCUS_FRAME (f);
5681 XSETINT (data->min_height, window_min_height);
5682 XSETINT (data->min_width, window_min_width);
5683 tem = Fmake_vector (make_number (n_windows), Qnil);
5684 data->saved_windows = tem;
5685 for (i = 0; i < n_windows; i++)
5686 XVECTOR (tem)->contents[i]
5687 = Fmake_vector (make_number (SAVED_WINDOW_VECTOR_SIZE), Qnil);
5688 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
5689 XSETWINDOW_CONFIGURATION (tem, data);
5690 return (tem);
5693 DEFUN ("save-window-excursion", Fsave_window_excursion, Ssave_window_excursion,
5694 0, UNEVALLED, 0,
5695 doc: /* Execute body, preserving window sizes and contents.
5696 Restore which buffer appears in which window, where display starts,
5697 and the value of point and mark for each window.
5698 Also restore the choice of selected window.
5699 Also restore which buffer is current.
5700 Does not restore the value of point in current buffer.
5701 usage: (save-window-excursion BODY ...) */)
5702 (args)
5703 Lisp_Object args;
5705 register Lisp_Object val;
5706 register int count = SPECPDL_INDEX ();
5708 record_unwind_protect (Fset_window_configuration,
5709 Fcurrent_window_configuration (Qnil));
5710 val = Fprogn (args);
5711 return unbind_to (count, val);
5715 /***********************************************************************
5716 Marginal Areas
5717 ***********************************************************************/
5719 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
5720 2, 3, 0,
5721 doc: /* Set width of marginal areas of window WINDOW.
5722 If window is nil, set margins of the currently selected window.
5723 First parameter LEFT-WIDTH specifies the number of character
5724 cells to reserve for the left marginal area. Second parameter
5725 RIGHT-WIDTH does the same for the right marginal area.
5726 A nil width parameter means no margin. */)
5727 (window, left, right)
5728 Lisp_Object window, left, right;
5730 struct window *w = decode_window (window);
5732 /* TODO: It doesn't make sense to use FLOATs here, since
5733 the rest of the code assumes they are integers.
5734 So don't allow floats! ++KFS */
5736 if (!NILP (left))
5737 CHECK_NUMBER_OR_FLOAT (left);
5738 if (!NILP (right))
5739 CHECK_NUMBER_OR_FLOAT (right);
5741 /* Check widths < 0 and translate a zero width to nil.
5742 Margins that are too wide have to be checked elsewhere. */
5743 if ((INTEGERP (left) && XINT (left) < 0)
5744 || (FLOATP (left) && XFLOAT_DATA (left) <= 0))
5745 XSETFASTINT (left, 0);
5746 if (INTEGERP (left) && XFASTINT (left) == 0)
5747 left = Qnil;
5749 if ((INTEGERP (right) && XINT (right) < 0)
5750 || (FLOATP (right) && XFLOAT_DATA (right) <= 0))
5751 XSETFASTINT (right, 0);
5752 if (INTEGERP (right) && XFASTINT (right) == 0)
5753 right = Qnil;
5755 if (!EQ (w->left_margin_cols, left)
5756 || !EQ (w->right_margin_cols, right))
5758 w->left_margin_cols = left;
5759 w->right_margin_cols = right;
5761 adjust_window_margins (w);
5763 ++windows_or_buffers_changed;
5764 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
5767 return Qnil;
5771 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
5772 0, 1, 0,
5773 doc: /* Get width of marginal areas of window WINDOW.
5774 If WINDOW is omitted or nil, use the currently selected window.
5775 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
5776 If a marginal area does not exist, its width will be returned
5777 as nil. */)
5778 (window)
5779 Lisp_Object window;
5781 struct window *w = decode_window (window);
5782 return Fcons (w->left_margin_cols, w->right_margin_cols);
5787 /***********************************************************************
5788 Fringes
5789 ***********************************************************************/
5791 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
5792 2, 4, 0,
5793 doc: /* Set width of fringes of window WINDOW.
5795 If window is nil, set fringes of the currently selected window.
5796 Second parameter LEFT-WIDTH specifies the number of pixels to reserve
5797 for the left fringe. Third parameter RIGHT-WIDTH does the same for
5798 the right fringe. Fourth parameter OUTSIDE-MARGINS non-nil specifies
5799 that fringes are drawn outside of the display margins; by default, fringes
5800 are drawn between display marginal areas and the text area.
5801 A nil width parameter means to use the frame's corresponding fringe width. */)
5802 (window, left, right, outside_margins)
5803 Lisp_Object window, left, right, outside_margins;
5805 struct window *w = decode_window (window);
5807 if (!NILP (left))
5808 CHECK_NUMBER (left);
5809 if (!NILP (right))
5810 CHECK_NUMBER (right);
5812 if (!EQ (w->left_fringe_width, left)
5813 || !EQ (w->right_fringe_width, right)
5814 || !EQ (w->fringes_outside_margins, outside_margins))
5816 w->left_fringe_width = left;
5817 w->right_fringe_width = right;
5818 w->fringes_outside_margins = outside_margins;
5820 adjust_window_margins (w);
5822 clear_glyph_matrix (w->current_matrix);
5823 w->window_end_valid = Qnil;
5825 ++windows_or_buffers_changed;
5826 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
5829 return Qnil;
5833 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
5834 0, 1, 0,
5835 doc: /* Get width of fringes of window WINDOW.
5836 If WINDOW is omitted or nil, use the currently selected window.
5837 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS).
5838 If a window specific fringe width is not set, its width will be returned
5839 as nil. */)
5840 (window)
5841 Lisp_Object window;
5843 struct window *w = decode_window (window);
5844 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
5845 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
5846 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w) ?
5847 Qt : Qnil), Qnil)));
5852 /***********************************************************************
5853 Scroll bars
5854 ***********************************************************************/
5856 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars, Sset_window_scroll_bars,
5857 2, 4, 0,
5858 doc: /* Set width and type of scroll bars of window WINDOW.
5859 If window is nil, set scroll bars of the currently selected window.
5860 Second parameter WIDTH specifies the pixel width for the scroll bar;
5861 this is automatically adjusted to a multiple of the frame column width.
5862 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
5863 bar: left, right, or nil.
5864 A width of nil and type of t means to use the frame's corresponding value. */)
5865 (window, width, vertical_type, horizontal_type)
5866 Lisp_Object window, width, vertical_type, horizontal_type;
5868 struct window *w = decode_window (window);
5870 if (!NILP (width))
5871 CHECK_NUMBER (width);
5873 if (XINT (width) == 0)
5874 vertical_type = Qnil;
5876 if (!EQ (w->scroll_bar_width, width)
5877 || !EQ (w->vertical_scroll_bar_type, vertical_type))
5879 w->scroll_bar_width = width;
5880 w->vertical_scroll_bar_type = vertical_type;
5882 adjust_window_margins (w);
5884 clear_glyph_matrix (w->current_matrix);
5885 w->window_end_valid = Qnil;
5887 ++windows_or_buffers_changed;
5888 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
5891 return Qnil;
5895 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
5896 0, 1, 0,
5897 doc: /* Get width and type of scroll bars of window WINDOW.
5898 If WINDOW is omitted or nil, use the currently selected window.
5899 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE). */)
5900 (window)
5901 Lisp_Object window;
5903 struct window *w = decode_window (window);
5904 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
5905 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
5906 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
5907 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
5908 Fcons (w->vertical_scroll_bar_type,
5909 Fcons (Qnil, Qnil))));
5914 /***********************************************************************
5915 Smooth scrolling
5916 ***********************************************************************/
5918 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 1, 0,
5919 doc: /* Return the amount by which WINDOW is scrolled vertically.
5920 Use the selected window if WINDOW is nil or omitted.
5921 Value is a multiple of the canonical character height of WINDOW. */)
5922 (window)
5923 Lisp_Object window;
5925 Lisp_Object result;
5926 struct frame *f;
5927 struct window *w;
5929 if (NILP (window))
5930 window = selected_window;
5931 else
5932 CHECK_WINDOW (window);
5933 w = XWINDOW (window);
5934 f = XFRAME (w->frame);
5936 if (FRAME_WINDOW_P (f))
5937 result = FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll);
5938 else
5939 result = make_number (0);
5940 return result;
5944 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
5945 2, 2, 0,
5946 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
5947 WINDOW nil means use the selected window. VSCROLL is a non-negative
5948 multiple of the canonical character height of WINDOW. */)
5949 (window, vscroll)
5950 Lisp_Object window, vscroll;
5952 struct window *w;
5953 struct frame *f;
5955 if (NILP (window))
5956 window = selected_window;
5957 else
5958 CHECK_WINDOW (window);
5959 CHECK_NUMBER_OR_FLOAT (vscroll);
5961 w = XWINDOW (window);
5962 f = XFRAME (w->frame);
5964 if (FRAME_WINDOW_P (f))
5966 int old_dy = w->vscroll;
5968 w->vscroll = - FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll);
5969 w->vscroll = min (w->vscroll, 0);
5971 /* Adjust glyph matrix of the frame if the virtual display
5972 area becomes larger than before. */
5973 if (w->vscroll < 0 && w->vscroll < old_dy)
5974 adjust_glyphs (f);
5976 /* Prevent redisplay shortcuts. */
5977 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
5980 return Fwindow_vscroll (window);
5984 /* Call FN for all leaf windows on frame F. FN is called with the
5985 first argument being a pointer to the leaf window, and with
5986 additional argument USER_DATA. Stops when FN returns 0. */
5988 void
5989 foreach_window (f, fn, user_data)
5990 struct frame *f;
5991 int (* fn) P_ ((struct window *, void *));
5992 void *user_data;
5994 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
5998 /* Helper function for foreach_window. Call FN for all leaf windows
5999 reachable from W. FN is called with the first argument being a
6000 pointer to the leaf window, and with additional argument USER_DATA.
6001 Stop when FN returns 0. Value is 0 if stopped by FN. */
6003 static int
6004 foreach_window_1 (w, fn, user_data)
6005 struct window *w;
6006 int (* fn) P_ ((struct window *, void *));
6007 void *user_data;
6009 int cont;
6011 for (cont = 1; w && cont;)
6013 if (!NILP (w->hchild))
6014 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6015 else if (!NILP (w->vchild))
6016 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6017 else
6018 cont = fn (w, user_data);
6020 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6023 return cont;
6027 /* Freeze or unfreeze the window start of W unless it is a
6028 mini-window or the selected window. FREEZE_P non-null means freeze
6029 the window start. */
6031 static int
6032 freeze_window_start (w, freeze_p)
6033 struct window *w;
6034 void *freeze_p;
6036 if (w == XWINDOW (selected_window)
6037 || MINI_WINDOW_P (w)
6038 || (MINI_WINDOW_P (XWINDOW (selected_window))
6039 && ! NILP (Vminibuf_scroll_window)
6040 && w == XWINDOW (Vminibuf_scroll_window)))
6041 freeze_p = NULL;
6043 w->frozen_window_start_p = freeze_p != NULL;
6044 return 1;
6048 /* Freeze or unfreeze the window starts of all leaf windows on frame
6049 F, except the selected window and a mini-window. FREEZE_P non-zero
6050 means freeze the window start. */
6052 void
6053 freeze_window_starts (f, freeze_p)
6054 struct frame *f;
6055 int freeze_p;
6057 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6061 /***********************************************************************
6062 Initialization
6063 ***********************************************************************/
6065 /* Return 1 if window configurations C1 and C2
6066 describe the same state of affairs. This is used by Fequal. */
6069 compare_window_configurations (c1, c2, ignore_positions)
6070 Lisp_Object c1, c2;
6071 int ignore_positions;
6073 register struct save_window_data *d1, *d2;
6074 struct Lisp_Vector *sw1, *sw2;
6075 int i;
6077 if (!WINDOW_CONFIGURATIONP (c1))
6078 wrong_type_argument (Qwindow_configuration_p, c1);
6079 if (!WINDOW_CONFIGURATIONP (c2))
6080 wrong_type_argument (Qwindow_configuration_p, c2);
6082 d1 = (struct save_window_data *) XVECTOR (c1);
6083 d2 = (struct save_window_data *) XVECTOR (c2);
6084 sw1 = XVECTOR (d1->saved_windows);
6085 sw2 = XVECTOR (d2->saved_windows);
6087 if (! EQ (d1->frame_cols, d2->frame_cols))
6088 return 0;
6089 if (! EQ (d1->frame_lines, d2->frame_lines))
6090 return 0;
6091 if (! EQ (d1->frame_menu_bar_lines, d2->frame_menu_bar_lines))
6092 return 0;
6093 if (! EQ (d1->selected_frame, d2->selected_frame))
6094 return 0;
6095 /* Don't compare the current_window field directly.
6096 Instead see w1_is_current and w2_is_current, below. */
6097 if (! EQ (d1->current_buffer, d2->current_buffer))
6098 return 0;
6099 if (! ignore_positions)
6101 if (! EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window))
6102 return 0;
6103 if (! EQ (d1->minibuf_selected_window, d2->minibuf_selected_window))
6104 return 0;
6106 /* Don't compare the root_window field.
6107 We don't require the two configurations
6108 to use the same window object,
6109 and the two root windows must be equivalent
6110 if everything else compares equal. */
6111 if (! EQ (d1->focus_frame, d2->focus_frame))
6112 return 0;
6113 if (! EQ (d1->min_width, d2->min_width))
6114 return 0;
6115 if (! EQ (d1->min_height, d2->min_height))
6116 return 0;
6118 /* Verify that the two confis have the same number of windows. */
6119 if (sw1->size != sw2->size)
6120 return 0;
6122 for (i = 0; i < sw1->size; i++)
6124 struct saved_window *p1, *p2;
6125 int w1_is_current, w2_is_current;
6127 p1 = SAVED_WINDOW_N (sw1, i);
6128 p2 = SAVED_WINDOW_N (sw2, i);
6130 /* Verify that the current windows in the two
6131 configurations correspond to each other. */
6132 w1_is_current = EQ (d1->current_window, p1->window);
6133 w2_is_current = EQ (d2->current_window, p2->window);
6135 if (w1_is_current != w2_is_current)
6136 return 0;
6138 /* Verify that the corresponding windows do match. */
6139 if (! EQ (p1->buffer, p2->buffer))
6140 return 0;
6141 if (! EQ (p1->left_col, p2->left_col))
6142 return 0;
6143 if (! EQ (p1->top_line, p2->top_line))
6144 return 0;
6145 if (! EQ (p1->total_cols, p2->total_cols))
6146 return 0;
6147 if (! EQ (p1->total_lines, p2->total_lines))
6148 return 0;
6149 if (! EQ (p1->display_table, p2->display_table))
6150 return 0;
6151 if (! EQ (p1->parent, p2->parent))
6152 return 0;
6153 if (! EQ (p1->prev, p2->prev))
6154 return 0;
6155 if (! ignore_positions)
6157 if (! EQ (p1->hscroll, p2->hscroll))
6158 return 0;
6159 if (!EQ (p1->min_hscroll, p2->min_hscroll))
6160 return 0;
6161 if (! EQ (p1->start_at_line_beg, p2->start_at_line_beg))
6162 return 0;
6163 if (NILP (Fequal (p1->start, p2->start)))
6164 return 0;
6165 if (NILP (Fequal (p1->pointm, p2->pointm)))
6166 return 0;
6167 if (NILP (Fequal (p1->mark, p2->mark)))
6168 return 0;
6170 if (! EQ (p1->left_margin_cols, p2->left_margin_cols))
6171 return 0;
6172 if (! EQ (p1->right_margin_cols, p2->right_margin_cols))
6173 return 0;
6174 if (! EQ (p1->left_fringe_width, p2->left_fringe_width))
6175 return 0;
6176 if (! EQ (p1->right_fringe_width, p2->right_fringe_width))
6177 return 0;
6178 if (! EQ (p1->fringes_outside_margins, p2->fringes_outside_margins))
6179 return 0;
6180 if (! EQ (p1->scroll_bar_width, p2->scroll_bar_width))
6181 return 0;
6182 if (! EQ (p1->vertical_scroll_bar_type, p2->vertical_scroll_bar_type))
6183 return 0;
6186 return 1;
6189 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
6190 Scompare_window_configurations, 2, 2, 0,
6191 doc: /* Compare two window configurations as regards the structure of windows.
6192 This function ignores details such as the values of point and mark
6193 and scrolling positions. */)
6194 (x, y)
6195 Lisp_Object x, y;
6197 if (compare_window_configurations (x, y, 1))
6198 return Qt;
6199 return Qnil;
6202 void
6203 init_window_once ()
6205 struct frame *f = make_terminal_frame ();
6206 XSETFRAME (selected_frame, f);
6207 Vterminal_frame = selected_frame;
6208 minibuf_window = f->minibuffer_window;
6209 selected_window = f->selected_window;
6210 last_nonminibuf_frame = f;
6212 window_initialized = 1;
6215 void
6216 init_window ()
6218 Vwindow_list = Qnil;
6221 void
6222 syms_of_window ()
6224 Qwindow_size_fixed = intern ("window-size-fixed");
6225 staticpro (&Qwindow_size_fixed);
6227 staticpro (&Qwindow_configuration_change_hook);
6228 Qwindow_configuration_change_hook
6229 = intern ("window-configuration-change-hook");
6231 Qwindowp = intern ("windowp");
6232 staticpro (&Qwindowp);
6234 Qwindow_configuration_p = intern ("window-configuration-p");
6235 staticpro (&Qwindow_configuration_p);
6237 Qwindow_live_p = intern ("window-live-p");
6238 staticpro (&Qwindow_live_p);
6240 Qtemp_buffer_show_hook = intern ("temp-buffer-show-hook");
6241 staticpro (&Qtemp_buffer_show_hook);
6243 staticpro (&Vwindow_list);
6245 minibuf_selected_window = Qnil;
6246 staticpro (&minibuf_selected_window);
6248 DEFVAR_LISP ("temp-buffer-show-function", &Vtemp_buffer_show_function,
6249 doc: /* Non-nil means call as function to display a help buffer.
6250 The function is called with one argument, the buffer to be displayed.
6251 Used by `with-output-to-temp-buffer'.
6252 If this function is used, then it must do the entire job of showing
6253 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
6254 Vtemp_buffer_show_function = Qnil;
6256 DEFVAR_LISP ("display-buffer-function", &Vdisplay_buffer_function,
6257 doc: /* If non-nil, function to call to handle `display-buffer'.
6258 It will receive two args, the buffer and a flag which if non-nil means
6259 that the currently selected window is not acceptable.
6260 Commands such as `switch-to-buffer-other-window' and `find-file-other-window'
6261 work using this function. */);
6262 Vdisplay_buffer_function = Qnil;
6264 DEFVAR_LISP ("even-window-heights", &Veven_window_heights,
6265 doc: /* *If non-nil, `display-buffer' should even the window heights.
6266 If nil, `display-buffer' will leave the window configuration alone. */);
6267 Veven_window_heights = Qt;
6269 DEFVAR_LISP ("minibuffer-scroll-window", &Vminibuf_scroll_window,
6270 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
6271 Vminibuf_scroll_window = Qnil;
6273 DEFVAR_BOOL ("mode-line-in-non-selected-windows", &mode_line_in_non_selected_windows,
6274 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
6275 If the minibuffer is active, the `minibuffer-scroll-window' mode line
6276 is displayed in the `mode-line' face. */);
6277 mode_line_in_non_selected_windows = 1;
6279 DEFVAR_LISP ("other-window-scroll-buffer", &Vother_window_scroll_buffer,
6280 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
6281 Vother_window_scroll_buffer = Qnil;
6283 DEFVAR_BOOL ("pop-up-frames", &pop_up_frames,
6284 doc: /* *Non-nil means `display-buffer' should make a separate frame. */);
6285 pop_up_frames = 0;
6287 DEFVAR_BOOL ("display-buffer-reuse-frames", &display_buffer_reuse_frames,
6288 doc: /* *Non-nil means `display-buffer' should reuse frames.
6289 If the buffer in question is already displayed in a frame, raise that frame. */);
6290 display_buffer_reuse_frames = 0;
6292 DEFVAR_LISP ("pop-up-frame-function", &Vpop_up_frame_function,
6293 doc: /* Function to call to handle automatic new frame creation.
6294 It is called with no arguments and should return a newly created frame.
6296 A typical value might be `(lambda () (new-frame pop-up-frame-alist))'
6297 where `pop-up-frame-alist' would hold the default frame parameters. */);
6298 Vpop_up_frame_function = Qnil;
6300 DEFVAR_LISP ("special-display-buffer-names", &Vspecial_display_buffer_names,
6301 doc: /* *List of buffer names that should have their own special frames.
6302 Displaying a buffer whose name is in this list makes a special frame for it
6303 using `special-display-function'. See also `special-display-regexps'.
6305 An element of the list can be a list instead of just a string.
6306 There are two ways to use a list as an element:
6307 (BUFFER FRAME-PARAMETERS...) (BUFFER FUNCTION OTHER-ARGS...)
6308 In the first case, FRAME-PARAMETERS are used to create the frame.
6309 In the latter case, FUNCTION is called with BUFFER as the first argument,
6310 followed by OTHER-ARGS--it can display BUFFER in any way it likes.
6311 All this is done by the function found in `special-display-function'.
6313 If this variable appears \"not to work\", because you add a name to it
6314 but that buffer still appears in the selected window, look at the
6315 values of `same-window-buffer-names' and `same-window-regexps'.
6316 Those variables take precedence over this one. */);
6317 Vspecial_display_buffer_names = Qnil;
6319 DEFVAR_LISP ("special-display-regexps", &Vspecial_display_regexps,
6320 doc: /* *List of regexps saying which buffers should have their own special frames.
6321 If a buffer name matches one of these regexps, it gets its own frame.
6322 Displaying a buffer whose name is in this list makes a special frame for it
6323 using `special-display-function'.
6325 An element of the list can be a list instead of just a string.
6326 There are two ways to use a list as an element:
6327 (REGEXP FRAME-PARAMETERS...) (REGEXP FUNCTION OTHER-ARGS...)
6328 In the first case, FRAME-PARAMETERS are used to create the frame.
6329 In the latter case, FUNCTION is called with the buffer as first argument,
6330 followed by OTHER-ARGS--it can display the buffer in any way it likes.
6331 All this is done by the function found in `special-display-function'.
6333 If this variable appears \"not to work\", because you add a regexp to it
6334 but the matching buffers still appear in the selected window, look at the
6335 values of `same-window-buffer-names' and `same-window-regexps'.
6336 Those variables take precedence over this one. */);
6337 Vspecial_display_regexps = Qnil;
6339 DEFVAR_LISP ("special-display-function", &Vspecial_display_function,
6340 doc: /* Function to call to make a new frame for a special buffer.
6341 It is called with two arguments, the buffer and optional buffer specific
6342 data, and should return a window displaying that buffer.
6343 The default value normally makes a separate frame for the buffer,
6344 using `special-display-frame-alist' to specify the frame parameters.
6345 But if the buffer specific data includes (same-buffer . t) then the
6346 buffer is displayed in the current selected window.
6347 Otherwise if it includes (same-frame . t) then the buffer is displayed in
6348 a new window in the currently selected frame.
6350 A buffer is special if it is listed in `special-display-buffer-names'
6351 or matches a regexp in `special-display-regexps'. */);
6352 Vspecial_display_function = Qnil;
6354 DEFVAR_LISP ("same-window-buffer-names", &Vsame_window_buffer_names,
6355 doc: /* *List of buffer names that should appear in the selected window.
6356 Displaying one of these buffers using `display-buffer' or `pop-to-buffer'
6357 switches to it in the selected window, rather than making it appear
6358 in some other window.
6360 An element of the list can be a cons cell instead of just a string.
6361 Then the car must be a string, which specifies the buffer name.
6362 This is for compatibility with `special-display-buffer-names';
6363 the cdr of the cons cell is ignored.
6365 See also `same-window-regexps'. */);
6366 Vsame_window_buffer_names = Qnil;
6368 DEFVAR_LISP ("same-window-regexps", &Vsame_window_regexps,
6369 doc: /* *List of regexps saying which buffers should appear in the selected window.
6370 If a buffer name matches one of these regexps, then displaying it
6371 using `display-buffer' or `pop-to-buffer' switches to it
6372 in the selected window, rather than making it appear in some other window.
6374 An element of the list can be a cons cell instead of just a string.
6375 Then the car must be a string, which specifies the buffer name.
6376 This is for compatibility with `special-display-buffer-names';
6377 the cdr of the cons cell is ignored.
6379 See also `same-window-buffer-names'. */);
6380 Vsame_window_regexps = Qnil;
6382 DEFVAR_BOOL ("pop-up-windows", &pop_up_windows,
6383 doc: /* *Non-nil means display-buffer should make new windows. */);
6384 pop_up_windows = 1;
6386 DEFVAR_INT ("next-screen-context-lines", &next_screen_context_lines,
6387 doc: /* *Number of lines of continuity when scrolling by screenfuls. */);
6388 next_screen_context_lines = 2;
6390 DEFVAR_INT ("split-height-threshold", &split_height_threshold,
6391 doc: /* *display-buffer would prefer to split the largest window if this large.
6392 If there is only one window, it is split regardless of this value. */);
6393 split_height_threshold = 500;
6395 DEFVAR_INT ("window-min-height", &window_min_height,
6396 doc: /* *Delete any window less than this tall (including its mode line). */);
6397 window_min_height = 4;
6399 DEFVAR_INT ("window-min-width", &window_min_width,
6400 doc: /* *Delete any window less than this wide. */);
6401 window_min_width = 10;
6403 DEFVAR_LISP ("scroll-preserve-screen-position",
6404 &Vscroll_preserve_screen_position,
6405 doc: /* *Non-nil means scroll commands move point to keep its screen line unchanged. */);
6406 Vscroll_preserve_screen_position = Qnil;
6408 DEFVAR_LISP ("window-configuration-change-hook",
6409 &Vwindow_configuration_change_hook,
6410 doc: /* Functions to call when window configuration changes.
6411 The selected frame is the one whose configuration has changed. */);
6412 Vwindow_configuration_change_hook = Qnil;
6414 DEFVAR_BOOL ("window-size-fixed", &window_size_fixed,
6415 doc: /* Non-nil in a buffer means windows displaying the buffer are fixed-size.
6416 Emacs won't change the size of any window displaying that buffer,
6417 unless you explicitly change the size, or Emacs has no other choice.
6418 This variable automatically becomes buffer-local when set. */);
6419 Fmake_variable_buffer_local (Qwindow_size_fixed);
6420 window_size_fixed = 0;
6422 defsubr (&Sselected_window);
6423 defsubr (&Sminibuffer_window);
6424 defsubr (&Swindow_minibuffer_p);
6425 defsubr (&Swindowp);
6426 defsubr (&Swindow_live_p);
6427 defsubr (&Spos_visible_in_window_p);
6428 defsubr (&Swindow_buffer);
6429 defsubr (&Swindow_height);
6430 defsubr (&Swindow_width);
6431 defsubr (&Swindow_hscroll);
6432 defsubr (&Sset_window_hscroll);
6433 defsubr (&Swindow_redisplay_end_trigger);
6434 defsubr (&Sset_window_redisplay_end_trigger);
6435 defsubr (&Swindow_edges);
6436 defsubr (&Swindow_pixel_edges);
6437 defsubr (&Swindow_inside_edges);
6438 defsubr (&Swindow_inside_pixel_edges);
6439 defsubr (&Scoordinates_in_window_p);
6440 defsubr (&Swindow_at);
6441 defsubr (&Swindow_point);
6442 defsubr (&Swindow_start);
6443 defsubr (&Swindow_end);
6444 defsubr (&Sset_window_point);
6445 defsubr (&Sset_window_start);
6446 defsubr (&Swindow_dedicated_p);
6447 defsubr (&Sset_window_dedicated_p);
6448 defsubr (&Swindow_display_table);
6449 defsubr (&Sset_window_display_table);
6450 defsubr (&Snext_window);
6451 defsubr (&Sprevious_window);
6452 defsubr (&Sother_window);
6453 defsubr (&Sget_lru_window);
6454 defsubr (&Sget_largest_window);
6455 defsubr (&Sget_buffer_window);
6456 defsubr (&Sdelete_other_windows);
6457 defsubr (&Sdelete_windows_on);
6458 defsubr (&Sreplace_buffer_in_windows);
6459 defsubr (&Sdelete_window);
6460 defsubr (&Sset_window_buffer);
6461 defsubr (&Sselect_window);
6462 defsubr (&Sspecial_display_p);
6463 defsubr (&Ssame_window_p);
6464 defsubr (&Sdisplay_buffer);
6465 defsubr (&Ssplit_window);
6466 defsubr (&Senlarge_window);
6467 defsubr (&Sshrink_window);
6468 defsubr (&Sscroll_up);
6469 defsubr (&Sscroll_down);
6470 defsubr (&Sscroll_left);
6471 defsubr (&Sscroll_right);
6472 defsubr (&Sother_window_for_scrolling);
6473 defsubr (&Sscroll_other_window);
6474 defsubr (&Sminibuffer_selected_window);
6475 defsubr (&Srecenter);
6476 defsubr (&Swindow_text_height);
6477 defsubr (&Smove_to_window_line);
6478 defsubr (&Swindow_configuration_p);
6479 defsubr (&Swindow_configuration_frame);
6480 defsubr (&Sset_window_configuration);
6481 defsubr (&Scurrent_window_configuration);
6482 defsubr (&Ssave_window_excursion);
6483 defsubr (&Sset_window_margins);
6484 defsubr (&Swindow_margins);
6485 defsubr (&Sset_window_fringes);
6486 defsubr (&Swindow_fringes);
6487 defsubr (&Sset_window_scroll_bars);
6488 defsubr (&Swindow_scroll_bars);
6489 defsubr (&Swindow_vscroll);
6490 defsubr (&Sset_window_vscroll);
6491 defsubr (&Scompare_window_configurations);
6492 defsubr (&Swindow_list);
6495 void
6496 keys_of_window ()
6498 initial_define_key (control_x_map, '1', "delete-other-windows");
6499 initial_define_key (control_x_map, '2', "split-window");
6500 initial_define_key (control_x_map, '0', "delete-window");
6501 initial_define_key (control_x_map, 'o', "other-window");
6502 initial_define_key (control_x_map, '^', "enlarge-window");
6503 initial_define_key (control_x_map, '<', "scroll-left");
6504 initial_define_key (control_x_map, '>', "scroll-right");
6506 initial_define_key (global_map, Ctl ('V'), "scroll-up");
6507 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
6508 initial_define_key (meta_map, 'v', "scroll-down");
6510 initial_define_key (global_map, Ctl('L'), "recenter");
6511 initial_define_key (meta_map, 'r', "move-to-window-line");
6514 /* arch-tag: 90a9c576-0590-48f1-a5f1-6c96a0452d9f
6515 (do not change this comment) */