(Fset_window_point): If displaying cursors in windows
[bpt/emacs.git] / src / window.c
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985,86,87,93,94,95,96,97,1998,2000
4 Free Software Foundation, Inc.
5
6 This file is part of GNU Emacs.
7
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.
12
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.
17
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. */
22
23 #include <config.h>
24 #include "lisp.h"
25 #include "buffer.h"
26 #include "keyboard.h"
27 #include "frame.h"
28 #include "window.h"
29 #include "commands.h"
30 #include "indent.h"
31 #include "termchar.h"
32 #include "disptab.h"
33 #include "dispextern.h"
34 #include "blockinput.h"
35 #include "intervals.h"
36
37 #ifdef HAVE_X_WINDOWS
38 #include "xterm.h"
39 #endif /* HAVE_X_WINDOWS */
40 #ifdef WINDOWSNT
41 #include "w32term.h"
42 #endif
43 #ifdef MSDOS
44 #include "msdos.h"
45 #endif
46 #ifdef macintosh
47 #include "macterm.h"
48 #endif
49
50 #ifndef max
51 #define max(a, b) ((a) < (b) ? (b) : (a))
52 #endif
53
54
55 Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
56 Lisp_Object Qwindow_size_fixed, Qleft_bitmap_area, Qright_bitmap_area;
57 extern Lisp_Object Qheight, Qwidth;
58
59 static struct window *decode_window P_ ((Lisp_Object));
60 static Lisp_Object select_window_1 P_ ((Lisp_Object, int));
61 static int count_windows P_ ((struct window *));
62 static int get_leaf_windows P_ ((struct window *, struct window **, int));
63 static void window_scroll P_ ((Lisp_Object, int, int, int));
64 static void window_scroll_pixel_based P_ ((Lisp_Object, int, int, int));
65 static void window_scroll_line_based P_ ((Lisp_Object, int, int, int));
66 static int window_min_size_1 P_ ((struct window *, int));
67 static int window_min_size P_ ((struct window *, int, int, int *));
68 static void size_window P_ ((Lisp_Object, int, int, int));
69 static int freeze_window_start P_ ((struct window *, void *));
70 static int window_fixed_size_p P_ ((struct window *, int, int));
71 static void enlarge_window P_ ((Lisp_Object, int, int));
72 static Lisp_Object window_list P_ ((void));
73 static int add_window_to_list P_ ((struct window *, void *));
74 static int candidate_window_p P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
75 Lisp_Object));
76 static Lisp_Object next_window P_ ((Lisp_Object, Lisp_Object,
77 Lisp_Object, int));
78 static void decode_next_window_args P_ ((Lisp_Object *, Lisp_Object *,
79 Lisp_Object *));
80 static int foreach_window_1 P_ ((struct window *,
81 int (* fn) (struct window *, void *),
82 void *));
83 static Lisp_Object window_list_1 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
84
85 /* This is the window in which the terminal's cursor should
86 be left when nothing is being done with it. This must
87 always be a leaf window, and its buffer is selected by
88 the top level editing loop at the end of each command.
89
90 This value is always the same as
91 FRAME_SELECTED_WINDOW (selected_frame). */
92
93 Lisp_Object selected_window;
94
95 /* A list of all windows for use by next_window and Fwindow_list.
96 Functions creating or deleting windows should invalidate this cache
97 by setting it to nil. */
98
99 Lisp_Object Vwindow_list;
100
101 /* The mini-buffer window of the selected frame.
102 Note that you cannot test for mini-bufferness of an arbitrary window
103 by comparing against this; but you can test for mini-bufferness of
104 the selected window. */
105
106 Lisp_Object minibuf_window;
107
108 /* Non-nil means it is the window for C-M-v to scroll
109 when the mini-buffer is selected. */
110
111 Lisp_Object Vminibuf_scroll_window;
112
113 /* Non-nil means this is the buffer whose window C-M-v should scroll. */
114
115 Lisp_Object Vother_window_scroll_buffer;
116
117 /* Non-nil means it's function to call to display temp buffers. */
118
119 Lisp_Object Vtemp_buffer_show_function;
120
121 /* If a window gets smaller than either of these, it is removed. */
122
123 int window_min_height;
124 int window_min_width;
125
126 /* Nonzero implies Fdisplay_buffer should create windows. */
127
128 int pop_up_windows;
129
130 /* Nonzero implies make new frames for Fdisplay_buffer. */
131
132 int pop_up_frames;
133
134 /* Nonzero means reuse existing frames for displaying buffers. */
135
136 int display_buffer_reuse_frames;
137
138 /* Non-nil means use this function instead of default */
139
140 Lisp_Object Vpop_up_frame_function;
141
142 /* Function to call to handle Fdisplay_buffer. */
143
144 Lisp_Object Vdisplay_buffer_function;
145
146 /* Non-nil means that Fdisplay_buffer should even the heights of windows. */
147
148 Lisp_Object Veven_window_heights;
149
150 /* List of buffer *names* for buffers that should have their own frames. */
151
152 Lisp_Object Vspecial_display_buffer_names;
153
154 /* List of regexps for buffer names that should have their own frames. */
155
156 Lisp_Object Vspecial_display_regexps;
157
158 /* Function to pop up a special frame. */
159
160 Lisp_Object Vspecial_display_function;
161
162 /* List of buffer *names* for buffers to appear in selected window. */
163
164 Lisp_Object Vsame_window_buffer_names;
165
166 /* List of regexps for buffer names to appear in selected window. */
167
168 Lisp_Object Vsame_window_regexps;
169
170 /* Hook run at end of temp_output_buffer_show. */
171
172 Lisp_Object Qtemp_buffer_show_hook;
173
174 /* Fdisplay_buffer always splits the largest window
175 if that window is more than this high. */
176
177 int split_height_threshold;
178
179 /* Number of lines of continuity in scrolling by screenfuls. */
180
181 int next_screen_context_lines;
182
183 /* Incremented for each window created. */
184
185 static int sequence_number;
186
187 /* Nonzero after init_window_once has finished. */
188
189 static int window_initialized;
190
191 /* Hook to run when window config changes. */
192
193 Lisp_Object Qwindow_configuration_change_hook;
194 Lisp_Object Vwindow_configuration_change_hook;
195
196 /* Nonzero means scroll commands try to put point
197 at the same screen height as previously. */
198
199 Lisp_Object Vscroll_preserve_screen_position;
200
201 #if 0 /* This isn't used anywhere. */
202 /* Nonzero means we can split a frame even if it is "unsplittable". */
203 static int inhibit_frame_unsplittable;
204 #endif /* 0 */
205
206 #define min(a, b) ((a) < (b) ? (a) : (b))
207
208 extern int scroll_margin;
209
210 extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
211 \f
212 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
213 "Returns t if OBJECT is a window.")
214 (object)
215 Lisp_Object object;
216 {
217 return WINDOWP (object) ? Qt : Qnil;
218 }
219
220 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
221 "Returns t if OBJECT is a window which is currently visible.")
222 (object)
223 Lisp_Object object;
224 {
225 return (WINDOWP (object) && ! NILP (XWINDOW (object)->buffer) ? Qt : Qnil);
226 }
227
228 Lisp_Object
229 make_window ()
230 {
231 Lisp_Object val;
232 register struct window *p;
233 register struct Lisp_Vector *vec;
234 int i;
235
236 vec = allocate_vectorlike ((EMACS_INT) VECSIZE (struct window));
237 for (i = 0; i < VECSIZE (struct window); i++)
238 vec->contents[i] = Qnil;
239 vec->size = VECSIZE (struct window);
240 p = (struct window *) vec;
241 XSETFASTINT (p->sequence_number, ++sequence_number);
242 XSETFASTINT (p->left, 0);
243 XSETFASTINT (p->top, 0);
244 XSETFASTINT (p->height, 0);
245 XSETFASTINT (p->width, 0);
246 XSETFASTINT (p->hscroll, 0);
247 p->orig_top = p->orig_height = Qnil;
248 p->start = Fmake_marker ();
249 p->pointm = Fmake_marker ();
250 XSETFASTINT (p->use_time, 0);
251 p->frame = Qnil;
252 p->display_table = Qnil;
253 p->dedicated = Qnil;
254 p->pseudo_window_p = 0;
255 bzero (&p->cursor, sizeof (p->cursor));
256 bzero (&p->last_cursor, sizeof (p->last_cursor));
257 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
258 p->desired_matrix = p->current_matrix = 0;
259 p->phys_cursor_type = -1;
260 p->must_be_updated_p = 0;
261 XSETFASTINT (p->window_end_vpos, 0);
262 XSETFASTINT (p->window_end_pos, 0);
263 p->window_end_valid = Qnil;
264 p->vscroll = 0;
265 XSETWINDOW (val, p);
266 XSETFASTINT (p->last_point, 0);
267 p->frozen_window_start_p = 0;
268
269 Vwindow_list = Qnil;
270 return val;
271 }
272
273 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
274 "Return the window that the cursor now appears in and commands apply to.")
275 ()
276 {
277 return selected_window;
278 }
279
280 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
281 "Return the window used now for minibuffers.\n\
282 If the optional argument FRAME is specified, return the minibuffer window\n\
283 used by that frame.")
284 (frame)
285 Lisp_Object frame;
286 {
287 if (NILP (frame))
288 frame = selected_frame;
289 CHECK_LIVE_FRAME (frame, 0);
290 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
291 }
292
293 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
294 "Returns non-nil if WINDOW is a minibuffer window.")
295 (window)
296 Lisp_Object window;
297 {
298 struct window *w = decode_window (window);
299 return MINI_WINDOW_P (w) ? Qt : Qnil;
300 }
301
302
303 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
304 Spos_visible_in_window_p, 0, 3, 0,
305 "Return t if position POS is currently on the frame in WINDOW.\n\
306 Return nil if that position is scrolled vertically out of view.\n\
307 If a character is only partially visible, nil is returned, unless the\n\
308 optional argument PARTIALLY is non-nil.\n\
309 POS defaults to point in WINDOW; WINDOW defaults to the selected window.")
310 (pos, window, partially)
311 Lisp_Object pos, window, partially;
312 {
313 register struct window *w;
314 register int posint;
315 register struct buffer *buf;
316 struct text_pos top;
317 Lisp_Object in_window;
318 int fully_p;
319
320 w = decode_window (window);
321 buf = XBUFFER (w->buffer);
322 SET_TEXT_POS_FROM_MARKER (top, w->start);
323
324 if (!NILP (pos))
325 {
326 CHECK_NUMBER_COERCE_MARKER (pos, 0);
327 posint = XINT (pos);
328 }
329 else if (w == XWINDOW (selected_window))
330 posint = PT;
331 else
332 posint = XMARKER (w->pointm)->charpos;
333
334 /* If position is above window start, it's not visible. */
335 if (posint < CHARPOS (top))
336 in_window = Qnil;
337 else if (XFASTINT (w->last_modified) >= BUF_MODIFF (buf)
338 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (buf)
339 && posint < BUF_Z (buf) - XFASTINT (w->window_end_pos))
340 {
341 /* If frame is up-to-date, and POSINT is < window end pos, use
342 that info. This doesn't work for POSINT == end pos, because
343 the window end pos is actually the position _after_ the last
344 char in the window. */
345 if (NILP (partially))
346 {
347 pos_visible_p (w, posint, &fully_p, NILP (partially));
348 in_window = fully_p ? Qt : Qnil;
349 }
350 else
351 in_window = Qt;
352 }
353 else if (posint > BUF_ZV (buf))
354 in_window = Qnil;
355 else if (CHARPOS (top) < BUF_BEGV (buf) || CHARPOS (top) > BUF_ZV (buf))
356 /* If window start is out of range, do something reasonable. */
357 in_window = Qnil;
358 else
359 {
360 if (pos_visible_p (w, posint, &fully_p, NILP (partially)))
361 in_window = !NILP (partially) || fully_p ? Qt : Qnil;
362 else
363 in_window = Qnil;
364 }
365
366 return in_window;
367 }
368
369 \f
370 static struct window *
371 decode_window (window)
372 register Lisp_Object window;
373 {
374 if (NILP (window))
375 return XWINDOW (selected_window);
376
377 CHECK_LIVE_WINDOW (window, 0);
378 return XWINDOW (window);
379 }
380
381 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
382 "Return the buffer that WINDOW is displaying.")
383 (window)
384 Lisp_Object window;
385 {
386 return decode_window (window)->buffer;
387 }
388
389 DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
390 "Return the number of lines in WINDOW (including its mode line).")
391 (window)
392 Lisp_Object window;
393 {
394 return decode_window (window)->height;
395 }
396
397 DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
398 "Return the number of display columns in WINDOW.\n\
399 This is the width that is usable columns available for text in WINDOW.\n\
400 If you want to find out how many columns WINDOW takes up,\n\
401 use (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))).")
402 (window)
403 Lisp_Object window;
404 {
405 return make_number (window_internal_width (decode_window (window)));
406 }
407
408 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
409 "Return the number of columns by which WINDOW is scrolled from left margin.")
410 (window)
411 Lisp_Object window;
412 {
413 return decode_window (window)->hscroll;
414 }
415
416 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
417 "Set number of columns WINDOW is scrolled from left margin to NCOL.\n\
418 NCOL should be zero or positive.")
419 (window, ncol)
420 register Lisp_Object window, ncol;
421 {
422 register struct window *w;
423
424 CHECK_NUMBER (ncol, 1);
425 if (XINT (ncol) < 0) XSETFASTINT (ncol, 0);
426 w = decode_window (window);
427 if (XINT (w->hscroll) != XINT (ncol))
428 /* Prevent redisplay shortcuts */
429 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
430 w->hscroll = ncol;
431 return ncol;
432 }
433
434 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
435 Swindow_redisplay_end_trigger, 0, 1, 0,
436 "Return WINDOW's redisplay end trigger value.\n\
437 See `set-window-redisplay-end-trigger' for more information.")
438 (window)
439 Lisp_Object window;
440 {
441 return decode_window (window)->redisplay_end_trigger;
442 }
443
444 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
445 Sset_window_redisplay_end_trigger, 2, 2, 0,
446 "Set WINDOW's redisplay end trigger value to VALUE.\n\
447 VALUE should be a buffer position (typically a marker) or nil.\n\
448 If it is a buffer position, then if redisplay in WINDOW reaches a position\n\
449 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called\n\
450 with two arguments: WINDOW, and the end trigger value.\n\
451 Afterwards the end-trigger value is reset to nil.")
452 (window, value)
453 register Lisp_Object window, value;
454 {
455 register struct window *w;
456
457 w = decode_window (window);
458 w->redisplay_end_trigger = value;
459 return value;
460 }
461
462 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
463 "Return a list of the edge coordinates of WINDOW.\n\
464 \(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.\n\
465 RIGHT is one more than the rightmost column used by WINDOW,\n\
466 and BOTTOM is one more than the bottommost row used by WINDOW\n\
467 and its mode-line.")
468 (window)
469 Lisp_Object window;
470 {
471 register struct window *w = decode_window (window);
472
473 return Fcons (w->left, Fcons (w->top,
474 Fcons (make_number (WINDOW_RIGHT_EDGE (w)),
475 Fcons (make_number (XFASTINT (w->top)
476 + XFASTINT (w->height)),
477 Qnil))));
478 }
479
480 /* Test if the character at column *X, row *Y is within window W.
481 If it is not, return 0;
482 if it is in the window's text area,
483 set *x and *y to its location relative to the upper left corner
484 of the window, and
485 return 1;
486 if it is on the window's modeline, return 2;
487 if it is on the border between the window and its right sibling,
488 return 3.
489 if it is on the window's top line, return 4;
490 if it is in the bitmap area to the left/right of the window,
491 return 5 or 6, and convert *X and *Y to window-relative corrdinates.
492
493 X and Y are frame relative pixel coordinates. */
494
495 static int
496 coordinates_in_window (w, x, y)
497 register struct window *w;
498 register int *x, *y;
499 {
500 struct frame *f = XFRAME (WINDOW_FRAME (w));
501 int left_x, right_x, top_y, bottom_y;
502 int flags_area_width = FRAME_LEFT_FLAGS_AREA_WIDTH (f);
503
504 /* Let's make this a global enum later, instead of using numbers
505 everywhere. */
506 enum {ON_NOTHING, ON_TEXT, ON_MODE_LINE, ON_VERTICAL_BORDER,
507 ON_HEADER_LINE, ON_LEFT_FRINGE, ON_RIGHT_FRINGE};
508
509 /* In what's below, we subtract 1 when computing right_x because we
510 want the rightmost pixel, which is given by left_pixel+width-1. */
511 if (w->pseudo_window_p)
512 {
513 left_x = 0;
514 right_x = XFASTINT (w->width) * CANON_Y_UNIT (f) - 1;
515 top_y = WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w);
516 bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
517 }
518 else
519 {
520 left_x = (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X (w)
521 - FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
522 right_x = WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X (w) - 1;
523 top_y = (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w)
524 - FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
525 bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
526 }
527
528 /* On the mode line or header line? If it's near the start of
529 the mode or header line of window that's has a horizontal
530 sibling, say it's on the vertical line. That's to be able
531 to resize windows horizontally in case we're using toolkit
532 scroll bars. */
533
534 if (WINDOW_WANTS_MODELINE_P (w)
535 && *y < bottom_y
536 && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
537 {
538 if (!WINDOW_RIGHTMOST_P (w)
539 && (abs (*x - ((XFASTINT (w->left) + XFASTINT (w->width))
540 * CANON_X_UNIT (f)))
541 < CANON_X_UNIT (f) / 2))
542 return ON_VERTICAL_BORDER;
543 return ON_MODE_LINE;
544 }
545
546 if (WINDOW_WANTS_HEADER_LINE_P (w)
547 && *y >= top_y
548 && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
549 {
550 if (!WINDOW_RIGHTMOST_P (w)
551 && (abs (*x - ((XFASTINT (w->left) + XFASTINT (w->width))
552 * CANON_X_UNIT (f)))
553 < CANON_X_UNIT (f) / 2))
554 return ON_VERTICAL_BORDER;
555 return ON_HEADER_LINE;
556 }
557
558 /* Completely outside anything interesting? */
559 if (*y < top_y
560 || *y >= bottom_y
561 || *x < (left_x
562 - flags_area_width
563 - (FRAME_LEFT_SCROLL_BAR_WIDTH (f)
564 * CANON_X_UNIT (f)))
565 || *x > right_x + flags_area_width)
566 return ON_NOTHING;
567
568 if (FRAME_WINDOW_P (f))
569 {
570 if (!w->pseudo_window_p
571 && !FRAME_HAS_VERTICAL_SCROLL_BARS (f)
572 && !WINDOW_RIGHTMOST_P (w)
573 && (abs (*x - right_x - flags_area_width) < CANON_X_UNIT (f) / 2))
574 return ON_VERTICAL_BORDER;
575
576 if (*x < left_x || *x > right_x)
577 {
578 /* Other lines than the mode line don't include flags areas and
579 scroll bars on the left. */
580
581 /* Convert X and Y to window-relative pixel coordinates. */
582 *x -= left_x;
583 *y -= top_y;
584 return *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
585 }
586 }
587 else
588 {
589 /* Need to say "*x > right_x" rather than >=, since on character
590 terminals, the vertical line's x coordinate is right_x. */
591 if (*x < left_x || *x > right_x)
592 {
593 /* Other lines than the mode line don't include flags areas and
594 scroll bars on the left. */
595
596 /* Convert X and Y to window-relative pixel coordinates. */
597 *x -= left_x;
598 *y -= top_y;
599 return *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
600 }
601
602 /* Here, too, "*x > right_x" is because of character terminals. */
603 if (!w->pseudo_window_p
604 && !WINDOW_RIGHTMOST_P (w)
605 && *x > right_x - CANON_X_UNIT (f))
606 /* On the border on the right side of the window? Assume that
607 this area begins at RIGHT_X minus a canonical char width. */
608 return ON_VERTICAL_BORDER;
609 }
610
611 /* Convert X and Y to window-relative pixel coordinates. */
612 *x -= left_x;
613 *y -= top_y;
614 return ON_TEXT;
615 }
616
617 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
618 Scoordinates_in_window_p, 2, 2, 0,
619 "Return non-nil if COORDINATES are in WINDOW.\n\
620 COORDINATES is a cons of the form (X . Y), X and Y being distances\n\
621 measured in characters from the upper-left corner of the frame.\n\
622 (0 . 0) denotes the character in the upper left corner of the\n\
623 frame.\n\
624 If COORDINATES are in the text portion of WINDOW,\n\
625 the coordinates relative to the window are returned.\n\
626 If they are in the mode line of WINDOW, `mode-line' is returned.\n\
627 If they are in the top mode line of WINDOW, `header-line' is returned.\n\
628 If they are in the bitmap-area to the left of the window,\n\
629 `left-bitmap-area' is returned, if they are in the area on the right of\n\
630 the window, `right-bitmap-area' is returned.\n\
631 If they are on the border between WINDOW and its right sibling,\n\
632 `vertical-line' is returned.")
633 (coordinates, window)
634 register Lisp_Object coordinates, window;
635 {
636 struct window *w;
637 struct frame *f;
638 int x, y;
639 Lisp_Object lx, ly;
640
641 CHECK_LIVE_WINDOW (window, 0);
642 w = XWINDOW (window);
643 f = XFRAME (w->frame);
644 CHECK_CONS (coordinates, 1);
645 lx = Fcar (coordinates);
646 ly = Fcdr (coordinates);
647 CHECK_NUMBER_OR_FLOAT (lx, 1);
648 CHECK_NUMBER_OR_FLOAT (ly, 1);
649 x = PIXEL_X_FROM_CANON_X (f, lx);
650 y = PIXEL_Y_FROM_CANON_Y (f, ly);
651
652 switch (coordinates_in_window (w, &x, &y))
653 {
654 case 0: /* NOT in window at all. */
655 return Qnil;
656
657 case 1: /* In text part of window. */
658 /* X and Y are now window relative pixel coordinates.
659 Convert them to canonical char units before returning
660 them. */
661 return Fcons (CANON_X_FROM_PIXEL_X (f, x),
662 CANON_Y_FROM_PIXEL_Y (f, y));
663
664 case 2: /* In mode line of window. */
665 return Qmode_line;
666
667 case 3: /* On right border of window. */
668 return Qvertical_line;
669
670 case 4:
671 return Qheader_line;
672
673 case 5:
674 return Qleft_bitmap_area;
675
676 case 6:
677 return Qright_bitmap_area;
678
679 default:
680 abort ();
681 }
682 }
683
684
685 /* Callback for foreach_window, used in window_from_coordinates.
686 Check if window W contains coordinates specified by USER_DATA which
687 is actually a pointer to a struct check_window_data CW.
688
689 Check if window W contains coordinates *CW->x and *CW->y. If it
690 does, return W in *CW->window, as Lisp_Object, and return in
691 *CW->part the part of the window under coordinates *X,*Y. Return
692 zero from this function to stop iterating over windows. */
693
694 struct check_window_data
695 {
696 Lisp_Object *window;
697 int *x, *y, *part;
698 };
699
700 static int
701 check_window_containing (w, user_data)
702 struct window *w;
703 void *user_data;
704 {
705 struct check_window_data *cw = (struct check_window_data *) user_data;
706 int found;
707
708 found = coordinates_in_window (w, cw->x, cw->y);
709 if (found)
710 {
711 *cw->part = found - 1;
712 XSETWINDOW (*cw->window, w);
713 }
714
715 return !found;
716 }
717
718
719 /* Find the window containing frame-relative pixel position X/Y and
720 return it as a Lisp_Object. If X, Y is on the window's modeline,
721 set *PART to 1; if it is on the separating line between the window
722 and its right sibling, set it to 2; otherwise set it to 0. If
723 there is no window under X, Y return nil and leave *PART
724 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
725
726 This function was previously implemented with a loop cycling over
727 windows with Fnext_window, and starting with the frame's selected
728 window. It turned out that this doesn't work with an
729 implementation of next_window using Vwindow_list, because
730 FRAME_SELECTED_WINDOW (F) is not always contained in the window
731 tree of F when this function is called asynchronously from
732 note_mouse_highlight. The original loop didn't terminate in this
733 case. */
734
735 Lisp_Object
736 window_from_coordinates (f, x, y, part, tool_bar_p)
737 struct frame *f;
738 int x, y;
739 int *part;
740 int tool_bar_p;
741 {
742 Lisp_Object window;
743 struct check_window_data cw;
744
745 window = Qnil;
746 cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
747 foreach_window (f, check_window_containing, &cw);
748
749 /* If not found above, see if it's in the tool bar window, if a tool
750 bar exists. */
751 if (NILP (window)
752 && tool_bar_p
753 && WINDOWP (f->tool_bar_window)
754 && XINT (XWINDOW (f->tool_bar_window)->height) > 0
755 && coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y))
756 {
757 *part = 0;
758 window = f->tool_bar_window;
759 }
760
761 return window;
762 }
763
764 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
765 "Return window containing coordinates X and Y on FRAME.\n\
766 If omitted, FRAME defaults to the currently selected frame.\n\
767 The top left corner of the frame is considered to be row 0,\n\
768 column 0.")
769 (x, y, frame)
770 Lisp_Object x, y, frame;
771 {
772 int part;
773 struct frame *f;
774
775 if (NILP (frame))
776 frame = selected_frame;
777 CHECK_LIVE_FRAME (frame, 2);
778 f = XFRAME (frame);
779
780 /* Check that arguments are integers or floats. */
781 CHECK_NUMBER_OR_FLOAT (x, 0);
782 CHECK_NUMBER_OR_FLOAT (y, 1);
783
784 return window_from_coordinates (f,
785 PIXEL_X_FROM_CANON_X (f, x),
786 PIXEL_Y_FROM_CANON_Y (f, y),
787 &part, 0);
788 }
789
790 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
791 "Return current value of point in WINDOW.\n\
792 For a nonselected window, this is the value point would have\n\
793 if that window were selected.\n\
794 \n\
795 Note that, when WINDOW is the selected window and its buffer\n\
796 is also currently selected, the value returned is the same as (point).\n\
797 It would be more strictly correct to return the `top-level' value\n\
798 of point, outside of any save-excursion forms.\n\
799 But that is hard to define.")
800 (window)
801 Lisp_Object window;
802 {
803 register struct window *w = decode_window (window);
804
805 if (w == XWINDOW (selected_window)
806 && current_buffer == XBUFFER (w->buffer))
807 return Fpoint ();
808 return Fmarker_position (w->pointm);
809 }
810
811 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
812 "Return position at which display currently starts in WINDOW.\n\
813 This is updated by redisplay or by calling `set-window-start'.")
814 (window)
815 Lisp_Object window;
816 {
817 return Fmarker_position (decode_window (window)->start);
818 }
819
820 /* This is text temporarily removed from the doc string below.
821
822 This function returns nil if the position is not currently known.\n\
823 That happens when redisplay is preempted and doesn't finish.\n\
824 If in that case you want to compute where the end of the window would\n\
825 have been if redisplay had finished, do this:\n\
826 (save-excursion\n\
827 (goto-char (window-start window))\n\
828 (vertical-motion (1- (window-height window)) window)\n\
829 (point))") */
830
831 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
832 "Return position at which display currently ends in WINDOW.\n\
833 This is updated by redisplay, when it runs to completion.\n\
834 Simply changing the buffer text or setting `window-start'\n\
835 does not update this value.\n\
836 If UP-TO-DATE is non-nil, compute the up-to-date position\n\
837 if it isn't already recorded.")
838 (window, update)
839 Lisp_Object window, update;
840 {
841 Lisp_Object value;
842 struct window *w = decode_window (window);
843 Lisp_Object buf;
844
845 buf = w->buffer;
846 CHECK_BUFFER (buf, 0);
847
848 #if 0 /* This change broke some things. We should make it later. */
849 /* If we don't know the end position, return nil.
850 The user can compute it with vertical-motion if he wants to.
851 It would be nicer to do it automatically,
852 but that's so slow that it would probably bother people. */
853 if (NILP (w->window_end_valid))
854 return Qnil;
855 #endif
856
857 if (! NILP (update)
858 && ! (! NILP (w->window_end_valid)
859 && XFASTINT (w->last_modified) >= MODIFF))
860 {
861 struct text_pos startp;
862 struct it it;
863
864 /* In case W->start is out of the range, use something
865 reasonable. This situation occured when loading a file with
866 `-l' containing a call to `rmail' with subsequent other
867 commands. At the end, W->start happened to be BEG, while
868 rmail had already narrowed the buffer. */
869 if (XMARKER (w->start)->charpos < BEGV)
870 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
871 else if (XMARKER (w->start)->charpos > ZV)
872 SET_TEXT_POS (startp, ZV, ZV_BYTE);
873 else
874 SET_TEXT_POS_FROM_MARKER (startp, w->start);
875
876 /* Cannot use Fvertical_motion because that function doesn't
877 cope with variable-height lines. */
878 start_display (&it, w, startp);
879 move_it_vertically (&it, window_box_height (w));
880 value = make_number (IT_CHARPOS (it));
881 }
882 else
883 XSETINT (value, BUF_Z (XBUFFER (buf)) - XFASTINT (w->window_end_pos));
884
885 return value;
886 }
887
888 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
889 "Make point value in WINDOW be at position POS in WINDOW's buffer.")
890 (window, pos)
891 Lisp_Object window, pos;
892 {
893 register struct window *w = decode_window (window);
894
895 CHECK_NUMBER_COERCE_MARKER (pos, 1);
896 if (w == XWINDOW (selected_window)
897 && XBUFFER (w->buffer) == current_buffer)
898 Fgoto_char (pos);
899 else
900 set_marker_restricted (w->pointm, pos, w->buffer);
901
902 /* If displaying hollow box cursors in non-selected windows, we have
903 to make sure that redisplay updates the window to show the new
904 value of point. */
905 if (cursor_in_non_selected_windows && !EQ (window, selected_window))
906 ++windows_or_buffers_changed;
907
908 return pos;
909 }
910
911 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
912 "Make display in WINDOW start at position POS in WINDOW's buffer.\n\
913 Optional third arg NOFORCE non-nil inhibits next redisplay\n\
914 from overriding motion of point in order to display at this exact start.")
915 (window, pos, noforce)
916 Lisp_Object window, pos, noforce;
917 {
918 register struct window *w = decode_window (window);
919
920 CHECK_NUMBER_COERCE_MARKER (pos, 1);
921 set_marker_restricted (w->start, pos, w->buffer);
922 /* this is not right, but much easier than doing what is right. */
923 w->start_at_line_beg = Qnil;
924 if (NILP (noforce))
925 w->force_start = Qt;
926 w->update_mode_line = Qt;
927 XSETFASTINT (w->last_modified, 0);
928 XSETFASTINT (w->last_overlay_modified, 0);
929 if (!EQ (window, selected_window))
930 windows_or_buffers_changed++;
931
932 return pos;
933 }
934
935 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
936 1, 1, 0,
937 "Return WINDOW's dedicated object, usually t or nil.\n\
938 See also `set-window-dedicated-p'.")
939 (window)
940 Lisp_Object window;
941 {
942 return decode_window (window)->dedicated;
943 }
944
945 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
946 Sset_window_dedicated_p, 2, 2, 0,
947 "Control whether WINDOW is dedicated to the buffer it displays.\n\
948 If it is dedicated, Emacs will not automatically change\n\
949 which buffer appears in it.\n\
950 The second argument is the new value for the dedication flag;\n\
951 non-nil means yes.")
952 (window, arg)
953 Lisp_Object window, arg;
954 {
955 register struct window *w = decode_window (window);
956
957 if (NILP (arg))
958 w->dedicated = Qnil;
959 else
960 w->dedicated = Qt;
961
962 return w->dedicated;
963 }
964
965 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
966 0, 1, 0,
967 "Return the display-table that WINDOW is using.")
968 (window)
969 Lisp_Object window;
970 {
971 return decode_window (window)->display_table;
972 }
973
974 /* Get the display table for use on window W. This is either W's
975 display table or W's buffer's display table. Ignore the specified
976 tables if they are not valid; if no valid table is specified,
977 return 0. */
978
979 struct Lisp_Char_Table *
980 window_display_table (w)
981 struct window *w;
982 {
983 struct Lisp_Char_Table *dp = NULL;
984
985 if (DISP_TABLE_P (w->display_table))
986 dp = XCHAR_TABLE (w->display_table);
987 else if (BUFFERP (w->buffer))
988 {
989 struct buffer *b = XBUFFER (w->buffer);
990
991 if (DISP_TABLE_P (b->display_table))
992 dp = XCHAR_TABLE (b->display_table);
993 else if (DISP_TABLE_P (Vstandard_display_table))
994 dp = XCHAR_TABLE (Vstandard_display_table);
995 }
996
997 return dp;
998 }
999
1000 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1001 "Set WINDOW's display-table to TABLE.")
1002 (window, table)
1003 register Lisp_Object window, table;
1004 {
1005 register struct window *w;
1006
1007 w = decode_window (window);
1008 w->display_table = table;
1009 return table;
1010 }
1011 \f
1012 /* Record info on buffer window w is displaying
1013 when it is about to cease to display that buffer. */
1014 static void
1015 unshow_buffer (w)
1016 register struct window *w;
1017 {
1018 Lisp_Object buf;
1019 struct buffer *b;
1020
1021 buf = w->buffer;
1022 b = XBUFFER (buf);
1023 if (b != XMARKER (w->pointm)->buffer)
1024 abort ();
1025
1026 #if 0
1027 if (w == XWINDOW (selected_window)
1028 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1029 /* Do this except when the selected window's buffer
1030 is being removed from some other window. */
1031 #endif
1032 /* last_window_start records the start position that this buffer
1033 had in the last window to be disconnected from it.
1034 Now that this statement is unconditional,
1035 it is possible for the buffer to be displayed in the
1036 selected window, while last_window_start reflects another
1037 window which was recently showing the same buffer.
1038 Some people might say that might be a good thing. Let's see. */
1039 b->last_window_start = marker_position (w->start);
1040
1041 /* Point in the selected window's buffer
1042 is actually stored in that buffer, and the window's pointm isn't used.
1043 So don't clobber point in that buffer. */
1044 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1045 /* This line helps to fix Horsley's testbug.el bug. */
1046 && !(WINDOWP (b->last_selected_window)
1047 && w != XWINDOW (b->last_selected_window)
1048 && EQ (buf, XWINDOW (b->last_selected_window)->buffer)))
1049 temp_set_point_both (b,
1050 clip_to_bounds (BUF_BEGV (b),
1051 XMARKER (w->pointm)->charpos,
1052 BUF_ZV (b)),
1053 clip_to_bounds (BUF_BEGV_BYTE (b),
1054 marker_byte_position (w->pointm),
1055 BUF_ZV_BYTE (b)));
1056
1057 if (WINDOWP (b->last_selected_window)
1058 && w == XWINDOW (b->last_selected_window))
1059 b->last_selected_window = Qnil;
1060 }
1061
1062 /* Put replacement into the window structure in place of old. */
1063 static void
1064 replace_window (old, replacement)
1065 Lisp_Object old, replacement;
1066 {
1067 register Lisp_Object tem;
1068 register struct window *o = XWINDOW (old), *p = XWINDOW (replacement);
1069
1070 /* If OLD is its frame's root_window, then replacement is the new
1071 root_window for that frame. */
1072
1073 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1074 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
1075
1076 p->left = o->left;
1077 p->top = o->top;
1078 p->width = o->width;
1079 p->height = o->height;
1080 p->desired_matrix = p->current_matrix = 0;
1081 p->vscroll = 0;
1082 bzero (&p->cursor, sizeof (p->cursor));
1083 bzero (&p->last_cursor, sizeof (p->last_cursor));
1084 bzero (&p->phys_cursor, sizeof (p->phys_cursor));
1085 p->phys_cursor_type = -1;
1086 p->must_be_updated_p = 0;
1087 p->pseudo_window_p = 0;
1088 XSETFASTINT (p->window_end_vpos, 0);
1089 XSETFASTINT (p->window_end_pos, 0);
1090 p->window_end_valid = Qnil;
1091 p->frozen_window_start_p = 0;
1092 p->orig_top = p->orig_height = Qnil;
1093
1094 p->next = tem = o->next;
1095 if (!NILP (tem))
1096 XWINDOW (tem)->prev = replacement;
1097
1098 p->prev = tem = o->prev;
1099 if (!NILP (tem))
1100 XWINDOW (tem)->next = replacement;
1101
1102 p->parent = tem = o->parent;
1103 if (!NILP (tem))
1104 {
1105 if (EQ (XWINDOW (tem)->vchild, old))
1106 XWINDOW (tem)->vchild = replacement;
1107 if (EQ (XWINDOW (tem)->hchild, old))
1108 XWINDOW (tem)->hchild = replacement;
1109 }
1110
1111 /*** Here, if replacement is a vertical combination
1112 and so is its new parent, we should make replacement's
1113 children be children of that parent instead. ***/
1114 }
1115
1116 DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
1117 "Remove WINDOW from the display. Default is selected window.")
1118 (window)
1119 register Lisp_Object window;
1120 {
1121 delete_window (window);
1122
1123 if (! NILP (Vwindow_configuration_change_hook)
1124 && ! NILP (Vrun_hooks))
1125 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
1126
1127 return Qnil;
1128 }
1129
1130 void
1131 delete_window (window)
1132 register Lisp_Object window;
1133 {
1134 register Lisp_Object tem, parent, sib;
1135 register struct window *p;
1136 register struct window *par;
1137 FRAME_PTR frame;
1138
1139 /* Because this function is called by other C code on non-leaf
1140 windows, the CHECK_LIVE_WINDOW macro would choke inappropriately,
1141 so we can't decode_window here. */
1142 if (NILP (window))
1143 window = selected_window;
1144 else
1145 CHECK_WINDOW (window, 0);
1146 p = XWINDOW (window);
1147
1148 /* It's okay to delete an already-deleted window. */
1149 if (NILP (p->buffer)
1150 && NILP (p->hchild)
1151 && NILP (p->vchild))
1152 return;
1153
1154 parent = p->parent;
1155 if (NILP (parent))
1156 error ("Attempt to delete minibuffer or sole ordinary window");
1157 par = XWINDOW (parent);
1158
1159 windows_or_buffers_changed++;
1160 Vwindow_list = Qnil;
1161 frame = XFRAME (WINDOW_FRAME (p));
1162 FRAME_WINDOW_SIZES_CHANGED (frame) = 1;
1163
1164 /* Are we trying to delete any frame's selected window? */
1165 {
1166 Lisp_Object frame, pwindow;
1167
1168 /* See if the frame's selected window is either WINDOW
1169 or any subwindow of it, by finding all that window's parents
1170 and comparing each one with WINDOW. */
1171 frame = WINDOW_FRAME (XWINDOW (window));
1172 pwindow = FRAME_SELECTED_WINDOW (XFRAME (frame));
1173
1174 while (!NILP (pwindow))
1175 {
1176 if (EQ (window, pwindow))
1177 break;
1178 pwindow = XWINDOW (pwindow)->parent;
1179 }
1180
1181 if (EQ (window, pwindow))
1182 {
1183 Lisp_Object alternative;
1184 alternative = Fnext_window (window, Qlambda, Qnil);
1185
1186 /* If we're about to delete the selected window on the
1187 selected frame, then we should use Fselect_window to select
1188 the new window. On the other hand, if we're about to
1189 delete the selected window on any other frame, we shouldn't do
1190 anything but set the frame's selected_window slot. */
1191 if (EQ (window, selected_window))
1192 Fselect_window (alternative);
1193 else
1194 FRAME_SELECTED_WINDOW (XFRAME (frame)) = alternative;
1195 }
1196 }
1197
1198 tem = p->buffer;
1199 /* tem is null for dummy parent windows
1200 (which have inferiors but not any contents themselves) */
1201 if (!NILP (tem))
1202 {
1203 unshow_buffer (p);
1204 unchain_marker (p->pointm);
1205 unchain_marker (p->start);
1206 }
1207
1208 /* Free window glyph matrices. It is sure that they are allocated
1209 again when ADJUST_GLYPHS is called. Block input so that expose
1210 events and other events that access glyph matrices are not
1211 processed while we are changing them. */
1212 BLOCK_INPUT;
1213 free_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (frame)));
1214
1215 tem = p->next;
1216 if (!NILP (tem))
1217 XWINDOW (tem)->prev = p->prev;
1218
1219 tem = p->prev;
1220 if (!NILP (tem))
1221 XWINDOW (tem)->next = p->next;
1222
1223 if (EQ (window, par->hchild))
1224 par->hchild = p->next;
1225 if (EQ (window, par->vchild))
1226 par->vchild = p->next;
1227
1228 /* Find one of our siblings to give our space to. */
1229 sib = p->prev;
1230 if (NILP (sib))
1231 {
1232 /* If p gives its space to its next sibling, that sibling needs
1233 to have its top/left side pulled back to where p's is.
1234 set_window_{height,width} will re-position the sibling's
1235 children. */
1236 sib = p->next;
1237 XWINDOW (sib)->top = p->top;
1238 XWINDOW (sib)->left = p->left;
1239 }
1240
1241 /* Stretch that sibling. */
1242 if (!NILP (par->vchild))
1243 set_window_height (sib,
1244 XFASTINT (XWINDOW (sib)->height) + XFASTINT (p->height),
1245 1);
1246 if (!NILP (par->hchild))
1247 set_window_width (sib,
1248 XFASTINT (XWINDOW (sib)->width) + XFASTINT (p->width),
1249 1);
1250
1251 /* If parent now has only one child,
1252 put the child into the parent's place. */
1253 tem = par->hchild;
1254 if (NILP (tem))
1255 tem = par->vchild;
1256 if (NILP (XWINDOW (tem)->next))
1257 replace_window (parent, tem);
1258
1259 /* Since we may be deleting combination windows, we must make sure that
1260 not only p but all its children have been marked as deleted. */
1261 if (! NILP (p->hchild))
1262 delete_all_subwindows (XWINDOW (p->hchild));
1263 else if (! NILP (p->vchild))
1264 delete_all_subwindows (XWINDOW (p->vchild));
1265
1266 /* Mark this window as deleted. */
1267 p->buffer = p->hchild = p->vchild = Qnil;
1268
1269 /* Adjust glyph matrices. */
1270 adjust_glyphs (frame);
1271 UNBLOCK_INPUT;
1272 }
1273
1274
1275 \f
1276 /***********************************************************************
1277 Window List
1278 ***********************************************************************/
1279
1280 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1281 pointer. This is a callback function for foreach_window, used in
1282 function window_list. */
1283
1284 static int
1285 add_window_to_list (w, user_data)
1286 struct window *w;
1287 void *user_data;
1288 {
1289 Lisp_Object *list = (Lisp_Object *) user_data;
1290 Lisp_Object window;
1291 XSETWINDOW (window, w);
1292 *list = Fcons (window, *list);
1293 return 1;
1294 }
1295
1296
1297 /* Return a list of all windows, for use by next_window. If
1298 Vwindow_list is a list, return that list. Otherwise, build a new
1299 list, cache it in Vwindow_list, and return that. */
1300
1301 static Lisp_Object
1302 window_list ()
1303 {
1304 if (!CONSP (Vwindow_list))
1305 {
1306 Lisp_Object tail;
1307
1308 Vwindow_list = Qnil;
1309 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1310 {
1311 Lisp_Object args[2];
1312
1313 /* We are visiting windows in canonical order, and add
1314 new windows at the front of args[1], which means we
1315 have to reverse this list at the end. */
1316 args[1] = Qnil;
1317 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1318 args[0] = Vwindow_list;
1319 args[1] = Fnreverse (args[1]);
1320 Vwindow_list = Fnconc (2, args);
1321 }
1322 }
1323
1324 return Vwindow_list;
1325 }
1326
1327
1328 /* Value is non-zero if WINDOW satisfies the constraints given by
1329 OWINDOW, MINIBUF and ALL_FRAMES.
1330
1331 MINIBUF t means WINDOW may be minibuffer windows.
1332 `lambda' means WINDOW may not be a minibuffer window.
1333 a window means a specific minibuffer window
1334
1335 ALL_FRAMES t means search all frames,
1336 nil means search just current frame,
1337 `visible' means search just visible frames,
1338 0 means search visible and iconified frames,
1339 a window means search the frame that window belongs to,
1340 a frame means consider windows on that frame, only. */
1341
1342 static int
1343 candidate_window_p (window, owindow, minibuf, all_frames)
1344 Lisp_Object window, owindow, minibuf, all_frames;
1345 {
1346 struct window *w = XWINDOW (window);
1347 struct frame *f = XFRAME (w->frame);
1348 int candidate_p = 1;
1349
1350 if (!BUFFERP (w->buffer))
1351 candidate_p = 0;
1352 else if (MINI_WINDOW_P (w)
1353 && (EQ (minibuf, Qlambda)
1354 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
1355 {
1356 /* If MINIBUF is `lambda' don't consider any mini-windows.
1357 If it is a window, consider only that one. */
1358 candidate_p = 0;
1359 }
1360 else if (EQ (all_frames, Qt))
1361 candidate_p = 1;
1362 else if (NILP (all_frames))
1363 {
1364 xassert (WINDOWP (owindow));
1365 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
1366 }
1367 else if (EQ (all_frames, Qvisible))
1368 {
1369 FRAME_SAMPLE_VISIBILITY (f);
1370 candidate_p = FRAME_VISIBLE_P (f);
1371 }
1372 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
1373 {
1374 FRAME_SAMPLE_VISIBILITY (f);
1375 candidate_p = FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f);
1376 }
1377 else if (WINDOWP (all_frames))
1378 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
1379 || EQ (XWINDOW (all_frames)->frame, w->frame)
1380 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
1381 else if (FRAMEP (all_frames))
1382 candidate_p = EQ (all_frames, w->frame);
1383
1384 return candidate_p;
1385 }
1386
1387
1388 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
1389 Fwindow_list. See there for the meaning of WINDOW, MINIBUF, and
1390 ALL_FRAMES. */
1391
1392 static void
1393 decode_next_window_args (window, minibuf, all_frames)
1394 Lisp_Object *window, *minibuf, *all_frames;
1395 {
1396 if (NILP (*window))
1397 *window = selected_window;
1398 else
1399 CHECK_LIVE_WINDOW (*window, 0);
1400
1401 /* MINIBUF nil may or may not include minibuffers. Decide if it
1402 does. */
1403 if (NILP (*minibuf))
1404 *minibuf = minibuf_level ? minibuf_window : Qlambda;
1405 else if (!EQ (*minibuf, Qt))
1406 *minibuf = Qlambda;
1407
1408 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
1409 => count none of them, or a specific minibuffer window (the
1410 active one) to count. */
1411
1412 /* ALL_FRAMES nil doesn't specify which frames to include. */
1413 if (NILP (*all_frames))
1414 *all_frames = (!EQ (*minibuf, Qlambda)
1415 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
1416 : Qnil);
1417 else if (EQ (*all_frames, Qvisible))
1418 ;
1419 else if (XFASTINT (*all_frames) == 0)
1420 ;
1421 else if (FRAMEP (*all_frames))
1422 ;
1423 else if (!EQ (*all_frames, Qt))
1424 *all_frames = Qnil;
1425
1426 /* Now *ALL_FRAMES is t meaning search all frames, nil meaning
1427 search just current frame, `visible' meaning search just visible
1428 frames, 0 meaning search visible and iconified frames, or a
1429 window, meaning search the frame that window belongs to, or a
1430 frame, meaning consider windows on that frame, only. */
1431 }
1432
1433
1434 /* Return the next or previous window of WINDOW in canonical ordering
1435 of windows. NEXT_P non-zero means return the next window. See the
1436 documentation string of next-window for the meaning of MINIBUF and
1437 ALL_FRAMES. */
1438
1439 static Lisp_Object
1440 next_window (window, minibuf, all_frames, next_p)
1441 Lisp_Object window, minibuf, all_frames;
1442 int next_p;
1443 {
1444 decode_next_window_args (&window, &minibuf, &all_frames);
1445
1446 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
1447 return the first window on the frame. */
1448 if (FRAMEP (all_frames)
1449 && !EQ (all_frames, XWINDOW (window)->frame))
1450 return Fframe_first_window (all_frames);
1451
1452 if (next_p)
1453 {
1454 Lisp_Object list;
1455
1456 /* Find WINDOW in the list of all windows. */
1457 list = Fmemq (window, window_list ());
1458
1459 /* Scan forward from WINDOW to the end of the window list. */
1460 if (CONSP (list))
1461 for (list = XCDR (list); CONSP (list); list = XCDR (list))
1462 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1463 break;
1464
1465 /* Scan from the start of the window list up to WINDOW. */
1466 if (!CONSP (list))
1467 for (list = Vwindow_list;
1468 CONSP (list) && !EQ (XCAR (list), window);
1469 list = XCDR (list))
1470 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
1471 break;
1472
1473 if (CONSP (list))
1474 window = XCAR (list);
1475 }
1476 else
1477 {
1478 Lisp_Object candidate, list;
1479
1480 /* Scan through the list of windows for candidates. If there are
1481 candidate windows in front of WINDOW, the last one of these
1482 is the one we want. If there are candidates following WINDOW
1483 in the list, again the last one of these is the one we want. */
1484 candidate = Qnil;
1485 for (list = window_list (); CONSP (list); list = XCDR (list))
1486 {
1487 if (EQ (XCAR (list), window))
1488 {
1489 if (WINDOWP (candidate))
1490 break;
1491 }
1492 else if (candidate_window_p (XCAR (list), window, minibuf,
1493 all_frames))
1494 candidate = XCAR (list);
1495 }
1496
1497 if (WINDOWP (candidate))
1498 window = candidate;
1499 }
1500
1501 return window;
1502 }
1503
1504
1505 /* This comment supplies the doc string for `next-window',
1506 for make-docfile to see. We cannot put this in the real DEFUN
1507 due to limits in the Unix cpp.
1508
1509 DEFUN ("next-window", Ffoo, Sfoo, 0, 3, 0,
1510 "Return next window after WINDOW in canonical ordering of windows.\n\
1511 If omitted, WINDOW defaults to the selected window.\n\
1512 \n\
1513 Optional second arg MINIBUF t means count the minibuffer window even\n\
1514 if not active. MINIBUF nil or omitted means count the minibuffer iff\n\
1515 it is active. MINIBUF neither t nor nil means not to count the\n\
1516 minibuffer even if it is active.\n\
1517 \n\
1518 Several frames may share a single minibuffer; if the minibuffer\n\
1519 counts, all windows on all frames that share that minibuffer count\n\
1520 too. Therefore, `next-window' can be used to iterate through the\n\
1521 set of windows even when the minibuffer is on another frame. If the\n\
1522 minibuffer does not count, only windows from WINDOW's frame count.\n\
1523 \n\
1524 Optional third arg ALL-FRAMES t means include windows on all frames.\n\
1525 ALL-FRAMES nil or omitted means cycle within the frames as specified\n\
1526 above. ALL-FRAMES = `visible' means include windows on all visible frames.\n\
1527 ALL-FRAMES = 0 means include windows on all visible and iconified frames.\n\
1528 If ALL-FRAMES is a frame, restrict search to windows on that frame.\n\
1529 Anything else means restrict to WINDOW's frame.\n\
1530 \n\
1531 If you use consistent values for MINIBUF and ALL-FRAMES, you can use\n\
1532 `next-window' to iterate through the entire cycle of acceptable\n\
1533 windows, eventually ending up back at the window you started with.\n\
1534 `previous-window' traverses the same cycle, in the reverse order.")
1535 (window, minibuf, all_frames) */
1536
1537 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
1538 0)
1539 (window, minibuf, all_frames)
1540 Lisp_Object window, minibuf, all_frames;
1541 {
1542 return next_window (window, minibuf, all_frames, 1);
1543 }
1544
1545
1546 /* This comment supplies the doc string for `previous-window',
1547 for make-docfile to see. We cannot put this in the real DEFUN
1548 due to limits in the Unix cpp.
1549
1550 DEFUN ("previous-window", Ffoo, Sfoo, 0, 3, 0,
1551 "Return the window preceding WINDOW in canonical ordering of windows.\n\
1552 If omitted, WINDOW defaults to the selected window.\n\
1553 \n\
1554 Optional second arg MINIBUF t means count the minibuffer window even\n\
1555 if not active. MINIBUF nil or omitted means count the minibuffer iff\n\
1556 it is active. MINIBUF neither t nor nil means not to count the\n\
1557 minibuffer even if it is active.\n\
1558 \n\
1559 Several frames may share a single minibuffer; if the minibuffer\n\
1560 counts, all windows on all frames that share that minibuffer count\n\
1561 too. Therefore, `previous-window' can be used to iterate through\n\
1562 the set of windows even when the minibuffer is on another frame. If\n\
1563 the minibuffer does not count, only windows from WINDOW's frame count\n\
1564 \n\
1565 Optional third arg ALL-FRAMES t means include windows on all frames.\n\
1566 ALL-FRAMES nil or omitted means cycle within the frames as specified\n\
1567 above. ALL-FRAMES = `visible' means include windows on all visible frames.\n\
1568 ALL-FRAMES = 0 means include windows on all visible and iconified frames.\n\
1569 If ALL-FRAMES is a frame, restrict search to windows on that frame.\n\
1570 Anything else means restrict to WINDOW's frame.\n\
1571 \n\
1572 If you use consistent values for MINIBUF and ALL-FRAMES, you can use\n\
1573 `previous-window' to iterate through the entire cycle of acceptable\n\
1574 windows, eventually ending up back at the window you started with.\n\
1575 `next-window' traverses the same cycle, in the reverse order.")
1576 (window, minibuf, all_frames) */
1577
1578
1579 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
1580 0)
1581 (window, minibuf, all_frames)
1582 Lisp_Object window, minibuf, all_frames;
1583 {
1584 return next_window (window, minibuf, all_frames, 0);
1585 }
1586
1587
1588 DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
1589 "Select the ARG'th different window on this frame.\n\
1590 All windows on current frame are arranged in a cyclic order.\n\
1591 This command selects the window ARG steps away in that order.\n\
1592 A negative ARG moves in the opposite order. If the optional second\n\
1593 argument ALL_FRAMES is non-nil, cycle through all frames.")
1594 (arg, all_frames)
1595 Lisp_Object arg, all_frames;
1596 {
1597 Lisp_Object window;
1598 int i;
1599
1600 CHECK_NUMBER (arg, 0);
1601 window = selected_window;
1602
1603 for (i = XINT (arg); i > 0; --i)
1604 window = Fnext_window (window, Qnil, all_frames);
1605 for (; i < 0; ++i)
1606 window = Fprevious_window (window, Qnil, all_frames);
1607
1608 Fselect_window (window);
1609 return Qnil;
1610 }
1611
1612
1613 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
1614 "Return a list of windows on FRAME, starting with WINDOW.\n\
1615 FRAME nil or omitted means use the selected frame.\n\
1616 WINDOW nil or omitted means use the selected window.\n\
1617 MINIBUF t means include the minibuffer window, even if it isn't active.\n\
1618 MINIBUF nil or omitted means include the minibuffer window only\n\
1619 if it's active.\n\
1620 MINIBUF neither nil nor t means never include the minibuffer window.")
1621 (frame, minibuf, window)
1622 Lisp_Object frame, minibuf, window;
1623 {
1624 Lisp_Object list;
1625
1626 if (NILP (window))
1627 window = selected_window;
1628 if (NILP (frame))
1629 frame = selected_frame;
1630
1631 if (!EQ (frame, XWINDOW (window)->frame))
1632 error ("Window is on a different frame");
1633
1634 return window_list_1 (window, minibuf, frame);
1635 }
1636
1637
1638 /* Return a list of windows in canonical ordering. Arguments are like
1639 for `next-window'. */
1640
1641 static Lisp_Object
1642 window_list_1 (window, minibuf, all_frames)
1643 Lisp_Object window, minibuf, all_frames;
1644 {
1645 Lisp_Object tail, list;
1646
1647 decode_next_window_args (&window, &minibuf, &all_frames);
1648 list = Qnil;
1649
1650 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
1651 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
1652 list = Fcons (XCAR (tail), list);
1653
1654 return Fnreverse (list);
1655 }
1656
1657
1658 \f
1659 /* Look at all windows, performing an operation specified by TYPE
1660 with argument OBJ.
1661 If FRAMES is Qt, look at all frames;
1662 Qnil, look at just the selected frame;
1663 Qvisible, look at visible frames;
1664 a frame, just look at windows on that frame.
1665 If MINI is non-zero, perform the operation on minibuffer windows too.
1666 */
1667
1668 enum window_loop
1669 {
1670 WINDOW_LOOP_UNUSED,
1671 GET_BUFFER_WINDOW, /* Arg is buffer */
1672 GET_LRU_WINDOW, /* Arg is t for full-width windows only */
1673 DELETE_OTHER_WINDOWS, /* Arg is window not to delete */
1674 DELETE_BUFFER_WINDOWS, /* Arg is buffer */
1675 GET_LARGEST_WINDOW,
1676 UNSHOW_BUFFER, /* Arg is buffer */
1677 CHECK_ALL_WINDOWS
1678 };
1679
1680 static Lisp_Object
1681 window_loop (type, obj, mini, frames)
1682 enum window_loop type;
1683 Lisp_Object obj, frames;
1684 int mini;
1685 {
1686 Lisp_Object window, windows, best_window, frame_arg;
1687 struct frame *f;
1688 struct gcpro gcpro1;
1689
1690 /* If we're only looping through windows on a particular frame,
1691 frame points to that frame. If we're looping through windows
1692 on all frames, frame is 0. */
1693 if (FRAMEP (frames))
1694 f = XFRAME (frames);
1695 else if (NILP (frames))
1696 f = SELECTED_FRAME ();
1697 else
1698 f = NULL;
1699
1700 if (f)
1701 frame_arg = Qlambda;
1702 else if (XFASTINT (frames) == 0)
1703 frame_arg = frames;
1704 else if (EQ (frames, Qvisible))
1705 frame_arg = frames;
1706 else
1707 frame_arg = Qt;
1708
1709 /* frame_arg is Qlambda to stick to one frame,
1710 Qvisible to consider all visible frames,
1711 or Qt otherwise. */
1712
1713 /* Pick a window to start with. */
1714 if (WINDOWP (obj))
1715 window = obj;
1716 else if (f)
1717 window = FRAME_SELECTED_WINDOW (f);
1718 else
1719 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
1720
1721 /* Figure out the last window we're going to mess with. Since
1722 Fnext_window, given the same options, is guaranteed to go in a
1723 ring, we can just use Fprevious_window to find the last one.
1724
1725 We can't just wait until we hit the first window again, because
1726 it might be deleted. */
1727
1728 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
1729 GCPRO1 (windows);
1730 best_window = Qnil;
1731
1732 for (; CONSP (windows); windows = CDR (windows))
1733 {
1734 struct window *w;
1735
1736 window = XCAR (windows);
1737 w = XWINDOW (window);
1738
1739 /* Note that we do not pay attention here to whether the frame
1740 is visible, since Fwindow_list skips non-visible frames if
1741 that is desired, under the control of frame_arg. */
1742 if (!MINI_WINDOW_P (w)
1743 /* For UNSHOW_BUFFER, we must always consider all windows. */
1744 || type == UNSHOW_BUFFER
1745 || (mini && minibuf_level > 0))
1746 switch (type)
1747 {
1748 case GET_BUFFER_WINDOW:
1749 if (EQ (w->buffer, obj)
1750 /* Don't find any minibuffer window
1751 except the one that is currently in use. */
1752 && (MINI_WINDOW_P (w)
1753 ? EQ (window, minibuf_window)
1754 : 1))
1755 {
1756 UNGCPRO;
1757 return window;
1758 }
1759 break;
1760
1761 case GET_LRU_WINDOW:
1762 /* t as arg means consider only full-width windows */
1763 if (!NILP (obj) && !WINDOW_FULL_WIDTH_P (w))
1764 break;
1765 /* Ignore dedicated windows and minibuffers. */
1766 if (MINI_WINDOW_P (w) || !NILP (w->dedicated))
1767 break;
1768 if (NILP (best_window)
1769 || (XFASTINT (XWINDOW (best_window)->use_time)
1770 > XFASTINT (w->use_time)))
1771 best_window = window;
1772 break;
1773
1774 case DELETE_OTHER_WINDOWS:
1775 if (!EQ (window, obj))
1776 Fdelete_window (window);
1777 break;
1778
1779 case DELETE_BUFFER_WINDOWS:
1780 if (EQ (w->buffer, obj))
1781 {
1782 struct frame *f = XFRAME (WINDOW_FRAME (w));
1783
1784 /* If this window is dedicated, and in a frame of its own,
1785 kill the frame. */
1786 if (EQ (window, FRAME_ROOT_WINDOW (f))
1787 && !NILP (w->dedicated)
1788 && other_visible_frames (f))
1789 {
1790 /* Skip the other windows on this frame.
1791 There might be one, the minibuffer! */
1792 while (CONSP (XCDR (windows))
1793 && EQ (XWINDOW (XCAR (windows))->frame,
1794 XWINDOW (XCAR (XCDR (windows)))->frame))
1795 windows = XCDR (windows);
1796
1797 /* Now we can safely delete the frame. */
1798 Fdelete_frame (w->frame, Qnil);
1799 }
1800 else if (NILP (w->parent))
1801 {
1802 /* If we're deleting the buffer displayed in the
1803 only window on the frame, find a new buffer to
1804 display there. */
1805 Lisp_Object buffer;
1806 buffer = Fother_buffer (obj, Qnil, w->frame);
1807 if (NILP (buffer))
1808 buffer = Fget_buffer_create (build_string ("*scratch*"));
1809 Fset_window_buffer (window, buffer);
1810 if (EQ (window, selected_window))
1811 Fset_buffer (w->buffer);
1812 }
1813 else
1814 Fdelete_window (window);
1815 }
1816 break;
1817
1818 case GET_LARGEST_WINDOW:
1819 {
1820 /* Ignore dedicated windows and minibuffers. */
1821 if (MINI_WINDOW_P (w) || !NILP (w->dedicated))
1822 break;
1823
1824 if (NILP (best_window))
1825 best_window = window;
1826 else
1827 {
1828 struct window *b = XWINDOW (best_window);
1829 if (XFASTINT (w->height) * XFASTINT (w->width)
1830 > XFASTINT (b->height) * XFASTINT (b->width))
1831 best_window = window;
1832 }
1833 }
1834 break;
1835
1836 case UNSHOW_BUFFER:
1837 if (EQ (w->buffer, obj))
1838 {
1839 Lisp_Object buffer;
1840 struct frame *f = XFRAME (w->frame);
1841
1842 /* Find another buffer to show in this window. */
1843 buffer = Fother_buffer (obj, Qnil, w->frame);
1844 if (NILP (buffer))
1845 buffer = Fget_buffer_create (build_string ("*scratch*"));
1846
1847 /* If this window is dedicated, and in a frame of its own,
1848 kill the frame. */
1849 if (EQ (window, FRAME_ROOT_WINDOW (f))
1850 && !NILP (w->dedicated)
1851 && other_visible_frames (f))
1852 {
1853 /* Skip the other windows on this frame.
1854 There might be one, the minibuffer! */
1855 while (CONSP (XCDR (windows))
1856 && EQ (XWINDOW (XCAR (windows))->frame,
1857 XWINDOW (XCAR (XCDR (windows)))->frame))
1858 windows = XCDR (windows);
1859
1860 /* Now we can safely delete the frame. */
1861 Fdelete_frame (w->frame, Qnil);
1862 }
1863 else
1864 {
1865 /* Otherwise show a different buffer in the window. */
1866 w->dedicated = Qnil;
1867 Fset_window_buffer (window, buffer);
1868 if (EQ (window, selected_window))
1869 Fset_buffer (w->buffer);
1870 }
1871 }
1872 break;
1873
1874 /* Check for a window that has a killed buffer. */
1875 case CHECK_ALL_WINDOWS:
1876 if (! NILP (w->buffer)
1877 && NILP (XBUFFER (w->buffer)->name))
1878 abort ();
1879 break;
1880
1881 case WINDOW_LOOP_UNUSED:
1882 break;
1883 }
1884 }
1885
1886 UNGCPRO;
1887 return best_window;
1888 }
1889
1890 /* Used for debugging. Abort if any window has a dead buffer. */
1891
1892 void
1893 check_all_windows ()
1894 {
1895 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
1896 }
1897
1898 DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 1, 0,
1899 "Return the window least recently selected or used for display.\n\
1900 If optional argument FRAME is `visible', search all visible frames.\n\
1901 If FRAME is 0, search all visible and iconified frames.\n\
1902 If FRAME is t, search all frames.\n\
1903 If FRAME is nil, search only the selected frame.\n\
1904 If FRAME is a frame, search only that frame.")
1905 (frame)
1906 Lisp_Object frame;
1907 {
1908 register Lisp_Object w;
1909 /* First try for a window that is full-width */
1910 w = window_loop (GET_LRU_WINDOW, Qt, 0, frame);
1911 if (!NILP (w) && !EQ (w, selected_window))
1912 return w;
1913 /* If none of them, try the rest */
1914 return window_loop (GET_LRU_WINDOW, Qnil, 0, frame);
1915 }
1916
1917 DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 1, 0,
1918 "Return the largest window in area.\n\
1919 If optional argument FRAME is `visible', search all visible frames.\n\
1920 If FRAME is 0, search all visible and iconified frames.\n\
1921 If FRAME is t, search all frames.\n\
1922 If FRAME is nil, search only the selected frame.\n\
1923 If FRAME is a frame, search only that frame.")
1924 (frame)
1925 Lisp_Object frame;
1926 {
1927 return window_loop (GET_LARGEST_WINDOW, Qnil, 0,
1928 frame);
1929 }
1930
1931 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 1, 2, 0,
1932 "Return a window currently displaying BUFFER, or nil if none.\n\
1933 If optional argument FRAME is `visible', search all visible frames.\n\
1934 If optional argument FRAME is 0, search all visible and iconified frames.\n\
1935 If FRAME is t, search all frames.\n\
1936 If FRAME is nil, search only the selected frame.\n\
1937 If FRAME is a frame, search only that frame.")
1938 (buffer, frame)
1939 Lisp_Object buffer, frame;
1940 {
1941 buffer = Fget_buffer (buffer);
1942 if (BUFFERP (buffer))
1943 return window_loop (GET_BUFFER_WINDOW, buffer, 1, frame);
1944 else
1945 return Qnil;
1946 }
1947
1948 DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
1949 0, 1, "",
1950 "Make WINDOW (or the selected window) fill its frame.\n\
1951 Only the frame WINDOW is on is affected.\n\
1952 This function tries to reduce display jumps\n\
1953 by keeping the text previously visible in WINDOW\n\
1954 in the same place on the frame. Doing this depends on\n\
1955 the value of (window-start WINDOW), so if calling this function\n\
1956 in a program gives strange scrolling, make sure the window-start\n\
1957 value is reasonable when this function is called.")
1958 (window)
1959 Lisp_Object window;
1960 {
1961 struct window *w;
1962 int startpos;
1963 int top;
1964
1965 if (NILP (window))
1966 window = selected_window;
1967 else
1968 CHECK_LIVE_WINDOW (window, 0);
1969
1970 w = XWINDOW (window);
1971
1972 startpos = marker_position (w->start);
1973 top = XFASTINT (w->top) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
1974
1975 if (MINI_WINDOW_P (w) && top > 0)
1976 error ("Can't expand minibuffer to full frame");
1977
1978 window_loop (DELETE_OTHER_WINDOWS, window, 0, WINDOW_FRAME (w));
1979
1980 /* Try to minimize scrolling, by setting the window start to the point
1981 will cause the text at the old window start to be at the same place
1982 on the frame. But don't try to do this if the window start is
1983 outside the visible portion (as might happen when the display is
1984 not current, due to typeahead). */
1985 if (startpos >= BUF_BEGV (XBUFFER (w->buffer))
1986 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
1987 {
1988 struct position pos;
1989 struct buffer *obuf = current_buffer;
1990
1991 Fset_buffer (w->buffer);
1992 /* This computation used to temporarily move point, but that can
1993 have unwanted side effects due to text properties. */
1994 pos = *vmotion (startpos, -top, w);
1995
1996 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
1997 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
1998 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
1999 : Qnil);
2000 /* We need to do this, so that the window-scroll-functions
2001 get called. */
2002 w->optional_new_start = Qt;
2003
2004 set_buffer_internal (obuf);
2005 }
2006
2007 return Qnil;
2008 }
2009
2010 DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
2011 1, 2, "bDelete windows on (buffer): ",
2012 "Delete all windows showing BUFFER.\n\
2013 Optional second argument FRAME controls which frames are affected.\n\
2014 If optional argument FRAME is `visible', search all visible frames.\n\
2015 If FRAME is 0, search all visible and iconified frames.\n\
2016 If FRAME is nil, search all frames.\n\
2017 If FRAME is t, search only the selected frame.\n\
2018 If FRAME is a frame, search only that frame.")
2019 (buffer, frame)
2020 Lisp_Object buffer, frame;
2021 {
2022 /* FRAME uses t and nil to mean the opposite of what window_loop
2023 expects. */
2024 if (NILP (frame))
2025 frame = Qt;
2026 else if (EQ (frame, Qt))
2027 frame = Qnil;
2028
2029 if (!NILP (buffer))
2030 {
2031 buffer = Fget_buffer (buffer);
2032 CHECK_BUFFER (buffer, 0);
2033 window_loop (DELETE_BUFFER_WINDOWS, buffer, 0, frame);
2034 }
2035
2036 return Qnil;
2037 }
2038
2039 DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows,
2040 Sreplace_buffer_in_windows,
2041 1, 1, "bReplace buffer in windows: ",
2042 "Replace BUFFER with some other buffer in all windows showing it.")
2043 (buffer)
2044 Lisp_Object buffer;
2045 {
2046 if (!NILP (buffer))
2047 {
2048 buffer = Fget_buffer (buffer);
2049 CHECK_BUFFER (buffer, 0);
2050 window_loop (UNSHOW_BUFFER, buffer, 0, Qt);
2051 }
2052 return Qnil;
2053 }
2054
2055 /* Replace BUFFER with some other buffer in all windows
2056 of all frames, even those on other keyboards. */
2057
2058 void
2059 replace_buffer_in_all_windows (buffer)
2060 Lisp_Object buffer;
2061 {
2062 #ifdef MULTI_KBOARD
2063 Lisp_Object tail, frame;
2064
2065 /* A single call to window_loop won't do the job
2066 because it only considers frames on the current keyboard.
2067 So loop manually over frames, and handle each one. */
2068 FOR_EACH_FRAME (tail, frame)
2069 window_loop (UNSHOW_BUFFER, buffer, 1, frame);
2070 #else
2071 window_loop (UNSHOW_BUFFER, buffer, 1, Qt);
2072 #endif
2073 }
2074 \f
2075 /* Set the height of WINDOW and all its inferiors. */
2076
2077 /* The smallest acceptable dimensions for a window. Anything smaller
2078 might crash Emacs. */
2079
2080 #define MIN_SAFE_WINDOW_WIDTH (2)
2081 #define MIN_SAFE_WINDOW_HEIGHT (2)
2082
2083 /* Make sure that window_min_height and window_min_width are
2084 not too small; if they are, set them to safe minima. */
2085
2086 static void
2087 check_min_window_sizes ()
2088 {
2089 /* Smaller values might permit a crash. */
2090 if (window_min_width < MIN_SAFE_WINDOW_WIDTH)
2091 window_min_width = MIN_SAFE_WINDOW_WIDTH;
2092 if (window_min_height < MIN_SAFE_WINDOW_HEIGHT)
2093 window_min_height = MIN_SAFE_WINDOW_HEIGHT;
2094 }
2095
2096 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2097 minimum allowable size. */
2098
2099 void
2100 check_frame_size (frame, rows, cols)
2101 FRAME_PTR frame;
2102 int *rows, *cols;
2103 {
2104 /* For height, we have to see:
2105 whether the frame has a minibuffer,
2106 whether it wants a mode line, and
2107 whether it has a menu bar. */
2108 int min_height =
2109 (FRAME_MINIBUF_ONLY_P (frame) ? MIN_SAFE_WINDOW_HEIGHT - 1
2110 : (! FRAME_HAS_MINIBUF_P (frame)) ? MIN_SAFE_WINDOW_HEIGHT
2111 : 2 * MIN_SAFE_WINDOW_HEIGHT - 1);
2112
2113 if (FRAME_TOP_MARGIN (frame) > 0)
2114 min_height += FRAME_TOP_MARGIN (frame);
2115
2116 if (*rows < min_height)
2117 *rows = min_height;
2118 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2119 *cols = MIN_SAFE_WINDOW_WIDTH;
2120 }
2121
2122
2123 /* Value is non-zero if window W is fixed-size. WIDTH_P non-zero means
2124 check if W's width can be changed, otherwise check W's height.
2125 CHECK_SIBLINGS_P non-zero means check resizablity of WINDOW's
2126 siblings, too. If none of the siblings is resizable, WINDOW isn't
2127 either. */
2128
2129 static int
2130 window_fixed_size_p (w, width_p, check_siblings_p)
2131 struct window *w;
2132 int width_p, check_siblings_p;
2133 {
2134 int fixed_p;
2135 struct window *c;
2136
2137 if (!NILP (w->hchild))
2138 {
2139 c = XWINDOW (w->hchild);
2140
2141 if (width_p)
2142 {
2143 /* A horiz. combination is fixed-width if all of if its
2144 children are. */
2145 while (c && window_fixed_size_p (c, width_p, 0))
2146 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2147 fixed_p = c == NULL;
2148 }
2149 else
2150 {
2151 /* A horiz. combination is fixed-height if one of if its
2152 children is. */
2153 while (c && !window_fixed_size_p (c, width_p, 0))
2154 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2155 fixed_p = c != NULL;
2156 }
2157 }
2158 else if (!NILP (w->vchild))
2159 {
2160 c = XWINDOW (w->vchild);
2161
2162 if (width_p)
2163 {
2164 /* A vert. combination is fixed-width if one of if its
2165 children is. */
2166 while (c && !window_fixed_size_p (c, width_p, 0))
2167 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2168 fixed_p = c != NULL;
2169 }
2170 else
2171 {
2172 /* A vert. combination is fixed-height if all of if its
2173 children are. */
2174 while (c && window_fixed_size_p (c, width_p, 0))
2175 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2176 fixed_p = c == NULL;
2177 }
2178 }
2179 else if (BUFFERP (w->buffer))
2180 {
2181 if (w->height_fixed_p && !width_p)
2182 fixed_p = 1;
2183 else
2184 {
2185 struct buffer *old = current_buffer;
2186 Lisp_Object val;
2187
2188 current_buffer = XBUFFER (w->buffer);
2189 val = find_symbol_value (Qwindow_size_fixed);
2190 current_buffer = old;
2191
2192 fixed_p = 0;
2193 if (!EQ (val, Qunbound))
2194 {
2195 fixed_p = !NILP (val);
2196
2197 if (fixed_p
2198 && ((EQ (val, Qheight) && width_p)
2199 || (EQ (val, Qwidth) && !width_p)))
2200 fixed_p = 0;
2201 }
2202 }
2203
2204 /* Can't tell if this one is resizable without looking at
2205 siblings. If all siblings are fixed-size this one is too. */
2206 if (!fixed_p && check_siblings_p && WINDOWP (w->parent))
2207 {
2208 Lisp_Object child;
2209
2210 for (child = w->prev; !NILP (child); child = XWINDOW (child)->prev)
2211 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2212 break;
2213
2214 if (NILP (child))
2215 for (child = w->next; !NILP (child); child = XWINDOW (child)->next)
2216 if (!window_fixed_size_p (XWINDOW (child), width_p, 0))
2217 break;
2218
2219 if (NILP (child))
2220 fixed_p = 1;
2221 }
2222 }
2223 else
2224 fixed_p = 1;
2225
2226 return fixed_p;
2227 }
2228
2229
2230 /* Return the minimum size of window W, not taking fixed-width windows
2231 into account. WIDTH_P non-zero means return the minimum width,
2232 otherwise return the minimum height. If W is a combination window,
2233 compute the minimum size from the minimum sizes of W's children. */
2234
2235 static int
2236 window_min_size_1 (w, width_p)
2237 struct window *w;
2238 int width_p;
2239 {
2240 struct window *c;
2241 int size;
2242
2243 if (!NILP (w->hchild))
2244 {
2245 c = XWINDOW (w->hchild);
2246 size = 0;
2247
2248 if (width_p)
2249 {
2250 /* The min width of a horizontal combination is
2251 the sum of the min widths of its children. */
2252 while (c)
2253 {
2254 size += window_min_size_1 (c, width_p);
2255 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2256 }
2257 }
2258 else
2259 {
2260 /* The min height a horizontal combination equals
2261 the maximum of all min height of its children. */
2262 while (c)
2263 {
2264 int min_size = window_min_size_1 (c, width_p);
2265 size = max (min_size, size);
2266 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2267 }
2268 }
2269 }
2270 else if (!NILP (w->vchild))
2271 {
2272 c = XWINDOW (w->vchild);
2273 size = 0;
2274
2275 if (width_p)
2276 {
2277 /* The min width of a vertical combination is
2278 the maximum of the min widths of its children. */
2279 while (c)
2280 {
2281 int min_size = window_min_size_1 (c, width_p);
2282 size = max (min_size, size);
2283 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2284 }
2285 }
2286 else
2287 {
2288 /* The min height of a vertical combination equals
2289 the sum of the min height of its children. */
2290 while (c)
2291 {
2292 size += window_min_size_1 (c, width_p);
2293 c = WINDOWP (c->next) ? XWINDOW (c->next) : NULL;
2294 }
2295 }
2296 }
2297 else
2298 {
2299 if (width_p)
2300 size = window_min_width;
2301 else
2302 {
2303 if (MINI_WINDOW_P (w)
2304 || (!WINDOW_WANTS_MODELINE_P (w)
2305 && !WINDOW_WANTS_HEADER_LINE_P (w)))
2306 size = 1;
2307 else
2308 size = window_min_height;
2309 }
2310 }
2311
2312 return size;
2313 }
2314
2315
2316 /* Return the minimum size of window W, taking fixed-size windows into
2317 account. WIDTH_P non-zero means return the minimum width,
2318 otherwise return the minimum height. IGNORE_FIXED_P non-zero means
2319 ignore if W is fixed-size. Set *FIXED to 1 if W is fixed-size
2320 unless FIXED is null. */
2321
2322 static int
2323 window_min_size (w, width_p, ignore_fixed_p, fixed)
2324 struct window *w;
2325 int width_p, ignore_fixed_p, *fixed;
2326 {
2327 int size, fixed_p;
2328
2329 if (ignore_fixed_p)
2330 fixed_p = 0;
2331 else
2332 fixed_p = window_fixed_size_p (w, width_p, 1);
2333
2334 if (fixed)
2335 *fixed = fixed_p;
2336
2337 if (fixed_p)
2338 size = width_p ? XFASTINT (w->width) : XFASTINT (w->height);
2339 else
2340 size = window_min_size_1 (w, width_p);
2341
2342 return size;
2343 }
2344
2345
2346 /* Set WINDOW's height or width to SIZE. WIDTH_P non-zero means set
2347 WINDOW's width. Resize WINDOW's children, if any, so that they
2348 keep their proportionate size relative to WINDOW. Propagate
2349 WINDOW's top or left edge position to children. Delete windows
2350 that become too small unless NODELETE_P is non-zero. */
2351
2352 static void
2353 size_window (window, size, width_p, nodelete_p)
2354 Lisp_Object window;
2355 int size, width_p, nodelete_p;
2356 {
2357 struct window *w = XWINDOW (window);
2358 struct window *c;
2359 Lisp_Object child, *forward, *sideward;
2360 int old_size, min_size;
2361
2362 check_min_window_sizes ();
2363 size = max (0, size);
2364
2365 /* If the window has been "too small" at one point,
2366 don't delete it for being "too small" in the future.
2367 Preserve it as long as that is at all possible. */
2368 if (width_p)
2369 {
2370 old_size = XINT (w->width);
2371 min_size = window_min_width;
2372 }
2373 else
2374 {
2375 old_size = XINT (w->height);
2376 min_size = window_min_height;
2377 }
2378
2379 if (old_size < window_min_width)
2380 w->too_small_ok = Qt;
2381
2382 /* Maybe delete WINDOW if it's too small. */
2383 if (!nodelete_p && !NILP (w->parent))
2384 {
2385 int min_size;
2386
2387 if (!MINI_WINDOW_P (w) && !NILP (w->too_small_ok))
2388 min_size = width_p ? MIN_SAFE_WINDOW_WIDTH : MIN_SAFE_WINDOW_HEIGHT;
2389 else
2390 min_size = width_p ? window_min_width : window_min_height;
2391
2392 if (size < min_size)
2393 {
2394 delete_window (window);
2395 return;
2396 }
2397 }
2398
2399 /* Set redisplay hints. */
2400 w->last_modified = make_number (0);
2401 w->last_overlay_modified = make_number (0);
2402 windows_or_buffers_changed++;
2403 FRAME_WINDOW_SIZES_CHANGED (XFRAME (w->frame)) = 1;
2404
2405 if (width_p)
2406 {
2407 sideward = &w->vchild;
2408 forward = &w->hchild;
2409 w->width = make_number (size);
2410 }
2411 else
2412 {
2413 sideward = &w->hchild;
2414 forward = &w->vchild;
2415 w->height = make_number (size);
2416 }
2417
2418 if (!NILP (*sideward))
2419 {
2420 for (child = *sideward; !NILP (child); child = c->next)
2421 {
2422 c = XWINDOW (child);
2423 if (width_p)
2424 c->left = w->left;
2425 else
2426 c->top = w->top;
2427 size_window (child, size, width_p, nodelete_p);
2428 }
2429 }
2430 else if (!NILP (*forward))
2431 {
2432 int fixed_size, each, extra, n;
2433 int resize_fixed_p, nfixed;
2434 int last_pos, first_pos, nchildren, total;
2435
2436 /* Determine the fixed-size portion of the this window, and the
2437 number of child windows. */
2438 fixed_size = nchildren = nfixed = total = 0;
2439 for (child = *forward; !NILP (child); child = c->next, ++nchildren)
2440 {
2441 int child_size;
2442
2443 c = XWINDOW (child);
2444 child_size = width_p ? XINT (c->width) : XINT (c->height);
2445 total += child_size;
2446
2447 if (window_fixed_size_p (c, width_p, 0))
2448 {
2449 fixed_size += child_size;
2450 ++nfixed;
2451 }
2452 }
2453
2454 /* If the new size is smaller than fixed_size, or if there
2455 aren't any resizable windows, allow resizing fixed-size
2456 windows. */
2457 resize_fixed_p = nfixed == nchildren || size < fixed_size;
2458
2459 /* Compute how many lines/columns to add to each child. The
2460 value of extra takes care of rounding errors. */
2461 n = resize_fixed_p ? nchildren : nchildren - nfixed;
2462 each = (size - total) / n;
2463 extra = (size - total) - n * each;
2464
2465 /* Compute new children heights and edge positions. */
2466 first_pos = width_p ? XINT (w->left) : XINT (w->top);
2467 last_pos = first_pos;
2468 for (child = *forward; !NILP (child); child = c->next)
2469 {
2470 int new_size, old_size;
2471
2472 c = XWINDOW (child);
2473 old_size = width_p ? XFASTINT (c->width) : XFASTINT (c->height);
2474 new_size = old_size;
2475
2476 /* The top or left edge position of this child equals the
2477 bottom or right edge of its predecessor. */
2478 if (width_p)
2479 c->left = make_number (last_pos);
2480 else
2481 c->top = make_number (last_pos);
2482
2483 /* If this child can be resized, do it. */
2484 if (resize_fixed_p || !window_fixed_size_p (c, width_p, 0))
2485 {
2486 new_size = old_size + each + extra;
2487 extra = 0;
2488 }
2489
2490 /* Set new height. Note that size_window also propagates
2491 edge positions to children, so it's not a no-op if we
2492 didn't change the child's size. */
2493 size_window (child, new_size, width_p, 1);
2494
2495 /* Remember the bottom/right edge position of this child; it
2496 will be used to set the top/left edge of the next child. */
2497 last_pos += new_size;
2498 }
2499
2500 /* We should have covered the parent exactly with child windows. */
2501 xassert (size == last_pos - first_pos);
2502
2503 /* Now delete any children that became too small. */
2504 if (!nodelete_p)
2505 for (child = *forward; !NILP (child); child = c->next)
2506 {
2507 int child_size;
2508 c = XWINDOW (child);
2509 child_size = width_p ? XINT (c->width) : XINT (c->height);
2510 size_window (child, child_size, width_p, 0);
2511 }
2512 }
2513 }
2514
2515 /* Set WINDOW's height to HEIGHT, and recursively change the height of
2516 WINDOW's children. NODELETE non-zero means don't delete windows
2517 that become too small in the process. (The caller should check
2518 later and do so if appropriate.) */
2519
2520 void
2521 set_window_height (window, height, nodelete)
2522 Lisp_Object window;
2523 int height;
2524 int nodelete;
2525 {
2526 size_window (window, height, 0, nodelete);
2527 }
2528
2529
2530 /* Set WINDOW's width to WIDTH, and recursively change the width of
2531 WINDOW's children. NODELETE non-zero means don't delete windows
2532 that become too small in the process. (The caller should check
2533 later and do so if appropriate.) */
2534
2535 void
2536 set_window_width (window, width, nodelete)
2537 Lisp_Object window;
2538 int width;
2539 int nodelete;
2540 {
2541 size_window (window, width, 1, nodelete);
2542 }
2543
2544 \f
2545 int window_select_count;
2546
2547 Lisp_Object
2548 Fset_window_buffer_unwind (obuf)
2549 Lisp_Object obuf;
2550 {
2551 Fset_buffer (obuf);
2552 return Qnil;
2553 }
2554
2555
2556 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
2557 means it's allowed to run hooks. See make_frame for a case where
2558 it's not allowed. */
2559
2560 void
2561 set_window_buffer (window, buffer, run_hooks_p)
2562 Lisp_Object window, buffer;
2563 int run_hooks_p;
2564 {
2565 struct window *w = XWINDOW (window);
2566 struct buffer *b = XBUFFER (buffer);
2567 int count = specpdl_ptr - specpdl;
2568
2569 w->buffer = buffer;
2570
2571 if (EQ (window, selected_window))
2572 b->last_selected_window = window;
2573
2574 /* Update time stamps of buffer display. */
2575 if (INTEGERP (b->display_count))
2576 XSETINT (b->display_count, XINT (b->display_count) + 1);
2577 b->display_time = Fcurrent_time ();
2578
2579 XSETFASTINT (w->window_end_pos, 0);
2580 XSETFASTINT (w->window_end_vpos, 0);
2581 bzero (&w->last_cursor, sizeof w->last_cursor);
2582 w->window_end_valid = Qnil;
2583 XSETFASTINT (w->hscroll, 0);
2584 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
2585 set_marker_restricted (w->start,
2586 make_number (b->last_window_start),
2587 buffer);
2588 w->start_at_line_beg = Qnil;
2589 w->force_start = Qnil;
2590 XSETFASTINT (w->last_modified, 0);
2591 XSETFASTINT (w->last_overlay_modified, 0);
2592 windows_or_buffers_changed++;
2593
2594 /* We must select BUFFER for running the window-scroll-functions.
2595 If WINDOW is selected, switch permanently.
2596 Otherwise, switch but go back to the ambient buffer afterward. */
2597 if (EQ (window, selected_window))
2598 Fset_buffer (buffer);
2599 /* We can't check ! NILP (Vwindow_scroll_functions) here
2600 because that might itself be a local variable. */
2601 else if (window_initialized)
2602 {
2603 record_unwind_protect (Fset_window_buffer_unwind, Fcurrent_buffer ());
2604 Fset_buffer (buffer);
2605 }
2606
2607 /* Set left and right marginal area width from buffer. */
2608 Fset_window_margins (window, b->left_margin_width, b->right_margin_width);
2609
2610 if (run_hooks_p)
2611 {
2612 if (! NILP (Vwindow_scroll_functions))
2613 run_hook_with_args_2 (Qwindow_scroll_functions, window,
2614 Fmarker_position (w->start));
2615
2616 if (! NILP (Vwindow_configuration_change_hook)
2617 && ! NILP (Vrun_hooks))
2618 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
2619 }
2620
2621 unbind_to (count, Qnil);
2622 }
2623
2624
2625 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 2, 0,
2626 "Make WINDOW display BUFFER as its contents.\n\
2627 BUFFER can be a buffer or buffer name.")
2628 (window, buffer)
2629 register Lisp_Object window, buffer;
2630 {
2631 register Lisp_Object tem;
2632 register struct window *w = decode_window (window);
2633
2634 XSETWINDOW (window, w);
2635 buffer = Fget_buffer (buffer);
2636 CHECK_BUFFER (buffer, 1);
2637
2638 if (NILP (XBUFFER (buffer)->name))
2639 error ("Attempt to display deleted buffer");
2640
2641 tem = w->buffer;
2642 if (NILP (tem))
2643 error ("Window is deleted");
2644 else if (! EQ (tem, Qt)) /* w->buffer is t when the window
2645 is first being set up. */
2646 {
2647 if (!NILP (w->dedicated) && !EQ (tem, buffer))
2648 error ("Window is dedicated to `%s'",
2649 XSTRING (XBUFFER (tem)->name)->data);
2650
2651 unshow_buffer (w);
2652 }
2653
2654 set_window_buffer (window, buffer, 1);
2655 return Qnil;
2656 }
2657
2658 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 1, 0,
2659 "Select WINDOW. Most editing will apply to WINDOW's buffer.\n\
2660 If WINDOW is not already selected, also make WINDOW's buffer current.\n\
2661 Note that the main editor command loop\n\
2662 selects the buffer of the selected window before each command.")
2663 (window)
2664 register Lisp_Object window;
2665 {
2666 return select_window_1 (window, 1);
2667 }
2668 \f
2669 /* Note that selected_window can be nil
2670 when this is called from Fset_window_configuration. */
2671
2672 static Lisp_Object
2673 select_window_1 (window, recordflag)
2674 register Lisp_Object window;
2675 int recordflag;
2676 {
2677 register struct window *w;
2678 register struct window *ow;
2679 struct frame *sf;
2680
2681 CHECK_LIVE_WINDOW (window, 0);
2682
2683 w = XWINDOW (window);
2684
2685 if (NILP (w->buffer))
2686 error ("Trying to select deleted window or non-leaf window");
2687
2688 XSETFASTINT (w->use_time, ++window_select_count);
2689 if (EQ (window, selected_window))
2690 return window;
2691
2692 if (!NILP (selected_window))
2693 {
2694 ow = XWINDOW (selected_window);
2695 if (! NILP (ow->buffer))
2696 set_marker_both (ow->pointm, ow->buffer,
2697 BUF_PT (XBUFFER (ow->buffer)),
2698 BUF_PT_BYTE (XBUFFER (ow->buffer)));
2699 }
2700
2701 selected_window = window;
2702 sf = SELECTED_FRAME ();
2703 if (XFRAME (WINDOW_FRAME (w)) != sf)
2704 {
2705 XFRAME (WINDOW_FRAME (w))->selected_window = window;
2706 /* Use this rather than Fhandle_switch_frame
2707 so that FRAME_FOCUS_FRAME is moved appropriately as we
2708 move around in the state where a minibuffer in a separate
2709 frame is active. */
2710 Fselect_frame (WINDOW_FRAME (w), Qnil);
2711 }
2712 else
2713 sf->selected_window = window;
2714
2715 if (recordflag)
2716 record_buffer (w->buffer);
2717 Fset_buffer (w->buffer);
2718
2719 XBUFFER (w->buffer)->last_selected_window = window;
2720
2721 /* Go to the point recorded in the window.
2722 This is important when the buffer is in more
2723 than one window. It also matters when
2724 redisplay_window has altered point after scrolling,
2725 because it makes the change only in the window. */
2726 {
2727 register int new_point = marker_position (w->pointm);
2728 if (new_point < BEGV)
2729 SET_PT (BEGV);
2730 else if (new_point > ZV)
2731 SET_PT (ZV);
2732 else
2733 SET_PT (new_point);
2734 }
2735
2736 windows_or_buffers_changed++;
2737 return window;
2738 }
2739 \f
2740 /* Deiconify the frame containing the window WINDOW,
2741 unless it is the selected frame;
2742 then return WINDOW.
2743
2744 The reason for the exception for the selected frame
2745 is that it seems better not to change the selected frames visibility
2746 merely because of displaying a different buffer in it.
2747 The deiconification is useful when a buffer gets shown in
2748 another frame that you were not using lately. */
2749
2750 static Lisp_Object
2751 display_buffer_1 (window)
2752 Lisp_Object window;
2753 {
2754 Lisp_Object frame = XWINDOW (window)->frame;
2755 FRAME_PTR f = XFRAME (frame);
2756
2757 FRAME_SAMPLE_VISIBILITY (f);
2758
2759 if (!EQ (frame, selected_frame))
2760 {
2761 if (FRAME_ICONIFIED_P (f))
2762 Fmake_frame_visible (frame);
2763 else if (FRAME_VISIBLE_P (f))
2764 Fraise_frame (frame);
2765 }
2766
2767 return window;
2768 }
2769
2770 DEFUN ("special-display-p", Fspecial_display_p, Sspecial_display_p, 1, 1, 0,
2771 "Returns non-nil if a buffer named BUFFER-NAME would be created specially.\n\
2772 The value is actually t if the frame should be called with default frame\n\
2773 parameters, and a list of frame parameters if they were specified.\n\
2774 See `special-display-buffer-names', and `special-display-regexps'.")
2775 (buffer_name)
2776 Lisp_Object buffer_name;
2777 {
2778 Lisp_Object tem;
2779
2780 CHECK_STRING (buffer_name, 1);
2781
2782 tem = Fmember (buffer_name, Vspecial_display_buffer_names);
2783 if (!NILP (tem))
2784 return Qt;
2785
2786 tem = Fassoc (buffer_name, Vspecial_display_buffer_names);
2787 if (!NILP (tem))
2788 return XCDR (tem);
2789
2790 for (tem = Vspecial_display_regexps; CONSP (tem); tem = XCDR (tem))
2791 {
2792 Lisp_Object car = XCAR (tem);
2793 if (STRINGP (car)
2794 && fast_string_match (car, buffer_name) >= 0)
2795 return Qt;
2796 else if (CONSP (car)
2797 && STRINGP (XCAR (car))
2798 && fast_string_match (XCAR (car), buffer_name) >= 0)
2799 return XCDR (car);
2800 }
2801 return Qnil;
2802 }
2803
2804 DEFUN ("same-window-p", Fsame_window_p, Ssame_window_p, 1, 1, 0,
2805 "Returns non-nil if a new buffer named BUFFER-NAME would use the same window.\n\
2806 See `same-window-buffer-names' and `same-window-regexps'.")
2807 (buffer_name)
2808 Lisp_Object buffer_name;
2809 {
2810 Lisp_Object tem;
2811
2812 CHECK_STRING (buffer_name, 1);
2813
2814 tem = Fmember (buffer_name, Vsame_window_buffer_names);
2815 if (!NILP (tem))
2816 return Qt;
2817
2818 tem = Fassoc (buffer_name, Vsame_window_buffer_names);
2819 if (!NILP (tem))
2820 return Qt;
2821
2822 for (tem = Vsame_window_regexps; CONSP (tem); tem = XCDR (tem))
2823 {
2824 Lisp_Object car = XCAR (tem);
2825 if (STRINGP (car)
2826 && fast_string_match (car, buffer_name) >= 0)
2827 return Qt;
2828 else if (CONSP (car)
2829 && STRINGP (XCAR (car))
2830 && fast_string_match (XCAR (car), buffer_name) >= 0)
2831 return Qt;
2832 }
2833 return Qnil;
2834 }
2835
2836 /* Use B so the default is (other-buffer). */
2837 DEFUN ("display-buffer", Fdisplay_buffer, Sdisplay_buffer, 1, 3,
2838 "BDisplay buffer: \nP",
2839 "Make BUFFER appear in some window but don't select it.\n\
2840 BUFFER can be a buffer or a buffer name.\n\
2841 If BUFFER is shown already in some window, just use that one,\n\
2842 unless the window is the selected window and the optional second\n\
2843 argument NOT-THIS-WINDOW is non-nil (interactively, with prefix arg).\n\
2844 If `pop-up-frames' is non-nil, make a new frame if no window shows BUFFER.\n\
2845 Returns the window displaying BUFFER.\n\
2846 If `display-reuse-frames' is non-nil, and another frame is currently\n\
2847 displaying BUFFER, then simply raise that frame.\n\
2848 \n\
2849 The variables `special-display-buffer-names', `special-display-regexps',\n\
2850 `same-window-buffer-names', and `same-window-regexps' customize how certain\n\
2851 buffer names are handled.\n\
2852 \n\
2853 If optional argument FRAME is `visible', search all visible frames.\n\
2854 If FRAME is 0, search all visible and iconified frames.\n\
2855 If FRAME is t, search all frames.\n\
2856 If FRAME is a frame, search only that frame.\n\
2857 If FRAME is nil, search only the selected frame\n\
2858 (actually the last nonminibuffer frame),\n\
2859 unless `pop-up-frames' or `display-buffer-reuse-frames' is non-nil,\n\
2860 which means search visible and iconified frames.\n\
2861 \n\
2862 If `even-window-heights' is non-nil, window heights will be evened out\n\
2863 if displaying the buffer causes two vertically\ adjacent windows to be\n\
2864 displayed.")
2865 (buffer, not_this_window, frame)
2866 register Lisp_Object buffer, not_this_window, frame;
2867 {
2868 register Lisp_Object window, tem, swp;
2869 struct frame *f;
2870
2871 swp = Qnil;
2872 buffer = Fget_buffer (buffer);
2873 CHECK_BUFFER (buffer, 0);
2874
2875 if (!NILP (Vdisplay_buffer_function))
2876 return call2 (Vdisplay_buffer_function, buffer, not_this_window);
2877
2878 if (NILP (not_this_window)
2879 && XBUFFER (XWINDOW (selected_window)->buffer) == XBUFFER (buffer))
2880 return display_buffer_1 (selected_window);
2881
2882 /* See if the user has specified this buffer should appear
2883 in the selected window. */
2884 if (NILP (not_this_window))
2885 {
2886 swp = Fsame_window_p (XBUFFER (buffer)->name);
2887 if (!NILP (swp) && !no_switch_window (selected_window))
2888 {
2889 Fswitch_to_buffer (buffer, Qnil);
2890 return display_buffer_1 (selected_window);
2891 }
2892 }
2893
2894 /* If the user wants pop-up-frames or display-reuse-frames, then
2895 look for a window showing BUFFER on any visible or iconified frame.
2896 Otherwise search only the current frame. */
2897 if (! NILP (frame))
2898 tem = frame;
2899 else if (pop_up_frames
2900 || display_buffer_reuse_frames
2901 || last_nonminibuf_frame == 0)
2902 XSETFASTINT (tem, 0);
2903 else
2904 XSETFRAME (tem, last_nonminibuf_frame);
2905
2906 window = Fget_buffer_window (buffer, tem);
2907 if (!NILP (window)
2908 && (NILP (not_this_window) || !EQ (window, selected_window)))
2909 return display_buffer_1 (window);
2910
2911 /* Certain buffer names get special handling. */
2912 if (!NILP (Vspecial_display_function) && NILP (swp))
2913 {
2914 tem = Fspecial_display_p (XBUFFER (buffer)->name);
2915 if (EQ (tem, Qt))
2916 return call1 (Vspecial_display_function, buffer);
2917 if (CONSP (tem))
2918 return call2 (Vspecial_display_function, buffer, tem);
2919 }
2920
2921 /* If there are no frames open that have more than a minibuffer,
2922 we need to create a new frame. */
2923 if (pop_up_frames || last_nonminibuf_frame == 0)
2924 {
2925 window = Fframe_selected_window (call0 (Vpop_up_frame_function));
2926 Fset_window_buffer (window, buffer);
2927 return display_buffer_1 (window);
2928 }
2929
2930 f = SELECTED_FRAME ();
2931 if (pop_up_windows
2932 || FRAME_MINIBUF_ONLY_P (f)
2933 /* If the current frame is a special display frame,
2934 don't try to reuse its windows. */
2935 || !NILP (XWINDOW (FRAME_ROOT_WINDOW (f))->dedicated))
2936 {
2937 Lisp_Object frames;
2938
2939 frames = Qnil;
2940 if (FRAME_MINIBUF_ONLY_P (f))
2941 XSETFRAME (frames, last_nonminibuf_frame);
2942 /* Don't try to create a window if would get an error */
2943 if (split_height_threshold < window_min_height << 1)
2944 split_height_threshold = window_min_height << 1;
2945
2946 /* Note that both Fget_largest_window and Fget_lru_window
2947 ignore minibuffers and dedicated windows.
2948 This means they can return nil. */
2949
2950 /* If the frame we would try to split cannot be split,
2951 try other frames. */
2952 if (FRAME_NO_SPLIT_P (NILP (frames) ? f : last_nonminibuf_frame))
2953 {
2954 /* Try visible frames first. */
2955 window = Fget_largest_window (Qvisible);
2956 /* If that didn't work, try iconified frames. */
2957 if (NILP (window))
2958 window = Fget_largest_window (make_number (0));
2959 if (NILP (window))
2960 window = Fget_largest_window (Qt);
2961 }
2962 else
2963 window = Fget_largest_window (frames);
2964
2965 /* If we got a tall enough full-width window that can be split,
2966 split it. */
2967 if (!NILP (window)
2968 && ! FRAME_NO_SPLIT_P (XFRAME (XWINDOW (window)->frame))
2969 && window_height (window) >= split_height_threshold
2970 && WINDOW_FULL_WIDTH_P (XWINDOW (window)))
2971 window = Fsplit_window (window, Qnil, Qnil);
2972 else
2973 {
2974 Lisp_Object upper, lower, other;
2975
2976 window = Fget_lru_window (frames);
2977 /* If the LRU window is selected, and big enough,
2978 and can be split, split it. */
2979 if (!NILP (window)
2980 && ! FRAME_NO_SPLIT_P (XFRAME (XWINDOW (window)->frame))
2981 && (EQ (window, selected_window)
2982 || EQ (XWINDOW (window)->parent, Qnil))
2983 && window_height (window) >= window_min_height << 1)
2984 window = Fsplit_window (window, Qnil, Qnil);
2985 /* If Fget_lru_window returned nil, try other approaches. */
2986
2987 /* Try visible frames first. */
2988 if (NILP (window))
2989 window = Fget_buffer_window (buffer, Qvisible);
2990 if (NILP (window))
2991 window = Fget_largest_window (Qvisible);
2992 /* If that didn't work, try iconified frames. */
2993 if (NILP (window))
2994 window = Fget_buffer_window (buffer, make_number (0));
2995 if (NILP (window))
2996 window = Fget_largest_window (make_number (0));
2997 /* Try invisible frames. */
2998 if (NILP (window))
2999 window = Fget_buffer_window (buffer, Qt);
3000 if (NILP (window))
3001 window = Fget_largest_window (Qt);
3002 /* As a last resort, make a new frame. */
3003 if (NILP (window))
3004 window = Fframe_selected_window (call0 (Vpop_up_frame_function));
3005 /* If window appears above or below another,
3006 even out their heights. */
3007 other = upper = lower = Qnil;
3008 if (!NILP (XWINDOW (window)->prev))
3009 other = upper = XWINDOW (window)->prev, lower = window;
3010 if (!NILP (XWINDOW (window)->next))
3011 other = lower = XWINDOW (window)->next, upper = window;
3012 if (!NILP (other)
3013 && !NILP (Veven_window_heights)
3014 /* Check that OTHER and WINDOW are vertically arrayed. */
3015 && !EQ (XWINDOW (other)->top, XWINDOW (window)->top)
3016 && (XFASTINT (XWINDOW (other)->height)
3017 > XFASTINT (XWINDOW (window)->height)))
3018 {
3019 int total = (XFASTINT (XWINDOW (other)->height)
3020 + XFASTINT (XWINDOW (window)->height));
3021 enlarge_window (upper,
3022 total / 2 - XFASTINT (XWINDOW (upper)->height),
3023 0);
3024 }
3025 }
3026 }
3027 else
3028 window = Fget_lru_window (Qnil);
3029
3030 Fset_window_buffer (window, buffer);
3031 return display_buffer_1 (window);
3032 }
3033
3034 void
3035 temp_output_buffer_show (buf)
3036 register Lisp_Object buf;
3037 {
3038 register struct buffer *old = current_buffer;
3039 register Lisp_Object window;
3040 register struct window *w;
3041
3042 XBUFFER (buf)->directory = current_buffer->directory;
3043
3044 Fset_buffer (buf);
3045 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3046 BEGV = BEG;
3047 ZV = Z;
3048 SET_PT (BEG);
3049 XBUFFER (buf)->prevent_redisplay_optimizations_p = 1;
3050 set_buffer_internal (old);
3051
3052 if (!EQ (Vtemp_buffer_show_function, Qnil))
3053 call1 (Vtemp_buffer_show_function, buf);
3054 else
3055 {
3056 window = Fdisplay_buffer (buf, Qnil, Qnil);
3057
3058 if (!EQ (XWINDOW (window)->frame, selected_frame))
3059 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3060 Vminibuf_scroll_window = window;
3061 w = XWINDOW (window);
3062 XSETFASTINT (w->hscroll, 0);
3063 set_marker_restricted_both (w->start, buf, 1, 1);
3064 set_marker_restricted_both (w->pointm, buf, 1, 1);
3065
3066 /* Run temp-buffer-show-hook, with the chosen window selected
3067 and it sbuffer current. */
3068 if (!NILP (Vrun_hooks))
3069 {
3070 Lisp_Object tem;
3071 tem = Fboundp (Qtemp_buffer_show_hook);
3072 if (!NILP (tem))
3073 {
3074 tem = Fsymbol_value (Qtemp_buffer_show_hook);
3075 if (!NILP (tem))
3076 {
3077 int count = specpdl_ptr - specpdl;
3078 Lisp_Object prev_window;
3079 prev_window = selected_window;
3080
3081 /* Select the window that was chosen, for running the hook. */
3082 record_unwind_protect (Fselect_window, prev_window);
3083 select_window_1 (window, 0);
3084 Fset_buffer (w->buffer);
3085 call1 (Vrun_hooks, Qtemp_buffer_show_hook);
3086 select_window_1 (prev_window, 0);
3087 unbind_to (count, Qnil);
3088 }
3089 }
3090 }
3091 }
3092 }
3093 \f
3094 static void
3095 make_dummy_parent (window)
3096 Lisp_Object window;
3097 {
3098 Lisp_Object new;
3099 register struct window *o, *p;
3100 register struct Lisp_Vector *vec;
3101 int i;
3102
3103 o = XWINDOW (window);
3104 vec = allocate_vectorlike ((EMACS_INT)VECSIZE (struct window));
3105 for (i = 0; i < VECSIZE (struct window); ++i)
3106 vec->contents[i] = ((struct Lisp_Vector *)o)->contents[i];
3107 vec->size = VECSIZE (struct window);
3108 p = (struct window *)vec;
3109 XSETWINDOW (new, p);
3110
3111 XSETFASTINT (p->sequence_number, ++sequence_number);
3112
3113 /* Put new into window structure in place of window */
3114 replace_window (window, new);
3115
3116 o->next = Qnil;
3117 o->prev = Qnil;
3118 o->vchild = Qnil;
3119 o->hchild = Qnil;
3120 o->parent = new;
3121
3122 p->start = Qnil;
3123 p->pointm = Qnil;
3124 p->buffer = Qnil;
3125 }
3126
3127 DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "",
3128 "Split WINDOW, putting SIZE lines in the first of the pair.\n\
3129 WINDOW defaults to selected one and SIZE to half its size.\n\
3130 If optional third arg HORFLAG is non-nil, split side by side\n\
3131 and put SIZE columns in the first of the pair. In that case,\n\
3132 SIZE includes that window's scroll bar, or the divider column to its right.")
3133 (window, size, horflag)
3134 Lisp_Object window, size, horflag;
3135 {
3136 register Lisp_Object new;
3137 register struct window *o, *p;
3138 FRAME_PTR fo;
3139 register int size_int;
3140
3141 if (NILP (window))
3142 window = selected_window;
3143 else
3144 CHECK_LIVE_WINDOW (window, 0);
3145
3146 o = XWINDOW (window);
3147 fo = XFRAME (WINDOW_FRAME (o));
3148
3149 if (NILP (size))
3150 {
3151 if (!NILP (horflag))
3152 /* Calculate the size of the left-hand window, by dividing
3153 the usable space in columns by two.
3154 We round up, since the left-hand window may include
3155 a dividing line, while the right-hand may not. */
3156 size_int = (XFASTINT (o->width) + 1) >> 1;
3157 else
3158 size_int = XFASTINT (o->height) >> 1;
3159 }
3160 else
3161 {
3162 CHECK_NUMBER (size, 1);
3163 size_int = XINT (size);
3164 }
3165
3166 if (MINI_WINDOW_P (o))
3167 error ("Attempt to split minibuffer window");
3168 else if (window_fixed_size_p (o, !NILP (horflag), 0))
3169 error ("Attempt to split fixed-size window");
3170
3171 check_min_window_sizes ();
3172
3173 if (NILP (horflag))
3174 {
3175 if (size_int < window_min_height)
3176 error ("Window height %d too small (after splitting)", size_int);
3177 if (size_int + window_min_height > XFASTINT (o->height))
3178 error ("Window height %d too small (after splitting)",
3179 XFASTINT (o->height) - size_int);
3180 if (NILP (o->parent)
3181 || NILP (XWINDOW (o->parent)->vchild))
3182 {
3183 make_dummy_parent (window);
3184 new = o->parent;
3185 XWINDOW (new)->vchild = window;
3186 }
3187 }
3188 else
3189 {
3190 if (size_int < window_min_width)
3191 error ("Window width %d too small (after splitting)", size_int);
3192
3193 if (size_int + window_min_width > XFASTINT (o->width))
3194 error ("Window width %d too small (after splitting)",
3195 XFASTINT (o->width) - size_int);
3196 if (NILP (o->parent)
3197 || NILP (XWINDOW (o->parent)->hchild))
3198 {
3199 make_dummy_parent (window);
3200 new = o->parent;
3201 XWINDOW (new)->hchild = window;
3202 }
3203 }
3204
3205 /* Now we know that window's parent is a vertical combination
3206 if we are dividing vertically, or a horizontal combination
3207 if we are making side-by-side windows */
3208
3209 windows_or_buffers_changed++;
3210 FRAME_WINDOW_SIZES_CHANGED (fo) = 1;
3211 new = make_window ();
3212 p = XWINDOW (new);
3213
3214 p->frame = o->frame;
3215 p->next = o->next;
3216 if (!NILP (p->next))
3217 XWINDOW (p->next)->prev = new;
3218 p->prev = window;
3219 o->next = new;
3220 p->parent = o->parent;
3221 p->buffer = Qt;
3222 p->window_end_valid = Qnil;
3223 bzero (&p->last_cursor, sizeof p->last_cursor);
3224
3225 /* Apportion the available frame space among the two new windows */
3226
3227 if (!NILP (horflag))
3228 {
3229 p->height = o->height;
3230 p->top = o->top;
3231 XSETFASTINT (p->width, XFASTINT (o->width) - size_int);
3232 XSETFASTINT (o->width, size_int);
3233 XSETFASTINT (p->left, XFASTINT (o->left) + size_int);
3234 }
3235 else
3236 {
3237 p->left = o->left;
3238 p->width = o->width;
3239 XSETFASTINT (p->height, XFASTINT (o->height) - size_int);
3240 XSETFASTINT (o->height, size_int);
3241 XSETFASTINT (p->top, XFASTINT (o->top) + size_int);
3242 }
3243
3244 /* Adjust glyph matrices. */
3245 adjust_glyphs (fo);
3246 Fset_window_buffer (new, o->buffer);
3247 return new;
3248 }
3249 \f
3250 DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 2, "p",
3251 "Make current window ARG lines bigger.\n\
3252 From program, optional second arg non-nil means grow sideways ARG columns.")
3253 (arg, side)
3254 register Lisp_Object arg, side;
3255 {
3256 CHECK_NUMBER (arg, 0);
3257 enlarge_window (selected_window, XINT (arg), !NILP (side));
3258
3259 if (! NILP (Vwindow_configuration_change_hook))
3260 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
3261
3262 return Qnil;
3263 }
3264
3265 DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 2, "p",
3266 "Make current window ARG lines smaller.\n\
3267 From program, optional second arg non-nil means shrink sideways arg columns.")
3268 (arg, side)
3269 register Lisp_Object arg, side;
3270 {
3271 CHECK_NUMBER (arg, 0);
3272 enlarge_window (selected_window, -XINT (arg), !NILP (side));
3273
3274 if (! NILP (Vwindow_configuration_change_hook))
3275 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
3276
3277 return Qnil;
3278 }
3279
3280 int
3281 window_height (window)
3282 Lisp_Object window;
3283 {
3284 register struct window *p = XWINDOW (window);
3285 return XFASTINT (p->height);
3286 }
3287
3288 int
3289 window_width (window)
3290 Lisp_Object window;
3291 {
3292 register struct window *p = XWINDOW (window);
3293 return XFASTINT (p->width);
3294 }
3295
3296
3297 #define CURBEG(w) \
3298 *(widthflag ? &(XWINDOW (w)->left) : &(XWINDOW (w)->top))
3299
3300 #define CURSIZE(w) \
3301 *(widthflag ? &(XWINDOW (w)->width) : &(XWINDOW (w)->height))
3302
3303
3304 /* Enlarge selected_window by DELTA. WIDTHFLAG non-zero means
3305 increase its width. Siblings of the selected window are resized to
3306 fullfil the size request. If they become too small in the process,
3307 they will be deleted. */
3308
3309 static void
3310 enlarge_window (window, delta, widthflag)
3311 Lisp_Object window;
3312 int delta, widthflag;
3313 {
3314 Lisp_Object parent, next, prev;
3315 struct window *p;
3316 Lisp_Object *sizep;
3317 int maximum;
3318 int (*sizefun) P_ ((Lisp_Object))
3319 = widthflag ? window_width : window_height;
3320 void (*setsizefun) P_ ((Lisp_Object, int, int))
3321 = (widthflag ? set_window_width : set_window_height);
3322
3323 /* Check values of window_min_width and window_min_height for
3324 validity. */
3325 check_min_window_sizes ();
3326
3327 /* Give up if this window cannot be resized. */
3328 if (window_fixed_size_p (XWINDOW (window), widthflag, 1))
3329 error ("Window is not resizable");
3330
3331 /* Find the parent of the selected window. */
3332 while (1)
3333 {
3334 p = XWINDOW (window);
3335 parent = p->parent;
3336
3337 if (NILP (parent))
3338 {
3339 if (widthflag)
3340 error ("No other window to side of this one");
3341 break;
3342 }
3343
3344 if (widthflag
3345 ? !NILP (XWINDOW (parent)->hchild)
3346 : !NILP (XWINDOW (parent)->vchild))
3347 break;
3348
3349 window = parent;
3350 }
3351
3352 sizep = &CURSIZE (window);
3353
3354 {
3355 register int maxdelta;
3356
3357 maxdelta = (!NILP (parent) ? (*sizefun) (parent) - XINT (*sizep)
3358 : !NILP (p->next) ? ((*sizefun) (p->next)
3359 - window_min_size (XWINDOW (p->next),
3360 widthflag, 0, 0))
3361 : !NILP (p->prev) ? ((*sizefun) (p->prev)
3362 - window_min_size (XWINDOW (p->prev),
3363 widthflag, 0, 0))
3364 /* This is a frame with only one window, a minibuffer-only
3365 or a minibufferless frame. */
3366 : (delta = 0));
3367
3368 if (delta > maxdelta)
3369 /* This case traps trying to make the minibuffer
3370 the full frame, or make the only window aside from the
3371 minibuffer the full frame. */
3372 delta = maxdelta;
3373 }
3374
3375 if (XINT (*sizep) + delta < window_min_size (XWINDOW (window), widthflag, 0, 0))
3376 {
3377 delete_window (window);
3378 return;
3379 }
3380
3381 if (delta == 0)
3382 return;
3383
3384 /* Find the total we can get from other siblings. */
3385 maximum = 0;
3386 for (next = p->next; ! NILP (next); next = XWINDOW (next)->next)
3387 maximum += (*sizefun) (next) - window_min_size (XWINDOW (next),
3388 widthflag, 0, 0);
3389 for (prev = p->prev; ! NILP (prev); prev = XWINDOW (prev)->prev)
3390 maximum += (*sizefun) (prev) - window_min_size (XWINDOW (prev),
3391 widthflag, 0, 0);
3392
3393 /* If we can get it all from them, do so. */
3394 if (delta <= maximum)
3395 {
3396 Lisp_Object first_unaffected;
3397 Lisp_Object first_affected;
3398 int fixed_p;
3399
3400 next = p->next;
3401 prev = p->prev;
3402 first_affected = window;
3403 /* Look at one sibling at a time,
3404 moving away from this window in both directions alternately,
3405 and take as much as we can get without deleting that sibling. */
3406 while (delta != 0 && (!NILP (next) || !NILP (prev)))
3407 {
3408 if (! NILP (next))
3409 {
3410 int this_one = ((*sizefun) (next)
3411 - window_min_size (XWINDOW (next),
3412 widthflag, 0, &fixed_p));
3413 if (!fixed_p)
3414 {
3415 if (this_one > delta)
3416 this_one = delta;
3417
3418 (*setsizefun) (next, (*sizefun) (next) - this_one, 0);
3419 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
3420
3421 delta -= this_one;
3422 }
3423
3424 next = XWINDOW (next)->next;
3425 }
3426
3427 if (delta == 0)
3428 break;
3429
3430 if (! NILP (prev))
3431 {
3432 int this_one = ((*sizefun) (prev)
3433 - window_min_size (XWINDOW (prev),
3434 widthflag, 0, &fixed_p));
3435 if (!fixed_p)
3436 {
3437 if (this_one > delta)
3438 this_one = delta;
3439
3440 first_affected = prev;
3441
3442 (*setsizefun) (prev, (*sizefun) (prev) - this_one, 0);
3443 (*setsizefun) (window, XINT (*sizep) + this_one, 0);
3444
3445 delta -= this_one;
3446 }
3447
3448 prev = XWINDOW (prev)->prev;
3449 }
3450 }
3451
3452 xassert (delta == 0);
3453
3454 /* Now recalculate the edge positions of all the windows affected,
3455 based on the new sizes. */
3456 first_unaffected = next;
3457 prev = first_affected;
3458 for (next = XWINDOW (prev)->next; ! EQ (next, first_unaffected);
3459 prev = next, next = XWINDOW (next)->next)
3460 {
3461 XSETINT (CURBEG (next), XINT (CURBEG (prev)) + (*sizefun) (prev));
3462 /* This does not change size of NEXT,
3463 but it propagates the new top edge to its children */
3464 (*setsizefun) (next, (*sizefun) (next), 0);
3465 }
3466 }
3467 else
3468 {
3469 register int delta1;
3470 register int opht = (*sizefun) (parent);
3471
3472 /* If trying to grow this window to or beyond size of the parent,
3473 make delta1 so big that, on shrinking back down,
3474 all the siblings end up with less than one line and are deleted. */
3475 if (opht <= XINT (*sizep) + delta)
3476 delta1 = opht * opht * 2;
3477 else
3478 {
3479 /* Otherwise, make delta1 just right so that if we add
3480 delta1 lines to this window and to the parent, and then
3481 shrink the parent back to its original size, the new
3482 proportional size of this window will increase by delta.
3483
3484 The function size_window will compute the new height h'
3485 of the window from delta1 as:
3486
3487 e = delta1/n
3488 x = delta1 - delta1/n * n for the 1st resizable child
3489 h' = h + e + x
3490
3491 where n is the number of children that can be resized.
3492 We can ignore x by choosing a delta1 that is a multiple of
3493 n. We want the height of this window to come out as
3494
3495 h' = h + delta
3496
3497 So, delta1 must be
3498
3499 h + e = h + delta
3500 delta1/n = delta
3501 delta1 = n * delta.
3502
3503 The number of children n rquals the number of resizable
3504 children of this window + 1 because we know window itself
3505 is resizable (otherwise we would have signalled an error. */
3506
3507 struct window *w = XWINDOW (window);
3508 Lisp_Object s;
3509 int n = 1;
3510
3511 for (s = w->next; !NILP (s); s = XWINDOW (s)->next)
3512 if (!window_fixed_size_p (XWINDOW (s), widthflag, 0))
3513 ++n;
3514 for (s = w->prev; !NILP (s); s = XWINDOW (s)->prev)
3515 if (!window_fixed_size_p (XWINDOW (s), widthflag, 0))
3516 ++n;
3517
3518 delta1 = n * delta;
3519 }
3520
3521 /* Add delta1 lines or columns to this window, and to the parent,
3522 keeping things consistent while not affecting siblings. */
3523 XSETINT (CURSIZE (parent), opht + delta1);
3524 (*setsizefun) (window, XINT (*sizep) + delta1, 0);
3525
3526 /* Squeeze out delta1 lines or columns from our parent,
3527 shriking this window and siblings proportionately.
3528 This brings parent back to correct size.
3529 Delta1 was calculated so this makes this window the desired size,
3530 taking it all out of the siblings. */
3531 (*setsizefun) (parent, opht, 0);
3532 }
3533
3534 XSETFASTINT (p->last_modified, 0);
3535 XSETFASTINT (p->last_overlay_modified, 0);
3536
3537 /* Adjust glyph matrices. */
3538 adjust_glyphs (XFRAME (WINDOW_FRAME (XWINDOW (window))));
3539 }
3540
3541 #undef CURBEG
3542 #undef CURSIZE
3543
3544
3545 \f
3546 /***********************************************************************
3547 Resizing Mini-Windows
3548 ***********************************************************************/
3549
3550 static void shrink_window_lowest_first P_ ((struct window *, int));
3551
3552 enum save_restore_action
3553 {
3554 CHECK_ORIG_SIZES,
3555 SAVE_ORIG_SIZES,
3556 RESTORE_ORIG_SIZES
3557 };
3558
3559 static int save_restore_orig_size P_ ((struct window *,
3560 enum save_restore_action));
3561
3562 /* Shrink windows rooted in window W to HEIGHT. Take the space needed
3563 from lowest windows first. */
3564
3565 static void
3566 shrink_window_lowest_first (w, height)
3567 struct window *w;
3568 int height;
3569 {
3570 struct window *c;
3571 Lisp_Object child;
3572 int old_height;
3573
3574 xassert (!MINI_WINDOW_P (w));
3575
3576 /* Set redisplay hints. */
3577 XSETFASTINT (w->last_modified, 0);
3578 XSETFASTINT (w->last_overlay_modified, 0);
3579 windows_or_buffers_changed++;
3580 FRAME_WINDOW_SIZES_CHANGED (XFRAME (WINDOW_FRAME (w))) = 1;
3581
3582 old_height = XFASTINT (w->height);
3583 XSETFASTINT (w->height, height);
3584
3585 if (!NILP (w->hchild))
3586 {
3587 for (child = w->hchild; !NILP (child); child = c->next)
3588 {
3589 c = XWINDOW (child);
3590 c->top = w->top;
3591 shrink_window_lowest_first (c, height);
3592 }
3593 }
3594 else if (!NILP (w->vchild))
3595 {
3596 Lisp_Object last_child;
3597 int delta = old_height - height;
3598 int last_top;
3599
3600 last_child = Qnil;
3601
3602 /* Find the last child. We are taking space from lowest windows
3603 first, so we iterate over children from the last child
3604 backwards. */
3605 for (child = w->vchild; !NILP (child); child = XWINDOW (child)->next)
3606 last_child = child;
3607
3608 /* Assign new heights. We leave only MIN_SAFE_WINDOW_HEIGHT. */
3609 for (child = last_child; delta && !NILP (child); child = c->prev)
3610 {
3611 int this_one;
3612
3613 c = XWINDOW (child);
3614 this_one = XFASTINT (c->height) - MIN_SAFE_WINDOW_HEIGHT;
3615
3616 if (this_one > delta)
3617 this_one = delta;
3618
3619 shrink_window_lowest_first (c, XFASTINT (c->height) - this_one);
3620 delta -= this_one;
3621 }
3622
3623 /* Compute new positions. */
3624 last_top = XINT (w->top);
3625 for (child = w->vchild; !NILP (child); child = c->next)
3626 {
3627 c = XWINDOW (child);
3628 c->top = make_number (last_top);
3629 shrink_window_lowest_first (c, XFASTINT (c->height));
3630 last_top += XFASTINT (c->height);
3631 }
3632 }
3633 }
3634
3635
3636 /* Save, restore, or check positions and sizes in the window tree
3637 rooted at W. ACTION says what to do.
3638
3639 If ACTION is CHECK_ORIG_SIZES, check if orig_top and orig_height
3640 members are valid for all windows in the window tree. Value is
3641 non-zero if they are valid.
3642
3643 If ACTION is SAVE_ORIG_SIZES, save members top and height in
3644 orig_top and orig_height for all windows in the tree.
3645
3646 If ACTION is RESTORE_ORIG_SIZES, restore top and height from
3647 values stored in orig_top and orig_height for all windows. */
3648
3649 static int
3650 save_restore_orig_size (w, action)
3651 struct window *w;
3652 enum save_restore_action action;
3653 {
3654 int success_p = 1;
3655
3656 while (w)
3657 {
3658 if (!NILP (w->hchild))
3659 {
3660 if (!save_restore_orig_size (XWINDOW (w->hchild), action))
3661 success_p = 0;
3662 }
3663 else if (!NILP (w->vchild))
3664 {
3665 if (!save_restore_orig_size (XWINDOW (w->vchild), action))
3666 success_p = 0;
3667 }
3668
3669 switch (action)
3670 {
3671 case CHECK_ORIG_SIZES:
3672 if (!INTEGERP (w->orig_top) || !INTEGERP (w->orig_height))
3673 return 0;
3674 break;
3675
3676 case SAVE_ORIG_SIZES:
3677 w->orig_top = w->top;
3678 w->orig_height = w->height;
3679 XSETFASTINT (w->last_modified, 0);
3680 XSETFASTINT (w->last_overlay_modified, 0);
3681 break;
3682
3683 case RESTORE_ORIG_SIZES:
3684 xassert (INTEGERP (w->orig_top) && INTEGERP (w->orig_height));
3685 w->top = w->orig_top;
3686 w->height = w->orig_height;
3687 w->orig_height = w->orig_top = Qnil;
3688 XSETFASTINT (w->last_modified, 0);
3689 XSETFASTINT (w->last_overlay_modified, 0);
3690 break;
3691
3692 default:
3693 abort ();
3694 }
3695
3696 w = NILP (w->next) ? NULL : XWINDOW (w->next);
3697 }
3698
3699 return success_p;
3700 }
3701
3702
3703 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we can
3704 without deleting other windows. */
3705
3706 void
3707 grow_mini_window (w, delta)
3708 struct window *w;
3709 int delta;
3710 {
3711 struct frame *f = XFRAME (w->frame);
3712 struct window *root;
3713
3714 xassert (MINI_WINDOW_P (w));
3715 xassert (delta >= 0);
3716
3717 /* Check values of window_min_width and window_min_height for
3718 validity. */
3719 check_min_window_sizes ();
3720
3721 /* Compute how much we can enlarge the mini-window without deleting
3722 other windows. */
3723 root = XWINDOW (FRAME_ROOT_WINDOW (f));
3724 if (delta)
3725 {
3726 int min_height = window_min_size (root, 0, 0, 0);
3727 if (XFASTINT (root->height) - delta < min_height)
3728 delta = XFASTINT (root->height) - min_height;
3729 }
3730
3731 if (delta)
3732 {
3733 /* Save original window sizes and positions, if not already done. */
3734 if (!save_restore_orig_size (root, CHECK_ORIG_SIZES))
3735 save_restore_orig_size (root, SAVE_ORIG_SIZES);
3736
3737 /* Shrink other windows. */
3738 shrink_window_lowest_first (root, XFASTINT (root->height) - delta);
3739
3740 /* Grow the mini-window. */
3741 w->top = make_number (XFASTINT (root->top) + XFASTINT (root->height));
3742 w->height = make_number (XFASTINT (w->height) + delta);
3743 XSETFASTINT (w->last_modified, 0);
3744 XSETFASTINT (w->last_overlay_modified, 0);
3745
3746 adjust_glyphs (f);
3747 }
3748 }
3749
3750
3751 /* Shrink mini-window W. If there is recorded info about window sizes
3752 before a call to grow_mini_window, restore recorded window sizes.
3753 Otherwise, if the mini-window is higher than 1 line, resize it to 1
3754 line. */
3755
3756 void
3757 shrink_mini_window (w)
3758 struct window *w;
3759 {
3760 struct frame *f = XFRAME (w->frame);
3761 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
3762
3763 if (save_restore_orig_size (root, CHECK_ORIG_SIZES))
3764 {
3765 save_restore_orig_size (root, RESTORE_ORIG_SIZES);
3766 adjust_glyphs (f);
3767 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3768 windows_or_buffers_changed = 1;
3769 }
3770 else if (XFASTINT (w->height) > 1)
3771 {
3772 Lisp_Object window;
3773 XSETWINDOW (window, w);
3774 enlarge_window (window, 1 - XFASTINT (w->height), 0);
3775 }
3776 }
3777
3778
3779 \f
3780 /* Mark window cursors off for all windows in the window tree rooted
3781 at W by setting their phys_cursor_on_p flag to zero. Called from
3782 xterm.c, e.g. when a frame is cleared and thereby all cursors on
3783 the frame are cleared. */
3784
3785 void
3786 mark_window_cursors_off (w)
3787 struct window *w;
3788 {
3789 while (w)
3790 {
3791 if (!NILP (w->hchild))
3792 mark_window_cursors_off (XWINDOW (w->hchild));
3793 else if (!NILP (w->vchild))
3794 mark_window_cursors_off (XWINDOW (w->vchild));
3795 else
3796 w->phys_cursor_on_p = 0;
3797
3798 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3799 }
3800 }
3801
3802
3803 /* Return number of lines of text (not counting mode line) in W. */
3804
3805 int
3806 window_internal_height (w)
3807 struct window *w;
3808 {
3809 int ht = XFASTINT (w->height);
3810
3811 if (MINI_WINDOW_P (w))
3812 return ht;
3813
3814 if (!NILP (w->parent) || !NILP (w->vchild) || !NILP (w->hchild)
3815 || !NILP (w->next) || !NILP (w->prev)
3816 || FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME (w))))
3817 return ht - 1;
3818
3819 return ht;
3820 }
3821
3822
3823 /* Return the number of columns in W.
3824 Don't count columns occupied by scroll bars or the vertical bar
3825 separating W from the sibling to its right. */
3826
3827 int
3828 window_internal_width (w)
3829 struct window *w;
3830 {
3831 struct frame *f = XFRAME (WINDOW_FRAME (w));
3832 int width = XINT (w->width);
3833
3834 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
3835 /* Scroll bars occupy a few columns. */
3836 width -= FRAME_SCROLL_BAR_COLS (f);
3837 else if (!WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
3838 /* The column of `|' characters separating side-by-side windows
3839 occupies one column only. */
3840 width -= 1;
3841
3842 /* On window-systems, areas to the left and right of the window
3843 are used to display bitmaps there. */
3844 if (FRAME_WINDOW_P (f))
3845 width -= FRAME_FLAGS_AREA_COLS (f);
3846
3847 return width;
3848 }
3849
3850 \f
3851 /************************************************************************
3852 Window Scrolling
3853 ***********************************************************************/
3854
3855 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
3856 one screen-full, which is defined as the height of the window minus
3857 next_screen_context_lines. If WHOLE is zero, scroll up N lines
3858 instead. Negative values of N mean scroll down. NOERROR non-zero
3859 means don't signal an error if we try to move over BEGV or ZV,
3860 respectively. */
3861
3862 static void
3863 window_scroll (window, n, whole, noerror)
3864 Lisp_Object window;
3865 int n;
3866 int whole;
3867 int noerror;
3868 {
3869 /* If we must, use the pixel-based version which is much slower than
3870 the line-based one but can handle varying line heights. */
3871 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
3872 window_scroll_pixel_based (window, n, whole, noerror);
3873 else
3874 window_scroll_line_based (window, n, whole, noerror);
3875 }
3876
3877
3878 /* Implementation of window_scroll that works based on pixel line
3879 heights. See the comment of window_scroll for parameter
3880 descriptions. */
3881
3882 static void
3883 window_scroll_pixel_based (window, n, whole, noerror)
3884 Lisp_Object window;
3885 int n;
3886 int whole;
3887 int noerror;
3888 {
3889 struct it it;
3890 struct window *w = XWINDOW (window);
3891 struct text_pos start;
3892 Lisp_Object tem;
3893 int this_scroll_margin;
3894 int preserve_y;
3895 /* True if we fiddled the window vscroll field without really scrolling. */
3896 int vscrolled = 0;
3897
3898 SET_TEXT_POS_FROM_MARKER (start, w->start);
3899
3900 /* If PT is not visible in WINDOW, move back one half of
3901 the screen. */
3902 XSETFASTINT (tem, PT);
3903 tem = Fpos_visible_in_window_p (tem, window, Qnil);
3904 if (NILP (tem))
3905 {
3906 /* Move backward half the height of the window. Performance note:
3907 vmotion used here is about 10% faster, but would give wrong
3908 results for variable height lines. */
3909 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
3910 it.current_y = it.last_visible_y;
3911 move_it_vertically (&it, -it.last_visible_y / 2);
3912
3913 /* The function move_iterator_vertically may move over more than
3914 the specified y-distance. If it->w is small, e.g. a
3915 mini-buffer window, we may end up in front of the window's
3916 display area. This is the case when Start displaying at the
3917 start of the line containing PT in this case. */
3918 if (it.current_y <= 0)
3919 {
3920 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
3921 move_it_vertically (&it, 0);
3922 it.current_y = 0;
3923 }
3924
3925 start = it.current.pos;
3926 }
3927
3928 /* If scroll_preserve_screen_position is non-zero, we try to set
3929 point in the same window line as it is now, so get that line. */
3930 if (!NILP (Vscroll_preserve_screen_position))
3931 {
3932 start_display (&it, w, start);
3933 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
3934 preserve_y = it.current_y;
3935 }
3936 else
3937 preserve_y = -1;
3938
3939 /* Move iterator it from start the specified distance forward or
3940 backward. The result is the new window start. */
3941 start_display (&it, w, start);
3942 if (whole)
3943 {
3944 int screen_full = (it.last_visible_y
3945 - next_screen_context_lines * CANON_Y_UNIT (it.f));
3946 int direction = n < 0 ? -1 : 1;
3947 move_it_vertically (&it, direction * screen_full);
3948 }
3949 else
3950 move_it_by_lines (&it, n, 1);
3951
3952 /* End if we end up at ZV or BEGV. */
3953 if ((n > 0 && IT_CHARPOS (it) == ZV)
3954 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
3955 {
3956 if (IT_CHARPOS (it) == ZV)
3957 {
3958 if (it.current_y + it.max_ascent + it.max_descent
3959 > it.last_visible_y)
3960 /* The last line was only partially visible, make it fully
3961 visible. */
3962 w->vscroll =
3963 it.last_visible_y
3964 - it.current_y + it.max_ascent + it.max_descent;
3965 else if (noerror)
3966 return;
3967 else
3968 Fsignal (Qend_of_buffer, Qnil);
3969 }
3970 else
3971 {
3972 if (w->vscroll != 0)
3973 /* The first line was only partially visible, make it fully
3974 visible. */
3975 w->vscroll = 0;
3976 else if (noerror)
3977 return;
3978 else
3979 Fsignal (Qbeginning_of_buffer, Qnil);
3980 }
3981
3982 /* If control gets here, then we vscrolled. */
3983
3984 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3985
3986 /* Don't try to change the window start below. */
3987 vscrolled = 1;
3988 }
3989
3990 if (! vscrolled)
3991 {
3992 /* Set the window start, and set up the window for redisplay. */
3993 set_marker_restricted (w->start, make_number (IT_CHARPOS (it)),
3994 w->buffer);
3995 w->start_at_line_beg = Fbolp ();
3996 w->update_mode_line = Qt;
3997 XSETFASTINT (w->last_modified, 0);
3998 XSETFASTINT (w->last_overlay_modified, 0);
3999 /* Set force_start so that redisplay_window will run the
4000 window-scroll-functions. */
4001 w->force_start = Qt;
4002 }
4003
4004 it.current_y = it.vpos = 0;
4005
4006 /* Preserve the screen position if we must. */
4007 if (preserve_y >= 0)
4008 {
4009 move_it_to (&it, -1, -1, preserve_y, -1, MOVE_TO_Y);
4010 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4011 }
4012 else
4013 {
4014 /* Move PT out of scroll margins. */
4015 this_scroll_margin = max (0, scroll_margin);
4016 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->height) / 4);
4017 this_scroll_margin *= CANON_Y_UNIT (it.f);
4018
4019 if (n > 0)
4020 {
4021 /* We moved the window start towards ZV, so PT may be now
4022 in the scroll margin at the top. */
4023 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4024 while (it.current_y < this_scroll_margin)
4025 move_it_by_lines (&it, 1, 1);
4026 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4027 }
4028 else if (n < 0)
4029 {
4030 int charpos, bytepos;
4031
4032 /* We moved the window start towards BEGV, so PT may be now
4033 in the scroll margin at the bottom. */
4034 move_it_to (&it, PT, -1,
4035 it.last_visible_y - this_scroll_margin - 1, -1,
4036 MOVE_TO_POS | MOVE_TO_Y);
4037
4038 /* Save our position, in case it's correct. */
4039 charpos = IT_CHARPOS (it);
4040 bytepos = IT_BYTEPOS (it);
4041
4042 /* See if point is on a partially visible line at the end. */
4043 move_it_by_lines (&it, 1, 1);
4044 if (it.current_y > it.last_visible_y)
4045 /* The last line was only partially visible, so back up two
4046 lines to make sure we're on a fully visible line. */
4047 {
4048 move_it_by_lines (&it, -2, 0);
4049 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4050 }
4051 else
4052 /* No, the position we saved is OK, so use it. */
4053 SET_PT_BOTH (charpos, bytepos);
4054 }
4055 }
4056 }
4057
4058
4059 /* Implementation of window_scroll that works based on screen lines.
4060 See the comment of window_scroll for parameter descriptions. */
4061
4062 static void
4063 window_scroll_line_based (window, n, whole, noerror)
4064 Lisp_Object window;
4065 int n;
4066 int whole;
4067 int noerror;
4068 {
4069 register struct window *w = XWINDOW (window);
4070 register int opoint = PT, opoint_byte = PT_BYTE;
4071 register int pos, pos_byte;
4072 register int ht = window_internal_height (w);
4073 register Lisp_Object tem;
4074 int lose;
4075 Lisp_Object bolp;
4076 int startpos;
4077 struct position posit;
4078 int original_vpos;
4079
4080 startpos = marker_position (w->start);
4081
4082 posit = *compute_motion (startpos, 0, 0, 0,
4083 PT, ht, 0,
4084 window_internal_width (w), XINT (w->hscroll),
4085 0, w);
4086 original_vpos = posit.vpos;
4087
4088 XSETFASTINT (tem, PT);
4089 tem = Fpos_visible_in_window_p (tem, window, Qnil);
4090
4091 if (NILP (tem))
4092 {
4093 Fvertical_motion (make_number (- (ht / 2)), window);
4094 startpos = PT;
4095 }
4096
4097 SET_PT (startpos);
4098 lose = n < 0 && PT == BEGV;
4099 Fvertical_motion (make_number (n), window);
4100 pos = PT;
4101 pos_byte = PT_BYTE;
4102 bolp = Fbolp ();
4103 SET_PT_BOTH (opoint, opoint_byte);
4104
4105 if (lose)
4106 {
4107 if (noerror)
4108 return;
4109 else
4110 Fsignal (Qbeginning_of_buffer, Qnil);
4111 }
4112
4113 if (pos < ZV)
4114 {
4115 int this_scroll_margin = scroll_margin;
4116
4117 /* Don't use a scroll margin that is negative or too large. */
4118 if (this_scroll_margin < 0)
4119 this_scroll_margin = 0;
4120
4121 if (XINT (w->height) < 4 * scroll_margin)
4122 this_scroll_margin = XINT (w->height) / 4;
4123
4124 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
4125 w->start_at_line_beg = bolp;
4126 w->update_mode_line = Qt;
4127 XSETFASTINT (w->last_modified, 0);
4128 XSETFASTINT (w->last_overlay_modified, 0);
4129 /* Set force_start so that redisplay_window will run
4130 the window-scroll-functions. */
4131 w->force_start = Qt;
4132
4133 if (whole && !NILP (Vscroll_preserve_screen_position))
4134 {
4135 SET_PT_BOTH (pos, pos_byte);
4136 Fvertical_motion (make_number (original_vpos), window);
4137 }
4138 /* If we scrolled forward, put point enough lines down
4139 that it is outside the scroll margin. */
4140 else if (n > 0)
4141 {
4142 int top_margin;
4143
4144 if (this_scroll_margin > 0)
4145 {
4146 SET_PT_BOTH (pos, pos_byte);
4147 Fvertical_motion (make_number (this_scroll_margin), window);
4148 top_margin = PT;
4149 }
4150 else
4151 top_margin = pos;
4152
4153 if (top_margin <= opoint)
4154 SET_PT_BOTH (opoint, opoint_byte);
4155 else if (!NILP (Vscroll_preserve_screen_position))
4156 {
4157 SET_PT_BOTH (pos, pos_byte);
4158 Fvertical_motion (make_number (original_vpos), window);
4159 }
4160 else
4161 SET_PT (top_margin);
4162 }
4163 else if (n < 0)
4164 {
4165 int bottom_margin;
4166
4167 /* If we scrolled backward, put point near the end of the window
4168 but not within the scroll margin. */
4169 SET_PT_BOTH (pos, pos_byte);
4170 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
4171 if (XFASTINT (tem) == ht - this_scroll_margin)
4172 bottom_margin = PT;
4173 else
4174 bottom_margin = PT + 1;
4175
4176 if (bottom_margin > opoint)
4177 SET_PT_BOTH (opoint, opoint_byte);
4178 else
4179 {
4180 if (!NILP (Vscroll_preserve_screen_position))
4181 {
4182 SET_PT_BOTH (pos, pos_byte);
4183 Fvertical_motion (make_number (original_vpos), window);
4184 }
4185 else
4186 Fvertical_motion (make_number (-1), window);
4187 }
4188 }
4189 }
4190 else
4191 {
4192 if (noerror)
4193 return;
4194 else
4195 Fsignal (Qend_of_buffer, Qnil);
4196 }
4197 }
4198
4199
4200 /* Scroll selected_window up or down. If N is nil, scroll a
4201 screen-full which is defined as the height of the window minus
4202 next_screen_context_lines. If N is the symbol `-', scroll.
4203 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4204 up. This is the guts of Fscroll_up and Fscroll_down. */
4205
4206 static void
4207 scroll_command (n, direction)
4208 Lisp_Object n;
4209 int direction;
4210 {
4211 register int defalt;
4212 int count = specpdl_ptr - specpdl;
4213
4214 xassert (abs (direction) == 1);
4215
4216 /* If selected window's buffer isn't current, make it current for
4217 the moment. But don't screw up if window_scroll gets an error. */
4218 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
4219 {
4220 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4221 Fset_buffer (XWINDOW (selected_window)->buffer);
4222
4223 /* Make redisplay consider other windows than just selected_window. */
4224 ++windows_or_buffers_changed;
4225 }
4226
4227 defalt = (window_internal_height (XWINDOW (selected_window))
4228 - next_screen_context_lines);
4229 defalt = direction * (defalt < 1 ? 1 : defalt);
4230
4231 if (NILP (n))
4232 window_scroll (selected_window, defalt, 1, 0);
4233 else if (EQ (n, Qminus))
4234 window_scroll (selected_window, - defalt, 1, 0);
4235 else
4236 {
4237 n = Fprefix_numeric_value (n);
4238 window_scroll (selected_window, XINT (n) * direction, 0, 0);
4239 }
4240
4241 unbind_to (count, Qnil);
4242 }
4243
4244 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "P",
4245 "Scroll text of current window upward ARG lines; or near full screen if no ARG.\n\
4246 A near full screen is `next-screen-context-lines' less than a full screen.\n\
4247 Negative ARG means scroll downward.\n\
4248 If ARG is the atom `-', scroll downward by nearly full screen.\n\
4249 When calling from a program, supply as argument a number, nil, or `-'.")
4250 (arg)
4251 Lisp_Object arg;
4252 {
4253 scroll_command (arg, 1);
4254 return Qnil;
4255 }
4256
4257 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "P",
4258 "Scroll text of current window down ARG lines; or near full screen if no ARG.\n\
4259 A near full screen is `next-screen-context-lines' less than a full screen.\n\
4260 Negative ARG means scroll upward.\n\
4261 If ARG is the atom `-', scroll upward by nearly full screen.\n\
4262 When calling from a program, supply as argument a number, nil, or `-'.")
4263 (arg)
4264 Lisp_Object arg;
4265 {
4266 scroll_command (arg, -1);
4267 return Qnil;
4268 }
4269 \f
4270 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
4271 "Return the other window for \"other window scroll\" commands.\n\
4272 If in the minibuffer, `minibuffer-scroll-window' if non-nil\n\
4273 specifies the window.\n\
4274 If `other-window-scroll-buffer' is non-nil, a window\n\
4275 showing that buffer is used.")
4276 ()
4277 {
4278 Lisp_Object window;
4279
4280 if (MINI_WINDOW_P (XWINDOW (selected_window))
4281 && !NILP (Vminibuf_scroll_window))
4282 window = Vminibuf_scroll_window;
4283 /* If buffer is specified, scroll that buffer. */
4284 else if (!NILP (Vother_window_scroll_buffer))
4285 {
4286 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
4287 if (NILP (window))
4288 window = Fdisplay_buffer (Vother_window_scroll_buffer, Qt, Qnil);
4289 }
4290 else
4291 {
4292 /* Nothing specified; look for a neighboring window on the same
4293 frame. */
4294 window = Fnext_window (selected_window, Qnil, Qnil);
4295
4296 if (EQ (window, selected_window))
4297 /* That didn't get us anywhere; look for a window on another
4298 visible frame. */
4299 do
4300 window = Fnext_window (window, Qnil, Qt);
4301 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
4302 && ! EQ (window, selected_window));
4303 }
4304
4305 CHECK_LIVE_WINDOW (window, 0);
4306
4307 if (EQ (window, selected_window))
4308 error ("There is no other window");
4309
4310 return window;
4311 }
4312
4313 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
4314 "Scroll next window upward ARG lines; or near full screen if no ARG.\n\
4315 A near full screen is `next-screen-context-lines' less than a full screen.\n\
4316 The next window is the one below the current one; or the one at the top\n\
4317 if the current one is at the bottom. Negative ARG means scroll downward.\n\
4318 If ARG is the atom `-', scroll downward by nearly full screen.\n\
4319 When calling from a program, supply as argument a number, nil, or `-'.\n\
4320 \n\
4321 If in the minibuffer, `minibuffer-scroll-window' if non-nil\n\
4322 specifies the window to scroll.\n\
4323 If `other-window-scroll-buffer' is non-nil, scroll the window\n\
4324 showing that buffer, popping the buffer up if necessary.")
4325 (arg)
4326 register Lisp_Object arg;
4327 {
4328 register Lisp_Object window;
4329 register int defalt;
4330 register struct window *w;
4331 register int count = specpdl_ptr - specpdl;
4332
4333 window = Fother_window_for_scrolling ();
4334
4335 w = XWINDOW (window);
4336 defalt = window_internal_height (w) - next_screen_context_lines;
4337 if (defalt < 1) defalt = 1;
4338
4339 /* Don't screw up if window_scroll gets an error. */
4340 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4341 ++windows_or_buffers_changed;
4342
4343 Fset_buffer (w->buffer);
4344 SET_PT (marker_position (w->pointm));
4345
4346 if (NILP (arg))
4347 window_scroll (window, defalt, 1, 1);
4348 else if (EQ (arg, Qminus))
4349 window_scroll (window, -defalt, 1, 1);
4350 else
4351 {
4352 if (CONSP (arg))
4353 arg = Fcar (arg);
4354 CHECK_NUMBER (arg, 0);
4355 window_scroll (window, XINT (arg), 0, 1);
4356 }
4357
4358 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
4359 unbind_to (count, Qnil);
4360
4361 return Qnil;
4362 }
4363 \f
4364 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 1, "P",
4365 "Scroll selected window display ARG columns left.\n\
4366 Default for ARG is window width minus 2.")
4367 (arg)
4368 register Lisp_Object arg;
4369 {
4370
4371 if (NILP (arg))
4372 XSETFASTINT (arg, window_internal_width (XWINDOW (selected_window)) - 2);
4373 else
4374 arg = Fprefix_numeric_value (arg);
4375
4376 return
4377 Fset_window_hscroll (selected_window,
4378 make_number (XINT (XWINDOW (selected_window)->hscroll)
4379 + XINT (arg)));
4380 }
4381
4382 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 1, "P",
4383 "Scroll selected window display ARG columns right.\n\
4384 Default for ARG is window width minus 2.")
4385 (arg)
4386 register Lisp_Object arg;
4387 {
4388 if (NILP (arg))
4389 XSETFASTINT (arg, window_internal_width (XWINDOW (selected_window)) - 2);
4390 else
4391 arg = Fprefix_numeric_value (arg);
4392
4393 return
4394 Fset_window_hscroll (selected_window,
4395 make_number (XINT (XWINDOW (selected_window)->hscroll)
4396 - XINT (arg)));
4397 }
4398
4399 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
4400 "Center point in window and redisplay frame. With ARG, put point on line ARG.\n\
4401 The desired position of point is always relative to the current window.\n\
4402 Just C-u as prefix means put point in the center of the window.\n\
4403 If ARG is omitted or nil, erases the entire frame and then\n\
4404 redraws with point in the center of the current window.")
4405 (arg)
4406 register Lisp_Object arg;
4407 {
4408 register struct window *w = XWINDOW (selected_window);
4409 register int ht = window_internal_height (w);
4410 struct position pos;
4411 struct buffer *buf = XBUFFER (w->buffer);
4412 struct buffer *obuf = current_buffer;
4413
4414 if (NILP (arg))
4415 {
4416 extern int frame_garbaged;
4417 int i;
4418
4419 /* Invalidate pixel data calculated for all compositions. */
4420 for (i = 0; i < n_compositions; i++)
4421 composition_table[i]->font = NULL;
4422
4423 Fredraw_frame (w->frame);
4424 SET_FRAME_GARBAGED (XFRAME (WINDOW_FRAME (w)));
4425 XSETFASTINT (arg, ht / 2);
4426 }
4427 else if (CONSP (arg)) /* Just C-u. */
4428 {
4429 XSETFASTINT (arg, ht / 2);
4430 }
4431 else
4432 {
4433 arg = Fprefix_numeric_value (arg);
4434 CHECK_NUMBER (arg, 0);
4435 }
4436
4437 if (XINT (arg) < 0)
4438 XSETINT (arg, XINT (arg) + ht);
4439
4440 set_buffer_internal (buf);
4441 pos = *vmotion (PT, - XINT (arg), w);
4442
4443 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
4444 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
4445 || FETCH_BYTE (pos.bytepos - 1) == '\n')
4446 ? Qt : Qnil);
4447 w->force_start = Qt;
4448 set_buffer_internal (obuf);
4449
4450 return Qnil;
4451 }
4452
4453
4454 /* Value is the number of lines actually displayed in window W,
4455 as opposed to its height. */
4456
4457 static int
4458 displayed_window_lines (w)
4459 struct window *w;
4460 {
4461 struct it it;
4462 struct text_pos start;
4463 int height = window_box_height (w);
4464 struct buffer *old_buffer;
4465 int bottom_y;
4466
4467 if (XBUFFER (w->buffer) != current_buffer)
4468 {
4469 old_buffer = current_buffer;
4470 set_buffer_internal (XBUFFER (w->buffer));
4471 }
4472 else
4473 old_buffer = NULL;
4474
4475 SET_TEXT_POS_FROM_MARKER (start, w->start);
4476 start_display (&it, w, start);
4477 move_it_vertically (&it, height);
4478
4479 if (old_buffer)
4480 set_buffer_internal (old_buffer);
4481
4482 bottom_y = it.current_y + it.max_ascent + it.max_descent;
4483
4484 if (bottom_y > it.current_y && bottom_y <= it.last_visible_y)
4485 /* Hit a line without a terminating newline. */
4486 it.vpos++;
4487
4488 /* Add in empty lines at the bottom of the window. */
4489 if (bottom_y < height)
4490 {
4491 struct frame *f = XFRAME (w->frame);
4492 int rest = height - bottom_y;
4493 int lines = rest / CANON_Y_UNIT (f);
4494 it.vpos += lines;
4495 }
4496
4497 return it.vpos;
4498 }
4499
4500
4501 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
4502 0, 1, 0,
4503 "Return the height in lines of the text display area of WINDOW.\n\
4504 This doesn't include the mode-line (or header-line if any) or any\n\
4505 partial-height lines in the text display area.")
4506 (window)
4507 Lisp_Object window;
4508 {
4509 struct window *w = decode_window (window);
4510 int pixel_height = window_box_height (w);
4511 int line_height = pixel_height / CANON_Y_UNIT (XFRAME (w->frame));
4512 return make_number (line_height);
4513 }
4514
4515
4516 \f
4517 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
4518 1, 1, "P",
4519 "Position point relative to window.\n\
4520 With no argument, position point at center of window.\n\
4521 An argument specifies vertical position within the window;\n\
4522 zero means top of window, negative means relative to bottom of window.")
4523 (arg)
4524 Lisp_Object arg;
4525 {
4526 struct window *w = XWINDOW (selected_window);
4527 int lines, start;
4528 Lisp_Object window;
4529
4530 window = selected_window;
4531 start = marker_position (w->start);
4532 if (start < BEGV || start > ZV)
4533 {
4534 int height = window_internal_height (w);
4535 Fvertical_motion (make_number (- (height / 2)), window);
4536 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
4537 w->start_at_line_beg = Fbolp ();
4538 w->force_start = Qt;
4539 }
4540 else
4541 Fgoto_char (w->start);
4542
4543 lines = displayed_window_lines (w);
4544 if (NILP (arg))
4545 XSETFASTINT (arg, lines / 2);
4546 else
4547 {
4548 arg = Fprefix_numeric_value (arg);
4549 if (XINT (arg) < 0)
4550 XSETINT (arg, XINT (arg) + lines);
4551 }
4552
4553 if (w->vscroll)
4554 /* Skip past a partially visible first line. */
4555 XSETINT (arg, XINT (arg) + 1);
4556
4557 return Fvertical_motion (arg, window);
4558 }
4559
4560
4561 \f
4562 /***********************************************************************
4563 Window Configuration
4564 ***********************************************************************/
4565
4566 struct save_window_data
4567 {
4568 EMACS_INT size_from_Lisp_Vector_struct;
4569 struct Lisp_Vector *next_from_Lisp_Vector_struct;
4570 Lisp_Object frame_width, frame_height, frame_menu_bar_lines;
4571 Lisp_Object frame_tool_bar_lines;
4572 Lisp_Object selected_frame;
4573 Lisp_Object current_window;
4574 Lisp_Object current_buffer;
4575 Lisp_Object minibuf_scroll_window;
4576 Lisp_Object root_window;
4577 Lisp_Object focus_frame;
4578 /* Record the values of window-min-width and window-min-height
4579 so that window sizes remain consistent with them. */
4580 Lisp_Object min_width, min_height;
4581 /* A vector, each of whose elements is a struct saved_window
4582 for one window. */
4583 Lisp_Object saved_windows;
4584 };
4585
4586 /* This is saved as a Lisp_Vector */
4587 struct saved_window
4588 {
4589 /* these first two must agree with struct Lisp_Vector in lisp.h */
4590 EMACS_INT size_from_Lisp_Vector_struct;
4591 struct Lisp_Vector *next_from_Lisp_Vector_struct;
4592
4593 Lisp_Object window;
4594 Lisp_Object buffer, start, pointm, mark;
4595 Lisp_Object left, top, width, height, hscroll;
4596 Lisp_Object parent, prev;
4597 Lisp_Object start_at_line_beg;
4598 Lisp_Object display_table;
4599 Lisp_Object orig_top, orig_height;
4600 };
4601 #define SAVED_WINDOW_VECTOR_SIZE 16 /* Arg to Fmake_vector */
4602
4603 #define SAVED_WINDOW_N(swv,n) \
4604 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
4605
4606 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
4607 "Return t if OBJECT is a window-configuration object.")
4608 (object)
4609 Lisp_Object object;
4610 {
4611 if (WINDOW_CONFIGURATIONP (object))
4612 return Qt;
4613 return Qnil;
4614 }
4615
4616 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
4617 "Return the frame that CONFIG, a window-configuration object, is about.")
4618 (config)
4619 Lisp_Object config;
4620 {
4621 register struct save_window_data *data;
4622 struct Lisp_Vector *saved_windows;
4623
4624 if (! WINDOW_CONFIGURATIONP (config))
4625 wrong_type_argument (Qwindow_configuration_p, config);
4626
4627 data = (struct save_window_data *) XVECTOR (config);
4628 saved_windows = XVECTOR (data->saved_windows);
4629 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
4630 }
4631
4632 DEFUN ("set-window-configuration", Fset_window_configuration,
4633 Sset_window_configuration, 1, 1, 0,
4634 "Set the configuration of windows and buffers as specified by CONFIGURATION.\n\
4635 CONFIGURATION must be a value previously returned\n\
4636 by `current-window-configuration' (which see).\n\
4637 If CONFIGURATION was made from a frame that is now deleted,\n\
4638 only frame-independent values can be restored. In this case,\n\
4639 the return value is nil. Otherwise the value is t.")
4640 (configuration)
4641 Lisp_Object configuration;
4642 {
4643 register struct save_window_data *data;
4644 struct Lisp_Vector *saved_windows;
4645 Lisp_Object new_current_buffer;
4646 Lisp_Object frame;
4647 FRAME_PTR f;
4648 int old_point = -1;
4649
4650 while (!WINDOW_CONFIGURATIONP (configuration))
4651 wrong_type_argument (Qwindow_configuration_p, configuration);
4652
4653 data = (struct save_window_data *) XVECTOR (configuration);
4654 saved_windows = XVECTOR (data->saved_windows);
4655
4656 new_current_buffer = data->current_buffer;
4657 if (NILP (XBUFFER (new_current_buffer)->name))
4658 new_current_buffer = Qnil;
4659 else
4660 {
4661 if (XBUFFER (new_current_buffer) == current_buffer)
4662 old_point = PT;
4663 }
4664
4665 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
4666 f = XFRAME (frame);
4667
4668 /* If f is a dead frame, don't bother rebuilding its window tree.
4669 However, there is other stuff we should still try to do below. */
4670 if (FRAME_LIVE_P (f))
4671 {
4672 register struct window *w;
4673 register struct saved_window *p;
4674 struct window *root_window;
4675 struct window **leaf_windows;
4676 int n_leaf_windows;
4677 int k, i, n;
4678
4679 /* If the frame has been resized since this window configuration was
4680 made, we change the frame to the size specified in the
4681 configuration, restore the configuration, and then resize it
4682 back. We keep track of the prevailing height in these variables. */
4683 int previous_frame_height = FRAME_HEIGHT (f);
4684 int previous_frame_width = FRAME_WIDTH (f);
4685 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
4686 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
4687
4688 /* The mouse highlighting code could get screwed up
4689 if it runs during this. */
4690 BLOCK_INPUT;
4691
4692 if (XFASTINT (data->frame_height) != previous_frame_height
4693 || XFASTINT (data->frame_width) != previous_frame_width)
4694 change_frame_size (f, XFASTINT (data->frame_height),
4695 XFASTINT (data->frame_width), 0, 0, 0);
4696 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
4697 if (XFASTINT (data->frame_menu_bar_lines)
4698 != previous_frame_menu_bar_lines)
4699 x_set_menu_bar_lines (f, data->frame_menu_bar_lines, make_number (0));
4700 #ifdef HAVE_WINDOW_SYSTEM
4701 if (XFASTINT (data->frame_tool_bar_lines)
4702 != previous_frame_tool_bar_lines)
4703 x_set_tool_bar_lines (f, data->frame_tool_bar_lines, make_number (0));
4704 #endif
4705 #endif
4706
4707 /* "Swap out" point from the selected window
4708 into its buffer. We do this now, before
4709 restoring the window contents, and prevent it from
4710 being done later on when we select a new window. */
4711 if (! NILP (XWINDOW (selected_window)->buffer))
4712 {
4713 w = XWINDOW (selected_window);
4714 set_marker_both (w->pointm,
4715 w->buffer,
4716 BUF_PT (XBUFFER (w->buffer)),
4717 BUF_PT_BYTE (XBUFFER (w->buffer)));
4718 }
4719
4720 windows_or_buffers_changed++;
4721 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4722
4723 /* Problem: Freeing all matrices and later allocating them again
4724 is a serious redisplay flickering problem. What we would
4725 really like to do is to free only those matrices not reused
4726 below. */
4727 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
4728 leaf_windows
4729 = (struct window **) alloca (count_windows (root_window)
4730 * sizeof (struct window *));
4731 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
4732
4733 /* Temporarily avoid any problems with windows that are smaller
4734 than they are supposed to be. */
4735 window_min_height = 1;
4736 window_min_width = 1;
4737
4738 /* Kludge Alert!
4739 Mark all windows now on frame as "deleted".
4740 Restoring the new configuration "undeletes" any that are in it.
4741
4742 Save their current buffers in their height fields, since we may
4743 need it later, if a buffer saved in the configuration is now
4744 dead. */
4745 delete_all_subwindows (XWINDOW (FRAME_ROOT_WINDOW (f)));
4746
4747 for (k = 0; k < saved_windows->size; k++)
4748 {
4749 p = SAVED_WINDOW_N (saved_windows, k);
4750 w = XWINDOW (p->window);
4751 w->next = Qnil;
4752
4753 if (!NILP (p->parent))
4754 w->parent = SAVED_WINDOW_N (saved_windows,
4755 XFASTINT (p->parent))->window;
4756 else
4757 w->parent = Qnil;
4758
4759 if (!NILP (p->prev))
4760 {
4761 w->prev = SAVED_WINDOW_N (saved_windows,
4762 XFASTINT (p->prev))->window;
4763 XWINDOW (w->prev)->next = p->window;
4764 }
4765 else
4766 {
4767 w->prev = Qnil;
4768 if (!NILP (w->parent))
4769 {
4770 if (EQ (p->width, XWINDOW (w->parent)->width))
4771 {
4772 XWINDOW (w->parent)->vchild = p->window;
4773 XWINDOW (w->parent)->hchild = Qnil;
4774 }
4775 else
4776 {
4777 XWINDOW (w->parent)->hchild = p->window;
4778 XWINDOW (w->parent)->vchild = Qnil;
4779 }
4780 }
4781 }
4782
4783 /* If we squirreled away the buffer in the window's height,
4784 restore it now. */
4785 if (BUFFERP (w->height))
4786 w->buffer = w->height;
4787 w->left = p->left;
4788 w->top = p->top;
4789 w->width = p->width;
4790 w->height = p->height;
4791 w->hscroll = p->hscroll;
4792 w->display_table = p->display_table;
4793 w->orig_top = p->orig_top;
4794 w->orig_height = p->orig_height;
4795 XSETFASTINT (w->last_modified, 0);
4796 XSETFASTINT (w->last_overlay_modified, 0);
4797
4798 /* Reinstall the saved buffer and pointers into it. */
4799 if (NILP (p->buffer))
4800 w->buffer = p->buffer;
4801 else
4802 {
4803 if (!NILP (XBUFFER (p->buffer)->name))
4804 /* If saved buffer is alive, install it. */
4805 {
4806 w->buffer = p->buffer;
4807 w->start_at_line_beg = p->start_at_line_beg;
4808 set_marker_restricted (w->start, p->start, w->buffer);
4809 set_marker_restricted (w->pointm, p->pointm, w->buffer);
4810 Fset_marker (XBUFFER (w->buffer)->mark,
4811 p->mark, w->buffer);
4812
4813 /* As documented in Fcurrent_window_configuration, don't
4814 save the location of point in the buffer which was current
4815 when the window configuration was recorded. */
4816 if (!EQ (p->buffer, new_current_buffer)
4817 && XBUFFER (p->buffer) == current_buffer)
4818 Fgoto_char (w->pointm);
4819 }
4820 else if (NILP (w->buffer) || NILP (XBUFFER (w->buffer)->name))
4821 /* Else unless window has a live buffer, get one. */
4822 {
4823 w->buffer = Fcdr (Fcar (Vbuffer_alist));
4824 /* This will set the markers to beginning of visible
4825 range. */
4826 set_marker_restricted (w->start, make_number (0), w->buffer);
4827 set_marker_restricted (w->pointm, make_number (0),w->buffer);
4828 w->start_at_line_beg = Qt;
4829 }
4830 else
4831 /* Keeping window's old buffer; make sure the markers
4832 are real. */
4833 {
4834 /* Set window markers at start of visible range. */
4835 if (XMARKER (w->start)->buffer == 0)
4836 set_marker_restricted (w->start, make_number (0),
4837 w->buffer);
4838 if (XMARKER (w->pointm)->buffer == 0)
4839 set_marker_restricted_both (w->pointm, w->buffer,
4840 BUF_PT (XBUFFER (w->buffer)),
4841 BUF_PT_BYTE (XBUFFER (w->buffer)));
4842 w->start_at_line_beg = Qt;
4843 }
4844 }
4845 }
4846
4847 FRAME_ROOT_WINDOW (f) = data->root_window;
4848 /* Prevent "swapping out point" in the old selected window
4849 using the buffer that has been restored into it.
4850 That swapping out has already been done,
4851 near the beginning of this function. */
4852 selected_window = Qnil;
4853 Fselect_window (data->current_window);
4854 XBUFFER (XWINDOW (selected_window)->buffer)->last_selected_window
4855 = selected_window;
4856
4857 if (NILP (data->focus_frame)
4858 || (FRAMEP (data->focus_frame)
4859 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
4860 Fredirect_frame_focus (frame, data->focus_frame);
4861
4862 #if 0 /* I don't understand why this is needed, and it causes problems
4863 when the frame's old selected window has been deleted. */
4864 if (f != selected_frame && FRAME_WINDOW_P (f))
4865 do_switch_frame (WINDOW_FRAME (XWINDOW (data->root_window)),
4866 Qnil, 0);
4867 #endif
4868
4869 /* Set the screen height to the value it had before this function. */
4870 if (previous_frame_height != FRAME_HEIGHT (f)
4871 || previous_frame_width != FRAME_WIDTH (f))
4872 change_frame_size (f, previous_frame_height, previous_frame_width,
4873 0, 0, 0);
4874 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
4875 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
4876 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
4877 make_number (0));
4878 #ifdef HAVE_WINDOW_SYSTEM
4879 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
4880 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
4881 make_number (0));
4882 #endif
4883 #endif
4884
4885 /* Now, free glyph matrices in windows that were not reused. */
4886 for (i = n = 0; i < n_leaf_windows; ++i)
4887 {
4888 if (NILP (leaf_windows[i]->buffer))
4889 {
4890 /* Assert it's not reused as a combination. */
4891 xassert (NILP (leaf_windows[i]->hchild)
4892 && NILP (leaf_windows[i]->vchild));
4893 free_window_matrices (leaf_windows[i]);
4894 SET_FRAME_GARBAGED (f);
4895 }
4896 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
4897 ++n;
4898 }
4899
4900 /* If more than one window shows the new and old current buffer,
4901 don't try to preserve point in that buffer. */
4902 if (old_point > 0 && n > 1)
4903 old_point = -1;
4904
4905 adjust_glyphs (f);
4906
4907 UNBLOCK_INPUT;
4908
4909 /* Fselect_window will have made f the selected frame, so we
4910 reselect the proper frame here. Fhandle_switch_frame will change the
4911 selected window too, but that doesn't make the call to
4912 Fselect_window above totally superfluous; it still sets f's
4913 selected window. */
4914 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
4915 do_switch_frame (data->selected_frame, Qnil, 0);
4916
4917 if (! NILP (Vwindow_configuration_change_hook)
4918 && ! NILP (Vrun_hooks))
4919 call1 (Vrun_hooks, Qwindow_configuration_change_hook);
4920 }
4921
4922 if (!NILP (new_current_buffer))
4923 {
4924 Fset_buffer (new_current_buffer);
4925
4926 /* If the buffer that is current now is the same
4927 that was current before setting the window configuration,
4928 don't alter its PT. */
4929 if (old_point >= 0)
4930 SET_PT (old_point);
4931 }
4932
4933 /* Restore the minimum heights recorded in the configuration. */
4934 window_min_height = XINT (data->min_height);
4935 window_min_width = XINT (data->min_width);
4936
4937 Vminibuf_scroll_window = data->minibuf_scroll_window;
4938
4939 return (FRAME_LIVE_P (f) ? Qt : Qnil);
4940 }
4941
4942 /* Mark all windows now on frame as deleted
4943 by setting their buffers to nil. */
4944
4945 void
4946 delete_all_subwindows (w)
4947 register struct window *w;
4948 {
4949 if (!NILP (w->next))
4950 delete_all_subwindows (XWINDOW (w->next));
4951 if (!NILP (w->vchild))
4952 delete_all_subwindows (XWINDOW (w->vchild));
4953 if (!NILP (w->hchild))
4954 delete_all_subwindows (XWINDOW (w->hchild));
4955
4956 w->height = w->buffer; /* See Fset_window_configuration for excuse. */
4957
4958 if (!NILP (w->buffer))
4959 unshow_buffer (w);
4960
4961 /* We set all three of these fields to nil, to make sure that we can
4962 distinguish this dead window from any live window. Live leaf
4963 windows will have buffer set, and combination windows will have
4964 vchild or hchild set. */
4965 w->buffer = Qnil;
4966 w->vchild = Qnil;
4967 w->hchild = Qnil;
4968
4969 Vwindow_list = Qnil;
4970 }
4971 \f
4972 static int
4973 count_windows (window)
4974 register struct window *window;
4975 {
4976 register int count = 1;
4977 if (!NILP (window->next))
4978 count += count_windows (XWINDOW (window->next));
4979 if (!NILP (window->vchild))
4980 count += count_windows (XWINDOW (window->vchild));
4981 if (!NILP (window->hchild))
4982 count += count_windows (XWINDOW (window->hchild));
4983 return count;
4984 }
4985
4986
4987 /* Fill vector FLAT with leaf windows under W, starting at index I.
4988 Value is last index + 1. */
4989
4990 static int
4991 get_leaf_windows (w, flat, i)
4992 struct window *w;
4993 struct window **flat;
4994 int i;
4995 {
4996 while (w)
4997 {
4998 if (!NILP (w->hchild))
4999 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
5000 else if (!NILP (w->vchild))
5001 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
5002 else
5003 flat[i++] = w;
5004
5005 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5006 }
5007
5008 return i;
5009 }
5010
5011
5012 /* Return a pointer to the glyph W's physical cursor is on. Value is
5013 null if W's current matrix is invalid, so that no meaningfull glyph
5014 can be returned. */
5015
5016 struct glyph *
5017 get_phys_cursor_glyph (w)
5018 struct window *w;
5019 {
5020 struct glyph_row *row;
5021 struct glyph *glyph;
5022
5023 if (w->phys_cursor.vpos >= 0
5024 && w->phys_cursor.vpos < w->current_matrix->nrows
5025 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
5026 row->enabled_p)
5027 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
5028 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
5029 else
5030 glyph = NULL;
5031
5032 return glyph;
5033 }
5034
5035
5036 static int
5037 save_window_save (window, vector, i)
5038 Lisp_Object window;
5039 struct Lisp_Vector *vector;
5040 int i;
5041 {
5042 register struct saved_window *p;
5043 register struct window *w;
5044 register Lisp_Object tem;
5045
5046 for (;!NILP (window); window = w->next)
5047 {
5048 p = SAVED_WINDOW_N (vector, i);
5049 w = XWINDOW (window);
5050
5051 XSETFASTINT (w->temslot, i++);
5052 p->window = window;
5053 p->buffer = w->buffer;
5054 p->left = w->left;
5055 p->top = w->top;
5056 p->width = w->width;
5057 p->height = w->height;
5058 p->hscroll = w->hscroll;
5059 p->display_table = w->display_table;
5060 p->orig_top = w->orig_top;
5061 p->orig_height = w->orig_height;
5062 if (!NILP (w->buffer))
5063 {
5064 /* Save w's value of point in the window configuration.
5065 If w is the selected window, then get the value of point
5066 from the buffer; pointm is garbage in the selected window. */
5067 if (EQ (window, selected_window))
5068 {
5069 p->pointm = Fmake_marker ();
5070 set_marker_both (p->pointm, w->buffer,
5071 BUF_PT (XBUFFER (w->buffer)),
5072 BUF_PT_BYTE (XBUFFER (w->buffer)));
5073 }
5074 else
5075 p->pointm = Fcopy_marker (w->pointm, Qnil);
5076
5077 p->start = Fcopy_marker (w->start, Qnil);
5078 p->start_at_line_beg = w->start_at_line_beg;
5079
5080 tem = XBUFFER (w->buffer)->mark;
5081 p->mark = Fcopy_marker (tem, Qnil);
5082 }
5083 else
5084 {
5085 p->pointm = Qnil;
5086 p->start = Qnil;
5087 p->mark = Qnil;
5088 p->start_at_line_beg = Qnil;
5089 }
5090
5091 if (NILP (w->parent))
5092 p->parent = Qnil;
5093 else
5094 p->parent = XWINDOW (w->parent)->temslot;
5095
5096 if (NILP (w->prev))
5097 p->prev = Qnil;
5098 else
5099 p->prev = XWINDOW (w->prev)->temslot;
5100
5101 if (!NILP (w->vchild))
5102 i = save_window_save (w->vchild, vector, i);
5103 if (!NILP (w->hchild))
5104 i = save_window_save (w->hchild, vector, i);
5105 }
5106
5107 return i;
5108 }
5109
5110 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
5111 Scurrent_window_configuration, 0, 1, 0,
5112 "Return an object representing the current window configuration of FRAME.\n\
5113 If FRAME is nil or omitted, use the selected frame.\n\
5114 This describes the number of windows, their sizes and current buffers,\n\
5115 and for each displayed buffer, where display starts, and the positions of\n\
5116 point and mark. An exception is made for point in the current buffer:\n\
5117 its value is -not- saved.\n\
5118 This also records the currently selected frame, and FRAME's focus\n\
5119 redirection (see `redirect-frame-focus').")
5120 (frame)
5121 Lisp_Object frame;
5122 {
5123 register Lisp_Object tem;
5124 register int n_windows;
5125 register struct save_window_data *data;
5126 register struct Lisp_Vector *vec;
5127 register int i;
5128 FRAME_PTR f;
5129
5130 if (NILP (frame))
5131 frame = selected_frame;
5132 CHECK_LIVE_FRAME (frame, 0);
5133 f = XFRAME (frame);
5134
5135 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
5136 vec = allocate_vectorlike (VECSIZE (struct save_window_data));
5137 for (i = 0; i < VECSIZE (struct save_window_data); i++)
5138 vec->contents[i] = Qnil;
5139 vec->size = VECSIZE (struct save_window_data);
5140 data = (struct save_window_data *)vec;
5141
5142 XSETFASTINT (data->frame_width, FRAME_WIDTH (f));
5143 XSETFASTINT (data->frame_height, FRAME_HEIGHT (f));
5144 XSETFASTINT (data->frame_menu_bar_lines, FRAME_MENU_BAR_LINES (f));
5145 XSETFASTINT (data->frame_tool_bar_lines, FRAME_TOOL_BAR_LINES (f));
5146 data->selected_frame = selected_frame;
5147 data->current_window = FRAME_SELECTED_WINDOW (f);
5148 XSETBUFFER (data->current_buffer, current_buffer);
5149 data->minibuf_scroll_window = Vminibuf_scroll_window;
5150 data->root_window = FRAME_ROOT_WINDOW (f);
5151 data->focus_frame = FRAME_FOCUS_FRAME (f);
5152 XSETINT (data->min_height, window_min_height);
5153 XSETINT (data->min_width, window_min_width);
5154 tem = Fmake_vector (make_number (n_windows), Qnil);
5155 data->saved_windows = tem;
5156 for (i = 0; i < n_windows; i++)
5157 XVECTOR (tem)->contents[i]
5158 = Fmake_vector (make_number (SAVED_WINDOW_VECTOR_SIZE), Qnil);
5159 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
5160 XSETWINDOW_CONFIGURATION (tem, data);
5161 return (tem);
5162 }
5163
5164 DEFUN ("save-window-excursion", Fsave_window_excursion, Ssave_window_excursion,
5165 0, UNEVALLED, 0,
5166 "Execute body, preserving window sizes and contents.\n\
5167 Restore which buffer appears in which window, where display starts,\n\
5168 and the value of point and mark for each window.\n\
5169 Also restore the choice of selected window.\n\
5170 Also restore which buffer is current.\n\
5171 Does not restore the value of point in current buffer.")
5172 (args)
5173 Lisp_Object args;
5174 {
5175 register Lisp_Object val;
5176 register int count = specpdl_ptr - specpdl;
5177
5178 record_unwind_protect (Fset_window_configuration,
5179 Fcurrent_window_configuration (Qnil));
5180 val = Fprogn (args);
5181 return unbind_to (count, val);
5182 }
5183
5184 \f
5185 /***********************************************************************
5186 Marginal Areas
5187 ***********************************************************************/
5188
5189 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
5190 2, 3, 0,
5191 "Set width of marginal areas of window WINDOW.\n\
5192 If window is nil, set margins of the currently selected window.\n\
5193 First parameter LEFT-WIDTH specifies the number of character\n\
5194 cells to reserve for the left marginal area. Second parameter\n\
5195 RIGHT-WIDTH does the same for the right marginal area.\n\
5196 A nil width parameter means no margin.")
5197 (window, left, right)
5198 Lisp_Object window, left, right;
5199 {
5200 struct window *w = decode_window (window);
5201
5202 if (!NILP (left))
5203 CHECK_NUMBER_OR_FLOAT (left, 1);
5204 if (!NILP (right))
5205 CHECK_NUMBER_OR_FLOAT (right, 2);
5206
5207 /* Check widths < 0 and translate a zero width to nil.
5208 Margins that are too wide have to be checked elsewhere. */
5209 if ((INTEGERP (left) && XINT (left) < 0)
5210 || (FLOATP (left) && XFLOAT_DATA (left) <= 0))
5211 XSETFASTINT (left, 0);
5212 if (INTEGERP (left) && XFASTINT (left) == 0)
5213 left = Qnil;
5214
5215 if ((INTEGERP (right) && XINT (right) < 0)
5216 || (FLOATP (right) && XFLOAT_DATA (right) <= 0))
5217 XSETFASTINT (right, 0);
5218 if (INTEGERP (right) && XFASTINT (right) == 0)
5219 right = Qnil;
5220
5221 w->left_margin_width = left;
5222 w->right_margin_width = right;
5223
5224 ++windows_or_buffers_changed;
5225 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
5226 return Qnil;
5227 }
5228
5229
5230 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
5231 0, 1, 0,
5232 "Get width of marginal areas of window WINDOW.\n\
5233 If WINDOW is omitted or nil, use the currently selected window.\n\
5234 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).\n\
5235 If a marginal area does not exist, its width will be returned\n\
5236 as nil.")
5237 (window)
5238 Lisp_Object window;
5239 {
5240 struct window *w = decode_window (window);
5241 return Fcons (w->left_margin_width, w->right_margin_width);
5242 }
5243
5244
5245 \f
5246 /***********************************************************************
5247 Smooth scrolling
5248 ***********************************************************************/
5249
5250 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 1, 0,
5251 "Return the amount by which WINDOW is scrolled vertically.\n\
5252 Use the selected window if WINDOW is nil or omitted.\n\
5253 Value is a multiple of the canonical character height of WINDOW.")
5254 (window)
5255 Lisp_Object window;
5256 {
5257 Lisp_Object result;
5258 struct frame *f;
5259 struct window *w;
5260
5261 if (NILP (window))
5262 window = selected_window;
5263 else
5264 CHECK_WINDOW (window, 0);
5265 w = XWINDOW (window);
5266 f = XFRAME (w->frame);
5267
5268 if (FRAME_WINDOW_P (f))
5269 result = CANON_Y_FROM_PIXEL_Y (f, -w->vscroll);
5270 else
5271 result = make_number (0);
5272 return result;
5273 }
5274
5275
5276 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
5277 2, 2, 0,
5278 "Set amount by which WINDOW should be scrolled vertically to VSCROLL.\n\
5279 WINDOW nil or omitted means use the selected window. VSCROLL is a\n\
5280 non-negative multiple of the canonical character height of WINDOW.")
5281 (window, vscroll)
5282 Lisp_Object window, vscroll;
5283 {
5284 struct window *w;
5285 struct frame *f;
5286
5287 if (NILP (window))
5288 window = selected_window;
5289 else
5290 CHECK_WINDOW (window, 0);
5291 CHECK_NUMBER_OR_FLOAT (vscroll, 1);
5292
5293 w = XWINDOW (window);
5294 f = XFRAME (w->frame);
5295
5296 if (FRAME_WINDOW_P (f))
5297 {
5298 int old_dy = w->vscroll;
5299
5300 w->vscroll = - CANON_Y_UNIT (f) * XFLOATINT (vscroll);
5301 w->vscroll = min (w->vscroll, 0);
5302
5303 /* Adjust glyph matrix of the frame if the virtual display
5304 area becomes larger than before. */
5305 if (w->vscroll < 0 && w->vscroll < old_dy)
5306 adjust_glyphs (f);
5307
5308 /* Prevent redisplay shortcuts. */
5309 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
5310 }
5311
5312 return Fwindow_vscroll (window);
5313 }
5314
5315 \f
5316 /* Call FN for all leaf windows on frame F. FN is called with the
5317 first argument being a pointer to the leaf window, and with
5318 additional argument USER_DATA. Stops when FN returns 0. */
5319
5320 void
5321 foreach_window (f, fn, user_data)
5322 struct frame *f;
5323 int (* fn) P_ ((struct window *, void *));
5324 void *user_data;
5325 {
5326 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
5327 }
5328
5329
5330 /* Helper function for foreach_window. Call FN for all leaf windows
5331 reachable from W. FN is called with the first argument being a
5332 pointer to the leaf window, and with additional argument USER_DATA.
5333 Stop when FN returns 0. Value is 0 if stopped by FN. */
5334
5335 static int
5336 foreach_window_1 (w, fn, user_data)
5337 struct window *w;
5338 int (* fn) P_ ((struct window *, void *));
5339 void *user_data;
5340 {
5341 int cont;
5342
5343 for (cont = 1; w && cont;)
5344 {
5345 if (!NILP (w->hchild))
5346 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
5347 else if (!NILP (w->vchild))
5348 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
5349 else
5350 cont = fn (w, user_data);
5351
5352 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5353 }
5354
5355 return cont;
5356 }
5357
5358
5359 /* Freeze or unfreeze the window start of W if unless it is a
5360 mini-window or the selected window. FREEZE_P non-null means freeze
5361 the window start. */
5362
5363 static int
5364 freeze_window_start (w, freeze_p)
5365 struct window *w;
5366 void *freeze_p;
5367 {
5368 if (w == XWINDOW (selected_window)
5369 || MINI_WINDOW_P (w)
5370 || (MINI_WINDOW_P (XWINDOW (selected_window))
5371 && ! NILP (Vminibuf_scroll_window)
5372 && w == XWINDOW (Vminibuf_scroll_window)))
5373 freeze_p = NULL;
5374
5375 w->frozen_window_start_p = freeze_p != NULL;
5376 return 1;
5377 }
5378
5379
5380 /* Freeze or unfreeze the window starts of all leaf windows on frame
5381 F, except the selected window and a mini-window. FREEZE_P non-zero
5382 means freeze the window start. */
5383
5384 void
5385 freeze_window_starts (f, freeze_p)
5386 struct frame *f;
5387 int freeze_p;
5388 {
5389 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
5390 }
5391
5392 \f
5393 /***********************************************************************
5394 Initialization
5395 ***********************************************************************/
5396
5397 /* Return 1 if window configurations C1 and C2
5398 describe the same state of affairs. This is used by Fequal. */
5399
5400 int
5401 compare_window_configurations (c1, c2, ignore_positions)
5402 Lisp_Object c1, c2;
5403 int ignore_positions;
5404 {
5405 register struct save_window_data *d1, *d2;
5406 struct Lisp_Vector *sw1, *sw2;
5407 int i;
5408
5409 if (!WINDOW_CONFIGURATIONP (c1))
5410 wrong_type_argument (Qwindow_configuration_p, c1);
5411 if (!WINDOW_CONFIGURATIONP (c2))
5412 wrong_type_argument (Qwindow_configuration_p, c2);
5413
5414 d1 = (struct save_window_data *) XVECTOR (c1);
5415 d2 = (struct save_window_data *) XVECTOR (c2);
5416 sw1 = XVECTOR (d1->saved_windows);
5417 sw2 = XVECTOR (d2->saved_windows);
5418
5419 if (! EQ (d1->frame_width, d2->frame_width))
5420 return 0;
5421 if (! EQ (d1->frame_height, d2->frame_height))
5422 return 0;
5423 if (! EQ (d1->frame_menu_bar_lines, d2->frame_menu_bar_lines))
5424 return 0;
5425 if (! EQ (d1->selected_frame, d2->selected_frame))
5426 return 0;
5427 /* Don't compare the current_window field directly.
5428 Instead see w1_is_current and w2_is_current, below. */
5429 if (! EQ (d1->current_buffer, d2->current_buffer))
5430 return 0;
5431 if (! ignore_positions)
5432 if (! EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window))
5433 return 0;
5434 /* Don't compare the root_window field.
5435 We don't require the two configurations
5436 to use the same window object,
5437 and the two root windows must be equivalent
5438 if everything else compares equal. */
5439 if (! EQ (d1->focus_frame, d2->focus_frame))
5440 return 0;
5441 if (! EQ (d1->min_width, d2->min_width))
5442 return 0;
5443 if (! EQ (d1->min_height, d2->min_height))
5444 return 0;
5445
5446 /* Verify that the two confis have the same number of windows. */
5447 if (sw1->size != sw2->size)
5448 return 0;
5449
5450 for (i = 0; i < sw1->size; i++)
5451 {
5452 struct saved_window *p1, *p2;
5453 int w1_is_current, w2_is_current;
5454
5455 p1 = SAVED_WINDOW_N (sw1, i);
5456 p2 = SAVED_WINDOW_N (sw2, i);
5457
5458 /* Verify that the current windows in the two
5459 configurations correspond to each other. */
5460 w1_is_current = EQ (d1->current_window, p1->window);
5461 w2_is_current = EQ (d2->current_window, p2->window);
5462
5463 if (w1_is_current != w2_is_current)
5464 return 0;
5465
5466 /* Verify that the corresponding windows do match. */
5467 if (! EQ (p1->buffer, p2->buffer))
5468 return 0;
5469 if (! EQ (p1->left, p2->left))
5470 return 0;
5471 if (! EQ (p1->top, p2->top))
5472 return 0;
5473 if (! EQ (p1->width, p2->width))
5474 return 0;
5475 if (! EQ (p1->height, p2->height))
5476 return 0;
5477 if (! EQ (p1->display_table, p2->display_table))
5478 return 0;
5479 if (! EQ (p1->parent, p2->parent))
5480 return 0;
5481 if (! EQ (p1->prev, p2->prev))
5482 return 0;
5483 if (! ignore_positions)
5484 {
5485 if (! EQ (p1->hscroll, p2->hscroll))
5486 return 0;
5487 if (! EQ (p1->start_at_line_beg, p2->start_at_line_beg))
5488 return 0;
5489 if (NILP (Fequal (p1->start, p2->start)))
5490 return 0;
5491 if (NILP (Fequal (p1->pointm, p2->pointm)))
5492 return 0;
5493 if (NILP (Fequal (p1->mark, p2->mark)))
5494 return 0;
5495 }
5496 }
5497
5498 return 1;
5499 }
5500
5501 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
5502 Scompare_window_configurations, 2, 2, 0,
5503 "Compare two window configurations as regards the structure of windows.\n\
5504 This function ignores details such as the values of point and mark\n\
5505 and scrolling positions.")
5506 (x, y)
5507 Lisp_Object x, y;
5508 {
5509 if (compare_window_configurations (x, y, 1))
5510 return Qt;
5511 return Qnil;
5512 }
5513 \f
5514 void
5515 init_window_once ()
5516 {
5517 struct frame *f = make_terminal_frame ();
5518 XSETFRAME (selected_frame, f);
5519 Vterminal_frame = selected_frame;
5520 minibuf_window = f->minibuffer_window;
5521 selected_window = f->selected_window;
5522 last_nonminibuf_frame = f;
5523
5524 window_initialized = 1;
5525 }
5526
5527 void
5528 init_window ()
5529 {
5530 Vwindow_list = Qnil;
5531 }
5532
5533 void
5534 syms_of_window ()
5535 {
5536 Qleft_bitmap_area = intern ("left-bitmap-area");
5537 staticpro (&Qleft_bitmap_area);
5538 Qright_bitmap_area = intern ("right-bitmap-area");
5539 staticpro (&Qright_bitmap_area);
5540
5541 Qwindow_size_fixed = intern ("window-size-fixed");
5542 staticpro (&Qwindow_size_fixed);
5543
5544 staticpro (&Qwindow_configuration_change_hook);
5545 Qwindow_configuration_change_hook
5546 = intern ("window-configuration-change-hook");
5547
5548 Qwindowp = intern ("windowp");
5549 staticpro (&Qwindowp);
5550
5551 Qwindow_configuration_p = intern ("window-configuration-p");
5552 staticpro (&Qwindow_configuration_p);
5553
5554 Qwindow_live_p = intern ("window-live-p");
5555 staticpro (&Qwindow_live_p);
5556
5557 Qtemp_buffer_show_hook = intern ("temp-buffer-show-hook");
5558 staticpro (&Qtemp_buffer_show_hook);
5559
5560 staticpro (&Vwindow_list);
5561
5562 DEFVAR_LISP ("temp-buffer-show-function", &Vtemp_buffer_show_function,
5563 "Non-nil means call as function to display a help buffer.\n\
5564 The function is called with one argument, the buffer to be displayed.\n\
5565 Used by `with-output-to-temp-buffer'.\n\
5566 If this function is used, then it must do the entire job of showing\n\
5567 the buffer; `temp-buffer-show-hook' is not run unless this function runs it.");
5568 Vtemp_buffer_show_function = Qnil;
5569
5570 DEFVAR_LISP ("display-buffer-function", &Vdisplay_buffer_function,
5571 "If non-nil, function to call to handle `display-buffer'.\n\
5572 It will receive two args, the buffer and a flag which if non-nil means\n\
5573 that the currently selected window is not acceptable.\n\
5574 Commands such as `switch-to-buffer-other-window' and `find-file-other-window'\n\
5575 work using this function.");
5576 Vdisplay_buffer_function = Qnil;
5577
5578 DEFVAR_LISP ("even-window-heights", &Veven_window_heights,
5579 "*If non-nil, `display-buffer' should even the window heights.\n\
5580 If nil, `display-buffer' will leave the window configuration alone.");
5581 Veven_window_heights = Qt;
5582
5583 DEFVAR_LISP ("minibuffer-scroll-window", &Vminibuf_scroll_window,
5584 "Non-nil means it is the window that C-M-v in minibuffer should scroll.");
5585 Vminibuf_scroll_window = Qnil;
5586
5587 DEFVAR_LISP ("other-window-scroll-buffer", &Vother_window_scroll_buffer,
5588 "If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window.");
5589 Vother_window_scroll_buffer = Qnil;
5590
5591 DEFVAR_BOOL ("pop-up-frames", &pop_up_frames,
5592 "*Non-nil means `display-buffer' should make a separate frame.");
5593 pop_up_frames = 0;
5594
5595 DEFVAR_BOOL ("display-buffer-reuse-frames", &display_buffer_reuse_frames,
5596 "*Non-nil means `display-buffer' should reuse frames.\n\
5597 If the buffer in question is already displayed in a frame, raise that frame.");
5598 display_buffer_reuse_frames = 0;
5599
5600 DEFVAR_LISP ("pop-up-frame-function", &Vpop_up_frame_function,
5601 "Function to call to handle automatic new frame creation.\n\
5602 It is called with no arguments and should return a newly created frame.\n\
5603 \n\
5604 A typical value might be `(lambda () (new-frame pop-up-frame-alist))'\n\
5605 where `pop-up-frame-alist' would hold the default frame parameters.");
5606 Vpop_up_frame_function = Qnil;
5607
5608 DEFVAR_LISP ("special-display-buffer-names", &Vspecial_display_buffer_names,
5609 "*List of buffer names that should have their own special frames.\n\
5610 Displaying a buffer whose name is in this list makes a special frame for it\n\
5611 using `special-display-function'. See also `special-display-regexps'.\n\
5612 \n\
5613 An element of the list can be a list instead of just a string.\n\
5614 There are two ways to use a list as an element:\n\
5615 (BUFFER FRAME-PARAMETERS...) (BUFFER FUNCTION OTHER-ARGS...)\n\
5616 In the first case, FRAME-PARAMETERS are used to create the frame.\n\
5617 In the latter case, FUNCTION is called with BUFFER as the first argument,\n\
5618 followed by OTHER-ARGS--it can display BUFFER in any way it likes.\n\
5619 All this is done by the function found in `special-display-function'.\n\
5620 \n\
5621 If this variable appears \"not to work\", because you add a name to it\n\
5622 but that buffer still appears in the selected window, look at the\n\
5623 values of `same-window-buffer-names' and `same-window-regexps'.\n\
5624 Those variables take precedence over this one.");
5625 Vspecial_display_buffer_names = Qnil;
5626
5627 DEFVAR_LISP ("special-display-regexps", &Vspecial_display_regexps,
5628 "*List of regexps saying which buffers should have their own special frames.\n\
5629 If a buffer name matches one of these regexps, it gets its own frame.\n\
5630 Displaying a buffer whose name is in this list makes a special frame for it\n\
5631 using `special-display-function'.\n\
5632 \n\
5633 An element of the list can be a list instead of just a string.\n\
5634 There are two ways to use a list as an element:\n\
5635 (REGEXP FRAME-PARAMETERS...) (REGEXP FUNCTION OTHER-ARGS...)\n\
5636 In the first case, FRAME-PARAMETERS are used to create the frame.\n\
5637 In the latter case, FUNCTION is called with the buffer as first argument,\n\
5638 followed by OTHER-ARGS--it can display the buffer in any way it likes.\n\
5639 All this is done by the function found in `special-display-function'.\n\
5640 \n\
5641 If this variable appears \"not to work\", because you add a regexp to it\n\
5642 but the matching buffers still appear in the selected window, look at the\n\
5643 values of `same-window-buffer-names' and `same-window-regexps'.\n\
5644 Those variables take precedence over this one.");
5645 Vspecial_display_regexps = Qnil;
5646
5647 DEFVAR_LISP ("special-display-function", &Vspecial_display_function,
5648 "Function to call to make a new frame for a special buffer.\n\
5649 It is called with two arguments, the buffer and optional buffer specific\n\
5650 data, and should return a window displaying that buffer.\n\
5651 The default value makes a separate frame for the buffer,\n\
5652 using `special-display-frame-alist' to specify the frame parameters.\n\
5653 \n\
5654 A buffer is special if its is listed in `special-display-buffer-names'\n\
5655 or matches a regexp in `special-display-regexps'.");
5656 Vspecial_display_function = Qnil;
5657
5658 DEFVAR_LISP ("same-window-buffer-names", &Vsame_window_buffer_names,
5659 "*List of buffer names that should appear in the selected window.\n\
5660 Displaying one of these buffers using `display-buffer' or `pop-to-buffer'\n\
5661 switches to it in the selected window, rather than making it appear\n\
5662 in some other window.\n\
5663 \n\
5664 An element of the list can be a cons cell instead of just a string.\n\
5665 Then the car must be a string, which specifies the buffer name.\n\
5666 This is for compatibility with `special-display-buffer-names';\n\
5667 the cdr of the cons cell is ignored.\n\
5668 \n\
5669 See also `same-window-regexps'.");
5670 Vsame_window_buffer_names = Qnil;
5671
5672 DEFVAR_LISP ("same-window-regexps", &Vsame_window_regexps,
5673 "*List of regexps saying which buffers should appear in the selected window.\n\
5674 If a buffer name matches one of these regexps, then displaying it\n\
5675 using `display-buffer' or `pop-to-buffer' switches to it\n\
5676 in the selected window, rather than making it appear in some other window.\n\
5677 \n\
5678 An element of the list can be a cons cell instead of just a string.\n\
5679 Then the car must be a string, which specifies the buffer name.\n\
5680 This is for compatibility with `special-display-buffer-names';\n\
5681 the cdr of the cons cell is ignored.\n\
5682 \n\
5683 See also `same-window-buffer-names'.");
5684 Vsame_window_regexps = Qnil;
5685
5686 DEFVAR_BOOL ("pop-up-windows", &pop_up_windows,
5687 "*Non-nil means display-buffer should make new windows.");
5688 pop_up_windows = 1;
5689
5690 DEFVAR_INT ("next-screen-context-lines", &next_screen_context_lines,
5691 "*Number of lines of continuity when scrolling by screenfuls.");
5692 next_screen_context_lines = 2;
5693
5694 DEFVAR_INT ("split-height-threshold", &split_height_threshold,
5695 "*display-buffer would prefer to split the largest window if this large.\n\
5696 If there is only one window, it is split regardless of this value.");
5697 split_height_threshold = 500;
5698
5699 DEFVAR_INT ("window-min-height", &window_min_height,
5700 "*Delete any window less than this tall (including its mode line).");
5701 window_min_height = 4;
5702
5703 DEFVAR_INT ("window-min-width", &window_min_width,
5704 "*Delete any window less than this wide.");
5705 window_min_width = 10;
5706
5707 DEFVAR_LISP ("scroll-preserve-screen-position",
5708 &Vscroll_preserve_screen_position,
5709 "*Nonzero means scroll commands move point to keep its screen line unchanged.");
5710 Vscroll_preserve_screen_position = Qnil;
5711
5712 DEFVAR_LISP ("window-configuration-change-hook",
5713 &Vwindow_configuration_change_hook,
5714 "Functions to call when window configuration changes.\n\
5715 The selected frame is the one whose configuration has changed.");
5716 Vwindow_configuration_change_hook = Qnil;
5717
5718 defsubr (&Sselected_window);
5719 defsubr (&Sminibuffer_window);
5720 defsubr (&Swindow_minibuffer_p);
5721 defsubr (&Swindowp);
5722 defsubr (&Swindow_live_p);
5723 defsubr (&Spos_visible_in_window_p);
5724 defsubr (&Swindow_buffer);
5725 defsubr (&Swindow_height);
5726 defsubr (&Swindow_width);
5727 defsubr (&Swindow_hscroll);
5728 defsubr (&Sset_window_hscroll);
5729 defsubr (&Swindow_redisplay_end_trigger);
5730 defsubr (&Sset_window_redisplay_end_trigger);
5731 defsubr (&Swindow_edges);
5732 defsubr (&Scoordinates_in_window_p);
5733 defsubr (&Swindow_at);
5734 defsubr (&Swindow_point);
5735 defsubr (&Swindow_start);
5736 defsubr (&Swindow_end);
5737 defsubr (&Sset_window_point);
5738 defsubr (&Sset_window_start);
5739 defsubr (&Swindow_dedicated_p);
5740 defsubr (&Sset_window_dedicated_p);
5741 defsubr (&Swindow_display_table);
5742 defsubr (&Sset_window_display_table);
5743 defsubr (&Snext_window);
5744 defsubr (&Sprevious_window);
5745 defsubr (&Sother_window);
5746 defsubr (&Sget_lru_window);
5747 defsubr (&Sget_largest_window);
5748 defsubr (&Sget_buffer_window);
5749 defsubr (&Sdelete_other_windows);
5750 defsubr (&Sdelete_windows_on);
5751 defsubr (&Sreplace_buffer_in_windows);
5752 defsubr (&Sdelete_window);
5753 defsubr (&Sset_window_buffer);
5754 defsubr (&Sselect_window);
5755 defsubr (&Sspecial_display_p);
5756 defsubr (&Ssame_window_p);
5757 defsubr (&Sdisplay_buffer);
5758 defsubr (&Ssplit_window);
5759 defsubr (&Senlarge_window);
5760 defsubr (&Sshrink_window);
5761 defsubr (&Sscroll_up);
5762 defsubr (&Sscroll_down);
5763 defsubr (&Sscroll_left);
5764 defsubr (&Sscroll_right);
5765 defsubr (&Sother_window_for_scrolling);
5766 defsubr (&Sscroll_other_window);
5767 defsubr (&Srecenter);
5768 defsubr (&Swindow_text_height);
5769 defsubr (&Smove_to_window_line);
5770 defsubr (&Swindow_configuration_p);
5771 defsubr (&Swindow_configuration_frame);
5772 defsubr (&Sset_window_configuration);
5773 defsubr (&Scurrent_window_configuration);
5774 defsubr (&Ssave_window_excursion);
5775 defsubr (&Sset_window_margins);
5776 defsubr (&Swindow_margins);
5777 defsubr (&Swindow_vscroll);
5778 defsubr (&Sset_window_vscroll);
5779 defsubr (&Scompare_window_configurations);
5780 defsubr (&Swindow_list);
5781 }
5782
5783 void
5784 keys_of_window ()
5785 {
5786 initial_define_key (control_x_map, '1', "delete-other-windows");
5787 initial_define_key (control_x_map, '2', "split-window");
5788 initial_define_key (control_x_map, '0', "delete-window");
5789 initial_define_key (control_x_map, 'o', "other-window");
5790 initial_define_key (control_x_map, '^', "enlarge-window");
5791 initial_define_key (control_x_map, '<', "scroll-left");
5792 initial_define_key (control_x_map, '>', "scroll-right");
5793
5794 initial_define_key (global_map, Ctl ('V'), "scroll-up");
5795 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
5796 initial_define_key (meta_map, 'v', "scroll-down");
5797
5798 initial_define_key (global_map, Ctl('L'), "recenter");
5799 initial_define_key (meta_map, 'r', "move-to-window-line");
5800 }