(hexl-mode-map): Use command remapping instead of
[emacs.git] / src / window.c
blob83440f440cc52f44e7e43ee0340926ec5926b797
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985,86,87,93,94,95,96,97,1998,2000, 2001, 2002
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 #include <config.h>
24 #include "lisp.h"
25 #include "buffer.h"
26 #include "keyboard.h"
27 #include "keymap.h"
28 #include "frame.h"
29 #include "window.h"
30 #include "commands.h"
31 #include "indent.h"
32 #include "termchar.h"
33 #include "disptab.h"
34 #include "dispextern.h"
35 #include "blockinput.h"
36 #include "intervals.h"
38 #ifdef HAVE_X_WINDOWS
39 #include "xterm.h"
40 #endif /* HAVE_X_WINDOWS */
41 #ifdef WINDOWSNT
42 #include "w32term.h"
43 #endif
44 #ifdef MSDOS
45 #include "msdos.h"
46 #endif
47 #ifdef MAC_OS
48 #include "macterm.h"
49 #endif
51 /* Values returned from coordinates_in_window. */
53 enum window_part
55 ON_NOTHING,
56 ON_TEXT,
57 ON_MODE_LINE,
58 ON_VERTICAL_BORDER,
59 ON_HEADER_LINE,
60 ON_LEFT_FRINGE,
61 ON_RIGHT_FRINGE,
62 ON_LEFT_MARGIN,
63 ON_RIGHT_MARGIN
67 Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
68 Lisp_Object Qwindow_size_fixed;
69 extern Lisp_Object Qleft_margin, Qright_margin;
70 extern Lisp_Object Qheight, Qwidth;
72 static int displayed_window_lines P_ ((struct window *));
73 static struct window *decode_window P_ ((Lisp_Object));
74 static Lisp_Object select_window_1 P_ ((Lisp_Object, int));
75 static int count_windows P_ ((struct window *));
76 static int get_leaf_windows P_ ((struct window *, struct window **, int));
77 static void window_scroll P_ ((Lisp_Object, int, int, int));
78 static void window_scroll_pixel_based P_ ((Lisp_Object, int, int, int));
79 static void window_scroll_line_based P_ ((Lisp_Object, int, int, int));
80 static int window_min_size_1 P_ ((struct window *, int));
81 static int window_min_size P_ ((struct window *, int, int, int *));
82 static void size_window P_ ((Lisp_Object, int, int, int));
83 static int freeze_window_start P_ ((struct window *, void *));
84 static int window_fixed_size_p P_ ((struct window *, int, int));
85 static void enlarge_window P_ ((Lisp_Object, int, int, int));
86 static Lisp_Object window_list P_ ((void));
87 static int add_window_to_list P_ ((struct window *, void *));
88 static int candidate_window_p P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
89 Lisp_Object));
90 static Lisp_Object next_window P_ ((Lisp_Object, Lisp_Object,
91 Lisp_Object, int));
92 static void decode_next_window_args P_ ((Lisp_Object *, Lisp_Object *,
93 Lisp_Object *));
94 static int foreach_window_1 P_ ((struct window *,
95 int (* fn) (struct window *, void *),
96 void *));
97 static Lisp_Object window_list_1 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
99 /* The value of `window-size-fixed'. */
101 int window_size_fixed;
103 /* This is the window in which the terminal's cursor should
104 be left when nothing is being done with it. This must
105 always be a leaf window, and its buffer is selected by
106 the top level editing loop at the end of each command.
108 This value is always the same as
109 FRAME_SELECTED_WINDOW (selected_frame). */
111 Lisp_Object selected_window;
113 /* A list of all windows for use by next_window and Fwindow_list.
114 Functions creating or deleting windows should invalidate this cache
115 by setting it to nil. */
117 Lisp_Object Vwindow_list;
119 /* The mini-buffer window of the selected frame.
120 Note that you cannot test for mini-bufferness of an arbitrary window
121 by comparing against this; but you can test for mini-bufferness of
122 the selected window. */
124 Lisp_Object minibuf_window;
126 /* Non-nil means it is the window whose mode line should be
127 shown as the selected window when the minibuffer is selected. */
129 Lisp_Object minibuf_selected_window;
131 /* Non-nil means it is the window for C-M-v to scroll
132 when the mini-buffer is selected. */
134 Lisp_Object Vminibuf_scroll_window;
136 /* Non-nil means this is the buffer whose window C-M-v should scroll. */
138 Lisp_Object Vother_window_scroll_buffer;
140 /* Non-nil means it's function to call to display temp buffers. */
142 Lisp_Object Vtemp_buffer_show_function;
144 /* Non-zero means to use mode-line-inactive face in all windows but the
145 selected-window and the minibuffer-scroll-window when the
146 minibuffer is active. */
147 int mode_line_in_non_selected_windows;
149 /* If a window gets smaller than either of these, it is removed. */
151 EMACS_INT window_min_height;
152 EMACS_INT window_min_width;
154 /* Nonzero implies Fdisplay_buffer should create windows. */
156 int pop_up_windows;
158 /* Nonzero implies make new frames for Fdisplay_buffer. */
160 int pop_up_frames;
162 /* Nonzero means reuse existing frames for displaying buffers. */
164 int display_buffer_reuse_frames;
166 /* Non-nil means use this function instead of default */
168 Lisp_Object Vpop_up_frame_function;
170 /* Function to call to handle Fdisplay_buffer. */
172 Lisp_Object Vdisplay_buffer_function;
174 /* Non-nil means that Fdisplay_buffer should even the heights of windows. */
176 Lisp_Object Veven_window_heights;
178 /* List of buffer *names* for buffers that should have their own frames. */
180 Lisp_Object Vspecial_display_buffer_names;
182 /* List of regexps for buffer names that should have their own frames. */
184 Lisp_Object Vspecial_display_regexps;
186 /* Function to pop up a special frame. */
188 Lisp_Object Vspecial_display_function;
190 /* List of buffer *names* for buffers to appear in selected window. */
192 Lisp_Object Vsame_window_buffer_names;
194 /* List of regexps for buffer names to appear in selected window. */
196 Lisp_Object Vsame_window_regexps;
198 /* Hook run at end of temp_output_buffer_show. */
200 Lisp_Object Qtemp_buffer_show_hook;
202 /* Fdisplay_buffer always splits the largest window
203 if that window is more than this high. */
205 EMACS_INT split_height_threshold;
207 /* Number of lines of continuity in scrolling by screenfuls. */
209 EMACS_INT next_screen_context_lines;
211 /* Incremented for each window created. */
213 static int sequence_number;
215 /* Nonzero after init_window_once has finished. */
217 static int window_initialized;
219 /* Hook to run when window config changes. */
221 Lisp_Object Qwindow_configuration_change_hook;
222 Lisp_Object Vwindow_configuration_change_hook;
224 /* Nonzero means scroll commands try to put point
225 at the same screen height as previously. */
227 Lisp_Object Vscroll_preserve_screen_position;
229 #if 0 /* This isn't used anywhere. */
230 /* Nonzero means we can split a frame even if it is "unsplittable". */
231 static int inhibit_frame_unsplittable;
232 #endif /* 0 */
234 extern EMACS_INT scroll_margin;
236 extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
238 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
239 doc: /* Returns t if OBJECT is a window. */)
240 (object)
241 Lisp_Object object;
243 return WINDOWP (object) ? Qt : Qnil;
246 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
247 doc: /* Returns t if OBJECT is a window which is currently visible. */)
248 (object)
249 Lisp_Object object;
251 return WINDOW_LIVE_P (object) ? Qt : Qnil;
254 Lisp_Object
255 make_window ()
257 Lisp_Object val;
258 register struct window *p;
260 p = allocate_window ();
261 XSETFASTINT (p->sequence_number, ++sequence_number);
262 XSETFASTINT (p->left, 0);
263 XSETFASTINT (p->top, 0);
264 XSETFASTINT (p->height, 0);
265 XSETFASTINT (p->width, 0);
266 XSETFASTINT (p->hscroll, 0);
267 XSETFASTINT (p->min_hscroll, 0);
268 p->orig_top = p->orig_height = Qnil;
269 p->start = Fmake_marker ();
270 p->pointm = Fmake_marker ();
271 XSETFASTINT (p->use_time, 0);
272 p->frame = Qnil;
273 p->display_table = Qnil;
274 p->dedicated = Qnil;
275 p->pseudo_window_p = 0;
276 bzero (&p->cursor, sizeof (p->cursor));
277 bzero (&p->last_cursor, sizeof (p->last_cursor));
278 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
279 p->desired_matrix = p->current_matrix = 0;
280 p->phys_cursor_type = -1;
281 p->phys_cursor_width = -1;
282 p->must_be_updated_p = 0;
283 XSETFASTINT (p->window_end_vpos, 0);
284 XSETFASTINT (p->window_end_pos, 0);
285 p->window_end_valid = Qnil;
286 p->vscroll = 0;
287 XSETWINDOW (val, p);
288 XSETFASTINT (p->last_point, 0);
289 p->frozen_window_start_p = 0;
290 p->height_fixed_p = 0;
291 p->last_cursor_off_p = p->cursor_off_p = 0;
293 Vwindow_list = Qnil;
294 return val;
297 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
298 doc: /* Return the window that the cursor now appears in and commands apply to. */)
301 return selected_window;
304 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
305 doc: /* Return the window used now for minibuffers.
306 If the optional argument FRAME is specified, return the minibuffer window
307 used by that frame. */)
308 (frame)
309 Lisp_Object frame;
311 if (NILP (frame))
312 frame = selected_frame;
313 CHECK_LIVE_FRAME (frame);
314 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
317 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
318 doc: /* Returns non-nil if WINDOW is a minibuffer window. */)
319 (window)
320 Lisp_Object window;
322 struct window *w = decode_window (window);
323 return MINI_WINDOW_P (w) ? Qt : Qnil;
327 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
328 Spos_visible_in_window_p, 0, 3, 0,
329 doc: /* Return t if position POS is currently on the frame in WINDOW.
330 Return nil if that position is scrolled vertically out of view.
331 If a character is only partially visible, nil is returned, unless the
332 optional argument PARTIALLY is non-nil.
333 POS defaults to point in WINDOW; WINDOW defaults to the selected window. */)
334 (pos, window, partially)
335 Lisp_Object pos, window, partially;
337 register struct window *w;
338 register int posint;
339 register struct buffer *buf;
340 struct text_pos top;
341 Lisp_Object in_window;
342 int fully_p;
344 w = decode_window (window);
345 buf = XBUFFER (w->buffer);
346 SET_TEXT_POS_FROM_MARKER (top, w->start);
348 if (!NILP (pos))
350 CHECK_NUMBER_COERCE_MARKER (pos);
351 posint = XINT (pos);
353 else if (w == XWINDOW (selected_window))
354 posint = PT;
355 else
356 posint = XMARKER (w->pointm)->charpos;
358 /* If position is above window start, it's not visible. */
359 if (posint < CHARPOS (top))
360 in_window = Qnil;
361 else if (XFASTINT (w->last_modified) >= BUF_MODIFF (buf)
362 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (buf)
363 && posint < BUF_Z (buf) - XFASTINT (w->window_end_pos))
365 /* If frame is up-to-date, and POSINT is < window end pos, use
366 that info. This doesn't work for POSINT == end pos, because
367 the window end pos is actually the position _after_ the last
368 char in the window. */
369 if (NILP (partially))
371 pos_visible_p (w, posint, &fully_p, NILP (partially));
372 in_window = fully_p ? Qt : Qnil;
374 else
375 in_window = Qt;
377 else if (posint > BUF_ZV (buf))
378 in_window = Qnil;
379 else if (CHARPOS (top) < BUF_BEGV (buf) || CHARPOS (top) > BUF_ZV (buf))
380 /* If window start is out of range, do something reasonable. */
381 in_window = Qnil;
382 else
384 if (pos_visible_p (w, posint, &fully_p, NILP (partially)))
385 in_window = !NILP (partially) || fully_p ? Qt : Qnil;
386 else
387 in_window = Qnil;
390 return in_window;
394 static struct window *
395 decode_window (window)
396 register Lisp_Object window;
398 if (NILP (window))
399 return XWINDOW (selected_window);
401 CHECK_LIVE_WINDOW (window);
402 return XWINDOW (window);
405 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
406 doc: /* Return the buffer that WINDOW is displaying. */)
407 (window)
408 Lisp_Object window;
410 return decode_window (window)->buffer;
413 DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
414 doc: /* Return the number of lines in WINDOW (including its mode line). */)
415 (window)
416 Lisp_Object window;
418 return decode_window (window)->height;
421 DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
422 doc: /* Return the number of display columns in WINDOW.
423 This is the width that is usable columns available for text in WINDOW.
424 If you want to find out how many columns WINDOW takes up,
425 use (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))). */)
426 (window)
427 Lisp_Object window;
429 return make_number (window_internal_width (decode_window (window)));
432 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
433 doc: /* Return the number of columns by which WINDOW is scrolled from left margin. */)
434 (window)
435 Lisp_Object window;
437 return decode_window (window)->hscroll;
440 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
441 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
442 NCOL should be zero or positive.
444 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
445 window so that the location of point becomes invisible. */)
446 (window, ncol)
447 Lisp_Object window, ncol;
449 struct window *w = decode_window (window);
450 int hscroll;
452 CHECK_NUMBER (ncol);
453 hscroll = max (0, XINT (ncol));
455 /* Prevent redisplay shortcuts when changing the hscroll. */
456 if (XINT (w->hscroll) != hscroll)
457 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
459 w->hscroll = make_number (hscroll);
460 return ncol;
463 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
464 Swindow_redisplay_end_trigger, 0, 1, 0,
465 doc: /* Return WINDOW's redisplay end trigger value.
466 See `set-window-redisplay-end-trigger' for more information. */)
467 (window)
468 Lisp_Object window;
470 return decode_window (window)->redisplay_end_trigger;
473 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
474 Sset_window_redisplay_end_trigger, 2, 2, 0,
475 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
476 VALUE should be a buffer position (typically a marker) or nil.
477 If it is a buffer position, then if redisplay in WINDOW reaches a position
478 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
479 with two arguments: WINDOW, and the end trigger value.
480 Afterwards the end-trigger value is reset to nil. */)
481 (window, value)
482 register Lisp_Object window, value;
484 register struct window *w;
486 w = decode_window (window);
487 w->redisplay_end_trigger = value;
488 return value;
491 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
492 doc: /* Return a list of the edge coordinates of WINDOW.
493 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
494 RIGHT is one more than the rightmost column used by WINDOW,
495 and BOTTOM is one more than the bottommost row used by WINDOW
496 and its mode-line. */)
497 (window)
498 Lisp_Object window;
500 register struct window *w = decode_window (window);
502 return Fcons (w->left, Fcons (w->top,
503 Fcons (make_number (WINDOW_RIGHT_EDGE (w)),
504 Fcons (make_number (XFASTINT (w->top)
505 + XFASTINT (w->height)),
506 Qnil))));
509 /* Test if the character at column *X, row *Y is within window W.
510 If it is not, return 0;
511 if it is in the window's text area,
512 set *x and *y to its location relative to the upper left corner
513 of the window, and
514 return 1;
515 if it is on the window's modeline, return 2;
516 if it is on the border between the window and its right sibling,
517 return 3.
518 if it is on the window's top line, return 4;
519 if it is in left or right fringe of the window,
520 return 5 or 6, and convert *X and *Y to window-relative coordinates;
521 if it is in the marginal area to the left/right of the window,
522 return 7 or 8, and convert *X and *Y to window-relative coordinates.
524 X and Y are frame relative pixel coordinates. */
526 static enum window_part
527 coordinates_in_window (w, x, y)
528 register struct window *w;
529 register int *x, *y;
531 /* Let's make this a global enum later, instead of using numbers
532 everywhere. */
533 struct frame *f = XFRAME (WINDOW_FRAME (w));
534 int left_x, right_x, top_y, bottom_y;
535 enum window_part part;
536 int ux = CANON_X_UNIT (f);
537 int x0 = XFASTINT (w->left) * ux;
538 int x1 = x0 + XFASTINT (w->width) * ux;
539 /* The width of the area where the vertical line can be dragged.
540 (Between mode lines for instance. */
541 int grabbable_width = ux;
542 int lmargin_width = 0, rmargin_width = 0;
544 if (*x < x0 || *x >= x1)
545 return ON_NOTHING;
547 /* In what's below, we subtract 1 when computing right_x because we
548 want the rightmost pixel, which is given by left_pixel+width-1. */
549 if (w->pseudo_window_p)
551 left_x = 0;
552 right_x = XFASTINT (w->width) * CANON_X_UNIT (f) - 1;
553 top_y = WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w);
554 bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
556 else
558 left_x = (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X (w)
559 - FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
560 right_x = WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X (w) - 1;
561 top_y = (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w)
562 - FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
563 bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
566 /* On the mode line or header line? If it's near the start of
567 the mode or header line of window that's has a horizontal
568 sibling, say it's on the vertical line. That's to be able
569 to resize windows horizontally in case we're using toolkit
570 scroll bars. */
572 if (WINDOW_WANTS_MODELINE_P (w)
573 && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
574 && *y < bottom_y)
576 /* We're somewhere on the mode line. We consider the place
577 between mode lines of horizontally adjacent mode lines
578 as the vertical border. If scroll bars on the left,
579 return the right window. */
580 part = ON_MODE_LINE;
582 if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
584 if (abs (*x - x0) < grabbable_width)
585 part = ON_VERTICAL_BORDER;
587 else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < grabbable_width)
588 part = ON_VERTICAL_BORDER;
590 else if (WINDOW_WANTS_HEADER_LINE_P (w)
591 && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
592 && *y >= top_y)
594 part = ON_HEADER_LINE;
596 if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
598 if (abs (*x - x0) < grabbable_width)
599 part = ON_VERTICAL_BORDER;
601 else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < grabbable_width)
602 part = ON_VERTICAL_BORDER;
604 /* Outside anything interesting? */
605 else if (*y < top_y
606 || *y >= bottom_y
607 || *x < (left_x
608 - FRAME_LEFT_FRINGE_WIDTH (f)
609 - FRAME_LEFT_SCROLL_BAR_WIDTH (f) * ux)
610 || *x > (right_x
611 + FRAME_RIGHT_FRINGE_WIDTH (f)
612 + FRAME_RIGHT_SCROLL_BAR_WIDTH (f) * ux))
614 part = ON_NOTHING;
616 else if (FRAME_WINDOW_P (f))
618 if (!w->pseudo_window_p
619 && !FRAME_HAS_VERTICAL_SCROLL_BARS (f)
620 && !WINDOW_RIGHTMOST_P (w)
621 && (abs (*x - right_x - FRAME_RIGHT_FRINGE_WIDTH (f)) < grabbable_width))
623 part = ON_VERTICAL_BORDER;
625 else if (*x < left_x || *x > right_x)
627 /* Other lines than the mode line don't include fringes and
628 scroll bars on the left. */
630 /* Convert X and Y to window-relative pixel coordinates. */
631 *x -= left_x;
632 *y -= top_y;
633 part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
635 else
637 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
638 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
639 /* You can never be on a margin area if its width is zero. */
640 if (lmargin_width
641 && *x <= window_box_right (w, LEFT_MARGIN_AREA))
642 part = ON_LEFT_MARGIN;
643 else if (rmargin_width
644 && *x >= window_box_left (w, RIGHT_MARGIN_AREA))
645 part = ON_RIGHT_MARGIN;
646 else
648 part = ON_TEXT;
649 *x -= left_x;
650 *y -= top_y;
654 else
656 /* Need to say "*x > right_x" rather than >=, since on character
657 terminals, the vertical line's x coordinate is right_x. */
658 if (*x < left_x || *x > right_x)
660 /* Other lines than the mode line don't include fringes and
661 scroll bars on the left. */
663 /* Convert X and Y to window-relative pixel coordinates. */
664 *x -= left_x;
665 *y -= top_y;
666 part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
668 /* Here, too, "*x > right_x" is because of character terminals. */
669 else if (!w->pseudo_window_p
670 && !WINDOW_RIGHTMOST_P (w)
671 && *x > right_x - ux)
673 /* On the border on the right side of the window? Assume that
674 this area begins at RIGHT_X minus a canonical char width. */
675 part = ON_VERTICAL_BORDER;
677 else
679 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
680 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
681 /* You can never be on a margin area if its width is zero.
682 This is especially important for character terminals. */
683 if (lmargin_width
684 && *x <= window_box_right (w, LEFT_MARGIN_AREA))
685 part = ON_LEFT_MARGIN;
686 else if (rmargin_width
687 && *x >= window_box_left (w, RIGHT_MARGIN_AREA))
688 part = ON_RIGHT_MARGIN;
689 else
691 part = ON_TEXT;
692 /* Convert X and Y to window-relative pixel coordinates. */
693 *x -= left_x;
694 *y -= top_y;
699 return part;
703 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
704 Scoordinates_in_window_p, 2, 2, 0,
705 doc: /* Return non-nil if COORDINATES are in WINDOW.
706 COORDINATES is a cons of the form (X . Y), X and Y being distances
707 measured in characters from the upper-left corner of the frame.
708 \(0 . 0) denotes the character in the upper left corner of the
709 frame.
710 If COORDINATES are in the text portion of WINDOW,
711 the coordinates relative to the window are returned.
712 If they are in the mode line of WINDOW, `mode-line' is returned.
713 If they are in the top mode line of WINDOW, `header-line' is returned.
714 If they are in the left fringe of WINDOW, `left-fringe' is returned.
715 If they are in the right fringe of WINDOW, `right-fringe' is returned.
716 If they are on the border between WINDOW and its right sibling,
717 `vertical-line' is returned.
718 If they are in the windows's left or right marginal areas, `left-margin'\n\
719 or `right-margin' is returned. */)
720 (coordinates, window)
721 register Lisp_Object coordinates, window;
723 struct window *w;
724 struct frame *f;
725 int x, y;
726 Lisp_Object lx, ly;
728 CHECK_LIVE_WINDOW (window);
729 w = XWINDOW (window);
730 f = XFRAME (w->frame);
731 CHECK_CONS (coordinates);
732 lx = Fcar (coordinates);
733 ly = Fcdr (coordinates);
734 CHECK_NUMBER_OR_FLOAT (lx);
735 CHECK_NUMBER_OR_FLOAT (ly);
736 x = PIXEL_X_FROM_CANON_X (f, lx);
737 y = PIXEL_Y_FROM_CANON_Y (f, ly);
739 switch (coordinates_in_window (w, &x, &y))
741 case ON_NOTHING:
742 return Qnil;
744 case ON_TEXT:
745 /* X and Y are now window relative pixel coordinates. Convert
746 them to canonical char units before returning them. */
747 return Fcons (CANON_X_FROM_PIXEL_X (f, x),
748 CANON_Y_FROM_PIXEL_Y (f, y));
750 case ON_MODE_LINE:
751 return Qmode_line;
753 case ON_VERTICAL_BORDER:
754 return Qvertical_line;
756 case ON_HEADER_LINE:
757 return Qheader_line;
759 case ON_LEFT_FRINGE:
760 return Qleft_fringe;
762 case ON_RIGHT_FRINGE:
763 return Qright_fringe;
765 case ON_LEFT_MARGIN:
766 return Qleft_margin;
768 case ON_RIGHT_MARGIN:
769 return Qright_margin;
771 default:
772 abort ();
777 /* Callback for foreach_window, used in window_from_coordinates.
778 Check if window W contains coordinates specified by USER_DATA which
779 is actually a pointer to a struct check_window_data CW.
781 Check if window W contains coordinates *CW->x and *CW->y. If it
782 does, return W in *CW->window, as Lisp_Object, and return in
783 *CW->part the part of the window under coordinates *X,*Y. Return
784 zero from this function to stop iterating over windows. */
786 struct check_window_data
788 Lisp_Object *window;
789 int *x, *y, *part;
792 static int
793 check_window_containing (w, user_data)
794 struct window *w;
795 void *user_data;
797 struct check_window_data *cw = (struct check_window_data *) user_data;
798 enum window_part found;
799 int continue_p = 1;
801 found = coordinates_in_window (w, cw->x, cw->y);
802 if (found != ON_NOTHING)
804 *cw->part = found - 1;
805 XSETWINDOW (*cw->window, w);
806 continue_p = 0;
809 return continue_p;
813 /* Find the window containing frame-relative pixel position X/Y and
814 return it as a Lisp_Object. If X, Y is on the window's modeline,
815 set *PART to 1; if it is on the separating line between the window
816 and its right sibling, set it to 2; otherwise set it to 0. If
817 there is no window under X, Y return nil and leave *PART
818 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
820 This function was previously implemented with a loop cycling over
821 windows with Fnext_window, and starting with the frame's selected
822 window. It turned out that this doesn't work with an
823 implementation of next_window using Vwindow_list, because
824 FRAME_SELECTED_WINDOW (F) is not always contained in the window
825 tree of F when this function is called asynchronously from
826 note_mouse_highlight. The original loop didn't terminate in this
827 case. */
829 Lisp_Object
830 window_from_coordinates (f, x, y, part, tool_bar_p)
831 struct frame *f;
832 int x, y;
833 int *part;
834 int tool_bar_p;
836 Lisp_Object window;
837 struct check_window_data cw;
839 window = Qnil;
840 cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
841 foreach_window (f, check_window_containing, &cw);
843 /* If not found above, see if it's in the tool bar window, if a tool
844 bar exists. */
845 if (NILP (window)
846 && tool_bar_p
847 && WINDOWP (f->tool_bar_window)
848 && XINT (XWINDOW (f->tool_bar_window)->height) > 0
849 && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
850 != ON_NOTHING))
852 *part = 0;
853 window = f->tool_bar_window;
856 return window;
859 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
860 doc: /* Return window containing coordinates X and Y on FRAME.
861 If omitted, FRAME defaults to the currently selected frame.
862 The top left corner of the frame is considered to be row 0,
863 column 0. */)
864 (x, y, frame)
865 Lisp_Object x, y, frame;
867 int part;
868 struct frame *f;
870 if (NILP (frame))
871 frame = selected_frame;
872 CHECK_LIVE_FRAME (frame);
873 f = XFRAME (frame);
875 /* Check that arguments are integers or floats. */
876 CHECK_NUMBER_OR_FLOAT (x);
877 CHECK_NUMBER_OR_FLOAT (y);
879 return window_from_coordinates (f,
880 PIXEL_X_FROM_CANON_X (f, x),
881 PIXEL_Y_FROM_CANON_Y (f, y),
882 &part, 0);
885 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
886 doc: /* Return current value of point in WINDOW.
887 For a nonselected window, this is the value point would have
888 if that window were selected.
890 Note that, when WINDOW is the selected window and its buffer
891 is also currently selected, the value returned is the same as (point).
892 It would be more strictly correct to return the `top-level' value
893 of point, outside of any save-excursion forms.
894 But that is hard to define. */)
895 (window)
896 Lisp_Object window;
898 register struct window *w = decode_window (window);
900 if (w == XWINDOW (selected_window)
901 && current_buffer == XBUFFER (w->buffer))
902 return Fpoint ();
903 return Fmarker_position (w->pointm);
906 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
907 doc: /* Return position at which display currently starts in WINDOW.
908 This is updated by redisplay or by calling `set-window-start'. */)
909 (window)
910 Lisp_Object window;
912 return Fmarker_position (decode_window (window)->start);
915 /* This is text temporarily removed from the doc string below.
917 This function returns nil if the position is not currently known.
918 That happens when redisplay is preempted and doesn't finish.
919 If in that case you want to compute where the end of the window would
920 have been if redisplay had finished, do this:
921 (save-excursion
922 (goto-char (window-start window))
923 (vertical-motion (1- (window-height window)) window)
924 (point))") */
926 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
927 doc: /* Return position at which display currently ends in WINDOW.
928 This is updated by redisplay, when it runs to completion.
929 Simply changing the buffer text or setting `window-start'
930 does not update this value.
931 If UPDATE is non-nil, compute the up-to-date position
932 if it isn't already recorded. */)
933 (window, update)
934 Lisp_Object window, update;
936 Lisp_Object value;
937 struct window *w = decode_window (window);
938 Lisp_Object buf;
940 buf = w->buffer;
941 CHECK_BUFFER (buf);
943 #if 0 /* This change broke some things. We should make it later. */
944 /* If we don't know the end position, return nil.
945 The user can compute it with vertical-motion if he wants to.
946 It would be nicer to do it automatically,
947 but that's so slow that it would probably bother people. */
948 if (NILP (w->window_end_valid))
949 return Qnil;
950 #endif
952 if (! NILP (update)
953 && ! (! NILP (w->window_end_valid)
954 && XFASTINT (w->last_modified) >= MODIFF))
956 struct text_pos startp;
957 struct it it;
958 struct buffer *old_buffer = NULL, *b = XBUFFER (buf);
960 /* In case W->start is out of the range, use something
961 reasonable. This situation occurred when loading a file with
962 `-l' containing a call to `rmail' with subsequent other
963 commands. At the end, W->start happened to be BEG, while
964 rmail had already narrowed the buffer. */
965 if (XMARKER (w->start)->charpos < BEGV)
966 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
967 else if (XMARKER (w->start)->charpos > ZV)
968 SET_TEXT_POS (startp, ZV, ZV_BYTE);
969 else
970 SET_TEXT_POS_FROM_MARKER (startp, w->start);
972 /* Cannot use Fvertical_motion because that function doesn't
973 cope with variable-height lines. */
974 if (b != current_buffer)
976 old_buffer = current_buffer;
977 set_buffer_internal (b);
980 start_display (&it, w, startp);
981 move_it_vertically (&it, window_box_height (w));
982 if (it.current_y < it.last_visible_y)
983 move_it_past_eol (&it);
984 value = make_number (IT_CHARPOS (it));
986 if (old_buffer)
987 set_buffer_internal (old_buffer);
989 else
990 XSETINT (value, BUF_Z (XBUFFER (buf)) - XFASTINT (w->window_end_pos));
992 return value;
995 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
996 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer. */)
997 (window, pos)
998 Lisp_Object window, pos;
1000 register struct window *w = decode_window (window);
1002 CHECK_NUMBER_COERCE_MARKER (pos);
1003 if (w == XWINDOW (selected_window)
1004 && XBUFFER (w->buffer) == current_buffer)
1005 Fgoto_char (pos);
1006 else
1007 set_marker_restricted (w->pointm, pos, w->buffer);
1009 /* We have to make sure that redisplay updates the window to show
1010 the new value of point. */
1011 if (!EQ (window, selected_window))
1012 ++windows_or_buffers_changed;
1014 return pos;
1017 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1018 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1019 Optional third arg NOFORCE non-nil inhibits next redisplay
1020 from overriding motion of point in order to display at this exact start. */)
1021 (window, pos, noforce)
1022 Lisp_Object window, pos, noforce;
1024 register struct window *w = decode_window (window);
1026 CHECK_NUMBER_COERCE_MARKER (pos);
1027 set_marker_restricted (w->start, pos, w->buffer);
1028 /* this is not right, but much easier than doing what is right. */
1029 w->start_at_line_beg = Qnil;
1030 if (NILP (noforce))
1031 w->force_start = Qt;
1032 w->update_mode_line = Qt;
1033 XSETFASTINT (w->last_modified, 0);
1034 XSETFASTINT (w->last_overlay_modified, 0);
1035 if (!EQ (window, selected_window))
1036 windows_or_buffers_changed++;
1038 return pos;
1041 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1042 1, 1, 0,
1043 doc: /* Return WINDOW's dedicated object, usually t or nil.
1044 See also `set-window-dedicated-p'. */)
1045 (window)
1046 Lisp_Object window;
1048 return decode_window (window)->dedicated;
1051 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1052 Sset_window_dedicated_p, 2, 2, 0,
1053 doc: /* Control whether WINDOW is dedicated to the buffer it displays.
1054 If it is dedicated, Emacs will not automatically change
1055 which buffer appears in it.
1056 The second argument is the new value for the dedication flag;
1057 non-nil means yes. */)
1058 (window, arg)
1059 Lisp_Object window, arg;
1061 register struct window *w = decode_window (window);
1063 if (NILP (arg))
1064 w->dedicated = Qnil;
1065 else
1066 w->dedicated = Qt;
1068 return w->dedicated;
1071 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1072 0, 1, 0,
1073 doc: /* Return the display-table that WINDOW is using. */)
1074 (window)
1075 Lisp_Object window;
1077 return decode_window (window)->display_table;
1080 /* Get the display table for use on window W. This is either W's
1081 display table or W's buffer's display table. Ignore the specified
1082 tables if they are not valid; if no valid table is specified,
1083 return 0. */
1085 struct Lisp_Char_Table *
1086 window_display_table (w)
1087 struct window *w;
1089 struct Lisp_Char_Table *dp = NULL;
1091 if (DISP_TABLE_P (w->display_table))
1092 dp = XCHAR_TABLE (w->display_table);
1093 else if (BUFFERP (w->buffer))
1095 struct buffer *b = XBUFFER (w->buffer);
1097 if (DISP_TABLE_P (b->display_table))
1098 dp = XCHAR_TABLE (b->display_table);
1099 else if (DISP_TABLE_P (Vstandard_display_table))
1100 dp = XCHAR_TABLE (Vstandard_display_table);
1103 return dp;
1106 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1107 doc: /* Set WINDOW's display-table to TABLE. */)
1108 (window, table)
1109 register Lisp_Object window, table;
1111 register struct window *w;
1113 w = decode_window (window);
1114 w->display_table = table;
1115 return table;
1118 /* Record info on buffer window w is displaying
1119 when it is about to cease to display that buffer. */
1120 static void
1121 unshow_buffer (w)
1122 register struct window *w;
1124 Lisp_Object buf;
1125 struct buffer *b;
1127 buf = w->buffer;
1128 b = XBUFFER (buf);
1129 if (b != XMARKER (w->pointm)->buffer)
1130 abort ();
1132 #if 0
1133 if (w == XWINDOW (selected_window)
1134 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1135 /* Do this except when the selected window's buffer
1136 is being removed from some other window. */
1137 #endif
1138 /* last_window_start records the start position that this buffer
1139 had in the last window to be disconnected from it.
1140 Now that this statement is unconditional,
1141 it is possible for the buffer to be displayed in the
1142 selected window, while last_window_start reflects another
1143 window which was recently showing the same buffer.
1144 Some people might say that might be a good thing. Let's see. */
1145 b->last_window_start = marker_position (w->start);
1147 /* Point in the selected window's buffer
1148 is actually stored in that buffer, and the window's pointm isn't used.
1149 So don't clobber point in that buffer. */
1150 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1151 /* This line helps to fix Horsley's testbug.el bug. */
1152 && !(WINDOWP (b->last_selected_window)
1153 && w != XWINDOW (b->last_selected_window)
1154 && EQ (buf, XWINDOW (b->last_selected_window)->buffer)))
1155 temp_set_point_both (b,
1156 clip_to_bounds (BUF_BEGV (b),
1157 XMARKER (w->pointm)->charpos,
1158 BUF_ZV (b)),
1159 clip_to_bounds (BUF_BEGV_BYTE (b),
1160 marker_byte_position (w->pointm),
1161 BUF_ZV_BYTE (b)));
1163 if (WINDOWP (b->last_selected_window)
1164 && w == XWINDOW (b->last_selected_window))
1165 b->last_selected_window = Qnil;
1168 /* Put replacement into the window structure in place of old. */
1169 static void
1170 replace_window (old, replacement)
1171 Lisp_Object old, replacement;
1173 register Lisp_Object tem;
1174 register struct window *o = XWINDOW (old), *p = XWINDOW (replacement);
1176 /* If OLD is its frame's root_window, then replacement is the new
1177 root_window for that frame. */
1179 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1180 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
1182 p->left = o->left;
1183 p->top = o->top;
1184 p->width = o->width;
1185 p->height = o->height;
1186 p->desired_matrix = p->current_matrix = 0;
1187 p->vscroll = 0;
1188 bzero (&p->cursor, sizeof (p->cursor));
1189 bzero (&p->last_cursor, sizeof (p->last_cursor));
1190 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
1191 p->phys_cursor_type = -1;
1192 p->phys_cursor_width = -1;
1193 p->must_be_updated_p = 0;
1194 p->pseudo_window_p = 0;
1195 XSETFASTINT (p->window_end_vpos, 0);
1196 XSETFASTINT (p->window_end_pos, 0);
1197 p->window_end_valid = Qnil;
1198 p->frozen_window_start_p = 0;
1199 p->orig_top = p->orig_height = Qnil;
1201 p->next = tem = o->next;
1202 if (!NILP (tem))
1203 XWINDOW (tem)->prev = replacement;
1205 p->prev = tem = o->prev;
1206 if (!NILP (tem))
1207 XWINDOW (tem)->next = replacement;
1209 p->parent = tem = o->parent;
1210 if (!NILP (tem))
1212 if (EQ (XWINDOW (tem)->vchild, old))
1213 XWINDOW (tem)->vchild = replacement;
1214 if (EQ (XWINDOW (tem)->hchild, old))
1215 XWINDOW (tem)->hchild = replacement;
1218 /*** Here, if replacement is a vertical combination
1219 and so is its new parent, we should make replacement's
1220 children be children of that parent instead. ***/
1223 DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
1224 doc: /* Remove WINDOW from the display. Default is selected window. */)
1225 (window)
1226 register Lisp_Object window;
1228 delete_window (window);
1230 if (! NILP (Vwindow_configuration_change_hook)
1231 && ! NILP (Vrun_hooks))
1232 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
1234 return Qnil;
1237 void
1238 delete_window (window)
1239 register Lisp_Object window;
1241 register Lisp_Object tem, parent, sib;
1242 register struct window *p;
1243 register struct window *par;
1244 struct frame *f;
1246 /* Because this function is called by other C code on non-leaf
1247 windows, the CHECK_LIVE_WINDOW macro would choke inappropriately,
1248 so we can't decode_window here. */
1249 if (NILP (window))
1250 window = selected_window;
1251 else
1252 CHECK_WINDOW (window);
1253 p = XWINDOW (window);
1255 /* It's okay to delete an already-deleted window. */
1256 if (NILP (p->buffer)
1257 && NILP (p->hchild)
1258 && NILP (p->vchild))
1259 return;
1261 parent = p->parent;
1262 if (NILP (parent))
1263 error ("Attempt to delete minibuffer or sole ordinary window");
1264 par = XWINDOW (parent);
1266 windows_or_buffers_changed++;
1267 Vwindow_list = Qnil;
1268 f = XFRAME (WINDOW_FRAME (p));
1269 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
1271 /* Are we trying to delete any frame's selected window? */
1273 Lisp_Object swindow, pwindow;
1275 /* See if the frame's selected window is either WINDOW
1276 or any subwindow of it, by finding all that window's parents
1277 and comparing each one with WINDOW. */
1278 swindow = FRAME_SELECTED_WINDOW (f);
1280 while (1)
1282 pwindow = swindow;
1283 while (!NILP (pwindow))
1285 if (EQ (window, pwindow))
1286 break;
1287 pwindow = XWINDOW (pwindow)->parent;
1290 /* If the window being deleted is not a parent of SWINDOW,
1291 then SWINDOW is ok as the new selected window. */
1292 if (!EQ (window, pwindow))
1293 break;
1294 /* Otherwise, try another window for SWINDOW. */
1295 swindow = Fnext_window (swindow, Qlambda, Qnil);;
1297 /* If we get back to the frame's selected window,
1298 it means there was no acceptable alternative,
1299 so we cannot delete. */
1300 if (EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1301 error ("Cannot delete window");
1304 /* If we need to change SWINDOW, do it. */
1305 if (! EQ (swindow, FRAME_SELECTED_WINDOW (f)))
1307 /* If we're about to delete the selected window on the
1308 selected frame, then we should use Fselect_window to select
1309 the new window. On the other hand, if we're about to
1310 delete the selected window on any other frame, we shouldn't do
1311 anything but set the frame's selected_window slot. */
1312 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
1313 Fselect_window (swindow);
1314 else
1315 FRAME_SELECTED_WINDOW (f) = swindow;
1319 tem = p->buffer;
1320 /* tem is null for dummy parent windows
1321 (which have inferiors but not any contents themselves) */
1322 if (!NILP (tem))
1324 unshow_buffer (p);
1325 unchain_marker (p->pointm);
1326 unchain_marker (p->start);
1329 /* Free window glyph matrices. It is sure that they are allocated
1330 again when ADJUST_GLYPHS is called. Block input so that expose
1331 events and other events that access glyph matrices are not
1332 processed while we are changing them. */
1333 BLOCK_INPUT;
1334 free_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)));
1336 tem = p->next;
1337 if (!NILP (tem))
1338 XWINDOW (tem)->prev = p->prev;
1340 tem = p->prev;
1341 if (!NILP (tem))
1342 XWINDOW (tem)->next = p->next;
1344 if (EQ (window, par->hchild))
1345 par->hchild = p->next;
1346 if (EQ (window, par->vchild))
1347 par->vchild = p->next;
1349 /* Find one of our siblings to give our space to. */
1350 sib = p->prev;
1351 if (NILP (sib))
1353 /* If p gives its space to its next sibling, that sibling needs
1354 to have its top/left side pulled back to where p's is.
1355 set_window_{height,width} will re-position the sibling's
1356 children. */
1357 sib = p->next;
1358 XWINDOW (sib)->top = p->top;
1359 XWINDOW (sib)->left = p->left;
1362 /* Stretch that sibling. */
1363 if (!NILP (par->vchild))
1364 set_window_height (sib,
1365 XFASTINT (XWINDOW (sib)->height) + XFASTINT (p->height),
1367 if (!NILP (par->hchild))
1368 set_window_width (sib,
1369 XFASTINT (XWINDOW (sib)->width) + XFASTINT (p->width),
1372 /* If parent now has only one child,
1373 put the child into the parent's place. */
1374 tem = par->hchild;
1375 if (NILP (tem))
1376 tem = par->vchild;
1377 if (NILP (XWINDOW (tem)->next))
1378 replace_window (parent, tem);
1380 /* Since we may be deleting combination windows, we must make sure that
1381 not only p but all its children have been marked as deleted. */
1382 if (! NILP (p->hchild))
1383 delete_all_subwindows (XWINDOW (p->hchild));
1384 else if (! NILP (p->vchild))
1385 delete_all_subwindows (XWINDOW (p->vchild));
1387 /* Mark this window as deleted. */
1388 p->buffer = p->hchild = p->vchild = Qnil;
1390 /* Adjust glyph matrices. */
1391 adjust_glyphs (f);
1392 UNBLOCK_INPUT;
1397 /***********************************************************************
1398 Window List
1399 ***********************************************************************/
1401 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1402 pointer. This is a callback function for foreach_window, used in
1403 function window_list. */
1405 static int
1406 add_window_to_list (w, user_data)
1407 struct window *w;
1408 void *user_data;
1410 Lisp_Object *list = (Lisp_Object *) user_data;
1411 Lisp_Object window;
1412 XSETWINDOW (window, w);
1413 *list = Fcons (window, *list);
1414 return 1;
1418 /* Return a list of all windows, for use by next_window. If
1419 Vwindow_list is a list, return that list. Otherwise, build a new
1420 list, cache it in Vwindow_list, and return that. */
1422 static Lisp_Object
1423 window_list ()
1425 if (!CONSP (Vwindow_list))
1427 Lisp_Object tail;
1429 Vwindow_list = Qnil;
1430 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1432 Lisp_Object args[2];
1434 /* We are visiting windows in canonical order, and add
1435 new windows at the front of args[1], which means we
1436 have to reverse this list at the end. */
1437 args[1] = Qnil;
1438 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1439 args[0] = Vwindow_list;
1440 args[1] = Fnreverse (args[1]);
1441 Vwindow_list = Fnconc (2, args);
1445 return Vwindow_list;
1449 /* Value is non-zero if WINDOW satisfies the constraints given by
1450 OWINDOW, MINIBUF and ALL_FRAMES.
1452 MINIBUF t means WINDOW may be minibuffer windows.
1453 `lambda' means WINDOW may not be a minibuffer window.
1454 a window means a specific minibuffer window
1456 ALL_FRAMES t means search all frames,
1457 nil means search just current frame,
1458 `visible' means search just visible frames,
1459 0 means search visible and iconified frames,
1460 a window means search the frame that window belongs to,
1461 a frame means consider windows on that frame, only. */
1463 static int
1464 candidate_window_p (window, owindow, minibuf, all_frames)
1465 Lisp_Object window, owindow, minibuf, all_frames;
1467 struct window *w = XWINDOW (window);
1468 struct frame *f = XFRAME (w->frame);
1469 int candidate_p = 1;
1471 if (!BUFFERP (w->buffer))
1472 candidate_p = 0;
1473 else if (MINI_WINDOW_P (w)
1474 && (EQ (minibuf, Qlambda)
1475 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
1477 /* If MINIBUF is `lambda' don't consider any mini-windows.
1478 If it is a window, consider only that one. */
1479 candidate_p = 0;
1481 else if (EQ (all_frames, Qt))
1482 candidate_p = 1;
1483 else if (NILP (all_frames))
1485 xassert (WINDOWP (owindow));
1486 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
1488 else if (EQ (all_frames, Qvisible))
1490 FRAME_SAMPLE_VISIBILITY (f);
1491 candidate_p = FRAME_VISIBLE_P (f);
1493 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
1495 FRAME_SAMPLE_VISIBILITY (f);
1496 candidate_p = FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f);
1498 else if (WINDOWP (all_frames))
1499 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
1500 || EQ (XWINDOW (all_frames)->frame, w->frame)
1501 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
1502 else if (FRAMEP (all_frames))
1503 candidate_p = EQ (all_frames, w->frame);
1505 return candidate_p;
1509 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
1510 Fwindow_list. See there for the meaning of WINDOW, MINIBUF, and
1511 ALL_FRAMES. */
1513 static void
1514 decode_next_window_args (window, minibuf, all_frames)
1515 Lisp_Object *window, *minibuf, *all_frames;
1517 if (NILP (*window))
1518 *window = selected_window;
1519 else
1520 CHECK_LIVE_WINDOW (*window);
1522 /* MINIBUF nil may or may not include minibuffers. Decide if it
1523 does. */
1524 if (NILP (*minibuf))
1525 *minibuf = minibuf_level ? minibuf_window : Qlambda;
1526 else if (!EQ (*minibuf, Qt))
1527 *minibuf = Qlambda;
1529 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
1530 => count none of them, or a specific minibuffer window (the
1531 active one) to count. */
1533 /* ALL_FRAMES nil doesn't specify which frames to include. */
1534 if (NILP (*all_frames))
1535 *all_frames = (!EQ (*minibuf, Qlambda)
1536 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
1537 : Qnil);
1538 else if (EQ (*all_frames, Qvisible))
1540 else if (XFASTINT (*all_frames) == 0)
1542 else if (FRAMEP (*all_frames))
1544 else if (!EQ (*all_frames, Qt))
1545 *all_frames = Qnil;
1547 /* Now *ALL_FRAMES is t meaning search all frames, nil meaning
1548 search just current frame, `visible' meaning search just visible
1549 frames, 0 meaning search visible and iconified frames, or a
1550 window, meaning search the frame that window belongs to, or a
1551 frame, meaning consider windows on that frame, only. */
1555 /* Return the next or previous window of WINDOW in canonical ordering
1556 of windows. NEXT_P non-zero means return the next window. See the
1557 documentation string of next-window for the meaning of MINIBUF and
1558 ALL_FRAMES. */
1560 static Lisp_Object
1561 next_window (window, minibuf, all_frames, next_p)
1562 Lisp_Object window, minibuf, all_frames;
1563 int next_p;
1565 decode_next_window_args (&window, &minibuf, &all_frames);
1567 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
1568 return the first window on the frame. */
1569 if (FRAMEP (all_frames)
1570 && !EQ (all_frames, XWINDOW (window)->frame))
1571 return Fframe_first_window (all_frames);
1573 if (next_p)
1575 Lisp_Object list;
1577 /* Find WINDOW in the list of all windows. */
1578 list = Fmemq (window, window_list ());
1580 /* Scan forward from WINDOW to the end of the window list. */
1581 if (CONSP (list))
1582 for (list = XCDR (list); CONSP (list); list = XCDR (list))
1583 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1584 break;
1586 /* Scan from the start of the window list up to WINDOW. */
1587 if (!CONSP (list))
1588 for (list = Vwindow_list;
1589 CONSP (list) && !EQ (XCAR (list), window);
1590 list = XCDR (list))
1591 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1592 break;
1594 if (CONSP (list))
1595 window = XCAR (list);
1597 else
1599 Lisp_Object candidate, list;
1601 /* Scan through the list of windows for candidates. If there are
1602 candidate windows in front of WINDOW, the last one of these
1603 is the one we want. If there are candidates following WINDOW
1604 in the list, again the last one of these is the one we want. */
1605 candidate = Qnil;
1606 for (list = window_list (); CONSP (list); list = XCDR (list))
1608 if (EQ (XCAR (list), window))
1610 if (WINDOWP (candidate))
1611 break;
1613 else if (candidate_window_p (XCAR (list), window, minibuf,
1614 all_frames))
1615 candidate = XCAR (list);
1618 if (WINDOWP (candidate))
1619 window = candidate;
1622 return window;
1626 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
1627 doc: /* Return next window after WINDOW in canonical ordering of windows.
1628 If omitted, WINDOW defaults to the selected window.
1630 Optional second arg MINIBUF t means count the minibuffer window even
1631 if not active. MINIBUF nil or omitted means count the minibuffer iff
1632 it is active. MINIBUF neither t nor nil means not to count the
1633 minibuffer even if it is active.
1635 Several frames may share a single minibuffer; if the minibuffer
1636 counts, all windows on all frames that share that minibuffer count
1637 too. Therefore, `next-window' can be used to iterate through the
1638 set of windows even when the minibuffer is on another frame. If the
1639 minibuffer does not count, only windows from WINDOW's frame count.
1641 Optional third arg ALL-FRAMES t means include windows on all frames.
1642 ALL-FRAMES nil or omitted means cycle within the frames as specified
1643 above. ALL-FRAMES = `visible' means include windows on all visible frames.
1644 ALL-FRAMES = 0 means include windows on all visible and iconified frames.
1645 If ALL-FRAMES is a frame, restrict search to windows on that frame.
1646 Anything else means restrict to WINDOW's frame.
1648 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
1649 `next-window' to iterate through the entire cycle of acceptable
1650 windows, eventually ending up back at the window you started with.
1651 `previous-window' traverses the same cycle, in the reverse order. */)
1652 (window, minibuf, all_frames)
1653 Lisp_Object window, minibuf, all_frames;
1655 return next_window (window, minibuf, all_frames, 1);
1659 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
1660 doc: /* Return the window preceding WINDOW in canonical ordering of windows.
1661 If omitted, WINDOW defaults to the selected window.
1663 Optional second arg MINIBUF t means count the minibuffer window even
1664 if not active. MINIBUF nil or omitted means count the minibuffer iff
1665 it is active. MINIBUF neither t nor nil means not to count the
1666 minibuffer even if it is active.
1668 Several frames may share a single minibuffer; if the minibuffer
1669 counts, all windows on all frames that share that minibuffer count
1670 too. Therefore, `previous-window' can be used to iterate through
1671 the set of windows even when the minibuffer is on another frame. If
1672 the minibuffer does not count, only windows from WINDOW's frame count
1674 Optional third arg ALL-FRAMES t means include windows on all frames.
1675 ALL-FRAMES nil or omitted means cycle within the frames as specified
1676 above. ALL-FRAMES = `visible' means include windows on all visible frames.
1677 ALL-FRAMES = 0 means include windows on all visible and iconified frames.
1678 If ALL-FRAMES is a frame, restrict search to windows on that frame.
1679 Anything else means restrict to WINDOW's frame.
1681 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
1682 `previous-window' to iterate through the entire cycle of acceptable
1683 windows, eventually ending up back at the window you started with.
1684 `next-window' traverses the same cycle, in the reverse order. */)
1685 (window, minibuf, all_frames)
1686 Lisp_Object window, minibuf, all_frames;
1688 return next_window (window, minibuf, all_frames, 0);
1692 DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
1693 doc: /* Select the ARG'th different window on this frame.
1694 All windows on current frame are arranged in a cyclic order.
1695 This command selects the window ARG steps away in that order.
1696 A negative ARG moves in the opposite order. If the optional second
1697 argument ALL_FRAMES is non-nil, cycle through all frames. */)
1698 (arg, all_frames)
1699 Lisp_Object arg, all_frames;
1701 Lisp_Object window;
1702 int i;
1704 CHECK_NUMBER (arg);
1705 window = selected_window;
1707 for (i = XINT (arg); i > 0; --i)
1708 window = Fnext_window (window, Qnil, all_frames);
1709 for (; i < 0; ++i)
1710 window = Fprevious_window (window, Qnil, all_frames);
1712 Fselect_window (window);
1713 return Qnil;
1717 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
1718 doc: /* Return a list of windows on FRAME, starting with WINDOW.
1719 FRAME nil or omitted means use the selected frame.
1720 WINDOW nil or omitted means use the selected window.
1721 MINIBUF t means include the minibuffer window, even if it isn't active.
1722 MINIBUF nil or omitted means include the minibuffer window only
1723 if it's active.
1724 MINIBUF neither nil nor t means never include the minibuffer window. */)
1725 (frame, minibuf, window)
1726 Lisp_Object frame, minibuf, window;
1728 if (NILP (window))
1729 window = selected_window;
1730 if (NILP (frame))
1731 frame = selected_frame;
1733 if (!EQ (frame, XWINDOW (window)->frame))
1734 error ("Window is on a different frame");
1736 return window_list_1 (window, minibuf, frame);
1740 /* Return a list of windows in canonical ordering. Arguments are like
1741 for `next-window'. */
1743 static Lisp_Object
1744 window_list_1 (window, minibuf, all_frames)
1745 Lisp_Object window, minibuf, all_frames;
1747 Lisp_Object tail, list;
1749 decode_next_window_args (&window, &minibuf, &all_frames);
1750 list = Qnil;
1752 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
1753 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
1754 list = Fcons (XCAR (tail), list);
1756 return Fnreverse (list);
1761 /* Look at all windows, performing an operation specified by TYPE
1762 with argument OBJ.
1763 If FRAMES is Qt, look at all frames;
1764 Qnil, look at just the selected frame;
1765 Qvisible, look at visible frames;
1766 a frame, just look at windows on that frame.
1767 If MINI is non-zero, perform the operation on minibuffer windows too. */
1769 enum window_loop
1771 WINDOW_LOOP_UNUSED,
1772 GET_BUFFER_WINDOW, /* Arg is buffer */
1773 GET_LRU_WINDOW, /* Arg is t for full-width windows only */
1774 DELETE_OTHER_WINDOWS, /* Arg is window not to delete */
1775 DELETE_BUFFER_WINDOWS, /* Arg is buffer */
1776 GET_LARGEST_WINDOW,
1777 UNSHOW_BUFFER, /* Arg is buffer */
1778 CHECK_ALL_WINDOWS
1781 static Lisp_Object
1782 window_loop (type, obj, mini, frames)
1783 enum window_loop type;
1784 Lisp_Object obj, frames;
1785 int mini;
1787 Lisp_Object window, windows, best_window, frame_arg;
1788 struct frame *f;
1789 struct gcpro gcpro1;
1791 /* If we're only looping through windows on a particular frame,
1792 frame points to that frame. If we're looping through windows
1793 on all frames, frame is 0. */
1794 if (FRAMEP (frames))
1795 f = XFRAME (frames);
1796 else if (NILP (frames))
1797 f = SELECTED_FRAME ();
1798 else
1799 f = NULL;
1801 if (f)
1802 frame_arg = Qlambda;
1803 else if (XFASTINT (frames) == 0)
1804 frame_arg = frames;
1805 else if (EQ (frames, Qvisible))
1806 frame_arg = frames;
1807 else
1808 frame_arg = Qt;
1810 /* frame_arg is Qlambda to stick to one frame,
1811 Qvisible to consider all visible frames,
1812 or Qt otherwise. */
1814 /* Pick a window to start with. */
1815 if (WINDOWP (obj))
1816 window = obj;
1817 else if (f)
1818 window = FRAME_SELECTED_WINDOW (f);
1819 else
1820 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
1822 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
1823 GCPRO1 (windows);
1824 best_window = Qnil;
1826 for (; CONSP (windows); windows = CDR (windows))
1828 struct window *w;
1830 window = XCAR (windows);
1831 w = XWINDOW (window);
1833 /* Note that we do not pay attention here to whether the frame
1834 is visible, since Fwindow_list skips non-visible frames if
1835 that is desired, under the control of frame_arg. */
1836 if (!MINI_WINDOW_P (w)
1837 /* For UNSHOW_BUFFER, we must always consider all windows. */
1838 || type == UNSHOW_BUFFER
1839 || (mini && minibuf_level > 0))
1840 switch (type)
1842 case GET_BUFFER_WINDOW:
1843 if (EQ (w->buffer, obj)
1844 /* Don't find any minibuffer window
1845 except the one that is currently in use. */
1846 && (MINI_WINDOW_P (w)
1847 ? EQ (window, minibuf_window)
1848 : 1))
1850 if (NILP (best_window))
1851 best_window = window;
1852 else if (EQ (window, selected_window))
1853 /* For compatibility with 20.x, prefer to return
1854 selected-window. */
1855 best_window = window;
1857 break;
1859 case GET_LRU_WINDOW:
1860 /* t as arg means consider only full-width windows */
1861 if (!NILP (obj) && !WINDOW_FULL_WIDTH_P (w))
1862 break;
1863 /* Ignore dedicated windows and minibuffers. */
1864 if (MINI_WINDOW_P (w) || EQ (w->dedicated, Qt))
1865 break;
1866 if (NILP (best_window)
1867 || (XFASTINT (XWINDOW (best_window)->use_time)
1868 > XFASTINT (w->use_time)))
1869 best_window = window;
1870 break;
1872 case DELETE_OTHER_WINDOWS:
1873 if (!EQ (window, obj))
1874 Fdelete_window (window);
1875 break;
1877 case DELETE_BUFFER_WINDOWS:
1878 if (EQ (w->buffer, obj))
1880 struct frame *f = XFRAME (WINDOW_FRAME (w));
1882 /* If this window is dedicated, and in a frame of its own,
1883 kill the frame. */
1884 if (EQ (window, FRAME_ROOT_WINDOW (f))
1885 && !NILP (w->dedicated)
1886 && other_visible_frames (f))
1888 /* Skip the other windows on this frame.
1889 There might be one, the minibuffer! */
1890 while (CONSP (XCDR (windows))
1891 && EQ (XWINDOW (XCAR (windows))->frame,
1892 XWINDOW (XCAR (XCDR (windows)))->frame))
1893 windows = XCDR (windows);
1895 /* Now we can safely delete the frame. */
1896 Fdelete_frame (w->frame, Qnil);
1898 else if (NILP (w->parent))
1900 /* If we're deleting the buffer displayed in the
1901 only window on the frame, find a new buffer to
1902 display there. */
1903 Lisp_Object buffer;
1904 buffer = Fother_buffer (obj, Qnil, w->frame);
1905 Fset_window_buffer (window, buffer);
1906 if (EQ (window, selected_window))
1907 Fset_buffer (w->buffer);
1909 else
1910 Fdelete_window (window);
1912 break;
1914 case GET_LARGEST_WINDOW:
1916 /* Ignore dedicated windows and minibuffers. */
1917 if (MINI_WINDOW_P (w) || EQ (w->dedicated, Qt))
1918 break;
1920 if (NILP (best_window))
1921 best_window = window;
1922 else
1924 struct window *b = XWINDOW (best_window);
1925 if (XFASTINT (w->height) * XFASTINT (w->width)
1926 > XFASTINT (b->height) * XFASTINT (b->width))
1927 best_window = window;
1930 break;
1932 case UNSHOW_BUFFER:
1933 if (EQ (w->buffer, obj))
1935 Lisp_Object buffer;
1936 struct frame *f = XFRAME (w->frame);
1938 /* Find another buffer to show in this window. */
1939 buffer = Fother_buffer (obj, Qnil, w->frame);
1941 /* If this window is dedicated, and in a frame of its own,
1942 kill the frame. */
1943 if (EQ (window, FRAME_ROOT_WINDOW (f))
1944 && !NILP (w->dedicated)
1945 && other_visible_frames (f))
1947 /* Skip the other windows on this frame.
1948 There might be one, the minibuffer! */
1949 while (CONSP (XCDR (windows))
1950 && EQ (XWINDOW (XCAR (windows))->frame,
1951 XWINDOW (XCAR (XCDR (windows)))->frame))
1952 windows = XCDR (windows);
1954 /* Now we can safely delete the frame. */
1955 Fdelete_frame (w->frame, Qnil);
1957 else if (!NILP (w->dedicated) && !NILP (w->parent))
1959 Lisp_Object window;
1960 XSETWINDOW (window, w);
1961 /* If this window is dedicated and not the only window
1962 in its frame, then kill it. */
1963 Fdelete_window (window);
1965 else
1967 /* Otherwise show a different buffer in the window. */
1968 w->dedicated = Qnil;
1969 Fset_window_buffer (window, buffer);
1970 if (EQ (window, selected_window))
1971 Fset_buffer (w->buffer);
1974 break;
1976 /* Check for a window that has a killed buffer. */
1977 case CHECK_ALL_WINDOWS:
1978 if (! NILP (w->buffer)
1979 && NILP (XBUFFER (w->buffer)->name))
1980 abort ();
1981 break;
1983 case WINDOW_LOOP_UNUSED:
1984 break;
1988 UNGCPRO;
1989 return best_window;
1992 /* Used for debugging. Abort if any window has a dead buffer. */
1994 void
1995 check_all_windows ()
1997 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2000 DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 1, 0,
2001 doc: /* Return the window least recently selected or used for display.
2002 If optional argument FRAME is `visible', search all visible frames.
2003 If FRAME is 0, search all visible and iconified frames.
2004 If FRAME is t, search all frames.
2005 If FRAME is nil, search only the selected frame.
2006 If FRAME is a frame, search only that frame. */)
2007 (frame)
2008 Lisp_Object frame;
2010 register Lisp_Object w;
2011 /* First try for a window that is full-width */
2012 w = window_loop (GET_LRU_WINDOW, Qt, 0, frame);
2013 if (!NILP (w) && !EQ (w, selected_window))
2014 return w;
2015 /* If none of them, try the rest */
2016 return window_loop (GET_LRU_WINDOW, Qnil, 0, frame);
2019 DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 1, 0,
2020 doc: /* Return the largest window in area.
2021 If optional argument FRAME is `visible', search all visible frames.
2022 If FRAME is 0, search all visible and iconified frames.
2023 If FRAME is t, search all frames.
2024 If FRAME is nil, search only the selected frame.
2025 If FRAME is a frame, search only that frame. */)
2026 (frame)
2027 Lisp_Object frame;
2029 return window_loop (GET_LARGEST_WINDOW, Qnil, 0,
2030 frame);
2033 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 1, 2, 0,
2034 doc: /* Return a window currently displaying BUFFER, or nil if none.
2035 If optional argument FRAME is `visible', search all visible frames.
2036 If optional argument FRAME is 0, search all visible and iconified frames.
2037 If FRAME is t, search all frames.
2038 If FRAME is nil, search only the selected frame.
2039 If FRAME is a frame, search only that frame. */)
2040 (buffer, frame)
2041 Lisp_Object buffer, frame;
2043 buffer = Fget_buffer (buffer);
2044 if (BUFFERP (buffer))
2045 return window_loop (GET_BUFFER_WINDOW, buffer, 1, frame);
2046 else
2047 return Qnil;
2050 DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
2051 0, 1, "",
2052 doc: /* Make WINDOW (or the selected window) fill its frame.
2053 Only the frame WINDOW is on is affected.
2054 This function tries to reduce display jumps
2055 by keeping the text previously visible in WINDOW
2056 in the same place on the frame. Doing this depends on
2057 the value of (window-start WINDOW), so if calling this function
2058 in a program gives strange scrolling, make sure the window-start
2059 value is reasonable when this function is called. */)
2060 (window)
2061 Lisp_Object window;
2063 struct window *w;
2064 int startpos;
2065 int top, new_top;
2067 if (NILP (window))
2068 window = selected_window;
2069 else
2070 CHECK_LIVE_WINDOW (window);
2071 w = XWINDOW (window);
2073 startpos = marker_position (w->start);
2074 top = XFASTINT (w->top) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2076 if (MINI_WINDOW_P (w) && top > 0)
2077 error ("Can't expand minibuffer to full frame");
2079 window_loop (DELETE_OTHER_WINDOWS, window, 0, WINDOW_FRAME (w));
2081 /* Try to minimize scrolling, by setting the window start to the point
2082 will cause the text at the old window start to be at the same place
2083 on the frame. But don't try to do this if the window start is
2084 outside the visible portion (as might happen when the display is
2085 not current, due to typeahead). */
2086 new_top = XFASTINT (w->top) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2087 if (new_top != top
2088 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2089 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2091 struct position pos;
2092 struct buffer *obuf = current_buffer;
2094 Fset_buffer (w->buffer);
2095 /* This computation used to temporarily move point, but that can
2096 have unwanted side effects due to text properties. */
2097 pos = *vmotion (startpos, -top, w);
2099 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2100 w->window_end_valid = Qnil;
2101 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2102 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2103 : Qnil);
2104 /* We need to do this, so that the window-scroll-functions
2105 get called. */
2106 w->optional_new_start = Qt;
2108 set_buffer_internal (obuf);
2111 return Qnil;
2114 DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
2115 1, 2, "bDelete windows on (buffer): ",
2116 doc: /* Delete all windows showing BUFFER.
2117 Optional second argument FRAME controls which frames are affected.
2118 If optional argument FRAME is `visible', search all visible frames.
2119 If FRAME is 0, search all visible and iconified frames.
2120 If FRAME is nil, search all frames.
2121 If FRAME is t, search only the selected frame.
2122 If FRAME is a frame, search only that frame. */)
2123 (buffer, frame)
2124 Lisp_Object buffer, frame;
2126 /* FRAME uses t and nil to mean the opposite of what window_loop
2127 expects. */
2128 if (NILP (frame))
2129 frame = Qt;
2130 else if (EQ (frame, Qt))
2131 frame = Qnil;
2133 if (!NILP (buffer))
2135 buffer = Fget_buffer (buffer);
2136 CHECK_BUFFER (buffer);
2137 window_loop (DELETE_BUFFER_WINDOWS, buffer, 0, frame);
2140 return Qnil;
2143 DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows,
2144 Sreplace_buffer_in_windows,
2145 1, 1, "bReplace buffer in windows: ",
2146 doc: /* Replace BUFFER with some other buffer in all windows showing it. */)
2147 (buffer)
2148 Lisp_Object buffer;
2150 if (!NILP (buffer))
2152 buffer = Fget_buffer (buffer);
2153 CHECK_BUFFER (buffer);
2154 window_loop (UNSHOW_BUFFER, buffer, 0, Qt);
2156 return Qnil;
2159 /* Replace BUFFER with some other buffer in all windows
2160 of all frames, even those on other keyboards. */
2162 void
2163 replace_buffer_in_all_windows (buffer)
2164 Lisp_Object buffer;
2166 #ifdef MULTI_KBOARD
2167 Lisp_Object tail, frame;
2169 /* A single call to window_loop won't do the job
2170 because it only considers frames on the current keyboard.
2171 So loop manually over frames, and handle each one. */
2172 FOR_EACH_FRAME (tail, frame)
2173 window_loop (UNSHOW_BUFFER, buffer, 1, frame);
2174 #else
2175 window_loop (UNSHOW_BUFFER, buffer, 1, Qt);
2176 #endif
2179 /* Set the height of WINDOW and all its inferiors. */
2181 /* The smallest acceptable dimensions for a window. Anything smaller
2182 might crash Emacs. */
2184 #define MIN_SAFE_WINDOW_WIDTH (2)
2185 #define MIN_SAFE_WINDOW_HEIGHT (1)
2187 /* Make sure that window_min_height and window_min_width are
2188 not too small; if they are, set them to safe minima. */
2190 static void
2191 check_min_window_sizes ()
2193 /* Smaller values might permit a crash. */
2194 if (window_min_width < MIN_SAFE_WINDOW_WIDTH)
2195 window_min_width = MIN_SAFE_WINDOW_WIDTH;
2196 if (window_min_height < MIN_SAFE_WINDOW_HEIGHT)
2197 window_min_height = MIN_SAFE_WINDOW_HEIGHT;
2200 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2201 minimum allowable size. */
2203 void
2204 check_frame_size (frame, rows, cols)
2205 FRAME_PTR frame;
2206 int *rows, *cols;
2208 /* For height, we have to see:
2209 how many windows the frame has at minimum (one or two),
2210 and whether it has a menu bar or other special stuff at the top. */
2211 int min_height
2212 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
2213 ? MIN_SAFE_WINDOW_HEIGHT
2214 : 2 * MIN_SAFE_WINDOW_HEIGHT);
2216 if (FRAME_TOP_MARGIN (frame) > 0)
2217 min_height += FRAME_TOP_MARGIN (frame);
2219 if (*rows < min_height)
2220 *rows = min_height;
2221 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2222 *cols = MIN_SAFE_WINDOW_WIDTH;
2226 /* Value is non-zero if window W is fixed-size. WIDTH_P non-zero means
2227 check if W's width can be changed, otherwise check W's height.
2228 CHECK_SIBLINGS_P non-zero means check resizablity of WINDOW's
2229 siblings, too. If none of the siblings is resizable, WINDOW isn't
2230 either. */
2232 static int
2233 window_fixed_size_p (w, width_p, check_siblings_p)
2234 struct window *w;
2235 int width_p, check_siblings_p;
2237 int fixed_p;
2238 struct window *c;
2240 if (!NILP (w->hchild))
2242 c = XWINDOW (w->hchild);
2244 if (width_p)
2246 /* A horiz. combination is fixed-width if all of if its
2247 children are. */
2248 while (c && window_fixed_size_p (c, width_p, 0))
2249 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2250 fixed_p = c == NULL;
2252 else
2254 /* A horiz. combination is fixed-height if one of if its
2255 children is. */
2256 while (c && !window_fixed_size_p (c, width_p, 0))
2257 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2258 fixed_p = c != NULL;
2261 else if (!NILP (w->vchild))
2263 c = XWINDOW (w->vchild);
2265 if (width_p)
2267 /* A vert. combination is fixed-width if one of if its
2268 children is. */
2269 while (c && !window_fixed_size_p (c, width_p, 0))
2270 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2271 fixed_p = c != NULL;
2273 else
2275 /* A vert. combination is fixed-height if all of if its
2276 children are. */
2277 while (c && window_fixed_size_p (c, width_p, 0))
2278 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2279 fixed_p = c == NULL;
2282 else if (BUFFERP (w->buffer))
2284 if (w->height_fixed_p && !width_p)
2285 fixed_p = 1;
2286 else
2288 struct buffer *old = current_buffer;
2289 Lisp_Object val;
2291 current_buffer = XBUFFER (w->buffer);
2292 val = find_symbol_value (Qwindow_size_fixed);
2293 current_buffer = old;
2295 fixed_p = 0;
2296 if (!EQ (val, Qunbound))
2298 fixed_p = !NILP (val);
2300 if (fixed_p
2301 && ((EQ (val, Qheight) && width_p)
2302 || (EQ (val, Qwidth) && !width_p)))
2303 fixed_p = 0;
2307 /* Can't tell if this one is resizable without looking at
2308 siblings. If all siblings are fixed-size this one is too. */
2309 if (!fixed_p && check_siblings_p && WINDOWP (w->parent))
2311 Lisp_Object child;
2313 for (child = w->prev; !NILP (child); child = XWINDOW (child)->prev)
2314 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2315 break;
2317 if (NILP (child))
2318 for (child = w->next; !NILP (child); child = XWINDOW (child)->next)
2319 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2320 break;
2322 if (NILP (child))
2323 fixed_p = 1;
2326 else
2327 fixed_p = 1;
2329 return fixed_p;
2333 /* Return the minimum size of window W, not taking fixed-width windows
2334 into account. WIDTH_P non-zero means return the minimum width,
2335 otherwise return the minimum height. If W is a combination window,
2336 compute the minimum size from the minimum sizes of W's children. */
2338 static int
2339 window_min_size_1 (w, width_p)
2340 struct window *w;
2341 int width_p;
2343 struct window *c;
2344 int size;
2346 if (!NILP (w->hchild))
2348 c = XWINDOW (w->hchild);
2349 size = 0;
2351 if (width_p)
2353 /* The min width of a horizontal combination is
2354 the sum of the min widths of its children. */
2355 while (c)
2357 size += window_min_size_1 (c, width_p);
2358 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2361 else
2363 /* The min height a horizontal combination equals
2364 the maximum of all min height of its children. */
2365 while (c)
2367 int min_size = window_min_size_1 (c, width_p);
2368 size = max (min_size, size);
2369 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2373 else if (!NILP (w->vchild))
2375 c = XWINDOW (w->vchild);
2376 size = 0;
2378 if (width_p)
2380 /* The min width of a vertical combination is
2381 the maximum of the min widths of its children. */
2382 while (c)
2384 int min_size = window_min_size_1 (c, width_p);
2385 size = max (min_size, size);
2386 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2389 else
2391 /* The min height of a vertical combination equals
2392 the sum of the min height of its children. */
2393 while (c)
2395 size += window_min_size_1 (c, width_p);
2396 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2400 else
2402 if (width_p)
2403 size = window_min_width;
2404 else
2406 if (MINI_WINDOW_P (w)
2407 || (!WINDOW_WANTS_MODELINE_P (w)
2408 && !WINDOW_WANTS_HEADER_LINE_P (w)))
2409 size = 1;
2410 else
2411 size = window_min_height;
2415 return size;
2419 /* Return the minimum size of window W, taking fixed-size windows into
2420 account. WIDTH_P non-zero means return the minimum width,
2421 otherwise return the minimum height. IGNORE_FIXED_P non-zero means
2422 ignore if W is fixed-size. Set *FIXED to 1 if W is fixed-size
2423 unless FIXED is null. */
2425 static int
2426 window_min_size (w, width_p, ignore_fixed_p, fixed)
2427 struct window *w;
2428 int width_p, ignore_fixed_p, *fixed;
2430 int size, fixed_p;
2432 if (ignore_fixed_p)
2433 fixed_p = 0;
2434 else
2435 fixed_p = window_fixed_size_p (w, width_p, 1);
2437 if (fixed)
2438 *fixed = fixed_p;
2440 if (fixed_p)
2441 size = width_p ? XFASTINT (w->width) : XFASTINT (w->height);
2442 else
2443 size = window_min_size_1 (w, width_p);
2445 return size;
2449 /* Set WINDOW's height or width to SIZE. WIDTH_P non-zero means set
2450 WINDOW's width. Resize WINDOW's children, if any, so that they
2451 keep their proportionate size relative to WINDOW. Propagate
2452 WINDOW's top or left edge position to children. Delete windows
2453 that become too small unless NODELETE_P is non-zero.
2455 If NODELETE_P is 2, that means we do delete windows that are
2456 too small, even if they were too small before! */
2458 static void
2459 size_window (window, size, width_p, nodelete_p)
2460 Lisp_Object window;
2461 int size, width_p, nodelete_p;
2463 struct window *w = XWINDOW (window);
2464 struct window *c;
2465 Lisp_Object child, *forward, *sideward;
2466 int old_size, min_size;
2468 if (nodelete_p == 2)
2469 nodelete_p = 0;
2471 check_min_window_sizes ();
2472 size = max (0, size);
2474 /* If the window has been "too small" at one point,
2475 don't delete it for being "too small" in the future.
2476 Preserve it as long as that is at all possible. */
2477 if (width_p)
2479 old_size = XINT (w->width);
2480 min_size = window_min_width;
2482 else
2484 old_size = XINT (w->height);
2485 min_size = window_min_height;
2488 if (old_size < min_size && nodelete_p != 2)
2489 w->too_small_ok = Qt;
2491 /* Maybe delete WINDOW if it's too small. */
2492 if (nodelete_p != 1 && !NILP (w->parent))
2494 if (!MINI_WINDOW_P (w) && !NILP (w->too_small_ok))
2495 min_size = width_p ? MIN_SAFE_WINDOW_WIDTH : MIN_SAFE_WINDOW_HEIGHT;
2496 else
2497 min_size = width_p ? window_min_width : window_min_height;
2499 if (size < min_size)
2501 delete_window (window);
2502 return;
2506 /* Set redisplay hints. */
2507 w->last_modified = make_number (0);
2508 w->last_overlay_modified = make_number (0);
2509 windows_or_buffers_changed++;
2510 FRAME_WINDOW_SIZES_CHANGED (XFRAME (w->frame)) = 1;
2512 if (width_p)
2514 sideward = &w->vchild;
2515 forward = &w->hchild;
2516 w->width = make_number (size);
2518 else
2520 sideward = &w->hchild;
2521 forward = &w->vchild;
2522 w->height = make_number (size);
2523 w->orig_height = Qnil;
2526 if (!NILP (*sideward))
2528 for (child = *sideward; !NILP (child); child = c->next)
2530 c = XWINDOW (child);
2531 if (width_p)
2532 c->left = w->left;
2533 else
2534 c->top = w->top;
2535 size_window (child, size, width_p, nodelete_p);
2538 else if (!NILP (*forward))
2540 int fixed_size, each, extra, n;
2541 int resize_fixed_p, nfixed;
2542 int last_pos, first_pos, nchildren, total;
2544 /* Determine the fixed-size portion of the this window, and the
2545 number of child windows. */
2546 fixed_size = nchildren = nfixed = total = 0;
2547 for (child = *forward; !NILP (child); child = c->next, ++nchildren)
2549 int child_size;
2551 c = XWINDOW (child);
2552 child_size = width_p ? XINT (c->width) : XINT (c->height);
2553 total += child_size;
2555 if (window_fixed_size_p (c, width_p, 0))
2557 fixed_size += child_size;
2558 ++nfixed;
2562 /* If the new size is smaller than fixed_size, or if there
2563 aren't any resizable windows, allow resizing fixed-size
2564 windows. */
2565 resize_fixed_p = nfixed == nchildren || size < fixed_size;
2567 /* Compute how many lines/columns to add to each child. The
2568 value of extra takes care of rounding errors. */
2569 n = resize_fixed_p ? nchildren : nchildren - nfixed;
2570 each = (size - total) / n;
2571 extra = (size - total) - n * each;
2573 /* Compute new children heights and edge positions. */
2574 first_pos = width_p ? XINT (w->left) : XINT (w->top);
2575 last_pos = first_pos;
2576 for (child = *forward; !NILP (child); child = c->next)
2578 int new_size, old_size;
2580 c = XWINDOW (child);
2581 old_size = width_p ? XFASTINT (c->width) : XFASTINT (c->height);
2582 new_size = old_size;
2584 /* The top or left edge position of this child equals the
2585 bottom or right edge of its predecessor. */
2586 if (width_p)
2587 c->left = make_number (last_pos);
2588 else
2589 c->top = make_number (last_pos);
2591 /* If this child can be resized, do it. */
2592 if (resize_fixed_p || !window_fixed_size_p (c, width_p, 0))
2594 new_size = old_size + each + extra;
2595 extra = 0;
2598 /* Set new height. Note that size_window also propagates
2599 edge positions to children, so it's not a no-op if we
2600 didn't change the child's size. */
2601 size_window (child, new_size, width_p, 1);
2603 /* Remember the bottom/right edge position of this child; it
2604 will be used to set the top/left edge of the next child. */
2605 last_pos += new_size;
2608 /* We should have covered the parent exactly with child windows. */
2609 xassert (size == last_pos - first_pos);
2611 /* Now delete any children that became too small. */
2612 if (!nodelete_p)
2613 for (child = *forward; !NILP (child); child = c->next)
2615 int child_size;
2616 c = XWINDOW (child);
2617 child_size = width_p ? XINT (c->width) : XINT (c->height);
2618 size_window (child, child_size, width_p, 2);
2623 /* Set WINDOW's height to HEIGHT, and recursively change the height of
2624 WINDOW's children. NODELETE non-zero means don't delete windows
2625 that become too small in the process. (The caller should check
2626 later and do so if appropriate.) */
2628 void
2629 set_window_height (window, height, nodelete)
2630 Lisp_Object window;
2631 int height;
2632 int nodelete;
2634 size_window (window, height, 0, nodelete);
2638 /* Set WINDOW's width to WIDTH, and recursively change the width of
2639 WINDOW's children. NODELETE non-zero means don't delete windows
2640 that become too small in the process. (The caller should check
2641 later and do so if appropriate.) */
2643 void
2644 set_window_width (window, width, nodelete)
2645 Lisp_Object window;
2646 int width;
2647 int nodelete;
2649 size_window (window, width, 1, nodelete);
2653 int window_select_count;
2655 Lisp_Object
2656 Fset_window_buffer_unwind (obuf)
2657 Lisp_Object obuf;
2659 Fset_buffer (obuf);
2660 return Qnil;
2664 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
2665 means it's allowed to run hooks. See make_frame for a case where
2666 it's not allowed. */
2668 void
2669 set_window_buffer (window, buffer, run_hooks_p)
2670 Lisp_Object window, buffer;
2671 int run_hooks_p;
2673 struct window *w = XWINDOW (window);
2674 struct buffer *b = XBUFFER (buffer);
2675 int count = SPECPDL_INDEX ();
2677 w->buffer = buffer;
2679 if (EQ (window, selected_window))
2680 b->last_selected_window = window;
2682 /* Update time stamps of buffer display. */
2683 if (INTEGERP (b->display_count))
2684 XSETINT (b->display_count, XINT (b->display_count) + 1);
2685 b->display_time = Fcurrent_time ();
2687 XSETFASTINT (w->window_end_pos, 0);
2688 XSETFASTINT (w->window_end_vpos, 0);
2689 bzero (&w->last_cursor, sizeof w->last_cursor);
2690 w->window_end_valid = Qnil;
2691 w->hscroll = w->min_hscroll = make_number (0);
2692 w->vscroll = 0;
2693 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
2694 set_marker_restricted (w->start,
2695 make_number (b->last_window_start),
2696 buffer);
2697 w->start_at_line_beg = Qnil;
2698 w->force_start = Qnil;
2699 XSETFASTINT (w->last_modified, 0);
2700 XSETFASTINT (w->last_overlay_modified, 0);
2701 windows_or_buffers_changed++;
2703 /* We must select BUFFER for running the window-scroll-functions.
2704 If WINDOW is selected, switch permanently.
2705 Otherwise, switch but go back to the ambient buffer afterward. */
2706 if (EQ (window, selected_window))
2707 Fset_buffer (buffer);
2708 /* We can't check ! NILP (Vwindow_scroll_functions) here
2709 because that might itself be a local variable. */
2710 else if (window_initialized)
2712 record_unwind_protect (Fset_window_buffer_unwind, Fcurrent_buffer ());
2713 Fset_buffer (buffer);
2716 /* Set left and right marginal area width from buffer. */
2717 Fset_window_margins (window, b->left_margin_width, b->right_margin_width);
2719 if (run_hooks_p)
2721 if (! NILP (Vwindow_scroll_functions))
2722 run_hook_with_args_2 (Qwindow_scroll_functions, window,
2723 Fmarker_position (w->start));
2725 if (! NILP (Vwindow_configuration_change_hook)
2726 && ! NILP (Vrun_hooks))
2727 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
2730 unbind_to (count, Qnil);
2734 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 2, 0,
2735 doc: /* Make WINDOW display BUFFER as its contents.
2736 BUFFER can be a buffer or buffer name. */)
2737 (window, buffer)
2738 register Lisp_Object window, buffer;
2740 register Lisp_Object tem;
2741 register struct window *w = decode_window (window);
2743 XSETWINDOW (window, w);
2744 buffer = Fget_buffer (buffer);
2745 CHECK_BUFFER (buffer);
2747 if (NILP (XBUFFER (buffer)->name))
2748 error ("Attempt to display deleted buffer");
2750 tem = w->buffer;
2751 if (NILP (tem))
2752 error ("Window is deleted");
2753 else if (! EQ (tem, Qt)) /* w->buffer is t when the window
2754 is first being set up. */
2756 if (!NILP (w->dedicated) && !EQ (tem, buffer))
2757 error ("Window is dedicated to `%s'",
2758 SDATA (XBUFFER (tem)->name));
2760 unshow_buffer (w);
2763 set_window_buffer (window, buffer, 1);
2764 return Qnil;
2767 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 1, 0,
2768 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
2769 If WINDOW is not already selected, also make WINDOW's buffer current.
2770 Also make WINDOW the frame's selected window.
2772 Note that the main editor command loop
2773 selects the buffer of the selected window before each command. */)
2774 (window)
2775 register Lisp_Object window;
2777 return select_window_1 (window, 1);
2780 /* Note that selected_window can be nil
2781 when this is called from Fset_window_configuration. */
2783 static Lisp_Object
2784 select_window_1 (window, recordflag)
2785 register Lisp_Object window;
2786 int recordflag;
2788 register struct window *w;
2789 register struct window *ow;
2790 struct frame *sf;
2792 CHECK_LIVE_WINDOW (window);
2794 w = XWINDOW (window);
2795 w->frozen_window_start_p = 0;
2797 XSETFASTINT (w->use_time, ++window_select_count);
2798 if (EQ (window, selected_window))
2799 return window;
2801 if (!NILP (selected_window))
2803 ow = XWINDOW (selected_window);
2804 if (! NILP (ow->buffer))
2805 set_marker_both (ow->pointm, ow->buffer,
2806 BUF_PT (XBUFFER (ow->buffer)),
2807 BUF_PT_BYTE (XBUFFER (ow->buffer)));
2810 selected_window = window;
2811 sf = SELECTED_FRAME ();
2812 if (XFRAME (WINDOW_FRAME (w)) != sf)
2814 XFRAME (WINDOW_FRAME (w))->selected_window = window;
2815 /* Use this rather than Fhandle_switch_frame
2816 so that FRAME_FOCUS_FRAME is moved appropriately as we
2817 move around in the state where a minibuffer in a separate
2818 frame is active. */
2819 Fselect_frame (WINDOW_FRAME (w), Qnil);
2821 else
2822 sf->selected_window = window;
2824 if (recordflag)
2825 record_buffer (w->buffer);
2826 Fset_buffer (w->buffer);
2828 XBUFFER (w->buffer)->last_selected_window = window;
2830 /* Go to the point recorded in the window.
2831 This is important when the buffer is in more
2832 than one window. It also matters when
2833 redisplay_window has altered point after scrolling,
2834 because it makes the change only in the window. */
2836 register int new_point = marker_position (w->pointm);
2837 if (new_point < BEGV)
2838 SET_PT (BEGV);
2839 else if (new_point > ZV)
2840 SET_PT (ZV);
2841 else
2842 SET_PT (new_point);
2845 windows_or_buffers_changed++;
2846 return window;
2849 /* Deiconify the frame containing the window WINDOW,
2850 unless it is the selected frame;
2851 then return WINDOW.
2853 The reason for the exception for the selected frame
2854 is that it seems better not to change the selected frames visibility
2855 merely because of displaying a different buffer in it.
2856 The deiconification is useful when a buffer gets shown in
2857 another frame that you were not using lately. */
2859 static Lisp_Object
2860 display_buffer_1 (window)
2861 Lisp_Object window;
2863 Lisp_Object frame = XWINDOW (window)->frame;
2864 FRAME_PTR f = XFRAME (frame);
2866 FRAME_SAMPLE_VISIBILITY (f);
2868 if (!EQ (frame, selected_frame))
2870 if (FRAME_ICONIFIED_P (f))
2871 Fmake_frame_visible (frame);
2872 else if (FRAME_VISIBLE_P (f))
2873 Fraise_frame (frame);
2876 return window;
2879 DEFUN ("special-display-p", Fspecial_display_p, Sspecial_display_p, 1, 1, 0,
2880 doc: /* Returns non-nil if a buffer named BUFFER-NAME would be created specially.
2881 The value is actually t if the frame should be called with default frame
2882 parameters, and a list of frame parameters if they were specified.
2883 See `special-display-buffer-names', and `special-display-regexps'. */)
2884 (buffer_name)
2885 Lisp_Object buffer_name;
2887 Lisp_Object tem;
2889 CHECK_STRING (buffer_name);
2891 tem = Fmember (buffer_name, Vspecial_display_buffer_names);
2892 if (!NILP (tem))
2893 return Qt;
2895 tem = Fassoc (buffer_name, Vspecial_display_buffer_names);
2896 if (!NILP (tem))
2897 return XCDR (tem);
2899 for (tem = Vspecial_display_regexps; CONSP (tem); tem = XCDR (tem))
2901 Lisp_Object car = XCAR (tem);
2902 if (STRINGP (car)
2903 && fast_string_match (car, buffer_name) >= 0)
2904 return Qt;
2905 else if (CONSP (car)
2906 && STRINGP (XCAR (car))
2907 && fast_string_match (XCAR (car), buffer_name) >= 0)
2908 return XCDR (car);
2910 return Qnil;
2913 DEFUN ("same-window-p", Fsame_window_p, Ssame_window_p, 1, 1, 0,
2914 doc: /* Returns non-nil if a new buffer named BUFFER-NAME would use the same window.
2915 See `same-window-buffer-names' and `same-window-regexps'. */)
2916 (buffer_name)
2917 Lisp_Object buffer_name;
2919 Lisp_Object tem;
2921 CHECK_STRING (buffer_name);
2923 tem = Fmember (buffer_name, Vsame_window_buffer_names);
2924 if (!NILP (tem))
2925 return Qt;
2927 tem = Fassoc (buffer_name, Vsame_window_buffer_names);
2928 if (!NILP (tem))
2929 return Qt;
2931 for (tem = Vsame_window_regexps; CONSP (tem); tem = XCDR (tem))
2933 Lisp_Object car = XCAR (tem);
2934 if (STRINGP (car)
2935 && fast_string_match (car, buffer_name) >= 0)
2936 return Qt;
2937 else if (CONSP (car)
2938 && STRINGP (XCAR (car))
2939 && fast_string_match (XCAR (car), buffer_name) >= 0)
2940 return Qt;
2942 return Qnil;
2945 /* Use B so the default is (other-buffer). */
2946 DEFUN ("display-buffer", Fdisplay_buffer, Sdisplay_buffer, 1, 3,
2947 "BDisplay buffer: \nP",
2948 doc: /* Make BUFFER appear in some window but don't select it.
2949 BUFFER can be a buffer or a buffer name.
2950 If BUFFER is shown already in some window, just use that one,
2951 unless the window is the selected window and the optional second
2952 argument NOT-THIS-WINDOW is non-nil (interactively, with prefix arg).
2953 If `pop-up-frames' is non-nil, make a new frame if no window shows BUFFER.
2954 Returns the window displaying BUFFER.
2955 If `display-buffer-reuse-frames' is non-nil, and another frame is currently
2956 displaying BUFFER, then simply raise that frame.
2958 The variables `special-display-buffer-names', `special-display-regexps',
2959 `same-window-buffer-names', and `same-window-regexps' customize how certain
2960 buffer names are handled.
2962 If optional argument FRAME is `visible', search all visible frames.
2963 If FRAME is 0, search all visible and iconified frames.
2964 If FRAME is t, search all frames.
2965 If FRAME is a frame, search only that frame.
2966 If FRAME is nil, search only the selected frame
2967 (actually the last nonminibuffer frame),
2968 unless `pop-up-frames' or `display-buffer-reuse-frames' is non-nil,
2969 which means search visible and iconified frames.
2971 If `even-window-heights' is non-nil, window heights will be evened out
2972 if displaying the buffer causes two vertically adjacent windows to be
2973 displayed. */)
2974 (buffer, not_this_window, frame)
2975 register Lisp_Object buffer, not_this_window, frame;
2977 register Lisp_Object window, tem, swp;
2978 struct frame *f;
2980 swp = Qnil;
2981 buffer = Fget_buffer (buffer);
2982 CHECK_BUFFER (buffer);
2984 if (!NILP (Vdisplay_buffer_function))
2985 return call2 (Vdisplay_buffer_function, buffer, not_this_window);
2987 if (NILP (not_this_window)
2988 && XBUFFER (XWINDOW (selected_window)->buffer) == XBUFFER (buffer))
2989 return display_buffer_1 (selected_window);
2991 /* See if the user has specified this buffer should appear
2992 in the selected window. */
2993 if (NILP (not_this_window))
2995 swp = Fsame_window_p (XBUFFER (buffer)->name);
2996 if (!NILP (swp) && !no_switch_window (selected_window))
2998 Fswitch_to_buffer (buffer, Qnil);
2999 return display_buffer_1 (selected_window);
3003 /* If the user wants pop-up-frames or display-buffer-reuse-frames,
3004 look for a window showing BUFFER on any visible or iconified frame.
3005 Otherwise search only the current frame. */
3006 if (! NILP (frame))
3007 tem = frame;
3008 else if (pop_up_frames
3009 || display_buffer_reuse_frames
3010 || last_nonminibuf_frame == 0)
3011 XSETFASTINT (tem, 0);
3012 else
3013 XSETFRAME (tem, last_nonminibuf_frame);
3015 window = Fget_buffer_window (buffer, tem);
3016 if (!NILP (window)
3017 && (NILP (not_this_window) || !EQ (window, selected_window)))
3018 return display_buffer_1 (window);
3020 /* Certain buffer names get special handling. */
3021 if (!NILP (Vspecial_display_function) && NILP (swp))
3023 tem = Fspecial_display_p (XBUFFER (buffer)->name);
3024 if (EQ (tem, Qt))
3025 return call1 (Vspecial_display_function, buffer);
3026 if (CONSP (tem))
3027 return call2 (Vspecial_display_function, buffer, tem);
3030 /* If there are no frames open that have more than a minibuffer,
3031 we need to create a new frame. */
3032 if (pop_up_frames || last_nonminibuf_frame == 0)
3034 window = Fframe_selected_window (call0 (Vpop_up_frame_function));
3035 Fset_window_buffer (window, buffer);
3036 return display_buffer_1 (window);
3039 f = SELECTED_FRAME ();
3040 if (pop_up_windows
3041 || FRAME_MINIBUF_ONLY_P (f)
3042 /* If the current frame is a special display frame,
3043 don't try to reuse its windows. */
3044 || !NILP (XWINDOW (FRAME_ROOT_WINDOW (f))->dedicated))
3046 Lisp_Object frames;
3048 frames = Qnil;
3049 if (FRAME_MINIBUF_ONLY_P (f))
3050 XSETFRAME (frames, last_nonminibuf_frame);
3051 /* Don't try to create a window if we would get an error. */
3052 if (split_height_threshold < window_min_height << 1)
3053 split_height_threshold = window_min_height << 1;
3055 /* Note that both Fget_largest_window and Fget_lru_window
3056 ignore minibuffers and dedicated windows.
3057 This means they can return nil. */
3059 /* If the frame we would try to split cannot be split,
3060 try other frames. */
3061 if (FRAME_NO_SPLIT_P (NILP (frames) ? f : last_nonminibuf_frame))
3063 /* Try visible frames first. */
3064 window = Fget_largest_window (Qvisible);
3065 /* If that didn't work, try iconified frames. */
3066 if (NILP (window))
3067 window = Fget_largest_window (make_number (0));
3068 if (NILP (window))
3069 window = Fget_largest_window (Qt);
3071 else
3072 window = Fget_largest_window (frames);
3074 /* If we got a tall enough full-width window that can be split,
3075 split it. */
3076 if (!NILP (window)
3077 && ! FRAME_NO_SPLIT_P (XFRAME (XWINDOW (window)->frame))
3078 && window_height (window) >= split_height_threshold
3079 && WINDOW_FULL_WIDTH_P (XWINDOW (window)))
3080 window = Fsplit_window (window, Qnil, Qnil);
3081 else
3083 Lisp_Object upper, lower, other;
3085 window = Fget_lru_window (frames);
3086 /* If the LRU window is selected, and big enough,
3087 and can be split, split it. */
3088 if (!NILP (window)
3089 && ! FRAME_NO_SPLIT_P (XFRAME (XWINDOW (window)->frame))
3090 && (EQ (window, selected_window)
3091 || EQ (XWINDOW (window)->parent, Qnil))
3092 && window_height (window) >= window_min_height << 1)
3093 window = Fsplit_window (window, Qnil, Qnil);
3094 /* If Fget_lru_window returned nil, try other approaches. */
3096 /* Try visible frames first. */
3097 if (NILP (window))
3098 window = Fget_buffer_window (buffer, Qvisible);
3099 if (NILP (window))
3100 window = Fget_largest_window (Qvisible);
3101 /* If that didn't work, try iconified frames. */
3102 if (NILP (window))
3103 window = Fget_buffer_window (buffer, make_number (0));
3104 if (NILP (window))
3105 window = Fget_largest_window (make_number (0));
3106 /* Try invisible frames. */
3107 if (NILP (window))
3108 window = Fget_buffer_window (buffer, Qt);
3109 if (NILP (window))
3110 window = Fget_largest_window (Qt);
3111 /* As a last resort, make a new frame. */
3112 if (NILP (window))
3113 window = Fframe_selected_window (call0 (Vpop_up_frame_function));
3114 /* If window appears above or below another,
3115 even out their heights. */
3116 other = upper = lower = Qnil;
3117 if (!NILP (XWINDOW (window)->prev))
3118 other = upper = XWINDOW (window)->prev, lower = window;
3119 if (!NILP (XWINDOW (window)->next))
3120 other = lower = XWINDOW (window)->next, upper = window;
3121 if (!NILP (other)
3122 && !NILP (Veven_window_heights)
3123 /* Check that OTHER and WINDOW are vertically arrayed. */
3124 && !EQ (XWINDOW (other)->top, XWINDOW (window)->top)
3125 && (XFASTINT (XWINDOW (other)->height)
3126 > XFASTINT (XWINDOW (window)->height)))
3128 int total = (XFASTINT (XWINDOW (other)->height)
3129 + XFASTINT (XWINDOW (window)->height));
3130 enlarge_window (upper,
3131 total / 2 - XFASTINT (XWINDOW (upper)->height),
3132 0, 0);
3136 else
3137 window = Fget_lru_window (Qnil);
3139 Fset_window_buffer (window, buffer);
3140 return display_buffer_1 (window);
3143 void
3144 temp_output_buffer_show (buf)
3145 register Lisp_Object buf;
3147 register struct buffer *old = current_buffer;
3148 register Lisp_Object window;
3149 register struct window *w;
3151 XBUFFER (buf)->directory = current_buffer->directory;
3153 Fset_buffer (buf);
3154 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3155 BEGV = BEG;
3156 ZV = Z;
3157 SET_PT (BEG);
3158 #if 0 /* rms: there should be no reason for this. */
3159 XBUFFER (buf)->prevent_redisplay_optimizations_p = 1;
3160 #endif
3161 set_buffer_internal (old);
3163 if (!EQ (Vtemp_buffer_show_function, Qnil))
3164 call1 (Vtemp_buffer_show_function, buf);
3165 else
3167 window = Fdisplay_buffer (buf, Qnil, Qnil);
3169 if (!EQ (XWINDOW (window)->frame, selected_frame))
3170 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3171 Vminibuf_scroll_window = window;
3172 w = XWINDOW (window);
3173 XSETFASTINT (w->hscroll, 0);
3174 XSETFASTINT (w->min_hscroll, 0);
3175 set_marker_restricted_both (w->start, buf, 1, 1);
3176 set_marker_restricted_both (w->pointm, buf, 1, 1);
3178 /* Run temp-buffer-show-hook, with the chosen window selected
3179 and its buffer current. */
3180 if (!NILP (Vrun_hooks))
3182 Lisp_Object tem;
3183 tem = Fboundp (Qtemp_buffer_show_hook);
3184 if (!NILP (tem))
3186 tem = Fsymbol_value (Qtemp_buffer_show_hook);
3187 if (!NILP (tem))
3189 int count = SPECPDL_INDEX ();
3190 Lisp_Object prev_window;
3191 prev_window = selected_window;
3193 /* Select the window that was chosen, for running the hook. */
3194 /* Both this Fselect_window and the select_window_1
3195 below will (may) incorrectly set-buffer to the buffer
3196 displayed in the window. --stef */
3197 record_unwind_protect (Fselect_window, prev_window);
3198 select_window_1 (window, 0);
3199 Fset_buffer (w->buffer);
3200 call1 (Vrun_hooks, Qtemp_buffer_show_hook);
3201 select_window_1 (prev_window, 0);
3202 unbind_to (count, Qnil);
3209 static void
3210 make_dummy_parent (window)
3211 Lisp_Object window;
3213 Lisp_Object new;
3214 register struct window *o, *p;
3215 int i;
3217 o = XWINDOW (window);
3218 p = allocate_window ();
3219 for (i = 0; i < VECSIZE (struct window); ++i)
3220 ((struct Lisp_Vector *) p)->contents[i]
3221 = ((struct Lisp_Vector *)o)->contents[i];
3222 XSETWINDOW (new, p);
3224 XSETFASTINT (p->sequence_number, ++sequence_number);
3226 /* Put new into window structure in place of window */
3227 replace_window (window, new);
3229 o->next = Qnil;
3230 o->prev = Qnil;
3231 o->vchild = Qnil;
3232 o->hchild = Qnil;
3233 o->parent = new;
3235 p->start = Qnil;
3236 p->pointm = Qnil;
3237 p->buffer = Qnil;
3240 DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "",
3241 doc: /* Split WINDOW, putting SIZE lines in the first of the pair.
3242 WINDOW defaults to selected one and SIZE to half its size.
3243 If optional third arg HORFLAG is non-nil, split side by side
3244 and put SIZE columns in the first of the pair. In that case,
3245 SIZE includes that window's scroll bar, or the divider column to its right. */)
3246 (window, size, horflag)
3247 Lisp_Object window, size, horflag;
3249 register Lisp_Object new;
3250 register struct window *o, *p;
3251 FRAME_PTR fo;
3252 register int size_int;
3254 if (NILP (window))
3255 window = selected_window;
3256 else
3257 CHECK_LIVE_WINDOW (window);
3259 o = XWINDOW (window);
3260 fo = XFRAME (WINDOW_FRAME (o));
3262 if (NILP (size))
3264 if (!NILP (horflag))
3265 /* Calculate the size of the left-hand window, by dividing
3266 the usable space in columns by two.
3267 We round up, since the left-hand window may include
3268 a dividing line, while the right-hand may not. */
3269 size_int = (XFASTINT (o->width) + 1) >> 1;
3270 else
3271 size_int = XFASTINT (o->height) >> 1;
3273 else
3275 CHECK_NUMBER (size);
3276 size_int = XINT (size);
3279 if (MINI_WINDOW_P (o))
3280 error ("Attempt to split minibuffer window");
3281 else if (window_fixed_size_p (o, !NILP (horflag), 0))
3282 error ("Attempt to split fixed-size window");
3284 check_min_window_sizes ();
3286 if (NILP (horflag))
3288 if (size_int < window_min_height)
3289 error ("Window height %d too small (after splitting)", size_int);
3290 if (size_int + window_min_height > XFASTINT (o->height))
3291 error ("Window height %d too small (after splitting)",
3292 XFASTINT (o->height) - size_int);
3293 if (NILP (o->parent)
3294 || NILP (XWINDOW (o->parent)->vchild))
3296 make_dummy_parent (window);
3297 new = o->parent;
3298 XWINDOW (new)->vchild = window;
3301 else
3303 if (size_int < window_min_width)
3304 error ("Window width %d too small (after splitting)", size_int);
3306 if (size_int + window_min_width > XFASTINT (o->width))
3307 error ("Window width %d too small (after splitting)",
3308 XFASTINT (o->width) - size_int);
3309 if (NILP (o->parent)
3310 || NILP (XWINDOW (o->parent)->hchild))
3312 make_dummy_parent (window);
3313 new = o->parent;
3314 XWINDOW (new)->hchild = window;
3318 /* Now we know that window's parent is a vertical combination
3319 if we are dividing vertically, or a horizontal combination
3320 if we are making side-by-side windows */
3322 windows_or_buffers_changed++;
3323 FRAME_WINDOW_SIZES_CHANGED (fo) = 1;
3324 new = make_window ();
3325 p = XWINDOW (new);
3327 p->frame = o->frame;
3328 p->next = o->next;
3329 if (!NILP (p->next))
3330 XWINDOW (p->next)->prev = new;
3331 p->prev = window;
3332 o->next = new;
3333 p->parent = o->parent;
3334 p->buffer = Qt;
3335 p->window_end_valid = Qnil;
3336 bzero (&p->last_cursor, sizeof p->last_cursor);
3338 /* Apportion the available frame space among the two new windows */
3340 if (!NILP (horflag))
3342 p->height = o->height;
3343 p->top = o->top;
3344 XSETFASTINT (p->width, XFASTINT (o->width) - size_int);
3345 XSETFASTINT (o->width, size_int);
3346 XSETFASTINT (p->left, XFASTINT (o->left) + size_int);
3348 else
3350 p->left = o->left;
3351 p->width = o->width;
3352 XSETFASTINT (p->height, XFASTINT (o->height) - size_int);
3353 XSETFASTINT (o->height, size_int);
3354 XSETFASTINT (p->top, XFASTINT (o->top) + size_int);
3357 /* Adjust glyph matrices. */
3358 adjust_glyphs (fo);
3359 Fset_window_buffer (new, o->buffer);
3360 return new;
3363 DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 3, "p",
3364 doc: /* Make current window ARG lines bigger.
3365 From program, optional second arg non-nil means grow sideways ARG columns.
3366 Interactively, if an argument is not given, make the window one line bigger.
3368 Optional third arg PRESERVE-BEFORE, if non-nil, means do not change the size
3369 of the siblings above or to the left of the selected window. Only
3370 siblings to the right or below are changed. */)
3371 (arg, side, preserve_before)
3372 register Lisp_Object arg, side, preserve_before;
3374 CHECK_NUMBER (arg);
3375 enlarge_window (selected_window, XINT (arg), !NILP (side),
3376 !NILP (preserve_before));
3378 if (! NILP (Vwindow_configuration_change_hook))
3379 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
3381 return Qnil;
3384 DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 3, "p",
3385 doc: /* Make current window ARG lines smaller.
3386 From program, optional second arg non-nil means shrink sideways arg columns.
3387 Interactively, if an argument is not given, make the window one line smaller.
3389 Optional third arg PRESERVE-BEFORE, if non-nil, means do not change the size
3390 of the siblings above or to the left of the selected window. Only
3391 siblings to the right or below are changed. */)
3392 (arg, side, preserve_before)
3393 register Lisp_Object arg, side, preserve_before;
3395 CHECK_NUMBER (arg);
3396 enlarge_window (selected_window, -XINT (arg), !NILP (side),
3397 !NILP (preserve_before));
3399 if (! NILP (Vwindow_configuration_change_hook))
3400 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
3402 return Qnil;
3406 window_height (window)
3407 Lisp_Object window;
3409 register struct window *p = XWINDOW (window);
3410 return XFASTINT (p->height);
3414 window_width (window)
3415 Lisp_Object window;
3417 register struct window *p = XWINDOW (window);
3418 return XFASTINT (p->width);
3422 #define CURBEG(w) \
3423 *(widthflag ? &(XWINDOW (w)->left) : &(XWINDOW (w)->top))
3425 #define CURSIZE(w) \
3426 *(widthflag ? &(XWINDOW (w)->width) : &(XWINDOW (w)->height))
3429 /* Enlarge WINDOW by DELTA. WIDTHFLAG non-zero means
3430 increase its width. Siblings of the selected window are resized to
3431 fulfill the size request. If they become too small in the process,
3432 they will be deleted.
3434 If PRESERVE_BEFORE is nonzero, that means don't alter
3435 the siblings to the left or above WINDOW. */
3437 static void
3438 enlarge_window (window, delta, widthflag, preserve_before)
3439 Lisp_Object window;
3440 int delta, widthflag, preserve_before;
3442 Lisp_Object parent, next, prev;
3443 struct window *p;
3444 Lisp_Object *sizep;
3445 int maximum;
3446 int (*sizefun) P_ ((Lisp_Object))
3447 = widthflag ? window_width : window_height;
3448 void (*setsizefun) P_ ((Lisp_Object, int, int))
3449 = (widthflag ? set_window_width : set_window_height);
3451 /* Check values of window_min_width and window_min_height for
3452 validity. */
3453 check_min_window_sizes ();
3455 /* Give up if this window cannot be resized. */
3456 if (window_fixed_size_p (XWINDOW (window), widthflag, 1))
3457 error ("Window is not resizable");
3459 /* Find the parent of the selected window. */
3460 while (1)
3462 p = XWINDOW (window);
3463 parent = p->parent;
3465 if (NILP (parent))
3467 if (widthflag)
3468 error ("No other window to side of this one");
3469 break;
3472 if (widthflag
3473 ? !NILP (XWINDOW (parent)->hchild)
3474 : !NILP (XWINDOW (parent)->vchild))
3475 break;
3477 window = parent;
3480 sizep = &CURSIZE (window);
3483 register int maxdelta;
3485 /* Compute the maximum size increment this window can have. */
3487 if (preserve_before)
3489 if (!NILP (parent))
3491 maxdelta = (*sizefun) (parent) - XINT (*sizep);
3492 /* Subtract size of siblings before, since we can't take that. */
3493 maxdelta -= XINT (CURBEG (window)) - XINT (CURBEG (parent));
3495 else
3496 maxdelta = (!NILP (p->next) ? ((*sizefun) (p->next)
3497 - window_min_size (XWINDOW (p->next),
3498 widthflag, 0, 0))
3499 : (delta = 0));
3501 else
3502 maxdelta = (!NILP (parent) ? (*sizefun) (parent) - XINT (*sizep)
3503 /* This is a main window followed by a minibuffer. */
3504 : !NILP (p->next) ? ((*sizefun) (p->next)
3505 - window_min_size (XWINDOW (p->next),
3506 widthflag, 0, 0))
3507 /* This is a minibuffer following a main window. */
3508 : !NILP (p->prev) ? ((*sizefun) (p->prev)
3509 - window_min_size (XWINDOW (p->prev),
3510 widthflag, 0, 0))
3511 /* This is a frame with only one window, a minibuffer-only
3512 or a minibufferless frame. */
3513 : (delta = 0));
3515 if (delta > maxdelta)
3516 /* This case traps trying to make the minibuffer
3517 the full frame, or make the only window aside from the
3518 minibuffer the full frame. */
3519 delta = maxdelta;
3522 if (XINT (*sizep) + delta < window_min_size (XWINDOW (window), widthflag, 0, 0))
3524 delete_window (window);
3525 return;
3528 if (delta == 0)
3529 return;
3531 /* Find the total we can get from other siblings without deleting them. */
3532 maximum = 0;
3533 for (next = p->next; ! NILP (next); next = XWINDOW (next)->next)
3534 maximum += (*sizefun) (next) - window_min_size (XWINDOW (next),
3535 widthflag, 0, 0);
3536 if (! preserve_before)
3537 for (prev = p->prev; ! NILP (prev); prev = XWINDOW (prev)->prev)
3538 maximum += (*sizefun) (prev) - window_min_size (XWINDOW (prev),
3539 widthflag, 0, 0);
3541 /* If we can get it all from them without deleting them, do so. */
3542 if (delta <= maximum)
3544 Lisp_Object first_unaffected;
3545 Lisp_Object first_affected;
3546 int fixed_p;
3548 next = p->next;
3549 prev = p->prev;
3550 first_affected = window;
3551 /* Look at one sibling at a time,
3552 moving away from this window in both directions alternately,
3553 and take as much as we can get without deleting that sibling. */
3554 while (delta != 0
3555 && (!NILP (next) || (!preserve_before && !NILP (prev))))
3557 if (! NILP (next))
3559 int this_one = ((*sizefun) (next)
3560 - window_min_size (XWINDOW (next),
3561 widthflag, 0, &fixed_p));
3562 if (!fixed_p)
3564 if (this_one > delta)
3565 this_one = delta;
3567 (*setsizefun) (next, (*sizefun) (next) - this_one, 0);
3568 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
3570 delta -= this_one;
3573 next = XWINDOW (next)->next;
3576 if (delta == 0)
3577 break;
3579 if (!preserve_before && ! NILP (prev))
3581 int this_one = ((*sizefun) (prev)
3582 - window_min_size (XWINDOW (prev),
3583 widthflag, 0, &fixed_p));
3584 if (!fixed_p)
3586 if (this_one > delta)
3587 this_one = delta;
3589 first_affected = prev;
3591 (*setsizefun) (prev, (*sizefun) (prev) - this_one, 0);
3592 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
3594 delta -= this_one;
3597 prev = XWINDOW (prev)->prev;
3601 xassert (delta == 0);
3603 /* Now recalculate the edge positions of all the windows affected,
3604 based on the new sizes. */
3605 first_unaffected = next;
3606 prev = first_affected;
3607 for (next = XWINDOW (prev)->next; ! EQ (next, first_unaffected);
3608 prev = next, next = XWINDOW (next)->next)
3610 XSETINT (CURBEG (next), XINT (CURBEG (prev)) + (*sizefun) (prev));
3611 /* This does not change size of NEXT,
3612 but it propagates the new top edge to its children */
3613 (*setsizefun) (next, (*sizefun) (next), 0);
3616 else
3618 register int delta1;
3619 register int opht = (*sizefun) (parent);
3621 if (opht <= XINT (*sizep) + delta)
3623 /* If trying to grow this window to or beyond size of the parent,
3624 just delete all the sibling windows. */
3625 Lisp_Object start, tem, next;
3627 start = XWINDOW (parent)->vchild;
3628 if (NILP (start))
3629 start = XWINDOW (parent)->hchild;
3631 /* Delete any siblings that come after WINDOW. */
3632 tem = XWINDOW (window)->next;
3633 while (! NILP (tem))
3635 next = XWINDOW (tem)->next;
3636 delete_window (tem);
3637 tem = next;
3640 /* Delete any siblings that come after WINDOW.
3641 Note that if START is not WINDOW, then WINDOW still
3642 Fhas siblings, so WINDOW has not yet replaced its parent. */
3643 tem = start;
3644 while (! EQ (tem, window))
3646 next = XWINDOW (tem)->next;
3647 delete_window (tem);
3648 tem = next;
3651 else
3653 /* Otherwise, make delta1 just right so that if we add
3654 delta1 lines to this window and to the parent, and then
3655 shrink the parent back to its original size, the new
3656 proportional size of this window will increase by delta.
3658 The function size_window will compute the new height h'
3659 of the window from delta1 as:
3661 e = delta1/n
3662 x = delta1 - delta1/n * n for the 1st resizable child
3663 h' = h + e + x
3665 where n is the number of children that can be resized.
3666 We can ignore x by choosing a delta1 that is a multiple of
3667 n. We want the height of this window to come out as
3669 h' = h + delta
3671 So, delta1 must be
3673 h + e = h + delta
3674 delta1/n = delta
3675 delta1 = n * delta.
3677 The number of children n equals the number of resizable
3678 children of this window + 1 because we know window itself
3679 is resizable (otherwise we would have signalled an error. */
3681 struct window *w = XWINDOW (window);
3682 Lisp_Object s;
3683 int n = 1;
3685 for (s = w->next; !NILP (s); s = XWINDOW (s)->next)
3686 if (!window_fixed_size_p (XWINDOW (s), widthflag, 0))
3687 ++n;
3688 for (s = w->prev; !NILP (s); s = XWINDOW (s)->prev)
3689 if (!window_fixed_size_p (XWINDOW (s), widthflag, 0))
3690 ++n;
3692 delta1 = n * delta;
3694 /* Add delta1 lines or columns to this window, and to the parent,
3695 keeping things consistent while not affecting siblings. */
3696 XSETINT (CURSIZE (parent), opht + delta1);
3697 (*setsizefun) (window, XINT (*sizep) + delta1, 0);
3699 /* Squeeze out delta1 lines or columns from our parent,
3700 shriking this window and siblings proportionately.
3701 This brings parent back to correct size.
3702 Delta1 was calculated so this makes this window the desired size,
3703 taking it all out of the siblings. */
3704 (*setsizefun) (parent, opht, 0);
3709 XSETFASTINT (p->last_modified, 0);
3710 XSETFASTINT (p->last_overlay_modified, 0);
3712 /* Adjust glyph matrices. */
3713 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
3716 #undef CURBEG
3717 #undef CURSIZE
3721 /***********************************************************************
3722 Resizing Mini-Windows
3723 ***********************************************************************/
3725 static void shrink_window_lowest_first P_ ((struct window *, int));
3727 enum save_restore_action
3729 CHECK_ORIG_SIZES,
3730 SAVE_ORIG_SIZES,
3731 RESTORE_ORIG_SIZES
3734 static int save_restore_orig_size P_ ((struct window *,
3735 enum save_restore_action));
3737 /* Shrink windows rooted in window W to HEIGHT. Take the space needed
3738 from lowest windows first. */
3740 static void
3741 shrink_window_lowest_first (w, height)
3742 struct window *w;
3743 int height;
3745 struct window *c;
3746 Lisp_Object child;
3747 int old_height;
3749 xassert (!MINI_WINDOW_P (w));
3751 /* Set redisplay hints. */
3752 XSETFASTINT (w->last_modified, 0);
3753 XSETFASTINT (w->last_overlay_modified, 0);
3754 windows_or_buffers_changed++;
3755 FRAME_WINDOW_SIZES_CHANGED (XFRAME (WINDOW_FRAME (w))) = 1;
3757 old_height = XFASTINT (w->height);
3758 XSETFASTINT (w->height, height);
3760 if (!NILP (w->hchild))
3762 for (child = w->hchild; !NILP (child); child = c->next)
3764 c = XWINDOW (child);
3765 c->top = w->top;
3766 shrink_window_lowest_first (c, height);
3769 else if (!NILP (w->vchild))
3771 Lisp_Object last_child;
3772 int delta = old_height - height;
3773 int last_top;
3775 last_child = Qnil;
3777 /* Find the last child. We are taking space from lowest windows
3778 first, so we iterate over children from the last child
3779 backwards. */
3780 for (child = w->vchild; !NILP (child); child = XWINDOW (child)->next)
3781 last_child = child;
3783 /* Assign new heights. We leave only MIN_SAFE_WINDOW_HEIGHT. */
3784 for (child = last_child; delta && !NILP (child); child = c->prev)
3786 int this_one;
3788 c = XWINDOW (child);
3789 this_one = XFASTINT (c->height) - MIN_SAFE_WINDOW_HEIGHT;
3791 if (this_one > delta)
3792 this_one = delta;
3794 shrink_window_lowest_first (c, XFASTINT (c->height) - this_one);
3795 delta -= this_one;
3798 /* Compute new positions. */
3799 last_top = XINT (w->top);
3800 for (child = w->vchild; !NILP (child); child = c->next)
3802 c = XWINDOW (child);
3803 c->top = make_number (last_top);
3804 shrink_window_lowest_first (c, XFASTINT (c->height));
3805 last_top += XFASTINT (c->height);
3811 /* Save, restore, or check positions and sizes in the window tree
3812 rooted at W. ACTION says what to do.
3814 If ACTION is CHECK_ORIG_SIZES, check if orig_top and orig_height
3815 members are valid for all windows in the window tree. Value is
3816 non-zero if they are valid.
3818 If ACTION is SAVE_ORIG_SIZES, save members top and height in
3819 orig_top and orig_height for all windows in the tree.
3821 If ACTION is RESTORE_ORIG_SIZES, restore top and height from
3822 values stored in orig_top and orig_height for all windows. */
3824 static int
3825 save_restore_orig_size (w, action)
3826 struct window *w;
3827 enum save_restore_action action;
3829 int success_p = 1;
3831 while (w)
3833 if (!NILP (w->hchild))
3835 if (!save_restore_orig_size (XWINDOW (w->hchild), action))
3836 success_p = 0;
3838 else if (!NILP (w->vchild))
3840 if (!save_restore_orig_size (XWINDOW (w->vchild), action))
3841 success_p = 0;
3844 switch (action)
3846 case CHECK_ORIG_SIZES:
3847 if (!INTEGERP (w->orig_top) || !INTEGERP (w->orig_height))
3848 return 0;
3849 break;
3851 case SAVE_ORIG_SIZES:
3852 w->orig_top = w->top;
3853 w->orig_height = w->height;
3854 XSETFASTINT (w->last_modified, 0);
3855 XSETFASTINT (w->last_overlay_modified, 0);
3856 break;
3858 case RESTORE_ORIG_SIZES:
3859 xassert (INTEGERP (w->orig_top) && INTEGERP (w->orig_height));
3860 w->top = w->orig_top;
3861 w->height = w->orig_height;
3862 w->orig_height = w->orig_top = Qnil;
3863 XSETFASTINT (w->last_modified, 0);
3864 XSETFASTINT (w->last_overlay_modified, 0);
3865 break;
3867 default:
3868 abort ();
3871 w = NILP (w->next) ? NULL : XWINDOW (w->next);
3874 return success_p;
3878 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we can
3879 without deleting other windows. */
3881 void
3882 grow_mini_window (w, delta)
3883 struct window *w;
3884 int delta;
3886 struct frame *f = XFRAME (w->frame);
3887 struct window *root;
3889 xassert (MINI_WINDOW_P (w));
3890 xassert (delta >= 0);
3892 /* Check values of window_min_width and window_min_height for
3893 validity. */
3894 check_min_window_sizes ();
3896 /* Compute how much we can enlarge the mini-window without deleting
3897 other windows. */
3898 root = XWINDOW (FRAME_ROOT_WINDOW (f));
3899 if (delta)
3901 int min_height = window_min_size (root, 0, 0, 0);
3902 if (XFASTINT (root->height) - delta < min_height)
3903 /* Note that the root window may already be smaller than
3904 min_height. */
3905 delta = max (0, XFASTINT (root->height) - min_height);
3908 if (delta)
3910 /* Save original window sizes and positions, if not already done. */
3911 if (!save_restore_orig_size (root, CHECK_ORIG_SIZES))
3912 save_restore_orig_size (root, SAVE_ORIG_SIZES);
3914 /* Shrink other windows. */
3915 shrink_window_lowest_first (root, XFASTINT (root->height) - delta);
3917 /* Grow the mini-window. */
3918 w->top = make_number (XFASTINT (root->top) + XFASTINT (root->height));
3919 w->height = make_number (XFASTINT (w->height) + delta);
3920 XSETFASTINT (w->last_modified, 0);
3921 XSETFASTINT (w->last_overlay_modified, 0);
3923 adjust_glyphs (f);
3928 /* Shrink mini-window W. If there is recorded info about window sizes
3929 before a call to grow_mini_window, restore recorded window sizes.
3930 Otherwise, if the mini-window is higher than 1 line, resize it to 1
3931 line. */
3933 void
3934 shrink_mini_window (w)
3935 struct window *w;
3937 struct frame *f = XFRAME (w->frame);
3938 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
3940 if (save_restore_orig_size (root, CHECK_ORIG_SIZES))
3942 save_restore_orig_size (root, RESTORE_ORIG_SIZES);
3943 adjust_glyphs (f);
3944 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3945 windows_or_buffers_changed = 1;
3947 else if (XFASTINT (w->height) > 1)
3949 /* Distribute the additional lines of the mini-window
3950 among the other windows. */
3951 Lisp_Object window;
3952 XSETWINDOW (window, w);
3953 enlarge_window (window, 1 - XFASTINT (w->height), 0, 0);
3959 /* Mark window cursors off for all windows in the window tree rooted
3960 at W by setting their phys_cursor_on_p flag to zero. Called from
3961 xterm.c, e.g. when a frame is cleared and thereby all cursors on
3962 the frame are cleared. */
3964 void
3965 mark_window_cursors_off (w)
3966 struct window *w;
3968 while (w)
3970 if (!NILP (w->hchild))
3971 mark_window_cursors_off (XWINDOW (w->hchild));
3972 else if (!NILP (w->vchild))
3973 mark_window_cursors_off (XWINDOW (w->vchild));
3974 else
3975 w->phys_cursor_on_p = 0;
3977 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3982 /* Return number of lines of text (not counting mode lines) in W. */
3985 window_internal_height (w)
3986 struct window *w;
3988 int ht = XFASTINT (w->height);
3990 if (!MINI_WINDOW_P (w))
3992 if (!NILP (w->parent)
3993 || !NILP (w->vchild)
3994 || !NILP (w->hchild)
3995 || !NILP (w->next)
3996 || !NILP (w->prev)
3997 || WINDOW_WANTS_MODELINE_P (w))
3998 --ht;
4000 if (WINDOW_WANTS_HEADER_LINE_P (w))
4001 --ht;
4004 return ht;
4008 /* Return the number of columns in W.
4009 Don't count columns occupied by scroll bars or the vertical bar
4010 separating W from the sibling to its right. */
4013 window_internal_width (w)
4014 struct window *w;
4016 struct frame *f = XFRAME (WINDOW_FRAME (w));
4017 int width = XINT (w->width);
4019 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
4020 /* Scroll bars occupy a few columns. */
4021 width -= FRAME_SCROLL_BAR_COLS (f);
4022 else if (!WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
4023 /* The column of `|' characters separating side-by-side windows
4024 occupies one column only. */
4025 width -= 1;
4027 /* On window-systems, areas to the left and right of the window
4028 are used as fringes. */
4029 if (FRAME_WINDOW_P (f))
4030 width -= FRAME_FRINGE_COLS (f);
4032 return width;
4036 /************************************************************************
4037 Window Scrolling
4038 ***********************************************************************/
4040 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4041 N screen-fulls, which is defined as the height of the window minus
4042 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4043 instead. Negative values of N mean scroll down. NOERROR non-zero
4044 means don't signal an error if we try to move over BEGV or ZV,
4045 respectively. */
4047 static void
4048 window_scroll (window, n, whole, noerror)
4049 Lisp_Object window;
4050 int n;
4051 int whole;
4052 int noerror;
4054 immediate_quit = 1;
4056 /* If we must, use the pixel-based version which is much slower than
4057 the line-based one but can handle varying line heights. */
4058 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4059 window_scroll_pixel_based (window, n, whole, noerror);
4060 else
4061 window_scroll_line_based (window, n, whole, noerror);
4063 immediate_quit = 0;
4067 /* Implementation of window_scroll that works based on pixel line
4068 heights. See the comment of window_scroll for parameter
4069 descriptions. */
4071 static void
4072 window_scroll_pixel_based (window, n, whole, noerror)
4073 Lisp_Object window;
4074 int n;
4075 int whole;
4076 int noerror;
4078 struct it it;
4079 struct window *w = XWINDOW (window);
4080 struct text_pos start;
4081 Lisp_Object tem;
4082 int this_scroll_margin;
4083 int preserve_y;
4084 /* True if we fiddled the window vscroll field without really scrolling. */
4085 int vscrolled = 0;
4087 SET_TEXT_POS_FROM_MARKER (start, w->start);
4089 /* If PT is not visible in WINDOW, move back one half of
4090 the screen. Allow PT to be partially visible, otherwise
4091 something like (scroll-down 1) with PT in the line before
4092 the partially visible one would recenter. */
4093 tem = Fpos_visible_in_window_p (make_number (PT), window, Qt);
4094 if (NILP (tem))
4096 /* Move backward half the height of the window. Performance note:
4097 vmotion used here is about 10% faster, but would give wrong
4098 results for variable height lines. */
4099 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4100 it.current_y = it.last_visible_y;
4101 move_it_vertically (&it, - window_box_height (w) / 2);
4103 /* The function move_iterator_vertically may move over more than
4104 the specified y-distance. If it->w is small, e.g. a
4105 mini-buffer window, we may end up in front of the window's
4106 display area. This is the case when Start displaying at the
4107 start of the line containing PT in this case. */
4108 if (it.current_y <= 0)
4110 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4111 move_it_vertically (&it, 0);
4112 it.current_y = 0;
4115 start = it.current.pos;
4118 /* If scroll_preserve_screen_position is non-zero, we try to set
4119 point in the same window line as it is now, so get that line. */
4120 if (!NILP (Vscroll_preserve_screen_position))
4122 start_display (&it, w, start);
4123 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4124 preserve_y = it.current_y;
4126 else
4127 preserve_y = -1;
4129 /* Move iterator it from start the specified distance forward or
4130 backward. The result is the new window start. */
4131 start_display (&it, w, start);
4132 if (whole)
4134 int screen_full = (window_box_height (w)
4135 - next_screen_context_lines * CANON_Y_UNIT (it.f));
4136 int dy = n * screen_full;
4138 /* Note that move_it_vertically always moves the iterator to the
4139 start of a line. So, if the last line doesn't have a newline,
4140 we would end up at the start of the line ending at ZV. */
4141 if (dy <= 0)
4142 move_it_vertically_backward (&it, -dy);
4143 else if (dy > 0)
4144 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4145 MOVE_TO_POS | MOVE_TO_Y);
4147 else
4148 move_it_by_lines (&it, n, 1);
4150 /* We failed if we find ZV is already on the screen (scrolling up,
4151 means there's nothing past the end), or if we can't start any
4152 earlier (scrolling down, means there's nothing past the top). */
4153 if ((n > 0 && IT_CHARPOS (it) == ZV)
4154 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4156 if (IT_CHARPOS (it) == ZV)
4158 if (it.current_y < it.last_visible_y
4159 && (it.current_y + it.max_ascent + it.max_descent
4160 >= it.last_visible_y))
4162 /* The last line was only partially visible, make it fully
4163 visible. */
4164 w->vscroll = (it.last_visible_y
4165 - it.current_y + it.max_ascent + it.max_descent);
4166 adjust_glyphs (it.f);
4168 else if (noerror)
4169 return;
4170 else
4171 Fsignal (Qend_of_buffer, Qnil);
4173 else
4175 if (w->vscroll != 0)
4176 /* The first line was only partially visible, make it fully
4177 visible. */
4178 w->vscroll = 0;
4179 else if (noerror)
4180 return;
4181 else
4182 Fsignal (Qbeginning_of_buffer, Qnil);
4185 /* If control gets here, then we vscrolled. */
4187 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4189 /* Don't try to change the window start below. */
4190 vscrolled = 1;
4193 if (! vscrolled)
4195 int pos = IT_CHARPOS (it);
4196 int bytepos;
4197 /* Set the window start, and set up the window for redisplay. */
4198 set_marker_restricted (w->start, make_number (pos),
4199 w->buffer);
4200 bytepos = XMARKER (w->start)->bytepos;
4201 w->start_at_line_beg = ((pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n')
4202 ? Qt : Qnil);
4203 w->update_mode_line = Qt;
4204 XSETFASTINT (w->last_modified, 0);
4205 XSETFASTINT (w->last_overlay_modified, 0);
4206 /* Set force_start so that redisplay_window will run the
4207 window-scroll-functions. */
4208 w->force_start = Qt;
4211 it.current_y = it.vpos = 0;
4213 /* Preserve the screen position if we must. */
4214 if (preserve_y >= 0)
4216 move_it_to (&it, -1, -1, preserve_y, -1, MOVE_TO_Y);
4217 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4219 else
4221 /* Move PT out of scroll margins. */
4222 this_scroll_margin = max (0, scroll_margin);
4223 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->height) / 4);
4224 this_scroll_margin *= CANON_Y_UNIT (it.f);
4226 if (n > 0)
4228 /* We moved the window start towards ZV, so PT may be now
4229 in the scroll margin at the top. */
4230 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4231 while (it.current_y < this_scroll_margin)
4233 int prev = it.current_y;
4234 move_it_by_lines (&it, 1, 1);
4235 if (prev == it.current_y)
4236 break;
4238 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4240 else if (n < 0)
4242 int charpos, bytepos;
4244 /* We moved the window start towards BEGV, so PT may be now
4245 in the scroll margin at the bottom. */
4246 move_it_to (&it, PT, -1,
4247 it.last_visible_y - this_scroll_margin - 1, -1,
4248 MOVE_TO_POS | MOVE_TO_Y);
4250 /* Save our position, in case it's correct. */
4251 charpos = IT_CHARPOS (it);
4252 bytepos = IT_BYTEPOS (it);
4254 /* See if point is on a partially visible line at the end. */
4255 move_it_by_lines (&it, 1, 1);
4256 if (it.current_y > it.last_visible_y)
4257 /* The last line was only partially visible, so back up two
4258 lines to make sure we're on a fully visible line. */
4260 move_it_by_lines (&it, -2, 0);
4261 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4263 else
4264 /* No, the position we saved is OK, so use it. */
4265 SET_PT_BOTH (charpos, bytepos);
4271 /* Implementation of window_scroll that works based on screen lines.
4272 See the comment of window_scroll for parameter descriptions. */
4274 static void
4275 window_scroll_line_based (window, n, whole, noerror)
4276 Lisp_Object window;
4277 int n;
4278 int whole;
4279 int noerror;
4281 register struct window *w = XWINDOW (window);
4282 register int opoint = PT, opoint_byte = PT_BYTE;
4283 register int pos, pos_byte;
4284 register int ht = window_internal_height (w);
4285 register Lisp_Object tem;
4286 int lose;
4287 Lisp_Object bolp;
4288 int startpos;
4289 struct position posit;
4290 int original_vpos;
4292 /* If scrolling screen-fulls, compute the number of lines to
4293 scroll from the window's height. */
4294 if (whole)
4295 n *= max (1, ht - next_screen_context_lines);
4297 startpos = marker_position (w->start);
4299 posit = *compute_motion (startpos, 0, 0, 0,
4300 PT, ht, 0,
4301 window_internal_width (w), XINT (w->hscroll),
4302 0, w);
4303 original_vpos = posit.vpos;
4305 XSETFASTINT (tem, PT);
4306 tem = Fpos_visible_in_window_p (tem, window, Qnil);
4308 if (NILP (tem))
4310 Fvertical_motion (make_number (- (ht / 2)), window);
4311 startpos = PT;
4314 SET_PT (startpos);
4315 lose = n < 0 && PT == BEGV;
4316 Fvertical_motion (make_number (n), window);
4317 pos = PT;
4318 pos_byte = PT_BYTE;
4319 bolp = Fbolp ();
4320 SET_PT_BOTH (opoint, opoint_byte);
4322 if (lose)
4324 if (noerror)
4325 return;
4326 else
4327 Fsignal (Qbeginning_of_buffer, Qnil);
4330 if (pos < ZV)
4332 int this_scroll_margin = scroll_margin;
4334 /* Don't use a scroll margin that is negative or too large. */
4335 if (this_scroll_margin < 0)
4336 this_scroll_margin = 0;
4338 if (XINT (w->height) < 4 * scroll_margin)
4339 this_scroll_margin = XINT (w->height) / 4;
4341 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
4342 w->start_at_line_beg = bolp;
4343 w->update_mode_line = Qt;
4344 XSETFASTINT (w->last_modified, 0);
4345 XSETFASTINT (w->last_overlay_modified, 0);
4346 /* Set force_start so that redisplay_window will run
4347 the window-scroll-functions. */
4348 w->force_start = Qt;
4350 if (whole && !NILP (Vscroll_preserve_screen_position))
4352 SET_PT_BOTH (pos, pos_byte);
4353 Fvertical_motion (make_number (original_vpos), window);
4355 /* If we scrolled forward, put point enough lines down
4356 that it is outside the scroll margin. */
4357 else if (n > 0)
4359 int top_margin;
4361 if (this_scroll_margin > 0)
4363 SET_PT_BOTH (pos, pos_byte);
4364 Fvertical_motion (make_number (this_scroll_margin), window);
4365 top_margin = PT;
4367 else
4368 top_margin = pos;
4370 if (top_margin <= opoint)
4371 SET_PT_BOTH (opoint, opoint_byte);
4372 else if (!NILP (Vscroll_preserve_screen_position))
4374 SET_PT_BOTH (pos, pos_byte);
4375 Fvertical_motion (make_number (original_vpos), window);
4377 else
4378 SET_PT (top_margin);
4380 else if (n < 0)
4382 int bottom_margin;
4384 /* If we scrolled backward, put point near the end of the window
4385 but not within the scroll margin. */
4386 SET_PT_BOTH (pos, pos_byte);
4387 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
4388 if (XFASTINT (tem) == ht - this_scroll_margin)
4389 bottom_margin = PT;
4390 else
4391 bottom_margin = PT + 1;
4393 if (bottom_margin > opoint)
4394 SET_PT_BOTH (opoint, opoint_byte);
4395 else
4397 if (!NILP (Vscroll_preserve_screen_position))
4399 SET_PT_BOTH (pos, pos_byte);
4400 Fvertical_motion (make_number (original_vpos), window);
4402 else
4403 Fvertical_motion (make_number (-1), window);
4407 else
4409 if (noerror)
4410 return;
4411 else
4412 Fsignal (Qend_of_buffer, Qnil);
4417 /* Scroll selected_window up or down. If N is nil, scroll a
4418 screen-full which is defined as the height of the window minus
4419 next_screen_context_lines. If N is the symbol `-', scroll.
4420 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4421 up. This is the guts of Fscroll_up and Fscroll_down. */
4423 static void
4424 scroll_command (n, direction)
4425 Lisp_Object n;
4426 int direction;
4428 int count = SPECPDL_INDEX ();
4430 xassert (abs (direction) == 1);
4432 /* If selected window's buffer isn't current, make it current for
4433 the moment. But don't screw up if window_scroll gets an error. */
4434 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
4436 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4437 Fset_buffer (XWINDOW (selected_window)->buffer);
4439 /* Make redisplay consider other windows than just selected_window. */
4440 ++windows_or_buffers_changed;
4443 if (NILP (n))
4444 window_scroll (selected_window, direction, 1, 0);
4445 else if (EQ (n, Qminus))
4446 window_scroll (selected_window, -direction, 1, 0);
4447 else
4449 n = Fprefix_numeric_value (n);
4450 window_scroll (selected_window, XINT (n) * direction, 0, 0);
4453 unbind_to (count, Qnil);
4456 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "P",
4457 doc: /* Scroll text of current window upward ARG lines; or near full screen if no ARG.
4458 A near full screen is `next-screen-context-lines' less than a full screen.
4459 Negative ARG means scroll downward.
4460 If ARG is the atom `-', scroll downward by nearly full screen.
4461 When calling from a program, supply as argument a number, nil, or `-'. */)
4462 (arg)
4463 Lisp_Object arg;
4465 scroll_command (arg, 1);
4466 return Qnil;
4469 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "P",
4470 doc: /* Scroll text of current window down ARG lines; or near full screen if no ARG.
4471 A near full screen is `next-screen-context-lines' less than a full screen.
4472 Negative ARG means scroll upward.
4473 If ARG is the atom `-', scroll upward by nearly full screen.
4474 When calling from a program, supply as argument a number, nil, or `-'. */)
4475 (arg)
4476 Lisp_Object arg;
4478 scroll_command (arg, -1);
4479 return Qnil;
4482 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
4483 doc: /* Return the other window for \"other window scroll\" commands.
4484 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4485 specifies the window.
4486 If `other-window-scroll-buffer' is non-nil, a window
4487 showing that buffer is used. */)
4490 Lisp_Object window;
4492 if (MINI_WINDOW_P (XWINDOW (selected_window))
4493 && !NILP (Vminibuf_scroll_window))
4494 window = Vminibuf_scroll_window;
4495 /* If buffer is specified, scroll that buffer. */
4496 else if (!NILP (Vother_window_scroll_buffer))
4498 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
4499 if (NILP (window))
4500 window = Fdisplay_buffer (Vother_window_scroll_buffer, Qt, Qnil);
4502 else
4504 /* Nothing specified; look for a neighboring window on the same
4505 frame. */
4506 window = Fnext_window (selected_window, Qnil, Qnil);
4508 if (EQ (window, selected_window))
4509 /* That didn't get us anywhere; look for a window on another
4510 visible frame. */
4512 window = Fnext_window (window, Qnil, Qt);
4513 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
4514 && ! EQ (window, selected_window));
4517 CHECK_LIVE_WINDOW (window);
4519 if (EQ (window, selected_window))
4520 error ("There is no other window");
4522 return window;
4525 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
4526 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
4527 A near full screen is `next-screen-context-lines' less than a full screen.
4528 The next window is the one below the current one; or the one at the top
4529 if the current one is at the bottom. Negative ARG means scroll downward.
4530 If ARG is the atom `-', scroll downward by nearly full screen.
4531 When calling from a program, supply as argument a number, nil, or `-'.
4533 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4534 specifies the window to scroll.
4535 If `other-window-scroll-buffer' is non-nil, scroll the window
4536 showing that buffer, popping the buffer up if necessary. */)
4537 (arg)
4538 Lisp_Object arg;
4540 Lisp_Object window;
4541 struct window *w;
4542 int count = SPECPDL_INDEX ();
4544 window = Fother_window_for_scrolling ();
4545 w = XWINDOW (window);
4547 /* Don't screw up if window_scroll gets an error. */
4548 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4549 ++windows_or_buffers_changed;
4551 Fset_buffer (w->buffer);
4552 SET_PT (marker_position (w->pointm));
4554 if (NILP (arg))
4555 window_scroll (window, 1, 1, 1);
4556 else if (EQ (arg, Qminus))
4557 window_scroll (window, -1, 1, 1);
4558 else
4560 if (CONSP (arg))
4561 arg = Fcar (arg);
4562 CHECK_NUMBER (arg);
4563 window_scroll (window, XINT (arg), 0, 1);
4566 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
4567 unbind_to (count, Qnil);
4569 return Qnil;
4572 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 1, "P",
4573 doc: /* Scroll selected window display ARG columns left.
4574 Default for ARG is window width minus 2.
4575 Value is the total amount of leftward horizontal scrolling in
4576 effect after the change.
4577 If `automatic-hscrolling' is non-nil, the argument ARG modifies
4578 a lower bound for automatic scrolling, i.e. automatic scrolling
4579 will not scroll a window to a column less than the value returned
4580 by this function. */)
4581 (arg)
4582 register Lisp_Object arg;
4584 Lisp_Object result;
4585 int hscroll;
4586 struct window *w = XWINDOW (selected_window);
4588 if (NILP (arg))
4589 XSETFASTINT (arg, window_internal_width (w) - 2);
4590 else
4591 arg = Fprefix_numeric_value (arg);
4593 hscroll = XINT (w->hscroll) + XINT (arg);
4594 result = Fset_window_hscroll (selected_window, make_number (hscroll));
4596 if (interactive_p (0))
4597 w->min_hscroll = w->hscroll;
4599 return result;
4602 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 1, "P",
4603 doc: /* Scroll selected window display ARG columns right.
4604 Default for ARG is window width minus 2.
4605 Value is the total amount of leftward horizontal scrolling in
4606 effect after the change.
4607 If `automatic-hscrolling' is non-nil, the argument ARG modifies
4608 a lower bound for automatic scrolling, i.e. automatic scrolling
4609 will not scroll a window to a column less than the value returned
4610 by this function. */)
4611 (arg)
4612 register Lisp_Object arg;
4614 Lisp_Object result;
4615 int hscroll;
4616 struct window *w = XWINDOW (selected_window);
4618 if (NILP (arg))
4619 XSETFASTINT (arg, window_internal_width (w) - 2);
4620 else
4621 arg = Fprefix_numeric_value (arg);
4623 hscroll = XINT (w->hscroll) - XINT (arg);
4624 result = Fset_window_hscroll (selected_window, make_number (hscroll));
4626 if (interactive_p (0))
4627 w->min_hscroll = w->hscroll;
4629 return result;
4632 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
4633 doc: /* Return the window which was selected when entering the minibuffer.
4634 Returns nil, if current window is not a minibuffer window. */)
4637 if (minibuf_level > 0
4638 && MINI_WINDOW_P (XWINDOW (selected_window))
4639 && !NILP (minibuf_selected_window)
4640 && WINDOW_LIVE_P (minibuf_selected_window))
4641 return minibuf_selected_window;
4643 return Qnil;
4646 /* Value is the number of lines actually displayed in window W,
4647 as opposed to its height. */
4649 static int
4650 displayed_window_lines (w)
4651 struct window *w;
4653 struct it it;
4654 struct text_pos start;
4655 int height = window_box_height (w);
4656 struct buffer *old_buffer;
4657 int bottom_y;
4659 if (XBUFFER (w->buffer) != current_buffer)
4661 old_buffer = current_buffer;
4662 set_buffer_internal (XBUFFER (w->buffer));
4664 else
4665 old_buffer = NULL;
4667 /* In case W->start is out of the accessible range, do something
4668 reasonable. This happens in Info mode when Info-scroll-down
4669 calls (recenter -1) while W->start is 1. */
4670 if (XMARKER (w->start)->charpos < BEGV)
4671 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
4672 else if (XMARKER (w->start)->charpos > ZV)
4673 SET_TEXT_POS (start, ZV, ZV_BYTE);
4674 else
4675 SET_TEXT_POS_FROM_MARKER (start, w->start);
4677 start_display (&it, w, start);
4678 move_it_vertically (&it, height);
4679 bottom_y = line_bottom_y (&it);
4681 /* rms: On a non-window display,
4682 the value of it.vpos at the bottom of the screen
4683 seems to be 1 larger than window_box_height (w).
4684 This kludge fixes a bug whereby (move-to-window-line -1)
4685 when ZV is on the last screen line
4686 moves to the previous screen line instead of the last one. */
4687 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
4688 height++;
4690 /* Add in empty lines at the bottom of the window. */
4691 if (bottom_y < height)
4693 int uy = CANON_Y_UNIT (it.f);
4694 it.vpos += (height - bottom_y + uy - 1) / uy;
4697 if (old_buffer)
4698 set_buffer_internal (old_buffer);
4700 return it.vpos;
4704 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
4705 doc: /* Center point in window and redisplay frame.
4706 With prefix argument ARG, recenter putting point on screen line ARG
4707 relative to the current window. If ARG is negative, it counts up from the
4708 bottom of the window. (ARG should be less than the height of the window.)
4710 If ARG is omitted or nil, erase the entire frame and then
4711 redraw with point in the center of the current window.
4712 Just C-u as prefix means put point in the center of the window
4713 and redisplay normally--don't erase and redraw the frame. */)
4714 (arg)
4715 register Lisp_Object arg;
4717 struct window *w = XWINDOW (selected_window);
4718 struct buffer *buf = XBUFFER (w->buffer);
4719 struct buffer *obuf = current_buffer;
4720 int center_p = 0;
4721 int charpos, bytepos;
4723 /* If redisplay is suppressed due to an error, try again. */
4724 obuf->display_error_modiff = 0;
4726 if (NILP (arg))
4728 int i;
4730 /* Invalidate pixel data calculated for all compositions. */
4731 for (i = 0; i < n_compositions; i++)
4732 composition_table[i]->font = NULL;
4734 Fredraw_frame (w->frame);
4735 SET_FRAME_GARBAGED (XFRAME (WINDOW_FRAME (w)));
4736 center_p = 1;
4738 else if (CONSP (arg)) /* Just C-u. */
4739 center_p = 1;
4740 else
4742 arg = Fprefix_numeric_value (arg);
4743 CHECK_NUMBER (arg);
4746 set_buffer_internal (buf);
4748 /* Handle centering on a graphical frame specially. Such frames can
4749 have variable-height lines and centering point on the basis of
4750 line counts would lead to strange effects. */
4751 if (FRAME_WINDOW_P (XFRAME (w->frame)))
4753 if (center_p)
4755 struct it it;
4756 struct text_pos pt;
4758 SET_TEXT_POS (pt, PT, PT_BYTE);
4759 start_display (&it, w, pt);
4760 move_it_vertically (&it, - window_box_height (w) / 2);
4761 charpos = IT_CHARPOS (it);
4762 bytepos = IT_BYTEPOS (it);
4764 else if (XINT (arg) < 0)
4766 struct it it;
4767 struct text_pos pt;
4768 int y0, y1, h, nlines;
4770 SET_TEXT_POS (pt, PT, PT_BYTE);
4771 start_display (&it, w, pt);
4772 y0 = it.current_y;
4774 /* The amount of pixels we have to move back is the window
4775 height minus what's displayed in the line containing PT,
4776 and the lines below. */
4777 nlines = - XINT (arg) - 1;
4778 move_it_by_lines (&it, nlines, 1);
4780 y1 = line_bottom_y (&it);
4782 /* If we can't move down NLINES lines because we hit
4783 the end of the buffer, count in some empty lines. */
4784 if (it.vpos < nlines)
4785 y1 += (nlines - it.vpos) * CANON_Y_UNIT (it.f);
4787 h = window_box_height (w) - (y1 - y0);
4789 start_display (&it, w, pt);
4790 move_it_vertically (&it, - h);
4791 charpos = IT_CHARPOS (it);
4792 bytepos = IT_BYTEPOS (it);
4794 else
4796 struct position pos;
4797 pos = *vmotion (PT, - XINT (arg), w);
4798 charpos = pos.bufpos;
4799 bytepos = pos.bytepos;
4802 else
4804 struct position pos;
4805 int ht = window_internal_height (w);
4807 if (center_p)
4808 arg = make_number (ht / 2);
4809 else if (XINT (arg) < 0)
4810 arg = make_number (XINT (arg) + ht);
4812 pos = *vmotion (PT, - XINT (arg), w);
4813 charpos = pos.bufpos;
4814 bytepos = pos.bytepos;
4817 /* Set the new window start. */
4818 set_marker_both (w->start, w->buffer, charpos, bytepos);
4819 w->window_end_valid = Qnil;
4821 w->optional_new_start = Qt;
4823 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
4824 w->start_at_line_beg = Qt;
4825 else
4826 w->start_at_line_beg = Qnil;
4828 set_buffer_internal (obuf);
4829 return Qnil;
4833 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
4834 0, 1, 0,
4835 doc: /* Return the height in lines of the text display area of WINDOW.
4836 This doesn't include the mode-line (or header-line if any) or any
4837 partial-height lines in the text display area. */)
4838 (window)
4839 Lisp_Object window;
4841 struct window *w = decode_window (window);
4842 int pixel_height = window_box_height (w);
4843 int line_height = pixel_height / CANON_Y_UNIT (XFRAME (w->frame));
4844 return make_number (line_height);
4849 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
4850 1, 1, "P",
4851 doc: /* Position point relative to window.
4852 With no argument, position point at center of window.
4853 An argument specifies vertical position within the window;
4854 zero means top of window, negative means relative to bottom of window. */)
4855 (arg)
4856 Lisp_Object arg;
4858 struct window *w = XWINDOW (selected_window);
4859 int lines, start;
4860 Lisp_Object window;
4862 window = selected_window;
4863 start = marker_position (w->start);
4864 if (start < BEGV || start > ZV)
4866 int height = window_internal_height (w);
4867 Fvertical_motion (make_number (- (height / 2)), window);
4868 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
4869 w->start_at_line_beg = Fbolp ();
4870 w->force_start = Qt;
4872 else
4873 Fgoto_char (w->start);
4875 lines = displayed_window_lines (w);
4876 if (NILP (arg))
4877 XSETFASTINT (arg, lines / 2);
4878 else
4880 arg = Fprefix_numeric_value (arg);
4881 if (XINT (arg) < 0)
4882 XSETINT (arg, XINT (arg) + lines);
4885 /* Skip past a partially visible first line. */
4886 if (w->vscroll)
4887 XSETINT (arg, XINT (arg) + 1);
4889 return Fvertical_motion (arg, window);
4894 /***********************************************************************
4895 Window Configuration
4896 ***********************************************************************/
4898 struct save_window_data
4900 EMACS_INT size_from_Lisp_Vector_struct;
4901 struct Lisp_Vector *next_from_Lisp_Vector_struct;
4902 Lisp_Object frame_width, frame_height, frame_menu_bar_lines;
4903 Lisp_Object frame_tool_bar_lines;
4904 Lisp_Object selected_frame;
4905 Lisp_Object current_window;
4906 Lisp_Object current_buffer;
4907 Lisp_Object minibuf_scroll_window;
4908 Lisp_Object minibuf_selected_window;
4909 Lisp_Object root_window;
4910 Lisp_Object focus_frame;
4911 /* Record the values of window-min-width and window-min-height
4912 so that window sizes remain consistent with them. */
4913 Lisp_Object min_width, min_height;
4914 /* A vector, each of whose elements is a struct saved_window
4915 for one window. */
4916 Lisp_Object saved_windows;
4919 /* This is saved as a Lisp_Vector */
4920 struct saved_window
4922 /* these first two must agree with struct Lisp_Vector in lisp.h */
4923 EMACS_INT size_from_Lisp_Vector_struct;
4924 struct Lisp_Vector *next_from_Lisp_Vector_struct;
4926 Lisp_Object window;
4927 Lisp_Object buffer, start, pointm, mark;
4928 Lisp_Object left, top, width, height, hscroll, min_hscroll;
4929 Lisp_Object parent, prev;
4930 Lisp_Object start_at_line_beg;
4931 Lisp_Object display_table;
4932 Lisp_Object orig_top, orig_height;
4935 #define SAVED_WINDOW_VECTOR_SIZE 17 /* Arg to Fmake_vector */
4937 #define SAVED_WINDOW_N(swv,n) \
4938 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
4940 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
4941 doc: /* Return t if OBJECT is a window-configuration object. */)
4942 (object)
4943 Lisp_Object object;
4945 if (WINDOW_CONFIGURATIONP (object))
4946 return Qt;
4947 return Qnil;
4950 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
4951 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
4952 (config)
4953 Lisp_Object config;
4955 register struct save_window_data *data;
4956 struct Lisp_Vector *saved_windows;
4958 if (! WINDOW_CONFIGURATIONP (config))
4959 wrong_type_argument (Qwindow_configuration_p, config);
4961 data = (struct save_window_data *) XVECTOR (config);
4962 saved_windows = XVECTOR (data->saved_windows);
4963 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
4966 DEFUN ("set-window-configuration", Fset_window_configuration,
4967 Sset_window_configuration, 1, 1, 0,
4968 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
4969 CONFIGURATION must be a value previously returned
4970 by `current-window-configuration' (which see).
4971 If CONFIGURATION was made from a frame that is now deleted,
4972 only frame-independent values can be restored. In this case,
4973 the return value is nil. Otherwise the value is t. */)
4974 (configuration)
4975 Lisp_Object configuration;
4977 register struct save_window_data *data;
4978 struct Lisp_Vector *saved_windows;
4979 Lisp_Object new_current_buffer;
4980 Lisp_Object frame;
4981 FRAME_PTR f;
4982 int old_point = -1;
4984 while (!WINDOW_CONFIGURATIONP (configuration))
4985 wrong_type_argument (Qwindow_configuration_p, configuration);
4987 data = (struct save_window_data *) XVECTOR (configuration);
4988 saved_windows = XVECTOR (data->saved_windows);
4990 new_current_buffer = data->current_buffer;
4991 if (NILP (XBUFFER (new_current_buffer)->name))
4992 new_current_buffer = Qnil;
4993 else
4995 if (XBUFFER (new_current_buffer) == current_buffer)
4996 old_point = PT;
4997 else
4998 old_point = BUF_PT (XBUFFER (new_current_buffer));
5001 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5002 f = XFRAME (frame);
5004 /* If f is a dead frame, don't bother rebuilding its window tree.
5005 However, there is other stuff we should still try to do below. */
5006 if (FRAME_LIVE_P (f))
5008 register struct window *w;
5009 register struct saved_window *p;
5010 struct window *root_window;
5011 struct window **leaf_windows;
5012 int n_leaf_windows;
5013 int k, i, n;
5015 /* If the frame has been resized since this window configuration was
5016 made, we change the frame to the size specified in the
5017 configuration, restore the configuration, and then resize it
5018 back. We keep track of the prevailing height in these variables. */
5019 int previous_frame_height = FRAME_HEIGHT (f);
5020 int previous_frame_width = FRAME_WIDTH (f);
5021 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5022 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5024 /* The mouse highlighting code could get screwed up
5025 if it runs during this. */
5026 BLOCK_INPUT;
5028 if (XFASTINT (data->frame_height) != previous_frame_height
5029 || XFASTINT (data->frame_width) != previous_frame_width)
5030 change_frame_size (f, XFASTINT (data->frame_height),
5031 XFASTINT (data->frame_width), 0, 0, 0);
5032 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5033 if (XFASTINT (data->frame_menu_bar_lines)
5034 != previous_frame_menu_bar_lines)
5035 x_set_menu_bar_lines (f, data->frame_menu_bar_lines, make_number (0));
5036 #ifdef HAVE_WINDOW_SYSTEM
5037 if (XFASTINT (data->frame_tool_bar_lines)
5038 != previous_frame_tool_bar_lines)
5039 x_set_tool_bar_lines (f, data->frame_tool_bar_lines, make_number (0));
5040 #endif
5041 #endif
5043 /* "Swap out" point from the selected window
5044 into its buffer. We do this now, before
5045 restoring the window contents, and prevent it from
5046 being done later on when we select a new window. */
5047 if (! NILP (XWINDOW (selected_window)->buffer))
5049 w = XWINDOW (selected_window);
5050 set_marker_both (w->pointm,
5051 w->buffer,
5052 BUF_PT (XBUFFER (w->buffer)),
5053 BUF_PT_BYTE (XBUFFER (w->buffer)));
5056 windows_or_buffers_changed++;
5057 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
5059 /* Problem: Freeing all matrices and later allocating them again
5060 is a serious redisplay flickering problem. What we would
5061 really like to do is to free only those matrices not reused
5062 below. */
5063 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
5064 leaf_windows
5065 = (struct window **) alloca (count_windows (root_window)
5066 * sizeof (struct window *));
5067 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
5069 /* Temporarily avoid any problems with windows that are smaller
5070 than they are supposed to be. */
5071 window_min_height = 1;
5072 window_min_width = 1;
5074 /* Kludge Alert!
5075 Mark all windows now on frame as "deleted".
5076 Restoring the new configuration "undeletes" any that are in it.
5078 Save their current buffers in their height fields, since we may
5079 need it later, if a buffer saved in the configuration is now
5080 dead. */
5081 delete_all_subwindows (XWINDOW (FRAME_ROOT_WINDOW (f)));
5083 for (k = 0; k < saved_windows->size; k++)
5085 p = SAVED_WINDOW_N (saved_windows, k);
5086 w = XWINDOW (p->window);
5087 w->next = Qnil;
5089 if (!NILP (p->parent))
5090 w->parent = SAVED_WINDOW_N (saved_windows,
5091 XFASTINT (p->parent))->window;
5092 else
5093 w->parent = Qnil;
5095 if (!NILP (p->prev))
5097 w->prev = SAVED_WINDOW_N (saved_windows,
5098 XFASTINT (p->prev))->window;
5099 XWINDOW (w->prev)->next = p->window;
5101 else
5103 w->prev = Qnil;
5104 if (!NILP (w->parent))
5106 if (EQ (p->width, XWINDOW (w->parent)->width))
5108 XWINDOW (w->parent)->vchild = p->window;
5109 XWINDOW (w->parent)->hchild = Qnil;
5111 else
5113 XWINDOW (w->parent)->hchild = p->window;
5114 XWINDOW (w->parent)->vchild = Qnil;
5119 /* If we squirreled away the buffer in the window's height,
5120 restore it now. */
5121 if (BUFFERP (w->height))
5122 w->buffer = w->height;
5123 w->left = p->left;
5124 w->top = p->top;
5125 w->width = p->width;
5126 w->height = p->height;
5127 w->hscroll = p->hscroll;
5128 w->min_hscroll = p->min_hscroll;
5129 w->display_table = p->display_table;
5130 w->orig_top = p->orig_top;
5131 w->orig_height = p->orig_height;
5132 XSETFASTINT (w->last_modified, 0);
5133 XSETFASTINT (w->last_overlay_modified, 0);
5135 /* Reinstall the saved buffer and pointers into it. */
5136 if (NILP (p->buffer))
5137 w->buffer = p->buffer;
5138 else
5140 if (!NILP (XBUFFER (p->buffer)->name))
5141 /* If saved buffer is alive, install it. */
5143 w->buffer = p->buffer;
5144 w->start_at_line_beg = p->start_at_line_beg;
5145 set_marker_restricted (w->start, p->start, w->buffer);
5146 set_marker_restricted (w->pointm, p->pointm, w->buffer);
5147 Fset_marker (XBUFFER (w->buffer)->mark,
5148 p->mark, w->buffer);
5150 /* As documented in Fcurrent_window_configuration, don't
5151 restore the location of point in the buffer which was
5152 current when the window configuration was recorded. */
5153 if (!EQ (p->buffer, new_current_buffer)
5154 && XBUFFER (p->buffer) == current_buffer)
5155 Fgoto_char (w->pointm);
5157 else if (NILP (w->buffer) || NILP (XBUFFER (w->buffer)->name))
5158 /* Else unless window has a live buffer, get one. */
5160 w->buffer = Fcdr (Fcar (Vbuffer_alist));
5161 /* This will set the markers to beginning of visible
5162 range. */
5163 set_marker_restricted (w->start, make_number (0), w->buffer);
5164 set_marker_restricted (w->pointm, make_number (0),w->buffer);
5165 w->start_at_line_beg = Qt;
5167 else
5168 /* Keeping window's old buffer; make sure the markers
5169 are real. */
5171 /* Set window markers at start of visible range. */
5172 if (XMARKER (w->start)->buffer == 0)
5173 set_marker_restricted (w->start, make_number (0),
5174 w->buffer);
5175 if (XMARKER (w->pointm)->buffer == 0)
5176 set_marker_restricted_both (w->pointm, w->buffer,
5177 BUF_PT (XBUFFER (w->buffer)),
5178 BUF_PT_BYTE (XBUFFER (w->buffer)));
5179 w->start_at_line_beg = Qt;
5184 FRAME_ROOT_WINDOW (f) = data->root_window;
5185 /* Prevent "swapping out point" in the old selected window
5186 using the buffer that has been restored into it.
5187 Use the point value from the beginning of this function
5188 since unshow_buffer (called from delete_all_subwindows)
5189 could have altered it. */
5190 selected_window = Qnil;
5191 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
5192 set_marker_restricted (XWINDOW (data->current_window)->pointm,
5193 make_number (old_point),
5194 XWINDOW (data->current_window)->buffer);
5196 Fselect_window (data->current_window);
5197 XBUFFER (XWINDOW (selected_window)->buffer)->last_selected_window
5198 = selected_window;
5200 if (NILP (data->focus_frame)
5201 || (FRAMEP (data->focus_frame)
5202 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
5203 Fredirect_frame_focus (frame, data->focus_frame);
5205 #if 0 /* I don't understand why this is needed, and it causes problems
5206 when the frame's old selected window has been deleted. */
5207 if (f != selected_frame && FRAME_WINDOW_P (f))
5208 do_switch_frame (WINDOW_FRAME (XWINDOW (data->root_window)),
5209 0, 0);
5210 #endif
5212 /* Set the screen height to the value it had before this function. */
5213 if (previous_frame_height != FRAME_HEIGHT (f)
5214 || previous_frame_width != FRAME_WIDTH (f))
5215 change_frame_size (f, previous_frame_height, previous_frame_width,
5216 0, 0, 0);
5217 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5218 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
5219 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
5220 make_number (0));
5221 #ifdef HAVE_WINDOW_SYSTEM
5222 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
5223 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
5224 make_number (0));
5225 #endif
5226 #endif
5228 /* Now, free glyph matrices in windows that were not reused. */
5229 for (i = n = 0; i < n_leaf_windows; ++i)
5231 if (NILP (leaf_windows[i]->buffer))
5233 /* Assert it's not reused as a combination. */
5234 xassert (NILP (leaf_windows[i]->hchild)
5235 && NILP (leaf_windows[i]->vchild));
5236 free_window_matrices (leaf_windows[i]);
5238 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
5239 ++n;
5242 adjust_glyphs (f);
5244 UNBLOCK_INPUT;
5246 /* Fselect_window will have made f the selected frame, so we
5247 reselect the proper frame here. Fhandle_switch_frame will change the
5248 selected window too, but that doesn't make the call to
5249 Fselect_window above totally superfluous; it still sets f's
5250 selected window. */
5251 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
5252 do_switch_frame (data->selected_frame, 0, 0);
5254 if (! NILP (Vwindow_configuration_change_hook)
5255 && ! NILP (Vrun_hooks))
5256 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
5259 if (!NILP (new_current_buffer))
5260 Fset_buffer (new_current_buffer);
5262 /* Restore the minimum heights recorded in the configuration. */
5263 window_min_height = XINT (data->min_height);
5264 window_min_width = XINT (data->min_width);
5266 Vminibuf_scroll_window = data->minibuf_scroll_window;
5267 minibuf_selected_window = data->minibuf_selected_window;
5269 return (FRAME_LIVE_P (f) ? Qt : Qnil);
5272 /* Mark all windows now on frame as deleted
5273 by setting their buffers to nil. */
5275 void
5276 delete_all_subwindows (w)
5277 register struct window *w;
5279 if (!NILP (w->next))
5280 delete_all_subwindows (XWINDOW (w->next));
5281 if (!NILP (w->vchild))
5282 delete_all_subwindows (XWINDOW (w->vchild));
5283 if (!NILP (w->hchild))
5284 delete_all_subwindows (XWINDOW (w->hchild));
5286 w->height = w->buffer; /* See Fset_window_configuration for excuse. */
5288 if (!NILP (w->buffer))
5289 unshow_buffer (w);
5291 /* We set all three of these fields to nil, to make sure that we can
5292 distinguish this dead window from any live window. Live leaf
5293 windows will have buffer set, and combination windows will have
5294 vchild or hchild set. */
5295 w->buffer = Qnil;
5296 w->vchild = Qnil;
5297 w->hchild = Qnil;
5299 Vwindow_list = Qnil;
5302 static int
5303 count_windows (window)
5304 register struct window *window;
5306 register int count = 1;
5307 if (!NILP (window->next))
5308 count += count_windows (XWINDOW (window->next));
5309 if (!NILP (window->vchild))
5310 count += count_windows (XWINDOW (window->vchild));
5311 if (!NILP (window->hchild))
5312 count += count_windows (XWINDOW (window->hchild));
5313 return count;
5317 /* Fill vector FLAT with leaf windows under W, starting at index I.
5318 Value is last index + 1. */
5320 static int
5321 get_leaf_windows (w, flat, i)
5322 struct window *w;
5323 struct window **flat;
5324 int i;
5326 while (w)
5328 if (!NILP (w->hchild))
5329 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
5330 else if (!NILP (w->vchild))
5331 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
5332 else
5333 flat[i++] = w;
5335 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5338 return i;
5342 /* Return a pointer to the glyph W's physical cursor is on. Value is
5343 null if W's current matrix is invalid, so that no meaningfull glyph
5344 can be returned. */
5346 struct glyph *
5347 get_phys_cursor_glyph (w)
5348 struct window *w;
5350 struct glyph_row *row;
5351 struct glyph *glyph;
5353 if (w->phys_cursor.vpos >= 0
5354 && w->phys_cursor.vpos < w->current_matrix->nrows
5355 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
5356 row->enabled_p)
5357 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
5358 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
5359 else
5360 glyph = NULL;
5362 return glyph;
5366 static int
5367 save_window_save (window, vector, i)
5368 Lisp_Object window;
5369 struct Lisp_Vector *vector;
5370 int i;
5372 register struct saved_window *p;
5373 register struct window *w;
5374 register Lisp_Object tem;
5376 for (;!NILP (window); window = w->next)
5378 p = SAVED_WINDOW_N (vector, i);
5379 w = XWINDOW (window);
5381 XSETFASTINT (w->temslot, i++);
5382 p->window = window;
5383 p->buffer = w->buffer;
5384 p->left = w->left;
5385 p->top = w->top;
5386 p->width = w->width;
5387 p->height = w->height;
5388 p->hscroll = w->hscroll;
5389 p->min_hscroll = w->min_hscroll;
5390 p->display_table = w->display_table;
5391 p->orig_top = w->orig_top;
5392 p->orig_height = w->orig_height;
5393 if (!NILP (w->buffer))
5395 /* Save w's value of point in the window configuration.
5396 If w is the selected window, then get the value of point
5397 from the buffer; pointm is garbage in the selected window. */
5398 if (EQ (window, selected_window))
5400 p->pointm = Fmake_marker ();
5401 set_marker_both (p->pointm, w->buffer,
5402 BUF_PT (XBUFFER (w->buffer)),
5403 BUF_PT_BYTE (XBUFFER (w->buffer)));
5405 else
5406 p->pointm = Fcopy_marker (w->pointm, Qnil);
5408 p->start = Fcopy_marker (w->start, Qnil);
5409 p->start_at_line_beg = w->start_at_line_beg;
5411 tem = XBUFFER (w->buffer)->mark;
5412 p->mark = Fcopy_marker (tem, Qnil);
5414 else
5416 p->pointm = Qnil;
5417 p->start = Qnil;
5418 p->mark = Qnil;
5419 p->start_at_line_beg = Qnil;
5422 if (NILP (w->parent))
5423 p->parent = Qnil;
5424 else
5425 p->parent = XWINDOW (w->parent)->temslot;
5427 if (NILP (w->prev))
5428 p->prev = Qnil;
5429 else
5430 p->prev = XWINDOW (w->prev)->temslot;
5432 if (!NILP (w->vchild))
5433 i = save_window_save (w->vchild, vector, i);
5434 if (!NILP (w->hchild))
5435 i = save_window_save (w->hchild, vector, i);
5438 return i;
5441 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
5442 Scurrent_window_configuration, 0, 1, 0,
5443 doc: /* Return an object representing the current window configuration of FRAME.
5444 If FRAME is nil or omitted, use the selected frame.
5445 This describes the number of windows, their sizes and current buffers,
5446 and for each displayed buffer, where display starts, and the positions of
5447 point and mark. An exception is made for point in the current buffer:
5448 its value is -not- saved.
5449 This also records the currently selected frame, and FRAME's focus
5450 redirection (see `redirect-frame-focus'). */)
5451 (frame)
5452 Lisp_Object frame;
5454 register Lisp_Object tem;
5455 register int n_windows;
5456 register struct save_window_data *data;
5457 register struct Lisp_Vector *vec;
5458 register int i;
5459 FRAME_PTR f;
5461 if (NILP (frame))
5462 frame = selected_frame;
5463 CHECK_LIVE_FRAME (frame);
5464 f = XFRAME (frame);
5466 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
5467 vec = allocate_other_vector (VECSIZE (struct save_window_data));
5468 data = (struct save_window_data *)vec;
5470 XSETFASTINT (data->frame_width, FRAME_WIDTH (f));
5471 XSETFASTINT (data->frame_height, FRAME_HEIGHT (f));
5472 XSETFASTINT (data->frame_menu_bar_lines, FRAME_MENU_BAR_LINES (f));
5473 XSETFASTINT (data->frame_tool_bar_lines, FRAME_TOOL_BAR_LINES (f));
5474 data->selected_frame = selected_frame;
5475 data->current_window = FRAME_SELECTED_WINDOW (f);
5476 XSETBUFFER (data->current_buffer, current_buffer);
5477 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
5478 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
5479 data->root_window = FRAME_ROOT_WINDOW (f);
5480 data->focus_frame = FRAME_FOCUS_FRAME (f);
5481 XSETINT (data->min_height, window_min_height);
5482 XSETINT (data->min_width, window_min_width);
5483 tem = Fmake_vector (make_number (n_windows), Qnil);
5484 data->saved_windows = tem;
5485 for (i = 0; i < n_windows; i++)
5486 XVECTOR (tem)->contents[i]
5487 = Fmake_vector (make_number (SAVED_WINDOW_VECTOR_SIZE), Qnil);
5488 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
5489 XSETWINDOW_CONFIGURATION (tem, data);
5490 return (tem);
5493 DEFUN ("save-window-excursion", Fsave_window_excursion, Ssave_window_excursion,
5494 0, UNEVALLED, 0,
5495 doc: /* Execute body, preserving window sizes and contents.
5496 Restore which buffer appears in which window, where display starts,
5497 and the value of point and mark for each window.
5498 Also restore the choice of selected window.
5499 Also restore which buffer is current.
5500 Does not restore the value of point in current buffer.
5501 usage: (save-window-excursion BODY ...) */)
5502 (args)
5503 Lisp_Object args;
5505 register Lisp_Object val;
5506 register int count = SPECPDL_INDEX ();
5508 record_unwind_protect (Fset_window_configuration,
5509 Fcurrent_window_configuration (Qnil));
5510 val = Fprogn (args);
5511 return unbind_to (count, val);
5515 /***********************************************************************
5516 Marginal Areas
5517 ***********************************************************************/
5519 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
5520 2, 3, 0,
5521 doc: /* Set width of marginal areas of window WINDOW.
5522 If window is nil, set margins of the currently selected window.
5523 First parameter LEFT-WIDTH specifies the number of character
5524 cells to reserve for the left marginal area. Second parameter
5525 RIGHT-WIDTH does the same for the right marginal area.
5526 A nil width parameter means no margin. */)
5527 (window, left, right)
5528 Lisp_Object window, left, right;
5530 struct window *w = decode_window (window);
5532 if (!NILP (left))
5533 CHECK_NUMBER_OR_FLOAT (left);
5534 if (!NILP (right))
5535 CHECK_NUMBER_OR_FLOAT (right);
5537 /* Check widths < 0 and translate a zero width to nil.
5538 Margins that are too wide have to be checked elsewhere. */
5539 if ((INTEGERP (left) && XINT (left) < 0)
5540 || (FLOATP (left) && XFLOAT_DATA (left) <= 0))
5541 XSETFASTINT (left, 0);
5542 if (INTEGERP (left) && XFASTINT (left) == 0)
5543 left = Qnil;
5545 if ((INTEGERP (right) && XINT (right) < 0)
5546 || (FLOATP (right) && XFLOAT_DATA (right) <= 0))
5547 XSETFASTINT (right, 0);
5548 if (INTEGERP (right) && XFASTINT (right) == 0)
5549 right = Qnil;
5551 w->left_margin_width = left;
5552 w->right_margin_width = right;
5554 ++windows_or_buffers_changed;
5555 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
5556 return Qnil;
5560 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
5561 0, 1, 0,
5562 doc: /* Get width of marginal areas of window WINDOW.
5563 If WINDOW is omitted or nil, use the currently selected window.
5564 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
5565 If a marginal area does not exist, its width will be returned
5566 as nil. */)
5567 (window)
5568 Lisp_Object window;
5570 struct window *w = decode_window (window);
5571 return Fcons (w->left_margin_width, w->right_margin_width);
5576 /***********************************************************************
5577 Smooth scrolling
5578 ***********************************************************************/
5580 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 1, 0,
5581 doc: /* Return the amount by which WINDOW is scrolled vertically.
5582 Use the selected window if WINDOW is nil or omitted.
5583 Value is a multiple of the canonical character height of WINDOW. */)
5584 (window)
5585 Lisp_Object window;
5587 Lisp_Object result;
5588 struct frame *f;
5589 struct window *w;
5591 if (NILP (window))
5592 window = selected_window;
5593 else
5594 CHECK_WINDOW (window);
5595 w = XWINDOW (window);
5596 f = XFRAME (w->frame);
5598 if (FRAME_WINDOW_P (f))
5599 result = CANON_Y_FROM_PIXEL_Y (f, -w->vscroll);
5600 else
5601 result = make_number (0);
5602 return result;
5606 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
5607 2, 2, 0,
5608 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
5609 WINDOW nil means use the selected window. VSCROLL is a non-negative
5610 multiple of the canonical character height of WINDOW. */)
5611 (window, vscroll)
5612 Lisp_Object window, vscroll;
5614 struct window *w;
5615 struct frame *f;
5617 if (NILP (window))
5618 window = selected_window;
5619 else
5620 CHECK_WINDOW (window);
5621 CHECK_NUMBER_OR_FLOAT (vscroll);
5623 w = XWINDOW (window);
5624 f = XFRAME (w->frame);
5626 if (FRAME_WINDOW_P (f))
5628 int old_dy = w->vscroll;
5630 w->vscroll = - CANON_Y_UNIT (f) * XFLOATINT (vscroll);
5631 w->vscroll = min (w->vscroll, 0);
5633 /* Adjust glyph matrix of the frame if the virtual display
5634 area becomes larger than before. */
5635 if (w->vscroll < 0 && w->vscroll < old_dy)
5636 adjust_glyphs (f);
5638 /* Prevent redisplay shortcuts. */
5639 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
5642 return Fwindow_vscroll (window);
5646 /* Call FN for all leaf windows on frame F. FN is called with the
5647 first argument being a pointer to the leaf window, and with
5648 additional argument USER_DATA. Stops when FN returns 0. */
5650 void
5651 foreach_window (f, fn, user_data)
5652 struct frame *f;
5653 int (* fn) P_ ((struct window *, void *));
5654 void *user_data;
5656 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
5660 /* Helper function for foreach_window. Call FN for all leaf windows
5661 reachable from W. FN is called with the first argument being a
5662 pointer to the leaf window, and with additional argument USER_DATA.
5663 Stop when FN returns 0. Value is 0 if stopped by FN. */
5665 static int
5666 foreach_window_1 (w, fn, user_data)
5667 struct window *w;
5668 int (* fn) P_ ((struct window *, void *));
5669 void *user_data;
5671 int cont;
5673 for (cont = 1; w && cont;)
5675 if (!NILP (w->hchild))
5676 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
5677 else if (!NILP (w->vchild))
5678 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
5679 else
5680 cont = fn (w, user_data);
5682 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5685 return cont;
5689 /* Freeze or unfreeze the window start of W unless it is a
5690 mini-window or the selected window. FREEZE_P non-null means freeze
5691 the window start. */
5693 static int
5694 freeze_window_start (w, freeze_p)
5695 struct window *w;
5696 void *freeze_p;
5698 if (w == XWINDOW (selected_window)
5699 || MINI_WINDOW_P (w)
5700 || (MINI_WINDOW_P (XWINDOW (selected_window))
5701 && ! NILP (Vminibuf_scroll_window)
5702 && w == XWINDOW (Vminibuf_scroll_window)))
5703 freeze_p = NULL;
5705 w->frozen_window_start_p = freeze_p != NULL;
5706 return 1;
5710 /* Freeze or unfreeze the window starts of all leaf windows on frame
5711 F, except the selected window and a mini-window. FREEZE_P non-zero
5712 means freeze the window start. */
5714 void
5715 freeze_window_starts (f, freeze_p)
5716 struct frame *f;
5717 int freeze_p;
5719 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
5723 /***********************************************************************
5724 Initialization
5725 ***********************************************************************/
5727 /* Return 1 if window configurations C1 and C2
5728 describe the same state of affairs. This is used by Fequal. */
5731 compare_window_configurations (c1, c2, ignore_positions)
5732 Lisp_Object c1, c2;
5733 int ignore_positions;
5735 register struct save_window_data *d1, *d2;
5736 struct Lisp_Vector *sw1, *sw2;
5737 int i;
5739 if (!WINDOW_CONFIGURATIONP (c1))
5740 wrong_type_argument (Qwindow_configuration_p, c1);
5741 if (!WINDOW_CONFIGURATIONP (c2))
5742 wrong_type_argument (Qwindow_configuration_p, c2);
5744 d1 = (struct save_window_data *) XVECTOR (c1);
5745 d2 = (struct save_window_data *) XVECTOR (c2);
5746 sw1 = XVECTOR (d1->saved_windows);
5747 sw2 = XVECTOR (d2->saved_windows);
5749 if (! EQ (d1->frame_width, d2->frame_width))
5750 return 0;
5751 if (! EQ (d1->frame_height, d2->frame_height))
5752 return 0;
5753 if (! EQ (d1->frame_menu_bar_lines, d2->frame_menu_bar_lines))
5754 return 0;
5755 if (! EQ (d1->selected_frame, d2->selected_frame))
5756 return 0;
5757 /* Don't compare the current_window field directly.
5758 Instead see w1_is_current and w2_is_current, below. */
5759 if (! EQ (d1->current_buffer, d2->current_buffer))
5760 return 0;
5761 if (! ignore_positions)
5763 if (! EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window))
5764 return 0;
5765 if (! EQ (d1->minibuf_selected_window, d2->minibuf_selected_window))
5766 return 0;
5768 /* Don't compare the root_window field.
5769 We don't require the two configurations
5770 to use the same window object,
5771 and the two root windows must be equivalent
5772 if everything else compares equal. */
5773 if (! EQ (d1->focus_frame, d2->focus_frame))
5774 return 0;
5775 if (! EQ (d1->min_width, d2->min_width))
5776 return 0;
5777 if (! EQ (d1->min_height, d2->min_height))
5778 return 0;
5780 /* Verify that the two confis have the same number of windows. */
5781 if (sw1->size != sw2->size)
5782 return 0;
5784 for (i = 0; i < sw1->size; i++)
5786 struct saved_window *p1, *p2;
5787 int w1_is_current, w2_is_current;
5789 p1 = SAVED_WINDOW_N (sw1, i);
5790 p2 = SAVED_WINDOW_N (sw2, i);
5792 /* Verify that the current windows in the two
5793 configurations correspond to each other. */
5794 w1_is_current = EQ (d1->current_window, p1->window);
5795 w2_is_current = EQ (d2->current_window, p2->window);
5797 if (w1_is_current != w2_is_current)
5798 return 0;
5800 /* Verify that the corresponding windows do match. */
5801 if (! EQ (p1->buffer, p2->buffer))
5802 return 0;
5803 if (! EQ (p1->left, p2->left))
5804 return 0;
5805 if (! EQ (p1->top, p2->top))
5806 return 0;
5807 if (! EQ (p1->width, p2->width))
5808 return 0;
5809 if (! EQ (p1->height, p2->height))
5810 return 0;
5811 if (! EQ (p1->display_table, p2->display_table))
5812 return 0;
5813 if (! EQ (p1->parent, p2->parent))
5814 return 0;
5815 if (! EQ (p1->prev, p2->prev))
5816 return 0;
5817 if (! ignore_positions)
5819 if (! EQ (p1->hscroll, p2->hscroll))
5820 return 0;
5821 if (!EQ (p1->min_hscroll, p2->min_hscroll))
5822 return 0;
5823 if (! EQ (p1->start_at_line_beg, p2->start_at_line_beg))
5824 return 0;
5825 if (NILP (Fequal (p1->start, p2->start)))
5826 return 0;
5827 if (NILP (Fequal (p1->pointm, p2->pointm)))
5828 return 0;
5829 if (NILP (Fequal (p1->mark, p2->mark)))
5830 return 0;
5834 return 1;
5837 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
5838 Scompare_window_configurations, 2, 2, 0,
5839 doc: /* Compare two window configurations as regards the structure of windows.
5840 This function ignores details such as the values of point and mark
5841 and scrolling positions. */)
5842 (x, y)
5843 Lisp_Object x, y;
5845 if (compare_window_configurations (x, y, 1))
5846 return Qt;
5847 return Qnil;
5850 void
5851 init_window_once ()
5853 struct frame *f = make_terminal_frame ();
5854 XSETFRAME (selected_frame, f);
5855 Vterminal_frame = selected_frame;
5856 minibuf_window = f->minibuffer_window;
5857 selected_window = f->selected_window;
5858 last_nonminibuf_frame = f;
5860 window_initialized = 1;
5863 void
5864 init_window ()
5866 Vwindow_list = Qnil;
5869 void
5870 syms_of_window ()
5872 Qwindow_size_fixed = intern ("window-size-fixed");
5873 staticpro (&Qwindow_size_fixed);
5875 staticpro (&Qwindow_configuration_change_hook);
5876 Qwindow_configuration_change_hook
5877 = intern ("window-configuration-change-hook");
5879 Qwindowp = intern ("windowp");
5880 staticpro (&Qwindowp);
5882 Qwindow_configuration_p = intern ("window-configuration-p");
5883 staticpro (&Qwindow_configuration_p);
5885 Qwindow_live_p = intern ("window-live-p");
5886 staticpro (&Qwindow_live_p);
5888 Qtemp_buffer_show_hook = intern ("temp-buffer-show-hook");
5889 staticpro (&Qtemp_buffer_show_hook);
5891 staticpro (&Vwindow_list);
5893 minibuf_selected_window = Qnil;
5894 staticpro (&minibuf_selected_window);
5896 DEFVAR_LISP ("temp-buffer-show-function", &Vtemp_buffer_show_function,
5897 doc: /* Non-nil means call as function to display a help buffer.
5898 The function is called with one argument, the buffer to be displayed.
5899 Used by `with-output-to-temp-buffer'.
5900 If this function is used, then it must do the entire job of showing
5901 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
5902 Vtemp_buffer_show_function = Qnil;
5904 DEFVAR_LISP ("display-buffer-function", &Vdisplay_buffer_function,
5905 doc: /* If non-nil, function to call to handle `display-buffer'.
5906 It will receive two args, the buffer and a flag which if non-nil means
5907 that the currently selected window is not acceptable.
5908 Commands such as `switch-to-buffer-other-window' and `find-file-other-window'
5909 work using this function. */);
5910 Vdisplay_buffer_function = Qnil;
5912 DEFVAR_LISP ("even-window-heights", &Veven_window_heights,
5913 doc: /* *If non-nil, `display-buffer' should even the window heights.
5914 If nil, `display-buffer' will leave the window configuration alone. */);
5915 Veven_window_heights = Qt;
5917 DEFVAR_LISP ("minibuffer-scroll-window", &Vminibuf_scroll_window,
5918 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
5919 Vminibuf_scroll_window = Qnil;
5921 DEFVAR_BOOL ("mode-line-in-non-selected-windows", &mode_line_in_non_selected_windows,
5922 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
5923 If the minibuffer is active, the `minibuffer-scroll-window' mode line
5924 is displayed in the `mode-line' face. */);
5925 mode_line_in_non_selected_windows = 1;
5927 DEFVAR_LISP ("other-window-scroll-buffer", &Vother_window_scroll_buffer,
5928 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
5929 Vother_window_scroll_buffer = Qnil;
5931 DEFVAR_BOOL ("pop-up-frames", &pop_up_frames,
5932 doc: /* *Non-nil means `display-buffer' should make a separate frame. */);
5933 pop_up_frames = 0;
5935 DEFVAR_BOOL ("display-buffer-reuse-frames", &display_buffer_reuse_frames,
5936 doc: /* *Non-nil means `display-buffer' should reuse frames.
5937 If the buffer in question is already displayed in a frame, raise that frame. */);
5938 display_buffer_reuse_frames = 0;
5940 DEFVAR_LISP ("pop-up-frame-function", &Vpop_up_frame_function,
5941 doc: /* Function to call to handle automatic new frame creation.
5942 It is called with no arguments and should return a newly created frame.
5944 A typical value might be `(lambda () (new-frame pop-up-frame-alist))'
5945 where `pop-up-frame-alist' would hold the default frame parameters. */);
5946 Vpop_up_frame_function = Qnil;
5948 DEFVAR_LISP ("special-display-buffer-names", &Vspecial_display_buffer_names,
5949 doc: /* *List of buffer names that should have their own special frames.
5950 Displaying a buffer whose name is in this list makes a special frame for it
5951 using `special-display-function'. See also `special-display-regexps'.
5953 An element of the list can be a list instead of just a string.
5954 There are two ways to use a list as an element:
5955 (BUFFER FRAME-PARAMETERS...) (BUFFER FUNCTION OTHER-ARGS...)
5956 In the first case, FRAME-PARAMETERS are used to create the frame.
5957 In the latter case, FUNCTION is called with BUFFER as the first argument,
5958 followed by OTHER-ARGS--it can display BUFFER in any way it likes.
5959 All this is done by the function found in `special-display-function'.
5961 If this variable appears \"not to work\", because you add a name to it
5962 but that buffer still appears in the selected window, look at the
5963 values of `same-window-buffer-names' and `same-window-regexps'.
5964 Those variables take precedence over this one. */);
5965 Vspecial_display_buffer_names = Qnil;
5967 DEFVAR_LISP ("special-display-regexps", &Vspecial_display_regexps,
5968 doc: /* *List of regexps saying which buffers should have their own special frames.
5969 If a buffer name matches one of these regexps, it gets its own frame.
5970 Displaying a buffer whose name is in this list makes a special frame for it
5971 using `special-display-function'.
5973 An element of the list can be a list instead of just a string.
5974 There are two ways to use a list as an element:
5975 (REGEXP FRAME-PARAMETERS...) (REGEXP FUNCTION OTHER-ARGS...)
5976 In the first case, FRAME-PARAMETERS are used to create the frame.
5977 In the latter case, FUNCTION is called with the buffer as first argument,
5978 followed by OTHER-ARGS--it can display the buffer in any way it likes.
5979 All this is done by the function found in `special-display-function'.
5981 If this variable appears \"not to work\", because you add a regexp to it
5982 but the matching buffers still appear in the selected window, look at the
5983 values of `same-window-buffer-names' and `same-window-regexps'.
5984 Those variables take precedence over this one. */);
5985 Vspecial_display_regexps = Qnil;
5987 DEFVAR_LISP ("special-display-function", &Vspecial_display_function,
5988 doc: /* Function to call to make a new frame for a special buffer.
5989 It is called with two arguments, the buffer and optional buffer specific
5990 data, and should return a window displaying that buffer.
5991 The default value normally makes a separate frame for the buffer,
5992 using `special-display-frame-alist' to specify the frame parameters.
5993 But if the buffer specific data includes (same-buffer . t) then the
5994 buffer is displayed in the current selected window.
5995 Otherwise if it includes (same-frame . t) then the buffer is displayed in
5996 a new window in the currently selected frame.
5998 A buffer is special if it is listed in `special-display-buffer-names'
5999 or matches a regexp in `special-display-regexps'. */);
6000 Vspecial_display_function = Qnil;
6002 DEFVAR_LISP ("same-window-buffer-names", &Vsame_window_buffer_names,
6003 doc: /* *List of buffer names that should appear in the selected window.
6004 Displaying one of these buffers using `display-buffer' or `pop-to-buffer'
6005 switches to it in the selected window, rather than making it appear
6006 in some other window.
6008 An element of the list can be a cons cell instead of just a string.
6009 Then the car must be a string, which specifies the buffer name.
6010 This is for compatibility with `special-display-buffer-names';
6011 the cdr of the cons cell is ignored.
6013 See also `same-window-regexps'. */);
6014 Vsame_window_buffer_names = Qnil;
6016 DEFVAR_LISP ("same-window-regexps", &Vsame_window_regexps,
6017 doc: /* *List of regexps saying which buffers should appear in the selected window.
6018 If a buffer name matches one of these regexps, then displaying it
6019 using `display-buffer' or `pop-to-buffer' switches to it
6020 in the selected window, rather than making it appear in some other window.
6022 An element of the list can be a cons cell instead of just a string.
6023 Then the car must be a string, which specifies the buffer name.
6024 This is for compatibility with `special-display-buffer-names';
6025 the cdr of the cons cell is ignored.
6027 See also `same-window-buffer-names'. */);
6028 Vsame_window_regexps = Qnil;
6030 DEFVAR_BOOL ("pop-up-windows", &pop_up_windows,
6031 doc: /* *Non-nil means display-buffer should make new windows. */);
6032 pop_up_windows = 1;
6034 DEFVAR_INT ("next-screen-context-lines", &next_screen_context_lines,
6035 doc: /* *Number of lines of continuity when scrolling by screenfuls. */);
6036 next_screen_context_lines = 2;
6038 DEFVAR_INT ("split-height-threshold", &split_height_threshold,
6039 doc: /* *display-buffer would prefer to split the largest window if this large.
6040 If there is only one window, it is split regardless of this value. */);
6041 split_height_threshold = 500;
6043 DEFVAR_INT ("window-min-height", &window_min_height,
6044 doc: /* *Delete any window less than this tall (including its mode line). */);
6045 window_min_height = 4;
6047 DEFVAR_INT ("window-min-width", &window_min_width,
6048 doc: /* *Delete any window less than this wide. */);
6049 window_min_width = 10;
6051 DEFVAR_LISP ("scroll-preserve-screen-position",
6052 &Vscroll_preserve_screen_position,
6053 doc: /* *Non-nil means scroll commands move point to keep its screen line unchanged. */);
6054 Vscroll_preserve_screen_position = Qnil;
6056 DEFVAR_LISP ("window-configuration-change-hook",
6057 &Vwindow_configuration_change_hook,
6058 doc: /* Functions to call when window configuration changes.
6059 The selected frame is the one whose configuration has changed. */);
6060 Vwindow_configuration_change_hook = Qnil;
6062 DEFVAR_BOOL ("window-size-fixed", &window_size_fixed,
6063 doc: /* Non-nil in a buffer means windows displaying the buffer are fixed-size.
6064 Emacs won't change the size of any window displaying that buffer,
6065 unless you explicitly change the size, or Emacs has no other choice.
6066 This variable automatically becomes buffer-local when set. */);
6067 Fmake_variable_buffer_local (Qwindow_size_fixed);
6068 window_size_fixed = 0;
6070 defsubr (&Sselected_window);
6071 defsubr (&Sminibuffer_window);
6072 defsubr (&Swindow_minibuffer_p);
6073 defsubr (&Swindowp);
6074 defsubr (&Swindow_live_p);
6075 defsubr (&Spos_visible_in_window_p);
6076 defsubr (&Swindow_buffer);
6077 defsubr (&Swindow_height);
6078 defsubr (&Swindow_width);
6079 defsubr (&Swindow_hscroll);
6080 defsubr (&Sset_window_hscroll);
6081 defsubr (&Swindow_redisplay_end_trigger);
6082 defsubr (&Sset_window_redisplay_end_trigger);
6083 defsubr (&Swindow_edges);
6084 defsubr (&Scoordinates_in_window_p);
6085 defsubr (&Swindow_at);
6086 defsubr (&Swindow_point);
6087 defsubr (&Swindow_start);
6088 defsubr (&Swindow_end);
6089 defsubr (&Sset_window_point);
6090 defsubr (&Sset_window_start);
6091 defsubr (&Swindow_dedicated_p);
6092 defsubr (&Sset_window_dedicated_p);
6093 defsubr (&Swindow_display_table);
6094 defsubr (&Sset_window_display_table);
6095 defsubr (&Snext_window);
6096 defsubr (&Sprevious_window);
6097 defsubr (&Sother_window);
6098 defsubr (&Sget_lru_window);
6099 defsubr (&Sget_largest_window);
6100 defsubr (&Sget_buffer_window);
6101 defsubr (&Sdelete_other_windows);
6102 defsubr (&Sdelete_windows_on);
6103 defsubr (&Sreplace_buffer_in_windows);
6104 defsubr (&Sdelete_window);
6105 defsubr (&Sset_window_buffer);
6106 defsubr (&Sselect_window);
6107 defsubr (&Sspecial_display_p);
6108 defsubr (&Ssame_window_p);
6109 defsubr (&Sdisplay_buffer);
6110 defsubr (&Ssplit_window);
6111 defsubr (&Senlarge_window);
6112 defsubr (&Sshrink_window);
6113 defsubr (&Sscroll_up);
6114 defsubr (&Sscroll_down);
6115 defsubr (&Sscroll_left);
6116 defsubr (&Sscroll_right);
6117 defsubr (&Sother_window_for_scrolling);
6118 defsubr (&Sscroll_other_window);
6119 defsubr (&Sminibuffer_selected_window);
6120 defsubr (&Srecenter);
6121 defsubr (&Swindow_text_height);
6122 defsubr (&Smove_to_window_line);
6123 defsubr (&Swindow_configuration_p);
6124 defsubr (&Swindow_configuration_frame);
6125 defsubr (&Sset_window_configuration);
6126 defsubr (&Scurrent_window_configuration);
6127 defsubr (&Ssave_window_excursion);
6128 defsubr (&Sset_window_margins);
6129 defsubr (&Swindow_margins);
6130 defsubr (&Swindow_vscroll);
6131 defsubr (&Sset_window_vscroll);
6132 defsubr (&Scompare_window_configurations);
6133 defsubr (&Swindow_list);
6136 void
6137 keys_of_window ()
6139 initial_define_key (control_x_map, '1', "delete-other-windows");
6140 initial_define_key (control_x_map, '2', "split-window");
6141 initial_define_key (control_x_map, '0', "delete-window");
6142 initial_define_key (control_x_map, 'o', "other-window");
6143 initial_define_key (control_x_map, '^', "enlarge-window");
6144 initial_define_key (control_x_map, '<', "scroll-left");
6145 initial_define_key (control_x_map, '>', "scroll-right");
6147 initial_define_key (global_map, Ctl ('V'), "scroll-up");
6148 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
6149 initial_define_key (meta_map, 'v', "scroll-down");
6151 initial_define_key (global_map, Ctl('L'), "recenter");
6152 initial_define_key (meta_map, 'r', "move-to-window-line");