Don't say "X Windows". From Colin Walters <walters@cis.ohio-state.edu>.
[emacs.git] / src / window.c
blob87b2c59ddb2fbbba7a1d2b38f4bab9a0b6cddd03
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
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 "frame.h"
28 #include "window.h"
29 #include "commands.h"
30 #include "indent.h"
31 #include "termchar.h"
32 #include "disptab.h"
33 #include "dispextern.h"
34 #include "blockinput.h"
35 #include "intervals.h"
37 #ifdef HAVE_X_WINDOWS
38 #include "xterm.h"
39 #endif /* HAVE_X_WINDOWS */
40 #ifdef WINDOWSNT
41 #include "w32term.h"
42 #endif
43 #ifdef MSDOS
44 #include "msdos.h"
45 #endif
46 #ifdef macintosh
47 #include "macterm.h"
48 #endif
50 #ifndef max
51 #define max(a, b) ((a) < (b) ? (b) : (a))
52 #endif
55 Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
56 Lisp_Object Qwindow_size_fixed, Qleft_bitmap_area, Qright_bitmap_area;
57 extern Lisp_Object Qheight, Qwidth;
59 static struct window *decode_window P_ ((Lisp_Object));
60 static Lisp_Object select_window_1 P_ ((Lisp_Object, int));
61 static int count_windows P_ ((struct window *));
62 static int get_leaf_windows P_ ((struct window *, struct window **, int));
63 static void window_scroll P_ ((Lisp_Object, int, int, int));
64 static void window_scroll_pixel_based P_ ((Lisp_Object, int, int, int));
65 static void window_scroll_line_based P_ ((Lisp_Object, int, int, int));
66 static int window_min_size_1 P_ ((struct window *, int));
67 static int window_min_size P_ ((struct window *, int, int, int *));
68 static void size_window P_ ((Lisp_Object, int, int, int));
69 static int freeze_window_start P_ ((struct window *, void *));
70 static int window_fixed_size_p P_ ((struct window *, int, int));
71 static void enlarge_window P_ ((Lisp_Object, int, int));
72 static Lisp_Object window_list P_ ((void));
73 static int add_window_to_list P_ ((struct window *, void *));
74 static int candidate_window_p P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
75 Lisp_Object));
76 static Lisp_Object next_window P_ ((Lisp_Object, Lisp_Object,
77 Lisp_Object, int));
78 static void decode_next_window_args P_ ((Lisp_Object *, Lisp_Object *,
79 Lisp_Object *));
80 static int foreach_window_1 P_ ((struct window *,
81 int (* fn) (struct window *, void *),
82 void *));
83 static Lisp_Object window_list_1 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
85 /* This is the window in which the terminal's cursor should
86 be left when nothing is being done with it. This must
87 always be a leaf window, and its buffer is selected by
88 the top level editing loop at the end of each command.
90 This value is always the same as
91 FRAME_SELECTED_WINDOW (selected_frame). */
93 Lisp_Object selected_window;
95 /* A list of all windows for use by next_window and Fwindow_list.
96 Functions creating or deleting windows should invalidate this cache
97 by setting it to nil. */
99 Lisp_Object Vwindow_list;
101 /* The mini-buffer window of the selected frame.
102 Note that you cannot test for mini-bufferness of an arbitrary window
103 by comparing against this; but you can test for mini-bufferness of
104 the selected window. */
106 Lisp_Object minibuf_window;
108 /* Non-nil means it is the window for C-M-v to scroll
109 when the mini-buffer is selected. */
111 Lisp_Object Vminibuf_scroll_window;
113 /* Non-nil means this is the buffer whose window C-M-v should scroll. */
115 Lisp_Object Vother_window_scroll_buffer;
117 /* Non-nil means it's function to call to display temp buffers. */
119 Lisp_Object Vtemp_buffer_show_function;
121 /* If a window gets smaller than either of these, it is removed. */
123 int window_min_height;
124 int window_min_width;
126 /* Nonzero implies Fdisplay_buffer should create windows. */
128 int pop_up_windows;
130 /* Nonzero implies make new frames for Fdisplay_buffer. */
132 int pop_up_frames;
134 /* Nonzero means reuse existing frames for displaying buffers. */
136 int display_buffer_reuse_frames;
138 /* Non-nil means use this function instead of default */
140 Lisp_Object Vpop_up_frame_function;
142 /* Function to call to handle Fdisplay_buffer. */
144 Lisp_Object Vdisplay_buffer_function;
146 /* Non-nil means that Fdisplay_buffer should even the heights of windows. */
148 Lisp_Object Veven_window_heights;
150 /* List of buffer *names* for buffers that should have their own frames. */
152 Lisp_Object Vspecial_display_buffer_names;
154 /* List of regexps for buffer names that should have their own frames. */
156 Lisp_Object Vspecial_display_regexps;
158 /* Function to pop up a special frame. */
160 Lisp_Object Vspecial_display_function;
162 /* List of buffer *names* for buffers to appear in selected window. */
164 Lisp_Object Vsame_window_buffer_names;
166 /* List of regexps for buffer names to appear in selected window. */
168 Lisp_Object Vsame_window_regexps;
170 /* Hook run at end of temp_output_buffer_show. */
172 Lisp_Object Qtemp_buffer_show_hook;
174 /* Fdisplay_buffer always splits the largest window
175 if that window is more than this high. */
177 int split_height_threshold;
179 /* Number of lines of continuity in scrolling by screenfuls. */
181 int next_screen_context_lines;
183 /* Incremented for each window created. */
185 static int sequence_number;
187 /* Nonzero after init_window_once has finished. */
189 static int window_initialized;
191 /* Hook to run when window config changes. */
193 Lisp_Object Qwindow_configuration_change_hook;
194 Lisp_Object Vwindow_configuration_change_hook;
196 /* Nonzero means scroll commands try to put point
197 at the same screen height as previously. */
199 Lisp_Object Vscroll_preserve_screen_position;
201 #if 0 /* This isn't used anywhere. */
202 /* Nonzero means we can split a frame even if it is "unsplittable". */
203 static int inhibit_frame_unsplittable;
204 #endif /* 0 */
206 #define min(a, b) ((a) < (b) ? (a) : (b))
208 extern int scroll_margin;
210 extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
212 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
213 "Returns t if OBJECT is a window.")
214 (object)
215 Lisp_Object object;
217 return WINDOWP (object) ? Qt : Qnil;
220 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
221 "Returns t if OBJECT is a window which is currently visible.")
222 (object)
223 Lisp_Object object;
225 return (WINDOWP (object) && ! NILP (XWINDOW (object)->buffer) ? Qt : Qnil);
228 Lisp_Object
229 make_window ()
231 Lisp_Object val;
232 register struct window *p;
233 register struct Lisp_Vector *vec;
234 int i;
236 vec = allocate_vectorlike ((EMACS_INT) VECSIZE (struct window));
237 for (i = 0; i < VECSIZE (struct window); i++)
238 vec->contents[i] = Qnil;
239 vec->size = VECSIZE (struct window);
240 p = (struct window *) vec;
241 XSETFASTINT (p->sequence_number, ++sequence_number);
242 XSETFASTINT (p->left, 0);
243 XSETFASTINT (p->top, 0);
244 XSETFASTINT (p->height, 0);
245 XSETFASTINT (p->width, 0);
246 XSETFASTINT (p->hscroll, 0);
247 XSETFASTINT (p->min_hscroll, 0);
248 p->orig_top = p->orig_height = Qnil;
249 p->start = Fmake_marker ();
250 p->pointm = Fmake_marker ();
251 XSETFASTINT (p->use_time, 0);
252 p->frame = Qnil;
253 p->display_table = Qnil;
254 p->dedicated = Qnil;
255 p->pseudo_window_p = 0;
256 bzero (&p->cursor, sizeof (p->cursor));
257 bzero (&p->last_cursor, sizeof (p->last_cursor));
258 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
259 p->desired_matrix = p->current_matrix = 0;
260 p->phys_cursor_type = -1;
261 p->must_be_updated_p = 0;
262 XSETFASTINT (p->window_end_vpos, 0);
263 XSETFASTINT (p->window_end_pos, 0);
264 p->window_end_valid = Qnil;
265 p->vscroll = 0;
266 XSETWINDOW (val, p);
267 XSETFASTINT (p->last_point, 0);
268 p->frozen_window_start_p = 0;
270 Vwindow_list = Qnil;
271 return val;
274 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
275 "Return the window that the cursor now appears in and commands apply to.")
278 return selected_window;
281 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
282 "Return the window used now for minibuffers.\n\
283 If the optional argument FRAME is specified, return the minibuffer window\n\
284 used by that frame.")
285 (frame)
286 Lisp_Object frame;
288 if (NILP (frame))
289 frame = selected_frame;
290 CHECK_LIVE_FRAME (frame, 0);
291 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
294 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
295 "Returns non-nil if WINDOW is a minibuffer window.")
296 (window)
297 Lisp_Object window;
299 struct window *w = decode_window (window);
300 return MINI_WINDOW_P (w) ? Qt : Qnil;
304 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
305 Spos_visible_in_window_p, 0, 3, 0,
306 "Return t if position POS is currently on the frame in WINDOW.\n\
307 Return nil if that position is scrolled vertically out of view.\n\
308 If a character is only partially visible, nil is returned, unless the\n\
309 optional argument PARTIALLY is non-nil.\n\
310 POS defaults to point in WINDOW; WINDOW defaults to the selected window.")
311 (pos, window, partially)
312 Lisp_Object pos, window, partially;
314 register struct window *w;
315 register int posint;
316 register struct buffer *buf;
317 struct text_pos top;
318 Lisp_Object in_window;
319 int fully_p;
321 w = decode_window (window);
322 buf = XBUFFER (w->buffer);
323 SET_TEXT_POS_FROM_MARKER (top, w->start);
325 if (!NILP (pos))
327 CHECK_NUMBER_COERCE_MARKER (pos, 0);
328 posint = XINT (pos);
330 else if (w == XWINDOW (selected_window))
331 posint = PT;
332 else
333 posint = XMARKER (w->pointm)->charpos;
335 /* If position is above window start, it's not visible. */
336 if (posint < CHARPOS (top))
337 in_window = Qnil;
338 else if (XFASTINT (w->last_modified) >= BUF_MODIFF (buf)
339 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (buf)
340 && posint < BUF_Z (buf) - XFASTINT (w->window_end_pos))
342 /* If frame is up-to-date, and POSINT is < window end pos, use
343 that info. This doesn't work for POSINT == end pos, because
344 the window end pos is actually the position _after_ the last
345 char in the window. */
346 if (NILP (partially))
348 pos_visible_p (w, posint, &fully_p, NILP (partially));
349 in_window = fully_p ? Qt : Qnil;
351 else
352 in_window = Qt;
354 else if (posint > BUF_ZV (buf))
355 in_window = Qnil;
356 else if (CHARPOS (top) < BUF_BEGV (buf) || CHARPOS (top) > BUF_ZV (buf))
357 /* If window start is out of range, do something reasonable. */
358 in_window = Qnil;
359 else
361 if (pos_visible_p (w, posint, &fully_p, NILP (partially)))
362 in_window = !NILP (partially) || fully_p ? Qt : Qnil;
363 else
364 in_window = Qnil;
367 return in_window;
371 static struct window *
372 decode_window (window)
373 register Lisp_Object window;
375 if (NILP (window))
376 return XWINDOW (selected_window);
378 CHECK_LIVE_WINDOW (window, 0);
379 return XWINDOW (window);
382 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
383 "Return the buffer that WINDOW is displaying.")
384 (window)
385 Lisp_Object window;
387 return decode_window (window)->buffer;
390 DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
391 "Return the number of lines in WINDOW (including its mode line).")
392 (window)
393 Lisp_Object window;
395 return decode_window (window)->height;
398 DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
399 "Return the number of display columns in WINDOW.\n\
400 This is the width that is usable columns available for text in WINDOW.\n\
401 If you want to find out how many columns WINDOW takes up,\n\
402 use (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))).")
403 (window)
404 Lisp_Object window;
406 return make_number (window_internal_width (decode_window (window)));
409 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
410 "Return the number of columns by which WINDOW is scrolled from left margin.")
411 (window)
412 Lisp_Object window;
414 return decode_window (window)->hscroll;
417 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
418 "Set number of columns WINDOW is scrolled from left margin to NCOL.\n\
419 NCOL should be zero or positive.")
420 (window, ncol)
421 Lisp_Object window, ncol;
423 struct window *w = decode_window (window);
424 int hscroll;
426 CHECK_NUMBER (ncol, 1);
427 hscroll = max (0, XINT (ncol));
429 /* Prevent redisplay shortcuts when changing the hscroll. */
430 if (XINT (w->hscroll) != hscroll)
431 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
433 w->hscroll = w->min_hscroll = make_number (hscroll);
434 return ncol;
437 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
438 Swindow_redisplay_end_trigger, 0, 1, 0,
439 "Return WINDOW's redisplay end trigger value.\n\
440 See `set-window-redisplay-end-trigger' for more information.")
441 (window)
442 Lisp_Object window;
444 return decode_window (window)->redisplay_end_trigger;
447 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
448 Sset_window_redisplay_end_trigger, 2, 2, 0,
449 "Set WINDOW's redisplay end trigger value to VALUE.\n\
450 VALUE should be a buffer position (typically a marker) or nil.\n\
451 If it is a buffer position, then if redisplay in WINDOW reaches a position\n\
452 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called\n\
453 with two arguments: WINDOW, and the end trigger value.\n\
454 Afterwards the end-trigger value is reset to nil.")
455 (window, value)
456 register Lisp_Object window, value;
458 register struct window *w;
460 w = decode_window (window);
461 w->redisplay_end_trigger = value;
462 return value;
465 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
466 "Return a list of the edge coordinates of WINDOW.\n\
467 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.\n\
468 RIGHT is one more than the rightmost column used by WINDOW,\n\
469 and BOTTOM is one more than the bottommost row used by WINDOW\n\
470 and its mode-line.")
471 (window)
472 Lisp_Object window;
474 register struct window *w = decode_window (window);
476 return Fcons (w->left, Fcons (w->top,
477 Fcons (make_number (WINDOW_RIGHT_EDGE (w)),
478 Fcons (make_number (XFASTINT (w->top)
479 + XFASTINT (w->height)),
480 Qnil))));
483 /* Test if the character at column *X, row *Y is within window W.
484 If it is not, return 0;
485 if it is in the window's text area,
486 set *x and *y to its location relative to the upper left corner
487 of the window, and
488 return 1;
489 if it is on the window's modeline, return 2;
490 if it is on the border between the window and its right sibling,
491 return 3.
492 if it is on the window's top line, return 4;
493 if it is in the bitmap area to the left/right of the window,
494 return 5 or 6, and convert *X and *Y to window-relative corrdinates.
496 X and Y are frame relative pixel coordinates. */
498 static int
499 coordinates_in_window (w, x, y)
500 register struct window *w;
501 register int *x, *y;
503 /* Let's make this a global enum later, instead of using numbers
504 everywhere. */
505 enum {ON_NOTHING, ON_TEXT, ON_MODE_LINE, ON_VERTICAL_BORDER,
506 ON_HEADER_LINE, ON_LEFT_FRINGE, ON_RIGHT_FRINGE};
508 struct frame *f = XFRAME (WINDOW_FRAME (w));
509 int left_x, right_x, top_y, bottom_y;
510 int flags_area_width = FRAME_LEFT_FLAGS_AREA_WIDTH (f);
511 int part;
512 int ux = CANON_X_UNIT (f), uy = CANON_Y_UNIT (f);
513 int x0 = XFASTINT (w->left) * ux;
514 int x1 = x0 + XFASTINT (w->width) * ux;
516 if (*x < x0 || *x >= x1)
517 return ON_NOTHING;
519 /* In what's below, we subtract 1 when computing right_x because we
520 want the rightmost pixel, which is given by left_pixel+width-1. */
521 if (w->pseudo_window_p)
523 left_x = 0;
524 right_x = XFASTINT (w->width) * CANON_X_UNIT (f) - 1;
525 top_y = WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w);
526 bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
528 else
530 left_x = (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X (w)
531 - FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
532 right_x = WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X (w) - 1;
533 top_y = (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w)
534 - FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
535 bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
538 /* On the mode line or header line? If it's near the start of
539 the mode or header line of window that's has a horizontal
540 sibling, say it's on the vertical line. That's to be able
541 to resize windows horizontally in case we're using toolkit
542 scroll bars. */
544 if (WINDOW_WANTS_MODELINE_P (w)
545 && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
546 && *y < bottom_y)
548 /* We're somewhere on the mode line. We consider the place
549 between mode lines of horizontally adjacent mode lines
550 as the vertical border. If scroll bars on the left,
551 return the right window. */
552 part = ON_MODE_LINE;
554 if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
556 if (abs (*x - x0) < ux / 2)
557 part = ON_VERTICAL_BORDER;
559 else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < ux / 2)
560 part = ON_VERTICAL_BORDER;
562 else if (WINDOW_WANTS_HEADER_LINE_P (w)
563 && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
564 && *y >= top_y)
566 part = ON_HEADER_LINE;
568 if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
570 if (abs (*x - x0) < ux / 2)
571 part = ON_VERTICAL_BORDER;
573 else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < ux / 2)
574 part = ON_VERTICAL_BORDER;
576 /* Outside anything interesting? */
577 else if (*y < top_y
578 || *y >= bottom_y
579 || *x < (left_x
580 - flags_area_width
581 - FRAME_LEFT_SCROLL_BAR_WIDTH (f) * ux)
582 || *x > right_x + flags_area_width)
584 part = ON_NOTHING;
586 else if (FRAME_WINDOW_P (f))
588 if (!w->pseudo_window_p
589 && !FRAME_HAS_VERTICAL_SCROLL_BARS (f)
590 && !WINDOW_RIGHTMOST_P (w)
591 && (abs (*x - right_x - flags_area_width) < ux / 2))
593 part = ON_VERTICAL_BORDER;
595 else if (*x < left_x || *x > right_x)
597 /* Other lines than the mode line don't include flags areas and
598 scroll bars on the left. */
600 /* Convert X and Y to window-relative pixel coordinates. */
601 *x -= left_x;
602 *y -= top_y;
603 part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
605 else
607 *x -= left_x;
608 *y -= top_y;
609 part = ON_TEXT;
612 else
614 /* Need to say "*x > right_x" rather than >=, since on character
615 terminals, the vertical line's x coordinate is right_x. */
616 if (*x < left_x || *x > right_x)
618 /* Other lines than the mode line don't include flags areas and
619 scroll bars on the left. */
621 /* Convert X and Y to window-relative pixel coordinates. */
622 *x -= left_x;
623 *y -= top_y;
624 part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
626 /* Here, too, "*x > right_x" is because of character terminals. */
627 else if (!w->pseudo_window_p
628 && !WINDOW_RIGHTMOST_P (w)
629 && *x > right_x - ux)
631 /* On the border on the right side of the window? Assume that
632 this area begins at RIGHT_X minus a canonical char width. */
633 part = ON_VERTICAL_BORDER;
635 else
637 /* Convert X and Y to window-relative pixel coordinates. */
638 *x -= left_x;
639 *y -= top_y;
640 part = ON_TEXT;
644 return part;
648 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
649 Scoordinates_in_window_p, 2, 2, 0,
650 "Return non-nil if COORDINATES are in WINDOW.\n\
651 COORDINATES is a cons of the form (X . Y), X and Y being distances\n\
652 measured in characters from the upper-left corner of the frame.\n\
653 (0 . 0) denotes the character in the upper left corner of the\n\
654 frame.\n\
655 If COORDINATES are in the text portion of WINDOW,\n\
656 the coordinates relative to the window are returned.\n\
657 If they are in the mode line of WINDOW, `mode-line' is returned.\n\
658 If they are in the top mode line of WINDOW, `header-line' is returned.\n\
659 If they are in the bitmap-area to the left of the window,\n\
660 `left-bitmap-area' is returned, if they are in the area on the right of\n\
661 the window, `right-bitmap-area' is returned.\n\
662 If they are on the border between WINDOW and its right sibling,\n\
663 `vertical-line' is returned.")
664 (coordinates, window)
665 register Lisp_Object coordinates, window;
667 struct window *w;
668 struct frame *f;
669 int x, y;
670 Lisp_Object lx, ly;
672 CHECK_LIVE_WINDOW (window, 0);
673 w = XWINDOW (window);
674 f = XFRAME (w->frame);
675 CHECK_CONS (coordinates, 1);
676 lx = Fcar (coordinates);
677 ly = Fcdr (coordinates);
678 CHECK_NUMBER_OR_FLOAT (lx, 1);
679 CHECK_NUMBER_OR_FLOAT (ly, 1);
680 x = PIXEL_X_FROM_CANON_X (f, lx);
681 y = PIXEL_Y_FROM_CANON_Y (f, ly);
683 switch (coordinates_in_window (w, &x, &y))
685 case 0: /* NOT in window at all. */
686 return Qnil;
688 case 1: /* In text part of window. */
689 /* X and Y are now window relative pixel coordinates.
690 Convert them to canonical char units before returning
691 them. */
692 return Fcons (CANON_X_FROM_PIXEL_X (f, x),
693 CANON_Y_FROM_PIXEL_Y (f, y));
695 case 2: /* In mode line of window. */
696 return Qmode_line;
698 case 3: /* On right border of window. */
699 return Qvertical_line;
701 case 4:
702 return Qheader_line;
704 case 5:
705 return Qleft_bitmap_area;
707 case 6:
708 return Qright_bitmap_area;
710 default:
711 abort ();
716 /* Callback for foreach_window, used in window_from_coordinates.
717 Check if window W contains coordinates specified by USER_DATA which
718 is actually a pointer to a struct check_window_data CW.
720 Check if window W contains coordinates *CW->x and *CW->y. If it
721 does, return W in *CW->window, as Lisp_Object, and return in
722 *CW->part the part of the window under coordinates *X,*Y. Return
723 zero from this function to stop iterating over windows. */
725 struct check_window_data
727 Lisp_Object *window;
728 int *x, *y, *part;
731 static int
732 check_window_containing (w, user_data)
733 struct window *w;
734 void *user_data;
736 struct check_window_data *cw = (struct check_window_data *) user_data;
737 int found;
739 found = coordinates_in_window (w, cw->x, cw->y);
740 if (found)
742 *cw->part = found - 1;
743 XSETWINDOW (*cw->window, w);
746 return !found;
750 /* Find the window containing frame-relative pixel position X/Y and
751 return it as a Lisp_Object. If X, Y is on the window's modeline,
752 set *PART to 1; if it is on the separating line between the window
753 and its right sibling, set it to 2; otherwise set it to 0. If
754 there is no window under X, Y return nil and leave *PART
755 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
757 This function was previously implemented with a loop cycling over
758 windows with Fnext_window, and starting with the frame's selected
759 window. It turned out that this doesn't work with an
760 implementation of next_window using Vwindow_list, because
761 FRAME_SELECTED_WINDOW (F) is not always contained in the window
762 tree of F when this function is called asynchronously from
763 note_mouse_highlight. The original loop didn't terminate in this
764 case. */
766 Lisp_Object
767 window_from_coordinates (f, x, y, part, tool_bar_p)
768 struct frame *f;
769 int x, y;
770 int *part;
771 int tool_bar_p;
773 Lisp_Object window;
774 struct check_window_data cw;
776 window = Qnil;
777 cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
778 foreach_window (f, check_window_containing, &cw);
780 /* If not found above, see if it's in the tool bar window, if a tool
781 bar exists. */
782 if (NILP (window)
783 && tool_bar_p
784 && WINDOWP (f->tool_bar_window)
785 && XINT (XWINDOW (f->tool_bar_window)->height) > 0
786 && coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y))
788 *part = 0;
789 window = f->tool_bar_window;
792 return window;
795 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
796 "Return window containing coordinates X and Y on FRAME.\n\
797 If omitted, FRAME defaults to the currently selected frame.\n\
798 The top left corner of the frame is considered to be row 0,\n\
799 column 0.")
800 (x, y, frame)
801 Lisp_Object x, y, frame;
803 int part;
804 struct frame *f;
806 if (NILP (frame))
807 frame = selected_frame;
808 CHECK_LIVE_FRAME (frame, 2);
809 f = XFRAME (frame);
811 /* Check that arguments are integers or floats. */
812 CHECK_NUMBER_OR_FLOAT (x, 0);
813 CHECK_NUMBER_OR_FLOAT (y, 1);
815 return window_from_coordinates (f,
816 PIXEL_X_FROM_CANON_X (f, x),
817 PIXEL_Y_FROM_CANON_Y (f, y),
818 &part, 0);
821 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
822 "Return current value of point in WINDOW.\n\
823 For a nonselected window, this is the value point would have\n\
824 if that window were selected.\n\
826 Note that, when WINDOW is the selected window and its buffer\n\
827 is also currently selected, the value returned is the same as (point).\n\
828 It would be more strictly correct to return the `top-level' value\n\
829 of point, outside of any save-excursion forms.\n\
830 But that is hard to define.")
831 (window)
832 Lisp_Object window;
834 register struct window *w = decode_window (window);
836 if (w == XWINDOW (selected_window)
837 && current_buffer == XBUFFER (w->buffer))
838 return Fpoint ();
839 return Fmarker_position (w->pointm);
842 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
843 "Return position at which display currently starts in WINDOW.\n\
844 This is updated by redisplay or by calling `set-window-start'.")
845 (window)
846 Lisp_Object window;
848 return Fmarker_position (decode_window (window)->start);
851 /* This is text temporarily removed from the doc string below.
853 This function returns nil if the position is not currently known.\n\
854 That happens when redisplay is preempted and doesn't finish.\n\
855 If in that case you want to compute where the end of the window would\n\
856 have been if redisplay had finished, do this:\n\
857 (save-excursion\n\
858 (goto-char (window-start window))\n\
859 (vertical-motion (1- (window-height window)) window)\n\
860 (point))") */
862 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
863 "Return position at which display currently ends in WINDOW.\n\
864 This is updated by redisplay, when it runs to completion.\n\
865 Simply changing the buffer text or setting `window-start'\n\
866 does not update this value.\n\
867 If UPDATE is non-nil, compute the up-to-date position\n\
868 if it isn't already recorded.")
869 (window, update)
870 Lisp_Object window, update;
872 Lisp_Object value;
873 struct window *w = decode_window (window);
874 Lisp_Object buf;
876 buf = w->buffer;
877 CHECK_BUFFER (buf, 0);
879 #if 0 /* This change broke some things. We should make it later. */
880 /* If we don't know the end position, return nil.
881 The user can compute it with vertical-motion if he wants to.
882 It would be nicer to do it automatically,
883 but that's so slow that it would probably bother people. */
884 if (NILP (w->window_end_valid))
885 return Qnil;
886 #endif
888 if (! NILP (update)
889 && ! (! NILP (w->window_end_valid)
890 && XFASTINT (w->last_modified) >= MODIFF))
892 struct text_pos startp;
893 struct it it;
895 /* In case W->start is out of the range, use something
896 reasonable. This situation occured when loading a file with
897 `-l' containing a call to `rmail' with subsequent other
898 commands. At the end, W->start happened to be BEG, while
899 rmail had already narrowed the buffer. */
900 if (XMARKER (w->start)->charpos < BEGV)
901 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
902 else if (XMARKER (w->start)->charpos > ZV)
903 SET_TEXT_POS (startp, ZV, ZV_BYTE);
904 else
905 SET_TEXT_POS_FROM_MARKER (startp, w->start);
907 /* Cannot use Fvertical_motion because that function doesn't
908 cope with variable-height lines. */
909 start_display (&it, w, startp);
910 move_it_vertically (&it, window_box_height (w));
911 move_it_past_eol (&it);
912 value = make_number (IT_CHARPOS (it));
914 else
915 XSETINT (value, BUF_Z (XBUFFER (buf)) - XFASTINT (w->window_end_pos));
917 return value;
920 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
921 "Make point value in WINDOW be at position POS in WINDOW's buffer.")
922 (window, pos)
923 Lisp_Object window, pos;
925 register struct window *w = decode_window (window);
927 CHECK_NUMBER_COERCE_MARKER (pos, 1);
928 if (w == XWINDOW (selected_window)
929 && XBUFFER (w->buffer) == current_buffer)
930 Fgoto_char (pos);
931 else
932 set_marker_restricted (w->pointm, pos, w->buffer);
934 /* We have to make sure that redisplay updates the window to show
935 the new value of point. */
936 if (!EQ (window, selected_window))
937 ++windows_or_buffers_changed;
939 return pos;
942 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
943 "Make display in WINDOW start at position POS in WINDOW's buffer.\n\
944 Optional third arg NOFORCE non-nil inhibits next redisplay\n\
945 from overriding motion of point in order to display at this exact start.")
946 (window, pos, noforce)
947 Lisp_Object window, pos, noforce;
949 register struct window *w = decode_window (window);
951 CHECK_NUMBER_COERCE_MARKER (pos, 1);
952 set_marker_restricted (w->start, pos, w->buffer);
953 /* this is not right, but much easier than doing what is right. */
954 w->start_at_line_beg = Qnil;
955 if (NILP (noforce))
956 w->force_start = Qt;
957 w->update_mode_line = Qt;
958 XSETFASTINT (w->last_modified, 0);
959 XSETFASTINT (w->last_overlay_modified, 0);
960 if (!EQ (window, selected_window))
961 windows_or_buffers_changed++;
963 return pos;
966 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
967 1, 1, 0,
968 "Return WINDOW's dedicated object, usually t or nil.\n\
969 See also `set-window-dedicated-p'.")
970 (window)
971 Lisp_Object window;
973 return decode_window (window)->dedicated;
976 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
977 Sset_window_dedicated_p, 2, 2, 0,
978 "Control whether WINDOW is dedicated to the buffer it displays.\n\
979 If it is dedicated, Emacs will not automatically change\n\
980 which buffer appears in it.\n\
981 The second argument is the new value for the dedication flag;\n\
982 non-nil means yes.")
983 (window, arg)
984 Lisp_Object window, arg;
986 register struct window *w = decode_window (window);
988 if (NILP (arg))
989 w->dedicated = Qnil;
990 else
991 w->dedicated = Qt;
993 return w->dedicated;
996 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
997 0, 1, 0,
998 "Return the display-table that WINDOW is using.")
999 (window)
1000 Lisp_Object window;
1002 return decode_window (window)->display_table;
1005 /* Get the display table for use on window W. This is either W's
1006 display table or W's buffer's display table. Ignore the specified
1007 tables if they are not valid; if no valid table is specified,
1008 return 0. */
1010 struct Lisp_Char_Table *
1011 window_display_table (w)
1012 struct window *w;
1014 struct Lisp_Char_Table *dp = NULL;
1016 if (DISP_TABLE_P (w->display_table))
1017 dp = XCHAR_TABLE (w->display_table);
1018 else if (BUFFERP (w->buffer))
1020 struct buffer *b = XBUFFER (w->buffer);
1022 if (DISP_TABLE_P (b->display_table))
1023 dp = XCHAR_TABLE (b->display_table);
1024 else if (DISP_TABLE_P (Vstandard_display_table))
1025 dp = XCHAR_TABLE (Vstandard_display_table);
1028 return dp;
1031 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1032 "Set WINDOW's display-table to TABLE.")
1033 (window, table)
1034 register Lisp_Object window, table;
1036 register struct window *w;
1038 w = decode_window (window);
1039 w->display_table = table;
1040 return table;
1043 /* Record info on buffer window w is displaying
1044 when it is about to cease to display that buffer. */
1045 static void
1046 unshow_buffer (w)
1047 register struct window *w;
1049 Lisp_Object buf;
1050 struct buffer *b;
1052 buf = w->buffer;
1053 b = XBUFFER (buf);
1054 if (b != XMARKER (w->pointm)->buffer)
1055 abort ();
1057 #if 0
1058 if (w == XWINDOW (selected_window)
1059 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1060 /* Do this except when the selected window's buffer
1061 is being removed from some other window. */
1062 #endif
1063 /* last_window_start records the start position that this buffer
1064 had in the last window to be disconnected from it.
1065 Now that this statement is unconditional,
1066 it is possible for the buffer to be displayed in the
1067 selected window, while last_window_start reflects another
1068 window which was recently showing the same buffer.
1069 Some people might say that might be a good thing. Let's see. */
1070 b->last_window_start = marker_position (w->start);
1072 /* Point in the selected window's buffer
1073 is actually stored in that buffer, and the window's pointm isn't used.
1074 So don't clobber point in that buffer. */
1075 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1076 /* This line helps to fix Horsley's testbug.el bug. */
1077 && !(WINDOWP (b->last_selected_window)
1078 && w != XWINDOW (b->last_selected_window)
1079 && EQ (buf, XWINDOW (b->last_selected_window)->buffer)))
1080 temp_set_point_both (b,
1081 clip_to_bounds (BUF_BEGV (b),
1082 XMARKER (w->pointm)->charpos,
1083 BUF_ZV (b)),
1084 clip_to_bounds (BUF_BEGV_BYTE (b),
1085 marker_byte_position (w->pointm),
1086 BUF_ZV_BYTE (b)));
1088 if (WINDOWP (b->last_selected_window)
1089 && w == XWINDOW (b->last_selected_window))
1090 b->last_selected_window = Qnil;
1093 /* Put replacement into the window structure in place of old. */
1094 static void
1095 replace_window (old, replacement)
1096 Lisp_Object old, replacement;
1098 register Lisp_Object tem;
1099 register struct window *o = XWINDOW (old), *p = XWINDOW (replacement);
1101 /* If OLD is its frame's root_window, then replacement is the new
1102 root_window for that frame. */
1104 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1105 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
1107 p->left = o->left;
1108 p->top = o->top;
1109 p->width = o->width;
1110 p->height = o->height;
1111 p->desired_matrix = p->current_matrix = 0;
1112 p->vscroll = 0;
1113 bzero (&p->cursor, sizeof (p->cursor));
1114 bzero (&p->last_cursor, sizeof (p->last_cursor));
1115 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
1116 p->phys_cursor_type = -1;
1117 p->must_be_updated_p = 0;
1118 p->pseudo_window_p = 0;
1119 XSETFASTINT (p->window_end_vpos, 0);
1120 XSETFASTINT (p->window_end_pos, 0);
1121 p->window_end_valid = Qnil;
1122 p->frozen_window_start_p = 0;
1123 p->orig_top = p->orig_height = Qnil;
1125 p->next = tem = o->next;
1126 if (!NILP (tem))
1127 XWINDOW (tem)->prev = replacement;
1129 p->prev = tem = o->prev;
1130 if (!NILP (tem))
1131 XWINDOW (tem)->next = replacement;
1133 p->parent = tem = o->parent;
1134 if (!NILP (tem))
1136 if (EQ (XWINDOW (tem)->vchild, old))
1137 XWINDOW (tem)->vchild = replacement;
1138 if (EQ (XWINDOW (tem)->hchild, old))
1139 XWINDOW (tem)->hchild = replacement;
1142 /*** Here, if replacement is a vertical combination
1143 and so is its new parent, we should make replacement's
1144 children be children of that parent instead. ***/
1147 DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
1148 "Remove WINDOW from the display. Default is selected window.")
1149 (window)
1150 register Lisp_Object window;
1152 delete_window (window);
1154 if (! NILP (Vwindow_configuration_change_hook)
1155 && ! NILP (Vrun_hooks))
1156 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
1158 return Qnil;
1161 void
1162 delete_window (window)
1163 register Lisp_Object window;
1165 register Lisp_Object tem, parent, sib;
1166 register struct window *p;
1167 register struct window *par;
1168 struct frame *f;
1170 /* Because this function is called by other C code on non-leaf
1171 windows, the CHECK_LIVE_WINDOW macro would choke inappropriately,
1172 so we can't decode_window here. */
1173 if (NILP (window))
1174 window = selected_window;
1175 else
1176 CHECK_WINDOW (window, 0);
1177 p = XWINDOW (window);
1179 /* It's okay to delete an already-deleted window. */
1180 if (NILP (p->buffer)
1181 && NILP (p->hchild)
1182 && NILP (p->vchild))
1183 return;
1185 parent = p->parent;
1186 if (NILP (parent))
1187 error ("Attempt to delete minibuffer or sole ordinary window");
1188 par = XWINDOW (parent);
1190 windows_or_buffers_changed++;
1191 Vwindow_list = Qnil;
1192 f = XFRAME (WINDOW_FRAME (p));
1193 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
1195 /* Are we trying to delete any frame's selected window? */
1197 Lisp_Object pwindow;
1199 /* See if the frame's selected window is either WINDOW
1200 or any subwindow of it, by finding all that window's parents
1201 and comparing each one with WINDOW. */
1202 pwindow = FRAME_SELECTED_WINDOW (f);
1204 while (!NILP (pwindow))
1206 if (EQ (window, pwindow))
1207 break;
1208 pwindow = XWINDOW (pwindow)->parent;
1211 if (EQ (window, pwindow))
1213 Lisp_Object alternative;
1214 alternative = Fnext_window (window, Qlambda, Qnil);
1216 /* If we're about to delete the selected window on the
1217 selected frame, then we should use Fselect_window to select
1218 the new window. On the other hand, if we're about to
1219 delete the selected window on any other frame, we shouldn't do
1220 anything but set the frame's selected_window slot. */
1221 if (EQ (window, selected_window))
1222 Fselect_window (alternative);
1223 else
1224 FRAME_SELECTED_WINDOW (f) = alternative;
1228 tem = p->buffer;
1229 /* tem is null for dummy parent windows
1230 (which have inferiors but not any contents themselves) */
1231 if (!NILP (tem))
1233 unshow_buffer (p);
1234 unchain_marker (p->pointm);
1235 unchain_marker (p->start);
1238 /* Free window glyph matrices. It is sure that they are allocated
1239 again when ADJUST_GLYPHS is called. Block input so that expose
1240 events and other events that access glyph matrices are not
1241 processed while we are changing them. */
1242 BLOCK_INPUT;
1243 free_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)));
1245 tem = p->next;
1246 if (!NILP (tem))
1247 XWINDOW (tem)->prev = p->prev;
1249 tem = p->prev;
1250 if (!NILP (tem))
1251 XWINDOW (tem)->next = p->next;
1253 if (EQ (window, par->hchild))
1254 par->hchild = p->next;
1255 if (EQ (window, par->vchild))
1256 par->vchild = p->next;
1258 /* Find one of our siblings to give our space to. */
1259 sib = p->prev;
1260 if (NILP (sib))
1262 /* If p gives its space to its next sibling, that sibling needs
1263 to have its top/left side pulled back to where p's is.
1264 set_window_{height,width} will re-position the sibling's
1265 children. */
1266 sib = p->next;
1267 XWINDOW (sib)->top = p->top;
1268 XWINDOW (sib)->left = p->left;
1271 /* Stretch that sibling. */
1272 if (!NILP (par->vchild))
1273 set_window_height (sib,
1274 XFASTINT (XWINDOW (sib)->height) + XFASTINT (p->height),
1276 if (!NILP (par->hchild))
1277 set_window_width (sib,
1278 XFASTINT (XWINDOW (sib)->width) + XFASTINT (p->width),
1281 /* If parent now has only one child,
1282 put the child into the parent's place. */
1283 tem = par->hchild;
1284 if (NILP (tem))
1285 tem = par->vchild;
1286 if (NILP (XWINDOW (tem)->next))
1287 replace_window (parent, tem);
1289 /* Since we may be deleting combination windows, we must make sure that
1290 not only p but all its children have been marked as deleted. */
1291 if (! NILP (p->hchild))
1292 delete_all_subwindows (XWINDOW (p->hchild));
1293 else if (! NILP (p->vchild))
1294 delete_all_subwindows (XWINDOW (p->vchild));
1296 /* Mark this window as deleted. */
1297 p->buffer = p->hchild = p->vchild = Qnil;
1299 /* Adjust glyph matrices. */
1300 adjust_glyphs (f);
1301 UNBLOCK_INPUT;
1306 /***********************************************************************
1307 Window List
1308 ***********************************************************************/
1310 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1311 pointer. This is a callback function for foreach_window, used in
1312 function window_list. */
1314 static int
1315 add_window_to_list (w, user_data)
1316 struct window *w;
1317 void *user_data;
1319 Lisp_Object *list = (Lisp_Object *) user_data;
1320 Lisp_Object window;
1321 XSETWINDOW (window, w);
1322 *list = Fcons (window, *list);
1323 return 1;
1327 /* Return a list of all windows, for use by next_window. If
1328 Vwindow_list is a list, return that list. Otherwise, build a new
1329 list, cache it in Vwindow_list, and return that. */
1331 static Lisp_Object
1332 window_list ()
1334 if (!CONSP (Vwindow_list))
1336 Lisp_Object tail;
1338 Vwindow_list = Qnil;
1339 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1341 Lisp_Object args[2];
1343 /* We are visiting windows in canonical order, and add
1344 new windows at the front of args[1], which means we
1345 have to reverse this list at the end. */
1346 args[1] = Qnil;
1347 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1348 args[0] = Vwindow_list;
1349 args[1] = Fnreverse (args[1]);
1350 Vwindow_list = Fnconc (2, args);
1354 return Vwindow_list;
1358 /* Value is non-zero if WINDOW satisfies the constraints given by
1359 OWINDOW, MINIBUF and ALL_FRAMES.
1361 MINIBUF t means WINDOW may be minibuffer windows.
1362 `lambda' means WINDOW may not be a minibuffer window.
1363 a window means a specific minibuffer window
1365 ALL_FRAMES t means search all frames,
1366 nil means search just current frame,
1367 `visible' means search just visible frames,
1368 0 means search visible and iconified frames,
1369 a window means search the frame that window belongs to,
1370 a frame means consider windows on that frame, only. */
1372 static int
1373 candidate_window_p (window, owindow, minibuf, all_frames)
1374 Lisp_Object window, owindow, minibuf, all_frames;
1376 struct window *w = XWINDOW (window);
1377 struct frame *f = XFRAME (w->frame);
1378 int candidate_p = 1;
1380 if (!BUFFERP (w->buffer))
1381 candidate_p = 0;
1382 else if (MINI_WINDOW_P (w)
1383 && (EQ (minibuf, Qlambda)
1384 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
1386 /* If MINIBUF is `lambda' don't consider any mini-windows.
1387 If it is a window, consider only that one. */
1388 candidate_p = 0;
1390 else if (EQ (all_frames, Qt))
1391 candidate_p = 1;
1392 else if (NILP (all_frames))
1394 xassert (WINDOWP (owindow));
1395 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
1397 else if (EQ (all_frames, Qvisible))
1399 FRAME_SAMPLE_VISIBILITY (f);
1400 candidate_p = FRAME_VISIBLE_P (f);
1402 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
1404 FRAME_SAMPLE_VISIBILITY (f);
1405 candidate_p = FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f);
1407 else if (WINDOWP (all_frames))
1408 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
1409 || EQ (XWINDOW (all_frames)->frame, w->frame)
1410 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
1411 else if (FRAMEP (all_frames))
1412 candidate_p = EQ (all_frames, w->frame);
1414 return candidate_p;
1418 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
1419 Fwindow_list. See there for the meaning of WINDOW, MINIBUF, and
1420 ALL_FRAMES. */
1422 static void
1423 decode_next_window_args (window, minibuf, all_frames)
1424 Lisp_Object *window, *minibuf, *all_frames;
1426 if (NILP (*window))
1427 *window = selected_window;
1428 else
1429 CHECK_LIVE_WINDOW (*window, 0);
1431 /* MINIBUF nil may or may not include minibuffers. Decide if it
1432 does. */
1433 if (NILP (*minibuf))
1434 *minibuf = minibuf_level ? minibuf_window : Qlambda;
1435 else if (!EQ (*minibuf, Qt))
1436 *minibuf = Qlambda;
1438 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
1439 => count none of them, or a specific minibuffer window (the
1440 active one) to count. */
1442 /* ALL_FRAMES nil doesn't specify which frames to include. */
1443 if (NILP (*all_frames))
1444 *all_frames = (!EQ (*minibuf, Qlambda)
1445 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
1446 : Qnil);
1447 else if (EQ (*all_frames, Qvisible))
1449 else if (XFASTINT (*all_frames) == 0)
1451 else if (FRAMEP (*all_frames))
1453 else if (!EQ (*all_frames, Qt))
1454 *all_frames = Qnil;
1456 /* Now *ALL_FRAMES is t meaning search all frames, nil meaning
1457 search just current frame, `visible' meaning search just visible
1458 frames, 0 meaning search visible and iconified frames, or a
1459 window, meaning search the frame that window belongs to, or a
1460 frame, meaning consider windows on that frame, only. */
1464 /* Return the next or previous window of WINDOW in canonical ordering
1465 of windows. NEXT_P non-zero means return the next window. See the
1466 documentation string of next-window for the meaning of MINIBUF and
1467 ALL_FRAMES. */
1469 static Lisp_Object
1470 next_window (window, minibuf, all_frames, next_p)
1471 Lisp_Object window, minibuf, all_frames;
1472 int next_p;
1474 decode_next_window_args (&window, &minibuf, &all_frames);
1476 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
1477 return the first window on the frame. */
1478 if (FRAMEP (all_frames)
1479 && !EQ (all_frames, XWINDOW (window)->frame))
1480 return Fframe_first_window (all_frames);
1482 if (next_p)
1484 Lisp_Object list;
1486 /* Find WINDOW in the list of all windows. */
1487 list = Fmemq (window, window_list ());
1489 /* Scan forward from WINDOW to the end of the window list. */
1490 if (CONSP (list))
1491 for (list = XCDR (list); CONSP (list); list = XCDR (list))
1492 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1493 break;
1495 /* Scan from the start of the window list up to WINDOW. */
1496 if (!CONSP (list))
1497 for (list = Vwindow_list;
1498 CONSP (list) && !EQ (XCAR (list), window);
1499 list = XCDR (list))
1500 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1501 break;
1503 if (CONSP (list))
1504 window = XCAR (list);
1506 else
1508 Lisp_Object candidate, list;
1510 /* Scan through the list of windows for candidates. If there are
1511 candidate windows in front of WINDOW, the last one of these
1512 is the one we want. If there are candidates following WINDOW
1513 in the list, again the last one of these is the one we want. */
1514 candidate = Qnil;
1515 for (list = window_list (); CONSP (list); list = XCDR (list))
1517 if (EQ (XCAR (list), window))
1519 if (WINDOWP (candidate))
1520 break;
1522 else if (candidate_window_p (XCAR (list), window, minibuf,
1523 all_frames))
1524 candidate = XCAR (list);
1527 if (WINDOWP (candidate))
1528 window = candidate;
1531 return window;
1535 /* This comment supplies the doc string for `next-window',
1536 for make-docfile to see. We cannot put this in the real DEFUN
1537 due to limits in the Unix cpp.
1539 DEFUN ("next-window", Ffoo, Sfoo, 0, 3, 0,
1540 "Return next window after WINDOW in canonical ordering of windows.\n\
1541 If omitted, WINDOW defaults to the selected window.\n\
1543 Optional second arg MINIBUF t means count the minibuffer window even\n\
1544 if not active. MINIBUF nil or omitted means count the minibuffer iff\n\
1545 it is active. MINIBUF neither t nor nil means not to count the\n\
1546 minibuffer even if it is active.\n\
1548 Several frames may share a single minibuffer; if the minibuffer\n\
1549 counts, all windows on all frames that share that minibuffer count\n\
1550 too. Therefore, `next-window' can be used to iterate through the\n\
1551 set of windows even when the minibuffer is on another frame. If the\n\
1552 minibuffer does not count, only windows from WINDOW's frame count.\n\
1554 Optional third arg ALL-FRAMES t means include windows on all frames.\n\
1555 ALL-FRAMES nil or omitted means cycle within the frames as specified\n\
1556 above. ALL-FRAMES = `visible' means include windows on all visible frames.\n\
1557 ALL-FRAMES = 0 means include windows on all visible and iconified frames.\n\
1558 If ALL-FRAMES is a frame, restrict search to windows on that frame.\n\
1559 Anything else means restrict to WINDOW's frame.\n\
1561 If you use consistent values for MINIBUF and ALL-FRAMES, you can use\n\
1562 `next-window' to iterate through the entire cycle of acceptable\n\
1563 windows, eventually ending up back at the window you started with.\n\
1564 `previous-window' traverses the same cycle, in the reverse order.")
1565 (window, minibuf, all_frames) */
1567 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
1569 (window, minibuf, all_frames)
1570 Lisp_Object window, minibuf, all_frames;
1572 return next_window (window, minibuf, all_frames, 1);
1576 /* This comment supplies the doc string for `previous-window',
1577 for make-docfile to see. We cannot put this in the real DEFUN
1578 due to limits in the Unix cpp.
1580 DEFUN ("previous-window", Ffoo, Sfoo, 0, 3, 0,
1581 "Return the window preceding WINDOW in canonical ordering of windows.\n\
1582 If omitted, WINDOW defaults to the selected window.\n\
1584 Optional second arg MINIBUF t means count the minibuffer window even\n\
1585 if not active. MINIBUF nil or omitted means count the minibuffer iff\n\
1586 it is active. MINIBUF neither t nor nil means not to count the\n\
1587 minibuffer even if it is active.\n\
1589 Several frames may share a single minibuffer; if the minibuffer\n\
1590 counts, all windows on all frames that share that minibuffer count\n\
1591 too. Therefore, `previous-window' can be used to iterate through\n\
1592 the set of windows even when the minibuffer is on another frame. If\n\
1593 the minibuffer does not count, only windows from WINDOW's frame count\n\
1595 Optional third arg ALL-FRAMES t means include windows on all frames.\n\
1596 ALL-FRAMES nil or omitted means cycle within the frames as specified\n\
1597 above. ALL-FRAMES = `visible' means include windows on all visible frames.\n\
1598 ALL-FRAMES = 0 means include windows on all visible and iconified frames.\n\
1599 If ALL-FRAMES is a frame, restrict search to windows on that frame.\n\
1600 Anything else means restrict to WINDOW's frame.\n\
1602 If you use consistent values for MINIBUF and ALL-FRAMES, you can use\n\
1603 `previous-window' to iterate through the entire cycle of acceptable\n\
1604 windows, eventually ending up back at the window you started with.\n\
1605 `next-window' traverses the same cycle, in the reverse order.")
1606 (window, minibuf, all_frames) */
1609 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
1611 (window, minibuf, all_frames)
1612 Lisp_Object window, minibuf, all_frames;
1614 return next_window (window, minibuf, all_frames, 0);
1618 DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
1619 "Select the ARG'th different window on this frame.\n\
1620 All windows on current frame are arranged in a cyclic order.\n\
1621 This command selects the window ARG steps away in that order.\n\
1622 A negative ARG moves in the opposite order. If the optional second\n\
1623 argument ALL_FRAMES is non-nil, cycle through all frames.")
1624 (arg, all_frames)
1625 Lisp_Object arg, all_frames;
1627 Lisp_Object window;
1628 int i;
1630 CHECK_NUMBER (arg, 0);
1631 window = selected_window;
1633 for (i = XINT (arg); i > 0; --i)
1634 window = Fnext_window (window, Qnil, all_frames);
1635 for (; i < 0; ++i)
1636 window = Fprevious_window (window, Qnil, all_frames);
1638 Fselect_window (window);
1639 return Qnil;
1643 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
1644 "Return a list of windows on FRAME, starting with WINDOW.\n\
1645 FRAME nil or omitted means use the selected frame.\n\
1646 WINDOW nil or omitted means use the selected window.\n\
1647 MINIBUF t means include the minibuffer window, even if it isn't active.\n\
1648 MINIBUF nil or omitted means include the minibuffer window only\n\
1649 if it's active.\n\
1650 MINIBUF neither nil nor t means never include the minibuffer window.")
1651 (frame, minibuf, window)
1652 Lisp_Object frame, minibuf, window;
1655 if (NILP (window))
1656 window = selected_window;
1657 if (NILP (frame))
1658 frame = selected_frame;
1660 if (!EQ (frame, XWINDOW (window)->frame))
1661 error ("Window is on a different frame");
1663 return window_list_1 (window, minibuf, frame);
1667 /* Return a list of windows in canonical ordering. Arguments are like
1668 for `next-window'. */
1670 static Lisp_Object
1671 window_list_1 (window, minibuf, all_frames)
1672 Lisp_Object window, minibuf, all_frames;
1674 Lisp_Object tail, list;
1676 decode_next_window_args (&window, &minibuf, &all_frames);
1677 list = Qnil;
1679 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
1680 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
1681 list = Fcons (XCAR (tail), list);
1683 return Fnreverse (list);
1688 /* Look at all windows, performing an operation specified by TYPE
1689 with argument OBJ.
1690 If FRAMES is Qt, look at all frames;
1691 Qnil, look at just the selected frame;
1692 Qvisible, look at visible frames;
1693 a frame, just look at windows on that frame.
1694 If MINI is non-zero, perform the operation on minibuffer windows too. */
1696 enum window_loop
1698 WINDOW_LOOP_UNUSED,
1699 GET_BUFFER_WINDOW, /* Arg is buffer */
1700 GET_LRU_WINDOW, /* Arg is t for full-width windows only */
1701 DELETE_OTHER_WINDOWS, /* Arg is window not to delete */
1702 DELETE_BUFFER_WINDOWS, /* Arg is buffer */
1703 GET_LARGEST_WINDOW,
1704 UNSHOW_BUFFER, /* Arg is buffer */
1705 CHECK_ALL_WINDOWS
1708 static Lisp_Object
1709 window_loop (type, obj, mini, frames)
1710 enum window_loop type;
1711 Lisp_Object obj, frames;
1712 int mini;
1714 Lisp_Object window, windows, best_window, frame_arg;
1715 struct frame *f;
1716 struct gcpro gcpro1;
1718 /* If we're only looping through windows on a particular frame,
1719 frame points to that frame. If we're looping through windows
1720 on all frames, frame is 0. */
1721 if (FRAMEP (frames))
1722 f = XFRAME (frames);
1723 else if (NILP (frames))
1724 f = SELECTED_FRAME ();
1725 else
1726 f = NULL;
1728 if (f)
1729 frame_arg = Qlambda;
1730 else if (XFASTINT (frames) == 0)
1731 frame_arg = frames;
1732 else if (EQ (frames, Qvisible))
1733 frame_arg = frames;
1734 else
1735 frame_arg = Qt;
1737 /* frame_arg is Qlambda to stick to one frame,
1738 Qvisible to consider all visible frames,
1739 or Qt otherwise. */
1741 /* Pick a window to start with. */
1742 if (WINDOWP (obj))
1743 window = obj;
1744 else if (f)
1745 window = FRAME_SELECTED_WINDOW (f);
1746 else
1747 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
1749 /* Figure out the last window we're going to mess with. Since
1750 Fnext_window, given the same options, is guaranteed to go in a
1751 ring, we can just use Fprevious_window to find the last one.
1753 We can't just wait until we hit the first window again, because
1754 it might be deleted. */
1756 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
1757 GCPRO1 (windows);
1758 best_window = Qnil;
1760 for (; CONSP (windows); windows = CDR (windows))
1762 struct window *w;
1764 window = XCAR (windows);
1765 w = XWINDOW (window);
1767 /* Note that we do not pay attention here to whether the frame
1768 is visible, since Fwindow_list skips non-visible frames if
1769 that is desired, under the control of frame_arg. */
1770 if (!MINI_WINDOW_P (w)
1771 /* For UNSHOW_BUFFER, we must always consider all windows. */
1772 || type == UNSHOW_BUFFER
1773 || (mini && minibuf_level > 0))
1774 switch (type)
1776 case GET_BUFFER_WINDOW:
1777 if (EQ (w->buffer, obj)
1778 /* Don't find any minibuffer window
1779 except the one that is currently in use. */
1780 && (MINI_WINDOW_P (w)
1781 ? EQ (window, minibuf_window)
1782 : 1))
1784 UNGCPRO;
1785 return window;
1787 break;
1789 case GET_LRU_WINDOW:
1790 /* t as arg means consider only full-width windows */
1791 if (!NILP (obj) && !WINDOW_FULL_WIDTH_P (w))
1792 break;
1793 /* Ignore dedicated windows and minibuffers. */
1794 if (MINI_WINDOW_P (w) || !NILP (w->dedicated))
1795 break;
1796 if (NILP (best_window)
1797 || (XFASTINT (XWINDOW (best_window)->use_time)
1798 > XFASTINT (w->use_time)))
1799 best_window = window;
1800 break;
1802 case DELETE_OTHER_WINDOWS:
1803 if (!EQ (window, obj))
1804 Fdelete_window (window);
1805 break;
1807 case DELETE_BUFFER_WINDOWS:
1808 if (EQ (w->buffer, obj))
1810 struct frame *f = XFRAME (WINDOW_FRAME (w));
1812 /* If this window is dedicated, and in a frame of its own,
1813 kill the frame. */
1814 if (EQ (window, FRAME_ROOT_WINDOW (f))
1815 && !NILP (w->dedicated)
1816 && other_visible_frames (f))
1818 /* Skip the other windows on this frame.
1819 There might be one, the minibuffer! */
1820 while (CONSP (XCDR (windows))
1821 && EQ (XWINDOW (XCAR (windows))->frame,
1822 XWINDOW (XCAR (XCDR (windows)))->frame))
1823 windows = XCDR (windows);
1825 /* Now we can safely delete the frame. */
1826 Fdelete_frame (w->frame, Qnil);
1828 else if (NILP (w->parent))
1830 /* If we're deleting the buffer displayed in the
1831 only window on the frame, find a new buffer to
1832 display there. */
1833 Lisp_Object buffer;
1834 buffer = Fother_buffer (obj, Qnil, w->frame);
1835 if (NILP (buffer))
1836 buffer = Fget_buffer_create (build_string ("*scratch*"));
1837 Fset_window_buffer (window, buffer);
1838 if (EQ (window, selected_window))
1839 Fset_buffer (w->buffer);
1841 else
1842 Fdelete_window (window);
1844 break;
1846 case GET_LARGEST_WINDOW:
1848 /* Ignore dedicated windows and minibuffers. */
1849 if (MINI_WINDOW_P (w) || !NILP (w->dedicated))
1850 break;
1852 if (NILP (best_window))
1853 best_window = window;
1854 else
1856 struct window *b = XWINDOW (best_window);
1857 if (XFASTINT (w->height) * XFASTINT (w->width)
1858 > XFASTINT (b->height) * XFASTINT (b->width))
1859 best_window = window;
1862 break;
1864 case UNSHOW_BUFFER:
1865 if (EQ (w->buffer, obj))
1867 Lisp_Object buffer;
1868 struct frame *f = XFRAME (w->frame);
1870 /* Find another buffer to show in this window. */
1871 buffer = Fother_buffer (obj, Qnil, w->frame);
1872 if (NILP (buffer))
1873 buffer = Fget_buffer_create (build_string ("*scratch*"));
1875 /* If this window is dedicated, and in a frame of its own,
1876 kill the frame. */
1877 if (EQ (window, FRAME_ROOT_WINDOW (f))
1878 && !NILP (w->dedicated)
1879 && other_visible_frames (f))
1881 /* Skip the other windows on this frame.
1882 There might be one, the minibuffer! */
1883 while (CONSP (XCDR (windows))
1884 && EQ (XWINDOW (XCAR (windows))->frame,
1885 XWINDOW (XCAR (XCDR (windows)))->frame))
1886 windows = XCDR (windows);
1888 /* Now we can safely delete the frame. */
1889 Fdelete_frame (w->frame, Qnil);
1891 else
1893 /* Otherwise show a different buffer in the window. */
1894 w->dedicated = Qnil;
1895 Fset_window_buffer (window, buffer);
1896 if (EQ (window, selected_window))
1897 Fset_buffer (w->buffer);
1900 break;
1902 /* Check for a window that has a killed buffer. */
1903 case CHECK_ALL_WINDOWS:
1904 if (! NILP (w->buffer)
1905 && NILP (XBUFFER (w->buffer)->name))
1906 abort ();
1907 break;
1909 case WINDOW_LOOP_UNUSED:
1910 break;
1914 UNGCPRO;
1915 return best_window;
1918 /* Used for debugging. Abort if any window has a dead buffer. */
1920 void
1921 check_all_windows ()
1923 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
1926 DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 1, 0,
1927 "Return the window least recently selected or used for display.\n\
1928 If optional argument FRAME is `visible', search all visible frames.\n\
1929 If FRAME is 0, search all visible and iconified frames.\n\
1930 If FRAME is t, search all frames.\n\
1931 If FRAME is nil, search only the selected frame.\n\
1932 If FRAME is a frame, search only that frame.")
1933 (frame)
1934 Lisp_Object frame;
1936 register Lisp_Object w;
1937 /* First try for a window that is full-width */
1938 w = window_loop (GET_LRU_WINDOW, Qt, 0, frame);
1939 if (!NILP (w) && !EQ (w, selected_window))
1940 return w;
1941 /* If none of them, try the rest */
1942 return window_loop (GET_LRU_WINDOW, Qnil, 0, frame);
1945 DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 1, 0,
1946 "Return the largest window in area.\n\
1947 If optional argument FRAME is `visible', search all visible frames.\n\
1948 If FRAME is 0, search all visible and iconified frames.\n\
1949 If FRAME is t, search all frames.\n\
1950 If FRAME is nil, search only the selected frame.\n\
1951 If FRAME is a frame, search only that frame.")
1952 (frame)
1953 Lisp_Object frame;
1955 return window_loop (GET_LARGEST_WINDOW, Qnil, 0,
1956 frame);
1959 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 1, 2, 0,
1960 "Return a window currently displaying BUFFER, or nil if none.\n\
1961 If optional argument FRAME is `visible', search all visible frames.\n\
1962 If optional argument FRAME is 0, search all visible and iconified frames.\n\
1963 If FRAME is t, search all frames.\n\
1964 If FRAME is nil, search only the selected frame.\n\
1965 If FRAME is a frame, search only that frame.")
1966 (buffer, frame)
1967 Lisp_Object buffer, frame;
1969 buffer = Fget_buffer (buffer);
1970 if (BUFFERP (buffer))
1971 return window_loop (GET_BUFFER_WINDOW, buffer, 1, frame);
1972 else
1973 return Qnil;
1976 DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
1977 0, 1, "",
1978 "Make WINDOW (or the selected window) fill its frame.\n\
1979 Only the frame WINDOW is on is affected.\n\
1980 This function tries to reduce display jumps\n\
1981 by keeping the text previously visible in WINDOW\n\
1982 in the same place on the frame. Doing this depends on\n\
1983 the value of (window-start WINDOW), so if calling this function\n\
1984 in a program gives strange scrolling, make sure the window-start\n\
1985 value is reasonable when this function is called.")
1986 (window)
1987 Lisp_Object window;
1989 struct window *w;
1990 int startpos;
1991 int top, new_top;
1993 if (NILP (window))
1994 window = selected_window;
1995 else
1996 CHECK_LIVE_WINDOW (window, 0);
1997 w = XWINDOW (window);
1999 startpos = marker_position (w->start);
2000 top = XFASTINT (w->top) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2002 if (MINI_WINDOW_P (w) && top > 0)
2003 error ("Can't expand minibuffer to full frame");
2005 window_loop (DELETE_OTHER_WINDOWS, window, 0, WINDOW_FRAME (w));
2007 /* Try to minimize scrolling, by setting the window start to the point
2008 will cause the text at the old window start to be at the same place
2009 on the frame. But don't try to do this if the window start is
2010 outside the visible portion (as might happen when the display is
2011 not current, due to typeahead). */
2012 new_top = XFASTINT (w->top) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2013 if (new_top != top
2014 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2015 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2017 struct position pos;
2018 struct buffer *obuf = current_buffer;
2020 Fset_buffer (w->buffer);
2021 /* This computation used to temporarily move point, but that can
2022 have unwanted side effects due to text properties. */
2023 pos = *vmotion (startpos, -top, w);
2025 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2026 w->window_end_valid = Qnil;
2027 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2028 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2029 : Qnil);
2030 /* We need to do this, so that the window-scroll-functions
2031 get called. */
2032 w->optional_new_start = Qt;
2034 set_buffer_internal (obuf);
2037 return Qnil;
2040 DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
2041 1, 2, "bDelete windows on (buffer): ",
2042 "Delete all windows showing BUFFER.\n\
2043 Optional second argument FRAME controls which frames are affected.\n\
2044 If optional argument FRAME is `visible', search all visible frames.\n\
2045 If FRAME is 0, search all visible and iconified frames.\n\
2046 If FRAME is nil, search all frames.\n\
2047 If FRAME is t, search only the selected frame.\n\
2048 If FRAME is a frame, search only that frame.")
2049 (buffer, frame)
2050 Lisp_Object buffer, frame;
2052 /* FRAME uses t and nil to mean the opposite of what window_loop
2053 expects. */
2054 if (NILP (frame))
2055 frame = Qt;
2056 else if (EQ (frame, Qt))
2057 frame = Qnil;
2059 if (!NILP (buffer))
2061 buffer = Fget_buffer (buffer);
2062 CHECK_BUFFER (buffer, 0);
2063 window_loop (DELETE_BUFFER_WINDOWS, buffer, 0, frame);
2066 return Qnil;
2069 DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows,
2070 Sreplace_buffer_in_windows,
2071 1, 1, "bReplace buffer in windows: ",
2072 "Replace BUFFER with some other buffer in all windows showing it.")
2073 (buffer)
2074 Lisp_Object buffer;
2076 if (!NILP (buffer))
2078 buffer = Fget_buffer (buffer);
2079 CHECK_BUFFER (buffer, 0);
2080 window_loop (UNSHOW_BUFFER, buffer, 0, Qt);
2082 return Qnil;
2085 /* Replace BUFFER with some other buffer in all windows
2086 of all frames, even those on other keyboards. */
2088 void
2089 replace_buffer_in_all_windows (buffer)
2090 Lisp_Object buffer;
2092 #ifdef MULTI_KBOARD
2093 Lisp_Object tail, frame;
2095 /* A single call to window_loop won't do the job
2096 because it only considers frames on the current keyboard.
2097 So loop manually over frames, and handle each one. */
2098 FOR_EACH_FRAME (tail, frame)
2099 window_loop (UNSHOW_BUFFER, buffer, 1, frame);
2100 #else
2101 window_loop (UNSHOW_BUFFER, buffer, 1, Qt);
2102 #endif
2105 /* Set the height of WINDOW and all its inferiors. */
2107 /* The smallest acceptable dimensions for a window. Anything smaller
2108 might crash Emacs. */
2110 #define MIN_SAFE_WINDOW_WIDTH (2)
2111 #define MIN_SAFE_WINDOW_HEIGHT (2)
2113 /* Make sure that window_min_height and window_min_width are
2114 not too small; if they are, set them to safe minima. */
2116 static void
2117 check_min_window_sizes ()
2119 /* Smaller values might permit a crash. */
2120 if (window_min_width < MIN_SAFE_WINDOW_WIDTH)
2121 window_min_width = MIN_SAFE_WINDOW_WIDTH;
2122 if (window_min_height < MIN_SAFE_WINDOW_HEIGHT)
2123 window_min_height = MIN_SAFE_WINDOW_HEIGHT;
2126 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2127 minimum allowable size. */
2129 void
2130 check_frame_size (frame, rows, cols)
2131 FRAME_PTR frame;
2132 int *rows, *cols;
2134 /* For height, we have to see:
2135 whether the frame has a minibuffer,
2136 whether it wants a mode line, and
2137 whether it has a menu bar. */
2138 int min_height =
2139 (FRAME_MINIBUF_ONLY_P (frame) ? MIN_SAFE_WINDOW_HEIGHT - 1
2140 : (! FRAME_HAS_MINIBUF_P (frame)) ? MIN_SAFE_WINDOW_HEIGHT
2141 : 2 * MIN_SAFE_WINDOW_HEIGHT - 1);
2143 if (FRAME_TOP_MARGIN (frame) > 0)
2144 min_height += FRAME_TOP_MARGIN (frame);
2146 if (*rows < min_height)
2147 *rows = min_height;
2148 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2149 *cols = MIN_SAFE_WINDOW_WIDTH;
2153 /* Value is non-zero if window W is fixed-size. WIDTH_P non-zero means
2154 check if W's width can be changed, otherwise check W's height.
2155 CHECK_SIBLINGS_P non-zero means check resizablity of WINDOW's
2156 siblings, too. If none of the siblings is resizable, WINDOW isn't
2157 either. */
2159 static int
2160 window_fixed_size_p (w, width_p, check_siblings_p)
2161 struct window *w;
2162 int width_p, check_siblings_p;
2164 int fixed_p;
2165 struct window *c;
2167 if (!NILP (w->hchild))
2169 c = XWINDOW (w->hchild);
2171 if (width_p)
2173 /* A horiz. combination is fixed-width if all of if its
2174 children are. */
2175 while (c && window_fixed_size_p (c, width_p, 0))
2176 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2177 fixed_p = c == NULL;
2179 else
2181 /* A horiz. combination is fixed-height if one of if its
2182 children is. */
2183 while (c && !window_fixed_size_p (c, width_p, 0))
2184 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2185 fixed_p = c != NULL;
2188 else if (!NILP (w->vchild))
2190 c = XWINDOW (w->vchild);
2192 if (width_p)
2194 /* A vert. combination is fixed-width if one of if its
2195 children is. */
2196 while (c && !window_fixed_size_p (c, width_p, 0))
2197 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2198 fixed_p = c != NULL;
2200 else
2202 /* A vert. combination is fixed-height if all of if its
2203 children are. */
2204 while (c && window_fixed_size_p (c, width_p, 0))
2205 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2206 fixed_p = c == NULL;
2209 else if (BUFFERP (w->buffer))
2211 if (w->height_fixed_p && !width_p)
2212 fixed_p = 1;
2213 else
2215 struct buffer *old = current_buffer;
2216 Lisp_Object val;
2218 current_buffer = XBUFFER (w->buffer);
2219 val = find_symbol_value (Qwindow_size_fixed);
2220 current_buffer = old;
2222 fixed_p = 0;
2223 if (!EQ (val, Qunbound))
2225 fixed_p = !NILP (val);
2227 if (fixed_p
2228 && ((EQ (val, Qheight) && width_p)
2229 || (EQ (val, Qwidth) && !width_p)))
2230 fixed_p = 0;
2234 /* Can't tell if this one is resizable without looking at
2235 siblings. If all siblings are fixed-size this one is too. */
2236 if (!fixed_p && check_siblings_p && WINDOWP (w->parent))
2238 Lisp_Object child;
2240 for (child = w->prev; !NILP (child); child = XWINDOW (child)->prev)
2241 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2242 break;
2244 if (NILP (child))
2245 for (child = w->next; !NILP (child); child = XWINDOW (child)->next)
2246 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2247 break;
2249 if (NILP (child))
2250 fixed_p = 1;
2253 else
2254 fixed_p = 1;
2256 return fixed_p;
2260 /* Return the minimum size of window W, not taking fixed-width windows
2261 into account. WIDTH_P non-zero means return the minimum width,
2262 otherwise return the minimum height. If W is a combination window,
2263 compute the minimum size from the minimum sizes of W's children. */
2265 static int
2266 window_min_size_1 (w, width_p)
2267 struct window *w;
2268 int width_p;
2270 struct window *c;
2271 int size;
2273 if (!NILP (w->hchild))
2275 c = XWINDOW (w->hchild);
2276 size = 0;
2278 if (width_p)
2280 /* The min width of a horizontal combination is
2281 the sum of the min widths of its children. */
2282 while (c)
2284 size += window_min_size_1 (c, width_p);
2285 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2288 else
2290 /* The min height a horizontal combination equals
2291 the maximum of all min height of its children. */
2292 while (c)
2294 int min_size = window_min_size_1 (c, width_p);
2295 size = max (min_size, size);
2296 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2300 else if (!NILP (w->vchild))
2302 c = XWINDOW (w->vchild);
2303 size = 0;
2305 if (width_p)
2307 /* The min width of a vertical combination is
2308 the maximum of the min widths of its children. */
2309 while (c)
2311 int min_size = window_min_size_1 (c, width_p);
2312 size = max (min_size, size);
2313 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2316 else
2318 /* The min height of a vertical combination equals
2319 the sum of the min height of its children. */
2320 while (c)
2322 size += window_min_size_1 (c, width_p);
2323 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2327 else
2329 if (width_p)
2330 size = window_min_width;
2331 else
2333 if (MINI_WINDOW_P (w)
2334 || (!WINDOW_WANTS_MODELINE_P (w)
2335 && !WINDOW_WANTS_HEADER_LINE_P (w)))
2336 size = 1;
2337 else
2338 size = window_min_height;
2342 return size;
2346 /* Return the minimum size of window W, taking fixed-size windows into
2347 account. WIDTH_P non-zero means return the minimum width,
2348 otherwise return the minimum height. IGNORE_FIXED_P non-zero means
2349 ignore if W is fixed-size. Set *FIXED to 1 if W is fixed-size
2350 unless FIXED is null. */
2352 static int
2353 window_min_size (w, width_p, ignore_fixed_p, fixed)
2354 struct window *w;
2355 int width_p, ignore_fixed_p, *fixed;
2357 int size, fixed_p;
2359 if (ignore_fixed_p)
2360 fixed_p = 0;
2361 else
2362 fixed_p = window_fixed_size_p (w, width_p, 1);
2364 if (fixed)
2365 *fixed = fixed_p;
2367 if (fixed_p)
2368 size = width_p ? XFASTINT (w->width) : XFASTINT (w->height);
2369 else
2370 size = window_min_size_1 (w, width_p);
2372 return size;
2376 /* Set WINDOW's height or width to SIZE. WIDTH_P non-zero means set
2377 WINDOW's width. Resize WINDOW's children, if any, so that they
2378 keep their proportionate size relative to WINDOW. Propagate
2379 WINDOW's top or left edge position to children. Delete windows
2380 that become too small unless NODELETE_P is non-zero. */
2382 static void
2383 size_window (window, size, width_p, nodelete_p)
2384 Lisp_Object window;
2385 int size, width_p, nodelete_p;
2387 struct window *w = XWINDOW (window);
2388 struct window *c;
2389 Lisp_Object child, *forward, *sideward;
2390 int old_size, min_size;
2392 check_min_window_sizes ();
2393 size = max (0, size);
2395 /* If the window has been "too small" at one point,
2396 don't delete it for being "too small" in the future.
2397 Preserve it as long as that is at all possible. */
2398 if (width_p)
2400 old_size = XINT (w->width);
2401 min_size = window_min_width;
2403 else
2405 old_size = XINT (w->height);
2406 min_size = window_min_height;
2409 if (old_size < min_size)
2410 w->too_small_ok = Qt;
2412 /* Maybe delete WINDOW if it's too small. */
2413 if (!nodelete_p && !NILP (w->parent))
2415 if (!MINI_WINDOW_P (w) && !NILP (w->too_small_ok))
2416 min_size = width_p ? MIN_SAFE_WINDOW_WIDTH : MIN_SAFE_WINDOW_HEIGHT;
2417 else
2418 min_size = width_p ? window_min_width : window_min_height;
2420 if (size < min_size)
2422 delete_window (window);
2423 return;
2427 /* Set redisplay hints. */
2428 w->last_modified = make_number (0);
2429 w->last_overlay_modified = make_number (0);
2430 windows_or_buffers_changed++;
2431 FRAME_WINDOW_SIZES_CHANGED (XFRAME (w->frame)) = 1;
2433 if (width_p)
2435 sideward = &w->vchild;
2436 forward = &w->hchild;
2437 w->width = make_number (size);
2439 else
2441 sideward = &w->hchild;
2442 forward = &w->vchild;
2443 w->height = make_number (size);
2446 if (!NILP (*sideward))
2448 for (child = *sideward; !NILP (child); child = c->next)
2450 c = XWINDOW (child);
2451 if (width_p)
2452 c->left = w->left;
2453 else
2454 c->top = w->top;
2455 size_window (child, size, width_p, nodelete_p);
2458 else if (!NILP (*forward))
2460 int fixed_size, each, extra, n;
2461 int resize_fixed_p, nfixed;
2462 int last_pos, first_pos, nchildren, total;
2464 /* Determine the fixed-size portion of the this window, and the
2465 number of child windows. */
2466 fixed_size = nchildren = nfixed = total = 0;
2467 for (child = *forward; !NILP (child); child = c->next, ++nchildren)
2469 int child_size;
2471 c = XWINDOW (child);
2472 child_size = width_p ? XINT (c->width) : XINT (c->height);
2473 total += child_size;
2475 if (window_fixed_size_p (c, width_p, 0))
2477 fixed_size += child_size;
2478 ++nfixed;
2482 /* If the new size is smaller than fixed_size, or if there
2483 aren't any resizable windows, allow resizing fixed-size
2484 windows. */
2485 resize_fixed_p = nfixed == nchildren || size < fixed_size;
2487 /* Compute how many lines/columns to add to each child. The
2488 value of extra takes care of rounding errors. */
2489 n = resize_fixed_p ? nchildren : nchildren - nfixed;
2490 each = (size - total) / n;
2491 extra = (size - total) - n * each;
2493 /* Compute new children heights and edge positions. */
2494 first_pos = width_p ? XINT (w->left) : XINT (w->top);
2495 last_pos = first_pos;
2496 for (child = *forward; !NILP (child); child = c->next)
2498 int new_size, old_size;
2500 c = XWINDOW (child);
2501 old_size = width_p ? XFASTINT (c->width) : XFASTINT (c->height);
2502 new_size = old_size;
2504 /* The top or left edge position of this child equals the
2505 bottom or right edge of its predecessor. */
2506 if (width_p)
2507 c->left = make_number (last_pos);
2508 else
2509 c->top = make_number (last_pos);
2511 /* If this child can be resized, do it. */
2512 if (resize_fixed_p || !window_fixed_size_p (c, width_p, 0))
2514 new_size = old_size + each + extra;
2515 extra = 0;
2518 /* Set new height. Note that size_window also propagates
2519 edge positions to children, so it's not a no-op if we
2520 didn't change the child's size. */
2521 size_window (child, new_size, width_p, 1);
2523 /* Remember the bottom/right edge position of this child; it
2524 will be used to set the top/left edge of the next child. */
2525 last_pos += new_size;
2528 /* We should have covered the parent exactly with child windows. */
2529 xassert (size == last_pos - first_pos);
2531 /* Now delete any children that became too small. */
2532 if (!nodelete_p)
2533 for (child = *forward; !NILP (child); child = c->next)
2535 int child_size;
2536 c = XWINDOW (child);
2537 child_size = width_p ? XINT (c->width) : XINT (c->height);
2538 size_window (child, child_size, width_p, 0);
2543 /* Set WINDOW's height to HEIGHT, and recursively change the height of
2544 WINDOW's children. NODELETE non-zero means don't delete windows
2545 that become too small in the process. (The caller should check
2546 later and do so if appropriate.) */
2548 void
2549 set_window_height (window, height, nodelete)
2550 Lisp_Object window;
2551 int height;
2552 int nodelete;
2554 size_window (window, height, 0, nodelete);
2558 /* Set WINDOW's width to WIDTH, and recursively change the width of
2559 WINDOW's children. NODELETE non-zero means don't delete windows
2560 that become too small in the process. (The caller should check
2561 later and do so if appropriate.) */
2563 void
2564 set_window_width (window, width, nodelete)
2565 Lisp_Object window;
2566 int width;
2567 int nodelete;
2569 size_window (window, width, 1, nodelete);
2573 int window_select_count;
2575 Lisp_Object
2576 Fset_window_buffer_unwind (obuf)
2577 Lisp_Object obuf;
2579 Fset_buffer (obuf);
2580 return Qnil;
2584 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
2585 means it's allowed to run hooks. See make_frame for a case where
2586 it's not allowed. */
2588 void
2589 set_window_buffer (window, buffer, run_hooks_p)
2590 Lisp_Object window, buffer;
2591 int run_hooks_p;
2593 struct window *w = XWINDOW (window);
2594 struct buffer *b = XBUFFER (buffer);
2595 int count = specpdl_ptr - specpdl;
2597 w->buffer = buffer;
2599 if (EQ (window, selected_window))
2600 b->last_selected_window = window;
2602 /* Update time stamps of buffer display. */
2603 if (INTEGERP (b->display_count))
2604 XSETINT (b->display_count, XINT (b->display_count) + 1);
2605 b->display_time = Fcurrent_time ();
2607 XSETFASTINT (w->window_end_pos, 0);
2608 XSETFASTINT (w->window_end_vpos, 0);
2609 bzero (&w->last_cursor, sizeof w->last_cursor);
2610 w->window_end_valid = Qnil;
2611 XSETFASTINT (w->hscroll, 0);
2612 XSETFASTINT (w->min_hscroll, 0);
2613 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
2614 set_marker_restricted (w->start,
2615 make_number (b->last_window_start),
2616 buffer);
2617 w->start_at_line_beg = Qnil;
2618 w->force_start = Qnil;
2619 XSETFASTINT (w->last_modified, 0);
2620 XSETFASTINT (w->last_overlay_modified, 0);
2621 windows_or_buffers_changed++;
2623 /* We must select BUFFER for running the window-scroll-functions.
2624 If WINDOW is selected, switch permanently.
2625 Otherwise, switch but go back to the ambient buffer afterward. */
2626 if (EQ (window, selected_window))
2627 Fset_buffer (buffer);
2628 /* We can't check ! NILP (Vwindow_scroll_functions) here
2629 because that might itself be a local variable. */
2630 else if (window_initialized)
2632 record_unwind_protect (Fset_window_buffer_unwind, Fcurrent_buffer ());
2633 Fset_buffer (buffer);
2636 /* Set left and right marginal area width from buffer. */
2637 Fset_window_margins (window, b->left_margin_width, b->right_margin_width);
2639 if (run_hooks_p)
2641 if (! NILP (Vwindow_scroll_functions))
2642 run_hook_with_args_2 (Qwindow_scroll_functions, window,
2643 Fmarker_position (w->start));
2645 if (! NILP (Vwindow_configuration_change_hook)
2646 && ! NILP (Vrun_hooks))
2647 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
2650 unbind_to (count, Qnil);
2654 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 2, 0,
2655 "Make WINDOW display BUFFER as its contents.\n\
2656 BUFFER can be a buffer or buffer name.")
2657 (window, buffer)
2658 register Lisp_Object window, buffer;
2660 register Lisp_Object tem;
2661 register struct window *w = decode_window (window);
2663 XSETWINDOW (window, w);
2664 buffer = Fget_buffer (buffer);
2665 CHECK_BUFFER (buffer, 1);
2667 if (NILP (XBUFFER (buffer)->name))
2668 error ("Attempt to display deleted buffer");
2670 tem = w->buffer;
2671 if (NILP (tem))
2672 error ("Window is deleted");
2673 else if (! EQ (tem, Qt)) /* w->buffer is t when the window
2674 is first being set up. */
2676 if (!NILP (w->dedicated) && !EQ (tem, buffer))
2677 error ("Window is dedicated to `%s'",
2678 XSTRING (XBUFFER (tem)->name)->data);
2680 unshow_buffer (w);
2683 set_window_buffer (window, buffer, 1);
2684 return Qnil;
2687 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 1, 0,
2688 "Select WINDOW. Most editing will apply to WINDOW's buffer.\n\
2689 If WINDOW is not already selected, also make WINDOW's buffer current.\n\
2690 Note that the main editor command loop\n\
2691 selects the buffer of the selected window before each command.")
2692 (window)
2693 register Lisp_Object window;
2695 return select_window_1 (window, 1);
2698 /* Note that selected_window can be nil
2699 when this is called from Fset_window_configuration. */
2701 static Lisp_Object
2702 select_window_1 (window, recordflag)
2703 register Lisp_Object window;
2704 int recordflag;
2706 register struct window *w;
2707 register struct window *ow;
2708 struct frame *sf;
2710 CHECK_LIVE_WINDOW (window, 0);
2712 w = XWINDOW (window);
2714 if (NILP (w->buffer))
2715 error ("Trying to select deleted window or non-leaf window");
2717 XSETFASTINT (w->use_time, ++window_select_count);
2718 if (EQ (window, selected_window))
2719 return window;
2721 if (!NILP (selected_window))
2723 ow = XWINDOW (selected_window);
2724 if (! NILP (ow->buffer))
2725 set_marker_both (ow->pointm, ow->buffer,
2726 BUF_PT (XBUFFER (ow->buffer)),
2727 BUF_PT_BYTE (XBUFFER (ow->buffer)));
2730 selected_window = window;
2731 sf = SELECTED_FRAME ();
2732 if (XFRAME (WINDOW_FRAME (w)) != sf)
2734 XFRAME (WINDOW_FRAME (w))->selected_window = window;
2735 /* Use this rather than Fhandle_switch_frame
2736 so that FRAME_FOCUS_FRAME is moved appropriately as we
2737 move around in the state where a minibuffer in a separate
2738 frame is active. */
2739 Fselect_frame (WINDOW_FRAME (w), Qnil);
2741 else
2742 sf->selected_window = window;
2744 if (recordflag)
2745 record_buffer (w->buffer);
2746 Fset_buffer (w->buffer);
2748 XBUFFER (w->buffer)->last_selected_window = window;
2750 /* Go to the point recorded in the window.
2751 This is important when the buffer is in more
2752 than one window. It also matters when
2753 redisplay_window has altered point after scrolling,
2754 because it makes the change only in the window. */
2756 register int new_point = marker_position (w->pointm);
2757 if (new_point < BEGV)
2758 SET_PT (BEGV);
2759 else if (new_point > ZV)
2760 SET_PT (ZV);
2761 else
2762 SET_PT (new_point);
2765 windows_or_buffers_changed++;
2766 return window;
2769 /* Deiconify the frame containing the window WINDOW,
2770 unless it is the selected frame;
2771 then return WINDOW.
2773 The reason for the exception for the selected frame
2774 is that it seems better not to change the selected frames visibility
2775 merely because of displaying a different buffer in it.
2776 The deiconification is useful when a buffer gets shown in
2777 another frame that you were not using lately. */
2779 static Lisp_Object
2780 display_buffer_1 (window)
2781 Lisp_Object window;
2783 Lisp_Object frame = XWINDOW (window)->frame;
2784 FRAME_PTR f = XFRAME (frame);
2786 FRAME_SAMPLE_VISIBILITY (f);
2788 if (!EQ (frame, selected_frame))
2790 if (FRAME_ICONIFIED_P (f))
2791 Fmake_frame_visible (frame);
2792 else if (FRAME_VISIBLE_P (f))
2793 Fraise_frame (frame);
2796 return window;
2799 DEFUN ("special-display-p", Fspecial_display_p, Sspecial_display_p, 1, 1, 0,
2800 "Returns non-nil if a buffer named BUFFER-NAME would be created specially.\n\
2801 The value is actually t if the frame should be called with default frame\n\
2802 parameters, and a list of frame parameters if they were specified.\n\
2803 See `special-display-buffer-names', and `special-display-regexps'.")
2804 (buffer_name)
2805 Lisp_Object buffer_name;
2807 Lisp_Object tem;
2809 CHECK_STRING (buffer_name, 1);
2811 tem = Fmember (buffer_name, Vspecial_display_buffer_names);
2812 if (!NILP (tem))
2813 return Qt;
2815 tem = Fassoc (buffer_name, Vspecial_display_buffer_names);
2816 if (!NILP (tem))
2817 return XCDR (tem);
2819 for (tem = Vspecial_display_regexps; CONSP (tem); tem = XCDR (tem))
2821 Lisp_Object car = XCAR (tem);
2822 if (STRINGP (car)
2823 && fast_string_match (car, buffer_name) >= 0)
2824 return Qt;
2825 else if (CONSP (car)
2826 && STRINGP (XCAR (car))
2827 && fast_string_match (XCAR (car), buffer_name) >= 0)
2828 return XCDR (car);
2830 return Qnil;
2833 DEFUN ("same-window-p", Fsame_window_p, Ssame_window_p, 1, 1, 0,
2834 "Returns non-nil if a new buffer named BUFFER-NAME would use the same window.\n\
2835 See `same-window-buffer-names' and `same-window-regexps'.")
2836 (buffer_name)
2837 Lisp_Object buffer_name;
2839 Lisp_Object tem;
2841 CHECK_STRING (buffer_name, 1);
2843 tem = Fmember (buffer_name, Vsame_window_buffer_names);
2844 if (!NILP (tem))
2845 return Qt;
2847 tem = Fassoc (buffer_name, Vsame_window_buffer_names);
2848 if (!NILP (tem))
2849 return Qt;
2851 for (tem = Vsame_window_regexps; CONSP (tem); tem = XCDR (tem))
2853 Lisp_Object car = XCAR (tem);
2854 if (STRINGP (car)
2855 && fast_string_match (car, buffer_name) >= 0)
2856 return Qt;
2857 else if (CONSP (car)
2858 && STRINGP (XCAR (car))
2859 && fast_string_match (XCAR (car), buffer_name) >= 0)
2860 return Qt;
2862 return Qnil;
2865 /* Use B so the default is (other-buffer). */
2866 DEFUN ("display-buffer", Fdisplay_buffer, Sdisplay_buffer, 1, 3,
2867 "BDisplay buffer: \nP",
2868 "Make BUFFER appear in some window but don't select it.\n\
2869 BUFFER can be a buffer or a buffer name.\n\
2870 If BUFFER is shown already in some window, just use that one,\n\
2871 unless the window is the selected window and the optional second\n\
2872 argument NOT-THIS-WINDOW is non-nil (interactively, with prefix arg).\n\
2873 If `pop-up-frames' is non-nil, make a new frame if no window shows BUFFER.\n\
2874 Returns the window displaying BUFFER.\n\
2875 If `display-reuse-frames' is non-nil, and another frame is currently\n\
2876 displaying BUFFER, then simply raise that frame.\n\
2878 The variables `special-display-buffer-names', `special-display-regexps',\n\
2879 `same-window-buffer-names', and `same-window-regexps' customize how certain\n\
2880 buffer names are handled.\n\
2882 If optional argument FRAME is `visible', search all visible frames.\n\
2883 If FRAME is 0, search all visible and iconified frames.\n\
2884 If FRAME is t, search all frames.\n\
2885 If FRAME is a frame, search only that frame.\n\
2886 If FRAME is nil, search only the selected frame\n\
2887 (actually the last nonminibuffer frame),\n\
2888 unless `pop-up-frames' or `display-buffer-reuse-frames' is non-nil,\n\
2889 which means search visible and iconified frames.\n\
2891 If `even-window-heights' is non-nil, window heights will be evened out\n\
2892 if displaying the buffer causes two vertically adjacent windows to be\n\
2893 displayed.")
2894 (buffer, not_this_window, frame)
2895 register Lisp_Object buffer, not_this_window, frame;
2897 register Lisp_Object window, tem, swp;
2898 struct frame *f;
2900 swp = Qnil;
2901 buffer = Fget_buffer (buffer);
2902 CHECK_BUFFER (buffer, 0);
2904 if (!NILP (Vdisplay_buffer_function))
2905 return call2 (Vdisplay_buffer_function, buffer, not_this_window);
2907 if (NILP (not_this_window)
2908 && XBUFFER (XWINDOW (selected_window)->buffer) == XBUFFER (buffer))
2909 return display_buffer_1 (selected_window);
2911 /* See if the user has specified this buffer should appear
2912 in the selected window. */
2913 if (NILP (not_this_window))
2915 swp = Fsame_window_p (XBUFFER (buffer)->name);
2916 if (!NILP (swp) && !no_switch_window (selected_window))
2918 Fswitch_to_buffer (buffer, Qnil);
2919 return display_buffer_1 (selected_window);
2923 /* If the user wants pop-up-frames or display-reuse-frames, then
2924 look for a window showing BUFFER on any visible or iconified frame.
2925 Otherwise search only the current frame. */
2926 if (! NILP (frame))
2927 tem = frame;
2928 else if (pop_up_frames
2929 || display_buffer_reuse_frames
2930 || last_nonminibuf_frame == 0)
2931 XSETFASTINT (tem, 0);
2932 else
2933 XSETFRAME (tem, last_nonminibuf_frame);
2935 window = Fget_buffer_window (buffer, tem);
2936 if (!NILP (window)
2937 && (NILP (not_this_window) || !EQ (window, selected_window)))
2938 return display_buffer_1 (window);
2940 /* Certain buffer names get special handling. */
2941 if (!NILP (Vspecial_display_function) && NILP (swp))
2943 tem = Fspecial_display_p (XBUFFER (buffer)->name);
2944 if (EQ (tem, Qt))
2945 return call1 (Vspecial_display_function, buffer);
2946 if (CONSP (tem))
2947 return call2 (Vspecial_display_function, buffer, tem);
2950 /* If there are no frames open that have more than a minibuffer,
2951 we need to create a new frame. */
2952 if (pop_up_frames || last_nonminibuf_frame == 0)
2954 window = Fframe_selected_window (call0 (Vpop_up_frame_function));
2955 Fset_window_buffer (window, buffer);
2956 return display_buffer_1 (window);
2959 f = SELECTED_FRAME ();
2960 if (pop_up_windows
2961 || FRAME_MINIBUF_ONLY_P (f)
2962 /* If the current frame is a special display frame,
2963 don't try to reuse its windows. */
2964 || !NILP (XWINDOW (FRAME_ROOT_WINDOW (f))->dedicated))
2966 Lisp_Object frames;
2968 frames = Qnil;
2969 if (FRAME_MINIBUF_ONLY_P (f))
2970 XSETFRAME (frames, last_nonminibuf_frame);
2971 /* Don't try to create a window if would get an error */
2972 if (split_height_threshold < window_min_height << 1)
2973 split_height_threshold = window_min_height << 1;
2975 /* Note that both Fget_largest_window and Fget_lru_window
2976 ignore minibuffers and dedicated windows.
2977 This means they can return nil. */
2979 /* If the frame we would try to split cannot be split,
2980 try other frames. */
2981 if (FRAME_NO_SPLIT_P (NILP (frames) ? f : last_nonminibuf_frame))
2983 /* Try visible frames first. */
2984 window = Fget_largest_window (Qvisible);
2985 /* If that didn't work, try iconified frames. */
2986 if (NILP (window))
2987 window = Fget_largest_window (make_number (0));
2988 if (NILP (window))
2989 window = Fget_largest_window (Qt);
2991 else
2992 window = Fget_largest_window (frames);
2994 /* If we got a tall enough full-width window that can be split,
2995 split it. */
2996 if (!NILP (window)
2997 && ! FRAME_NO_SPLIT_P (XFRAME (XWINDOW (window)->frame))
2998 && window_height (window) >= split_height_threshold
2999 && WINDOW_FULL_WIDTH_P (XWINDOW (window)))
3000 window = Fsplit_window (window, Qnil, Qnil);
3001 else
3003 Lisp_Object upper, lower, other;
3005 window = Fget_lru_window (frames);
3006 /* If the LRU window is selected, and big enough,
3007 and can be split, split it. */
3008 if (!NILP (window)
3009 && ! FRAME_NO_SPLIT_P (XFRAME (XWINDOW (window)->frame))
3010 && (EQ (window, selected_window)
3011 || EQ (XWINDOW (window)->parent, Qnil))
3012 && window_height (window) >= window_min_height << 1)
3013 window = Fsplit_window (window, Qnil, Qnil);
3014 /* If Fget_lru_window returned nil, try other approaches. */
3016 /* Try visible frames first. */
3017 if (NILP (window))
3018 window = Fget_buffer_window (buffer, Qvisible);
3019 if (NILP (window))
3020 window = Fget_largest_window (Qvisible);
3021 /* If that didn't work, try iconified frames. */
3022 if (NILP (window))
3023 window = Fget_buffer_window (buffer, make_number (0));
3024 if (NILP (window))
3025 window = Fget_largest_window (make_number (0));
3026 /* Try invisible frames. */
3027 if (NILP (window))
3028 window = Fget_buffer_window (buffer, Qt);
3029 if (NILP (window))
3030 window = Fget_largest_window (Qt);
3031 /* As a last resort, make a new frame. */
3032 if (NILP (window))
3033 window = Fframe_selected_window (call0 (Vpop_up_frame_function));
3034 /* If window appears above or below another,
3035 even out their heights. */
3036 other = upper = lower = Qnil;
3037 if (!NILP (XWINDOW (window)->prev))
3038 other = upper = XWINDOW (window)->prev, lower = window;
3039 if (!NILP (XWINDOW (window)->next))
3040 other = lower = XWINDOW (window)->next, upper = window;
3041 if (!NILP (other)
3042 && !NILP (Veven_window_heights)
3043 /* Check that OTHER and WINDOW are vertically arrayed. */
3044 && !EQ (XWINDOW (other)->top, XWINDOW (window)->top)
3045 && (XFASTINT (XWINDOW (other)->height)
3046 > XFASTINT (XWINDOW (window)->height)))
3048 int total = (XFASTINT (XWINDOW (other)->height)
3049 + XFASTINT (XWINDOW (window)->height));
3050 enlarge_window (upper,
3051 total / 2 - XFASTINT (XWINDOW (upper)->height),
3056 else
3057 window = Fget_lru_window (Qnil);
3059 Fset_window_buffer (window, buffer);
3060 return display_buffer_1 (window);
3063 void
3064 temp_output_buffer_show (buf)
3065 register Lisp_Object buf;
3067 register struct buffer *old = current_buffer;
3068 register Lisp_Object window;
3069 register struct window *w;
3071 XBUFFER (buf)->directory = current_buffer->directory;
3073 Fset_buffer (buf);
3074 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3075 BEGV = BEG;
3076 ZV = Z;
3077 SET_PT (BEG);
3078 XBUFFER (buf)->prevent_redisplay_optimizations_p = 1;
3079 set_buffer_internal (old);
3081 if (!EQ (Vtemp_buffer_show_function, Qnil))
3082 call1 (Vtemp_buffer_show_function, buf);
3083 else
3085 window = Fdisplay_buffer (buf, Qnil, Qnil);
3087 if (!EQ (XWINDOW (window)->frame, selected_frame))
3088 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3089 Vminibuf_scroll_window = window;
3090 w = XWINDOW (window);
3091 XSETFASTINT (w->hscroll, 0);
3092 XSETFASTINT (w->min_hscroll, 0);
3093 set_marker_restricted_both (w->start, buf, 1, 1);
3094 set_marker_restricted_both (w->pointm, buf, 1, 1);
3096 /* Run temp-buffer-show-hook, with the chosen window selected
3097 and it sbuffer current. */
3098 if (!NILP (Vrun_hooks))
3100 Lisp_Object tem;
3101 tem = Fboundp (Qtemp_buffer_show_hook);
3102 if (!NILP (tem))
3104 tem = Fsymbol_value (Qtemp_buffer_show_hook);
3105 if (!NILP (tem))
3107 int count = specpdl_ptr - specpdl;
3108 Lisp_Object prev_window;
3109 prev_window = selected_window;
3111 /* Select the window that was chosen, for running the hook. */
3112 record_unwind_protect (Fselect_window, prev_window);
3113 select_window_1 (window, 0);
3114 Fset_buffer (w->buffer);
3115 call1 (Vrun_hooks, Qtemp_buffer_show_hook);
3116 select_window_1 (prev_window, 0);
3117 unbind_to (count, Qnil);
3124 static void
3125 make_dummy_parent (window)
3126 Lisp_Object window;
3128 Lisp_Object new;
3129 register struct window *o, *p;
3130 register struct Lisp_Vector *vec;
3131 int i;
3133 o = XWINDOW (window);
3134 vec = allocate_vectorlike ((EMACS_INT)VECSIZE (struct window));
3135 for (i = 0; i < VECSIZE (struct window); ++i)
3136 vec->contents[i] = ((struct Lisp_Vector *)o)->contents[i];
3137 vec->size = VECSIZE (struct window);
3138 p = (struct window *)vec;
3139 XSETWINDOW (new, p);
3141 XSETFASTINT (p->sequence_number, ++sequence_number);
3143 /* Put new into window structure in place of window */
3144 replace_window (window, new);
3146 o->next = Qnil;
3147 o->prev = Qnil;
3148 o->vchild = Qnil;
3149 o->hchild = Qnil;
3150 o->parent = new;
3152 p->start = Qnil;
3153 p->pointm = Qnil;
3154 p->buffer = Qnil;
3157 DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "",
3158 "Split WINDOW, putting SIZE lines in the first of the pair.\n\
3159 WINDOW defaults to selected one and SIZE to half its size.\n\
3160 If optional third arg HORFLAG is non-nil, split side by side\n\
3161 and put SIZE columns in the first of the pair. In that case,\n\
3162 SIZE includes that window's scroll bar, or the divider column to its right.")
3163 (window, size, horflag)
3164 Lisp_Object window, size, horflag;
3166 register Lisp_Object new;
3167 register struct window *o, *p;
3168 FRAME_PTR fo;
3169 register int size_int;
3171 if (NILP (window))
3172 window = selected_window;
3173 else
3174 CHECK_LIVE_WINDOW (window, 0);
3176 o = XWINDOW (window);
3177 fo = XFRAME (WINDOW_FRAME (o));
3179 if (NILP (size))
3181 if (!NILP (horflag))
3182 /* Calculate the size of the left-hand window, by dividing
3183 the usable space in columns by two.
3184 We round up, since the left-hand window may include
3185 a dividing line, while the right-hand may not. */
3186 size_int = (XFASTINT (o->width) + 1) >> 1;
3187 else
3188 size_int = XFASTINT (o->height) >> 1;
3190 else
3192 CHECK_NUMBER (size, 1);
3193 size_int = XINT (size);
3196 if (MINI_WINDOW_P (o))
3197 error ("Attempt to split minibuffer window");
3198 else if (window_fixed_size_p (o, !NILP (horflag), 0))
3199 error ("Attempt to split fixed-size window");
3201 check_min_window_sizes ();
3203 if (NILP (horflag))
3205 if (size_int < window_min_height)
3206 error ("Window height %d too small (after splitting)", size_int);
3207 if (size_int + window_min_height > XFASTINT (o->height))
3208 error ("Window height %d too small (after splitting)",
3209 XFASTINT (o->height) - size_int);
3210 if (NILP (o->parent)
3211 || NILP (XWINDOW (o->parent)->vchild))
3213 make_dummy_parent (window);
3214 new = o->parent;
3215 XWINDOW (new)->vchild = window;
3218 else
3220 if (size_int < window_min_width)
3221 error ("Window width %d too small (after splitting)", size_int);
3223 if (size_int + window_min_width > XFASTINT (o->width))
3224 error ("Window width %d too small (after splitting)",
3225 XFASTINT (o->width) - size_int);
3226 if (NILP (o->parent)
3227 || NILP (XWINDOW (o->parent)->hchild))
3229 make_dummy_parent (window);
3230 new = o->parent;
3231 XWINDOW (new)->hchild = window;
3235 /* Now we know that window's parent is a vertical combination
3236 if we are dividing vertically, or a horizontal combination
3237 if we are making side-by-side windows */
3239 windows_or_buffers_changed++;
3240 FRAME_WINDOW_SIZES_CHANGED (fo) = 1;
3241 new = make_window ();
3242 p = XWINDOW (new);
3244 p->frame = o->frame;
3245 p->next = o->next;
3246 if (!NILP (p->next))
3247 XWINDOW (p->next)->prev = new;
3248 p->prev = window;
3249 o->next = new;
3250 p->parent = o->parent;
3251 p->buffer = Qt;
3252 p->window_end_valid = Qnil;
3253 bzero (&p->last_cursor, sizeof p->last_cursor);
3255 /* Apportion the available frame space among the two new windows */
3257 if (!NILP (horflag))
3259 p->height = o->height;
3260 p->top = o->top;
3261 XSETFASTINT (p->width, XFASTINT (o->width) - size_int);
3262 XSETFASTINT (o->width, size_int);
3263 XSETFASTINT (p->left, XFASTINT (o->left) + size_int);
3265 else
3267 p->left = o->left;
3268 p->width = o->width;
3269 XSETFASTINT (p->height, XFASTINT (o->height) - size_int);
3270 XSETFASTINT (o->height, size_int);
3271 XSETFASTINT (p->top, XFASTINT (o->top) + size_int);
3274 /* Adjust glyph matrices. */
3275 adjust_glyphs (fo);
3276 Fset_window_buffer (new, o->buffer);
3277 return new;
3280 DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 2, "p",
3281 "Make current window ARG lines bigger.\n\
3282 From program, optional second arg non-nil means grow sideways ARG columns.")
3283 (arg, side)
3284 register Lisp_Object arg, side;
3286 CHECK_NUMBER (arg, 0);
3287 enlarge_window (selected_window, XINT (arg), !NILP (side));
3289 if (! NILP (Vwindow_configuration_change_hook))
3290 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
3292 return Qnil;
3295 DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 2, "p",
3296 "Make current window ARG lines smaller.\n\
3297 From program, optional second arg non-nil means shrink sideways arg columns.")
3298 (arg, side)
3299 register Lisp_Object arg, side;
3301 CHECK_NUMBER (arg, 0);
3302 enlarge_window (selected_window, -XINT (arg), !NILP (side));
3304 if (! NILP (Vwindow_configuration_change_hook))
3305 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
3307 return Qnil;
3311 window_height (window)
3312 Lisp_Object window;
3314 register struct window *p = XWINDOW (window);
3315 return XFASTINT (p->height);
3319 window_width (window)
3320 Lisp_Object window;
3322 register struct window *p = XWINDOW (window);
3323 return XFASTINT (p->width);
3327 #define CURBEG(w) \
3328 *(widthflag ? &(XWINDOW (w)->left) : &(XWINDOW (w)->top))
3330 #define CURSIZE(w) \
3331 *(widthflag ? &(XWINDOW (w)->width) : &(XWINDOW (w)->height))
3334 /* Enlarge selected_window by DELTA. WIDTHFLAG non-zero means
3335 increase its width. Siblings of the selected window are resized to
3336 fullfil the size request. If they become too small in the process,
3337 they will be deleted. */
3339 static void
3340 enlarge_window (window, delta, widthflag)
3341 Lisp_Object window;
3342 int delta, widthflag;
3344 Lisp_Object parent, next, prev;
3345 struct window *p;
3346 Lisp_Object *sizep;
3347 int maximum;
3348 int (*sizefun) P_ ((Lisp_Object))
3349 = widthflag ? window_width : window_height;
3350 void (*setsizefun) P_ ((Lisp_Object, int, int))
3351 = (widthflag ? set_window_width : set_window_height);
3353 /* Check values of window_min_width and window_min_height for
3354 validity. */
3355 check_min_window_sizes ();
3357 /* Give up if this window cannot be resized. */
3358 if (window_fixed_size_p (XWINDOW (window), widthflag, 1))
3359 error ("Window is not resizable");
3361 /* Find the parent of the selected window. */
3362 while (1)
3364 p = XWINDOW (window);
3365 parent = p->parent;
3367 if (NILP (parent))
3369 if (widthflag)
3370 error ("No other window to side of this one");
3371 break;
3374 if (widthflag
3375 ? !NILP (XWINDOW (parent)->hchild)
3376 : !NILP (XWINDOW (parent)->vchild))
3377 break;
3379 window = parent;
3382 sizep = &CURSIZE (window);
3385 register int maxdelta;
3387 maxdelta = (!NILP (parent) ? (*sizefun) (parent) - XINT (*sizep)
3388 : !NILP (p->next) ? ((*sizefun) (p->next)
3389 - window_min_size (XWINDOW (p->next),
3390 widthflag, 0, 0))
3391 : !NILP (p->prev) ? ((*sizefun) (p->prev)
3392 - window_min_size (XWINDOW (p->prev),
3393 widthflag, 0, 0))
3394 /* This is a frame with only one window, a minibuffer-only
3395 or a minibufferless frame. */
3396 : (delta = 0));
3398 if (delta > maxdelta)
3399 /* This case traps trying to make the minibuffer
3400 the full frame, or make the only window aside from the
3401 minibuffer the full frame. */
3402 delta = maxdelta;
3405 if (XINT (*sizep) + delta < window_min_size (XWINDOW (window), widthflag, 0, 0))
3407 delete_window (window);
3408 return;
3411 if (delta == 0)
3412 return;
3414 /* Find the total we can get from other siblings. */
3415 maximum = 0;
3416 for (next = p->next; ! NILP (next); next = XWINDOW (next)->next)
3417 maximum += (*sizefun) (next) - window_min_size (XWINDOW (next),
3418 widthflag, 0, 0);
3419 for (prev = p->prev; ! NILP (prev); prev = XWINDOW (prev)->prev)
3420 maximum += (*sizefun) (prev) - window_min_size (XWINDOW (prev),
3421 widthflag, 0, 0);
3423 /* If we can get it all from them, do so. */
3424 if (delta <= maximum)
3426 Lisp_Object first_unaffected;
3427 Lisp_Object first_affected;
3428 int fixed_p;
3430 next = p->next;
3431 prev = p->prev;
3432 first_affected = window;
3433 /* Look at one sibling at a time,
3434 moving away from this window in both directions alternately,
3435 and take as much as we can get without deleting that sibling. */
3436 while (delta != 0 && (!NILP (next) || !NILP (prev)))
3438 if (! NILP (next))
3440 int this_one = ((*sizefun) (next)
3441 - window_min_size (XWINDOW (next),
3442 widthflag, 0, &fixed_p));
3443 if (!fixed_p)
3445 if (this_one > delta)
3446 this_one = delta;
3448 (*setsizefun) (next, (*sizefun) (next) - this_one, 0);
3449 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
3451 delta -= this_one;
3454 next = XWINDOW (next)->next;
3457 if (delta == 0)
3458 break;
3460 if (! NILP (prev))
3462 int this_one = ((*sizefun) (prev)
3463 - window_min_size (XWINDOW (prev),
3464 widthflag, 0, &fixed_p));
3465 if (!fixed_p)
3467 if (this_one > delta)
3468 this_one = delta;
3470 first_affected = prev;
3472 (*setsizefun) (prev, (*sizefun) (prev) - this_one, 0);
3473 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
3475 delta -= this_one;
3478 prev = XWINDOW (prev)->prev;
3482 xassert (delta == 0);
3484 /* Now recalculate the edge positions of all the windows affected,
3485 based on the new sizes. */
3486 first_unaffected = next;
3487 prev = first_affected;
3488 for (next = XWINDOW (prev)->next; ! EQ (next, first_unaffected);
3489 prev = next, next = XWINDOW (next)->next)
3491 XSETINT (CURBEG (next), XINT (CURBEG (prev)) + (*sizefun) (prev));
3492 /* This does not change size of NEXT,
3493 but it propagates the new top edge to its children */
3494 (*setsizefun) (next, (*sizefun) (next), 0);
3497 else
3499 register int delta1;
3500 register int opht = (*sizefun) (parent);
3502 /* If trying to grow this window to or beyond size of the parent,
3503 make delta1 so big that, on shrinking back down,
3504 all the siblings end up with less than one line and are deleted. */
3505 if (opht <= XINT (*sizep) + delta)
3506 delta1 = opht * opht * 2;
3507 else
3509 /* Otherwise, make delta1 just right so that if we add
3510 delta1 lines to this window and to the parent, and then
3511 shrink the parent back to its original size, the new
3512 proportional size of this window will increase by delta.
3514 The function size_window will compute the new height h'
3515 of the window from delta1 as:
3517 e = delta1/n
3518 x = delta1 - delta1/n * n for the 1st resizable child
3519 h' = h + e + x
3521 where n is the number of children that can be resized.
3522 We can ignore x by choosing a delta1 that is a multiple of
3523 n. We want the height of this window to come out as
3525 h' = h + delta
3527 So, delta1 must be
3529 h + e = h + delta
3530 delta1/n = delta
3531 delta1 = n * delta.
3533 The number of children n rquals the number of resizable
3534 children of this window + 1 because we know window itself
3535 is resizable (otherwise we would have signalled an error. */
3537 struct window *w = XWINDOW (window);
3538 Lisp_Object s;
3539 int n = 1;
3541 for (s = w->next; !NILP (s); s = XWINDOW (s)->next)
3542 if (!window_fixed_size_p (XWINDOW (s), widthflag, 0))
3543 ++n;
3544 for (s = w->prev; !NILP (s); s = XWINDOW (s)->prev)
3545 if (!window_fixed_size_p (XWINDOW (s), widthflag, 0))
3546 ++n;
3548 delta1 = n * delta;
3551 /* Add delta1 lines or columns to this window, and to the parent,
3552 keeping things consistent while not affecting siblings. */
3553 XSETINT (CURSIZE (parent), opht + delta1);
3554 (*setsizefun) (window, XINT (*sizep) + delta1, 0);
3556 /* Squeeze out delta1 lines or columns from our parent,
3557 shriking this window and siblings proportionately.
3558 This brings parent back to correct size.
3559 Delta1 was calculated so this makes this window the desired size,
3560 taking it all out of the siblings. */
3561 (*setsizefun) (parent, opht, 0);
3564 XSETFASTINT (p->last_modified, 0);
3565 XSETFASTINT (p->last_overlay_modified, 0);
3567 /* Adjust glyph matrices. */
3568 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
3571 #undef CURBEG
3572 #undef CURSIZE
3576 /***********************************************************************
3577 Resizing Mini-Windows
3578 ***********************************************************************/
3580 static void shrink_window_lowest_first P_ ((struct window *, int));
3582 enum save_restore_action
3584 CHECK_ORIG_SIZES,
3585 SAVE_ORIG_SIZES,
3586 RESTORE_ORIG_SIZES
3589 static int save_restore_orig_size P_ ((struct window *,
3590 enum save_restore_action));
3592 /* Shrink windows rooted in window W to HEIGHT. Take the space needed
3593 from lowest windows first. */
3595 static void
3596 shrink_window_lowest_first (w, height)
3597 struct window *w;
3598 int height;
3600 struct window *c;
3601 Lisp_Object child;
3602 int old_height;
3604 xassert (!MINI_WINDOW_P (w));
3606 /* Set redisplay hints. */
3607 XSETFASTINT (w->last_modified, 0);
3608 XSETFASTINT (w->last_overlay_modified, 0);
3609 windows_or_buffers_changed++;
3610 FRAME_WINDOW_SIZES_CHANGED (XFRAME (WINDOW_FRAME (w))) = 1;
3612 old_height = XFASTINT (w->height);
3613 XSETFASTINT (w->height, height);
3615 if (!NILP (w->hchild))
3617 for (child = w->hchild; !NILP (child); child = c->next)
3619 c = XWINDOW (child);
3620 c->top = w->top;
3621 shrink_window_lowest_first (c, height);
3624 else if (!NILP (w->vchild))
3626 Lisp_Object last_child;
3627 int delta = old_height - height;
3628 int last_top;
3630 last_child = Qnil;
3632 /* Find the last child. We are taking space from lowest windows
3633 first, so we iterate over children from the last child
3634 backwards. */
3635 for (child = w->vchild; !NILP (child); child = XWINDOW (child)->next)
3636 last_child = child;
3638 /* Assign new heights. We leave only MIN_SAFE_WINDOW_HEIGHT. */
3639 for (child = last_child; delta && !NILP (child); child = c->prev)
3641 int this_one;
3643 c = XWINDOW (child);
3644 this_one = XFASTINT (c->height) - MIN_SAFE_WINDOW_HEIGHT;
3646 if (this_one > delta)
3647 this_one = delta;
3649 shrink_window_lowest_first (c, XFASTINT (c->height) - this_one);
3650 delta -= this_one;
3653 /* Compute new positions. */
3654 last_top = XINT (w->top);
3655 for (child = w->vchild; !NILP (child); child = c->next)
3657 c = XWINDOW (child);
3658 c->top = make_number (last_top);
3659 shrink_window_lowest_first (c, XFASTINT (c->height));
3660 last_top += XFASTINT (c->height);
3666 /* Save, restore, or check positions and sizes in the window tree
3667 rooted at W. ACTION says what to do.
3669 If ACTION is CHECK_ORIG_SIZES, check if orig_top and orig_height
3670 members are valid for all windows in the window tree. Value is
3671 non-zero if they are valid.
3673 If ACTION is SAVE_ORIG_SIZES, save members top and height in
3674 orig_top and orig_height for all windows in the tree.
3676 If ACTION is RESTORE_ORIG_SIZES, restore top and height from
3677 values stored in orig_top and orig_height for all windows. */
3679 static int
3680 save_restore_orig_size (w, action)
3681 struct window *w;
3682 enum save_restore_action action;
3684 int success_p = 1;
3686 while (w)
3688 if (!NILP (w->hchild))
3690 if (!save_restore_orig_size (XWINDOW (w->hchild), action))
3691 success_p = 0;
3693 else if (!NILP (w->vchild))
3695 if (!save_restore_orig_size (XWINDOW (w->vchild), action))
3696 success_p = 0;
3699 switch (action)
3701 case CHECK_ORIG_SIZES:
3702 if (!INTEGERP (w->orig_top) || !INTEGERP (w->orig_height))
3703 return 0;
3704 break;
3706 case SAVE_ORIG_SIZES:
3707 w->orig_top = w->top;
3708 w->orig_height = w->height;
3709 XSETFASTINT (w->last_modified, 0);
3710 XSETFASTINT (w->last_overlay_modified, 0);
3711 break;
3713 case RESTORE_ORIG_SIZES:
3714 xassert (INTEGERP (w->orig_top) && INTEGERP (w->orig_height));
3715 w->top = w->orig_top;
3716 w->height = w->orig_height;
3717 w->orig_height = w->orig_top = Qnil;
3718 XSETFASTINT (w->last_modified, 0);
3719 XSETFASTINT (w->last_overlay_modified, 0);
3720 break;
3722 default:
3723 abort ();
3726 w = NILP (w->next) ? NULL : XWINDOW (w->next);
3729 return success_p;
3733 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we can
3734 without deleting other windows. */
3736 void
3737 grow_mini_window (w, delta)
3738 struct window *w;
3739 int delta;
3741 struct frame *f = XFRAME (w->frame);
3742 struct window *root;
3744 xassert (MINI_WINDOW_P (w));
3745 xassert (delta >= 0);
3747 /* Check values of window_min_width and window_min_height for
3748 validity. */
3749 check_min_window_sizes ();
3751 /* Compute how much we can enlarge the mini-window without deleting
3752 other windows. */
3753 root = XWINDOW (FRAME_ROOT_WINDOW (f));
3754 if (delta)
3756 int min_height = window_min_size (root, 0, 0, 0);
3757 if (XFASTINT (root->height) - delta < min_height)
3758 delta = XFASTINT (root->height) - min_height;
3761 if (delta)
3763 /* Save original window sizes and positions, if not already done. */
3764 if (!save_restore_orig_size (root, CHECK_ORIG_SIZES))
3765 save_restore_orig_size (root, SAVE_ORIG_SIZES);
3767 /* Shrink other windows. */
3768 shrink_window_lowest_first (root, XFASTINT (root->height) - delta);
3770 /* Grow the mini-window. */
3771 w->top = make_number (XFASTINT (root->top) + XFASTINT (root->height));
3772 w->height = make_number (XFASTINT (w->height) + delta);
3773 XSETFASTINT (w->last_modified, 0);
3774 XSETFASTINT (w->last_overlay_modified, 0);
3776 adjust_glyphs (f);
3781 /* Shrink mini-window W. If there is recorded info about window sizes
3782 before a call to grow_mini_window, restore recorded window sizes.
3783 Otherwise, if the mini-window is higher than 1 line, resize it to 1
3784 line. */
3786 void
3787 shrink_mini_window (w)
3788 struct window *w;
3790 struct frame *f = XFRAME (w->frame);
3791 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
3793 if (save_restore_orig_size (root, CHECK_ORIG_SIZES))
3795 save_restore_orig_size (root, RESTORE_ORIG_SIZES);
3796 adjust_glyphs (f);
3797 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3798 windows_or_buffers_changed = 1;
3800 else if (XFASTINT (w->height) > 1)
3802 Lisp_Object window;
3803 XSETWINDOW (window, w);
3804 enlarge_window (window, 1 - XFASTINT (w->height), 0);
3810 /* Mark window cursors off for all windows in the window tree rooted
3811 at W by setting their phys_cursor_on_p flag to zero. Called from
3812 xterm.c, e.g. when a frame is cleared and thereby all cursors on
3813 the frame are cleared. */
3815 void
3816 mark_window_cursors_off (w)
3817 struct window *w;
3819 while (w)
3821 if (!NILP (w->hchild))
3822 mark_window_cursors_off (XWINDOW (w->hchild));
3823 else if (!NILP (w->vchild))
3824 mark_window_cursors_off (XWINDOW (w->vchild));
3825 else
3826 w->phys_cursor_on_p = 0;
3828 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3833 /* Return number of lines of text (not counting mode line) in W. */
3836 window_internal_height (w)
3837 struct window *w;
3839 int ht = XFASTINT (w->height);
3841 if (MINI_WINDOW_P (w))
3842 return ht;
3844 if (!NILP (w->parent) || !NILP (w->vchild) || !NILP (w->hchild)
3845 || !NILP (w->next) || !NILP (w->prev)
3846 || FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (w))))
3847 return ht - 1;
3849 return ht;
3853 /* Return the number of columns in W.
3854 Don't count columns occupied by scroll bars or the vertical bar
3855 separating W from the sibling to its right. */
3858 window_internal_width (w)
3859 struct window *w;
3861 struct frame *f = XFRAME (WINDOW_FRAME (w));
3862 int width = XINT (w->width);
3864 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
3865 /* Scroll bars occupy a few columns. */
3866 width -= FRAME_SCROLL_BAR_COLS (f);
3867 else if (!WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
3868 /* The column of `|' characters separating side-by-side windows
3869 occupies one column only. */
3870 width -= 1;
3872 /* On window-systems, areas to the left and right of the window
3873 are used to display bitmaps there. */
3874 if (FRAME_WINDOW_P (f))
3875 width -= FRAME_FLAGS_AREA_COLS (f);
3877 return width;
3881 /************************************************************************
3882 Window Scrolling
3883 ***********************************************************************/
3885 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
3886 one screen-full, which is defined as the height of the window minus
3887 next_screen_context_lines. If WHOLE is zero, scroll up N lines
3888 instead. Negative values of N mean scroll down. NOERROR non-zero
3889 means don't signal an error if we try to move over BEGV or ZV,
3890 respectively. */
3892 static void
3893 window_scroll (window, n, whole, noerror)
3894 Lisp_Object window;
3895 int n;
3896 int whole;
3897 int noerror;
3899 /* If we must, use the pixel-based version which is much slower than
3900 the line-based one but can handle varying line heights. */
3901 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
3902 window_scroll_pixel_based (window, n, whole, noerror);
3903 else
3904 window_scroll_line_based (window, n, whole, noerror);
3908 /* Implementation of window_scroll that works based on pixel line
3909 heights. See the comment of window_scroll for parameter
3910 descriptions. */
3912 static void
3913 window_scroll_pixel_based (window, n, whole, noerror)
3914 Lisp_Object window;
3915 int n;
3916 int whole;
3917 int noerror;
3919 struct it it;
3920 struct window *w = XWINDOW (window);
3921 struct text_pos start;
3922 Lisp_Object tem;
3923 int this_scroll_margin;
3924 int preserve_y;
3925 /* True if we fiddled the window vscroll field without really scrolling. */
3926 int vscrolled = 0;
3928 SET_TEXT_POS_FROM_MARKER (start, w->start);
3930 /* If PT is not visible in WINDOW, move back one half of
3931 the screen. */
3932 tem = Fpos_visible_in_window_p (make_number (PT), window, Qnil);
3933 if (NILP (tem))
3935 /* Move backward half the height of the window. Performance note:
3936 vmotion used here is about 10% faster, but would give wrong
3937 results for variable height lines. */
3938 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
3939 it.current_y = it.last_visible_y;
3940 move_it_vertically (&it, -it.last_visible_y / 2);
3942 /* The function move_iterator_vertically may move over more than
3943 the specified y-distance. If it->w is small, e.g. a
3944 mini-buffer window, we may end up in front of the window's
3945 display area. This is the case when Start displaying at the
3946 start of the line containing PT in this case. */
3947 if (it.current_y <= 0)
3949 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
3950 move_it_vertically (&it, 0);
3951 it.current_y = 0;
3954 start = it.current.pos;
3957 /* If scroll_preserve_screen_position is non-zero, we try to set
3958 point in the same window line as it is now, so get that line. */
3959 if (!NILP (Vscroll_preserve_screen_position))
3961 start_display (&it, w, start);
3962 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
3963 preserve_y = it.current_y;
3965 else
3966 preserve_y = -1;
3968 /* Move iterator it from start the specified distance forward or
3969 backward. The result is the new window start. */
3970 start_display (&it, w, start);
3971 if (whole)
3973 int screen_full = (it.last_visible_y
3974 - next_screen_context_lines * CANON_Y_UNIT (it.f));
3975 int direction = n < 0 ? -1 : 1;
3976 int dy = direction * screen_full;
3978 /* Note that move_it_vertically always moves the iterator to the
3979 start of a line. So, if the last line doesn't have a newline,
3980 we would end up at the start of the line ending at ZV. */
3981 if (dy <= 0)
3982 move_it_vertically_backward (&it, -dy);
3983 else if (dy > 0)
3984 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
3985 MOVE_TO_POS | MOVE_TO_Y);
3987 else
3988 move_it_by_lines (&it, n, 1);
3990 /* End if we end up at ZV or BEGV. */
3991 if ((n > 0 && IT_CHARPOS (it) == ZV)
3992 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
3994 if (IT_CHARPOS (it) == ZV)
3996 if (it.current_y + it.max_ascent + it.max_descent
3997 > it.last_visible_y)
3999 /* The last line was only partially visible, make it fully
4000 visible. */
4001 w->vscroll = (it.last_visible_y
4002 - it.current_y + it.max_ascent + it.max_descent);
4003 adjust_glyphs (it.f);
4005 else if (noerror)
4006 return;
4007 else
4008 Fsignal (Qend_of_buffer, Qnil);
4010 else
4012 if (w->vscroll != 0)
4013 /* The first line was only partially visible, make it fully
4014 visible. */
4015 w->vscroll = 0;
4016 else if (noerror)
4017 return;
4018 else
4019 Fsignal (Qbeginning_of_buffer, Qnil);
4022 /* If control gets here, then we vscrolled. */
4024 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4026 /* Don't try to change the window start below. */
4027 vscrolled = 1;
4030 if (! vscrolled)
4032 /* Set the window start, and set up the window for redisplay. */
4033 set_marker_restricted (w->start, make_number (IT_CHARPOS (it)),
4034 w->buffer);
4035 w->start_at_line_beg = Fbolp ();
4036 w->update_mode_line = Qt;
4037 XSETFASTINT (w->last_modified, 0);
4038 XSETFASTINT (w->last_overlay_modified, 0);
4039 /* Set force_start so that redisplay_window will run the
4040 window-scroll-functions. */
4041 w->force_start = Qt;
4044 it.current_y = it.vpos = 0;
4046 /* Preserve the screen position if we must. */
4047 if (preserve_y >= 0)
4049 move_it_to (&it, -1, -1, preserve_y, -1, MOVE_TO_Y);
4050 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4052 else
4054 /* Move PT out of scroll margins. */
4055 this_scroll_margin = max (0, scroll_margin);
4056 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->height) / 4);
4057 this_scroll_margin *= CANON_Y_UNIT (it.f);
4059 if (n > 0)
4061 /* We moved the window start towards ZV, so PT may be now
4062 in the scroll margin at the top. */
4063 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4064 while (it.current_y < this_scroll_margin)
4065 move_it_by_lines (&it, 1, 1);
4066 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4068 else if (n < 0)
4070 int charpos, bytepos;
4072 /* We moved the window start towards BEGV, so PT may be now
4073 in the scroll margin at the bottom. */
4074 move_it_to (&it, PT, -1,
4075 it.last_visible_y - this_scroll_margin - 1, -1,
4076 MOVE_TO_POS | MOVE_TO_Y);
4078 /* Save our position, in case it's correct. */
4079 charpos = IT_CHARPOS (it);
4080 bytepos = IT_BYTEPOS (it);
4082 /* See if point is on a partially visible line at the end. */
4083 move_it_by_lines (&it, 1, 1);
4084 if (it.current_y > it.last_visible_y)
4085 /* The last line was only partially visible, so back up two
4086 lines to make sure we're on a fully visible line. */
4088 move_it_by_lines (&it, -2, 0);
4089 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4091 else
4092 /* No, the position we saved is OK, so use it. */
4093 SET_PT_BOTH (charpos, bytepos);
4099 /* Implementation of window_scroll that works based on screen lines.
4100 See the comment of window_scroll for parameter descriptions. */
4102 static void
4103 window_scroll_line_based (window, n, whole, noerror)
4104 Lisp_Object window;
4105 int n;
4106 int whole;
4107 int noerror;
4109 register struct window *w = XWINDOW (window);
4110 register int opoint = PT, opoint_byte = PT_BYTE;
4111 register int pos, pos_byte;
4112 register int ht = window_internal_height (w);
4113 register Lisp_Object tem;
4114 int lose;
4115 Lisp_Object bolp;
4116 int startpos;
4117 struct position posit;
4118 int original_vpos;
4120 startpos = marker_position (w->start);
4122 posit = *compute_motion (startpos, 0, 0, 0,
4123 PT, ht, 0,
4124 window_internal_width (w), XINT (w->hscroll),
4125 0, w);
4126 original_vpos = posit.vpos;
4128 XSETFASTINT (tem, PT);
4129 tem = Fpos_visible_in_window_p (tem, window, Qnil);
4131 if (NILP (tem))
4133 Fvertical_motion (make_number (- (ht / 2)), window);
4134 startpos = PT;
4137 SET_PT (startpos);
4138 lose = n < 0 && PT == BEGV;
4139 Fvertical_motion (make_number (n), window);
4140 pos = PT;
4141 pos_byte = PT_BYTE;
4142 bolp = Fbolp ();
4143 SET_PT_BOTH (opoint, opoint_byte);
4145 if (lose)
4147 if (noerror)
4148 return;
4149 else
4150 Fsignal (Qbeginning_of_buffer, Qnil);
4153 if (pos < ZV)
4155 int this_scroll_margin = scroll_margin;
4157 /* Don't use a scroll margin that is negative or too large. */
4158 if (this_scroll_margin < 0)
4159 this_scroll_margin = 0;
4161 if (XINT (w->height) < 4 * scroll_margin)
4162 this_scroll_margin = XINT (w->height) / 4;
4164 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
4165 w->start_at_line_beg = bolp;
4166 w->update_mode_line = Qt;
4167 XSETFASTINT (w->last_modified, 0);
4168 XSETFASTINT (w->last_overlay_modified, 0);
4169 /* Set force_start so that redisplay_window will run
4170 the window-scroll-functions. */
4171 w->force_start = Qt;
4173 if (whole && !NILP (Vscroll_preserve_screen_position))
4175 SET_PT_BOTH (pos, pos_byte);
4176 Fvertical_motion (make_number (original_vpos), window);
4178 /* If we scrolled forward, put point enough lines down
4179 that it is outside the scroll margin. */
4180 else if (n > 0)
4182 int top_margin;
4184 if (this_scroll_margin > 0)
4186 SET_PT_BOTH (pos, pos_byte);
4187 Fvertical_motion (make_number (this_scroll_margin), window);
4188 top_margin = PT;
4190 else
4191 top_margin = pos;
4193 if (top_margin <= opoint)
4194 SET_PT_BOTH (opoint, opoint_byte);
4195 else if (!NILP (Vscroll_preserve_screen_position))
4197 SET_PT_BOTH (pos, pos_byte);
4198 Fvertical_motion (make_number (original_vpos), window);
4200 else
4201 SET_PT (top_margin);
4203 else if (n < 0)
4205 int bottom_margin;
4207 /* If we scrolled backward, put point near the end of the window
4208 but not within the scroll margin. */
4209 SET_PT_BOTH (pos, pos_byte);
4210 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
4211 if (XFASTINT (tem) == ht - this_scroll_margin)
4212 bottom_margin = PT;
4213 else
4214 bottom_margin = PT + 1;
4216 if (bottom_margin > opoint)
4217 SET_PT_BOTH (opoint, opoint_byte);
4218 else
4220 if (!NILP (Vscroll_preserve_screen_position))
4222 SET_PT_BOTH (pos, pos_byte);
4223 Fvertical_motion (make_number (original_vpos), window);
4225 else
4226 Fvertical_motion (make_number (-1), window);
4230 else
4232 if (noerror)
4233 return;
4234 else
4235 Fsignal (Qend_of_buffer, Qnil);
4240 /* Scroll selected_window up or down. If N is nil, scroll a
4241 screen-full which is defined as the height of the window minus
4242 next_screen_context_lines. If N is the symbol `-', scroll.
4243 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4244 up. This is the guts of Fscroll_up and Fscroll_down. */
4246 static void
4247 scroll_command (n, direction)
4248 Lisp_Object n;
4249 int direction;
4251 register int defalt;
4252 int count = specpdl_ptr - specpdl;
4254 xassert (abs (direction) == 1);
4256 /* If selected window's buffer isn't current, make it current for
4257 the moment. But don't screw up if window_scroll gets an error. */
4258 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
4260 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4261 Fset_buffer (XWINDOW (selected_window)->buffer);
4263 /* Make redisplay consider other windows than just selected_window. */
4264 ++windows_or_buffers_changed;
4267 defalt = (window_internal_height (XWINDOW (selected_window))
4268 - next_screen_context_lines);
4269 defalt = direction * (defalt < 1 ? 1 : defalt);
4271 if (NILP (n))
4272 window_scroll (selected_window, defalt, 1, 0);
4273 else if (EQ (n, Qminus))
4274 window_scroll (selected_window, - defalt, 1, 0);
4275 else
4277 n = Fprefix_numeric_value (n);
4278 window_scroll (selected_window, XINT (n) * direction, 0, 0);
4281 unbind_to (count, Qnil);
4284 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "P",
4285 "Scroll text of current window upward ARG lines; or near full screen if no ARG.\n\
4286 A near full screen is `next-screen-context-lines' less than a full screen.\n\
4287 Negative ARG means scroll downward.\n\
4288 If ARG is the atom `-', scroll downward by nearly full screen.\n\
4289 When calling from a program, supply as argument a number, nil, or `-'.")
4290 (arg)
4291 Lisp_Object arg;
4293 scroll_command (arg, 1);
4294 return Qnil;
4297 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "P",
4298 "Scroll text of current window down ARG lines; or near full screen if no ARG.\n\
4299 A near full screen is `next-screen-context-lines' less than a full screen.\n\
4300 Negative ARG means scroll upward.\n\
4301 If ARG is the atom `-', scroll upward by nearly full screen.\n\
4302 When calling from a program, supply as argument a number, nil, or `-'.")
4303 (arg)
4304 Lisp_Object arg;
4306 scroll_command (arg, -1);
4307 return Qnil;
4310 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
4311 "Return the other window for \"other window scroll\" commands.\n\
4312 If in the minibuffer, `minibuffer-scroll-window' if non-nil\n\
4313 specifies the window.\n\
4314 If `other-window-scroll-buffer' is non-nil, a window\n\
4315 showing that buffer is used.")
4318 Lisp_Object window;
4320 if (MINI_WINDOW_P (XWINDOW (selected_window))
4321 && !NILP (Vminibuf_scroll_window))
4322 window = Vminibuf_scroll_window;
4323 /* If buffer is specified, scroll that buffer. */
4324 else if (!NILP (Vother_window_scroll_buffer))
4326 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
4327 if (NILP (window))
4328 window = Fdisplay_buffer (Vother_window_scroll_buffer, Qt, Qnil);
4330 else
4332 /* Nothing specified; look for a neighboring window on the same
4333 frame. */
4334 window = Fnext_window (selected_window, Qnil, Qnil);
4336 if (EQ (window, selected_window))
4337 /* That didn't get us anywhere; look for a window on another
4338 visible frame. */
4340 window = Fnext_window (window, Qnil, Qt);
4341 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
4342 && ! EQ (window, selected_window));
4345 CHECK_LIVE_WINDOW (window, 0);
4347 if (EQ (window, selected_window))
4348 error ("There is no other window");
4350 return window;
4353 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
4354 "Scroll next window upward ARG lines; or near full screen if no ARG.\n\
4355 A near full screen is `next-screen-context-lines' less than a full screen.\n\
4356 The next window is the one below the current one; or the one at the top\n\
4357 if the current one is at the bottom. Negative ARG means scroll downward.\n\
4358 If ARG is the atom `-', scroll downward by nearly full screen.\n\
4359 When calling from a program, supply as argument a number, nil, or `-'.\n\
4361 If in the minibuffer, `minibuffer-scroll-window' if non-nil\n\
4362 specifies the window to scroll.\n\
4363 If `other-window-scroll-buffer' is non-nil, scroll the window\n\
4364 showing that buffer, popping the buffer up if necessary.")
4365 (arg)
4366 register Lisp_Object arg;
4368 register Lisp_Object window;
4369 register int defalt;
4370 register struct window *w;
4371 register int count = specpdl_ptr - specpdl;
4373 window = Fother_window_for_scrolling ();
4375 w = XWINDOW (window);
4376 defalt = window_internal_height (w) - next_screen_context_lines;
4377 if (defalt < 1) defalt = 1;
4379 /* Don't screw up if window_scroll gets an error. */
4380 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4381 ++windows_or_buffers_changed;
4383 Fset_buffer (w->buffer);
4384 SET_PT (marker_position (w->pointm));
4386 if (NILP (arg))
4387 window_scroll (window, defalt, 1, 1);
4388 else if (EQ (arg, Qminus))
4389 window_scroll (window, -defalt, 1, 1);
4390 else
4392 if (CONSP (arg))
4393 arg = Fcar (arg);
4394 CHECK_NUMBER (arg, 0);
4395 window_scroll (window, XINT (arg), 0, 1);
4398 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
4399 unbind_to (count, Qnil);
4401 return Qnil;
4404 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 1, "P",
4405 "Scroll selected window display ARG columns left.\n\
4406 Default for ARG is window width minus 2.")
4407 (arg)
4408 register Lisp_Object arg;
4411 if (NILP (arg))
4412 XSETFASTINT (arg, window_internal_width (XWINDOW (selected_window)) - 2);
4413 else
4414 arg = Fprefix_numeric_value (arg);
4416 return
4417 Fset_window_hscroll (selected_window,
4418 make_number (XINT (XWINDOW (selected_window)->hscroll)
4419 + XINT (arg)));
4422 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 1, "P",
4423 "Scroll selected window display ARG columns right.\n\
4424 Default for ARG is window width minus 2.")
4425 (arg)
4426 register Lisp_Object arg;
4428 if (NILP (arg))
4429 XSETFASTINT (arg, window_internal_width (XWINDOW (selected_window)) - 2);
4430 else
4431 arg = Fprefix_numeric_value (arg);
4433 return
4434 Fset_window_hscroll (selected_window,
4435 make_number (XINT (XWINDOW (selected_window)->hscroll)
4436 - XINT (arg)));
4439 /* Value is the number of lines actually displayed in window W,
4440 as opposed to its height. */
4442 static int
4443 displayed_window_lines (w)
4444 struct window *w;
4446 struct it it;
4447 struct text_pos start;
4448 int height = window_box_height (w);
4449 struct buffer *old_buffer;
4450 int bottom_y;
4452 if (XBUFFER (w->buffer) != current_buffer)
4454 old_buffer = current_buffer;
4455 set_buffer_internal (XBUFFER (w->buffer));
4457 else
4458 old_buffer = NULL;
4460 SET_TEXT_POS_FROM_MARKER (start, w->start);
4461 start_display (&it, w, start);
4462 move_it_vertically (&it, height);
4464 if (old_buffer)
4465 set_buffer_internal (old_buffer);
4467 bottom_y = it.current_y + it.max_ascent + it.max_descent;
4469 if (bottom_y > it.current_y && bottom_y <= it.last_visible_y)
4470 /* Hit a line without a terminating newline. */
4471 it.vpos++;
4473 /* Add in empty lines at the bottom of the window. */
4474 if (bottom_y < height)
4476 struct frame *f = XFRAME (w->frame);
4477 int rest = height - bottom_y;
4478 int lines = rest / CANON_Y_UNIT (f);
4479 it.vpos += lines;
4482 return it.vpos;
4486 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
4487 "Center point in window and redisplay frame.\n\
4488 With prefix argument ARG, recenter putting point on screen line ARG\n\
4489 relative to the current window. If ARG is negative, it counts up from the\n\
4490 bottom of the window. (ARG should be less than the height of the window.)\n\
4492 If ARG is omitted or nil, erase the entire frame and then\n\
4493 redraw with point in the center of the current window.\n\
4494 Just C-u as prefix means put point in the center of the window\n\
4495 and redisplay normally--don't erase and redraw the frame.")
4496 (arg)
4497 register Lisp_Object arg;
4499 struct window *w = XWINDOW (selected_window);
4500 struct buffer *buf = XBUFFER (w->buffer);
4501 struct buffer *obuf = current_buffer;
4502 int center_p = 0;
4503 int charpos, bytepos;
4505 if (NILP (arg))
4507 int i;
4509 /* Invalidate pixel data calculated for all compositions. */
4510 for (i = 0; i < n_compositions; i++)
4511 composition_table[i]->font = NULL;
4513 Fredraw_frame (w->frame);
4514 SET_FRAME_GARBAGED (XFRAME (WINDOW_FRAME (w)));
4515 center_p = 1;
4517 else if (CONSP (arg)) /* Just C-u. */
4518 center_p = 1;
4519 else
4521 arg = Fprefix_numeric_value (arg);
4522 CHECK_NUMBER (arg, 0);
4525 set_buffer_internal (buf);
4527 /* Handle centering on a gfaphical frame specially. Such frames can
4528 have variable-height lines and centering point on the basis of
4529 line counts would lead to strange effects. */
4530 if (center_p && FRAME_WINDOW_P (XFRAME (w->frame)))
4532 struct it it;
4533 struct text_pos pt;
4535 SET_TEXT_POS (pt, PT, PT_BYTE);
4536 start_display (&it, w, pt);
4537 move_it_vertically (&it, - it.last_visible_y / 2);
4538 charpos = IT_CHARPOS (it);
4539 bytepos = IT_BYTEPOS (it);
4541 else
4543 struct position pos;
4545 if (center_p)
4547 int ht = displayed_window_lines (w);
4548 arg = make_number (ht / 2);
4550 else if (XINT (arg) < 0)
4552 int ht = displayed_window_lines (w);
4553 XSETINT (arg, XINT (arg) + ht);
4556 pos = *vmotion (PT, - XINT (arg), w);
4557 charpos = pos.bufpos;
4558 bytepos = pos.bytepos;
4561 /* Set the new window start. */
4562 set_marker_both (w->start, w->buffer, charpos, bytepos);
4563 w->window_end_valid = Qnil;
4564 w->force_start = Qt;
4565 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
4566 w->start_at_line_beg = Qt;
4567 else
4568 w->start_at_line_beg = Qnil;
4570 set_buffer_internal (obuf);
4571 return Qnil;
4575 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
4576 0, 1, 0,
4577 "Return the height in lines of the text display area of WINDOW.\n\
4578 This doesn't include the mode-line (or header-line if any) or any\n\
4579 partial-height lines in the text display area.")
4580 (window)
4581 Lisp_Object window;
4583 struct window *w = decode_window (window);
4584 int pixel_height = window_box_height (w);
4585 int line_height = pixel_height / CANON_Y_UNIT (XFRAME (w->frame));
4586 return make_number (line_height);
4591 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
4592 1, 1, "P",
4593 "Position point relative to window.\n\
4594 With no argument, position point at center of window.\n\
4595 An argument specifies vertical position within the window;\n\
4596 zero means top of window, negative means relative to bottom of window.")
4597 (arg)
4598 Lisp_Object arg;
4600 struct window *w = XWINDOW (selected_window);
4601 int lines, start;
4602 Lisp_Object window;
4604 window = selected_window;
4605 start = marker_position (w->start);
4606 if (start < BEGV || start > ZV)
4608 int height = window_internal_height (w);
4609 Fvertical_motion (make_number (- (height / 2)), window);
4610 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
4611 w->start_at_line_beg = Fbolp ();
4612 w->force_start = Qt;
4614 else
4615 Fgoto_char (w->start);
4617 lines = displayed_window_lines (w);
4618 if (NILP (arg))
4619 XSETFASTINT (arg, lines / 2);
4620 else
4622 arg = Fprefix_numeric_value (arg);
4623 if (XINT (arg) < 0)
4624 XSETINT (arg, XINT (arg) + lines);
4627 if (w->vscroll)
4628 /* Skip past a partially visible first line. */
4629 XSETINT (arg, XINT (arg) + 1);
4631 return Fvertical_motion (arg, window);
4636 /***********************************************************************
4637 Window Configuration
4638 ***********************************************************************/
4640 struct save_window_data
4642 EMACS_INT size_from_Lisp_Vector_struct;
4643 struct Lisp_Vector *next_from_Lisp_Vector_struct;
4644 Lisp_Object frame_width, frame_height, frame_menu_bar_lines;
4645 Lisp_Object frame_tool_bar_lines;
4646 Lisp_Object selected_frame;
4647 Lisp_Object current_window;
4648 Lisp_Object current_buffer;
4649 Lisp_Object minibuf_scroll_window;
4650 Lisp_Object root_window;
4651 Lisp_Object focus_frame;
4652 /* Record the values of window-min-width and window-min-height
4653 so that window sizes remain consistent with them. */
4654 Lisp_Object min_width, min_height;
4655 /* A vector, each of whose elements is a struct saved_window
4656 for one window. */
4657 Lisp_Object saved_windows;
4660 /* This is saved as a Lisp_Vector */
4661 struct saved_window
4663 /* these first two must agree with struct Lisp_Vector in lisp.h */
4664 EMACS_INT size_from_Lisp_Vector_struct;
4665 struct Lisp_Vector *next_from_Lisp_Vector_struct;
4667 Lisp_Object window;
4668 Lisp_Object buffer, start, pointm, mark;
4669 Lisp_Object left, top, width, height, hscroll, min_hscroll;
4670 Lisp_Object parent, prev;
4671 Lisp_Object start_at_line_beg;
4672 Lisp_Object display_table;
4673 Lisp_Object orig_top, orig_height;
4676 #define SAVED_WINDOW_VECTOR_SIZE 17 /* Arg to Fmake_vector */
4678 #define SAVED_WINDOW_N(swv,n) \
4679 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
4681 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
4682 "Return t if OBJECT is a window-configuration object.")
4683 (object)
4684 Lisp_Object object;
4686 if (WINDOW_CONFIGURATIONP (object))
4687 return Qt;
4688 return Qnil;
4691 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
4692 "Return the frame that CONFIG, a window-configuration object, is about.")
4693 (config)
4694 Lisp_Object config;
4696 register struct save_window_data *data;
4697 struct Lisp_Vector *saved_windows;
4699 if (! WINDOW_CONFIGURATIONP (config))
4700 wrong_type_argument (Qwindow_configuration_p, config);
4702 data = (struct save_window_data *) XVECTOR (config);
4703 saved_windows = XVECTOR (data->saved_windows);
4704 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
4707 DEFUN ("set-window-configuration", Fset_window_configuration,
4708 Sset_window_configuration, 1, 1, 0,
4709 "Set the configuration of windows and buffers as specified by CONFIGURATION.\n\
4710 CONFIGURATION must be a value previously returned\n\
4711 by `current-window-configuration' (which see).\n\
4712 If CONFIGURATION was made from a frame that is now deleted,\n\
4713 only frame-independent values can be restored. In this case,\n\
4714 the return value is nil. Otherwise the value is t.")
4715 (configuration)
4716 Lisp_Object configuration;
4718 register struct save_window_data *data;
4719 struct Lisp_Vector *saved_windows;
4720 Lisp_Object new_current_buffer;
4721 Lisp_Object frame;
4722 FRAME_PTR f;
4723 int old_point = -1;
4725 while (!WINDOW_CONFIGURATIONP (configuration))
4726 wrong_type_argument (Qwindow_configuration_p, configuration);
4728 data = (struct save_window_data *) XVECTOR (configuration);
4729 saved_windows = XVECTOR (data->saved_windows);
4731 new_current_buffer = data->current_buffer;
4732 if (NILP (XBUFFER (new_current_buffer)->name))
4733 new_current_buffer = Qnil;
4734 else
4736 if (XBUFFER (new_current_buffer) == current_buffer)
4737 old_point = PT;
4740 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
4741 f = XFRAME (frame);
4743 /* If f is a dead frame, don't bother rebuilding its window tree.
4744 However, there is other stuff we should still try to do below. */
4745 if (FRAME_LIVE_P (f))
4747 register struct window *w;
4748 register struct saved_window *p;
4749 struct window *root_window;
4750 struct window **leaf_windows;
4751 int n_leaf_windows;
4752 int k, i, n;
4754 /* If the frame has been resized since this window configuration was
4755 made, we change the frame to the size specified in the
4756 configuration, restore the configuration, and then resize it
4757 back. We keep track of the prevailing height in these variables. */
4758 int previous_frame_height = FRAME_HEIGHT (f);
4759 int previous_frame_width = FRAME_WIDTH (f);
4760 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
4761 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
4763 /* The mouse highlighting code could get screwed up
4764 if it runs during this. */
4765 BLOCK_INPUT;
4767 if (XFASTINT (data->frame_height) != previous_frame_height
4768 || XFASTINT (data->frame_width) != previous_frame_width)
4769 change_frame_size (f, XFASTINT (data->frame_height),
4770 XFASTINT (data->frame_width), 0, 0, 0);
4771 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
4772 if (XFASTINT (data->frame_menu_bar_lines)
4773 != previous_frame_menu_bar_lines)
4774 x_set_menu_bar_lines (f, data->frame_menu_bar_lines, make_number (0));
4775 #ifdef HAVE_WINDOW_SYSTEM
4776 if (XFASTINT (data->frame_tool_bar_lines)
4777 != previous_frame_tool_bar_lines)
4778 x_set_tool_bar_lines (f, data->frame_tool_bar_lines, make_number (0));
4779 #endif
4780 #endif
4782 /* "Swap out" point from the selected window
4783 into its buffer. We do this now, before
4784 restoring the window contents, and prevent it from
4785 being done later on when we select a new window. */
4786 if (! NILP (XWINDOW (selected_window)->buffer))
4788 w = XWINDOW (selected_window);
4789 set_marker_both (w->pointm,
4790 w->buffer,
4791 BUF_PT (XBUFFER (w->buffer)),
4792 BUF_PT_BYTE (XBUFFER (w->buffer)));
4795 windows_or_buffers_changed++;
4796 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4798 /* Problem: Freeing all matrices and later allocating them again
4799 is a serious redisplay flickering problem. What we would
4800 really like to do is to free only those matrices not reused
4801 below. */
4802 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
4803 leaf_windows
4804 = (struct window **) alloca (count_windows (root_window)
4805 * sizeof (struct window *));
4806 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
4808 /* Temporarily avoid any problems with windows that are smaller
4809 than they are supposed to be. */
4810 window_min_height = 1;
4811 window_min_width = 1;
4813 /* Kludge Alert!
4814 Mark all windows now on frame as "deleted".
4815 Restoring the new configuration "undeletes" any that are in it.
4817 Save their current buffers in their height fields, since we may
4818 need it later, if a buffer saved in the configuration is now
4819 dead. */
4820 delete_all_subwindows (XWINDOW (FRAME_ROOT_WINDOW (f)));
4822 for (k = 0; k < saved_windows->size; k++)
4824 p = SAVED_WINDOW_N (saved_windows, k);
4825 w = XWINDOW (p->window);
4826 w->next = Qnil;
4828 if (!NILP (p->parent))
4829 w->parent = SAVED_WINDOW_N (saved_windows,
4830 XFASTINT (p->parent))->window;
4831 else
4832 w->parent = Qnil;
4834 if (!NILP (p->prev))
4836 w->prev = SAVED_WINDOW_N (saved_windows,
4837 XFASTINT (p->prev))->window;
4838 XWINDOW (w->prev)->next = p->window;
4840 else
4842 w->prev = Qnil;
4843 if (!NILP (w->parent))
4845 if (EQ (p->width, XWINDOW (w->parent)->width))
4847 XWINDOW (w->parent)->vchild = p->window;
4848 XWINDOW (w->parent)->hchild = Qnil;
4850 else
4852 XWINDOW (w->parent)->hchild = p->window;
4853 XWINDOW (w->parent)->vchild = Qnil;
4858 /* If we squirreled away the buffer in the window's height,
4859 restore it now. */
4860 if (BUFFERP (w->height))
4861 w->buffer = w->height;
4862 w->left = p->left;
4863 w->top = p->top;
4864 w->width = p->width;
4865 w->height = p->height;
4866 w->hscroll = p->hscroll;
4867 w->min_hscroll = p->min_hscroll;
4868 w->display_table = p->display_table;
4869 w->orig_top = p->orig_top;
4870 w->orig_height = p->orig_height;
4871 XSETFASTINT (w->last_modified, 0);
4872 XSETFASTINT (w->last_overlay_modified, 0);
4874 /* Reinstall the saved buffer and pointers into it. */
4875 if (NILP (p->buffer))
4876 w->buffer = p->buffer;
4877 else
4879 if (!NILP (XBUFFER (p->buffer)->name))
4880 /* If saved buffer is alive, install it. */
4882 w->buffer = p->buffer;
4883 w->start_at_line_beg = p->start_at_line_beg;
4884 set_marker_restricted (w->start, p->start, w->buffer);
4885 set_marker_restricted (w->pointm, p->pointm, w->buffer);
4886 Fset_marker (XBUFFER (w->buffer)->mark,
4887 p->mark, w->buffer);
4889 /* As documented in Fcurrent_window_configuration, don't
4890 save the location of point in the buffer which was current
4891 when the window configuration was recorded. */
4892 if (!EQ (p->buffer, new_current_buffer)
4893 && XBUFFER (p->buffer) == current_buffer)
4894 Fgoto_char (w->pointm);
4896 else if (NILP (w->buffer) || NILP (XBUFFER (w->buffer)->name))
4897 /* Else unless window has a live buffer, get one. */
4899 w->buffer = Fcdr (Fcar (Vbuffer_alist));
4900 /* This will set the markers to beginning of visible
4901 range. */
4902 set_marker_restricted (w->start, make_number (0), w->buffer);
4903 set_marker_restricted (w->pointm, make_number (0),w->buffer);
4904 w->start_at_line_beg = Qt;
4906 else
4907 /* Keeping window's old buffer; make sure the markers
4908 are real. */
4910 /* Set window markers at start of visible range. */
4911 if (XMARKER (w->start)->buffer == 0)
4912 set_marker_restricted (w->start, make_number (0),
4913 w->buffer);
4914 if (XMARKER (w->pointm)->buffer == 0)
4915 set_marker_restricted_both (w->pointm, w->buffer,
4916 BUF_PT (XBUFFER (w->buffer)),
4917 BUF_PT_BYTE (XBUFFER (w->buffer)));
4918 w->start_at_line_beg = Qt;
4923 FRAME_ROOT_WINDOW (f) = data->root_window;
4924 /* Prevent "swapping out point" in the old selected window
4925 using the buffer that has been restored into it.
4926 That swapping out has already been done,
4927 near the beginning of this function. */
4928 selected_window = Qnil;
4929 Fselect_window (data->current_window);
4930 XBUFFER (XWINDOW (selected_window)->buffer)->last_selected_window
4931 = selected_window;
4933 if (NILP (data->focus_frame)
4934 || (FRAMEP (data->focus_frame)
4935 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
4936 Fredirect_frame_focus (frame, data->focus_frame);
4938 #if 0 /* I don't understand why this is needed, and it causes problems
4939 when the frame's old selected window has been deleted. */
4940 if (f != selected_frame && FRAME_WINDOW_P (f))
4941 do_switch_frame (WINDOW_FRAME (XWINDOW (data->root_window)),
4942 Qnil, 0);
4943 #endif
4945 /* Set the screen height to the value it had before this function. */
4946 if (previous_frame_height != FRAME_HEIGHT (f)
4947 || previous_frame_width != FRAME_WIDTH (f))
4948 change_frame_size (f, previous_frame_height, previous_frame_width,
4949 0, 0, 0);
4950 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
4951 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
4952 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
4953 make_number (0));
4954 #ifdef HAVE_WINDOW_SYSTEM
4955 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
4956 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
4957 make_number (0));
4958 #endif
4959 #endif
4961 /* Now, free glyph matrices in windows that were not reused. */
4962 for (i = n = 0; i < n_leaf_windows; ++i)
4964 if (NILP (leaf_windows[i]->buffer))
4966 /* Assert it's not reused as a combination. */
4967 xassert (NILP (leaf_windows[i]->hchild)
4968 && NILP (leaf_windows[i]->vchild));
4969 free_window_matrices (leaf_windows[i]);
4971 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
4972 ++n;
4975 /* If more than one window shows the new and old current buffer,
4976 don't try to preserve point in that buffer. */
4977 if (old_point > 0 && n > 1)
4978 old_point = -1;
4980 adjust_glyphs (f);
4982 UNBLOCK_INPUT;
4984 /* Fselect_window will have made f the selected frame, so we
4985 reselect the proper frame here. Fhandle_switch_frame will change the
4986 selected window too, but that doesn't make the call to
4987 Fselect_window above totally superfluous; it still sets f's
4988 selected window. */
4989 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
4990 do_switch_frame (data->selected_frame, Qnil, 0);
4992 if (! NILP (Vwindow_configuration_change_hook)
4993 && ! NILP (Vrun_hooks))
4994 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
4997 if (!NILP (new_current_buffer))
4999 Fset_buffer (new_current_buffer);
5001 /* If the buffer that is current now is the same
5002 that was current before setting the window configuration,
5003 don't alter its PT. */
5004 if (old_point >= 0)
5005 SET_PT (old_point);
5008 /* Restore the minimum heights recorded in the configuration. */
5009 window_min_height = XINT (data->min_height);
5010 window_min_width = XINT (data->min_width);
5012 Vminibuf_scroll_window = data->minibuf_scroll_window;
5014 return (FRAME_LIVE_P (f) ? Qt : Qnil);
5017 /* Mark all windows now on frame as deleted
5018 by setting their buffers to nil. */
5020 void
5021 delete_all_subwindows (w)
5022 register struct window *w;
5024 if (!NILP (w->next))
5025 delete_all_subwindows (XWINDOW (w->next));
5026 if (!NILP (w->vchild))
5027 delete_all_subwindows (XWINDOW (w->vchild));
5028 if (!NILP (w->hchild))
5029 delete_all_subwindows (XWINDOW (w->hchild));
5031 w->height = w->buffer; /* See Fset_window_configuration for excuse. */
5033 if (!NILP (w->buffer))
5034 unshow_buffer (w);
5036 /* We set all three of these fields to nil, to make sure that we can
5037 distinguish this dead window from any live window. Live leaf
5038 windows will have buffer set, and combination windows will have
5039 vchild or hchild set. */
5040 w->buffer = Qnil;
5041 w->vchild = Qnil;
5042 w->hchild = Qnil;
5044 Vwindow_list = Qnil;
5047 static int
5048 count_windows (window)
5049 register struct window *window;
5051 register int count = 1;
5052 if (!NILP (window->next))
5053 count += count_windows (XWINDOW (window->next));
5054 if (!NILP (window->vchild))
5055 count += count_windows (XWINDOW (window->vchild));
5056 if (!NILP (window->hchild))
5057 count += count_windows (XWINDOW (window->hchild));
5058 return count;
5062 /* Fill vector FLAT with leaf windows under W, starting at index I.
5063 Value is last index + 1. */
5065 static int
5066 get_leaf_windows (w, flat, i)
5067 struct window *w;
5068 struct window **flat;
5069 int i;
5071 while (w)
5073 if (!NILP (w->hchild))
5074 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
5075 else if (!NILP (w->vchild))
5076 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
5077 else
5078 flat[i++] = w;
5080 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5083 return i;
5087 /* Return a pointer to the glyph W's physical cursor is on. Value is
5088 null if W's current matrix is invalid, so that no meaningfull glyph
5089 can be returned. */
5091 struct glyph *
5092 get_phys_cursor_glyph (w)
5093 struct window *w;
5095 struct glyph_row *row;
5096 struct glyph *glyph;
5098 if (w->phys_cursor.vpos >= 0
5099 && w->phys_cursor.vpos < w->current_matrix->nrows
5100 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
5101 row->enabled_p)
5102 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
5103 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
5104 else
5105 glyph = NULL;
5107 return glyph;
5111 static int
5112 save_window_save (window, vector, i)
5113 Lisp_Object window;
5114 struct Lisp_Vector *vector;
5115 int i;
5117 register struct saved_window *p;
5118 register struct window *w;
5119 register Lisp_Object tem;
5121 for (;!NILP (window); window = w->next)
5123 p = SAVED_WINDOW_N (vector, i);
5124 w = XWINDOW (window);
5126 XSETFASTINT (w->temslot, i++);
5127 p->window = window;
5128 p->buffer = w->buffer;
5129 p->left = w->left;
5130 p->top = w->top;
5131 p->width = w->width;
5132 p->height = w->height;
5133 p->hscroll = w->hscroll;
5134 p->min_hscroll = w->min_hscroll;
5135 p->display_table = w->display_table;
5136 p->orig_top = w->orig_top;
5137 p->orig_height = w->orig_height;
5138 if (!NILP (w->buffer))
5140 /* Save w's value of point in the window configuration.
5141 If w is the selected window, then get the value of point
5142 from the buffer; pointm is garbage in the selected window. */
5143 if (EQ (window, selected_window))
5145 p->pointm = Fmake_marker ();
5146 set_marker_both (p->pointm, w->buffer,
5147 BUF_PT (XBUFFER (w->buffer)),
5148 BUF_PT_BYTE (XBUFFER (w->buffer)));
5150 else
5151 p->pointm = Fcopy_marker (w->pointm, Qnil);
5153 p->start = Fcopy_marker (w->start, Qnil);
5154 p->start_at_line_beg = w->start_at_line_beg;
5156 tem = XBUFFER (w->buffer)->mark;
5157 p->mark = Fcopy_marker (tem, Qnil);
5159 else
5161 p->pointm = Qnil;
5162 p->start = Qnil;
5163 p->mark = Qnil;
5164 p->start_at_line_beg = Qnil;
5167 if (NILP (w->parent))
5168 p->parent = Qnil;
5169 else
5170 p->parent = XWINDOW (w->parent)->temslot;
5172 if (NILP (w->prev))
5173 p->prev = Qnil;
5174 else
5175 p->prev = XWINDOW (w->prev)->temslot;
5177 if (!NILP (w->vchild))
5178 i = save_window_save (w->vchild, vector, i);
5179 if (!NILP (w->hchild))
5180 i = save_window_save (w->hchild, vector, i);
5183 return i;
5186 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
5187 Scurrent_window_configuration, 0, 1, 0,
5188 "Return an object representing the current window configuration of FRAME.\n\
5189 If FRAME is nil or omitted, use the selected frame.\n\
5190 This describes the number of windows, their sizes and current buffers,\n\
5191 and for each displayed buffer, where display starts, and the positions of\n\
5192 point and mark. An exception is made for point in the current buffer:\n\
5193 its value is -not- saved.\n\
5194 This also records the currently selected frame, and FRAME's focus\n\
5195 redirection (see `redirect-frame-focus').")
5196 (frame)
5197 Lisp_Object frame;
5199 register Lisp_Object tem;
5200 register int n_windows;
5201 register struct save_window_data *data;
5202 register struct Lisp_Vector *vec;
5203 register int i;
5204 FRAME_PTR f;
5206 if (NILP (frame))
5207 frame = selected_frame;
5208 CHECK_LIVE_FRAME (frame, 0);
5209 f = XFRAME (frame);
5211 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
5212 vec = allocate_vectorlike (VECSIZE (struct save_window_data));
5213 for (i = 0; i < VECSIZE (struct save_window_data); i++)
5214 vec->contents[i] = Qnil;
5215 vec->size = VECSIZE (struct save_window_data);
5216 data = (struct save_window_data *)vec;
5218 XSETFASTINT (data->frame_width, FRAME_WIDTH (f));
5219 XSETFASTINT (data->frame_height, FRAME_HEIGHT (f));
5220 XSETFASTINT (data->frame_menu_bar_lines, FRAME_MENU_BAR_LINES (f));
5221 XSETFASTINT (data->frame_tool_bar_lines, FRAME_TOOL_BAR_LINES (f));
5222 data->selected_frame = selected_frame;
5223 data->current_window = FRAME_SELECTED_WINDOW (f);
5224 XSETBUFFER (data->current_buffer, current_buffer);
5225 data->minibuf_scroll_window = Vminibuf_scroll_window;
5226 data->root_window = FRAME_ROOT_WINDOW (f);
5227 data->focus_frame = FRAME_FOCUS_FRAME (f);
5228 XSETINT (data->min_height, window_min_height);
5229 XSETINT (data->min_width, window_min_width);
5230 tem = Fmake_vector (make_number (n_windows), Qnil);
5231 data->saved_windows = tem;
5232 for (i = 0; i < n_windows; i++)
5233 XVECTOR (tem)->contents[i]
5234 = Fmake_vector (make_number (SAVED_WINDOW_VECTOR_SIZE), Qnil);
5235 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
5236 XSETWINDOW_CONFIGURATION (tem, data);
5237 return (tem);
5240 DEFUN ("save-window-excursion", Fsave_window_excursion, Ssave_window_excursion,
5241 0, UNEVALLED, 0,
5242 "Execute body, preserving window sizes and contents.\n\
5243 Restore which buffer appears in which window, where display starts,\n\
5244 and the value of point and mark for each window.\n\
5245 Also restore the choice of selected window.\n\
5246 Also restore which buffer is current.\n\
5247 Does not restore the value of point in current buffer.")
5248 (args)
5249 Lisp_Object args;
5251 register Lisp_Object val;
5252 register int count = specpdl_ptr - specpdl;
5254 record_unwind_protect (Fset_window_configuration,
5255 Fcurrent_window_configuration (Qnil));
5256 val = Fprogn (args);
5257 return unbind_to (count, val);
5261 /***********************************************************************
5262 Marginal Areas
5263 ***********************************************************************/
5265 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
5266 2, 3, 0,
5267 "Set width of marginal areas of window WINDOW.\n\
5268 If window is nil, set margins of the currently selected window.\n\
5269 First parameter LEFT-WIDTH specifies the number of character\n\
5270 cells to reserve for the left marginal area. Second parameter\n\
5271 RIGHT-WIDTH does the same for the right marginal area.\n\
5272 A nil width parameter means no margin.")
5273 (window, left, right)
5274 Lisp_Object window, left, right;
5276 struct window *w = decode_window (window);
5278 if (!NILP (left))
5279 CHECK_NUMBER_OR_FLOAT (left, 1);
5280 if (!NILP (right))
5281 CHECK_NUMBER_OR_FLOAT (right, 2);
5283 /* Check widths < 0 and translate a zero width to nil.
5284 Margins that are too wide have to be checked elsewhere. */
5285 if ((INTEGERP (left) && XINT (left) < 0)
5286 || (FLOATP (left) && XFLOAT_DATA (left) <= 0))
5287 XSETFASTINT (left, 0);
5288 if (INTEGERP (left) && XFASTINT (left) == 0)
5289 left = Qnil;
5291 if ((INTEGERP (right) && XINT (right) < 0)
5292 || (FLOATP (right) && XFLOAT_DATA (right) <= 0))
5293 XSETFASTINT (right, 0);
5294 if (INTEGERP (right) && XFASTINT (right) == 0)
5295 right = Qnil;
5297 w->left_margin_width = left;
5298 w->right_margin_width = right;
5300 ++windows_or_buffers_changed;
5301 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
5302 return Qnil;
5306 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
5307 0, 1, 0,
5308 "Get width of marginal areas of window WINDOW.\n\
5309 If WINDOW is omitted or nil, use the currently selected window.\n\
5310 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).\n\
5311 If a marginal area does not exist, its width will be returned\n\
5312 as nil.")
5313 (window)
5314 Lisp_Object window;
5316 struct window *w = decode_window (window);
5317 return Fcons (w->left_margin_width, w->right_margin_width);
5322 /***********************************************************************
5323 Smooth scrolling
5324 ***********************************************************************/
5326 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 1, 0,
5327 "Return the amount by which WINDOW is scrolled vertically.\n\
5328 Use the selected window if WINDOW is nil or omitted.\n\
5329 Value is a multiple of the canonical character height of WINDOW.")
5330 (window)
5331 Lisp_Object window;
5333 Lisp_Object result;
5334 struct frame *f;
5335 struct window *w;
5337 if (NILP (window))
5338 window = selected_window;
5339 else
5340 CHECK_WINDOW (window, 0);
5341 w = XWINDOW (window);
5342 f = XFRAME (w->frame);
5344 if (FRAME_WINDOW_P (f))
5345 result = CANON_Y_FROM_PIXEL_Y (f, -w->vscroll);
5346 else
5347 result = make_number (0);
5348 return result;
5352 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
5353 2, 2, 0,
5354 "Set amount by which WINDOW should be scrolled vertically to VSCROLL.\n\
5355 WINDOW nil or omitted means use the selected window. VSCROLL is a\n\
5356 non-negative multiple of the canonical character height of WINDOW.")
5357 (window, vscroll)
5358 Lisp_Object window, vscroll;
5360 struct window *w;
5361 struct frame *f;
5363 if (NILP (window))
5364 window = selected_window;
5365 else
5366 CHECK_WINDOW (window, 0);
5367 CHECK_NUMBER_OR_FLOAT (vscroll, 1);
5369 w = XWINDOW (window);
5370 f = XFRAME (w->frame);
5372 if (FRAME_WINDOW_P (f))
5374 int old_dy = w->vscroll;
5376 w->vscroll = - CANON_Y_UNIT (f) * XFLOATINT (vscroll);
5377 w->vscroll = min (w->vscroll, 0);
5379 /* Adjust glyph matrix of the frame if the virtual display
5380 area becomes larger than before. */
5381 if (w->vscroll < 0 && w->vscroll < old_dy)
5382 adjust_glyphs (f);
5384 /* Prevent redisplay shortcuts. */
5385 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
5388 return Fwindow_vscroll (window);
5392 /* Call FN for all leaf windows on frame F. FN is called with the
5393 first argument being a pointer to the leaf window, and with
5394 additional argument USER_DATA. Stops when FN returns 0. */
5396 void
5397 foreach_window (f, fn, user_data)
5398 struct frame *f;
5399 int (* fn) P_ ((struct window *, void *));
5400 void *user_data;
5402 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
5406 /* Helper function for foreach_window. Call FN for all leaf windows
5407 reachable from W. FN is called with the first argument being a
5408 pointer to the leaf window, and with additional argument USER_DATA.
5409 Stop when FN returns 0. Value is 0 if stopped by FN. */
5411 static int
5412 foreach_window_1 (w, fn, user_data)
5413 struct window *w;
5414 int (* fn) P_ ((struct window *, void *));
5415 void *user_data;
5417 int cont;
5419 for (cont = 1; w && cont;)
5421 if (!NILP (w->hchild))
5422 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
5423 else if (!NILP (w->vchild))
5424 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
5425 else
5426 cont = fn (w, user_data);
5428 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5431 return cont;
5435 /* Freeze or unfreeze the window start of W if unless it is a
5436 mini-window or the selected window. FREEZE_P non-null means freeze
5437 the window start. */
5439 static int
5440 freeze_window_start (w, freeze_p)
5441 struct window *w;
5442 void *freeze_p;
5444 if (w == XWINDOW (selected_window)
5445 || MINI_WINDOW_P (w)
5446 || (MINI_WINDOW_P (XWINDOW (selected_window))
5447 && ! NILP (Vminibuf_scroll_window)
5448 && w == XWINDOW (Vminibuf_scroll_window)))
5449 freeze_p = NULL;
5451 w->frozen_window_start_p = freeze_p != NULL;
5452 return 1;
5456 /* Freeze or unfreeze the window starts of all leaf windows on frame
5457 F, except the selected window and a mini-window. FREEZE_P non-zero
5458 means freeze the window start. */
5460 void
5461 freeze_window_starts (f, freeze_p)
5462 struct frame *f;
5463 int freeze_p;
5465 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
5469 /***********************************************************************
5470 Initialization
5471 ***********************************************************************/
5473 /* Return 1 if window configurations C1 and C2
5474 describe the same state of affairs. This is used by Fequal. */
5477 compare_window_configurations (c1, c2, ignore_positions)
5478 Lisp_Object c1, c2;
5479 int ignore_positions;
5481 register struct save_window_data *d1, *d2;
5482 struct Lisp_Vector *sw1, *sw2;
5483 int i;
5485 if (!WINDOW_CONFIGURATIONP (c1))
5486 wrong_type_argument (Qwindow_configuration_p, c1);
5487 if (!WINDOW_CONFIGURATIONP (c2))
5488 wrong_type_argument (Qwindow_configuration_p, c2);
5490 d1 = (struct save_window_data *) XVECTOR (c1);
5491 d2 = (struct save_window_data *) XVECTOR (c2);
5492 sw1 = XVECTOR (d1->saved_windows);
5493 sw2 = XVECTOR (d2->saved_windows);
5495 if (! EQ (d1->frame_width, d2->frame_width))
5496 return 0;
5497 if (! EQ (d1->frame_height, d2->frame_height))
5498 return 0;
5499 if (! EQ (d1->frame_menu_bar_lines, d2->frame_menu_bar_lines))
5500 return 0;
5501 if (! EQ (d1->selected_frame, d2->selected_frame))
5502 return 0;
5503 /* Don't compare the current_window field directly.
5504 Instead see w1_is_current and w2_is_current, below. */
5505 if (! EQ (d1->current_buffer, d2->current_buffer))
5506 return 0;
5507 if (! ignore_positions)
5508 if (! EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window))
5509 return 0;
5510 /* Don't compare the root_window field.
5511 We don't require the two configurations
5512 to use the same window object,
5513 and the two root windows must be equivalent
5514 if everything else compares equal. */
5515 if (! EQ (d1->focus_frame, d2->focus_frame))
5516 return 0;
5517 if (! EQ (d1->min_width, d2->min_width))
5518 return 0;
5519 if (! EQ (d1->min_height, d2->min_height))
5520 return 0;
5522 /* Verify that the two confis have the same number of windows. */
5523 if (sw1->size != sw2->size)
5524 return 0;
5526 for (i = 0; i < sw1->size; i++)
5528 struct saved_window *p1, *p2;
5529 int w1_is_current, w2_is_current;
5531 p1 = SAVED_WINDOW_N (sw1, i);
5532 p2 = SAVED_WINDOW_N (sw2, i);
5534 /* Verify that the current windows in the two
5535 configurations correspond to each other. */
5536 w1_is_current = EQ (d1->current_window, p1->window);
5537 w2_is_current = EQ (d2->current_window, p2->window);
5539 if (w1_is_current != w2_is_current)
5540 return 0;
5542 /* Verify that the corresponding windows do match. */
5543 if (! EQ (p1->buffer, p2->buffer))
5544 return 0;
5545 if (! EQ (p1->left, p2->left))
5546 return 0;
5547 if (! EQ (p1->top, p2->top))
5548 return 0;
5549 if (! EQ (p1->width, p2->width))
5550 return 0;
5551 if (! EQ (p1->height, p2->height))
5552 return 0;
5553 if (! EQ (p1->display_table, p2->display_table))
5554 return 0;
5555 if (! EQ (p1->parent, p2->parent))
5556 return 0;
5557 if (! EQ (p1->prev, p2->prev))
5558 return 0;
5559 if (! ignore_positions)
5561 if (! EQ (p1->hscroll, p2->hscroll))
5562 return 0;
5563 if (!EQ (p1->min_hscroll, p2->min_hscroll))
5564 return 0;
5565 if (! EQ (p1->start_at_line_beg, p2->start_at_line_beg))
5566 return 0;
5567 if (NILP (Fequal (p1->start, p2->start)))
5568 return 0;
5569 if (NILP (Fequal (p1->pointm, p2->pointm)))
5570 return 0;
5571 if (NILP (Fequal (p1->mark, p2->mark)))
5572 return 0;
5576 return 1;
5579 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
5580 Scompare_window_configurations, 2, 2, 0,
5581 "Compare two window configurations as regards the structure of windows.\n\
5582 This function ignores details such as the values of point and mark\n\
5583 and scrolling positions.")
5584 (x, y)
5585 Lisp_Object x, y;
5587 if (compare_window_configurations (x, y, 1))
5588 return Qt;
5589 return Qnil;
5592 void
5593 init_window_once ()
5595 struct frame *f = make_terminal_frame ();
5596 XSETFRAME (selected_frame, f);
5597 Vterminal_frame = selected_frame;
5598 minibuf_window = f->minibuffer_window;
5599 selected_window = f->selected_window;
5600 last_nonminibuf_frame = f;
5602 window_initialized = 1;
5605 void
5606 init_window ()
5608 Vwindow_list = Qnil;
5611 void
5612 syms_of_window ()
5614 Qleft_bitmap_area = intern ("left-bitmap-area");
5615 staticpro (&Qleft_bitmap_area);
5616 Qright_bitmap_area = intern ("right-bitmap-area");
5617 staticpro (&Qright_bitmap_area);
5619 Qwindow_size_fixed = intern ("window-size-fixed");
5620 staticpro (&Qwindow_size_fixed);
5622 staticpro (&Qwindow_configuration_change_hook);
5623 Qwindow_configuration_change_hook
5624 = intern ("window-configuration-change-hook");
5626 Qwindowp = intern ("windowp");
5627 staticpro (&Qwindowp);
5629 Qwindow_configuration_p = intern ("window-configuration-p");
5630 staticpro (&Qwindow_configuration_p);
5632 Qwindow_live_p = intern ("window-live-p");
5633 staticpro (&Qwindow_live_p);
5635 Qtemp_buffer_show_hook = intern ("temp-buffer-show-hook");
5636 staticpro (&Qtemp_buffer_show_hook);
5638 staticpro (&Vwindow_list);
5640 DEFVAR_LISP ("temp-buffer-show-function", &Vtemp_buffer_show_function,
5641 "Non-nil means call as function to display a help buffer.\n\
5642 The function is called with one argument, the buffer to be displayed.\n\
5643 Used by `with-output-to-temp-buffer'.\n\
5644 If this function is used, then it must do the entire job of showing\n\
5645 the buffer; `temp-buffer-show-hook' is not run unless this function runs it.");
5646 Vtemp_buffer_show_function = Qnil;
5648 DEFVAR_LISP ("display-buffer-function", &Vdisplay_buffer_function,
5649 "If non-nil, function to call to handle `display-buffer'.\n\
5650 It will receive two args, the buffer and a flag which if non-nil means\n\
5651 that the currently selected window is not acceptable.\n\
5652 Commands such as `switch-to-buffer-other-window' and `find-file-other-window'\n\
5653 work using this function.");
5654 Vdisplay_buffer_function = Qnil;
5656 DEFVAR_LISP ("even-window-heights", &Veven_window_heights,
5657 "*If non-nil, `display-buffer' should even the window heights.\n\
5658 If nil, `display-buffer' will leave the window configuration alone.");
5659 Veven_window_heights = Qt;
5661 DEFVAR_LISP ("minibuffer-scroll-window", &Vminibuf_scroll_window,
5662 "Non-nil means it is the window that C-M-v in minibuffer should scroll.");
5663 Vminibuf_scroll_window = Qnil;
5665 DEFVAR_LISP ("other-window-scroll-buffer", &Vother_window_scroll_buffer,
5666 "If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window.");
5667 Vother_window_scroll_buffer = Qnil;
5669 DEFVAR_BOOL ("pop-up-frames", &pop_up_frames,
5670 "*Non-nil means `display-buffer' should make a separate frame.");
5671 pop_up_frames = 0;
5673 DEFVAR_BOOL ("display-buffer-reuse-frames", &display_buffer_reuse_frames,
5674 "*Non-nil means `display-buffer' should reuse frames.\n\
5675 If the buffer in question is already displayed in a frame, raise that frame.");
5676 display_buffer_reuse_frames = 0;
5678 DEFVAR_LISP ("pop-up-frame-function", &Vpop_up_frame_function,
5679 "Function to call to handle automatic new frame creation.\n\
5680 It is called with no arguments and should return a newly created frame.\n\
5682 A typical value might be `(lambda () (new-frame pop-up-frame-alist))'\n\
5683 where `pop-up-frame-alist' would hold the default frame parameters.");
5684 Vpop_up_frame_function = Qnil;
5686 DEFVAR_LISP ("special-display-buffer-names", &Vspecial_display_buffer_names,
5687 "*List of buffer names that should have their own special frames.\n\
5688 Displaying a buffer whose name is in this list makes a special frame for it\n\
5689 using `special-display-function'. See also `special-display-regexps'.\n\
5691 An element of the list can be a list instead of just a string.\n\
5692 There are two ways to use a list as an element:\n\
5693 (BUFFER FRAME-PARAMETERS...) (BUFFER FUNCTION OTHER-ARGS...)\n\
5694 In the first case, FRAME-PARAMETERS are used to create the frame.\n\
5695 In the latter case, FUNCTION is called with BUFFER as the first argument,\n\
5696 followed by OTHER-ARGS--it can display BUFFER in any way it likes.\n\
5697 All this is done by the function found in `special-display-function'.\n\
5699 If this variable appears \"not to work\", because you add a name to it\n\
5700 but that buffer still appears in the selected window, look at the\n\
5701 values of `same-window-buffer-names' and `same-window-regexps'.\n\
5702 Those variables take precedence over this one.");
5703 Vspecial_display_buffer_names = Qnil;
5705 DEFVAR_LISP ("special-display-regexps", &Vspecial_display_regexps,
5706 "*List of regexps saying which buffers should have their own special frames.\n\
5707 If a buffer name matches one of these regexps, it gets its own frame.\n\
5708 Displaying a buffer whose name is in this list makes a special frame for it\n\
5709 using `special-display-function'.\n\
5711 An element of the list can be a list instead of just a string.\n\
5712 There are two ways to use a list as an element:\n\
5713 (REGEXP FRAME-PARAMETERS...) (REGEXP FUNCTION OTHER-ARGS...)\n\
5714 In the first case, FRAME-PARAMETERS are used to create the frame.\n\
5715 In the latter case, FUNCTION is called with the buffer as first argument,\n\
5716 followed by OTHER-ARGS--it can display the buffer in any way it likes.\n\
5717 All this is done by the function found in `special-display-function'.\n\
5719 If this variable appears \"not to work\", because you add a regexp to it\n\
5720 but the matching buffers still appear in the selected window, look at the\n\
5721 values of `same-window-buffer-names' and `same-window-regexps'.\n\
5722 Those variables take precedence over this one.");
5723 Vspecial_display_regexps = Qnil;
5725 DEFVAR_LISP ("special-display-function", &Vspecial_display_function,
5726 "Function to call to make a new frame for a special buffer.\n\
5727 It is called with two arguments, the buffer and optional buffer specific\n\
5728 data, and should return a window displaying that buffer.\n\
5729 The default value makes a separate frame for the buffer,\n\
5730 using `special-display-frame-alist' to specify the frame parameters.\n\
5732 A buffer is special if its is listed in `special-display-buffer-names'\n\
5733 or matches a regexp in `special-display-regexps'.");
5734 Vspecial_display_function = Qnil;
5736 DEFVAR_LISP ("same-window-buffer-names", &Vsame_window_buffer_names,
5737 "*List of buffer names that should appear in the selected window.\n\
5738 Displaying one of these buffers using `display-buffer' or `pop-to-buffer'\n\
5739 switches to it in the selected window, rather than making it appear\n\
5740 in some other window.\n\
5742 An element of the list can be a cons cell instead of just a string.\n\
5743 Then the car must be a string, which specifies the buffer name.\n\
5744 This is for compatibility with `special-display-buffer-names';\n\
5745 the cdr of the cons cell is ignored.\n\
5747 See also `same-window-regexps'.");
5748 Vsame_window_buffer_names = Qnil;
5750 DEFVAR_LISP ("same-window-regexps", &Vsame_window_regexps,
5751 "*List of regexps saying which buffers should appear in the selected window.\n\
5752 If a buffer name matches one of these regexps, then displaying it\n\
5753 using `display-buffer' or `pop-to-buffer' switches to it\n\
5754 in the selected window, rather than making it appear in some other window.\n\
5756 An element of the list can be a cons cell instead of just a string.\n\
5757 Then the car must be a string, which specifies the buffer name.\n\
5758 This is for compatibility with `special-display-buffer-names';\n\
5759 the cdr of the cons cell is ignored.\n\
5761 See also `same-window-buffer-names'.");
5762 Vsame_window_regexps = Qnil;
5764 DEFVAR_BOOL ("pop-up-windows", &pop_up_windows,
5765 "*Non-nil means display-buffer should make new windows.");
5766 pop_up_windows = 1;
5768 DEFVAR_INT ("next-screen-context-lines", &next_screen_context_lines,
5769 "*Number of lines of continuity when scrolling by screenfuls.");
5770 next_screen_context_lines = 2;
5772 DEFVAR_INT ("split-height-threshold", &split_height_threshold,
5773 "*display-buffer would prefer to split the largest window if this large.\n\
5774 If there is only one window, it is split regardless of this value.");
5775 split_height_threshold = 500;
5777 DEFVAR_INT ("window-min-height", &window_min_height,
5778 "*Delete any window less than this tall (including its mode line).");
5779 window_min_height = 4;
5781 DEFVAR_INT ("window-min-width", &window_min_width,
5782 "*Delete any window less than this wide.");
5783 window_min_width = 10;
5785 DEFVAR_LISP ("scroll-preserve-screen-position",
5786 &Vscroll_preserve_screen_position,
5787 "*Nonzero means scroll commands move point to keep its screen line unchanged.");
5788 Vscroll_preserve_screen_position = Qnil;
5790 DEFVAR_LISP ("window-configuration-change-hook",
5791 &Vwindow_configuration_change_hook,
5792 "Functions to call when window configuration changes.\n\
5793 The selected frame is the one whose configuration has changed.");
5794 Vwindow_configuration_change_hook = Qnil;
5796 defsubr (&Sselected_window);
5797 defsubr (&Sminibuffer_window);
5798 defsubr (&Swindow_minibuffer_p);
5799 defsubr (&Swindowp);
5800 defsubr (&Swindow_live_p);
5801 defsubr (&Spos_visible_in_window_p);
5802 defsubr (&Swindow_buffer);
5803 defsubr (&Swindow_height);
5804 defsubr (&Swindow_width);
5805 defsubr (&Swindow_hscroll);
5806 defsubr (&Sset_window_hscroll);
5807 defsubr (&Swindow_redisplay_end_trigger);
5808 defsubr (&Sset_window_redisplay_end_trigger);
5809 defsubr (&Swindow_edges);
5810 defsubr (&Scoordinates_in_window_p);
5811 defsubr (&Swindow_at);
5812 defsubr (&Swindow_point);
5813 defsubr (&Swindow_start);
5814 defsubr (&Swindow_end);
5815 defsubr (&Sset_window_point);
5816 defsubr (&Sset_window_start);
5817 defsubr (&Swindow_dedicated_p);
5818 defsubr (&Sset_window_dedicated_p);
5819 defsubr (&Swindow_display_table);
5820 defsubr (&Sset_window_display_table);
5821 defsubr (&Snext_window);
5822 defsubr (&Sprevious_window);
5823 defsubr (&Sother_window);
5824 defsubr (&Sget_lru_window);
5825 defsubr (&Sget_largest_window);
5826 defsubr (&Sget_buffer_window);
5827 defsubr (&Sdelete_other_windows);
5828 defsubr (&Sdelete_windows_on);
5829 defsubr (&Sreplace_buffer_in_windows);
5830 defsubr (&Sdelete_window);
5831 defsubr (&Sset_window_buffer);
5832 defsubr (&Sselect_window);
5833 defsubr (&Sspecial_display_p);
5834 defsubr (&Ssame_window_p);
5835 defsubr (&Sdisplay_buffer);
5836 defsubr (&Ssplit_window);
5837 defsubr (&Senlarge_window);
5838 defsubr (&Sshrink_window);
5839 defsubr (&Sscroll_up);
5840 defsubr (&Sscroll_down);
5841 defsubr (&Sscroll_left);
5842 defsubr (&Sscroll_right);
5843 defsubr (&Sother_window_for_scrolling);
5844 defsubr (&Sscroll_other_window);
5845 defsubr (&Srecenter);
5846 defsubr (&Swindow_text_height);
5847 defsubr (&Smove_to_window_line);
5848 defsubr (&Swindow_configuration_p);
5849 defsubr (&Swindow_configuration_frame);
5850 defsubr (&Sset_window_configuration);
5851 defsubr (&Scurrent_window_configuration);
5852 defsubr (&Ssave_window_excursion);
5853 defsubr (&Sset_window_margins);
5854 defsubr (&Swindow_margins);
5855 defsubr (&Swindow_vscroll);
5856 defsubr (&Sset_window_vscroll);
5857 defsubr (&Scompare_window_configurations);
5858 defsubr (&Swindow_list);
5861 void
5862 keys_of_window ()
5864 initial_define_key (control_x_map, '1', "delete-other-windows");
5865 initial_define_key (control_x_map, '2', "split-window");
5866 initial_define_key (control_x_map, '0', "delete-window");
5867 initial_define_key (control_x_map, 'o', "other-window");
5868 initial_define_key (control_x_map, '^', "enlarge-window");
5869 initial_define_key (control_x_map, '<', "scroll-left");
5870 initial_define_key (control_x_map, '>', "scroll-right");
5872 initial_define_key (global_map, Ctl ('V'), "scroll-up");
5873 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
5874 initial_define_key (meta_map, 'v', "scroll-down");
5876 initial_define_key (global_map, Ctl('L'), "recenter");
5877 initial_define_key (meta_map, 'r', "move-to-window-line");