Doc fixes.
[emacs.git] / src / window.c
blob1b6ac07955d48dcc43c2a05d7ef319390c5ed3f0
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985,86,87,93,94,95,96,97,1998,2000, 2001
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 /* The value of `window-size-fixed'. */
87 int window_size_fixed;
89 /* This is the window in which the terminal's cursor should
90 be left when nothing is being done with it. This must
91 always be a leaf window, and its buffer is selected by
92 the top level editing loop at the end of each command.
94 This value is always the same as
95 FRAME_SELECTED_WINDOW (selected_frame). */
97 Lisp_Object selected_window;
99 /* A list of all windows for use by next_window and Fwindow_list.
100 Functions creating or deleting windows should invalidate this cache
101 by setting it to nil. */
103 Lisp_Object Vwindow_list;
105 /* The mini-buffer window of the selected frame.
106 Note that you cannot test for mini-bufferness of an arbitrary window
107 by comparing against this; but you can test for mini-bufferness of
108 the selected window. */
110 Lisp_Object minibuf_window;
112 /* Non-nil means it is the window for C-M-v to scroll
113 when the mini-buffer is selected. */
115 Lisp_Object Vminibuf_scroll_window;
117 /* Non-nil means this is the buffer whose window C-M-v should scroll. */
119 Lisp_Object Vother_window_scroll_buffer;
121 /* Non-nil means it's function to call to display temp buffers. */
123 Lisp_Object Vtemp_buffer_show_function;
125 /* If a window gets smaller than either of these, it is removed. */
127 int window_min_height;
128 int window_min_width;
130 /* Nonzero implies Fdisplay_buffer should create windows. */
132 int pop_up_windows;
134 /* Nonzero implies make new frames for Fdisplay_buffer. */
136 int pop_up_frames;
138 /* Nonzero means reuse existing frames for displaying buffers. */
140 int display_buffer_reuse_frames;
142 /* Non-nil means use this function instead of default */
144 Lisp_Object Vpop_up_frame_function;
146 /* Function to call to handle Fdisplay_buffer. */
148 Lisp_Object Vdisplay_buffer_function;
150 /* Non-nil means that Fdisplay_buffer should even the heights of windows. */
152 Lisp_Object Veven_window_heights;
154 /* List of buffer *names* for buffers that should have their own frames. */
156 Lisp_Object Vspecial_display_buffer_names;
158 /* List of regexps for buffer names that should have their own frames. */
160 Lisp_Object Vspecial_display_regexps;
162 /* Function to pop up a special frame. */
164 Lisp_Object Vspecial_display_function;
166 /* List of buffer *names* for buffers to appear in selected window. */
168 Lisp_Object Vsame_window_buffer_names;
170 /* List of regexps for buffer names to appear in selected window. */
172 Lisp_Object Vsame_window_regexps;
174 /* Hook run at end of temp_output_buffer_show. */
176 Lisp_Object Qtemp_buffer_show_hook;
178 /* Fdisplay_buffer always splits the largest window
179 if that window is more than this high. */
181 int split_height_threshold;
183 /* Number of lines of continuity in scrolling by screenfuls. */
185 int next_screen_context_lines;
187 /* Incremented for each window created. */
189 static int sequence_number;
191 /* Nonzero after init_window_once has finished. */
193 static int window_initialized;
195 /* Hook to run when window config changes. */
197 Lisp_Object Qwindow_configuration_change_hook;
198 Lisp_Object Vwindow_configuration_change_hook;
200 /* Nonzero means scroll commands try to put point
201 at the same screen height as previously. */
203 Lisp_Object Vscroll_preserve_screen_position;
205 #if 0 /* This isn't used anywhere. */
206 /* Nonzero means we can split a frame even if it is "unsplittable". */
207 static int inhibit_frame_unsplittable;
208 #endif /* 0 */
210 #define min(a, b) ((a) < (b) ? (a) : (b))
212 extern int scroll_margin;
214 extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
216 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
217 "Returns t if OBJECT is a window.")
218 (object)
219 Lisp_Object object;
221 return WINDOWP (object) ? Qt : Qnil;
224 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
225 "Returns t if OBJECT is a window which is currently visible.")
226 (object)
227 Lisp_Object object;
229 return WINDOW_LIVE_P (object) ? Qt : Qnil;
232 Lisp_Object
233 make_window ()
235 Lisp_Object val;
236 register struct window *p;
237 register struct Lisp_Vector *vec;
238 int i;
240 vec = allocate_vectorlike ((EMACS_INT) VECSIZE (struct window));
241 for (i = 0; i < VECSIZE (struct window); i++)
242 vec->contents[i] = Qnil;
243 vec->size = VECSIZE (struct window);
244 p = (struct window *) vec;
245 XSETFASTINT (p->sequence_number, ++sequence_number);
246 XSETFASTINT (p->left, 0);
247 XSETFASTINT (p->top, 0);
248 XSETFASTINT (p->height, 0);
249 XSETFASTINT (p->width, 0);
250 XSETFASTINT (p->hscroll, 0);
251 XSETFASTINT (p->min_hscroll, 0);
252 p->orig_top = p->orig_height = Qnil;
253 p->start = Fmake_marker ();
254 p->pointm = Fmake_marker ();
255 XSETFASTINT (p->use_time, 0);
256 p->frame = Qnil;
257 p->display_table = Qnil;
258 p->dedicated = Qnil;
259 p->pseudo_window_p = 0;
260 bzero (&p->cursor, sizeof (p->cursor));
261 bzero (&p->last_cursor, sizeof (p->last_cursor));
262 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
263 p->desired_matrix = p->current_matrix = 0;
264 p->phys_cursor_type = -1;
265 p->must_be_updated_p = 0;
266 XSETFASTINT (p->window_end_vpos, 0);
267 XSETFASTINT (p->window_end_pos, 0);
268 p->window_end_valid = Qnil;
269 p->vscroll = 0;
270 XSETWINDOW (val, p);
271 XSETFASTINT (p->last_point, 0);
272 p->frozen_window_start_p = 0;
274 Vwindow_list = Qnil;
275 return val;
278 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
279 "Return the window that the cursor now appears in and commands apply to.")
282 return selected_window;
285 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
286 "Return the window used now for minibuffers.\n\
287 If the optional argument FRAME is specified, return the minibuffer window\n\
288 used by that frame.")
289 (frame)
290 Lisp_Object frame;
292 if (NILP (frame))
293 frame = selected_frame;
294 CHECK_LIVE_FRAME (frame, 0);
295 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
298 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
299 "Returns non-nil if WINDOW is a minibuffer window.")
300 (window)
301 Lisp_Object window;
303 struct window *w = decode_window (window);
304 return MINI_WINDOW_P (w) ? Qt : Qnil;
308 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
309 Spos_visible_in_window_p, 0, 3, 0,
310 "Return t if position POS is currently on the frame in WINDOW.\n\
311 Return nil if that position is scrolled vertically out of view.\n\
312 If a character is only partially visible, nil is returned, unless the\n\
313 optional argument PARTIALLY is non-nil.\n\
314 POS defaults to point in WINDOW; WINDOW defaults to the selected window.")
315 (pos, window, partially)
316 Lisp_Object pos, window, partially;
318 register struct window *w;
319 register int posint;
320 register struct buffer *buf;
321 struct text_pos top;
322 Lisp_Object in_window;
323 int fully_p;
325 w = decode_window (window);
326 buf = XBUFFER (w->buffer);
327 SET_TEXT_POS_FROM_MARKER (top, w->start);
329 if (!NILP (pos))
331 CHECK_NUMBER_COERCE_MARKER (pos, 0);
332 posint = XINT (pos);
334 else if (w == XWINDOW (selected_window))
335 posint = PT;
336 else
337 posint = XMARKER (w->pointm)->charpos;
339 /* If position is above window start, it's not visible. */
340 if (posint < CHARPOS (top))
341 in_window = Qnil;
342 else if (XFASTINT (w->last_modified) >= BUF_MODIFF (buf)
343 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (buf)
344 && posint < BUF_Z (buf) - XFASTINT (w->window_end_pos))
346 /* If frame is up-to-date, and POSINT is < window end pos, use
347 that info. This doesn't work for POSINT == end pos, because
348 the window end pos is actually the position _after_ the last
349 char in the window. */
350 if (NILP (partially))
352 pos_visible_p (w, posint, &fully_p, NILP (partially));
353 in_window = fully_p ? Qt : Qnil;
355 else
356 in_window = Qt;
358 else if (posint > BUF_ZV (buf))
359 in_window = Qnil;
360 else if (CHARPOS (top) < BUF_BEGV (buf) || CHARPOS (top) > BUF_ZV (buf))
361 /* If window start is out of range, do something reasonable. */
362 in_window = Qnil;
363 else
365 if (pos_visible_p (w, posint, &fully_p, NILP (partially)))
366 in_window = !NILP (partially) || fully_p ? Qt : Qnil;
367 else
368 in_window = Qnil;
371 return in_window;
375 static struct window *
376 decode_window (window)
377 register Lisp_Object window;
379 if (NILP (window))
380 return XWINDOW (selected_window);
382 CHECK_LIVE_WINDOW (window, 0);
383 return XWINDOW (window);
386 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
387 "Return the buffer that WINDOW is displaying.")
388 (window)
389 Lisp_Object window;
391 return decode_window (window)->buffer;
394 DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
395 "Return the number of lines in WINDOW (including its mode line).")
396 (window)
397 Lisp_Object window;
399 return decode_window (window)->height;
402 DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
403 "Return the number of display columns in WINDOW.\n\
404 This is the width that is usable columns available for text in WINDOW.\n\
405 If you want to find out how many columns WINDOW takes up,\n\
406 use (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))).")
407 (window)
408 Lisp_Object window;
410 return make_number (window_internal_width (decode_window (window)));
413 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
414 "Return the number of columns by which WINDOW is scrolled from left margin.")
415 (window)
416 Lisp_Object window;
418 return decode_window (window)->hscroll;
421 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
422 "Set number of columns WINDOW is scrolled from left margin to NCOL.\n\
423 NCOL should be zero or positive.")
424 (window, ncol)
425 Lisp_Object window, ncol;
427 struct window *w = decode_window (window);
428 int hscroll;
430 CHECK_NUMBER (ncol, 1);
431 hscroll = max (0, XINT (ncol));
433 /* Prevent redisplay shortcuts when changing the hscroll. */
434 if (XINT (w->hscroll) != hscroll)
435 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
437 w->hscroll = make_number (hscroll);
438 return ncol;
441 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
442 Swindow_redisplay_end_trigger, 0, 1, 0,
443 "Return WINDOW's redisplay end trigger value.\n\
444 See `set-window-redisplay-end-trigger' for more information.")
445 (window)
446 Lisp_Object window;
448 return decode_window (window)->redisplay_end_trigger;
451 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
452 Sset_window_redisplay_end_trigger, 2, 2, 0,
453 "Set WINDOW's redisplay end trigger value to VALUE.\n\
454 VALUE should be a buffer position (typically a marker) or nil.\n\
455 If it is a buffer position, then if redisplay in WINDOW reaches a position\n\
456 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called\n\
457 with two arguments: WINDOW, and the end trigger value.\n\
458 Afterwards the end-trigger value is reset to nil.")
459 (window, value)
460 register Lisp_Object window, value;
462 register struct window *w;
464 w = decode_window (window);
465 w->redisplay_end_trigger = value;
466 return value;
469 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
470 "Return a list of the edge coordinates of WINDOW.\n\
471 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.\n\
472 RIGHT is one more than the rightmost column used by WINDOW,\n\
473 and BOTTOM is one more than the bottommost row used by WINDOW\n\
474 and its mode-line.")
475 (window)
476 Lisp_Object window;
478 register struct window *w = decode_window (window);
480 return Fcons (w->left, Fcons (w->top,
481 Fcons (make_number (WINDOW_RIGHT_EDGE (w)),
482 Fcons (make_number (XFASTINT (w->top)
483 + XFASTINT (w->height)),
484 Qnil))));
487 /* Test if the character at column *X, row *Y is within window W.
488 If it is not, return 0;
489 if it is in the window's text area,
490 set *x and *y to its location relative to the upper left corner
491 of the window, and
492 return 1;
493 if it is on the window's modeline, return 2;
494 if it is on the border between the window and its right sibling,
495 return 3.
496 if it is on the window's top line, return 4;
497 if it is in the bitmap area to the left/right of the window,
498 return 5 or 6, and convert *X and *Y to window-relative corrdinates.
500 X and Y are frame relative pixel coordinates. */
502 static int
503 coordinates_in_window (w, x, y)
504 register struct window *w;
505 register int *x, *y;
507 /* Let's make this a global enum later, instead of using numbers
508 everywhere. */
509 enum {ON_NOTHING, ON_TEXT, ON_MODE_LINE, ON_VERTICAL_BORDER,
510 ON_HEADER_LINE, ON_LEFT_FRINGE, ON_RIGHT_FRINGE};
512 struct frame *f = XFRAME (WINDOW_FRAME (w));
513 int left_x, right_x, top_y, bottom_y;
514 int flags_area_width = FRAME_LEFT_FLAGS_AREA_WIDTH (f);
515 int part;
516 int ux = CANON_X_UNIT (f), uy = CANON_Y_UNIT (f);
517 int x0 = XFASTINT (w->left) * ux;
518 int x1 = x0 + XFASTINT (w->width) * ux;
520 if (*x < x0 || *x >= x1)
521 return ON_NOTHING;
523 /* In what's below, we subtract 1 when computing right_x because we
524 want the rightmost pixel, which is given by left_pixel+width-1. */
525 if (w->pseudo_window_p)
527 left_x = 0;
528 right_x = XFASTINT (w->width) * CANON_X_UNIT (f) - 1;
529 top_y = WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w);
530 bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
532 else
534 left_x = (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X (w)
535 - FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
536 right_x = WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X (w) - 1;
537 top_y = (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w)
538 - FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
539 bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
542 /* On the mode line or header line? If it's near the start of
543 the mode or header line of window that's has a horizontal
544 sibling, say it's on the vertical line. That's to be able
545 to resize windows horizontally in case we're using toolkit
546 scroll bars. */
548 if (WINDOW_WANTS_MODELINE_P (w)
549 && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
550 && *y < bottom_y)
552 /* We're somewhere on the mode line. We consider the place
553 between mode lines of horizontally adjacent mode lines
554 as the vertical border. If scroll bars on the left,
555 return the right window. */
556 part = ON_MODE_LINE;
558 if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
560 if (abs (*x - x0) < ux / 2)
561 part = ON_VERTICAL_BORDER;
563 else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < ux / 2)
564 part = ON_VERTICAL_BORDER;
566 else if (WINDOW_WANTS_HEADER_LINE_P (w)
567 && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
568 && *y >= top_y)
570 part = ON_HEADER_LINE;
572 if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
574 if (abs (*x - x0) < ux / 2)
575 part = ON_VERTICAL_BORDER;
577 else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < ux / 2)
578 part = ON_VERTICAL_BORDER;
580 /* Outside anything interesting? */
581 else if (*y < top_y
582 || *y >= bottom_y
583 || *x < (left_x
584 - flags_area_width
585 - FRAME_LEFT_SCROLL_BAR_WIDTH (f) * ux)
586 || *x > right_x + flags_area_width)
588 part = ON_NOTHING;
590 else if (FRAME_WINDOW_P (f))
592 if (!w->pseudo_window_p
593 && !FRAME_HAS_VERTICAL_SCROLL_BARS (f)
594 && !WINDOW_RIGHTMOST_P (w)
595 && (abs (*x - right_x - flags_area_width) < ux / 2))
597 part = ON_VERTICAL_BORDER;
599 else if (*x < left_x || *x > right_x)
601 /* Other lines than the mode line don't include flags areas and
602 scroll bars on the left. */
604 /* Convert X and Y to window-relative pixel coordinates. */
605 *x -= left_x;
606 *y -= top_y;
607 part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
609 else
611 *x -= left_x;
612 *y -= top_y;
613 part = ON_TEXT;
616 else
618 /* Need to say "*x > right_x" rather than >=, since on character
619 terminals, the vertical line's x coordinate is right_x. */
620 if (*x < left_x || *x > right_x)
622 /* Other lines than the mode line don't include flags areas and
623 scroll bars on the left. */
625 /* Convert X and Y to window-relative pixel coordinates. */
626 *x -= left_x;
627 *y -= top_y;
628 part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
630 /* Here, too, "*x > right_x" is because of character terminals. */
631 else if (!w->pseudo_window_p
632 && !WINDOW_RIGHTMOST_P (w)
633 && *x > right_x - ux)
635 /* On the border on the right side of the window? Assume that
636 this area begins at RIGHT_X minus a canonical char width. */
637 part = ON_VERTICAL_BORDER;
639 else
641 /* Convert X and Y to window-relative pixel coordinates. */
642 *x -= left_x;
643 *y -= top_y;
644 part = ON_TEXT;
648 return part;
652 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
653 Scoordinates_in_window_p, 2, 2, 0,
654 "Return non-nil if COORDINATES are in WINDOW.\n\
655 COORDINATES is a cons of the form (X . Y), X and Y being distances\n\
656 measured in characters from the upper-left corner of the frame.\n\
657 (0 . 0) denotes the character in the upper left corner of the\n\
658 frame.\n\
659 If COORDINATES are in the text portion of WINDOW,\n\
660 the coordinates relative to the window are returned.\n\
661 If they are in the mode line of WINDOW, `mode-line' is returned.\n\
662 If they are in the top mode line of WINDOW, `header-line' is returned.\n\
663 If they are in the bitmap-area to the left of the window,\n\
664 `left-bitmap-area' is returned, if they are in the area on the right of\n\
665 the window, `right-bitmap-area' is returned.\n\
666 If they are on the border between WINDOW and its right sibling,\n\
667 `vertical-line' is returned.")
668 (coordinates, window)
669 register Lisp_Object coordinates, window;
671 struct window *w;
672 struct frame *f;
673 int x, y;
674 Lisp_Object lx, ly;
676 CHECK_LIVE_WINDOW (window, 0);
677 w = XWINDOW (window);
678 f = XFRAME (w->frame);
679 CHECK_CONS (coordinates, 1);
680 lx = Fcar (coordinates);
681 ly = Fcdr (coordinates);
682 CHECK_NUMBER_OR_FLOAT (lx, 1);
683 CHECK_NUMBER_OR_FLOAT (ly, 1);
684 x = PIXEL_X_FROM_CANON_X (f, lx);
685 y = PIXEL_Y_FROM_CANON_Y (f, ly);
687 switch (coordinates_in_window (w, &x, &y))
689 case 0: /* NOT in window at all. */
690 return Qnil;
692 case 1: /* In text part of window. */
693 /* X and Y are now window relative pixel coordinates.
694 Convert them to canonical char units before returning
695 them. */
696 return Fcons (CANON_X_FROM_PIXEL_X (f, x),
697 CANON_Y_FROM_PIXEL_Y (f, y));
699 case 2: /* In mode line of window. */
700 return Qmode_line;
702 case 3: /* On right border of window. */
703 return Qvertical_line;
705 case 4:
706 return Qheader_line;
708 case 5:
709 return Qleft_bitmap_area;
711 case 6:
712 return Qright_bitmap_area;
714 default:
715 abort ();
720 /* Callback for foreach_window, used in window_from_coordinates.
721 Check if window W contains coordinates specified by USER_DATA which
722 is actually a pointer to a struct check_window_data CW.
724 Check if window W contains coordinates *CW->x and *CW->y. If it
725 does, return W in *CW->window, as Lisp_Object, and return in
726 *CW->part the part of the window under coordinates *X,*Y. Return
727 zero from this function to stop iterating over windows. */
729 struct check_window_data
731 Lisp_Object *window;
732 int *x, *y, *part;
735 static int
736 check_window_containing (w, user_data)
737 struct window *w;
738 void *user_data;
740 struct check_window_data *cw = (struct check_window_data *) user_data;
741 int found;
743 found = coordinates_in_window (w, cw->x, cw->y);
744 if (found)
746 *cw->part = found - 1;
747 XSETWINDOW (*cw->window, w);
750 return !found;
754 /* Find the window containing frame-relative pixel position X/Y and
755 return it as a Lisp_Object. If X, Y is on the window's modeline,
756 set *PART to 1; if it is on the separating line between the window
757 and its right sibling, set it to 2; otherwise set it to 0. If
758 there is no window under X, Y return nil and leave *PART
759 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
761 This function was previously implemented with a loop cycling over
762 windows with Fnext_window, and starting with the frame's selected
763 window. It turned out that this doesn't work with an
764 implementation of next_window using Vwindow_list, because
765 FRAME_SELECTED_WINDOW (F) is not always contained in the window
766 tree of F when this function is called asynchronously from
767 note_mouse_highlight. The original loop didn't terminate in this
768 case. */
770 Lisp_Object
771 window_from_coordinates (f, x, y, part, tool_bar_p)
772 struct frame *f;
773 int x, y;
774 int *part;
775 int tool_bar_p;
777 Lisp_Object window;
778 struct check_window_data cw;
780 window = Qnil;
781 cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
782 foreach_window (f, check_window_containing, &cw);
784 /* If not found above, see if it's in the tool bar window, if a tool
785 bar exists. */
786 if (NILP (window)
787 && tool_bar_p
788 && WINDOWP (f->tool_bar_window)
789 && XINT (XWINDOW (f->tool_bar_window)->height) > 0
790 && coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y))
792 *part = 0;
793 window = f->tool_bar_window;
796 return window;
799 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
800 "Return window containing coordinates X and Y on FRAME.\n\
801 If omitted, FRAME defaults to the currently selected frame.\n\
802 The top left corner of the frame is considered to be row 0,\n\
803 column 0.")
804 (x, y, frame)
805 Lisp_Object x, y, frame;
807 int part;
808 struct frame *f;
810 if (NILP (frame))
811 frame = selected_frame;
812 CHECK_LIVE_FRAME (frame, 2);
813 f = XFRAME (frame);
815 /* Check that arguments are integers or floats. */
816 CHECK_NUMBER_OR_FLOAT (x, 0);
817 CHECK_NUMBER_OR_FLOAT (y, 1);
819 return window_from_coordinates (f,
820 PIXEL_X_FROM_CANON_X (f, x),
821 PIXEL_Y_FROM_CANON_Y (f, y),
822 &part, 0);
825 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
826 "Return current value of point in WINDOW.\n\
827 For a nonselected window, this is the value point would have\n\
828 if that window were selected.\n\
830 Note that, when WINDOW is the selected window and its buffer\n\
831 is also currently selected, the value returned is the same as (point).\n\
832 It would be more strictly correct to return the `top-level' value\n\
833 of point, outside of any save-excursion forms.\n\
834 But that is hard to define.")
835 (window)
836 Lisp_Object window;
838 register struct window *w = decode_window (window);
840 if (w == XWINDOW (selected_window)
841 && current_buffer == XBUFFER (w->buffer))
842 return Fpoint ();
843 return Fmarker_position (w->pointm);
846 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
847 "Return position at which display currently starts in WINDOW.\n\
848 This is updated by redisplay or by calling `set-window-start'.")
849 (window)
850 Lisp_Object window;
852 return Fmarker_position (decode_window (window)->start);
855 /* This is text temporarily removed from the doc string below.
857 This function returns nil if the position is not currently known.\n\
858 That happens when redisplay is preempted and doesn't finish.\n\
859 If in that case you want to compute where the end of the window would\n\
860 have been if redisplay had finished, do this:\n\
861 (save-excursion\n\
862 (goto-char (window-start window))\n\
863 (vertical-motion (1- (window-height window)) window)\n\
864 (point))") */
866 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
867 "Return position at which display currently ends in WINDOW.\n\
868 This is updated by redisplay, when it runs to completion.\n\
869 Simply changing the buffer text or setting `window-start'\n\
870 does not update this value.\n\
871 If UPDATE is non-nil, compute the up-to-date position\n\
872 if it isn't already recorded.")
873 (window, update)
874 Lisp_Object window, update;
876 Lisp_Object value;
877 struct window *w = decode_window (window);
878 Lisp_Object buf;
880 buf = w->buffer;
881 CHECK_BUFFER (buf, 0);
883 #if 0 /* This change broke some things. We should make it later. */
884 /* If we don't know the end position, return nil.
885 The user can compute it with vertical-motion if he wants to.
886 It would be nicer to do it automatically,
887 but that's so slow that it would probably bother people. */
888 if (NILP (w->window_end_valid))
889 return Qnil;
890 #endif
892 if (! NILP (update)
893 && ! (! NILP (w->window_end_valid)
894 && XFASTINT (w->last_modified) >= MODIFF))
896 struct text_pos startp;
897 struct it it;
899 /* In case W->start is out of the range, use something
900 reasonable. This situation occured when loading a file with
901 `-l' containing a call to `rmail' with subsequent other
902 commands. At the end, W->start happened to be BEG, while
903 rmail had already narrowed the buffer. */
904 if (XMARKER (w->start)->charpos < BEGV)
905 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
906 else if (XMARKER (w->start)->charpos > ZV)
907 SET_TEXT_POS (startp, ZV, ZV_BYTE);
908 else
909 SET_TEXT_POS_FROM_MARKER (startp, w->start);
911 /* Cannot use Fvertical_motion because that function doesn't
912 cope with variable-height lines. */
913 start_display (&it, w, startp);
914 move_it_vertically (&it, window_box_height (w));
915 move_it_past_eol (&it);
916 value = make_number (IT_CHARPOS (it));
918 else
919 XSETINT (value, BUF_Z (XBUFFER (buf)) - XFASTINT (w->window_end_pos));
921 return value;
924 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
925 "Make point value in WINDOW be at position POS in WINDOW's buffer.")
926 (window, pos)
927 Lisp_Object window, pos;
929 register struct window *w = decode_window (window);
931 CHECK_NUMBER_COERCE_MARKER (pos, 1);
932 if (w == XWINDOW (selected_window)
933 && XBUFFER (w->buffer) == current_buffer)
934 Fgoto_char (pos);
935 else
936 set_marker_restricted (w->pointm, pos, w->buffer);
938 /* We have to make sure that redisplay updates the window to show
939 the new value of point. */
940 if (!EQ (window, selected_window))
941 ++windows_or_buffers_changed;
943 return pos;
946 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
947 "Make display in WINDOW start at position POS in WINDOW's buffer.\n\
948 Optional third arg NOFORCE non-nil inhibits next redisplay\n\
949 from overriding motion of point in order to display at this exact start.")
950 (window, pos, noforce)
951 Lisp_Object window, pos, noforce;
953 register struct window *w = decode_window (window);
955 CHECK_NUMBER_COERCE_MARKER (pos, 1);
956 set_marker_restricted (w->start, pos, w->buffer);
957 /* this is not right, but much easier than doing what is right. */
958 w->start_at_line_beg = Qnil;
959 if (NILP (noforce))
960 w->force_start = Qt;
961 w->update_mode_line = Qt;
962 XSETFASTINT (w->last_modified, 0);
963 XSETFASTINT (w->last_overlay_modified, 0);
964 if (!EQ (window, selected_window))
965 windows_or_buffers_changed++;
967 return pos;
970 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
971 1, 1, 0,
972 "Return WINDOW's dedicated object, usually t or nil.\n\
973 See also `set-window-dedicated-p'.")
974 (window)
975 Lisp_Object window;
977 return decode_window (window)->dedicated;
980 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
981 Sset_window_dedicated_p, 2, 2, 0,
982 "Control whether WINDOW is dedicated to the buffer it displays.\n\
983 If it is dedicated, Emacs will not automatically change\n\
984 which buffer appears in it.\n\
985 The second argument is the new value for the dedication flag;\n\
986 non-nil means yes.")
987 (window, arg)
988 Lisp_Object window, arg;
990 register struct window *w = decode_window (window);
992 if (NILP (arg))
993 w->dedicated = Qnil;
994 else
995 w->dedicated = Qt;
997 return w->dedicated;
1000 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1001 0, 1, 0,
1002 "Return the display-table that WINDOW is using.")
1003 (window)
1004 Lisp_Object window;
1006 return decode_window (window)->display_table;
1009 /* Get the display table for use on window W. This is either W's
1010 display table or W's buffer's display table. Ignore the specified
1011 tables if they are not valid; if no valid table is specified,
1012 return 0. */
1014 struct Lisp_Char_Table *
1015 window_display_table (w)
1016 struct window *w;
1018 struct Lisp_Char_Table *dp = NULL;
1020 if (DISP_TABLE_P (w->display_table))
1021 dp = XCHAR_TABLE (w->display_table);
1022 else if (BUFFERP (w->buffer))
1024 struct buffer *b = XBUFFER (w->buffer);
1026 if (DISP_TABLE_P (b->display_table))
1027 dp = XCHAR_TABLE (b->display_table);
1028 else if (DISP_TABLE_P (Vstandard_display_table))
1029 dp = XCHAR_TABLE (Vstandard_display_table);
1032 return dp;
1035 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1036 "Set WINDOW's display-table to TABLE.")
1037 (window, table)
1038 register Lisp_Object window, table;
1040 register struct window *w;
1042 w = decode_window (window);
1043 w->display_table = table;
1044 return table;
1047 /* Record info on buffer window w is displaying
1048 when it is about to cease to display that buffer. */
1049 static void
1050 unshow_buffer (w)
1051 register struct window *w;
1053 Lisp_Object buf;
1054 struct buffer *b;
1056 buf = w->buffer;
1057 b = XBUFFER (buf);
1058 if (b != XMARKER (w->pointm)->buffer)
1059 abort ();
1061 #if 0
1062 if (w == XWINDOW (selected_window)
1063 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1064 /* Do this except when the selected window's buffer
1065 is being removed from some other window. */
1066 #endif
1067 /* last_window_start records the start position that this buffer
1068 had in the last window to be disconnected from it.
1069 Now that this statement is unconditional,
1070 it is possible for the buffer to be displayed in the
1071 selected window, while last_window_start reflects another
1072 window which was recently showing the same buffer.
1073 Some people might say that might be a good thing. Let's see. */
1074 b->last_window_start = marker_position (w->start);
1076 /* Point in the selected window's buffer
1077 is actually stored in that buffer, and the window's pointm isn't used.
1078 So don't clobber point in that buffer. */
1079 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1080 /* This line helps to fix Horsley's testbug.el bug. */
1081 && !(WINDOWP (b->last_selected_window)
1082 && w != XWINDOW (b->last_selected_window)
1083 && EQ (buf, XWINDOW (b->last_selected_window)->buffer)))
1084 temp_set_point_both (b,
1085 clip_to_bounds (BUF_BEGV (b),
1086 XMARKER (w->pointm)->charpos,
1087 BUF_ZV (b)),
1088 clip_to_bounds (BUF_BEGV_BYTE (b),
1089 marker_byte_position (w->pointm),
1090 BUF_ZV_BYTE (b)));
1092 if (WINDOWP (b->last_selected_window)
1093 && w == XWINDOW (b->last_selected_window))
1094 b->last_selected_window = Qnil;
1097 /* Put replacement into the window structure in place of old. */
1098 static void
1099 replace_window (old, replacement)
1100 Lisp_Object old, replacement;
1102 register Lisp_Object tem;
1103 register struct window *o = XWINDOW (old), *p = XWINDOW (replacement);
1105 /* If OLD is its frame's root_window, then replacement is the new
1106 root_window for that frame. */
1108 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1109 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
1111 p->left = o->left;
1112 p->top = o->top;
1113 p->width = o->width;
1114 p->height = o->height;
1115 p->desired_matrix = p->current_matrix = 0;
1116 p->vscroll = 0;
1117 bzero (&p->cursor, sizeof (p->cursor));
1118 bzero (&p->last_cursor, sizeof (p->last_cursor));
1119 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
1120 p->phys_cursor_type = -1;
1121 p->must_be_updated_p = 0;
1122 p->pseudo_window_p = 0;
1123 XSETFASTINT (p->window_end_vpos, 0);
1124 XSETFASTINT (p->window_end_pos, 0);
1125 p->window_end_valid = Qnil;
1126 p->frozen_window_start_p = 0;
1127 p->orig_top = p->orig_height = Qnil;
1129 p->next = tem = o->next;
1130 if (!NILP (tem))
1131 XWINDOW (tem)->prev = replacement;
1133 p->prev = tem = o->prev;
1134 if (!NILP (tem))
1135 XWINDOW (tem)->next = replacement;
1137 p->parent = tem = o->parent;
1138 if (!NILP (tem))
1140 if (EQ (XWINDOW (tem)->vchild, old))
1141 XWINDOW (tem)->vchild = replacement;
1142 if (EQ (XWINDOW (tem)->hchild, old))
1143 XWINDOW (tem)->hchild = replacement;
1146 /*** Here, if replacement is a vertical combination
1147 and so is its new parent, we should make replacement's
1148 children be children of that parent instead. ***/
1151 DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
1152 "Remove WINDOW from the display. Default is selected window.")
1153 (window)
1154 register Lisp_Object window;
1156 delete_window (window);
1158 if (! NILP (Vwindow_configuration_change_hook)
1159 && ! NILP (Vrun_hooks))
1160 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
1162 return Qnil;
1165 void
1166 delete_window (window)
1167 register Lisp_Object window;
1169 register Lisp_Object tem, parent, sib;
1170 register struct window *p;
1171 register struct window *par;
1172 struct frame *f;
1174 /* Because this function is called by other C code on non-leaf
1175 windows, the CHECK_LIVE_WINDOW macro would choke inappropriately,
1176 so we can't decode_window here. */
1177 if (NILP (window))
1178 window = selected_window;
1179 else
1180 CHECK_WINDOW (window, 0);
1181 p = XWINDOW (window);
1183 /* It's okay to delete an already-deleted window. */
1184 if (NILP (p->buffer)
1185 && NILP (p->hchild)
1186 && NILP (p->vchild))
1187 return;
1189 parent = p->parent;
1190 if (NILP (parent))
1191 error ("Attempt to delete minibuffer or sole ordinary window");
1192 par = XWINDOW (parent);
1194 windows_or_buffers_changed++;
1195 Vwindow_list = Qnil;
1196 f = XFRAME (WINDOW_FRAME (p));
1197 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
1199 /* Are we trying to delete any frame's selected window? */
1201 Lisp_Object pwindow;
1203 /* See if the frame's selected window is either WINDOW
1204 or any subwindow of it, by finding all that window's parents
1205 and comparing each one with WINDOW. */
1206 pwindow = FRAME_SELECTED_WINDOW (f);
1208 while (!NILP (pwindow))
1210 if (EQ (window, pwindow))
1211 break;
1212 pwindow = XWINDOW (pwindow)->parent;
1215 if (EQ (window, pwindow))
1217 Lisp_Object alternative;
1218 alternative = Fnext_window (window, Qlambda, Qnil);
1220 /* If we're about to delete the selected window on the
1221 selected frame, then we should use Fselect_window to select
1222 the new window. On the other hand, if we're about to
1223 delete the selected window on any other frame, we shouldn't do
1224 anything but set the frame's selected_window slot. */
1225 if (EQ (window, selected_window))
1226 Fselect_window (alternative);
1227 else
1228 FRAME_SELECTED_WINDOW (f) = alternative;
1232 tem = p->buffer;
1233 /* tem is null for dummy parent windows
1234 (which have inferiors but not any contents themselves) */
1235 if (!NILP (tem))
1237 unshow_buffer (p);
1238 unchain_marker (p->pointm);
1239 unchain_marker (p->start);
1242 /* Free window glyph matrices. It is sure that they are allocated
1243 again when ADJUST_GLYPHS is called. Block input so that expose
1244 events and other events that access glyph matrices are not
1245 processed while we are changing them. */
1246 BLOCK_INPUT;
1247 free_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)));
1249 tem = p->next;
1250 if (!NILP (tem))
1251 XWINDOW (tem)->prev = p->prev;
1253 tem = p->prev;
1254 if (!NILP (tem))
1255 XWINDOW (tem)->next = p->next;
1257 if (EQ (window, par->hchild))
1258 par->hchild = p->next;
1259 if (EQ (window, par->vchild))
1260 par->vchild = p->next;
1262 /* Find one of our siblings to give our space to. */
1263 sib = p->prev;
1264 if (NILP (sib))
1266 /* If p gives its space to its next sibling, that sibling needs
1267 to have its top/left side pulled back to where p's is.
1268 set_window_{height,width} will re-position the sibling's
1269 children. */
1270 sib = p->next;
1271 XWINDOW (sib)->top = p->top;
1272 XWINDOW (sib)->left = p->left;
1275 /* Stretch that sibling. */
1276 if (!NILP (par->vchild))
1277 set_window_height (sib,
1278 XFASTINT (XWINDOW (sib)->height) + XFASTINT (p->height),
1280 if (!NILP (par->hchild))
1281 set_window_width (sib,
1282 XFASTINT (XWINDOW (sib)->width) + XFASTINT (p->width),
1285 /* If parent now has only one child,
1286 put the child into the parent's place. */
1287 tem = par->hchild;
1288 if (NILP (tem))
1289 tem = par->vchild;
1290 if (NILP (XWINDOW (tem)->next))
1291 replace_window (parent, tem);
1293 /* Since we may be deleting combination windows, we must make sure that
1294 not only p but all its children have been marked as deleted. */
1295 if (! NILP (p->hchild))
1296 delete_all_subwindows (XWINDOW (p->hchild));
1297 else if (! NILP (p->vchild))
1298 delete_all_subwindows (XWINDOW (p->vchild));
1300 /* Mark this window as deleted. */
1301 p->buffer = p->hchild = p->vchild = Qnil;
1303 /* Adjust glyph matrices. */
1304 adjust_glyphs (f);
1305 UNBLOCK_INPUT;
1310 /***********************************************************************
1311 Window List
1312 ***********************************************************************/
1314 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1315 pointer. This is a callback function for foreach_window, used in
1316 function window_list. */
1318 static int
1319 add_window_to_list (w, user_data)
1320 struct window *w;
1321 void *user_data;
1323 Lisp_Object *list = (Lisp_Object *) user_data;
1324 Lisp_Object window;
1325 XSETWINDOW (window, w);
1326 *list = Fcons (window, *list);
1327 return 1;
1331 /* Return a list of all windows, for use by next_window. If
1332 Vwindow_list is a list, return that list. Otherwise, build a new
1333 list, cache it in Vwindow_list, and return that. */
1335 static Lisp_Object
1336 window_list ()
1338 if (!CONSP (Vwindow_list))
1340 Lisp_Object tail;
1342 Vwindow_list = Qnil;
1343 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1345 Lisp_Object args[2];
1347 /* We are visiting windows in canonical order, and add
1348 new windows at the front of args[1], which means we
1349 have to reverse this list at the end. */
1350 args[1] = Qnil;
1351 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1352 args[0] = Vwindow_list;
1353 args[1] = Fnreverse (args[1]);
1354 Vwindow_list = Fnconc (2, args);
1358 return Vwindow_list;
1362 /* Value is non-zero if WINDOW satisfies the constraints given by
1363 OWINDOW, MINIBUF and ALL_FRAMES.
1365 MINIBUF t means WINDOW may be minibuffer windows.
1366 `lambda' means WINDOW may not be a minibuffer window.
1367 a window means a specific minibuffer window
1369 ALL_FRAMES t means search all frames,
1370 nil means search just current frame,
1371 `visible' means search just visible frames,
1372 0 means search visible and iconified frames,
1373 a window means search the frame that window belongs to,
1374 a frame means consider windows on that frame, only. */
1376 static int
1377 candidate_window_p (window, owindow, minibuf, all_frames)
1378 Lisp_Object window, owindow, minibuf, all_frames;
1380 struct window *w = XWINDOW (window);
1381 struct frame *f = XFRAME (w->frame);
1382 int candidate_p = 1;
1384 if (!BUFFERP (w->buffer))
1385 candidate_p = 0;
1386 else if (MINI_WINDOW_P (w)
1387 && (EQ (minibuf, Qlambda)
1388 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
1390 /* If MINIBUF is `lambda' don't consider any mini-windows.
1391 If it is a window, consider only that one. */
1392 candidate_p = 0;
1394 else if (EQ (all_frames, Qt))
1395 candidate_p = 1;
1396 else if (NILP (all_frames))
1398 xassert (WINDOWP (owindow));
1399 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
1401 else if (EQ (all_frames, Qvisible))
1403 FRAME_SAMPLE_VISIBILITY (f);
1404 candidate_p = FRAME_VISIBLE_P (f);
1406 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
1408 FRAME_SAMPLE_VISIBILITY (f);
1409 candidate_p = FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f);
1411 else if (WINDOWP (all_frames))
1412 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
1413 || EQ (XWINDOW (all_frames)->frame, w->frame)
1414 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
1415 else if (FRAMEP (all_frames))
1416 candidate_p = EQ (all_frames, w->frame);
1418 return candidate_p;
1422 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
1423 Fwindow_list. See there for the meaning of WINDOW, MINIBUF, and
1424 ALL_FRAMES. */
1426 static void
1427 decode_next_window_args (window, minibuf, all_frames)
1428 Lisp_Object *window, *minibuf, *all_frames;
1430 if (NILP (*window))
1431 *window = selected_window;
1432 else
1433 CHECK_LIVE_WINDOW (*window, 0);
1435 /* MINIBUF nil may or may not include minibuffers. Decide if it
1436 does. */
1437 if (NILP (*minibuf))
1438 *minibuf = minibuf_level ? minibuf_window : Qlambda;
1439 else if (!EQ (*minibuf, Qt))
1440 *minibuf = Qlambda;
1442 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
1443 => count none of them, or a specific minibuffer window (the
1444 active one) to count. */
1446 /* ALL_FRAMES nil doesn't specify which frames to include. */
1447 if (NILP (*all_frames))
1448 *all_frames = (!EQ (*minibuf, Qlambda)
1449 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
1450 : Qnil);
1451 else if (EQ (*all_frames, Qvisible))
1453 else if (XFASTINT (*all_frames) == 0)
1455 else if (FRAMEP (*all_frames))
1457 else if (!EQ (*all_frames, Qt))
1458 *all_frames = Qnil;
1460 /* Now *ALL_FRAMES is t meaning search all frames, nil meaning
1461 search just current frame, `visible' meaning search just visible
1462 frames, 0 meaning search visible and iconified frames, or a
1463 window, meaning search the frame that window belongs to, or a
1464 frame, meaning consider windows on that frame, only. */
1468 /* Return the next or previous window of WINDOW in canonical ordering
1469 of windows. NEXT_P non-zero means return the next window. See the
1470 documentation string of next-window for the meaning of MINIBUF and
1471 ALL_FRAMES. */
1473 static Lisp_Object
1474 next_window (window, minibuf, all_frames, next_p)
1475 Lisp_Object window, minibuf, all_frames;
1476 int next_p;
1478 decode_next_window_args (&window, &minibuf, &all_frames);
1480 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
1481 return the first window on the frame. */
1482 if (FRAMEP (all_frames)
1483 && !EQ (all_frames, XWINDOW (window)->frame))
1484 return Fframe_first_window (all_frames);
1486 if (next_p)
1488 Lisp_Object list;
1490 /* Find WINDOW in the list of all windows. */
1491 list = Fmemq (window, window_list ());
1493 /* Scan forward from WINDOW to the end of the window list. */
1494 if (CONSP (list))
1495 for (list = XCDR (list); CONSP (list); list = XCDR (list))
1496 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1497 break;
1499 /* Scan from the start of the window list up to WINDOW. */
1500 if (!CONSP (list))
1501 for (list = Vwindow_list;
1502 CONSP (list) && !EQ (XCAR (list), window);
1503 list = XCDR (list))
1504 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1505 break;
1507 if (CONSP (list))
1508 window = XCAR (list);
1510 else
1512 Lisp_Object candidate, list;
1514 /* Scan through the list of windows for candidates. If there are
1515 candidate windows in front of WINDOW, the last one of these
1516 is the one we want. If there are candidates following WINDOW
1517 in the list, again the last one of these is the one we want. */
1518 candidate = Qnil;
1519 for (list = window_list (); CONSP (list); list = XCDR (list))
1521 if (EQ (XCAR (list), window))
1523 if (WINDOWP (candidate))
1524 break;
1526 else if (candidate_window_p (XCAR (list), window, minibuf,
1527 all_frames))
1528 candidate = XCAR (list);
1531 if (WINDOWP (candidate))
1532 window = candidate;
1535 return window;
1539 /* This comment supplies the doc string for `next-window',
1540 for make-docfile to see. We cannot put this in the real DEFUN
1541 due to limits in the Unix cpp.
1543 DEFUN ("next-window", Ffoo, Sfoo, 0, 3, 0,
1544 "Return next window after WINDOW in canonical ordering of windows.\n\
1545 If omitted, WINDOW defaults to the selected window.\n\
1547 Optional second arg MINIBUF t means count the minibuffer window even\n\
1548 if not active. MINIBUF nil or omitted means count the minibuffer iff\n\
1549 it is active. MINIBUF neither t nor nil means not to count the\n\
1550 minibuffer even if it is active.\n\
1552 Several frames may share a single minibuffer; if the minibuffer\n\
1553 counts, all windows on all frames that share that minibuffer count\n\
1554 too. Therefore, `next-window' can be used to iterate through the\n\
1555 set of windows even when the minibuffer is on another frame. If the\n\
1556 minibuffer does not count, only windows from WINDOW's frame count.\n\
1558 Optional third arg ALL-FRAMES t means include windows on all frames.\n\
1559 ALL-FRAMES nil or omitted means cycle within the frames as specified\n\
1560 above. ALL-FRAMES = `visible' means include windows on all visible frames.\n\
1561 ALL-FRAMES = 0 means include windows on all visible and iconified frames.\n\
1562 If ALL-FRAMES is a frame, restrict search to windows on that frame.\n\
1563 Anything else means restrict to WINDOW's frame.\n\
1565 If you use consistent values for MINIBUF and ALL-FRAMES, you can use\n\
1566 `next-window' to iterate through the entire cycle of acceptable\n\
1567 windows, eventually ending up back at the window you started with.\n\
1568 `previous-window' traverses the same cycle, in the reverse order.")
1569 (window, minibuf, all_frames) */
1571 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
1573 (window, minibuf, all_frames)
1574 Lisp_Object window, minibuf, all_frames;
1576 return next_window (window, minibuf, all_frames, 1);
1580 /* This comment supplies the doc string for `previous-window',
1581 for make-docfile to see. We cannot put this in the real DEFUN
1582 due to limits in the Unix cpp.
1584 DEFUN ("previous-window", Ffoo, Sfoo, 0, 3, 0,
1585 "Return the window preceding WINDOW in canonical ordering of windows.\n\
1586 If omitted, WINDOW defaults to the selected window.\n\
1588 Optional second arg MINIBUF t means count the minibuffer window even\n\
1589 if not active. MINIBUF nil or omitted means count the minibuffer iff\n\
1590 it is active. MINIBUF neither t nor nil means not to count the\n\
1591 minibuffer even if it is active.\n\
1593 Several frames may share a single minibuffer; if the minibuffer\n\
1594 counts, all windows on all frames that share that minibuffer count\n\
1595 too. Therefore, `previous-window' can be used to iterate through\n\
1596 the set of windows even when the minibuffer is on another frame. If\n\
1597 the minibuffer does not count, only windows from WINDOW's frame count\n\
1599 Optional third arg ALL-FRAMES t means include windows on all frames.\n\
1600 ALL-FRAMES nil or omitted means cycle within the frames as specified\n\
1601 above. ALL-FRAMES = `visible' means include windows on all visible frames.\n\
1602 ALL-FRAMES = 0 means include windows on all visible and iconified frames.\n\
1603 If ALL-FRAMES is a frame, restrict search to windows on that frame.\n\
1604 Anything else means restrict to WINDOW's frame.\n\
1606 If you use consistent values for MINIBUF and ALL-FRAMES, you can use\n\
1607 `previous-window' to iterate through the entire cycle of acceptable\n\
1608 windows, eventually ending up back at the window you started with.\n\
1609 `next-window' traverses the same cycle, in the reverse order.")
1610 (window, minibuf, all_frames) */
1613 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
1615 (window, minibuf, all_frames)
1616 Lisp_Object window, minibuf, all_frames;
1618 return next_window (window, minibuf, all_frames, 0);
1622 DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
1623 "Select the ARG'th different window on this frame.\n\
1624 All windows on current frame are arranged in a cyclic order.\n\
1625 This command selects the window ARG steps away in that order.\n\
1626 A negative ARG moves in the opposite order. If the optional second\n\
1627 argument ALL_FRAMES is non-nil, cycle through all frames.")
1628 (arg, all_frames)
1629 Lisp_Object arg, all_frames;
1631 Lisp_Object window;
1632 int i;
1634 CHECK_NUMBER (arg, 0);
1635 window = selected_window;
1637 for (i = XINT (arg); i > 0; --i)
1638 window = Fnext_window (window, Qnil, all_frames);
1639 for (; i < 0; ++i)
1640 window = Fprevious_window (window, Qnil, all_frames);
1642 Fselect_window (window);
1643 return Qnil;
1647 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
1648 "Return a list of windows on FRAME, starting with WINDOW.\n\
1649 FRAME nil or omitted means use the selected frame.\n\
1650 WINDOW nil or omitted means use the selected window.\n\
1651 MINIBUF t means include the minibuffer window, even if it isn't active.\n\
1652 MINIBUF nil or omitted means include the minibuffer window only\n\
1653 if it's active.\n\
1654 MINIBUF neither nil nor t means never include the minibuffer window.")
1655 (frame, minibuf, window)
1656 Lisp_Object frame, minibuf, window;
1659 if (NILP (window))
1660 window = selected_window;
1661 if (NILP (frame))
1662 frame = selected_frame;
1664 if (!EQ (frame, XWINDOW (window)->frame))
1665 error ("Window is on a different frame");
1667 return window_list_1 (window, minibuf, frame);
1671 /* Return a list of windows in canonical ordering. Arguments are like
1672 for `next-window'. */
1674 static Lisp_Object
1675 window_list_1 (window, minibuf, all_frames)
1676 Lisp_Object window, minibuf, all_frames;
1678 Lisp_Object tail, list;
1680 decode_next_window_args (&window, &minibuf, &all_frames);
1681 list = Qnil;
1683 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
1684 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
1685 list = Fcons (XCAR (tail), list);
1687 return Fnreverse (list);
1692 /* Look at all windows, performing an operation specified by TYPE
1693 with argument OBJ.
1694 If FRAMES is Qt, look at all frames;
1695 Qnil, look at just the selected frame;
1696 Qvisible, look at visible frames;
1697 a frame, just look at windows on that frame.
1698 If MINI is non-zero, perform the operation on minibuffer windows too. */
1700 enum window_loop
1702 WINDOW_LOOP_UNUSED,
1703 GET_BUFFER_WINDOW, /* Arg is buffer */
1704 GET_LRU_WINDOW, /* Arg is t for full-width windows only */
1705 DELETE_OTHER_WINDOWS, /* Arg is window not to delete */
1706 DELETE_BUFFER_WINDOWS, /* Arg is buffer */
1707 GET_LARGEST_WINDOW,
1708 UNSHOW_BUFFER, /* Arg is buffer */
1709 CHECK_ALL_WINDOWS
1712 static Lisp_Object
1713 window_loop (type, obj, mini, frames)
1714 enum window_loop type;
1715 Lisp_Object obj, frames;
1716 int mini;
1718 Lisp_Object window, windows, best_window, frame_arg;
1719 struct frame *f;
1720 struct gcpro gcpro1;
1722 /* If we're only looping through windows on a particular frame,
1723 frame points to that frame. If we're looping through windows
1724 on all frames, frame is 0. */
1725 if (FRAMEP (frames))
1726 f = XFRAME (frames);
1727 else if (NILP (frames))
1728 f = SELECTED_FRAME ();
1729 else
1730 f = NULL;
1732 if (f)
1733 frame_arg = Qlambda;
1734 else if (XFASTINT (frames) == 0)
1735 frame_arg = frames;
1736 else if (EQ (frames, Qvisible))
1737 frame_arg = frames;
1738 else
1739 frame_arg = Qt;
1741 /* frame_arg is Qlambda to stick to one frame,
1742 Qvisible to consider all visible frames,
1743 or Qt otherwise. */
1745 /* Pick a window to start with. */
1746 if (WINDOWP (obj))
1747 window = obj;
1748 else if (f)
1749 window = FRAME_SELECTED_WINDOW (f);
1750 else
1751 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
1753 /* Figure out the last window we're going to mess with. Since
1754 Fnext_window, given the same options, is guaranteed to go in a
1755 ring, we can just use Fprevious_window to find the last one.
1757 We can't just wait until we hit the first window again, because
1758 it might be deleted. */
1760 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
1761 GCPRO1 (windows);
1762 best_window = Qnil;
1764 for (; CONSP (windows); windows = CDR (windows))
1766 struct window *w;
1768 window = XCAR (windows);
1769 w = XWINDOW (window);
1771 /* Note that we do not pay attention here to whether the frame
1772 is visible, since Fwindow_list skips non-visible frames if
1773 that is desired, under the control of frame_arg. */
1774 if (!MINI_WINDOW_P (w)
1775 /* For UNSHOW_BUFFER, we must always consider all windows. */
1776 || type == UNSHOW_BUFFER
1777 || (mini && minibuf_level > 0))
1778 switch (type)
1780 case GET_BUFFER_WINDOW:
1781 if (EQ (w->buffer, obj)
1782 /* Don't find any minibuffer window
1783 except the one that is currently in use. */
1784 && (MINI_WINDOW_P (w)
1785 ? EQ (window, minibuf_window)
1786 : 1))
1788 UNGCPRO;
1789 return window;
1791 break;
1793 case GET_LRU_WINDOW:
1794 /* t as arg means consider only full-width windows */
1795 if (!NILP (obj) && !WINDOW_FULL_WIDTH_P (w))
1796 break;
1797 /* Ignore dedicated windows and minibuffers. */
1798 if (MINI_WINDOW_P (w) || !NILP (w->dedicated))
1799 break;
1800 if (NILP (best_window)
1801 || (XFASTINT (XWINDOW (best_window)->use_time)
1802 > XFASTINT (w->use_time)))
1803 best_window = window;
1804 break;
1806 case DELETE_OTHER_WINDOWS:
1807 if (!EQ (window, obj))
1808 Fdelete_window (window);
1809 break;
1811 case DELETE_BUFFER_WINDOWS:
1812 if (EQ (w->buffer, obj))
1814 struct frame *f = XFRAME (WINDOW_FRAME (w));
1816 /* If this window is dedicated, and in a frame of its own,
1817 kill the frame. */
1818 if (EQ (window, FRAME_ROOT_WINDOW (f))
1819 && !NILP (w->dedicated)
1820 && other_visible_frames (f))
1822 /* Skip the other windows on this frame.
1823 There might be one, the minibuffer! */
1824 while (CONSP (XCDR (windows))
1825 && EQ (XWINDOW (XCAR (windows))->frame,
1826 XWINDOW (XCAR (XCDR (windows)))->frame))
1827 windows = XCDR (windows);
1829 /* Now we can safely delete the frame. */
1830 Fdelete_frame (w->frame, Qnil);
1832 else if (NILP (w->parent))
1834 /* If we're deleting the buffer displayed in the
1835 only window on the frame, find a new buffer to
1836 display there. */
1837 Lisp_Object buffer;
1838 buffer = Fother_buffer (obj, Qnil, w->frame);
1839 if (NILP (buffer))
1840 buffer = Fget_buffer_create (build_string ("*scratch*"));
1841 Fset_window_buffer (window, buffer);
1842 if (EQ (window, selected_window))
1843 Fset_buffer (w->buffer);
1845 else
1846 Fdelete_window (window);
1848 break;
1850 case GET_LARGEST_WINDOW:
1852 /* Ignore dedicated windows and minibuffers. */
1853 if (MINI_WINDOW_P (w) || !NILP (w->dedicated))
1854 break;
1856 if (NILP (best_window))
1857 best_window = window;
1858 else
1860 struct window *b = XWINDOW (best_window);
1861 if (XFASTINT (w->height) * XFASTINT (w->width)
1862 > XFASTINT (b->height) * XFASTINT (b->width))
1863 best_window = window;
1866 break;
1868 case UNSHOW_BUFFER:
1869 if (EQ (w->buffer, obj))
1871 Lisp_Object buffer;
1872 struct frame *f = XFRAME (w->frame);
1874 /* Find another buffer to show in this window. */
1875 buffer = Fother_buffer (obj, Qnil, w->frame);
1876 if (NILP (buffer))
1877 buffer = Fget_buffer_create (build_string ("*scratch*"));
1879 /* If this window is dedicated, and in a frame of its own,
1880 kill the frame. */
1881 if (EQ (window, FRAME_ROOT_WINDOW (f))
1882 && !NILP (w->dedicated)
1883 && other_visible_frames (f))
1885 /* Skip the other windows on this frame.
1886 There might be one, the minibuffer! */
1887 while (CONSP (XCDR (windows))
1888 && EQ (XWINDOW (XCAR (windows))->frame,
1889 XWINDOW (XCAR (XCDR (windows)))->frame))
1890 windows = XCDR (windows);
1892 /* Now we can safely delete the frame. */
1893 Fdelete_frame (w->frame, Qnil);
1895 else
1897 /* Otherwise show a different buffer in the window. */
1898 w->dedicated = Qnil;
1899 Fset_window_buffer (window, buffer);
1900 if (EQ (window, selected_window))
1901 Fset_buffer (w->buffer);
1904 break;
1906 /* Check for a window that has a killed buffer. */
1907 case CHECK_ALL_WINDOWS:
1908 if (! NILP (w->buffer)
1909 && NILP (XBUFFER (w->buffer)->name))
1910 abort ();
1911 break;
1913 case WINDOW_LOOP_UNUSED:
1914 break;
1918 UNGCPRO;
1919 return best_window;
1922 /* Used for debugging. Abort if any window has a dead buffer. */
1924 void
1925 check_all_windows ()
1927 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
1930 DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 1, 0,
1931 "Return the window least recently selected or used for display.\n\
1932 If optional argument FRAME is `visible', search all visible frames.\n\
1933 If FRAME is 0, search all visible and iconified frames.\n\
1934 If FRAME is t, search all frames.\n\
1935 If FRAME is nil, search only the selected frame.\n\
1936 If FRAME is a frame, search only that frame.")
1937 (frame)
1938 Lisp_Object frame;
1940 register Lisp_Object w;
1941 /* First try for a window that is full-width */
1942 w = window_loop (GET_LRU_WINDOW, Qt, 0, frame);
1943 if (!NILP (w) && !EQ (w, selected_window))
1944 return w;
1945 /* If none of them, try the rest */
1946 return window_loop (GET_LRU_WINDOW, Qnil, 0, frame);
1949 DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 1, 0,
1950 "Return the largest window in area.\n\
1951 If optional argument FRAME is `visible', search all visible frames.\n\
1952 If FRAME is 0, search all visible and iconified frames.\n\
1953 If FRAME is t, search all frames.\n\
1954 If FRAME is nil, search only the selected frame.\n\
1955 If FRAME is a frame, search only that frame.")
1956 (frame)
1957 Lisp_Object frame;
1959 return window_loop (GET_LARGEST_WINDOW, Qnil, 0,
1960 frame);
1963 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 1, 2, 0,
1964 "Return a window currently displaying BUFFER, or nil if none.\n\
1965 If optional argument FRAME is `visible', search all visible frames.\n\
1966 If optional argument FRAME is 0, search all visible and iconified frames.\n\
1967 If FRAME is t, search all frames.\n\
1968 If FRAME is nil, search only the selected frame.\n\
1969 If FRAME is a frame, search only that frame.")
1970 (buffer, frame)
1971 Lisp_Object buffer, frame;
1973 buffer = Fget_buffer (buffer);
1974 if (BUFFERP (buffer))
1975 return window_loop (GET_BUFFER_WINDOW, buffer, 1, frame);
1976 else
1977 return Qnil;
1980 DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
1981 0, 1, "",
1982 "Make WINDOW (or the selected window) fill its frame.\n\
1983 Only the frame WINDOW is on is affected.\n\
1984 This function tries to reduce display jumps\n\
1985 by keeping the text previously visible in WINDOW\n\
1986 in the same place on the frame. Doing this depends on\n\
1987 the value of (window-start WINDOW), so if calling this function\n\
1988 in a program gives strange scrolling, make sure the window-start\n\
1989 value is reasonable when this function is called.")
1990 (window)
1991 Lisp_Object window;
1993 struct window *w;
1994 int startpos;
1995 int top, new_top;
1997 if (NILP (window))
1998 window = selected_window;
1999 else
2000 CHECK_LIVE_WINDOW (window, 0);
2001 w = XWINDOW (window);
2003 startpos = marker_position (w->start);
2004 top = XFASTINT (w->top) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2006 if (MINI_WINDOW_P (w) && top > 0)
2007 error ("Can't expand minibuffer to full frame");
2009 window_loop (DELETE_OTHER_WINDOWS, window, 0, WINDOW_FRAME (w));
2011 /* Try to minimize scrolling, by setting the window start to the point
2012 will cause the text at the old window start to be at the same place
2013 on the frame. But don't try to do this if the window start is
2014 outside the visible portion (as might happen when the display is
2015 not current, due to typeahead). */
2016 new_top = XFASTINT (w->top) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2017 if (new_top != top
2018 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2019 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2021 struct position pos;
2022 struct buffer *obuf = current_buffer;
2024 Fset_buffer (w->buffer);
2025 /* This computation used to temporarily move point, but that can
2026 have unwanted side effects due to text properties. */
2027 pos = *vmotion (startpos, -top, w);
2029 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2030 w->window_end_valid = Qnil;
2031 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2032 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2033 : Qnil);
2034 /* We need to do this, so that the window-scroll-functions
2035 get called. */
2036 w->optional_new_start = Qt;
2038 set_buffer_internal (obuf);
2041 return Qnil;
2044 DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
2045 1, 2, "bDelete windows on (buffer): ",
2046 "Delete all windows showing BUFFER.\n\
2047 Optional second argument FRAME controls which frames are affected.\n\
2048 If optional argument FRAME is `visible', search all visible frames.\n\
2049 If FRAME is 0, search all visible and iconified frames.\n\
2050 If FRAME is nil, search all frames.\n\
2051 If FRAME is t, search only the selected frame.\n\
2052 If FRAME is a frame, search only that frame.")
2053 (buffer, frame)
2054 Lisp_Object buffer, frame;
2056 /* FRAME uses t and nil to mean the opposite of what window_loop
2057 expects. */
2058 if (NILP (frame))
2059 frame = Qt;
2060 else if (EQ (frame, Qt))
2061 frame = Qnil;
2063 if (!NILP (buffer))
2065 buffer = Fget_buffer (buffer);
2066 CHECK_BUFFER (buffer, 0);
2067 window_loop (DELETE_BUFFER_WINDOWS, buffer, 0, frame);
2070 return Qnil;
2073 DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows,
2074 Sreplace_buffer_in_windows,
2075 1, 1, "bReplace buffer in windows: ",
2076 "Replace BUFFER with some other buffer in all windows showing it.")
2077 (buffer)
2078 Lisp_Object buffer;
2080 if (!NILP (buffer))
2082 buffer = Fget_buffer (buffer);
2083 CHECK_BUFFER (buffer, 0);
2084 window_loop (UNSHOW_BUFFER, buffer, 0, Qt);
2086 return Qnil;
2089 /* Replace BUFFER with some other buffer in all windows
2090 of all frames, even those on other keyboards. */
2092 void
2093 replace_buffer_in_all_windows (buffer)
2094 Lisp_Object buffer;
2096 #ifdef MULTI_KBOARD
2097 Lisp_Object tail, frame;
2099 /* A single call to window_loop won't do the job
2100 because it only considers frames on the current keyboard.
2101 So loop manually over frames, and handle each one. */
2102 FOR_EACH_FRAME (tail, frame)
2103 window_loop (UNSHOW_BUFFER, buffer, 1, frame);
2104 #else
2105 window_loop (UNSHOW_BUFFER, buffer, 1, Qt);
2106 #endif
2109 /* Set the height of WINDOW and all its inferiors. */
2111 /* The smallest acceptable dimensions for a window. Anything smaller
2112 might crash Emacs. */
2114 #define MIN_SAFE_WINDOW_WIDTH (2)
2115 #define MIN_SAFE_WINDOW_HEIGHT (2)
2117 /* Make sure that window_min_height and window_min_width are
2118 not too small; if they are, set them to safe minima. */
2120 static void
2121 check_min_window_sizes ()
2123 /* Smaller values might permit a crash. */
2124 if (window_min_width < MIN_SAFE_WINDOW_WIDTH)
2125 window_min_width = MIN_SAFE_WINDOW_WIDTH;
2126 if (window_min_height < MIN_SAFE_WINDOW_HEIGHT)
2127 window_min_height = MIN_SAFE_WINDOW_HEIGHT;
2130 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2131 minimum allowable size. */
2133 void
2134 check_frame_size (frame, rows, cols)
2135 FRAME_PTR frame;
2136 int *rows, *cols;
2138 /* For height, we have to see:
2139 whether the frame has a minibuffer,
2140 whether it wants a mode line, and
2141 whether it has a menu bar. */
2142 int min_height =
2143 (FRAME_MINIBUF_ONLY_P (frame) ? MIN_SAFE_WINDOW_HEIGHT - 1
2144 : (! FRAME_HAS_MINIBUF_P (frame)) ? MIN_SAFE_WINDOW_HEIGHT
2145 : 2 * MIN_SAFE_WINDOW_HEIGHT - 1);
2147 if (FRAME_TOP_MARGIN (frame) > 0)
2148 min_height += FRAME_TOP_MARGIN (frame);
2150 if (*rows < min_height)
2151 *rows = min_height;
2152 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2153 *cols = MIN_SAFE_WINDOW_WIDTH;
2157 /* Value is non-zero if window W is fixed-size. WIDTH_P non-zero means
2158 check if W's width can be changed, otherwise check W's height.
2159 CHECK_SIBLINGS_P non-zero means check resizablity of WINDOW's
2160 siblings, too. If none of the siblings is resizable, WINDOW isn't
2161 either. */
2163 static int
2164 window_fixed_size_p (w, width_p, check_siblings_p)
2165 struct window *w;
2166 int width_p, check_siblings_p;
2168 int fixed_p;
2169 struct window *c;
2171 if (!NILP (w->hchild))
2173 c = XWINDOW (w->hchild);
2175 if (width_p)
2177 /* A horiz. combination is fixed-width if all of if its
2178 children are. */
2179 while (c && window_fixed_size_p (c, width_p, 0))
2180 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2181 fixed_p = c == NULL;
2183 else
2185 /* A horiz. combination is fixed-height if one of if its
2186 children is. */
2187 while (c && !window_fixed_size_p (c, width_p, 0))
2188 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2189 fixed_p = c != NULL;
2192 else if (!NILP (w->vchild))
2194 c = XWINDOW (w->vchild);
2196 if (width_p)
2198 /* A vert. combination is fixed-width if one of if its
2199 children is. */
2200 while (c && !window_fixed_size_p (c, width_p, 0))
2201 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2202 fixed_p = c != NULL;
2204 else
2206 /* A vert. combination is fixed-height if all of if its
2207 children are. */
2208 while (c && window_fixed_size_p (c, width_p, 0))
2209 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2210 fixed_p = c == NULL;
2213 else if (BUFFERP (w->buffer))
2215 if (w->height_fixed_p && !width_p)
2216 fixed_p = 1;
2217 else
2219 struct buffer *old = current_buffer;
2220 Lisp_Object val;
2222 current_buffer = XBUFFER (w->buffer);
2223 val = find_symbol_value (Qwindow_size_fixed);
2224 current_buffer = old;
2226 fixed_p = 0;
2227 if (!EQ (val, Qunbound))
2229 fixed_p = !NILP (val);
2231 if (fixed_p
2232 && ((EQ (val, Qheight) && width_p)
2233 || (EQ (val, Qwidth) && !width_p)))
2234 fixed_p = 0;
2238 /* Can't tell if this one is resizable without looking at
2239 siblings. If all siblings are fixed-size this one is too. */
2240 if (!fixed_p && check_siblings_p && WINDOWP (w->parent))
2242 Lisp_Object child;
2244 for (child = w->prev; !NILP (child); child = XWINDOW (child)->prev)
2245 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2246 break;
2248 if (NILP (child))
2249 for (child = w->next; !NILP (child); child = XWINDOW (child)->next)
2250 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2251 break;
2253 if (NILP (child))
2254 fixed_p = 1;
2257 else
2258 fixed_p = 1;
2260 return fixed_p;
2264 /* Return the minimum size of window W, not taking fixed-width windows
2265 into account. WIDTH_P non-zero means return the minimum width,
2266 otherwise return the minimum height. If W is a combination window,
2267 compute the minimum size from the minimum sizes of W's children. */
2269 static int
2270 window_min_size_1 (w, width_p)
2271 struct window *w;
2272 int width_p;
2274 struct window *c;
2275 int size;
2277 if (!NILP (w->hchild))
2279 c = XWINDOW (w->hchild);
2280 size = 0;
2282 if (width_p)
2284 /* The min width of a horizontal combination is
2285 the sum of the min widths of its children. */
2286 while (c)
2288 size += window_min_size_1 (c, width_p);
2289 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2292 else
2294 /* The min height a horizontal combination equals
2295 the maximum of all min height of its children. */
2296 while (c)
2298 int min_size = window_min_size_1 (c, width_p);
2299 size = max (min_size, size);
2300 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2304 else if (!NILP (w->vchild))
2306 c = XWINDOW (w->vchild);
2307 size = 0;
2309 if (width_p)
2311 /* The min width of a vertical combination is
2312 the maximum of the min widths of its children. */
2313 while (c)
2315 int min_size = window_min_size_1 (c, width_p);
2316 size = max (min_size, size);
2317 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2320 else
2322 /* The min height of a vertical combination equals
2323 the sum of the min height of its children. */
2324 while (c)
2326 size += window_min_size_1 (c, width_p);
2327 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2331 else
2333 if (width_p)
2334 size = window_min_width;
2335 else
2337 if (MINI_WINDOW_P (w)
2338 || (!WINDOW_WANTS_MODELINE_P (w)
2339 && !WINDOW_WANTS_HEADER_LINE_P (w)))
2340 size = 1;
2341 else
2342 size = window_min_height;
2346 return size;
2350 /* Return the minimum size of window W, taking fixed-size windows into
2351 account. WIDTH_P non-zero means return the minimum width,
2352 otherwise return the minimum height. IGNORE_FIXED_P non-zero means
2353 ignore if W is fixed-size. Set *FIXED to 1 if W is fixed-size
2354 unless FIXED is null. */
2356 static int
2357 window_min_size (w, width_p, ignore_fixed_p, fixed)
2358 struct window *w;
2359 int width_p, ignore_fixed_p, *fixed;
2361 int size, fixed_p;
2363 if (ignore_fixed_p)
2364 fixed_p = 0;
2365 else
2366 fixed_p = window_fixed_size_p (w, width_p, 1);
2368 if (fixed)
2369 *fixed = fixed_p;
2371 if (fixed_p)
2372 size = width_p ? XFASTINT (w->width) : XFASTINT (w->height);
2373 else
2374 size = window_min_size_1 (w, width_p);
2376 return size;
2380 /* Set WINDOW's height or width to SIZE. WIDTH_P non-zero means set
2381 WINDOW's width. Resize WINDOW's children, if any, so that they
2382 keep their proportionate size relative to WINDOW. Propagate
2383 WINDOW's top or left edge position to children. Delete windows
2384 that become too small unless NODELETE_P is non-zero. */
2386 static void
2387 size_window (window, size, width_p, nodelete_p)
2388 Lisp_Object window;
2389 int size, width_p, nodelete_p;
2391 struct window *w = XWINDOW (window);
2392 struct window *c;
2393 Lisp_Object child, *forward, *sideward;
2394 int old_size, min_size;
2396 check_min_window_sizes ();
2397 size = max (0, size);
2399 /* If the window has been "too small" at one point,
2400 don't delete it for being "too small" in the future.
2401 Preserve it as long as that is at all possible. */
2402 if (width_p)
2404 old_size = XINT (w->width);
2405 min_size = window_min_width;
2407 else
2409 old_size = XINT (w->height);
2410 min_size = window_min_height;
2413 if (old_size < min_size)
2414 w->too_small_ok = Qt;
2416 /* Maybe delete WINDOW if it's too small. */
2417 if (!nodelete_p && !NILP (w->parent))
2419 if (!MINI_WINDOW_P (w) && !NILP (w->too_small_ok))
2420 min_size = width_p ? MIN_SAFE_WINDOW_WIDTH : MIN_SAFE_WINDOW_HEIGHT;
2421 else
2422 min_size = width_p ? window_min_width : window_min_height;
2424 if (size < min_size)
2426 delete_window (window);
2427 return;
2431 /* Set redisplay hints. */
2432 w->last_modified = make_number (0);
2433 w->last_overlay_modified = make_number (0);
2434 windows_or_buffers_changed++;
2435 FRAME_WINDOW_SIZES_CHANGED (XFRAME (w->frame)) = 1;
2437 if (width_p)
2439 sideward = &w->vchild;
2440 forward = &w->hchild;
2441 w->width = make_number (size);
2443 else
2445 sideward = &w->hchild;
2446 forward = &w->vchild;
2447 w->height = make_number (size);
2448 w->orig_height = Qnil;
2451 if (!NILP (*sideward))
2453 for (child = *sideward; !NILP (child); child = c->next)
2455 c = XWINDOW (child);
2456 if (width_p)
2457 c->left = w->left;
2458 else
2459 c->top = w->top;
2460 size_window (child, size, width_p, nodelete_p);
2463 else if (!NILP (*forward))
2465 int fixed_size, each, extra, n;
2466 int resize_fixed_p, nfixed;
2467 int last_pos, first_pos, nchildren, total;
2469 /* Determine the fixed-size portion of the this window, and the
2470 number of child windows. */
2471 fixed_size = nchildren = nfixed = total = 0;
2472 for (child = *forward; !NILP (child); child = c->next, ++nchildren)
2474 int child_size;
2476 c = XWINDOW (child);
2477 child_size = width_p ? XINT (c->width) : XINT (c->height);
2478 total += child_size;
2480 if (window_fixed_size_p (c, width_p, 0))
2482 fixed_size += child_size;
2483 ++nfixed;
2487 /* If the new size is smaller than fixed_size, or if there
2488 aren't any resizable windows, allow resizing fixed-size
2489 windows. */
2490 resize_fixed_p = nfixed == nchildren || size < fixed_size;
2492 /* Compute how many lines/columns to add to each child. The
2493 value of extra takes care of rounding errors. */
2494 n = resize_fixed_p ? nchildren : nchildren - nfixed;
2495 each = (size - total) / n;
2496 extra = (size - total) - n * each;
2498 /* Compute new children heights and edge positions. */
2499 first_pos = width_p ? XINT (w->left) : XINT (w->top);
2500 last_pos = first_pos;
2501 for (child = *forward; !NILP (child); child = c->next)
2503 int new_size, old_size;
2505 c = XWINDOW (child);
2506 old_size = width_p ? XFASTINT (c->width) : XFASTINT (c->height);
2507 new_size = old_size;
2509 /* The top or left edge position of this child equals the
2510 bottom or right edge of its predecessor. */
2511 if (width_p)
2512 c->left = make_number (last_pos);
2513 else
2514 c->top = make_number (last_pos);
2516 /* If this child can be resized, do it. */
2517 if (resize_fixed_p || !window_fixed_size_p (c, width_p, 0))
2519 new_size = old_size + each + extra;
2520 extra = 0;
2523 /* Set new height. Note that size_window also propagates
2524 edge positions to children, so it's not a no-op if we
2525 didn't change the child's size. */
2526 size_window (child, new_size, width_p, 1);
2528 /* Remember the bottom/right edge position of this child; it
2529 will be used to set the top/left edge of the next child. */
2530 last_pos += new_size;
2533 /* We should have covered the parent exactly with child windows. */
2534 xassert (size == last_pos - first_pos);
2536 /* Now delete any children that became too small. */
2537 if (!nodelete_p)
2538 for (child = *forward; !NILP (child); child = c->next)
2540 int child_size;
2541 c = XWINDOW (child);
2542 child_size = width_p ? XINT (c->width) : XINT (c->height);
2543 size_window (child, child_size, width_p, 0);
2548 /* Set WINDOW's height to HEIGHT, and recursively change the height of
2549 WINDOW's children. NODELETE non-zero means don't delete windows
2550 that become too small in the process. (The caller should check
2551 later and do so if appropriate.) */
2553 void
2554 set_window_height (window, height, nodelete)
2555 Lisp_Object window;
2556 int height;
2557 int nodelete;
2559 size_window (window, height, 0, nodelete);
2563 /* Set WINDOW's width to WIDTH, and recursively change the width of
2564 WINDOW's children. NODELETE non-zero means don't delete windows
2565 that become too small in the process. (The caller should check
2566 later and do so if appropriate.) */
2568 void
2569 set_window_width (window, width, nodelete)
2570 Lisp_Object window;
2571 int width;
2572 int nodelete;
2574 size_window (window, width, 1, nodelete);
2578 int window_select_count;
2580 Lisp_Object
2581 Fset_window_buffer_unwind (obuf)
2582 Lisp_Object obuf;
2584 Fset_buffer (obuf);
2585 return Qnil;
2589 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
2590 means it's allowed to run hooks. See make_frame for a case where
2591 it's not allowed. */
2593 void
2594 set_window_buffer (window, buffer, run_hooks_p)
2595 Lisp_Object window, buffer;
2596 int run_hooks_p;
2598 struct window *w = XWINDOW (window);
2599 struct buffer *b = XBUFFER (buffer);
2600 int count = specpdl_ptr - specpdl;
2602 w->buffer = buffer;
2604 if (EQ (window, selected_window))
2605 b->last_selected_window = window;
2607 /* Update time stamps of buffer display. */
2608 if (INTEGERP (b->display_count))
2609 XSETINT (b->display_count, XINT (b->display_count) + 1);
2610 b->display_time = Fcurrent_time ();
2612 XSETFASTINT (w->window_end_pos, 0);
2613 XSETFASTINT (w->window_end_vpos, 0);
2614 bzero (&w->last_cursor, sizeof w->last_cursor);
2615 w->window_end_valid = Qnil;
2616 XSETFASTINT (w->hscroll, 0);
2617 XSETFASTINT (w->min_hscroll, 0);
2618 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
2619 set_marker_restricted (w->start,
2620 make_number (b->last_window_start),
2621 buffer);
2622 w->start_at_line_beg = Qnil;
2623 w->force_start = Qnil;
2624 XSETFASTINT (w->last_modified, 0);
2625 XSETFASTINT (w->last_overlay_modified, 0);
2626 windows_or_buffers_changed++;
2628 /* We must select BUFFER for running the window-scroll-functions.
2629 If WINDOW is selected, switch permanently.
2630 Otherwise, switch but go back to the ambient buffer afterward. */
2631 if (EQ (window, selected_window))
2632 Fset_buffer (buffer);
2633 /* We can't check ! NILP (Vwindow_scroll_functions) here
2634 because that might itself be a local variable. */
2635 else if (window_initialized)
2637 record_unwind_protect (Fset_window_buffer_unwind, Fcurrent_buffer ());
2638 Fset_buffer (buffer);
2641 /* Set left and right marginal area width from buffer. */
2642 Fset_window_margins (window, b->left_margin_width, b->right_margin_width);
2644 if (run_hooks_p)
2646 if (! NILP (Vwindow_scroll_functions))
2647 run_hook_with_args_2 (Qwindow_scroll_functions, window,
2648 Fmarker_position (w->start));
2650 if (! NILP (Vwindow_configuration_change_hook)
2651 && ! NILP (Vrun_hooks))
2652 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
2655 unbind_to (count, Qnil);
2659 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 2, 0,
2660 "Make WINDOW display BUFFER as its contents.\n\
2661 BUFFER can be a buffer or buffer name.")
2662 (window, buffer)
2663 register Lisp_Object window, buffer;
2665 register Lisp_Object tem;
2666 register struct window *w = decode_window (window);
2668 XSETWINDOW (window, w);
2669 buffer = Fget_buffer (buffer);
2670 CHECK_BUFFER (buffer, 1);
2672 if (NILP (XBUFFER (buffer)->name))
2673 error ("Attempt to display deleted buffer");
2675 tem = w->buffer;
2676 if (NILP (tem))
2677 error ("Window is deleted");
2678 else if (! EQ (tem, Qt)) /* w->buffer is t when the window
2679 is first being set up. */
2681 if (!NILP (w->dedicated) && !EQ (tem, buffer))
2682 error ("Window is dedicated to `%s'",
2683 XSTRING (XBUFFER (tem)->name)->data);
2685 unshow_buffer (w);
2688 set_window_buffer (window, buffer, 1);
2689 return Qnil;
2692 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 1, 0,
2693 "Select WINDOW. Most editing will apply to WINDOW's buffer.\n\
2694 If WINDOW is not already selected, also make WINDOW's buffer current.\n\
2695 Note that the main editor command loop\n\
2696 selects the buffer of the selected window before each command.")
2697 (window)
2698 register Lisp_Object window;
2700 return select_window_1 (window, 1);
2703 /* Note that selected_window can be nil
2704 when this is called from Fset_window_configuration. */
2706 static Lisp_Object
2707 select_window_1 (window, recordflag)
2708 register Lisp_Object window;
2709 int recordflag;
2711 register struct window *w;
2712 register struct window *ow;
2713 struct frame *sf;
2715 CHECK_LIVE_WINDOW (window, 0);
2717 w = XWINDOW (window);
2719 if (NILP (w->buffer))
2720 error ("Trying to select deleted window or non-leaf window");
2722 XSETFASTINT (w->use_time, ++window_select_count);
2723 if (EQ (window, selected_window))
2724 return window;
2726 if (!NILP (selected_window))
2728 ow = XWINDOW (selected_window);
2729 if (! NILP (ow->buffer))
2730 set_marker_both (ow->pointm, ow->buffer,
2731 BUF_PT (XBUFFER (ow->buffer)),
2732 BUF_PT_BYTE (XBUFFER (ow->buffer)));
2735 selected_window = window;
2736 sf = SELECTED_FRAME ();
2737 if (XFRAME (WINDOW_FRAME (w)) != sf)
2739 XFRAME (WINDOW_FRAME (w))->selected_window = window;
2740 /* Use this rather than Fhandle_switch_frame
2741 so that FRAME_FOCUS_FRAME is moved appropriately as we
2742 move around in the state where a minibuffer in a separate
2743 frame is active. */
2744 Fselect_frame (WINDOW_FRAME (w), Qnil);
2746 else
2747 sf->selected_window = window;
2749 if (recordflag)
2750 record_buffer (w->buffer);
2751 Fset_buffer (w->buffer);
2753 XBUFFER (w->buffer)->last_selected_window = window;
2755 /* Go to the point recorded in the window.
2756 This is important when the buffer is in more
2757 than one window. It also matters when
2758 redisplay_window has altered point after scrolling,
2759 because it makes the change only in the window. */
2761 register int new_point = marker_position (w->pointm);
2762 if (new_point < BEGV)
2763 SET_PT (BEGV);
2764 else if (new_point > ZV)
2765 SET_PT (ZV);
2766 else
2767 SET_PT (new_point);
2770 windows_or_buffers_changed++;
2771 return window;
2774 /* Deiconify the frame containing the window WINDOW,
2775 unless it is the selected frame;
2776 then return WINDOW.
2778 The reason for the exception for the selected frame
2779 is that it seems better not to change the selected frames visibility
2780 merely because of displaying a different buffer in it.
2781 The deiconification is useful when a buffer gets shown in
2782 another frame that you were not using lately. */
2784 static Lisp_Object
2785 display_buffer_1 (window)
2786 Lisp_Object window;
2788 Lisp_Object frame = XWINDOW (window)->frame;
2789 FRAME_PTR f = XFRAME (frame);
2791 FRAME_SAMPLE_VISIBILITY (f);
2793 if (!EQ (frame, selected_frame))
2795 if (FRAME_ICONIFIED_P (f))
2796 Fmake_frame_visible (frame);
2797 else if (FRAME_VISIBLE_P (f))
2798 Fraise_frame (frame);
2801 return window;
2804 DEFUN ("special-display-p", Fspecial_display_p, Sspecial_display_p, 1, 1, 0,
2805 "Returns non-nil if a buffer named BUFFER-NAME would be created specially.\n\
2806 The value is actually t if the frame should be called with default frame\n\
2807 parameters, and a list of frame parameters if they were specified.\n\
2808 See `special-display-buffer-names', and `special-display-regexps'.")
2809 (buffer_name)
2810 Lisp_Object buffer_name;
2812 Lisp_Object tem;
2814 CHECK_STRING (buffer_name, 1);
2816 tem = Fmember (buffer_name, Vspecial_display_buffer_names);
2817 if (!NILP (tem))
2818 return Qt;
2820 tem = Fassoc (buffer_name, Vspecial_display_buffer_names);
2821 if (!NILP (tem))
2822 return XCDR (tem);
2824 for (tem = Vspecial_display_regexps; CONSP (tem); tem = XCDR (tem))
2826 Lisp_Object car = XCAR (tem);
2827 if (STRINGP (car)
2828 && fast_string_match (car, buffer_name) >= 0)
2829 return Qt;
2830 else if (CONSP (car)
2831 && STRINGP (XCAR (car))
2832 && fast_string_match (XCAR (car), buffer_name) >= 0)
2833 return XCDR (car);
2835 return Qnil;
2838 DEFUN ("same-window-p", Fsame_window_p, Ssame_window_p, 1, 1, 0,
2839 "Returns non-nil if a new buffer named BUFFER-NAME would use the same window.\n\
2840 See `same-window-buffer-names' and `same-window-regexps'.")
2841 (buffer_name)
2842 Lisp_Object buffer_name;
2844 Lisp_Object tem;
2846 CHECK_STRING (buffer_name, 1);
2848 tem = Fmember (buffer_name, Vsame_window_buffer_names);
2849 if (!NILP (tem))
2850 return Qt;
2852 tem = Fassoc (buffer_name, Vsame_window_buffer_names);
2853 if (!NILP (tem))
2854 return Qt;
2856 for (tem = Vsame_window_regexps; CONSP (tem); tem = XCDR (tem))
2858 Lisp_Object car = XCAR (tem);
2859 if (STRINGP (car)
2860 && fast_string_match (car, buffer_name) >= 0)
2861 return Qt;
2862 else if (CONSP (car)
2863 && STRINGP (XCAR (car))
2864 && fast_string_match (XCAR (car), buffer_name) >= 0)
2865 return Qt;
2867 return Qnil;
2870 /* Use B so the default is (other-buffer). */
2871 DEFUN ("display-buffer", Fdisplay_buffer, Sdisplay_buffer, 1, 3,
2872 "BDisplay buffer: \nP",
2873 "Make BUFFER appear in some window but don't select it.\n\
2874 BUFFER can be a buffer or a buffer name.\n\
2875 If BUFFER is shown already in some window, just use that one,\n\
2876 unless the window is the selected window and the optional second\n\
2877 argument NOT-THIS-WINDOW is non-nil (interactively, with prefix arg).\n\
2878 If `pop-up-frames' is non-nil, make a new frame if no window shows BUFFER.\n\
2879 Returns the window displaying BUFFER.\n\
2880 If `display-reuse-frames' is non-nil, and another frame is currently\n\
2881 displaying BUFFER, then simply raise that frame.\n\
2883 The variables `special-display-buffer-names', `special-display-regexps',\n\
2884 `same-window-buffer-names', and `same-window-regexps' customize how certain\n\
2885 buffer names are handled.\n\
2887 If optional argument FRAME is `visible', search all visible frames.\n\
2888 If FRAME is 0, search all visible and iconified frames.\n\
2889 If FRAME is t, search all frames.\n\
2890 If FRAME is a frame, search only that frame.\n\
2891 If FRAME is nil, search only the selected frame\n\
2892 (actually the last nonminibuffer frame),\n\
2893 unless `pop-up-frames' or `display-buffer-reuse-frames' is non-nil,\n\
2894 which means search visible and iconified frames.\n\
2896 If `even-window-heights' is non-nil, window heights will be evened out\n\
2897 if displaying the buffer causes two vertically adjacent windows to be\n\
2898 displayed.")
2899 (buffer, not_this_window, frame)
2900 register Lisp_Object buffer, not_this_window, frame;
2902 register Lisp_Object window, tem, swp;
2903 struct frame *f;
2905 swp = Qnil;
2906 buffer = Fget_buffer (buffer);
2907 CHECK_BUFFER (buffer, 0);
2909 if (!NILP (Vdisplay_buffer_function))
2910 return call2 (Vdisplay_buffer_function, buffer, not_this_window);
2912 if (NILP (not_this_window)
2913 && XBUFFER (XWINDOW (selected_window)->buffer) == XBUFFER (buffer))
2914 return display_buffer_1 (selected_window);
2916 /* See if the user has specified this buffer should appear
2917 in the selected window. */
2918 if (NILP (not_this_window))
2920 swp = Fsame_window_p (XBUFFER (buffer)->name);
2921 if (!NILP (swp) && !no_switch_window (selected_window))
2923 Fswitch_to_buffer (buffer, Qnil);
2924 return display_buffer_1 (selected_window);
2928 /* If the user wants pop-up-frames or display-reuse-frames, then
2929 look for a window showing BUFFER on any visible or iconified frame.
2930 Otherwise search only the current frame. */
2931 if (! NILP (frame))
2932 tem = frame;
2933 else if (pop_up_frames
2934 || display_buffer_reuse_frames
2935 || last_nonminibuf_frame == 0)
2936 XSETFASTINT (tem, 0);
2937 else
2938 XSETFRAME (tem, last_nonminibuf_frame);
2940 window = Fget_buffer_window (buffer, tem);
2941 if (!NILP (window)
2942 && (NILP (not_this_window) || !EQ (window, selected_window)))
2943 return display_buffer_1 (window);
2945 /* Certain buffer names get special handling. */
2946 if (!NILP (Vspecial_display_function) && NILP (swp))
2948 tem = Fspecial_display_p (XBUFFER (buffer)->name);
2949 if (EQ (tem, Qt))
2950 return call1 (Vspecial_display_function, buffer);
2951 if (CONSP (tem))
2952 return call2 (Vspecial_display_function, buffer, tem);
2955 /* If there are no frames open that have more than a minibuffer,
2956 we need to create a new frame. */
2957 if (pop_up_frames || last_nonminibuf_frame == 0)
2959 window = Fframe_selected_window (call0 (Vpop_up_frame_function));
2960 Fset_window_buffer (window, buffer);
2961 return display_buffer_1 (window);
2964 f = SELECTED_FRAME ();
2965 if (pop_up_windows
2966 || FRAME_MINIBUF_ONLY_P (f)
2967 /* If the current frame is a special display frame,
2968 don't try to reuse its windows. */
2969 || !NILP (XWINDOW (FRAME_ROOT_WINDOW (f))->dedicated))
2971 Lisp_Object frames;
2973 frames = Qnil;
2974 if (FRAME_MINIBUF_ONLY_P (f))
2975 XSETFRAME (frames, last_nonminibuf_frame);
2976 /* Don't try to create a window if would get an error */
2977 if (split_height_threshold < window_min_height << 1)
2978 split_height_threshold = window_min_height << 1;
2980 /* Note that both Fget_largest_window and Fget_lru_window
2981 ignore minibuffers and dedicated windows.
2982 This means they can return nil. */
2984 /* If the frame we would try to split cannot be split,
2985 try other frames. */
2986 if (FRAME_NO_SPLIT_P (NILP (frames) ? f : last_nonminibuf_frame))
2988 /* Try visible frames first. */
2989 window = Fget_largest_window (Qvisible);
2990 /* If that didn't work, try iconified frames. */
2991 if (NILP (window))
2992 window = Fget_largest_window (make_number (0));
2993 if (NILP (window))
2994 window = Fget_largest_window (Qt);
2996 else
2997 window = Fget_largest_window (frames);
2999 /* If we got a tall enough full-width window that can be split,
3000 split it. */
3001 if (!NILP (window)
3002 && ! FRAME_NO_SPLIT_P (XFRAME (XWINDOW (window)->frame))
3003 && window_height (window) >= split_height_threshold
3004 && WINDOW_FULL_WIDTH_P (XWINDOW (window)))
3005 window = Fsplit_window (window, Qnil, Qnil);
3006 else
3008 Lisp_Object upper, lower, other;
3010 window = Fget_lru_window (frames);
3011 /* If the LRU window is selected, and big enough,
3012 and can be split, split it. */
3013 if (!NILP (window)
3014 && ! FRAME_NO_SPLIT_P (XFRAME (XWINDOW (window)->frame))
3015 && (EQ (window, selected_window)
3016 || EQ (XWINDOW (window)->parent, Qnil))
3017 && window_height (window) >= window_min_height << 1)
3018 window = Fsplit_window (window, Qnil, Qnil);
3019 /* If Fget_lru_window returned nil, try other approaches. */
3021 /* Try visible frames first. */
3022 if (NILP (window))
3023 window = Fget_buffer_window (buffer, Qvisible);
3024 if (NILP (window))
3025 window = Fget_largest_window (Qvisible);
3026 /* If that didn't work, try iconified frames. */
3027 if (NILP (window))
3028 window = Fget_buffer_window (buffer, make_number (0));
3029 if (NILP (window))
3030 window = Fget_largest_window (make_number (0));
3031 /* Try invisible frames. */
3032 if (NILP (window))
3033 window = Fget_buffer_window (buffer, Qt);
3034 if (NILP (window))
3035 window = Fget_largest_window (Qt);
3036 /* As a last resort, make a new frame. */
3037 if (NILP (window))
3038 window = Fframe_selected_window (call0 (Vpop_up_frame_function));
3039 /* If window appears above or below another,
3040 even out their heights. */
3041 other = upper = lower = Qnil;
3042 if (!NILP (XWINDOW (window)->prev))
3043 other = upper = XWINDOW (window)->prev, lower = window;
3044 if (!NILP (XWINDOW (window)->next))
3045 other = lower = XWINDOW (window)->next, upper = window;
3046 if (!NILP (other)
3047 && !NILP (Veven_window_heights)
3048 /* Check that OTHER and WINDOW are vertically arrayed. */
3049 && !EQ (XWINDOW (other)->top, XWINDOW (window)->top)
3050 && (XFASTINT (XWINDOW (other)->height)
3051 > XFASTINT (XWINDOW (window)->height)))
3053 int total = (XFASTINT (XWINDOW (other)->height)
3054 + XFASTINT (XWINDOW (window)->height));
3055 enlarge_window (upper,
3056 total / 2 - XFASTINT (XWINDOW (upper)->height),
3061 else
3062 window = Fget_lru_window (Qnil);
3064 Fset_window_buffer (window, buffer);
3065 return display_buffer_1 (window);
3068 void
3069 temp_output_buffer_show (buf)
3070 register Lisp_Object buf;
3072 register struct buffer *old = current_buffer;
3073 register Lisp_Object window;
3074 register struct window *w;
3076 XBUFFER (buf)->directory = current_buffer->directory;
3078 Fset_buffer (buf);
3079 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3080 BEGV = BEG;
3081 ZV = Z;
3082 SET_PT (BEG);
3083 XBUFFER (buf)->prevent_redisplay_optimizations_p = 1;
3084 set_buffer_internal (old);
3086 if (!EQ (Vtemp_buffer_show_function, Qnil))
3087 call1 (Vtemp_buffer_show_function, buf);
3088 else
3090 window = Fdisplay_buffer (buf, Qnil, Qnil);
3092 if (!EQ (XWINDOW (window)->frame, selected_frame))
3093 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3094 Vminibuf_scroll_window = window;
3095 w = XWINDOW (window);
3096 XSETFASTINT (w->hscroll, 0);
3097 XSETFASTINT (w->min_hscroll, 0);
3098 set_marker_restricted_both (w->start, buf, 1, 1);
3099 set_marker_restricted_both (w->pointm, buf, 1, 1);
3101 /* Run temp-buffer-show-hook, with the chosen window selected
3102 and it sbuffer current. */
3103 if (!NILP (Vrun_hooks))
3105 Lisp_Object tem;
3106 tem = Fboundp (Qtemp_buffer_show_hook);
3107 if (!NILP (tem))
3109 tem = Fsymbol_value (Qtemp_buffer_show_hook);
3110 if (!NILP (tem))
3112 int count = specpdl_ptr - specpdl;
3113 Lisp_Object prev_window;
3114 prev_window = selected_window;
3116 /* Select the window that was chosen, for running the hook. */
3117 record_unwind_protect (Fselect_window, prev_window);
3118 select_window_1 (window, 0);
3119 Fset_buffer (w->buffer);
3120 call1 (Vrun_hooks, Qtemp_buffer_show_hook);
3121 select_window_1 (prev_window, 0);
3122 unbind_to (count, Qnil);
3129 static void
3130 make_dummy_parent (window)
3131 Lisp_Object window;
3133 Lisp_Object new;
3134 register struct window *o, *p;
3135 register struct Lisp_Vector *vec;
3136 int i;
3138 o = XWINDOW (window);
3139 vec = allocate_vectorlike ((EMACS_INT)VECSIZE (struct window));
3140 for (i = 0; i < VECSIZE (struct window); ++i)
3141 vec->contents[i] = ((struct Lisp_Vector *)o)->contents[i];
3142 vec->size = VECSIZE (struct window);
3143 p = (struct window *)vec;
3144 XSETWINDOW (new, p);
3146 XSETFASTINT (p->sequence_number, ++sequence_number);
3148 /* Put new into window structure in place of window */
3149 replace_window (window, new);
3151 o->next = Qnil;
3152 o->prev = Qnil;
3153 o->vchild = Qnil;
3154 o->hchild = Qnil;
3155 o->parent = new;
3157 p->start = Qnil;
3158 p->pointm = Qnil;
3159 p->buffer = Qnil;
3162 DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "",
3163 "Split WINDOW, putting SIZE lines in the first of the pair.\n\
3164 WINDOW defaults to selected one and SIZE to half its size.\n\
3165 If optional third arg HORFLAG is non-nil, split side by side\n\
3166 and put SIZE columns in the first of the pair. In that case,\n\
3167 SIZE includes that window's scroll bar, or the divider column to its right.")
3168 (window, size, horflag)
3169 Lisp_Object window, size, horflag;
3171 register Lisp_Object new;
3172 register struct window *o, *p;
3173 FRAME_PTR fo;
3174 register int size_int;
3176 if (NILP (window))
3177 window = selected_window;
3178 else
3179 CHECK_LIVE_WINDOW (window, 0);
3181 o = XWINDOW (window);
3182 fo = XFRAME (WINDOW_FRAME (o));
3184 if (NILP (size))
3186 if (!NILP (horflag))
3187 /* Calculate the size of the left-hand window, by dividing
3188 the usable space in columns by two.
3189 We round up, since the left-hand window may include
3190 a dividing line, while the right-hand may not. */
3191 size_int = (XFASTINT (o->width) + 1) >> 1;
3192 else
3193 size_int = XFASTINT (o->height) >> 1;
3195 else
3197 CHECK_NUMBER (size, 1);
3198 size_int = XINT (size);
3201 if (MINI_WINDOW_P (o))
3202 error ("Attempt to split minibuffer window");
3203 else if (window_fixed_size_p (o, !NILP (horflag), 0))
3204 error ("Attempt to split fixed-size window");
3206 check_min_window_sizes ();
3208 if (NILP (horflag))
3210 if (size_int < window_min_height)
3211 error ("Window height %d too small (after splitting)", size_int);
3212 if (size_int + window_min_height > XFASTINT (o->height))
3213 error ("Window height %d too small (after splitting)",
3214 XFASTINT (o->height) - size_int);
3215 if (NILP (o->parent)
3216 || NILP (XWINDOW (o->parent)->vchild))
3218 make_dummy_parent (window);
3219 new = o->parent;
3220 XWINDOW (new)->vchild = window;
3223 else
3225 if (size_int < window_min_width)
3226 error ("Window width %d too small (after splitting)", size_int);
3228 if (size_int + window_min_width > XFASTINT (o->width))
3229 error ("Window width %d too small (after splitting)",
3230 XFASTINT (o->width) - size_int);
3231 if (NILP (o->parent)
3232 || NILP (XWINDOW (o->parent)->hchild))
3234 make_dummy_parent (window);
3235 new = o->parent;
3236 XWINDOW (new)->hchild = window;
3240 /* Now we know that window's parent is a vertical combination
3241 if we are dividing vertically, or a horizontal combination
3242 if we are making side-by-side windows */
3244 windows_or_buffers_changed++;
3245 FRAME_WINDOW_SIZES_CHANGED (fo) = 1;
3246 new = make_window ();
3247 p = XWINDOW (new);
3249 p->frame = o->frame;
3250 p->next = o->next;
3251 if (!NILP (p->next))
3252 XWINDOW (p->next)->prev = new;
3253 p->prev = window;
3254 o->next = new;
3255 p->parent = o->parent;
3256 p->buffer = Qt;
3257 p->window_end_valid = Qnil;
3258 bzero (&p->last_cursor, sizeof p->last_cursor);
3260 /* Apportion the available frame space among the two new windows */
3262 if (!NILP (horflag))
3264 p->height = o->height;
3265 p->top = o->top;
3266 XSETFASTINT (p->width, XFASTINT (o->width) - size_int);
3267 XSETFASTINT (o->width, size_int);
3268 XSETFASTINT (p->left, XFASTINT (o->left) + size_int);
3270 else
3272 p->left = o->left;
3273 p->width = o->width;
3274 XSETFASTINT (p->height, XFASTINT (o->height) - size_int);
3275 XSETFASTINT (o->height, size_int);
3276 XSETFASTINT (p->top, XFASTINT (o->top) + size_int);
3279 /* Adjust glyph matrices. */
3280 adjust_glyphs (fo);
3281 Fset_window_buffer (new, o->buffer);
3282 return new;
3285 DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 2, "p",
3286 "Make current window ARG lines bigger.\n\
3287 From program, optional second arg non-nil means grow sideways ARG columns.")
3288 (arg, side)
3289 register Lisp_Object arg, side;
3291 CHECK_NUMBER (arg, 0);
3292 enlarge_window (selected_window, XINT (arg), !NILP (side));
3294 if (! NILP (Vwindow_configuration_change_hook))
3295 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
3297 return Qnil;
3300 DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 2, "p",
3301 "Make current window ARG lines smaller.\n\
3302 From program, optional second arg non-nil means shrink sideways arg columns.")
3303 (arg, side)
3304 register Lisp_Object arg, side;
3306 CHECK_NUMBER (arg, 0);
3307 enlarge_window (selected_window, -XINT (arg), !NILP (side));
3309 if (! NILP (Vwindow_configuration_change_hook))
3310 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
3312 return Qnil;
3316 window_height (window)
3317 Lisp_Object window;
3319 register struct window *p = XWINDOW (window);
3320 return XFASTINT (p->height);
3324 window_width (window)
3325 Lisp_Object window;
3327 register struct window *p = XWINDOW (window);
3328 return XFASTINT (p->width);
3332 #define CURBEG(w) \
3333 *(widthflag ? &(XWINDOW (w)->left) : &(XWINDOW (w)->top))
3335 #define CURSIZE(w) \
3336 *(widthflag ? &(XWINDOW (w)->width) : &(XWINDOW (w)->height))
3339 /* Enlarge selected_window by DELTA. WIDTHFLAG non-zero means
3340 increase its width. Siblings of the selected window are resized to
3341 fullfil the size request. If they become too small in the process,
3342 they will be deleted. */
3344 static void
3345 enlarge_window (window, delta, widthflag)
3346 Lisp_Object window;
3347 int delta, widthflag;
3349 Lisp_Object parent, next, prev;
3350 struct window *p;
3351 Lisp_Object *sizep;
3352 int maximum;
3353 int (*sizefun) P_ ((Lisp_Object))
3354 = widthflag ? window_width : window_height;
3355 void (*setsizefun) P_ ((Lisp_Object, int, int))
3356 = (widthflag ? set_window_width : set_window_height);
3358 /* Check values of window_min_width and window_min_height for
3359 validity. */
3360 check_min_window_sizes ();
3362 /* Give up if this window cannot be resized. */
3363 if (window_fixed_size_p (XWINDOW (window), widthflag, 1))
3364 error ("Window is not resizable");
3366 /* Find the parent of the selected window. */
3367 while (1)
3369 p = XWINDOW (window);
3370 parent = p->parent;
3372 if (NILP (parent))
3374 if (widthflag)
3375 error ("No other window to side of this one");
3376 break;
3379 if (widthflag
3380 ? !NILP (XWINDOW (parent)->hchild)
3381 : !NILP (XWINDOW (parent)->vchild))
3382 break;
3384 window = parent;
3387 sizep = &CURSIZE (window);
3390 register int maxdelta;
3392 maxdelta = (!NILP (parent) ? (*sizefun) (parent) - XINT (*sizep)
3393 : !NILP (p->next) ? ((*sizefun) (p->next)
3394 - window_min_size (XWINDOW (p->next),
3395 widthflag, 0, 0))
3396 : !NILP (p->prev) ? ((*sizefun) (p->prev)
3397 - window_min_size (XWINDOW (p->prev),
3398 widthflag, 0, 0))
3399 /* This is a frame with only one window, a minibuffer-only
3400 or a minibufferless frame. */
3401 : (delta = 0));
3403 if (delta > maxdelta)
3404 /* This case traps trying to make the minibuffer
3405 the full frame, or make the only window aside from the
3406 minibuffer the full frame. */
3407 delta = maxdelta;
3410 if (XINT (*sizep) + delta < window_min_size (XWINDOW (window), widthflag, 0, 0))
3412 delete_window (window);
3413 return;
3416 if (delta == 0)
3417 return;
3419 /* Find the total we can get from other siblings. */
3420 maximum = 0;
3421 for (next = p->next; ! NILP (next); next = XWINDOW (next)->next)
3422 maximum += (*sizefun) (next) - window_min_size (XWINDOW (next),
3423 widthflag, 0, 0);
3424 for (prev = p->prev; ! NILP (prev); prev = XWINDOW (prev)->prev)
3425 maximum += (*sizefun) (prev) - window_min_size (XWINDOW (prev),
3426 widthflag, 0, 0);
3428 /* If we can get it all from them, do so. */
3429 if (delta <= maximum)
3431 Lisp_Object first_unaffected;
3432 Lisp_Object first_affected;
3433 int fixed_p;
3435 next = p->next;
3436 prev = p->prev;
3437 first_affected = window;
3438 /* Look at one sibling at a time,
3439 moving away from this window in both directions alternately,
3440 and take as much as we can get without deleting that sibling. */
3441 while (delta != 0 && (!NILP (next) || !NILP (prev)))
3443 if (! NILP (next))
3445 int this_one = ((*sizefun) (next)
3446 - window_min_size (XWINDOW (next),
3447 widthflag, 0, &fixed_p));
3448 if (!fixed_p)
3450 if (this_one > delta)
3451 this_one = delta;
3453 (*setsizefun) (next, (*sizefun) (next) - this_one, 0);
3454 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
3456 delta -= this_one;
3459 next = XWINDOW (next)->next;
3462 if (delta == 0)
3463 break;
3465 if (! NILP (prev))
3467 int this_one = ((*sizefun) (prev)
3468 - window_min_size (XWINDOW (prev),
3469 widthflag, 0, &fixed_p));
3470 if (!fixed_p)
3472 if (this_one > delta)
3473 this_one = delta;
3475 first_affected = prev;
3477 (*setsizefun) (prev, (*sizefun) (prev) - this_one, 0);
3478 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
3480 delta -= this_one;
3483 prev = XWINDOW (prev)->prev;
3487 xassert (delta == 0);
3489 /* Now recalculate the edge positions of all the windows affected,
3490 based on the new sizes. */
3491 first_unaffected = next;
3492 prev = first_affected;
3493 for (next = XWINDOW (prev)->next; ! EQ (next, first_unaffected);
3494 prev = next, next = XWINDOW (next)->next)
3496 XSETINT (CURBEG (next), XINT (CURBEG (prev)) + (*sizefun) (prev));
3497 /* This does not change size of NEXT,
3498 but it propagates the new top edge to its children */
3499 (*setsizefun) (next, (*sizefun) (next), 0);
3502 else
3504 register int delta1;
3505 register int opht = (*sizefun) (parent);
3507 /* If trying to grow this window to or beyond size of the parent,
3508 make delta1 so big that, on shrinking back down,
3509 all the siblings end up with less than one line and are deleted. */
3510 if (opht <= XINT (*sizep) + delta)
3511 delta1 = opht * opht * 2;
3512 else
3514 /* Otherwise, make delta1 just right so that if we add
3515 delta1 lines to this window and to the parent, and then
3516 shrink the parent back to its original size, the new
3517 proportional size of this window will increase by delta.
3519 The function size_window will compute the new height h'
3520 of the window from delta1 as:
3522 e = delta1/n
3523 x = delta1 - delta1/n * n for the 1st resizable child
3524 h' = h + e + x
3526 where n is the number of children that can be resized.
3527 We can ignore x by choosing a delta1 that is a multiple of
3528 n. We want the height of this window to come out as
3530 h' = h + delta
3532 So, delta1 must be
3534 h + e = h + delta
3535 delta1/n = delta
3536 delta1 = n * delta.
3538 The number of children n rquals the number of resizable
3539 children of this window + 1 because we know window itself
3540 is resizable (otherwise we would have signalled an error. */
3542 struct window *w = XWINDOW (window);
3543 Lisp_Object s;
3544 int n = 1;
3546 for (s = w->next; !NILP (s); s = XWINDOW (s)->next)
3547 if (!window_fixed_size_p (XWINDOW (s), widthflag, 0))
3548 ++n;
3549 for (s = w->prev; !NILP (s); s = XWINDOW (s)->prev)
3550 if (!window_fixed_size_p (XWINDOW (s), widthflag, 0))
3551 ++n;
3553 delta1 = n * delta;
3556 /* Add delta1 lines or columns to this window, and to the parent,
3557 keeping things consistent while not affecting siblings. */
3558 XSETINT (CURSIZE (parent), opht + delta1);
3559 (*setsizefun) (window, XINT (*sizep) + delta1, 0);
3561 /* Squeeze out delta1 lines or columns from our parent,
3562 shriking this window and siblings proportionately.
3563 This brings parent back to correct size.
3564 Delta1 was calculated so this makes this window the desired size,
3565 taking it all out of the siblings. */
3566 (*setsizefun) (parent, opht, 0);
3569 XSETFASTINT (p->last_modified, 0);
3570 XSETFASTINT (p->last_overlay_modified, 0);
3572 /* Adjust glyph matrices. */
3573 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
3576 #undef CURBEG
3577 #undef CURSIZE
3581 /***********************************************************************
3582 Resizing Mini-Windows
3583 ***********************************************************************/
3585 static void shrink_window_lowest_first P_ ((struct window *, int));
3587 enum save_restore_action
3589 CHECK_ORIG_SIZES,
3590 SAVE_ORIG_SIZES,
3591 RESTORE_ORIG_SIZES
3594 static int save_restore_orig_size P_ ((struct window *,
3595 enum save_restore_action));
3597 /* Shrink windows rooted in window W to HEIGHT. Take the space needed
3598 from lowest windows first. */
3600 static void
3601 shrink_window_lowest_first (w, height)
3602 struct window *w;
3603 int height;
3605 struct window *c;
3606 Lisp_Object child;
3607 int old_height;
3609 xassert (!MINI_WINDOW_P (w));
3611 /* Set redisplay hints. */
3612 XSETFASTINT (w->last_modified, 0);
3613 XSETFASTINT (w->last_overlay_modified, 0);
3614 windows_or_buffers_changed++;
3615 FRAME_WINDOW_SIZES_CHANGED (XFRAME (WINDOW_FRAME (w))) = 1;
3617 old_height = XFASTINT (w->height);
3618 XSETFASTINT (w->height, height);
3620 if (!NILP (w->hchild))
3622 for (child = w->hchild; !NILP (child); child = c->next)
3624 c = XWINDOW (child);
3625 c->top = w->top;
3626 shrink_window_lowest_first (c, height);
3629 else if (!NILP (w->vchild))
3631 Lisp_Object last_child;
3632 int delta = old_height - height;
3633 int last_top;
3635 last_child = Qnil;
3637 /* Find the last child. We are taking space from lowest windows
3638 first, so we iterate over children from the last child
3639 backwards. */
3640 for (child = w->vchild; !NILP (child); child = XWINDOW (child)->next)
3641 last_child = child;
3643 /* Assign new heights. We leave only MIN_SAFE_WINDOW_HEIGHT. */
3644 for (child = last_child; delta && !NILP (child); child = c->prev)
3646 int this_one;
3648 c = XWINDOW (child);
3649 this_one = XFASTINT (c->height) - MIN_SAFE_WINDOW_HEIGHT;
3651 if (this_one > delta)
3652 this_one = delta;
3654 shrink_window_lowest_first (c, XFASTINT (c->height) - this_one);
3655 delta -= this_one;
3658 /* Compute new positions. */
3659 last_top = XINT (w->top);
3660 for (child = w->vchild; !NILP (child); child = c->next)
3662 c = XWINDOW (child);
3663 c->top = make_number (last_top);
3664 shrink_window_lowest_first (c, XFASTINT (c->height));
3665 last_top += XFASTINT (c->height);
3671 /* Save, restore, or check positions and sizes in the window tree
3672 rooted at W. ACTION says what to do.
3674 If ACTION is CHECK_ORIG_SIZES, check if orig_top and orig_height
3675 members are valid for all windows in the window tree. Value is
3676 non-zero if they are valid.
3678 If ACTION is SAVE_ORIG_SIZES, save members top and height in
3679 orig_top and orig_height for all windows in the tree.
3681 If ACTION is RESTORE_ORIG_SIZES, restore top and height from
3682 values stored in orig_top and orig_height for all windows. */
3684 static int
3685 save_restore_orig_size (w, action)
3686 struct window *w;
3687 enum save_restore_action action;
3689 int success_p = 1;
3691 while (w)
3693 if (!NILP (w->hchild))
3695 if (!save_restore_orig_size (XWINDOW (w->hchild), action))
3696 success_p = 0;
3698 else if (!NILP (w->vchild))
3700 if (!save_restore_orig_size (XWINDOW (w->vchild), action))
3701 success_p = 0;
3704 switch (action)
3706 case CHECK_ORIG_SIZES:
3707 if (!INTEGERP (w->orig_top) || !INTEGERP (w->orig_height))
3708 return 0;
3709 break;
3711 case SAVE_ORIG_SIZES:
3712 w->orig_top = w->top;
3713 w->orig_height = w->height;
3714 XSETFASTINT (w->last_modified, 0);
3715 XSETFASTINT (w->last_overlay_modified, 0);
3716 break;
3718 case RESTORE_ORIG_SIZES:
3719 xassert (INTEGERP (w->orig_top) && INTEGERP (w->orig_height));
3720 w->top = w->orig_top;
3721 w->height = w->orig_height;
3722 w->orig_height = w->orig_top = Qnil;
3723 XSETFASTINT (w->last_modified, 0);
3724 XSETFASTINT (w->last_overlay_modified, 0);
3725 break;
3727 default:
3728 abort ();
3731 w = NILP (w->next) ? NULL : XWINDOW (w->next);
3734 return success_p;
3738 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we can
3739 without deleting other windows. */
3741 void
3742 grow_mini_window (w, delta)
3743 struct window *w;
3744 int delta;
3746 struct frame *f = XFRAME (w->frame);
3747 struct window *root;
3749 xassert (MINI_WINDOW_P (w));
3750 xassert (delta >= 0);
3752 /* Check values of window_min_width and window_min_height for
3753 validity. */
3754 check_min_window_sizes ();
3756 /* Compute how much we can enlarge the mini-window without deleting
3757 other windows. */
3758 root = XWINDOW (FRAME_ROOT_WINDOW (f));
3759 if (delta)
3761 int min_height = window_min_size (root, 0, 0, 0);
3762 if (XFASTINT (root->height) - delta < min_height)
3763 delta = XFASTINT (root->height) - min_height;
3766 if (delta)
3768 /* Save original window sizes and positions, if not already done. */
3769 if (!save_restore_orig_size (root, CHECK_ORIG_SIZES))
3770 save_restore_orig_size (root, SAVE_ORIG_SIZES);
3772 /* Shrink other windows. */
3773 shrink_window_lowest_first (root, XFASTINT (root->height) - delta);
3775 /* Grow the mini-window. */
3776 w->top = make_number (XFASTINT (root->top) + XFASTINT (root->height));
3777 w->height = make_number (XFASTINT (w->height) + delta);
3778 XSETFASTINT (w->last_modified, 0);
3779 XSETFASTINT (w->last_overlay_modified, 0);
3781 adjust_glyphs (f);
3786 /* Shrink mini-window W. If there is recorded info about window sizes
3787 before a call to grow_mini_window, restore recorded window sizes.
3788 Otherwise, if the mini-window is higher than 1 line, resize it to 1
3789 line. */
3791 void
3792 shrink_mini_window (w)
3793 struct window *w;
3795 struct frame *f = XFRAME (w->frame);
3796 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
3798 if (save_restore_orig_size (root, CHECK_ORIG_SIZES))
3800 save_restore_orig_size (root, RESTORE_ORIG_SIZES);
3801 adjust_glyphs (f);
3802 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3803 windows_or_buffers_changed = 1;
3805 else if (XFASTINT (w->height) > 1)
3807 /* Distribute the additional lines of the mini-window
3808 among the other windows. */
3809 Lisp_Object window;
3810 XSETWINDOW (window, w);
3811 enlarge_window (window, 1 - XFASTINT (w->height), 0);
3817 /* Mark window cursors off for all windows in the window tree rooted
3818 at W by setting their phys_cursor_on_p flag to zero. Called from
3819 xterm.c, e.g. when a frame is cleared and thereby all cursors on
3820 the frame are cleared. */
3822 void
3823 mark_window_cursors_off (w)
3824 struct window *w;
3826 while (w)
3828 if (!NILP (w->hchild))
3829 mark_window_cursors_off (XWINDOW (w->hchild));
3830 else if (!NILP (w->vchild))
3831 mark_window_cursors_off (XWINDOW (w->vchild));
3832 else
3833 w->phys_cursor_on_p = 0;
3835 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3840 /* Return number of lines of text (not counting mode line) in W. */
3843 window_internal_height (w)
3844 struct window *w;
3846 int ht = XFASTINT (w->height);
3848 if (MINI_WINDOW_P (w))
3849 return ht;
3851 if (!NILP (w->parent) || !NILP (w->vchild) || !NILP (w->hchild)
3852 || !NILP (w->next) || !NILP (w->prev)
3853 || FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (w))))
3854 return ht - 1;
3856 return ht;
3860 /* Return the number of columns in W.
3861 Don't count columns occupied by scroll bars or the vertical bar
3862 separating W from the sibling to its right. */
3865 window_internal_width (w)
3866 struct window *w;
3868 struct frame *f = XFRAME (WINDOW_FRAME (w));
3869 int width = XINT (w->width);
3871 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
3872 /* Scroll bars occupy a few columns. */
3873 width -= FRAME_SCROLL_BAR_COLS (f);
3874 else if (!WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
3875 /* The column of `|' characters separating side-by-side windows
3876 occupies one column only. */
3877 width -= 1;
3879 /* On window-systems, areas to the left and right of the window
3880 are used to display bitmaps there. */
3881 if (FRAME_WINDOW_P (f))
3882 width -= FRAME_FLAGS_AREA_COLS (f);
3884 return width;
3888 /************************************************************************
3889 Window Scrolling
3890 ***********************************************************************/
3892 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
3893 one screen-full, which is defined as the height of the window minus
3894 next_screen_context_lines. If WHOLE is zero, scroll up N lines
3895 instead. Negative values of N mean scroll down. NOERROR non-zero
3896 means don't signal an error if we try to move over BEGV or ZV,
3897 respectively. */
3899 static void
3900 window_scroll (window, n, whole, noerror)
3901 Lisp_Object window;
3902 int n;
3903 int whole;
3904 int noerror;
3906 /* If we must, use the pixel-based version which is much slower than
3907 the line-based one but can handle varying line heights. */
3908 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
3909 window_scroll_pixel_based (window, n, whole, noerror);
3910 else
3911 window_scroll_line_based (window, n, whole, noerror);
3915 /* Implementation of window_scroll that works based on pixel line
3916 heights. See the comment of window_scroll for parameter
3917 descriptions. */
3919 static void
3920 window_scroll_pixel_based (window, n, whole, noerror)
3921 Lisp_Object window;
3922 int n;
3923 int whole;
3924 int noerror;
3926 struct it it;
3927 struct window *w = XWINDOW (window);
3928 struct text_pos start;
3929 Lisp_Object tem;
3930 int this_scroll_margin;
3931 int preserve_y;
3932 /* True if we fiddled the window vscroll field without really scrolling. */
3933 int vscrolled = 0;
3935 SET_TEXT_POS_FROM_MARKER (start, w->start);
3937 /* If PT is not visible in WINDOW, move back one half of
3938 the screen. */
3939 tem = Fpos_visible_in_window_p (make_number (PT), window, Qnil);
3940 if (NILP (tem))
3942 /* Move backward half the height of the window. Performance note:
3943 vmotion used here is about 10% faster, but would give wrong
3944 results for variable height lines. */
3945 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
3946 it.current_y = it.last_visible_y;
3947 move_it_vertically (&it, -it.last_visible_y / 2);
3949 /* The function move_iterator_vertically may move over more than
3950 the specified y-distance. If it->w is small, e.g. a
3951 mini-buffer window, we may end up in front of the window's
3952 display area. This is the case when Start displaying at the
3953 start of the line containing PT in this case. */
3954 if (it.current_y <= 0)
3956 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
3957 move_it_vertically (&it, 0);
3958 it.current_y = 0;
3961 start = it.current.pos;
3964 /* If scroll_preserve_screen_position is non-zero, we try to set
3965 point in the same window line as it is now, so get that line. */
3966 if (!NILP (Vscroll_preserve_screen_position))
3968 start_display (&it, w, start);
3969 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
3970 preserve_y = it.current_y;
3972 else
3973 preserve_y = -1;
3975 /* Move iterator it from start the specified distance forward or
3976 backward. The result is the new window start. */
3977 start_display (&it, w, start);
3978 if (whole)
3980 int screen_full = (it.last_visible_y
3981 - next_screen_context_lines * CANON_Y_UNIT (it.f));
3982 int direction = n < 0 ? -1 : 1;
3983 int dy = direction * screen_full;
3985 /* Note that move_it_vertically always moves the iterator to the
3986 start of a line. So, if the last line doesn't have a newline,
3987 we would end up at the start of the line ending at ZV. */
3988 if (dy <= 0)
3989 move_it_vertically_backward (&it, -dy);
3990 else if (dy > 0)
3991 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
3992 MOVE_TO_POS | MOVE_TO_Y);
3994 else
3995 move_it_by_lines (&it, n, 1);
3997 /* End if we end up at ZV or BEGV. */
3998 if ((n > 0 && IT_CHARPOS (it) == ZV)
3999 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4001 if (IT_CHARPOS (it) == ZV)
4003 if (it.current_y + it.max_ascent + it.max_descent
4004 > it.last_visible_y)
4006 /* The last line was only partially visible, make it fully
4007 visible. */
4008 w->vscroll = (it.last_visible_y
4009 - it.current_y + it.max_ascent + it.max_descent);
4010 adjust_glyphs (it.f);
4012 else if (noerror)
4013 return;
4014 else
4015 Fsignal (Qend_of_buffer, Qnil);
4017 else
4019 if (w->vscroll != 0)
4020 /* The first line was only partially visible, make it fully
4021 visible. */
4022 w->vscroll = 0;
4023 else if (noerror)
4024 return;
4025 else
4026 Fsignal (Qbeginning_of_buffer, Qnil);
4029 /* If control gets here, then we vscrolled. */
4031 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4033 /* Don't try to change the window start below. */
4034 vscrolled = 1;
4037 if (! vscrolled)
4039 /* Set the window start, and set up the window for redisplay. */
4040 set_marker_restricted (w->start, make_number (IT_CHARPOS (it)),
4041 w->buffer);
4042 w->start_at_line_beg = Fbolp ();
4043 w->update_mode_line = Qt;
4044 XSETFASTINT (w->last_modified, 0);
4045 XSETFASTINT (w->last_overlay_modified, 0);
4046 /* Set force_start so that redisplay_window will run the
4047 window-scroll-functions. */
4048 w->force_start = Qt;
4051 it.current_y = it.vpos = 0;
4053 /* Preserve the screen position if we must. */
4054 if (preserve_y >= 0)
4056 move_it_to (&it, -1, -1, preserve_y, -1, MOVE_TO_Y);
4057 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4059 else
4061 /* Move PT out of scroll margins. */
4062 this_scroll_margin = max (0, scroll_margin);
4063 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->height) / 4);
4064 this_scroll_margin *= CANON_Y_UNIT (it.f);
4066 if (n > 0)
4068 /* We moved the window start towards ZV, so PT may be now
4069 in the scroll margin at the top. */
4070 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4071 while (it.current_y < this_scroll_margin)
4072 move_it_by_lines (&it, 1, 1);
4073 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4075 else if (n < 0)
4077 int charpos, bytepos;
4079 /* We moved the window start towards BEGV, so PT may be now
4080 in the scroll margin at the bottom. */
4081 move_it_to (&it, PT, -1,
4082 it.last_visible_y - this_scroll_margin - 1, -1,
4083 MOVE_TO_POS | MOVE_TO_Y);
4085 /* Save our position, in case it's correct. */
4086 charpos = IT_CHARPOS (it);
4087 bytepos = IT_BYTEPOS (it);
4089 /* See if point is on a partially visible line at the end. */
4090 move_it_by_lines (&it, 1, 1);
4091 if (it.current_y > it.last_visible_y)
4092 /* The last line was only partially visible, so back up two
4093 lines to make sure we're on a fully visible line. */
4095 move_it_by_lines (&it, -2, 0);
4096 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4098 else
4099 /* No, the position we saved is OK, so use it. */
4100 SET_PT_BOTH (charpos, bytepos);
4106 /* Implementation of window_scroll that works based on screen lines.
4107 See the comment of window_scroll for parameter descriptions. */
4109 static void
4110 window_scroll_line_based (window, n, whole, noerror)
4111 Lisp_Object window;
4112 int n;
4113 int whole;
4114 int noerror;
4116 register struct window *w = XWINDOW (window);
4117 register int opoint = PT, opoint_byte = PT_BYTE;
4118 register int pos, pos_byte;
4119 register int ht = window_internal_height (w);
4120 register Lisp_Object tem;
4121 int lose;
4122 Lisp_Object bolp;
4123 int startpos;
4124 struct position posit;
4125 int original_vpos;
4127 startpos = marker_position (w->start);
4129 posit = *compute_motion (startpos, 0, 0, 0,
4130 PT, ht, 0,
4131 window_internal_width (w), XINT (w->hscroll),
4132 0, w);
4133 original_vpos = posit.vpos;
4135 XSETFASTINT (tem, PT);
4136 tem = Fpos_visible_in_window_p (tem, window, Qnil);
4138 if (NILP (tem))
4140 Fvertical_motion (make_number (- (ht / 2)), window);
4141 startpos = PT;
4144 SET_PT (startpos);
4145 lose = n < 0 && PT == BEGV;
4146 Fvertical_motion (make_number (n), window);
4147 pos = PT;
4148 pos_byte = PT_BYTE;
4149 bolp = Fbolp ();
4150 SET_PT_BOTH (opoint, opoint_byte);
4152 if (lose)
4154 if (noerror)
4155 return;
4156 else
4157 Fsignal (Qbeginning_of_buffer, Qnil);
4160 if (pos < ZV)
4162 int this_scroll_margin = scroll_margin;
4164 /* Don't use a scroll margin that is negative or too large. */
4165 if (this_scroll_margin < 0)
4166 this_scroll_margin = 0;
4168 if (XINT (w->height) < 4 * scroll_margin)
4169 this_scroll_margin = XINT (w->height) / 4;
4171 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
4172 w->start_at_line_beg = bolp;
4173 w->update_mode_line = Qt;
4174 XSETFASTINT (w->last_modified, 0);
4175 XSETFASTINT (w->last_overlay_modified, 0);
4176 /* Set force_start so that redisplay_window will run
4177 the window-scroll-functions. */
4178 w->force_start = Qt;
4180 if (whole && !NILP (Vscroll_preserve_screen_position))
4182 SET_PT_BOTH (pos, pos_byte);
4183 Fvertical_motion (make_number (original_vpos), window);
4185 /* If we scrolled forward, put point enough lines down
4186 that it is outside the scroll margin. */
4187 else if (n > 0)
4189 int top_margin;
4191 if (this_scroll_margin > 0)
4193 SET_PT_BOTH (pos, pos_byte);
4194 Fvertical_motion (make_number (this_scroll_margin), window);
4195 top_margin = PT;
4197 else
4198 top_margin = pos;
4200 if (top_margin <= opoint)
4201 SET_PT_BOTH (opoint, opoint_byte);
4202 else if (!NILP (Vscroll_preserve_screen_position))
4204 SET_PT_BOTH (pos, pos_byte);
4205 Fvertical_motion (make_number (original_vpos), window);
4207 else
4208 SET_PT (top_margin);
4210 else if (n < 0)
4212 int bottom_margin;
4214 /* If we scrolled backward, put point near the end of the window
4215 but not within the scroll margin. */
4216 SET_PT_BOTH (pos, pos_byte);
4217 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
4218 if (XFASTINT (tem) == ht - this_scroll_margin)
4219 bottom_margin = PT;
4220 else
4221 bottom_margin = PT + 1;
4223 if (bottom_margin > opoint)
4224 SET_PT_BOTH (opoint, opoint_byte);
4225 else
4227 if (!NILP (Vscroll_preserve_screen_position))
4229 SET_PT_BOTH (pos, pos_byte);
4230 Fvertical_motion (make_number (original_vpos), window);
4232 else
4233 Fvertical_motion (make_number (-1), window);
4237 else
4239 if (noerror)
4240 return;
4241 else
4242 Fsignal (Qend_of_buffer, Qnil);
4247 /* Scroll selected_window up or down. If N is nil, scroll a
4248 screen-full which is defined as the height of the window minus
4249 next_screen_context_lines. If N is the symbol `-', scroll.
4250 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4251 up. This is the guts of Fscroll_up and Fscroll_down. */
4253 static void
4254 scroll_command (n, direction)
4255 Lisp_Object n;
4256 int direction;
4258 register int defalt;
4259 int count = specpdl_ptr - specpdl;
4261 xassert (abs (direction) == 1);
4263 /* If selected window's buffer isn't current, make it current for
4264 the moment. But don't screw up if window_scroll gets an error. */
4265 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
4267 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4268 Fset_buffer (XWINDOW (selected_window)->buffer);
4270 /* Make redisplay consider other windows than just selected_window. */
4271 ++windows_or_buffers_changed;
4274 defalt = (window_internal_height (XWINDOW (selected_window))
4275 - next_screen_context_lines);
4276 defalt = direction * (defalt < 1 ? 1 : defalt);
4278 if (NILP (n))
4279 window_scroll (selected_window, defalt, 1, 0);
4280 else if (EQ (n, Qminus))
4281 window_scroll (selected_window, - defalt, 1, 0);
4282 else
4284 n = Fprefix_numeric_value (n);
4285 window_scroll (selected_window, XINT (n) * direction, 0, 0);
4288 unbind_to (count, Qnil);
4291 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "P",
4292 "Scroll text of current window upward ARG lines; or near full screen if no ARG.\n\
4293 A near full screen is `next-screen-context-lines' less than a full screen.\n\
4294 Negative ARG means scroll downward.\n\
4295 If ARG is the atom `-', scroll downward by nearly full screen.\n\
4296 When calling from a program, supply as argument a number, nil, or `-'.")
4297 (arg)
4298 Lisp_Object arg;
4300 scroll_command (arg, 1);
4301 return Qnil;
4304 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "P",
4305 "Scroll text of current window down ARG lines; or near full screen if no ARG.\n\
4306 A near full screen is `next-screen-context-lines' less than a full screen.\n\
4307 Negative ARG means scroll upward.\n\
4308 If ARG is the atom `-', scroll upward by nearly full screen.\n\
4309 When calling from a program, supply as argument a number, nil, or `-'.")
4310 (arg)
4311 Lisp_Object arg;
4313 scroll_command (arg, -1);
4314 return Qnil;
4317 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
4318 "Return the other window for \"other window scroll\" commands.\n\
4319 If in the minibuffer, `minibuffer-scroll-window' if non-nil\n\
4320 specifies the window.\n\
4321 If `other-window-scroll-buffer' is non-nil, a window\n\
4322 showing that buffer is used.")
4325 Lisp_Object window;
4327 if (MINI_WINDOW_P (XWINDOW (selected_window))
4328 && !NILP (Vminibuf_scroll_window))
4329 window = Vminibuf_scroll_window;
4330 /* If buffer is specified, scroll that buffer. */
4331 else if (!NILP (Vother_window_scroll_buffer))
4333 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
4334 if (NILP (window))
4335 window = Fdisplay_buffer (Vother_window_scroll_buffer, Qt, Qnil);
4337 else
4339 /* Nothing specified; look for a neighboring window on the same
4340 frame. */
4341 window = Fnext_window (selected_window, Qnil, Qnil);
4343 if (EQ (window, selected_window))
4344 /* That didn't get us anywhere; look for a window on another
4345 visible frame. */
4347 window = Fnext_window (window, Qnil, Qt);
4348 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
4349 && ! EQ (window, selected_window));
4352 CHECK_LIVE_WINDOW (window, 0);
4354 if (EQ (window, selected_window))
4355 error ("There is no other window");
4357 return window;
4360 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
4361 "Scroll next window upward ARG lines; or near full screen if no ARG.\n\
4362 A near full screen is `next-screen-context-lines' less than a full screen.\n\
4363 The next window is the one below the current one; or the one at the top\n\
4364 if the current one is at the bottom. Negative ARG means scroll downward.\n\
4365 If ARG is the atom `-', scroll downward by nearly full screen.\n\
4366 When calling from a program, supply as argument a number, nil, or `-'.\n\
4368 If in the minibuffer, `minibuffer-scroll-window' if non-nil\n\
4369 specifies the window to scroll.\n\
4370 If `other-window-scroll-buffer' is non-nil, scroll the window\n\
4371 showing that buffer, popping the buffer up if necessary.")
4372 (arg)
4373 register Lisp_Object arg;
4375 register Lisp_Object window;
4376 register int defalt;
4377 register struct window *w;
4378 register int count = specpdl_ptr - specpdl;
4380 window = Fother_window_for_scrolling ();
4382 w = XWINDOW (window);
4383 defalt = window_internal_height (w) - next_screen_context_lines;
4384 if (defalt < 1) defalt = 1;
4386 /* Don't screw up if window_scroll gets an error. */
4387 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4388 ++windows_or_buffers_changed;
4390 Fset_buffer (w->buffer);
4391 SET_PT (marker_position (w->pointm));
4393 if (NILP (arg))
4394 window_scroll (window, defalt, 1, 1);
4395 else if (EQ (arg, Qminus))
4396 window_scroll (window, -defalt, 1, 1);
4397 else
4399 if (CONSP (arg))
4400 arg = Fcar (arg);
4401 CHECK_NUMBER (arg, 0);
4402 window_scroll (window, XINT (arg), 0, 1);
4405 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
4406 unbind_to (count, Qnil);
4408 return Qnil;
4411 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 1, "P",
4412 "Scroll selected window display ARG columns left.\n\
4413 Default for ARG is window width minus 2.")
4414 (arg)
4415 register Lisp_Object arg;
4417 Lisp_Object result;
4418 int hscroll;
4419 struct window *w = XWINDOW (selected_window);
4421 if (NILP (arg))
4422 XSETFASTINT (arg, window_internal_width (w) - 2);
4423 else
4424 arg = Fprefix_numeric_value (arg);
4426 hscroll = XINT (w->hscroll) + XINT (arg);
4427 result = Fset_window_hscroll (selected_window, make_number (hscroll));
4429 if (!NILP (Finteractive_p ()))
4430 w->min_hscroll = w->hscroll;
4432 return result;
4435 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 1, "P",
4436 "Scroll selected window display ARG columns right.\n\
4437 Default for ARG is window width minus 2.")
4438 (arg)
4439 register Lisp_Object arg;
4441 Lisp_Object result;
4442 int hscroll;
4443 struct window *w = XWINDOW (selected_window);
4445 if (NILP (arg))
4446 XSETFASTINT (arg, window_internal_width (w) - 2);
4447 else
4448 arg = Fprefix_numeric_value (arg);
4450 hscroll = XINT (w->hscroll) - XINT (arg);
4451 result = Fset_window_hscroll (selected_window, make_number (hscroll));
4453 if (!NILP (Finteractive_p ()))
4454 w->min_hscroll = w->hscroll;
4456 return result;
4459 /* Value is the number of lines actually displayed in window W,
4460 as opposed to its height. */
4462 static int
4463 displayed_window_lines (w)
4464 struct window *w;
4466 struct it it;
4467 struct text_pos start;
4468 int height = window_box_height (w);
4469 struct buffer *old_buffer;
4470 int bottom_y;
4472 if (XBUFFER (w->buffer) != current_buffer)
4474 old_buffer = current_buffer;
4475 set_buffer_internal (XBUFFER (w->buffer));
4477 else
4478 old_buffer = NULL;
4480 SET_TEXT_POS_FROM_MARKER (start, w->start);
4481 start_display (&it, w, start);
4482 move_it_vertically (&it, height);
4484 if (old_buffer)
4485 set_buffer_internal (old_buffer);
4487 bottom_y = it.current_y + it.max_ascent + it.max_descent;
4489 if (bottom_y > it.current_y && bottom_y <= it.last_visible_y)
4490 /* Hit a line without a terminating newline. */
4491 it.vpos++;
4493 /* Add in empty lines at the bottom of the window. */
4494 if (bottom_y < height)
4496 struct frame *f = XFRAME (w->frame);
4497 int rest = height - bottom_y;
4498 int lines = rest / CANON_Y_UNIT (f);
4499 it.vpos += lines;
4502 return it.vpos;
4506 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
4507 "Center point in window and redisplay frame.\n\
4508 With prefix argument ARG, recenter putting point on screen line ARG\n\
4509 relative to the current window. If ARG is negative, it counts up from the\n\
4510 bottom of the window. (ARG should be less than the height of the window.)\n\
4512 If ARG is omitted or nil, erase the entire frame and then\n\
4513 redraw with point in the center of the current window.\n\
4514 Just C-u as prefix means put point in the center of the window\n\
4515 and redisplay normally--don't erase and redraw the frame.")
4516 (arg)
4517 register Lisp_Object arg;
4519 struct window *w = XWINDOW (selected_window);
4520 struct buffer *buf = XBUFFER (w->buffer);
4521 struct buffer *obuf = current_buffer;
4522 int center_p = 0;
4523 int charpos, bytepos;
4525 if (NILP (arg))
4527 int i;
4529 /* Invalidate pixel data calculated for all compositions. */
4530 for (i = 0; i < n_compositions; i++)
4531 composition_table[i]->font = NULL;
4533 Fredraw_frame (w->frame);
4534 SET_FRAME_GARBAGED (XFRAME (WINDOW_FRAME (w)));
4535 center_p = 1;
4537 else if (CONSP (arg)) /* Just C-u. */
4538 center_p = 1;
4539 else
4541 arg = Fprefix_numeric_value (arg);
4542 CHECK_NUMBER (arg, 0);
4545 set_buffer_internal (buf);
4547 /* Handle centering on a gfaphical frame specially. Such frames can
4548 have variable-height lines and centering point on the basis of
4549 line counts would lead to strange effects. */
4550 if (center_p && FRAME_WINDOW_P (XFRAME (w->frame)))
4552 struct it it;
4553 struct text_pos pt;
4555 SET_TEXT_POS (pt, PT, PT_BYTE);
4556 start_display (&it, w, pt);
4557 move_it_vertically (&it, - it.last_visible_y / 2);
4558 charpos = IT_CHARPOS (it);
4559 bytepos = IT_BYTEPOS (it);
4561 else
4563 struct position pos;
4565 if (center_p)
4567 int ht = displayed_window_lines (w);
4568 arg = make_number (ht / 2);
4570 else if (XINT (arg) < 0)
4572 int ht = displayed_window_lines (w);
4573 XSETINT (arg, XINT (arg) + ht);
4576 pos = *vmotion (PT, - XINT (arg), w);
4577 charpos = pos.bufpos;
4578 bytepos = pos.bytepos;
4581 /* Set the new window start. */
4582 set_marker_both (w->start, w->buffer, charpos, bytepos);
4583 w->window_end_valid = Qnil;
4584 w->force_start = Qt;
4585 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
4586 w->start_at_line_beg = Qt;
4587 else
4588 w->start_at_line_beg = Qnil;
4590 set_buffer_internal (obuf);
4591 return Qnil;
4595 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
4596 0, 1, 0,
4597 "Return the height in lines of the text display area of WINDOW.\n\
4598 This doesn't include the mode-line (or header-line if any) or any\n\
4599 partial-height lines in the text display area.")
4600 (window)
4601 Lisp_Object window;
4603 struct window *w = decode_window (window);
4604 int pixel_height = window_box_height (w);
4605 int line_height = pixel_height / CANON_Y_UNIT (XFRAME (w->frame));
4606 return make_number (line_height);
4611 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
4612 1, 1, "P",
4613 "Position point relative to window.\n\
4614 With no argument, position point at center of window.\n\
4615 An argument specifies vertical position within the window;\n\
4616 zero means top of window, negative means relative to bottom of window.")
4617 (arg)
4618 Lisp_Object arg;
4620 struct window *w = XWINDOW (selected_window);
4621 int lines, start;
4622 Lisp_Object window;
4624 window = selected_window;
4625 start = marker_position (w->start);
4626 if (start < BEGV || start > ZV)
4628 int height = window_internal_height (w);
4629 Fvertical_motion (make_number (- (height / 2)), window);
4630 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
4631 w->start_at_line_beg = Fbolp ();
4632 w->force_start = Qt;
4634 else
4635 Fgoto_char (w->start);
4637 lines = displayed_window_lines (w);
4638 if (NILP (arg))
4639 XSETFASTINT (arg, lines / 2);
4640 else
4642 arg = Fprefix_numeric_value (arg);
4643 if (XINT (arg) < 0)
4644 XSETINT (arg, XINT (arg) + lines);
4647 if (w->vscroll)
4648 /* Skip past a partially visible first line. */
4649 XSETINT (arg, XINT (arg) + 1);
4651 return Fvertical_motion (arg, window);
4656 /***********************************************************************
4657 Window Configuration
4658 ***********************************************************************/
4660 struct save_window_data
4662 EMACS_INT size_from_Lisp_Vector_struct;
4663 struct Lisp_Vector *next_from_Lisp_Vector_struct;
4664 Lisp_Object frame_width, frame_height, frame_menu_bar_lines;
4665 Lisp_Object frame_tool_bar_lines;
4666 Lisp_Object selected_frame;
4667 Lisp_Object current_window;
4668 Lisp_Object current_buffer;
4669 Lisp_Object minibuf_scroll_window;
4670 Lisp_Object root_window;
4671 Lisp_Object focus_frame;
4672 /* Record the values of window-min-width and window-min-height
4673 so that window sizes remain consistent with them. */
4674 Lisp_Object min_width, min_height;
4675 /* A vector, each of whose elements is a struct saved_window
4676 for one window. */
4677 Lisp_Object saved_windows;
4680 /* This is saved as a Lisp_Vector */
4681 struct saved_window
4683 /* these first two must agree with struct Lisp_Vector in lisp.h */
4684 EMACS_INT size_from_Lisp_Vector_struct;
4685 struct Lisp_Vector *next_from_Lisp_Vector_struct;
4687 Lisp_Object window;
4688 Lisp_Object buffer, start, pointm, mark;
4689 Lisp_Object left, top, width, height, hscroll, min_hscroll;
4690 Lisp_Object parent, prev;
4691 Lisp_Object start_at_line_beg;
4692 Lisp_Object display_table;
4693 Lisp_Object orig_top, orig_height;
4696 #define SAVED_WINDOW_VECTOR_SIZE 17 /* Arg to Fmake_vector */
4698 #define SAVED_WINDOW_N(swv,n) \
4699 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
4701 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
4702 "Return t if OBJECT is a window-configuration object.")
4703 (object)
4704 Lisp_Object object;
4706 if (WINDOW_CONFIGURATIONP (object))
4707 return Qt;
4708 return Qnil;
4711 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
4712 "Return the frame that CONFIG, a window-configuration object, is about.")
4713 (config)
4714 Lisp_Object config;
4716 register struct save_window_data *data;
4717 struct Lisp_Vector *saved_windows;
4719 if (! WINDOW_CONFIGURATIONP (config))
4720 wrong_type_argument (Qwindow_configuration_p, config);
4722 data = (struct save_window_data *) XVECTOR (config);
4723 saved_windows = XVECTOR (data->saved_windows);
4724 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
4727 DEFUN ("set-window-configuration", Fset_window_configuration,
4728 Sset_window_configuration, 1, 1, 0,
4729 "Set the configuration of windows and buffers as specified by CONFIGURATION.\n\
4730 CONFIGURATION must be a value previously returned\n\
4731 by `current-window-configuration' (which see).\n\
4732 If CONFIGURATION was made from a frame that is now deleted,\n\
4733 only frame-independent values can be restored. In this case,\n\
4734 the return value is nil. Otherwise the value is t.")
4735 (configuration)
4736 Lisp_Object configuration;
4738 register struct save_window_data *data;
4739 struct Lisp_Vector *saved_windows;
4740 Lisp_Object new_current_buffer;
4741 Lisp_Object frame;
4742 FRAME_PTR f;
4743 int old_point = -1;
4745 while (!WINDOW_CONFIGURATIONP (configuration))
4746 wrong_type_argument (Qwindow_configuration_p, configuration);
4748 data = (struct save_window_data *) XVECTOR (configuration);
4749 saved_windows = XVECTOR (data->saved_windows);
4751 new_current_buffer = data->current_buffer;
4752 if (NILP (XBUFFER (new_current_buffer)->name))
4753 new_current_buffer = Qnil;
4754 else
4756 if (XBUFFER (new_current_buffer) == current_buffer)
4757 old_point = PT;
4760 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
4761 f = XFRAME (frame);
4763 /* If f is a dead frame, don't bother rebuilding its window tree.
4764 However, there is other stuff we should still try to do below. */
4765 if (FRAME_LIVE_P (f))
4767 register struct window *w;
4768 register struct saved_window *p;
4769 struct window *root_window;
4770 struct window **leaf_windows;
4771 int n_leaf_windows;
4772 int k, i, n;
4774 /* If the frame has been resized since this window configuration was
4775 made, we change the frame to the size specified in the
4776 configuration, restore the configuration, and then resize it
4777 back. We keep track of the prevailing height in these variables. */
4778 int previous_frame_height = FRAME_HEIGHT (f);
4779 int previous_frame_width = FRAME_WIDTH (f);
4780 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
4781 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
4783 /* The mouse highlighting code could get screwed up
4784 if it runs during this. */
4785 BLOCK_INPUT;
4787 if (XFASTINT (data->frame_height) != previous_frame_height
4788 || XFASTINT (data->frame_width) != previous_frame_width)
4789 change_frame_size (f, XFASTINT (data->frame_height),
4790 XFASTINT (data->frame_width), 0, 0, 0);
4791 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
4792 if (XFASTINT (data->frame_menu_bar_lines)
4793 != previous_frame_menu_bar_lines)
4794 x_set_menu_bar_lines (f, data->frame_menu_bar_lines, make_number (0));
4795 #ifdef HAVE_WINDOW_SYSTEM
4796 if (XFASTINT (data->frame_tool_bar_lines)
4797 != previous_frame_tool_bar_lines)
4798 x_set_tool_bar_lines (f, data->frame_tool_bar_lines, make_number (0));
4799 #endif
4800 #endif
4802 /* "Swap out" point from the selected window
4803 into its buffer. We do this now, before
4804 restoring the window contents, and prevent it from
4805 being done later on when we select a new window. */
4806 if (! NILP (XWINDOW (selected_window)->buffer))
4808 w = XWINDOW (selected_window);
4809 set_marker_both (w->pointm,
4810 w->buffer,
4811 BUF_PT (XBUFFER (w->buffer)),
4812 BUF_PT_BYTE (XBUFFER (w->buffer)));
4815 windows_or_buffers_changed++;
4816 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4818 /* Problem: Freeing all matrices and later allocating them again
4819 is a serious redisplay flickering problem. What we would
4820 really like to do is to free only those matrices not reused
4821 below. */
4822 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
4823 leaf_windows
4824 = (struct window **) alloca (count_windows (root_window)
4825 * sizeof (struct window *));
4826 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
4828 /* Temporarily avoid any problems with windows that are smaller
4829 than they are supposed to be. */
4830 window_min_height = 1;
4831 window_min_width = 1;
4833 /* Kludge Alert!
4834 Mark all windows now on frame as "deleted".
4835 Restoring the new configuration "undeletes" any that are in it.
4837 Save their current buffers in their height fields, since we may
4838 need it later, if a buffer saved in the configuration is now
4839 dead. */
4840 delete_all_subwindows (XWINDOW (FRAME_ROOT_WINDOW (f)));
4842 for (k = 0; k < saved_windows->size; k++)
4844 p = SAVED_WINDOW_N (saved_windows, k);
4845 w = XWINDOW (p->window);
4846 w->next = Qnil;
4848 if (!NILP (p->parent))
4849 w->parent = SAVED_WINDOW_N (saved_windows,
4850 XFASTINT (p->parent))->window;
4851 else
4852 w->parent = Qnil;
4854 if (!NILP (p->prev))
4856 w->prev = SAVED_WINDOW_N (saved_windows,
4857 XFASTINT (p->prev))->window;
4858 XWINDOW (w->prev)->next = p->window;
4860 else
4862 w->prev = Qnil;
4863 if (!NILP (w->parent))
4865 if (EQ (p->width, XWINDOW (w->parent)->width))
4867 XWINDOW (w->parent)->vchild = p->window;
4868 XWINDOW (w->parent)->hchild = Qnil;
4870 else
4872 XWINDOW (w->parent)->hchild = p->window;
4873 XWINDOW (w->parent)->vchild = Qnil;
4878 /* If we squirreled away the buffer in the window's height,
4879 restore it now. */
4880 if (BUFFERP (w->height))
4881 w->buffer = w->height;
4882 w->left = p->left;
4883 w->top = p->top;
4884 w->width = p->width;
4885 w->height = p->height;
4886 w->hscroll = p->hscroll;
4887 w->min_hscroll = p->min_hscroll;
4888 w->display_table = p->display_table;
4889 w->orig_top = p->orig_top;
4890 w->orig_height = p->orig_height;
4891 XSETFASTINT (w->last_modified, 0);
4892 XSETFASTINT (w->last_overlay_modified, 0);
4894 /* Reinstall the saved buffer and pointers into it. */
4895 if (NILP (p->buffer))
4896 w->buffer = p->buffer;
4897 else
4899 if (!NILP (XBUFFER (p->buffer)->name))
4900 /* If saved buffer is alive, install it. */
4902 w->buffer = p->buffer;
4903 w->start_at_line_beg = p->start_at_line_beg;
4904 set_marker_restricted (w->start, p->start, w->buffer);
4905 set_marker_restricted (w->pointm, p->pointm, w->buffer);
4906 Fset_marker (XBUFFER (w->buffer)->mark,
4907 p->mark, w->buffer);
4909 /* As documented in Fcurrent_window_configuration, don't
4910 save the location of point in the buffer which was current
4911 when the window configuration was recorded. */
4912 if (!EQ (p->buffer, new_current_buffer)
4913 && XBUFFER (p->buffer) == current_buffer)
4914 Fgoto_char (w->pointm);
4916 else if (NILP (w->buffer) || NILP (XBUFFER (w->buffer)->name))
4917 /* Else unless window has a live buffer, get one. */
4919 w->buffer = Fcdr (Fcar (Vbuffer_alist));
4920 /* This will set the markers to beginning of visible
4921 range. */
4922 set_marker_restricted (w->start, make_number (0), w->buffer);
4923 set_marker_restricted (w->pointm, make_number (0),w->buffer);
4924 w->start_at_line_beg = Qt;
4926 else
4927 /* Keeping window's old buffer; make sure the markers
4928 are real. */
4930 /* Set window markers at start of visible range. */
4931 if (XMARKER (w->start)->buffer == 0)
4932 set_marker_restricted (w->start, make_number (0),
4933 w->buffer);
4934 if (XMARKER (w->pointm)->buffer == 0)
4935 set_marker_restricted_both (w->pointm, w->buffer,
4936 BUF_PT (XBUFFER (w->buffer)),
4937 BUF_PT_BYTE (XBUFFER (w->buffer)));
4938 w->start_at_line_beg = Qt;
4943 FRAME_ROOT_WINDOW (f) = data->root_window;
4944 /* Prevent "swapping out point" in the old selected window
4945 using the buffer that has been restored into it.
4946 That swapping out has already been done,
4947 near the beginning of this function. */
4948 selected_window = Qnil;
4949 Fselect_window (data->current_window);
4950 XBUFFER (XWINDOW (selected_window)->buffer)->last_selected_window
4951 = selected_window;
4953 if (NILP (data->focus_frame)
4954 || (FRAMEP (data->focus_frame)
4955 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
4956 Fredirect_frame_focus (frame, data->focus_frame);
4958 #if 0 /* I don't understand why this is needed, and it causes problems
4959 when the frame's old selected window has been deleted. */
4960 if (f != selected_frame && FRAME_WINDOW_P (f))
4961 do_switch_frame (WINDOW_FRAME (XWINDOW (data->root_window)),
4962 Qnil, 0);
4963 #endif
4965 /* Set the screen height to the value it had before this function. */
4966 if (previous_frame_height != FRAME_HEIGHT (f)
4967 || previous_frame_width != FRAME_WIDTH (f))
4968 change_frame_size (f, previous_frame_height, previous_frame_width,
4969 0, 0, 0);
4970 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
4971 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
4972 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
4973 make_number (0));
4974 #ifdef HAVE_WINDOW_SYSTEM
4975 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
4976 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
4977 make_number (0));
4978 #endif
4979 #endif
4981 /* Now, free glyph matrices in windows that were not reused. */
4982 for (i = n = 0; i < n_leaf_windows; ++i)
4984 if (NILP (leaf_windows[i]->buffer))
4986 /* Assert it's not reused as a combination. */
4987 xassert (NILP (leaf_windows[i]->hchild)
4988 && NILP (leaf_windows[i]->vchild));
4989 free_window_matrices (leaf_windows[i]);
4991 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
4992 ++n;
4995 /* If more than one window shows the new and old current buffer,
4996 don't try to preserve point in that buffer. */
4997 if (old_point > 0 && n > 1)
4998 old_point = -1;
5000 adjust_glyphs (f);
5002 UNBLOCK_INPUT;
5004 /* Fselect_window will have made f the selected frame, so we
5005 reselect the proper frame here. Fhandle_switch_frame will change the
5006 selected window too, but that doesn't make the call to
5007 Fselect_window above totally superfluous; it still sets f's
5008 selected window. */
5009 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
5010 do_switch_frame (data->selected_frame, Qnil, 0);
5012 if (! NILP (Vwindow_configuration_change_hook)
5013 && ! NILP (Vrun_hooks))
5014 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
5017 if (!NILP (new_current_buffer))
5019 Fset_buffer (new_current_buffer);
5021 /* If the buffer that is current now is the same
5022 that was current before setting the window configuration,
5023 don't alter its PT. */
5024 if (old_point >= 0)
5025 SET_PT (old_point);
5028 /* Restore the minimum heights recorded in the configuration. */
5029 window_min_height = XINT (data->min_height);
5030 window_min_width = XINT (data->min_width);
5032 Vminibuf_scroll_window = data->minibuf_scroll_window;
5034 return (FRAME_LIVE_P (f) ? Qt : Qnil);
5037 /* Mark all windows now on frame as deleted
5038 by setting their buffers to nil. */
5040 void
5041 delete_all_subwindows (w)
5042 register struct window *w;
5044 if (!NILP (w->next))
5045 delete_all_subwindows (XWINDOW (w->next));
5046 if (!NILP (w->vchild))
5047 delete_all_subwindows (XWINDOW (w->vchild));
5048 if (!NILP (w->hchild))
5049 delete_all_subwindows (XWINDOW (w->hchild));
5051 w->height = w->buffer; /* See Fset_window_configuration for excuse. */
5053 if (!NILP (w->buffer))
5054 unshow_buffer (w);
5056 /* We set all three of these fields to nil, to make sure that we can
5057 distinguish this dead window from any live window. Live leaf
5058 windows will have buffer set, and combination windows will have
5059 vchild or hchild set. */
5060 w->buffer = Qnil;
5061 w->vchild = Qnil;
5062 w->hchild = Qnil;
5064 Vwindow_list = Qnil;
5067 static int
5068 count_windows (window)
5069 register struct window *window;
5071 register int count = 1;
5072 if (!NILP (window->next))
5073 count += count_windows (XWINDOW (window->next));
5074 if (!NILP (window->vchild))
5075 count += count_windows (XWINDOW (window->vchild));
5076 if (!NILP (window->hchild))
5077 count += count_windows (XWINDOW (window->hchild));
5078 return count;
5082 /* Fill vector FLAT with leaf windows under W, starting at index I.
5083 Value is last index + 1. */
5085 static int
5086 get_leaf_windows (w, flat, i)
5087 struct window *w;
5088 struct window **flat;
5089 int i;
5091 while (w)
5093 if (!NILP (w->hchild))
5094 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
5095 else if (!NILP (w->vchild))
5096 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
5097 else
5098 flat[i++] = w;
5100 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5103 return i;
5107 /* Return a pointer to the glyph W's physical cursor is on. Value is
5108 null if W's current matrix is invalid, so that no meaningfull glyph
5109 can be returned. */
5111 struct glyph *
5112 get_phys_cursor_glyph (w)
5113 struct window *w;
5115 struct glyph_row *row;
5116 struct glyph *glyph;
5118 if (w->phys_cursor.vpos >= 0
5119 && w->phys_cursor.vpos < w->current_matrix->nrows
5120 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
5121 row->enabled_p)
5122 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
5123 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
5124 else
5125 glyph = NULL;
5127 return glyph;
5131 static int
5132 save_window_save (window, vector, i)
5133 Lisp_Object window;
5134 struct Lisp_Vector *vector;
5135 int i;
5137 register struct saved_window *p;
5138 register struct window *w;
5139 register Lisp_Object tem;
5141 for (;!NILP (window); window = w->next)
5143 p = SAVED_WINDOW_N (vector, i);
5144 w = XWINDOW (window);
5146 XSETFASTINT (w->temslot, i++);
5147 p->window = window;
5148 p->buffer = w->buffer;
5149 p->left = w->left;
5150 p->top = w->top;
5151 p->width = w->width;
5152 p->height = w->height;
5153 p->hscroll = w->hscroll;
5154 p->min_hscroll = w->min_hscroll;
5155 p->display_table = w->display_table;
5156 p->orig_top = w->orig_top;
5157 p->orig_height = w->orig_height;
5158 if (!NILP (w->buffer))
5160 /* Save w's value of point in the window configuration.
5161 If w is the selected window, then get the value of point
5162 from the buffer; pointm is garbage in the selected window. */
5163 if (EQ (window, selected_window))
5165 p->pointm = Fmake_marker ();
5166 set_marker_both (p->pointm, w->buffer,
5167 BUF_PT (XBUFFER (w->buffer)),
5168 BUF_PT_BYTE (XBUFFER (w->buffer)));
5170 else
5171 p->pointm = Fcopy_marker (w->pointm, Qnil);
5173 p->start = Fcopy_marker (w->start, Qnil);
5174 p->start_at_line_beg = w->start_at_line_beg;
5176 tem = XBUFFER (w->buffer)->mark;
5177 p->mark = Fcopy_marker (tem, Qnil);
5179 else
5181 p->pointm = Qnil;
5182 p->start = Qnil;
5183 p->mark = Qnil;
5184 p->start_at_line_beg = Qnil;
5187 if (NILP (w->parent))
5188 p->parent = Qnil;
5189 else
5190 p->parent = XWINDOW (w->parent)->temslot;
5192 if (NILP (w->prev))
5193 p->prev = Qnil;
5194 else
5195 p->prev = XWINDOW (w->prev)->temslot;
5197 if (!NILP (w->vchild))
5198 i = save_window_save (w->vchild, vector, i);
5199 if (!NILP (w->hchild))
5200 i = save_window_save (w->hchild, vector, i);
5203 return i;
5206 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
5207 Scurrent_window_configuration, 0, 1, 0,
5208 "Return an object representing the current window configuration of FRAME.\n\
5209 If FRAME is nil or omitted, use the selected frame.\n\
5210 This describes the number of windows, their sizes and current buffers,\n\
5211 and for each displayed buffer, where display starts, and the positions of\n\
5212 point and mark. An exception is made for point in the current buffer:\n\
5213 its value is -not- saved.\n\
5214 This also records the currently selected frame, and FRAME's focus\n\
5215 redirection (see `redirect-frame-focus').")
5216 (frame)
5217 Lisp_Object frame;
5219 register Lisp_Object tem;
5220 register int n_windows;
5221 register struct save_window_data *data;
5222 register struct Lisp_Vector *vec;
5223 register int i;
5224 FRAME_PTR f;
5226 if (NILP (frame))
5227 frame = selected_frame;
5228 CHECK_LIVE_FRAME (frame, 0);
5229 f = XFRAME (frame);
5231 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
5232 vec = allocate_vectorlike (VECSIZE (struct save_window_data));
5233 for (i = 0; i < VECSIZE (struct save_window_data); i++)
5234 vec->contents[i] = Qnil;
5235 vec->size = VECSIZE (struct save_window_data);
5236 data = (struct save_window_data *)vec;
5238 XSETFASTINT (data->frame_width, FRAME_WIDTH (f));
5239 XSETFASTINT (data->frame_height, FRAME_HEIGHT (f));
5240 XSETFASTINT (data->frame_menu_bar_lines, FRAME_MENU_BAR_LINES (f));
5241 XSETFASTINT (data->frame_tool_bar_lines, FRAME_TOOL_BAR_LINES (f));
5242 data->selected_frame = selected_frame;
5243 data->current_window = FRAME_SELECTED_WINDOW (f);
5244 XSETBUFFER (data->current_buffer, current_buffer);
5245 data->minibuf_scroll_window = Vminibuf_scroll_window;
5246 data->root_window = FRAME_ROOT_WINDOW (f);
5247 data->focus_frame = FRAME_FOCUS_FRAME (f);
5248 XSETINT (data->min_height, window_min_height);
5249 XSETINT (data->min_width, window_min_width);
5250 tem = Fmake_vector (make_number (n_windows), Qnil);
5251 data->saved_windows = tem;
5252 for (i = 0; i < n_windows; i++)
5253 XVECTOR (tem)->contents[i]
5254 = Fmake_vector (make_number (SAVED_WINDOW_VECTOR_SIZE), Qnil);
5255 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
5256 XSETWINDOW_CONFIGURATION (tem, data);
5257 return (tem);
5260 DEFUN ("save-window-excursion", Fsave_window_excursion, Ssave_window_excursion,
5261 0, UNEVALLED, 0,
5262 "Execute body, preserving window sizes and contents.\n\
5263 Restore which buffer appears in which window, where display starts,\n\
5264 and the value of point and mark for each window.\n\
5265 Also restore the choice of selected window.\n\
5266 Also restore which buffer is current.\n\
5267 Does not restore the value of point in current buffer.")
5268 (args)
5269 Lisp_Object args;
5271 register Lisp_Object val;
5272 register int count = specpdl_ptr - specpdl;
5274 record_unwind_protect (Fset_window_configuration,
5275 Fcurrent_window_configuration (Qnil));
5276 val = Fprogn (args);
5277 return unbind_to (count, val);
5281 /***********************************************************************
5282 Marginal Areas
5283 ***********************************************************************/
5285 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
5286 2, 3, 0,
5287 "Set width of marginal areas of window WINDOW.\n\
5288 If window is nil, set margins of the currently selected window.\n\
5289 First parameter LEFT-WIDTH specifies the number of character\n\
5290 cells to reserve for the left marginal area. Second parameter\n\
5291 RIGHT-WIDTH does the same for the right marginal area.\n\
5292 A nil width parameter means no margin.")
5293 (window, left, right)
5294 Lisp_Object window, left, right;
5296 struct window *w = decode_window (window);
5298 if (!NILP (left))
5299 CHECK_NUMBER_OR_FLOAT (left, 1);
5300 if (!NILP (right))
5301 CHECK_NUMBER_OR_FLOAT (right, 2);
5303 /* Check widths < 0 and translate a zero width to nil.
5304 Margins that are too wide have to be checked elsewhere. */
5305 if ((INTEGERP (left) && XINT (left) < 0)
5306 || (FLOATP (left) && XFLOAT_DATA (left) <= 0))
5307 XSETFASTINT (left, 0);
5308 if (INTEGERP (left) && XFASTINT (left) == 0)
5309 left = Qnil;
5311 if ((INTEGERP (right) && XINT (right) < 0)
5312 || (FLOATP (right) && XFLOAT_DATA (right) <= 0))
5313 XSETFASTINT (right, 0);
5314 if (INTEGERP (right) && XFASTINT (right) == 0)
5315 right = Qnil;
5317 w->left_margin_width = left;
5318 w->right_margin_width = right;
5320 ++windows_or_buffers_changed;
5321 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
5322 return Qnil;
5326 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
5327 0, 1, 0,
5328 "Get width of marginal areas of window WINDOW.\n\
5329 If WINDOW is omitted or nil, use the currently selected window.\n\
5330 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).\n\
5331 If a marginal area does not exist, its width will be returned\n\
5332 as nil.")
5333 (window)
5334 Lisp_Object window;
5336 struct window *w = decode_window (window);
5337 return Fcons (w->left_margin_width, w->right_margin_width);
5342 /***********************************************************************
5343 Smooth scrolling
5344 ***********************************************************************/
5346 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 1, 0,
5347 "Return the amount by which WINDOW is scrolled vertically.\n\
5348 Use the selected window if WINDOW is nil or omitted.\n\
5349 Value is a multiple of the canonical character height of WINDOW.")
5350 (window)
5351 Lisp_Object window;
5353 Lisp_Object result;
5354 struct frame *f;
5355 struct window *w;
5357 if (NILP (window))
5358 window = selected_window;
5359 else
5360 CHECK_WINDOW (window, 0);
5361 w = XWINDOW (window);
5362 f = XFRAME (w->frame);
5364 if (FRAME_WINDOW_P (f))
5365 result = CANON_Y_FROM_PIXEL_Y (f, -w->vscroll);
5366 else
5367 result = make_number (0);
5368 return result;
5372 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
5373 2, 2, 0,
5374 "Set amount by which WINDOW should be scrolled vertically to VSCROLL.\n\
5375 WINDOW nil or omitted means use the selected window. VSCROLL is a\n\
5376 non-negative multiple of the canonical character height of WINDOW.")
5377 (window, vscroll)
5378 Lisp_Object window, vscroll;
5380 struct window *w;
5381 struct frame *f;
5383 if (NILP (window))
5384 window = selected_window;
5385 else
5386 CHECK_WINDOW (window, 0);
5387 CHECK_NUMBER_OR_FLOAT (vscroll, 1);
5389 w = XWINDOW (window);
5390 f = XFRAME (w->frame);
5392 if (FRAME_WINDOW_P (f))
5394 int old_dy = w->vscroll;
5396 w->vscroll = - CANON_Y_UNIT (f) * XFLOATINT (vscroll);
5397 w->vscroll = min (w->vscroll, 0);
5399 /* Adjust glyph matrix of the frame if the virtual display
5400 area becomes larger than before. */
5401 if (w->vscroll < 0 && w->vscroll < old_dy)
5402 adjust_glyphs (f);
5404 /* Prevent redisplay shortcuts. */
5405 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
5408 return Fwindow_vscroll (window);
5412 /* Call FN for all leaf windows on frame F. FN is called with the
5413 first argument being a pointer to the leaf window, and with
5414 additional argument USER_DATA. Stops when FN returns 0. */
5416 void
5417 foreach_window (f, fn, user_data)
5418 struct frame *f;
5419 int (* fn) P_ ((struct window *, void *));
5420 void *user_data;
5422 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
5426 /* Helper function for foreach_window. Call FN for all leaf windows
5427 reachable from W. FN is called with the first argument being a
5428 pointer to the leaf window, and with additional argument USER_DATA.
5429 Stop when FN returns 0. Value is 0 if stopped by FN. */
5431 static int
5432 foreach_window_1 (w, fn, user_data)
5433 struct window *w;
5434 int (* fn) P_ ((struct window *, void *));
5435 void *user_data;
5437 int cont;
5439 for (cont = 1; w && cont;)
5441 if (!NILP (w->hchild))
5442 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
5443 else if (!NILP (w->vchild))
5444 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
5445 else
5446 cont = fn (w, user_data);
5448 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5451 return cont;
5455 /* Freeze or unfreeze the window start of W if unless it is a
5456 mini-window or the selected window. FREEZE_P non-null means freeze
5457 the window start. */
5459 static int
5460 freeze_window_start (w, freeze_p)
5461 struct window *w;
5462 void *freeze_p;
5464 if (w == XWINDOW (selected_window)
5465 || MINI_WINDOW_P (w)
5466 || (MINI_WINDOW_P (XWINDOW (selected_window))
5467 && ! NILP (Vminibuf_scroll_window)
5468 && w == XWINDOW (Vminibuf_scroll_window)))
5469 freeze_p = NULL;
5471 w->frozen_window_start_p = freeze_p != NULL;
5472 return 1;
5476 /* Freeze or unfreeze the window starts of all leaf windows on frame
5477 F, except the selected window and a mini-window. FREEZE_P non-zero
5478 means freeze the window start. */
5480 void
5481 freeze_window_starts (f, freeze_p)
5482 struct frame *f;
5483 int freeze_p;
5485 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
5489 /***********************************************************************
5490 Initialization
5491 ***********************************************************************/
5493 /* Return 1 if window configurations C1 and C2
5494 describe the same state of affairs. This is used by Fequal. */
5497 compare_window_configurations (c1, c2, ignore_positions)
5498 Lisp_Object c1, c2;
5499 int ignore_positions;
5501 register struct save_window_data *d1, *d2;
5502 struct Lisp_Vector *sw1, *sw2;
5503 int i;
5505 if (!WINDOW_CONFIGURATIONP (c1))
5506 wrong_type_argument (Qwindow_configuration_p, c1);
5507 if (!WINDOW_CONFIGURATIONP (c2))
5508 wrong_type_argument (Qwindow_configuration_p, c2);
5510 d1 = (struct save_window_data *) XVECTOR (c1);
5511 d2 = (struct save_window_data *) XVECTOR (c2);
5512 sw1 = XVECTOR (d1->saved_windows);
5513 sw2 = XVECTOR (d2->saved_windows);
5515 if (! EQ (d1->frame_width, d2->frame_width))
5516 return 0;
5517 if (! EQ (d1->frame_height, d2->frame_height))
5518 return 0;
5519 if (! EQ (d1->frame_menu_bar_lines, d2->frame_menu_bar_lines))
5520 return 0;
5521 if (! EQ (d1->selected_frame, d2->selected_frame))
5522 return 0;
5523 /* Don't compare the current_window field directly.
5524 Instead see w1_is_current and w2_is_current, below. */
5525 if (! EQ (d1->current_buffer, d2->current_buffer))
5526 return 0;
5527 if (! ignore_positions)
5528 if (! EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window))
5529 return 0;
5530 /* Don't compare the root_window field.
5531 We don't require the two configurations
5532 to use the same window object,
5533 and the two root windows must be equivalent
5534 if everything else compares equal. */
5535 if (! EQ (d1->focus_frame, d2->focus_frame))
5536 return 0;
5537 if (! EQ (d1->min_width, d2->min_width))
5538 return 0;
5539 if (! EQ (d1->min_height, d2->min_height))
5540 return 0;
5542 /* Verify that the two confis have the same number of windows. */
5543 if (sw1->size != sw2->size)
5544 return 0;
5546 for (i = 0; i < sw1->size; i++)
5548 struct saved_window *p1, *p2;
5549 int w1_is_current, w2_is_current;
5551 p1 = SAVED_WINDOW_N (sw1, i);
5552 p2 = SAVED_WINDOW_N (sw2, i);
5554 /* Verify that the current windows in the two
5555 configurations correspond to each other. */
5556 w1_is_current = EQ (d1->current_window, p1->window);
5557 w2_is_current = EQ (d2->current_window, p2->window);
5559 if (w1_is_current != w2_is_current)
5560 return 0;
5562 /* Verify that the corresponding windows do match. */
5563 if (! EQ (p1->buffer, p2->buffer))
5564 return 0;
5565 if (! EQ (p1->left, p2->left))
5566 return 0;
5567 if (! EQ (p1->top, p2->top))
5568 return 0;
5569 if (! EQ (p1->width, p2->width))
5570 return 0;
5571 if (! EQ (p1->height, p2->height))
5572 return 0;
5573 if (! EQ (p1->display_table, p2->display_table))
5574 return 0;
5575 if (! EQ (p1->parent, p2->parent))
5576 return 0;
5577 if (! EQ (p1->prev, p2->prev))
5578 return 0;
5579 if (! ignore_positions)
5581 if (! EQ (p1->hscroll, p2->hscroll))
5582 return 0;
5583 if (!EQ (p1->min_hscroll, p2->min_hscroll))
5584 return 0;
5585 if (! EQ (p1->start_at_line_beg, p2->start_at_line_beg))
5586 return 0;
5587 if (NILP (Fequal (p1->start, p2->start)))
5588 return 0;
5589 if (NILP (Fequal (p1->pointm, p2->pointm)))
5590 return 0;
5591 if (NILP (Fequal (p1->mark, p2->mark)))
5592 return 0;
5596 return 1;
5599 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
5600 Scompare_window_configurations, 2, 2, 0,
5601 "Compare two window configurations as regards the structure of windows.\n\
5602 This function ignores details such as the values of point and mark\n\
5603 and scrolling positions.")
5604 (x, y)
5605 Lisp_Object x, y;
5607 if (compare_window_configurations (x, y, 1))
5608 return Qt;
5609 return Qnil;
5612 void
5613 init_window_once ()
5615 struct frame *f = make_terminal_frame ();
5616 XSETFRAME (selected_frame, f);
5617 Vterminal_frame = selected_frame;
5618 minibuf_window = f->minibuffer_window;
5619 selected_window = f->selected_window;
5620 last_nonminibuf_frame = f;
5622 window_initialized = 1;
5625 void
5626 init_window ()
5628 Vwindow_list = Qnil;
5631 void
5632 syms_of_window ()
5634 Qleft_bitmap_area = intern ("left-bitmap-area");
5635 staticpro (&Qleft_bitmap_area);
5636 Qright_bitmap_area = intern ("right-bitmap-area");
5637 staticpro (&Qright_bitmap_area);
5639 Qwindow_size_fixed = intern ("window-size-fixed");
5640 staticpro (&Qwindow_size_fixed);
5642 staticpro (&Qwindow_configuration_change_hook);
5643 Qwindow_configuration_change_hook
5644 = intern ("window-configuration-change-hook");
5646 Qwindowp = intern ("windowp");
5647 staticpro (&Qwindowp);
5649 Qwindow_configuration_p = intern ("window-configuration-p");
5650 staticpro (&Qwindow_configuration_p);
5652 Qwindow_live_p = intern ("window-live-p");
5653 staticpro (&Qwindow_live_p);
5655 Qtemp_buffer_show_hook = intern ("temp-buffer-show-hook");
5656 staticpro (&Qtemp_buffer_show_hook);
5658 staticpro (&Vwindow_list);
5660 DEFVAR_LISP ("temp-buffer-show-function", &Vtemp_buffer_show_function,
5661 "Non-nil means call as function to display a help buffer.\n\
5662 The function is called with one argument, the buffer to be displayed.\n\
5663 Used by `with-output-to-temp-buffer'.\n\
5664 If this function is used, then it must do the entire job of showing\n\
5665 the buffer; `temp-buffer-show-hook' is not run unless this function runs it.");
5666 Vtemp_buffer_show_function = Qnil;
5668 DEFVAR_LISP ("display-buffer-function", &Vdisplay_buffer_function,
5669 "If non-nil, function to call to handle `display-buffer'.\n\
5670 It will receive two args, the buffer and a flag which if non-nil means\n\
5671 that the currently selected window is not acceptable.\n\
5672 Commands such as `switch-to-buffer-other-window' and `find-file-other-window'\n\
5673 work using this function.");
5674 Vdisplay_buffer_function = Qnil;
5676 DEFVAR_LISP ("even-window-heights", &Veven_window_heights,
5677 "*If non-nil, `display-buffer' should even the window heights.\n\
5678 If nil, `display-buffer' will leave the window configuration alone.");
5679 Veven_window_heights = Qt;
5681 DEFVAR_LISP ("minibuffer-scroll-window", &Vminibuf_scroll_window,
5682 "Non-nil means it is the window that C-M-v in minibuffer should scroll.");
5683 Vminibuf_scroll_window = Qnil;
5685 DEFVAR_LISP ("other-window-scroll-buffer", &Vother_window_scroll_buffer,
5686 "If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window.");
5687 Vother_window_scroll_buffer = Qnil;
5689 DEFVAR_BOOL ("pop-up-frames", &pop_up_frames,
5690 "*Non-nil means `display-buffer' should make a separate frame.");
5691 pop_up_frames = 0;
5693 DEFVAR_BOOL ("display-buffer-reuse-frames", &display_buffer_reuse_frames,
5694 "*Non-nil means `display-buffer' should reuse frames.\n\
5695 If the buffer in question is already displayed in a frame, raise that frame.");
5696 display_buffer_reuse_frames = 0;
5698 DEFVAR_LISP ("pop-up-frame-function", &Vpop_up_frame_function,
5699 "Function to call to handle automatic new frame creation.\n\
5700 It is called with no arguments and should return a newly created frame.\n\
5702 A typical value might be `(lambda () (new-frame pop-up-frame-alist))'\n\
5703 where `pop-up-frame-alist' would hold the default frame parameters.");
5704 Vpop_up_frame_function = Qnil;
5706 DEFVAR_LISP ("special-display-buffer-names", &Vspecial_display_buffer_names,
5707 "*List of buffer names that should have their own special frames.\n\
5708 Displaying a buffer whose name is in this list makes a special frame for it\n\
5709 using `special-display-function'. See also `special-display-regexps'.\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 (BUFFER FRAME-PARAMETERS...) (BUFFER 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 BUFFER as the first argument,\n\
5716 followed by OTHER-ARGS--it can display 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 name to it\n\
5720 but that buffer still appears 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_buffer_names = Qnil;
5725 DEFVAR_LISP ("special-display-regexps", &Vspecial_display_regexps,
5726 "*List of regexps saying which buffers should have their own special frames.\n\
5727 If a buffer name matches one of these regexps, it gets its own frame.\n\
5728 Displaying a buffer whose name is in this list makes a special frame for it\n\
5729 using `special-display-function'.\n\
5731 An element of the list can be a list instead of just a string.\n\
5732 There are two ways to use a list as an element:\n\
5733 (REGEXP FRAME-PARAMETERS...) (REGEXP FUNCTION OTHER-ARGS...)\n\
5734 In the first case, FRAME-PARAMETERS are used to create the frame.\n\
5735 In the latter case, FUNCTION is called with the buffer as first argument,\n\
5736 followed by OTHER-ARGS--it can display the buffer in any way it likes.\n\
5737 All this is done by the function found in `special-display-function'.\n\
5739 If this variable appears \"not to work\", because you add a regexp to it\n\
5740 but the matching buffers still appear in the selected window, look at the\n\
5741 values of `same-window-buffer-names' and `same-window-regexps'.\n\
5742 Those variables take precedence over this one.");
5743 Vspecial_display_regexps = Qnil;
5745 DEFVAR_LISP ("special-display-function", &Vspecial_display_function,
5746 "Function to call to make a new frame for a special buffer.\n\
5747 It is called with two arguments, the buffer and optional buffer specific\n\
5748 data, and should return a window displaying that buffer.\n\
5749 The default value makes a separate frame for the buffer,\n\
5750 using `special-display-frame-alist' to specify the frame parameters.\n\
5752 A buffer is special if its is listed in `special-display-buffer-names'\n\
5753 or matches a regexp in `special-display-regexps'.");
5754 Vspecial_display_function = Qnil;
5756 DEFVAR_LISP ("same-window-buffer-names", &Vsame_window_buffer_names,
5757 "*List of buffer names that should appear in the selected window.\n\
5758 Displaying one of these buffers using `display-buffer' or `pop-to-buffer'\n\
5759 switches to it in the selected window, rather than making it appear\n\
5760 in some other window.\n\
5762 An element of the list can be a cons cell instead of just a string.\n\
5763 Then the car must be a string, which specifies the buffer name.\n\
5764 This is for compatibility with `special-display-buffer-names';\n\
5765 the cdr of the cons cell is ignored.\n\
5767 See also `same-window-regexps'.");
5768 Vsame_window_buffer_names = Qnil;
5770 DEFVAR_LISP ("same-window-regexps", &Vsame_window_regexps,
5771 "*List of regexps saying which buffers should appear in the selected window.\n\
5772 If a buffer name matches one of these regexps, then displaying it\n\
5773 using `display-buffer' or `pop-to-buffer' switches to it\n\
5774 in the selected window, rather than making it appear in some other window.\n\
5776 An element of the list can be a cons cell instead of just a string.\n\
5777 Then the car must be a string, which specifies the buffer name.\n\
5778 This is for compatibility with `special-display-buffer-names';\n\
5779 the cdr of the cons cell is ignored.\n\
5781 See also `same-window-buffer-names'.");
5782 Vsame_window_regexps = Qnil;
5784 DEFVAR_BOOL ("pop-up-windows", &pop_up_windows,
5785 "*Non-nil means display-buffer should make new windows.");
5786 pop_up_windows = 1;
5788 DEFVAR_INT ("next-screen-context-lines", &next_screen_context_lines,
5789 "*Number of lines of continuity when scrolling by screenfuls.");
5790 next_screen_context_lines = 2;
5792 DEFVAR_INT ("split-height-threshold", &split_height_threshold,
5793 "*display-buffer would prefer to split the largest window if this large.\n\
5794 If there is only one window, it is split regardless of this value.");
5795 split_height_threshold = 500;
5797 DEFVAR_INT ("window-min-height", &window_min_height,
5798 "*Delete any window less than this tall (including its mode line).");
5799 window_min_height = 4;
5801 DEFVAR_INT ("window-min-width", &window_min_width,
5802 "*Delete any window less than this wide.");
5803 window_min_width = 10;
5805 DEFVAR_LISP ("scroll-preserve-screen-position",
5806 &Vscroll_preserve_screen_position,
5807 "*Non-nil means scroll commands move point to keep its screen line unchanged.");
5808 Vscroll_preserve_screen_position = Qnil;
5810 DEFVAR_LISP ("window-configuration-change-hook",
5811 &Vwindow_configuration_change_hook,
5812 "Functions to call when window configuration changes.\n\
5813 The selected frame is the one whose configuration has changed.");
5814 Vwindow_configuration_change_hook = Qnil;
5816 DEFVAR_BOOL ("window-size-fixed", &window_size_fixed,
5817 "Non-nil in a buffer means windows displaying the buffer are fixed-size.\n\
5818 Emacs won't change the size of any window displaying that buffer,\n\
5819 unless you explicitly change the size, or Emacs has no other choice.\n\
5820 This variable automatically becomes buffer-local when set.");
5821 Fmake_variable_buffer_local (Qwindow_size_fixed);
5822 window_size_fixed = 0;
5824 defsubr (&Sselected_window);
5825 defsubr (&Sminibuffer_window);
5826 defsubr (&Swindow_minibuffer_p);
5827 defsubr (&Swindowp);
5828 defsubr (&Swindow_live_p);
5829 defsubr (&Spos_visible_in_window_p);
5830 defsubr (&Swindow_buffer);
5831 defsubr (&Swindow_height);
5832 defsubr (&Swindow_width);
5833 defsubr (&Swindow_hscroll);
5834 defsubr (&Sset_window_hscroll);
5835 defsubr (&Swindow_redisplay_end_trigger);
5836 defsubr (&Sset_window_redisplay_end_trigger);
5837 defsubr (&Swindow_edges);
5838 defsubr (&Scoordinates_in_window_p);
5839 defsubr (&Swindow_at);
5840 defsubr (&Swindow_point);
5841 defsubr (&Swindow_start);
5842 defsubr (&Swindow_end);
5843 defsubr (&Sset_window_point);
5844 defsubr (&Sset_window_start);
5845 defsubr (&Swindow_dedicated_p);
5846 defsubr (&Sset_window_dedicated_p);
5847 defsubr (&Swindow_display_table);
5848 defsubr (&Sset_window_display_table);
5849 defsubr (&Snext_window);
5850 defsubr (&Sprevious_window);
5851 defsubr (&Sother_window);
5852 defsubr (&Sget_lru_window);
5853 defsubr (&Sget_largest_window);
5854 defsubr (&Sget_buffer_window);
5855 defsubr (&Sdelete_other_windows);
5856 defsubr (&Sdelete_windows_on);
5857 defsubr (&Sreplace_buffer_in_windows);
5858 defsubr (&Sdelete_window);
5859 defsubr (&Sset_window_buffer);
5860 defsubr (&Sselect_window);
5861 defsubr (&Sspecial_display_p);
5862 defsubr (&Ssame_window_p);
5863 defsubr (&Sdisplay_buffer);
5864 defsubr (&Ssplit_window);
5865 defsubr (&Senlarge_window);
5866 defsubr (&Sshrink_window);
5867 defsubr (&Sscroll_up);
5868 defsubr (&Sscroll_down);
5869 defsubr (&Sscroll_left);
5870 defsubr (&Sscroll_right);
5871 defsubr (&Sother_window_for_scrolling);
5872 defsubr (&Sscroll_other_window);
5873 defsubr (&Srecenter);
5874 defsubr (&Swindow_text_height);
5875 defsubr (&Smove_to_window_line);
5876 defsubr (&Swindow_configuration_p);
5877 defsubr (&Swindow_configuration_frame);
5878 defsubr (&Sset_window_configuration);
5879 defsubr (&Scurrent_window_configuration);
5880 defsubr (&Ssave_window_excursion);
5881 defsubr (&Sset_window_margins);
5882 defsubr (&Swindow_margins);
5883 defsubr (&Swindow_vscroll);
5884 defsubr (&Sset_window_vscroll);
5885 defsubr (&Scompare_window_configurations);
5886 defsubr (&Swindow_list);
5889 void
5890 keys_of_window ()
5892 initial_define_key (control_x_map, '1', "delete-other-windows");
5893 initial_define_key (control_x_map, '2', "split-window");
5894 initial_define_key (control_x_map, '0', "delete-window");
5895 initial_define_key (control_x_map, 'o', "other-window");
5896 initial_define_key (control_x_map, '^', "enlarge-window");
5897 initial_define_key (control_x_map, '<', "scroll-left");
5898 initial_define_key (control_x_map, '>', "scroll-right");
5900 initial_define_key (global_map, Ctl ('V'), "scroll-up");
5901 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
5902 initial_define_key (meta_map, 'v', "scroll-down");
5904 initial_define_key (global_map, Ctl('L'), "recenter");
5905 initial_define_key (meta_map, 'r', "move-to-window-line");