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