Rewrite and delabelize vertical border check. (Bug#5357) (Bug#9618)
[bpt/emacs.git] / src / window.c
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985-1987, 1993-1998, 2000-2011
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 3 of the License, or
11 (at your option) 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. If not, see <http://www.gnu.org/licenses/>. */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <setjmp.h>
24
25 #include "lisp.h"
26 #include "buffer.h"
27 #include "keyboard.h"
28 #include "keymap.h"
29 #include "frame.h"
30 #include "window.h"
31 #include "commands.h"
32 #include "indent.h"
33 #include "termchar.h"
34 #include "disptab.h"
35 #include "dispextern.h"
36 #include "blockinput.h"
37 #include "intervals.h"
38 #include "termhooks.h" /* For FRAME_TERMINAL. */
39
40 #ifdef HAVE_X_WINDOWS
41 #include "xterm.h"
42 #endif /* HAVE_X_WINDOWS */
43 #ifdef WINDOWSNT
44 #include "w32term.h"
45 #endif
46 #ifdef MSDOS
47 #include "msdos.h"
48 #endif
49 #ifdef HAVE_NS
50 #include "nsterm.h"
51 #endif
52
53 Lisp_Object Qwindowp, Qwindow_live_p;
54 static Lisp_Object Qwindow_configuration_p, Qrecord_window_buffer;
55 static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
56 static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
57 static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
58 static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
59 static Lisp_Object Qsafe, Qabove, Qbelow;
60 static Lisp_Object Qauto_buffer_name;
61
62 static int displayed_window_lines (struct window *);
63 static struct window *decode_window (Lisp_Object);
64 static int count_windows (struct window *);
65 static int get_leaf_windows (struct window *, struct window **, int);
66 static void window_scroll (Lisp_Object, int, int, int);
67 static void window_scroll_pixel_based (Lisp_Object, int, int, int);
68 static void window_scroll_line_based (Lisp_Object, int, int, int);
69 static int freeze_window_start (struct window *, void *);
70 static Lisp_Object window_list (void);
71 static int add_window_to_list (struct window *, void *);
72 static int candidate_window_p (Lisp_Object, Lisp_Object, Lisp_Object,
73 Lisp_Object);
74 static Lisp_Object next_window (Lisp_Object, Lisp_Object,
75 Lisp_Object, int);
76 static void decode_next_window_args (Lisp_Object *, Lisp_Object *,
77 Lisp_Object *);
78 static void foreach_window (struct frame *,
79 int (* fn) (struct window *, void *),
80 void *);
81 static int foreach_window_1 (struct window *,
82 int (* fn) (struct window *, void *),
83 void *);
84 static Lisp_Object window_list_1 (Lisp_Object, Lisp_Object, Lisp_Object);
85 static int window_resize_check (struct window *, int);
86 static void window_resize_apply (struct window *, int);
87 static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
88
89 /* This is the window in which the terminal's cursor should
90 be left when nothing is being done with it. This must
91 always be a leaf window, and its buffer is selected by
92 the top level editing loop at the end of each command.
93
94 This value is always the same as
95 FRAME_SELECTED_WINDOW (selected_frame). */
96 Lisp_Object selected_window;
97
98 /* A list of all windows for use by next_window and Fwindow_list.
99 Functions creating or deleting windows should invalidate this cache
100 by setting it to nil. */
101 Lisp_Object Vwindow_list;
102
103 /* The mini-buffer window of the selected frame.
104 Note that you cannot test for mini-bufferness of an arbitrary window
105 by comparing against this; but you can test for mini-bufferness of
106 the selected window. */
107 Lisp_Object minibuf_window;
108
109 /* Non-nil means it is the window whose mode line should be
110 shown as the selected window when the minibuffer is selected. */
111 Lisp_Object minibuf_selected_window;
112
113 /* Hook run at end of temp_output_buffer_show. */
114 static Lisp_Object Qtemp_buffer_show_hook;
115
116 /* Incremented for each window created. */
117 static int sequence_number;
118
119 /* Nonzero after init_window_once has finished. */
120 static int window_initialized;
121
122 /* Hook to run when window config changes. */
123 static Lisp_Object Qwindow_configuration_change_hook;
124
125 /* Used by the function window_scroll_pixel_based */
126 static int window_scroll_pixel_based_preserve_x;
127 static int window_scroll_pixel_based_preserve_y;
128
129 /* Same for window_scroll_line_based. */
130 static int window_scroll_preserve_hpos;
131 static int window_scroll_preserve_vpos;
132 \f
133 static struct window *
134 decode_window (register Lisp_Object window)
135 {
136 if (NILP (window))
137 return XWINDOW (selected_window);
138
139 CHECK_LIVE_WINDOW (window);
140 return XWINDOW (window);
141 }
142
143 static struct window *
144 decode_any_window (register Lisp_Object window)
145 {
146 if (NILP (window))
147 return XWINDOW (selected_window);
148
149 CHECK_WINDOW (window);
150 return XWINDOW (window);
151 }
152
153 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
154 doc: /* Return t if OBJECT is a window and nil otherwise. */)
155 (Lisp_Object object)
156 {
157 return WINDOWP (object) ? Qt : Qnil;
158 }
159
160 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
161 doc: /* Return t if OBJECT is a live window and nil otherwise.
162 A live window is a window that displays a buffer. */)
163 (Lisp_Object object)
164 {
165 return WINDOW_LIVE_P (object) ? Qt : Qnil;
166 }
167 \f
168 /* Frames and windows. */
169 DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 1, 1, 0,
170 doc: /* Return the frame that window WINDOW is on.
171 WINDOW can be any window and defaults to the selected one. */)
172 (Lisp_Object window)
173 {
174 return decode_any_window (window)->frame;
175 }
176
177 DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
178 doc: /* Return the root window of FRAME_OR_WINDOW.
179 If omitted, FRAME_OR_WINDOW defaults to the currently selected frame.
180 Else if FRAME_OR_WINDOW denotes any window, return the root window of
181 that window's frame. If FRAME_OR_WINDOW denotes a live frame, return
182 the root window of that frame. */)
183 (Lisp_Object frame_or_window)
184 {
185 Lisp_Object window;
186
187 if (NILP (frame_or_window))
188 window = SELECTED_FRAME ()->root_window;
189 else if (WINDOWP (frame_or_window))
190 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
191 else
192 {
193 CHECK_LIVE_FRAME (frame_or_window);
194 window = XFRAME (frame_or_window)->root_window;
195 }
196
197 return window;
198 }
199
200 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
201 doc: /* Return the window used now for minibuffers.
202 If the optional argument FRAME is specified, return the minibuffer window
203 used by that frame. */)
204 (Lisp_Object frame)
205 {
206 if (NILP (frame))
207 frame = selected_frame;
208 CHECK_LIVE_FRAME (frame);
209 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
210 }
211
212 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
213 Swindow_minibuffer_p, 0, 1, 0,
214 doc: /* Return non-nil if WINDOW is a minibuffer window.
215 WINDOW can be any window and defaults to the selected one. */)
216 (Lisp_Object window)
217 {
218 return MINI_WINDOW_P (decode_any_window (window)) ? Qt : Qnil;
219 }
220
221 /* Don't move this to window.el - this must be a safe routine. */
222 DEFUN ("frame-first-window", Fframe_first_window, Sframe_first_window, 0, 1, 0,
223 doc: /* Return the topmost, leftmost live window on FRAME_OR_WINDOW.
224 If omitted, FRAME_OR_WINDOW defaults to the currently selected frame.
225 Else if FRAME_OR_WINDOW denotes any window, return the first window of
226 that window's frame. If FRAME_OR_WINDOW denotes a live frame, return
227 the first window of that frame. */)
228 (Lisp_Object frame_or_window)
229 {
230 Lisp_Object window;
231
232 if (NILP (frame_or_window))
233 window = SELECTED_FRAME ()->root_window;
234 else if (WINDOWP (frame_or_window))
235 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
236 else
237 {
238 CHECK_LIVE_FRAME (frame_or_window);
239 window = XFRAME (frame_or_window)->root_window;
240 }
241
242 while (NILP (XWINDOW (window)->buffer))
243 {
244 if (! NILP (XWINDOW (window)->hchild))
245 window = XWINDOW (window)->hchild;
246 else if (! NILP (XWINDOW (window)->vchild))
247 window = XWINDOW (window)->vchild;
248 else
249 abort ();
250 }
251
252 return window;
253 }
254
255 DEFUN ("frame-selected-window", Fframe_selected_window,
256 Sframe_selected_window, 0, 1, 0,
257 doc: /* Return the selected window of FRAME_OR_WINDOW.
258 If omitted, FRAME_OR_WINDOW defaults to the currently selected frame.
259 Else if FRAME_OR_WINDOW denotes any window, return the selected window
260 of that window's frame. If FRAME_OR_WINDOW denotes a live frame, return
261 the selected window of that frame. */)
262 (Lisp_Object frame_or_window)
263 {
264 Lisp_Object window;
265
266 if (NILP (frame_or_window))
267 window = SELECTED_FRAME ()->selected_window;
268 else if (WINDOWP (frame_or_window))
269 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
270 else
271 {
272 CHECK_LIVE_FRAME (frame_or_window);
273 window = XFRAME (frame_or_window)->selected_window;
274 }
275
276 return window;
277 }
278
279 DEFUN ("set-frame-selected-window", Fset_frame_selected_window,
280 Sset_frame_selected_window, 2, 3, 0,
281 doc: /* Set selected window of FRAME to WINDOW.
282 FRAME must be a live frame and defaults to the selected one. If FRAME
283 is the selected frame, this makes WINDOW the selected window. Optional
284 argument NORECORD non-nil means to neither change the order of recently
285 selected windows nor the buffer list. WINDOW must denote a live window.
286 Return WINDOW. */)
287 (Lisp_Object frame, Lisp_Object window, Lisp_Object norecord)
288 {
289 if (NILP (frame))
290 frame = selected_frame;
291
292 CHECK_LIVE_FRAME (frame);
293 CHECK_LIVE_WINDOW (window);
294
295 if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
296 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
297
298 if (EQ (frame, selected_frame))
299 return Fselect_window (window, norecord);
300 else
301 return XFRAME (frame)->selected_window = window;
302 }
303
304 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
305 doc: /* Return the selected window.
306 The selected window is the window in which the standard cursor for
307 selected windows appears and to which many commands apply. */)
308 (void)
309 {
310 return selected_window;
311 }
312
313 int window_select_count;
314
315 /* If select_window is called with inhibit_point_swap non-zero it will
316 not store point of the old selected window's buffer back into that
317 window's pointm slot. This is needed by Fset_window_configuration to
318 avoid that the display routine is called with selected_window set to
319 Qnil causing a subsequent crash. */
320 static Lisp_Object
321 select_window (Lisp_Object window, Lisp_Object norecord, int inhibit_point_swap)
322 {
323 register struct window *w;
324 register struct window *ow;
325 struct frame *sf;
326
327 CHECK_LIVE_WINDOW (window);
328
329 w = XWINDOW (window);
330 w->frozen_window_start_p = 0;
331
332 if (NILP (norecord))
333 {
334 ++window_select_count;
335 XSETFASTINT (w->use_time, window_select_count);
336 record_buffer (w->buffer);
337 }
338
339 if (EQ (window, selected_window) && !inhibit_point_swap)
340 return window;
341
342 sf = SELECTED_FRAME ();
343 if (XFRAME (WINDOW_FRAME (w)) != sf)
344 {
345 XFRAME (WINDOW_FRAME (w))->selected_window = window;
346 /* Use this rather than Fhandle_switch_frame
347 so that FRAME_FOCUS_FRAME is moved appropriately as we
348 move around in the state where a minibuffer in a separate
349 frame is active. */
350 Fselect_frame (WINDOW_FRAME (w), norecord);
351 /* Fselect_frame called us back so we've done all the work already. */
352 eassert (EQ (window, selected_window));
353 return window;
354 }
355 else
356 sf->selected_window = window;
357
358 /* Store the current buffer's actual point into the
359 old selected window. It belongs to that window,
360 and when the window is not selected, must be in the window. */
361 if (!inhibit_point_swap)
362 {
363 ow = XWINDOW (selected_window);
364 if (! NILP (ow->buffer))
365 set_marker_both (ow->pointm, ow->buffer,
366 BUF_PT (XBUFFER (ow->buffer)),
367 BUF_PT_BYTE (XBUFFER (ow->buffer)));
368 }
369
370 selected_window = window;
371
372 Fset_buffer (w->buffer);
373
374 BVAR (XBUFFER (w->buffer), last_selected_window) = window;
375
376 /* Go to the point recorded in the window.
377 This is important when the buffer is in more
378 than one window. It also matters when
379 redisplay_window has altered point after scrolling,
380 because it makes the change only in the window. */
381 {
382 register EMACS_INT new_point = marker_position (w->pointm);
383 if (new_point < BEGV)
384 SET_PT (BEGV);
385 else if (new_point > ZV)
386 SET_PT (ZV);
387 else
388 SET_PT (new_point);
389 }
390
391 windows_or_buffers_changed++;
392 return window;
393 }
394
395 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
396 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
397 Also make WINDOW's buffer current and make WINDOW the frame's selected
398 window. Return WINDOW.
399
400 Optional second arg NORECORD non-nil means do not put this buffer at the
401 front of the buffer list and do not make this window the most recently
402 selected one.
403
404 Note that the main editor command loop sets the current buffer to the
405 buffer of the selected window before each command. */)
406 (register Lisp_Object window, Lisp_Object norecord)
407 {
408 return select_window (window, norecord, 0);
409 }
410 \f
411 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
412 doc: /* Return the buffer that WINDOW is displaying.
413 WINDOW can be any window and defaults to the selected one.
414 If WINDOW is an internal window return nil. */)
415 (Lisp_Object window)
416 {
417 return decode_any_window (window)->buffer;
418 }
419
420 DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
421 doc: /* Return WINDOW's parent window.
422 WINDOW can be any window and defaults to the selected one.
423 Return nil if WINDOW has no parent. */)
424 (Lisp_Object window)
425 {
426 return decode_any_window (window)->parent;
427 }
428
429 DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
430 doc: /* Return WINDOW's topmost child window.
431 WINDOW can be any window and defaults to the selected one.
432 Return nil if WINDOW is not a vertical combination. */)
433 (Lisp_Object window)
434 {
435 return decode_any_window (window)->vchild;
436 }
437
438 DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
439 doc: /* Return WINDOW's leftmost child window.
440 WINDOW can be any window and defaults to the selected one.
441 Return nil if WINDOW is not a horizontal combination. */)
442 (Lisp_Object window)
443 {
444 return decode_any_window (window)->hchild;
445 }
446
447 DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
448 doc: /* Return WINDOW's next sibling window.
449 WINDOW can be any window and defaults to the selected one.
450 Return nil if WINDOW has no next sibling. */)
451 (Lisp_Object window)
452 {
453 return decode_any_window (window)->next;
454 }
455
456 DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
457 doc: /* Return WINDOW's previous sibling window.
458 WINDOW can be any window and defaults to the selected one.
459 Return nil if WINDOW has no previous sibling. */)
460 (Lisp_Object window)
461 {
462 return decode_any_window (window)->prev;
463 }
464
465 DEFUN ("window-splits", Fwindow_splits, Swindow_splits, 0, 1, 0,
466 doc: /* Return splits status for WINDOW.
467 WINDOW can be any window and defaults to the selected one.
468
469 If the value returned by this function is nil and WINDOW is resized, the
470 corresponding space is preferably taken from (or given to) WINDOW's
471 right sibling. When WINDOW is deleted, its space is given to its left
472 sibling.
473
474 If the value returned by this function is non-nil, resizing and deleting
475 WINDOW may resize all windows in the same combination. */)
476 (Lisp_Object window)
477 {
478 return decode_any_window (window)->splits;
479 }
480
481 DEFUN ("set-window-splits", Fset_window_splits, Sset_window_splits, 2, 2, 0,
482 doc: /* Set splits status of WINDOW to STATUS.
483 WINDOW can be any window and defaults to the selected one. Return
484 STATUS.
485
486 If STATUS is nil and WINDOW is later resized, the corresponding space is
487 preferably taken from (or given to) WINDOW's right sibling. When WINDOW
488 is deleted, its space is given to its left sibling.
489
490 If STATUS is non-nil, resizing and deleting WINDOW may resize all
491 windows in the same combination. */)
492 (Lisp_Object window, Lisp_Object status)
493 {
494 register struct window *w = decode_any_window (window);
495
496 w->splits = status;
497
498 return w->splits;
499 }
500
501 DEFUN ("window-nest", Fwindow_nest, Swindow_nest, 0, 1, 0,
502 doc: /* Return nest status of WINDOW.
503 WINDOW can be any window and defaults to the selected one.
504
505 If the return value is nil, subwindows of WINDOW can be recombined with
506 WINDOW's siblings. A return value of non-nil means that subwindows of
507 WINDOW are never \(re-)combined with WINDOW's siblings. */)
508 (Lisp_Object window)
509 {
510 return decode_any_window (window)->nest;
511 }
512
513 DEFUN ("set-window-nest", Fset_window_nest, Sset_window_nest, 2, 2, 0,
514 doc: /* Set nest status of WINDOW to STATUS.
515 WINDOW can be any window and defaults to the selected one. Return
516 STATUS.
517
518 If STATUS is nil, subwindows of WINDOW can be recombined with WINDOW's
519 siblings. STATUS non-nil means that subwindows of WINDOW are never
520 \(re-)combined with WINDOW's siblings. */)
521 (Lisp_Object window, Lisp_Object status)
522 {
523 register struct window *w = decode_any_window (window);
524
525 w->nest = status;
526
527 return w->nest;
528 }
529
530 DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
531 doc: /* Return WINDOW's use time.
532 WINDOW defaults to the selected window. The window with the highest use
533 time is the most recently selected one. The window with the lowest use
534 time is the least recently selected one. */)
535 (Lisp_Object window)
536 {
537 return decode_window (window)->use_time;
538 }
539 \f
540 DEFUN ("window-total-size", Fwindow_total_size, Swindow_total_size, 0, 2, 0,
541 doc: /* Return the total number of lines of WINDOW.
542 WINDOW can be any window and defaults to the selected one. The return
543 value includes WINDOW's mode line and header line, if any. If WINDOW
544 is internal, the return value is the sum of the total number of lines
545 of WINDOW's child windows if these are vertically combined and the
546 height of WINDOW's first child otherwise.
547
548 Optional argument HORIZONTAL non-nil means return the total number of
549 columns of WINDOW. In this case the return value includes any vertical
550 dividers or scrollbars of WINDOW. If WINDOW is internal, the return
551 value is the sum of the total number of columns of WINDOW's child
552 windows if they are horizontally combined and the width of WINDOW's
553 first child otherwise. */)
554 (Lisp_Object window, Lisp_Object horizontal)
555 {
556 if (NILP (horizontal))
557 return decode_any_window (window)->total_lines;
558 else
559 return decode_any_window (window)->total_cols;
560 }
561
562 DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
563 doc: /* Return new total size of WINDOW.
564 WINDOW defaults to the selected window. */)
565 (Lisp_Object window)
566 {
567 return decode_any_window (window)->new_total;
568 }
569
570 DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
571 doc: /* Return normal height of WINDOW.
572 WINDOW can be any window and defaults to the selected one. Optional
573 argument HORIZONTAL non-nil means return normal width of WINDOW. */)
574 (Lisp_Object window, Lisp_Object horizontal)
575 {
576 if (NILP (horizontal))
577 return decode_any_window (window)->normal_lines;
578 else
579 return decode_any_window (window)->normal_cols;
580 }
581
582 DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
583 doc: /* Return new normal size of WINDOW.
584 WINDOW can be any window and defaults to the selected one. */)
585 (Lisp_Object window)
586 {
587 return decode_any_window (window)->new_normal;
588 }
589
590 DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
591 doc: /* Return left column of WINDOW.
592 WINDOW can be any window and defaults to the selected one. */)
593 (Lisp_Object window)
594 {
595 return decode_any_window (window)->left_col;
596 }
597
598 DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
599 doc: /* Return top line of WINDOW.
600 WINDOW can be any window and defaults to the selected one. */)
601 (Lisp_Object window)
602 {
603 return decode_any_window (window)->top_line;
604 }
605
606 /* Return the number of lines of W's body. Don't count any mode or
607 header line of W. */
608
609 static int
610 window_body_lines (struct window *w)
611 {
612 int height = XFASTINT (w->total_lines);
613
614 if (!MINI_WINDOW_P (w))
615 {
616 if (WINDOW_WANTS_MODELINE_P (w))
617 --height;
618 if (WINDOW_WANTS_HEADER_LINE_P (w))
619 --height;
620 }
621
622 return height;
623 }
624
625 /* Return the number of columns of W's body. Don't count columns
626 occupied by the scroll bar or the vertical bar separating W from its
627 right sibling. On window-systems don't count fringes or display
628 margins either. */
629
630 int
631 window_body_cols (struct window *w)
632 {
633 struct frame *f = XFRAME (WINDOW_FRAME (w));
634 int width = XINT (w->total_cols);
635
636 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
637 /* Scroll bars occupy a few columns. */
638 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
639 else if (!FRAME_WINDOW_P (f)
640 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
641 /* The column of `|' characters separating side-by-side windows
642 occupies one column only. */
643 width -= 1;
644
645 if (FRAME_WINDOW_P (f))
646 /* On window-systems, fringes and display margins cannot be
647 used for normal text. */
648 width -= (WINDOW_FRINGE_COLS (w)
649 + WINDOW_LEFT_MARGIN_COLS (w)
650 + WINDOW_RIGHT_MARGIN_COLS (w));
651
652 return width;
653 }
654
655 DEFUN ("window-body-size", Fwindow_body_size, Swindow_body_size, 0, 2, 0,
656 doc: /* Return the number of lines of WINDOW's body.
657 WINDOW must be a live window and defaults to the selected one. The
658 return value does not include WINDOW's mode line and header line, if
659 any.
660
661 Optional argument HORIZONTAL non-nil means return the number of columns
662 of WINDOW's body. In this case, the return value does not include any
663 vertical dividers or scroll bars owned by WINDOW. On a window-system
664 the return value does not include the number of columns used for
665 WINDOW's fringes or display margins either. */)
666 (Lisp_Object window, Lisp_Object horizontal)
667 {
668 struct window *w = decode_any_window (window);
669
670 if (NILP (horizontal))
671 return make_number (window_body_lines (w));
672 else
673 return make_number (window_body_cols (w));
674 }
675
676 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
677 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
678 WINDOW must be a live window and defaults to the selected one. */)
679 (Lisp_Object window)
680 {
681 return decode_window (window)->hscroll;
682 }
683
684 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
685 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
686 If WINDOW is nil, the selected window is used.
687 Return NCOL. NCOL should be zero or positive.
688
689 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
690 window so that the location of point moves off-window. */)
691 (Lisp_Object window, Lisp_Object ncol)
692 {
693 struct window *w = decode_window (window);
694 int hscroll;
695
696 CHECK_NUMBER (ncol);
697 hscroll = max (0, XINT (ncol));
698
699 /* Prevent redisplay shortcuts when changing the hscroll. */
700 if (XINT (w->hscroll) != hscroll)
701 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
702
703 w->hscroll = make_number (hscroll);
704 return ncol;
705 }
706
707 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
708 Swindow_redisplay_end_trigger, 0, 1, 0,
709 doc: /* Return WINDOW's redisplay end trigger value.
710 WINDOW defaults to the selected window.
711 See `set-window-redisplay-end-trigger' for more information. */)
712 (Lisp_Object window)
713 {
714 return decode_window (window)->redisplay_end_trigger;
715 }
716
717 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
718 Sset_window_redisplay_end_trigger, 2, 2, 0,
719 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
720 VALUE should be a buffer position (typically a marker) or nil.
721 If it is a buffer position, then if redisplay in WINDOW reaches a position
722 beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
723 with two arguments: WINDOW, and the end trigger value.
724 Afterwards the end-trigger value is reset to nil. */)
725 (register Lisp_Object window, Lisp_Object value)
726 {
727 register struct window *w;
728
729 w = decode_window (window);
730 w->redisplay_end_trigger = value;
731 return value;
732 }
733
734 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
735 doc: /* Return a list of the edge coordinates of WINDOW.
736 The list has the form (LEFT TOP RIGHT BOTTOM).
737 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
738 all relative to 0, 0 at top left corner of frame.
739
740 RIGHT is one more than the rightmost column occupied by WINDOW.
741 BOTTOM is one more than the bottommost row occupied by WINDOW.
742 The edges include the space used by WINDOW's scroll bar, display
743 margins, fringes, header line, and/or mode line. For the edges of
744 just the text area, use `window-inside-edges'. */)
745 (Lisp_Object window)
746 {
747 register struct window *w = decode_any_window (window);
748
749 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
750 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
751 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
752 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
753 Qnil))));
754 }
755
756 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
757 doc: /* Return a list of the edge pixel coordinates of WINDOW.
758 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
759 the top left corner of the frame.
760
761 RIGHT is one more than the rightmost x position occupied by WINDOW.
762 BOTTOM is one more than the bottommost y position occupied by WINDOW.
763 The pixel edges include the space used by WINDOW's scroll bar, display
764 margins, fringes, header line, and/or mode line. For the pixel edges
765 of just the text area, use `window-inside-pixel-edges'. */)
766 (Lisp_Object window)
767 {
768 register struct window *w = decode_any_window (window);
769
770 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
771 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
772 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
773 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
774 Qnil))));
775 }
776
777 static void
778 calc_absolute_offset (struct window *w, int *add_x, int *add_y)
779 {
780 struct frame *f = XFRAME (w->frame);
781 *add_y = f->top_pos;
782 #ifdef FRAME_MENUBAR_HEIGHT
783 *add_y += FRAME_MENUBAR_HEIGHT (f);
784 #endif
785 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
786 *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
787 #elif FRAME_TOOLBAR_HEIGHT
788 *add_y += FRAME_TOOLBAR_HEIGHT (f);
789 #endif
790 #ifdef FRAME_NS_TITLEBAR_HEIGHT
791 *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
792 #endif
793 *add_x = f->left_pos;
794 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
795 *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
796 #endif
797 }
798
799 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
800 Swindow_absolute_pixel_edges, 0, 1, 0,
801 doc: /* Return a list of the edge pixel coordinates of WINDOW.
802 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
803 the top left corner of the display.
804
805 RIGHT is one more than the rightmost x position occupied by WINDOW.
806 BOTTOM is one more than the bottommost y position occupied by WINDOW.
807 The pixel edges include the space used by WINDOW's scroll bar, display
808 margins, fringes, header line, and/or mode line. For the pixel edges
809 of just the text area, use `window-inside-absolute-pixel-edges'. */)
810 (Lisp_Object window)
811 {
812 register struct window *w = decode_any_window (window);
813 int add_x, add_y;
814 calc_absolute_offset (w, &add_x, &add_y);
815
816 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w) + add_x),
817 Fcons (make_number (WINDOW_TOP_EDGE_Y (w) + add_y),
818 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w) + add_x),
819 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w) + add_y),
820 Qnil))));
821 }
822
823 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
824 doc: /* Return a list of the edge coordinates of WINDOW.
825 The list has the form (LEFT TOP RIGHT BOTTOM).
826 TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
827 all relative to 0, 0 at top left corner of frame.
828
829 RIGHT is one more than the rightmost column of WINDOW's text area.
830 BOTTOM is one more than the bottommost row of WINDOW's text area.
831 The inside edges do not include the space used by the WINDOW's scroll
832 bar, display margins, fringes, header line, and/or mode line. */)
833 (Lisp_Object window)
834 {
835 register struct window *w = decode_any_window (window);
836
837 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
838 + WINDOW_LEFT_MARGIN_COLS (w)
839 + WINDOW_LEFT_FRINGE_COLS (w)),
840 make_number (WINDOW_TOP_EDGE_LINE (w)
841 + WINDOW_HEADER_LINE_LINES (w)),
842 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
843 - WINDOW_RIGHT_MARGIN_COLS (w)
844 - WINDOW_RIGHT_FRINGE_COLS (w)),
845 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
846 - WINDOW_MODE_LINE_LINES (w)));
847 }
848
849 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
850 doc: /* Return a list of the edge pixel coordinates of WINDOW.
851 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
852 the top left corner of the frame.
853
854 RIGHT is one more than the rightmost x position of WINDOW's text area.
855 BOTTOM is one more than the bottommost y position of WINDOW's text area.
856 The inside edges do not include the space used by WINDOW's scroll bar,
857 display margins, fringes, header line, and/or mode line. */)
858 (Lisp_Object window)
859 {
860 register struct window *w = decode_any_window (window);
861
862 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
863 + WINDOW_LEFT_MARGIN_WIDTH (w)
864 + WINDOW_LEFT_FRINGE_WIDTH (w)),
865 make_number (WINDOW_TOP_EDGE_Y (w)
866 + WINDOW_HEADER_LINE_HEIGHT (w)),
867 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
868 - WINDOW_RIGHT_MARGIN_WIDTH (w)
869 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
870 make_number (WINDOW_BOTTOM_EDGE_Y (w)
871 - WINDOW_MODE_LINE_HEIGHT (w)));
872 }
873
874 DEFUN ("window-inside-absolute-pixel-edges",
875 Fwindow_inside_absolute_pixel_edges,
876 Swindow_inside_absolute_pixel_edges, 0, 1, 0,
877 doc: /* Return a list of the edge pixel coordinates of WINDOW.
878 The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
879 the top left corner of the display.
880
881 RIGHT is one more than the rightmost x position of WINDOW's text area.
882 BOTTOM is one more than the bottommost y position of WINDOW's text area.
883 The inside edges do not include the space used by WINDOW's scroll bar,
884 display margins, fringes, header line, and/or mode line. */)
885 (Lisp_Object window)
886 {
887 register struct window *w = decode_any_window (window);
888 int add_x, add_y;
889 calc_absolute_offset (w, &add_x, &add_y);
890
891 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
892 + WINDOW_LEFT_MARGIN_WIDTH (w)
893 + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
894 make_number (WINDOW_TOP_EDGE_Y (w)
895 + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
896 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
897 - WINDOW_RIGHT_MARGIN_WIDTH (w)
898 - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
899 make_number (WINDOW_BOTTOM_EDGE_Y (w)
900 - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
901 }
902
903 /* Test if the character at column X, row Y is within window W.
904 If it is not, return ON_NOTHING;
905 if it is in the window's text area, return ON_TEXT;
906 if it is on the window's modeline, return ON_MODE_LINE;
907 if it is on the border between the window and its right sibling,
908 return ON_VERTICAL_BORDER.
909 if it is on a scroll bar, return ON_SCROLL_BAR.
910 if it is on the window's top line, return ON_HEADER_LINE;
911 if it is in left or right fringe of the window,
912 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
913 if it is in the marginal area to the left/right of the window,
914 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
915
916 X and Y are frame relative pixel coordinates. */
917
918 static enum window_part
919 coordinates_in_window (register struct window *w, int x, int y)
920 {
921 struct frame *f = XFRAME (WINDOW_FRAME (w));
922 enum window_part part;
923 int ux = FRAME_COLUMN_WIDTH (f);
924 int left_x = WINDOW_LEFT_EDGE_X (w);
925 int right_x = WINDOW_RIGHT_EDGE_X (w);
926 int top_y = WINDOW_TOP_EDGE_Y (w);
927 int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
928 /* The width of the area where the vertical line can be dragged.
929 (Between mode lines for instance. */
930 int grabbable_width = ux;
931 int lmargin_width, rmargin_width, text_left, text_right;
932
933 /* Outside any interesting row or column? */
934 if (y < top_y || y >= bottom_y || x < left_x || x >= right_x)
935 return ON_NOTHING;
936
937 /* On the mode line or header line? */
938 if ((WINDOW_WANTS_MODELINE_P (w)
939 && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
940 && (part = ON_MODE_LINE))
941 || (WINDOW_WANTS_HEADER_LINE_P (w)
942 && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
943 && (part = ON_HEADER_LINE)))
944 {
945 /* If it's under/over the scroll bar portion of the mode/header
946 line, say it's on the vertical line. That's to be able to
947 resize windows horizontally in case we're using toolkit scroll
948 bars. Note: If scrollbars are on the left, the window that
949 must be eventually resized is that on the left of WINDOW. */
950 if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
951 && !WINDOW_LEFTMOST_P (w)
952 && eabs (x - left_x) < grabbable_width)
953 || (!WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
954 && !WINDOW_RIGHTMOST_P (w)
955 && eabs (x - right_x) < grabbable_width))
956 return ON_VERTICAL_BORDER;
957 else
958 return part;
959 }
960
961 /* In what's below, we subtract 1 when computing right_x because we
962 want the rightmost pixel, which is given by left_pixel+width-1. */
963 if (w->pseudo_window_p)
964 {
965 left_x = 0;
966 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
967 }
968 else
969 {
970 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
971 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
972 }
973
974 /* Outside any interesting column? */
975 if (x < left_x || x > right_x)
976 return ON_SCROLL_BAR;
977
978 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
979 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
980
981 text_left = window_box_left (w, TEXT_AREA);
982 text_right = text_left + window_box_width (w, TEXT_AREA);
983
984 if (FRAME_WINDOW_P (f))
985 {
986 if (!w->pseudo_window_p
987 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
988 && !WINDOW_RIGHTMOST_P (w)
989 && (eabs (x - right_x) < grabbable_width))
990 return ON_VERTICAL_BORDER;
991 }
992 /* Need to say "x > right_x" rather than >=, since on character
993 terminals, the vertical line's x coordinate is right_x. */
994 else if (!w->pseudo_window_p
995 && !WINDOW_RIGHTMOST_P (w)
996 && x > right_x - ux)
997 return ON_VERTICAL_BORDER;
998
999 if (x < text_left)
1000 {
1001 if (lmargin_width > 0
1002 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1003 ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
1004 : (x < left_x + lmargin_width)))
1005 return ON_LEFT_MARGIN;
1006
1007 return ON_LEFT_FRINGE;
1008 }
1009
1010 if (x >= text_right)
1011 {
1012 if (rmargin_width > 0
1013 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1014 ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
1015 : (x >= right_x - rmargin_width)))
1016 return ON_RIGHT_MARGIN;
1017
1018 return ON_RIGHT_FRINGE;
1019 }
1020
1021 /* Everything special ruled out - must be on text area */
1022 return ON_TEXT;
1023 }
1024
1025 /* Take X is the frame-relative pixel x-coordinate, and return the
1026 x-coordinate relative to part PART of window W. */
1027 int
1028 window_relative_x_coord (struct window *w, enum window_part part, int x)
1029 {
1030 int left_x = (w->pseudo_window_p) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w);
1031
1032 switch (part)
1033 {
1034 case ON_TEXT:
1035 return x - window_box_left (w, TEXT_AREA);
1036
1037 case ON_LEFT_FRINGE:
1038 return x - left_x;
1039
1040 case ON_RIGHT_FRINGE:
1041 return x - left_x - WINDOW_LEFT_FRINGE_WIDTH (w);
1042
1043 case ON_LEFT_MARGIN:
1044 return (x - left_x
1045 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1046 ? WINDOW_LEFT_FRINGE_WIDTH (w) : 0));
1047
1048 case ON_RIGHT_MARGIN:
1049 return (x + 1
1050 - ((w->pseudo_window_p)
1051 ? WINDOW_TOTAL_WIDTH (w)
1052 : WINDOW_BOX_RIGHT_EDGE_X (w))
1053 + window_box_width (w, RIGHT_MARGIN_AREA)
1054 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1055 ? WINDOW_RIGHT_FRINGE_WIDTH (w) : 0));
1056 }
1057
1058 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
1059 return 0;
1060 }
1061
1062
1063 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
1064 Scoordinates_in_window_p, 2, 2, 0,
1065 doc: /* Return non-nil if COORDINATES are in WINDOW.
1066 COORDINATES is a cons of the form (X . Y), X and Y being distances
1067 measured in characters from the upper-left corner of the frame.
1068 \(0 . 0) denotes the character in the upper left corner of the
1069 frame.
1070 If COORDINATES are in the text portion of WINDOW,
1071 the coordinates relative to the window are returned.
1072 If they are in the mode line of WINDOW, `mode-line' is returned.
1073 If they are in the top mode line of WINDOW, `header-line' is returned.
1074 If they are in the left fringe of WINDOW, `left-fringe' is returned.
1075 If they are in the right fringe of WINDOW, `right-fringe' is returned.
1076 If they are on the border between WINDOW and its right sibling,
1077 `vertical-line' is returned.
1078 If they are in the windows's left or right marginal areas, `left-margin'\n\
1079 or `right-margin' is returned. */)
1080 (register Lisp_Object coordinates, Lisp_Object window)
1081 {
1082 struct window *w;
1083 struct frame *f;
1084 int x, y;
1085 Lisp_Object lx, ly;
1086
1087 CHECK_WINDOW (window);
1088 w = XWINDOW (window);
1089 f = XFRAME (w->frame);
1090 CHECK_CONS (coordinates);
1091 lx = Fcar (coordinates);
1092 ly = Fcdr (coordinates);
1093 CHECK_NUMBER_OR_FLOAT (lx);
1094 CHECK_NUMBER_OR_FLOAT (ly);
1095 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
1096 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
1097
1098 switch (coordinates_in_window (w, x, y))
1099 {
1100 case ON_NOTHING:
1101 return Qnil;
1102
1103 case ON_TEXT:
1104 /* Convert X and Y to window relative pixel coordinates, and
1105 return the canonical char units. */
1106 x -= window_box_left (w, TEXT_AREA);
1107 y -= WINDOW_TOP_EDGE_Y (w);
1108 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
1109 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
1110
1111 case ON_MODE_LINE:
1112 return Qmode_line;
1113
1114 case ON_VERTICAL_BORDER:
1115 return Qvertical_line;
1116
1117 case ON_HEADER_LINE:
1118 return Qheader_line;
1119
1120 case ON_LEFT_FRINGE:
1121 return Qleft_fringe;
1122
1123 case ON_RIGHT_FRINGE:
1124 return Qright_fringe;
1125
1126 case ON_LEFT_MARGIN:
1127 return Qleft_margin;
1128
1129 case ON_RIGHT_MARGIN:
1130 return Qright_margin;
1131
1132 case ON_SCROLL_BAR:
1133 /* Historically we are supposed to return nil in this case. */
1134 return Qnil;
1135
1136 default:
1137 abort ();
1138 }
1139 }
1140
1141
1142 /* Callback for foreach_window, used in window_from_coordinates.
1143 Check if window W contains coordinates specified by USER_DATA which
1144 is actually a pointer to a struct check_window_data CW.
1145
1146 Check if window W contains coordinates *CW->x and *CW->y. If it
1147 does, return W in *CW->window, as Lisp_Object, and return in
1148 *CW->part the part of the window under coordinates *X,*Y. Return
1149 zero from this function to stop iterating over windows. */
1150
1151 struct check_window_data
1152 {
1153 Lisp_Object *window;
1154 int x, y;
1155 enum window_part *part;
1156 };
1157
1158 static int
1159 check_window_containing (struct window *w, void *user_data)
1160 {
1161 struct check_window_data *cw = (struct check_window_data *) user_data;
1162 enum window_part found;
1163 int continue_p = 1;
1164
1165 found = coordinates_in_window (w, cw->x, cw->y);
1166 if (found != ON_NOTHING)
1167 {
1168 *cw->part = found;
1169 XSETWINDOW (*cw->window, w);
1170 continue_p = 0;
1171 }
1172
1173 return continue_p;
1174 }
1175
1176
1177 /* Find the window containing frame-relative pixel position X/Y and
1178 return it as a Lisp_Object.
1179
1180 If X, Y is on one of the window's special `window_part' elements,
1181 set *PART to the id of that element.
1182
1183 If there is no window under X, Y return nil and leave *PART
1184 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1185
1186 This function was previously implemented with a loop cycling over
1187 windows with Fnext_window, and starting with the frame's selected
1188 window. It turned out that this doesn't work with an
1189 implementation of next_window using Vwindow_list, because
1190 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1191 tree of F when this function is called asynchronously from
1192 note_mouse_highlight. The original loop didn't terminate in this
1193 case. */
1194
1195 Lisp_Object
1196 window_from_coordinates (struct frame *f, int x, int y,
1197 enum window_part *part, int tool_bar_p)
1198 {
1199 Lisp_Object window;
1200 struct check_window_data cw;
1201 enum window_part dummy;
1202
1203 if (part == 0)
1204 part = &dummy;
1205
1206 window = Qnil;
1207 cw.window = &window, cw.x = x, cw.y = y; cw.part = part;
1208 foreach_window (f, check_window_containing, &cw);
1209
1210 /* If not found above, see if it's in the tool bar window, if a tool
1211 bar exists. */
1212 if (NILP (window)
1213 && tool_bar_p
1214 && WINDOWP (f->tool_bar_window)
1215 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1216 && (coordinates_in_window (XWINDOW (f->tool_bar_window), x, y)
1217 != ON_NOTHING))
1218 {
1219 *part = ON_TEXT;
1220 window = f->tool_bar_window;
1221 }
1222
1223 return window;
1224 }
1225
1226 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1227 doc: /* Return window containing coordinates X and Y on FRAME.
1228 FRAME must be a live frame and defaults to the selected one.
1229 The top left corner of the frame is considered to be row 0,
1230 column 0. */)
1231 (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
1232 {
1233 struct frame *f;
1234
1235 if (NILP (frame))
1236 frame = selected_frame;
1237 CHECK_LIVE_FRAME (frame);
1238 f = XFRAME (frame);
1239
1240 /* Check that arguments are integers or floats. */
1241 CHECK_NUMBER_OR_FLOAT (x);
1242 CHECK_NUMBER_OR_FLOAT (y);
1243
1244 return window_from_coordinates (f,
1245 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1246 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1247 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1248 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1249 0, 0);
1250 }
1251
1252 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1253 doc: /* Return current value of point in WINDOW.
1254 WINDOW must be a live window and defaults to the selected one.
1255
1256 For a nonselected window, this is the value point would have
1257 if that window were selected.
1258
1259 Note that, when WINDOW is the selected window and its buffer
1260 is also currently selected, the value returned is the same as (point).
1261 It would be more strictly correct to return the `top-level' value
1262 of point, outside of any save-excursion forms.
1263 But that is hard to define. */)
1264 (Lisp_Object window)
1265 {
1266 register struct window *w = decode_window (window);
1267
1268 if (w == XWINDOW (selected_window)
1269 && current_buffer == XBUFFER (w->buffer))
1270 return Fpoint ();
1271 return Fmarker_position (w->pointm);
1272 }
1273
1274 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1275 doc: /* Return position at which display currently starts in WINDOW.
1276 WINDOW must be a live window and defaults to the selected one.
1277 This is updated by redisplay or by calling `set-window-start'. */)
1278 (Lisp_Object window)
1279 {
1280 return Fmarker_position (decode_window (window)->start);
1281 }
1282
1283 /* This is text temporarily removed from the doc string below.
1284
1285 This function returns nil if the position is not currently known.
1286 That happens when redisplay is preempted and doesn't finish.
1287 If in that case you want to compute where the end of the window would
1288 have been if redisplay had finished, do this:
1289 (save-excursion
1290 (goto-char (window-start window))
1291 (vertical-motion (1- (window-height window)) window)
1292 (point))") */
1293
1294 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1295 doc: /* Return position at which display currently ends in WINDOW.
1296 WINDOW must be a live window and defaults to the selected one.
1297 This is updated by redisplay, when it runs to completion.
1298 Simply changing the buffer text or setting `window-start'
1299 does not update this value.
1300 Return nil if there is no recorded value. \(This can happen if the
1301 last redisplay of WINDOW was preempted, and did not finish.)
1302 If UPDATE is non-nil, compute the up-to-date position
1303 if it isn't already recorded. */)
1304 (Lisp_Object window, Lisp_Object update)
1305 {
1306 Lisp_Object value;
1307 struct window *w = decode_window (window);
1308 Lisp_Object buf;
1309 struct buffer *b;
1310
1311 buf = w->buffer;
1312 CHECK_BUFFER (buf);
1313 b = XBUFFER (buf);
1314
1315 #if 0 /* This change broke some things. We should make it later. */
1316 /* If we don't know the end position, return nil.
1317 The user can compute it with vertical-motion if he wants to.
1318 It would be nicer to do it automatically,
1319 but that's so slow that it would probably bother people. */
1320 if (NILP (w->window_end_valid))
1321 return Qnil;
1322 #endif
1323
1324 if (! NILP (update)
1325 && ! (! NILP (w->window_end_valid)
1326 && XFASTINT (w->last_modified) >= BUF_MODIFF (b)
1327 && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (b))
1328 && !noninteractive)
1329 {
1330 struct text_pos startp;
1331 struct it it;
1332 struct buffer *old_buffer = NULL;
1333 void *itdata = NULL;
1334
1335 /* Cannot use Fvertical_motion because that function doesn't
1336 cope with variable-height lines. */
1337 if (b != current_buffer)
1338 {
1339 old_buffer = current_buffer;
1340 set_buffer_internal (b);
1341 }
1342
1343 /* In case W->start is out of the range, use something
1344 reasonable. This situation occurred when loading a file with
1345 `-l' containing a call to `rmail' with subsequent other
1346 commands. At the end, W->start happened to be BEG, while
1347 rmail had already narrowed the buffer. */
1348 if (XMARKER (w->start)->charpos < BEGV)
1349 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1350 else if (XMARKER (w->start)->charpos > ZV)
1351 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1352 else
1353 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1354
1355 itdata = bidi_shelve_cache ();
1356 start_display (&it, w, startp);
1357 move_it_vertically (&it, window_box_height (w));
1358 if (it.current_y < it.last_visible_y)
1359 move_it_past_eol (&it);
1360 value = make_number (IT_CHARPOS (it));
1361 bidi_unshelve_cache (itdata, 0);
1362
1363 if (old_buffer)
1364 set_buffer_internal (old_buffer);
1365 }
1366 else
1367 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1368
1369 return value;
1370 }
1371
1372 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1373 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1374 Return POS. */)
1375 (Lisp_Object window, Lisp_Object pos)
1376 {
1377 register struct window *w = decode_window (window);
1378
1379 CHECK_NUMBER_COERCE_MARKER (pos);
1380 if (w == XWINDOW (selected_window)
1381 && XBUFFER (w->buffer) == current_buffer)
1382 Fgoto_char (pos);
1383 else
1384 set_marker_restricted (w->pointm, pos, w->buffer);
1385
1386 /* We have to make sure that redisplay updates the window to show
1387 the new value of point. */
1388 if (!EQ (window, selected_window))
1389 ++windows_or_buffers_changed;
1390
1391 return pos;
1392 }
1393
1394 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1395 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1396 If WINDOW is nil, the selected window is used. Return POS.
1397 Optional third arg NOFORCE non-nil inhibits next redisplay from
1398 overriding motion of point in order to display at this exact start. */)
1399 (Lisp_Object window, Lisp_Object pos, Lisp_Object noforce)
1400 {
1401 register struct window *w = decode_window (window);
1402
1403 CHECK_NUMBER_COERCE_MARKER (pos);
1404 set_marker_restricted (w->start, pos, w->buffer);
1405 /* this is not right, but much easier than doing what is right. */
1406 w->start_at_line_beg = Qnil;
1407 if (NILP (noforce))
1408 w->force_start = Qt;
1409 w->update_mode_line = Qt;
1410 XSETFASTINT (w->last_modified, 0);
1411 XSETFASTINT (w->last_overlay_modified, 0);
1412 if (!EQ (window, selected_window))
1413 windows_or_buffers_changed++;
1414
1415 return pos;
1416 }
1417
1418 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
1419 Spos_visible_in_window_p, 0, 3, 0,
1420 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
1421 Return nil if that position is scrolled vertically out of view.
1422 If a character is only partially visible, nil is returned, unless the
1423 optional argument PARTIALLY is non-nil.
1424 If POS is only out of view because of horizontal scrolling, return non-nil.
1425 If POS is t, it specifies the position of the last visible glyph in WINDOW.
1426 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
1427
1428 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
1429 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
1430 where X and Y are the pixel coordinates relative to the top left corner
1431 of the window. The remaining elements are omitted if the character after
1432 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
1433 off-window at the top and bottom of the row, ROWH is the height of the
1434 display row, and VPOS is the row number (0-based) containing POS. */)
1435 (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
1436 {
1437 register struct window *w;
1438 register EMACS_INT posint;
1439 register struct buffer *buf;
1440 struct text_pos top;
1441 Lisp_Object in_window = Qnil;
1442 int rtop, rbot, rowh, vpos, fully_p = 1;
1443 int x, y;
1444
1445 w = decode_window (window);
1446 buf = XBUFFER (w->buffer);
1447 SET_TEXT_POS_FROM_MARKER (top, w->start);
1448
1449 if (EQ (pos, Qt))
1450 posint = -1;
1451 else if (!NILP (pos))
1452 {
1453 CHECK_NUMBER_COERCE_MARKER (pos);
1454 posint = XINT (pos);
1455 }
1456 else if (w == XWINDOW (selected_window))
1457 posint = PT;
1458 else
1459 posint = XMARKER (w->pointm)->charpos;
1460
1461 /* If position is above window start or outside buffer boundaries,
1462 or if window start is out of range, position is not visible. */
1463 if ((EQ (pos, Qt)
1464 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
1465 && CHARPOS (top) >= BUF_BEGV (buf)
1466 && CHARPOS (top) <= BUF_ZV (buf)
1467 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
1468 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
1469 in_window = Qt;
1470
1471 if (!NILP (in_window) && !NILP (partially))
1472 {
1473 Lisp_Object part = Qnil;
1474 if (!fully_p)
1475 part = list4 (make_number (rtop), make_number (rbot),
1476 make_number (rowh), make_number (vpos));
1477 in_window = Fcons (make_number (x),
1478 Fcons (make_number (y), part));
1479 }
1480
1481 return in_window;
1482 }
1483
1484 DEFUN ("window-line-height", Fwindow_line_height,
1485 Swindow_line_height, 0, 2, 0,
1486 doc: /* Return height in pixels of text line LINE in window WINDOW.
1487 WINDOW defaults to the selected window.
1488
1489 Return height of current line if LINE is omitted or nil. Return height of
1490 header or mode line if LINE is `header-line' or `mode-line'.
1491 Otherwise, LINE is a text line number starting from 0. A negative number
1492 counts from the end of the window.
1493
1494 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
1495 in pixels of the visible part of the line, VPOS and YPOS are the
1496 vertical position in lines and pixels of the line, relative to the top
1497 of the first text line, and OFFBOT is the number of off-window pixels at
1498 the bottom of the text line. If there are off-window pixels at the top
1499 of the (first) text line, YPOS is negative.
1500
1501 Return nil if window display is not up-to-date. In that case, use
1502 `pos-visible-in-window-p' to obtain the information. */)
1503 (Lisp_Object line, Lisp_Object window)
1504 {
1505 register struct window *w;
1506 register struct buffer *b;
1507 struct glyph_row *row, *end_row;
1508 int max_y, crop, i, n;
1509
1510 w = decode_window (window);
1511
1512 if (noninteractive || w->pseudo_window_p)
1513 return Qnil;
1514
1515 CHECK_BUFFER (w->buffer);
1516 b = XBUFFER (w->buffer);
1517
1518 /* Fail if current matrix is not up-to-date. */
1519 if (NILP (w->window_end_valid)
1520 || current_buffer->clip_changed
1521 || current_buffer->prevent_redisplay_optimizations_p
1522 || XFASTINT (w->last_modified) < BUF_MODIFF (b)
1523 || XFASTINT (w->last_overlay_modified) < BUF_OVERLAY_MODIFF (b))
1524 return Qnil;
1525
1526 if (NILP (line))
1527 {
1528 i = w->cursor.vpos;
1529 if (i < 0 || i >= w->current_matrix->nrows
1530 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
1531 return Qnil;
1532 max_y = window_text_bottom_y (w);
1533 goto found_row;
1534 }
1535
1536 if (EQ (line, Qheader_line))
1537 {
1538 if (!WINDOW_WANTS_HEADER_LINE_P (w))
1539 return Qnil;
1540 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
1541 if (!row->enabled_p)
1542 return Qnil;
1543 return list4 (make_number (row->height),
1544 make_number (0), make_number (0),
1545 make_number (0));
1546 }
1547
1548 if (EQ (line, Qmode_line))
1549 {
1550 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
1551 if (!row->enabled_p)
1552 return Qnil;
1553 return list4 (make_number (row->height),
1554 make_number (0), /* not accurate */
1555 make_number (WINDOW_HEADER_LINE_HEIGHT (w)
1556 + window_text_bottom_y (w)),
1557 make_number (0));
1558 }
1559
1560 CHECK_NUMBER (line);
1561 n = XINT (line);
1562
1563 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
1564 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
1565 max_y = window_text_bottom_y (w);
1566 i = 0;
1567
1568 while ((n < 0 || i < n)
1569 && row <= end_row && row->enabled_p
1570 && row->y + row->height < max_y)
1571 row++, i++;
1572
1573 if (row > end_row || !row->enabled_p)
1574 return Qnil;
1575
1576 if (++n < 0)
1577 {
1578 if (-n > i)
1579 return Qnil;
1580 row += n;
1581 i += n;
1582 }
1583
1584 found_row:
1585 crop = max (0, (row->y + row->height) - max_y);
1586 return list4 (make_number (row->height + min (0, row->y) - crop),
1587 make_number (i),
1588 make_number (row->y),
1589 make_number (crop));
1590 }
1591
1592 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1593 0, 1, 0,
1594 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1595 More precisely, return the value assigned by the last call of
1596 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1597 never called with WINDOW as its argument, or the value set by that
1598 function was internally reset since its last call. WINDOW defaults to
1599 the selected window.
1600
1601 When a window is dedicated to its buffer, `display-buffer' will refrain
1602 from displaying another buffer in it. `get-lru-window' and
1603 `get-largest-window' treat dedicated windows specially.
1604 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1605 `kill-buffer' can delete a dedicated window and the containing frame.
1606
1607 Functions like `set-window-buffer' may change the buffer displayed by a
1608 window, unless that window is "strongly" dedicated to its buffer, that
1609 is the value returned by `window-dedicated-p' is t. */)
1610 (Lisp_Object window)
1611 {
1612 return decode_window (window)->dedicated;
1613 }
1614
1615 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1616 Sset_window_dedicated_p, 2, 2, 0,
1617 doc: /* Mark WINDOW as dedicated according to FLAG.
1618 WINDOW must be a live window and defaults to the selected one. FLAG
1619 non-nil means mark WINDOW as dedicated to its buffer. FLAG nil means
1620 mark WINDOW as non-dedicated. Return FLAG.
1621
1622 When a window is dedicated to its buffer, `display-buffer' will refrain
1623 from displaying another buffer in it. `get-lru-window' and
1624 `get-largest-window' treat dedicated windows specially.
1625 `delete-windows-on', `replace-buffer-in-windows', `quit-window',
1626 `quit-restore-window' and `kill-buffer' can delete a dedicated window
1627 and the containing frame.
1628
1629 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1630 its buffer. Functions like `set-window-buffer' may change the buffer
1631 displayed by a window, unless that window is strongly dedicated to its
1632 buffer. If and when `set-window-buffer' displays another buffer in a
1633 window, it also makes sure that the window is no more dedicated. */)
1634 (Lisp_Object window, Lisp_Object flag)
1635 {
1636 register struct window *w = decode_window (window);
1637
1638 w->dedicated = flag;
1639 return w->dedicated;
1640 }
1641
1642 DEFUN ("window-prev-buffers", Fwindow_prev_buffers, Swindow_prev_buffers,
1643 0, 1, 0,
1644 doc: /* Return buffers previously shown in WINDOW.
1645 WINDOW must be a live window and defaults to the selected one.
1646
1647 The return value is a list of elements (BUFFER WINDOW-START POS),
1648 where BUFFER is a buffer, WINDOW-START is the start position of the
1649 window for that buffer, and POS is a window-specific point value. */)
1650 (Lisp_Object window)
1651 {
1652 return decode_window (window)->prev_buffers;
1653 }
1654
1655 DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers,
1656 Sset_window_prev_buffers, 2, 2, 0,
1657 doc: /* Set WINDOW's previous buffers to PREV-BUFFERS.
1658 WINDOW must be a live window and defaults to the selected one.
1659
1660 PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
1661 where BUFFER is a buffer, WINDOW-START is the start position of the
1662 window for that buffer, and POS is a window-specific point value. */)
1663 (Lisp_Object window, Lisp_Object prev_buffers)
1664 {
1665 return decode_window (window)->prev_buffers = prev_buffers;
1666 }
1667
1668 DEFUN ("window-next-buffers", Fwindow_next_buffers, Swindow_next_buffers,
1669 0, 1, 0,
1670 doc: /* Return list of buffers recently re-shown in WINDOW.
1671 WINDOW must be a live window and defaults to the selected one. */)
1672 (Lisp_Object window)
1673 {
1674 return decode_window (window)->next_buffers;
1675 }
1676
1677 DEFUN ("set-window-next-buffers", Fset_window_next_buffers,
1678 Sset_window_next_buffers, 2, 2, 0,
1679 doc: /* Set WINDOW's next buffers to NEXT-BUFFERS.
1680 WINDOW must be a live window and defaults to the selected one.
1681 NEXT-BUFFERS should be a list of buffers. */)
1682 (Lisp_Object window, Lisp_Object next_buffers)
1683 {
1684 return decode_window (window)->next_buffers = next_buffers;
1685 }
1686
1687 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1688 0, 1, 0,
1689 doc: /* Return the parameters of WINDOW and their values.
1690 WINDOW defaults to the selected window. The return value is a list of
1691 elements of the form (PARAMETER . VALUE). */)
1692 (Lisp_Object window)
1693 {
1694 return Fcopy_alist (decode_any_window (window)->window_parameters);
1695 }
1696
1697 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1698 2, 2, 0,
1699 doc: /* Return WINDOW's value for PARAMETER.
1700 WINDOW defaults to the selected window. */)
1701 (Lisp_Object window, Lisp_Object parameter)
1702 {
1703 Lisp_Object result;
1704
1705 result = Fassq (parameter, decode_any_window (window)->window_parameters);
1706 return CDR_SAFE (result);
1707 }
1708
1709 DEFUN ("set-window-parameter", Fset_window_parameter,
1710 Sset_window_parameter, 3, 3, 0,
1711 doc: /* Set WINDOW's value of PARAMETER to VALUE.
1712 WINDOW defaults to the selected window. Return VALUE. */)
1713 (Lisp_Object window, Lisp_Object parameter, Lisp_Object value)
1714 {
1715 register struct window *w = decode_any_window (window);
1716 Lisp_Object old_alist_elt;
1717
1718 old_alist_elt = Fassq (parameter, w->window_parameters);
1719 if (NILP (old_alist_elt))
1720 w->window_parameters = Fcons (Fcons (parameter, value), w->window_parameters);
1721 else
1722 Fsetcdr (old_alist_elt, value);
1723 return value;
1724 }
1725
1726 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1727 0, 1, 0,
1728 doc: /* Return the display-table that WINDOW is using.
1729 WINDOW defaults to the selected window. */)
1730 (Lisp_Object window)
1731 {
1732 return decode_window (window)->display_table;
1733 }
1734
1735 /* Get the display table for use on window W. This is either W's
1736 display table or W's buffer's display table. Ignore the specified
1737 tables if they are not valid; if no valid table is specified,
1738 return 0. */
1739
1740 struct Lisp_Char_Table *
1741 window_display_table (struct window *w)
1742 {
1743 struct Lisp_Char_Table *dp = NULL;
1744
1745 if (DISP_TABLE_P (w->display_table))
1746 dp = XCHAR_TABLE (w->display_table);
1747 else if (BUFFERP (w->buffer))
1748 {
1749 struct buffer *b = XBUFFER (w->buffer);
1750
1751 if (DISP_TABLE_P (BVAR (b, display_table)))
1752 dp = XCHAR_TABLE (BVAR (b, display_table));
1753 else if (DISP_TABLE_P (Vstandard_display_table))
1754 dp = XCHAR_TABLE (Vstandard_display_table);
1755 }
1756
1757 return dp;
1758 }
1759
1760 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1761 doc: /* Set WINDOW's display-table to TABLE. */)
1762 (register Lisp_Object window, Lisp_Object table)
1763 {
1764 register struct window *w;
1765
1766 w = decode_window (window);
1767 w->display_table = table;
1768 return table;
1769 }
1770 \f
1771 /* Record info on buffer window W is displaying
1772 when it is about to cease to display that buffer. */
1773 static void
1774 unshow_buffer (register struct window *w)
1775 {
1776 Lisp_Object buf;
1777 struct buffer *b;
1778
1779 buf = w->buffer;
1780 b = XBUFFER (buf);
1781 if (b != XMARKER (w->pointm)->buffer)
1782 abort ();
1783
1784 #if 0
1785 if (w == XWINDOW (selected_window)
1786 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1787 /* Do this except when the selected window's buffer
1788 is being removed from some other window. */
1789 #endif
1790 /* last_window_start records the start position that this buffer
1791 had in the last window to be disconnected from it.
1792 Now that this statement is unconditional,
1793 it is possible for the buffer to be displayed in the
1794 selected window, while last_window_start reflects another
1795 window which was recently showing the same buffer.
1796 Some people might say that might be a good thing. Let's see. */
1797 b->last_window_start = marker_position (w->start);
1798
1799 /* Point in the selected window's buffer
1800 is actually stored in that buffer, and the window's pointm isn't used.
1801 So don't clobber point in that buffer. */
1802 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1803 /* This line helps to fix Horsley's testbug.el bug. */
1804 && !(WINDOWP (BVAR (b, last_selected_window))
1805 && w != XWINDOW (BVAR (b, last_selected_window))
1806 && EQ (buf, XWINDOW (BVAR (b, last_selected_window))->buffer)))
1807 temp_set_point_both (b,
1808 clip_to_bounds (BUF_BEGV (b),
1809 XMARKER (w->pointm)->charpos,
1810 BUF_ZV (b)),
1811 clip_to_bounds (BUF_BEGV_BYTE (b),
1812 marker_byte_position (w->pointm),
1813 BUF_ZV_BYTE (b)));
1814
1815 if (WINDOWP (BVAR (b, last_selected_window))
1816 && w == XWINDOW (BVAR (b, last_selected_window)))
1817 BVAR (b, last_selected_window) = Qnil;
1818 }
1819
1820 /* Put NEW into the window structure in place of OLD. SETFLAG zero
1821 means change window structure only. Otherwise store geometry and
1822 other settings as well. */
1823 static void
1824 replace_window (Lisp_Object old, Lisp_Object new, int setflag)
1825 {
1826 register Lisp_Object tem;
1827 register struct window *o = XWINDOW (old), *n = XWINDOW (new);
1828
1829 /* If OLD is its frame's root window, then NEW is the new
1830 root window for that frame. */
1831 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1832 FRAME_ROOT_WINDOW (XFRAME (o->frame)) = new;
1833
1834 if (setflag)
1835 {
1836 n->left_col = o->left_col;
1837 n->top_line = o->top_line;
1838 n->total_cols = o->total_cols;
1839 n->total_lines = o->total_lines;
1840 n->normal_cols = o->normal_cols;
1841 o->normal_cols = make_float (1.0);
1842 n->normal_lines = o->normal_lines;
1843 o->normal_lines = make_float (1.0);
1844 n->desired_matrix = n->current_matrix = 0;
1845 n->vscroll = 0;
1846 memset (&n->cursor, 0, sizeof (n->cursor));
1847 memset (&n->last_cursor, 0, sizeof (n->last_cursor));
1848 memset (&n->phys_cursor, 0, sizeof (n->phys_cursor));
1849 n->phys_cursor_type = -1;
1850 n->phys_cursor_width = -1;
1851 n->must_be_updated_p = 0;
1852 n->pseudo_window_p = 0;
1853 XSETFASTINT (n->window_end_vpos, 0);
1854 XSETFASTINT (n->window_end_pos, 0);
1855 n->window_end_valid = Qnil;
1856 n->frozen_window_start_p = 0;
1857 }
1858
1859 n->next = tem = o->next;
1860 if (!NILP (tem))
1861 XWINDOW (tem)->prev = new;
1862
1863 n->prev = tem = o->prev;
1864 if (!NILP (tem))
1865 XWINDOW (tem)->next = new;
1866
1867 n->parent = tem = o->parent;
1868 if (!NILP (tem))
1869 {
1870 if (EQ (XWINDOW (tem)->vchild, old))
1871 XWINDOW (tem)->vchild = new;
1872 if (EQ (XWINDOW (tem)->hchild, old))
1873 XWINDOW (tem)->hchild = new;
1874 }
1875 }
1876
1877 /* If window WINDOW and its parent window are iso-combined, merge
1878 WINDOW's children into those of its parent window and mark WINDOW as
1879 deleted. */
1880
1881 static void
1882 recombine_windows (Lisp_Object window)
1883 {
1884 struct window *w, *p, *c;
1885 Lisp_Object parent, child;
1886 int horflag;
1887
1888 w = XWINDOW (window);
1889 parent = w->parent;
1890 if (!NILP (parent) && NILP (w->nest))
1891 {
1892 p = XWINDOW (parent);
1893 if (((!NILP (p->vchild) && !NILP (w->vchild))
1894 || (!NILP (p->hchild) && !NILP (w->hchild))))
1895 /* WINDOW and PARENT are both either a vertical or a horizontal
1896 combination. */
1897 {
1898 horflag = NILP (w->vchild);
1899 child = horflag ? w->hchild : w->vchild;
1900 c = XWINDOW (child);
1901
1902 /* Splice WINDOW's children into its parent's children and
1903 assign new normal sizes. */
1904 if (NILP (w->prev))
1905 if (horflag)
1906 p->hchild = child;
1907 else
1908 p->vchild = child;
1909 else
1910 {
1911 c->prev = w->prev;
1912 XWINDOW (w->prev)->next = child;
1913 }
1914
1915 while (c)
1916 {
1917 c->parent = parent;
1918
1919 if (horflag)
1920 c->normal_cols
1921 = make_float (XFLOATINT (c->total_cols)
1922 / XFLOATINT (p->total_cols));
1923 else
1924 c->normal_lines
1925 = make_float (XFLOATINT (c->total_lines)
1926 / XFLOATINT (p->total_lines));
1927
1928 if (NILP (c->next))
1929 {
1930 if (!NILP (w->next))
1931 {
1932 c->next = w->next;
1933 XWINDOW (c->next)->prev = child;
1934 }
1935
1936 c = 0;
1937 }
1938 else
1939 {
1940 child = c->next;
1941 c = XWINDOW (child);
1942 }
1943 }
1944
1945 /* WINDOW can be deleted now. */
1946 w->vchild = w->hchild = Qnil;
1947 }
1948 }
1949 }
1950
1951 /* If WINDOW can be deleted, delete it. */
1952 static void
1953 delete_deletable_window (Lisp_Object window)
1954 {
1955 if (!NILP (call1 (Qwindow_deletable_p, window)))
1956 call1 (Qdelete_window, window);
1957 }
1958 \f
1959 /***********************************************************************
1960 Window List
1961 ***********************************************************************/
1962
1963 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
1964 pointer. This is a callback function for foreach_window, used in
1965 the window_list function. */
1966
1967 static int
1968 add_window_to_list (struct window *w, void *user_data)
1969 {
1970 Lisp_Object *list = (Lisp_Object *) user_data;
1971 Lisp_Object window;
1972 XSETWINDOW (window, w);
1973 *list = Fcons (window, *list);
1974 return 1;
1975 }
1976
1977
1978 /* Return a list of all windows, for use by next_window. If
1979 Vwindow_list is a list, return that list. Otherwise, build a new
1980 list, cache it in Vwindow_list, and return that. */
1981
1982 static Lisp_Object
1983 window_list (void)
1984 {
1985 if (!CONSP (Vwindow_list))
1986 {
1987 Lisp_Object tail;
1988
1989 Vwindow_list = Qnil;
1990 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1991 {
1992 Lisp_Object args[2];
1993
1994 /* We are visiting windows in canonical order, and add
1995 new windows at the front of args[1], which means we
1996 have to reverse this list at the end. */
1997 args[1] = Qnil;
1998 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
1999 args[0] = Vwindow_list;
2000 args[1] = Fnreverse (args[1]);
2001 Vwindow_list = Fnconc (2, args);
2002 }
2003 }
2004
2005 return Vwindow_list;
2006 }
2007
2008
2009 /* Value is non-zero if WINDOW satisfies the constraints given by
2010 OWINDOW, MINIBUF and ALL_FRAMES.
2011
2012 MINIBUF t means WINDOW may be minibuffer windows.
2013 `lambda' means WINDOW may not be a minibuffer window.
2014 a window means a specific minibuffer window
2015
2016 ALL_FRAMES t means search all frames,
2017 nil means search just current frame,
2018 `visible' means search just visible frames on the
2019 current terminal,
2020 0 means search visible and iconified frames on the
2021 current terminal,
2022 a window means search the frame that window belongs to,
2023 a frame means consider windows on that frame, only. */
2024
2025 static int
2026 candidate_window_p (Lisp_Object window, Lisp_Object owindow, Lisp_Object minibuf, Lisp_Object all_frames)
2027 {
2028 struct window *w = XWINDOW (window);
2029 struct frame *f = XFRAME (w->frame);
2030 int candidate_p = 1;
2031
2032 if (!BUFFERP (w->buffer))
2033 candidate_p = 0;
2034 else if (MINI_WINDOW_P (w)
2035 && (EQ (minibuf, Qlambda)
2036 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
2037 {
2038 /* If MINIBUF is `lambda' don't consider any mini-windows.
2039 If it is a window, consider only that one. */
2040 candidate_p = 0;
2041 }
2042 else if (EQ (all_frames, Qt))
2043 candidate_p = 1;
2044 else if (NILP (all_frames))
2045 {
2046 xassert (WINDOWP (owindow));
2047 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
2048 }
2049 else if (EQ (all_frames, Qvisible))
2050 {
2051 FRAME_SAMPLE_VISIBILITY (f);
2052 candidate_p = FRAME_VISIBLE_P (f)
2053 && (FRAME_TERMINAL (XFRAME (w->frame))
2054 == FRAME_TERMINAL (XFRAME (selected_frame)));
2055
2056 }
2057 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
2058 {
2059 FRAME_SAMPLE_VISIBILITY (f);
2060 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
2061 #ifdef HAVE_X_WINDOWS
2062 /* Yuck!! If we've just created the frame and the
2063 window-manager requested the user to place it
2064 manually, the window may still not be considered
2065 `visible'. I'd argue it should be at least
2066 something like `iconified', but don't know how to do
2067 that yet. --Stef */
2068 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
2069 && !f->output_data.x->has_been_visible)
2070 #endif
2071 )
2072 && (FRAME_TERMINAL (XFRAME (w->frame))
2073 == FRAME_TERMINAL (XFRAME (selected_frame)));
2074 }
2075 else if (WINDOWP (all_frames))
2076 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
2077 || EQ (XWINDOW (all_frames)->frame, w->frame)
2078 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
2079 else if (FRAMEP (all_frames))
2080 candidate_p = EQ (all_frames, w->frame);
2081
2082 return candidate_p;
2083 }
2084
2085
2086 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
2087 Fwindow_list. See candidate_window_p for the meaning of WINDOW,
2088 MINIBUF, and ALL_FRAMES. */
2089
2090 static void
2091 decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object *all_frames)
2092 {
2093 if (NILP (*window))
2094 *window = selected_window;
2095 else
2096 CHECK_LIVE_WINDOW (*window);
2097
2098 /* MINIBUF nil may or may not include minibuffers. Decide if it
2099 does. */
2100 if (NILP (*minibuf))
2101 *minibuf = minibuf_level ? minibuf_window : Qlambda;
2102 else if (!EQ (*minibuf, Qt))
2103 *minibuf = Qlambda;
2104
2105 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
2106 => count none of them, or a specific minibuffer window (the
2107 active one) to count. */
2108
2109 /* ALL_FRAMES nil doesn't specify which frames to include. */
2110 if (NILP (*all_frames))
2111 *all_frames = (!EQ (*minibuf, Qlambda)
2112 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
2113 : Qnil);
2114 else if (EQ (*all_frames, Qvisible))
2115 ;
2116 else if (EQ (*all_frames, make_number (0)))
2117 ;
2118 else if (FRAMEP (*all_frames))
2119 ;
2120 else if (!EQ (*all_frames, Qt))
2121 *all_frames = Qnil;
2122 }
2123
2124
2125 /* Return the next or previous window of WINDOW in cyclic ordering
2126 of windows. NEXT_P non-zero means return the next window. See the
2127 documentation string of next-window for the meaning of MINIBUF and
2128 ALL_FRAMES. */
2129
2130 static Lisp_Object
2131 next_window (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames, int next_p)
2132 {
2133 decode_next_window_args (&window, &minibuf, &all_frames);
2134
2135 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
2136 return the first window on the frame. */
2137 if (FRAMEP (all_frames)
2138 && !EQ (all_frames, XWINDOW (window)->frame))
2139 return Fframe_first_window (all_frames);
2140
2141 if (next_p)
2142 {
2143 Lisp_Object list;
2144
2145 /* Find WINDOW in the list of all windows. */
2146 list = Fmemq (window, window_list ());
2147
2148 /* Scan forward from WINDOW to the end of the window list. */
2149 if (CONSP (list))
2150 for (list = XCDR (list); CONSP (list); list = XCDR (list))
2151 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2152 break;
2153
2154 /* Scan from the start of the window list up to WINDOW. */
2155 if (!CONSP (list))
2156 for (list = Vwindow_list;
2157 CONSP (list) && !EQ (XCAR (list), window);
2158 list = XCDR (list))
2159 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2160 break;
2161
2162 if (CONSP (list))
2163 window = XCAR (list);
2164 }
2165 else
2166 {
2167 Lisp_Object candidate, list;
2168
2169 /* Scan through the list of windows for candidates. If there are
2170 candidate windows in front of WINDOW, the last one of these
2171 is the one we want. If there are candidates following WINDOW
2172 in the list, again the last one of these is the one we want. */
2173 candidate = Qnil;
2174 for (list = window_list (); CONSP (list); list = XCDR (list))
2175 {
2176 if (EQ (XCAR (list), window))
2177 {
2178 if (WINDOWP (candidate))
2179 break;
2180 }
2181 else if (candidate_window_p (XCAR (list), window, minibuf,
2182 all_frames))
2183 candidate = XCAR (list);
2184 }
2185
2186 if (WINDOWP (candidate))
2187 window = candidate;
2188 }
2189
2190 return window;
2191 }
2192
2193
2194 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
2195 doc: /* Return window following WINDOW in cyclic ordering of windows.
2196 WINDOW must be a live window and defaults to the selected one. The
2197 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2198 consider.
2199
2200 MINIBUF nil or omitted means consider the minibuffer window only if the
2201 minibuffer is active. MINIBUF t means consider the minibuffer window
2202 even if the minibuffer is not active. Any other value means do not
2203 consider the minibuffer window even if the minibuffer is active.
2204
2205 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2206 plus the minibuffer window if specified by the MINIBUF argument. If the
2207 minibuffer counts, consider all windows on all frames that share that
2208 minibuffer too. The following non-nil values of ALL-FRAMES have special
2209 meanings:
2210
2211 - t means consider all windows on all existing frames.
2212
2213 - `visible' means consider all windows on all visible frames.
2214
2215 - 0 (the number zero) means consider all windows on all visible and
2216 iconified frames.
2217
2218 - A frame means consider all windows on that frame only.
2219
2220 Anything else means consider all windows on WINDOW's frame and no
2221 others.
2222
2223 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2224 `next-window' to iterate through the entire cycle of acceptable
2225 windows, eventually ending up back at the window you started with.
2226 `previous-window' traverses the same cycle, in the reverse order. */)
2227 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2228 {
2229 return next_window (window, minibuf, all_frames, 1);
2230 }
2231
2232
2233 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
2234 doc: /* Return window preceding WINDOW in cyclic ordering of windows.
2235 WINDOW must be a live window and defaults to the selected one. The
2236 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2237 consider.
2238
2239 MINIBUF nil or omitted means consider the minibuffer window only if the
2240 minibuffer is active. MINIBUF t means consider the minibuffer window
2241 even if the minibuffer is not active. Any other value means do not
2242 consider the minibuffer window even if the minibuffer is active.
2243
2244 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2245 plus the minibuffer window if specified by the MINIBUF argument. If the
2246 minibuffer counts, consider all windows on all frames that share that
2247 minibuffer too. The following non-nil values of ALL-FRAMES have special
2248 meanings:
2249
2250 - t means consider all windows on all existing frames.
2251
2252 - `visible' means consider all windows on all visible frames.
2253
2254 - 0 (the number zero) means consider all windows on all visible and
2255 iconified frames.
2256
2257 - A frame means consider all windows on that frame only.
2258
2259 Anything else means consider all windows on WINDOW's frame and no
2260 others.
2261
2262 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2263 use `previous-window' to iterate through the entire cycle of
2264 acceptable windows, eventually ending up back at the window you
2265 started with. `next-window' traverses the same cycle, in the
2266 reverse order. */)
2267 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2268 {
2269 return next_window (window, minibuf, all_frames, 0);
2270 }
2271
2272
2273 /* Return a list of windows in cyclic ordering. Arguments are like
2274 for `next-window'. */
2275
2276 static Lisp_Object
2277 window_list_1 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2278 {
2279 Lisp_Object tail, list, rest;
2280
2281 decode_next_window_args (&window, &minibuf, &all_frames);
2282 list = Qnil;
2283
2284 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2285 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2286 list = Fcons (XCAR (tail), list);
2287
2288 /* Rotate the list to start with WINDOW. */
2289 list = Fnreverse (list);
2290 rest = Fmemq (window, list);
2291 if (!NILP (rest) && !EQ (rest, list))
2292 {
2293 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2294 ;
2295 XSETCDR (tail, Qnil);
2296 list = nconc2 (rest, list);
2297 }
2298 return list;
2299 }
2300
2301
2302 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2303 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2304 FRAME nil or omitted means use the selected frame.
2305 WINDOW nil or omitted means use the selected window.
2306 MINIBUF t means include the minibuffer window, even if it isn't active.
2307 MINIBUF nil or omitted means include the minibuffer window only
2308 if it's active.
2309 MINIBUF neither nil nor t means never include the minibuffer window. */)
2310 (Lisp_Object frame, Lisp_Object minibuf, Lisp_Object window)
2311 {
2312 if (NILP (window))
2313 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2314 CHECK_WINDOW (window);
2315 if (NILP (frame))
2316 frame = selected_frame;
2317
2318 if (!EQ (frame, XWINDOW (window)->frame))
2319 error ("Window is on a different frame");
2320
2321 return window_list_1 (window, minibuf, frame);
2322 }
2323
2324
2325 DEFUN ("window-list-1", Fwindow_list_1, Swindow_list_1, 0, 3, 0,
2326 doc: /* Return a list of all live windows.
2327 WINDOW specifies the first window to list and defaults to the selected
2328 window.
2329
2330 Optional argument MINIBUF nil or omitted means consider the minibuffer
2331 window only if the minibuffer is active. MINIBUF t means consider the
2332 minibuffer window even if the minibuffer is not active. Any other value
2333 means do not consider the minibuffer window even if the minibuffer is
2334 active.
2335
2336 Optional argument ALL-FRAMES nil or omitted means consider all windows
2337 on WINDOW's frame, plus the minibuffer window if specified by the
2338 MINIBUF argument. If the minibuffer counts, consider all windows on all
2339 frames that share that minibuffer too. The following non-nil values of
2340 ALL-FRAMES have special meanings:
2341
2342 - t means consider all windows on all existing frames.
2343
2344 - `visible' means consider all windows on all visible frames.
2345
2346 - 0 (the number zero) means consider all windows on all visible and
2347 iconified frames.
2348
2349 - A frame means consider all windows on that frame only.
2350
2351 Anything else means consider all windows on WINDOW's frame and no
2352 others.
2353
2354 If WINDOW is not on the list of windows returned, some other window will
2355 be listed first but no error is signalled. */)
2356 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2357 {
2358 return window_list_1 (window, minibuf, all_frames);
2359 }
2360 \f
2361 /* Look at all windows, performing an operation specified by TYPE
2362 with argument OBJ.
2363 If FRAMES is Qt, look at all frames;
2364 Qnil, look at just the selected frame;
2365 Qvisible, look at visible frames;
2366 a frame, just look at windows on that frame.
2367 If MINI is non-zero, perform the operation on minibuffer windows too. */
2368
2369 enum window_loop
2370 {
2371 WINDOW_LOOP_UNUSED,
2372 GET_BUFFER_WINDOW, /* Arg is buffer */
2373 REPLACE_BUFFER_IN_WINDOWS_SAFELY, /* Arg is buffer */
2374 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2375 CHECK_ALL_WINDOWS
2376 };
2377
2378 static Lisp_Object
2379 window_loop (enum window_loop type, Lisp_Object obj, int mini, Lisp_Object frames)
2380 {
2381 Lisp_Object window, windows, best_window, frame_arg;
2382 int frame_best_window_flag = 0;
2383 struct frame *f;
2384 struct gcpro gcpro1;
2385
2386 /* If we're only looping through windows on a particular frame,
2387 frame points to that frame. If we're looping through windows
2388 on all frames, frame is 0. */
2389 if (FRAMEP (frames))
2390 f = XFRAME (frames);
2391 else if (NILP (frames))
2392 f = SELECTED_FRAME ();
2393 else
2394 f = NULL;
2395
2396 if (f)
2397 frame_arg = Qlambda;
2398 else if (EQ (frames, make_number (0)))
2399 frame_arg = frames;
2400 else if (EQ (frames, Qvisible))
2401 frame_arg = frames;
2402 else
2403 frame_arg = Qt;
2404
2405 /* frame_arg is Qlambda to stick to one frame,
2406 Qvisible to consider all visible frames,
2407 or Qt otherwise. */
2408
2409 /* Pick a window to start with. */
2410 if (WINDOWP (obj))
2411 window = obj;
2412 else if (f)
2413 window = FRAME_SELECTED_WINDOW (f);
2414 else
2415 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2416
2417 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2418 GCPRO1 (windows);
2419 best_window = Qnil;
2420
2421 for (; CONSP (windows); windows = XCDR (windows))
2422 {
2423 struct window *w;
2424
2425 window = XCAR (windows);
2426 w = XWINDOW (window);
2427
2428 /* Note that we do not pay attention here to whether the frame
2429 is visible, since Fwindow_list skips non-visible frames if
2430 that is desired, under the control of frame_arg. */
2431 if (!MINI_WINDOW_P (w)
2432 /* For REPLACE_BUFFER_IN_WINDOWS_SAFELY, we must always
2433 consider all windows. */
2434 || type == REPLACE_BUFFER_IN_WINDOWS_SAFELY
2435 || (mini && minibuf_level > 0))
2436 switch (type)
2437 {
2438 case GET_BUFFER_WINDOW:
2439 if (EQ (w->buffer, obj)
2440 /* Don't find any minibuffer window except the one that
2441 is currently in use. */
2442 && (MINI_WINDOW_P (w) ? EQ (window, minibuf_window) : 1))
2443 {
2444 if (EQ (window, selected_window))
2445 /* Preferably return the selected window. */
2446 RETURN_UNGCPRO (window);
2447 else if (EQ (XWINDOW (window)->frame, selected_frame)
2448 && !frame_best_window_flag)
2449 /* Prefer windows on the current frame (but don't
2450 choose another one if we have one already). */
2451 {
2452 best_window = window;
2453 frame_best_window_flag = 1;
2454 }
2455 else if (NILP (best_window))
2456 best_window = window;
2457 }
2458 break;
2459
2460 case REPLACE_BUFFER_IN_WINDOWS_SAFELY:
2461 /* We could simply check whether the buffer shown by window
2462 is live, and show another buffer in case it isn't. */
2463 if (EQ (w->buffer, obj))
2464 {
2465 /* Undedicate WINDOW. */
2466 w->dedicated = Qnil;
2467 /* Make WINDOW show the buffer returned by
2468 other_buffer_safely, don't run any hooks. */
2469 set_window_buffer
2470 (window, other_buffer_safely (w->buffer), 0, 0);
2471 /* If WINDOW is the selected window, make its buffer
2472 current. But do so only if the window shows the
2473 current buffer (Bug#6454). */
2474 if (EQ (window, selected_window)
2475 && XBUFFER (w->buffer) == current_buffer)
2476 Fset_buffer (w->buffer);
2477 }
2478 break;
2479
2480 case REDISPLAY_BUFFER_WINDOWS:
2481 if (EQ (w->buffer, obj))
2482 {
2483 mark_window_display_accurate (window, 0);
2484 w->update_mode_line = Qt;
2485 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2486 ++update_mode_lines;
2487 best_window = window;
2488 }
2489 break;
2490
2491 /* Check for a window that has a killed buffer. */
2492 case CHECK_ALL_WINDOWS:
2493 if (! NILP (w->buffer)
2494 && NILP (BVAR (XBUFFER (w->buffer), name)))
2495 abort ();
2496 break;
2497
2498 case WINDOW_LOOP_UNUSED:
2499 break;
2500 }
2501 }
2502
2503 UNGCPRO;
2504 return best_window;
2505 }
2506
2507 /* Used for debugging. Abort if any window has a dead buffer. */
2508
2509 extern void check_all_windows (void) EXTERNALLY_VISIBLE;
2510 void
2511 check_all_windows (void)
2512 {
2513 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2514 }
2515
2516 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 0, 2, 0,
2517 doc: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2518 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
2519 the current buffer.
2520
2521 The optional argument ALL-FRAMES specifies the frames to consider:
2522
2523 - t means consider all windows on all existing frames.
2524
2525 - `visible' means consider all windows on all visible frames.
2526
2527 - 0 (the number zero) means consider all windows on all visible
2528 and iconified frames.
2529
2530 - A frame means consider all windows on that frame only.
2531
2532 Any other value of ALL-FRAMES means consider all windows on the
2533 selected frame and no others. */)
2534 (Lisp_Object buffer_or_name, Lisp_Object all_frames)
2535 {
2536 Lisp_Object buffer;
2537
2538 if (NILP (buffer_or_name))
2539 buffer = Fcurrent_buffer ();
2540 else
2541 buffer = Fget_buffer (buffer_or_name);
2542
2543 if (BUFFERP (buffer))
2544 return window_loop (GET_BUFFER_WINDOW, buffer, 1, all_frames);
2545 else
2546 return Qnil;
2547 }
2548
2549 static Lisp_Object
2550 resize_root_window (Lisp_Object window, Lisp_Object delta, Lisp_Object horizontal, Lisp_Object ignore)
2551 {
2552 return call4 (Qwindow_resize_root_window, window, delta, horizontal, ignore);
2553 }
2554
2555
2556 DEFUN ("delete-other-windows-internal", Fdelete_other_windows_internal,
2557 Sdelete_other_windows_internal, 0, 2, "",
2558 doc: /* Make WINDOW fill its frame.
2559 Only the frame WINDOW is on is affected. WINDOW may be any window and
2560 defaults to the selected one.
2561
2562 Optional argument ROOT, if non-nil, must specify an internal window
2563 containing WINDOW as a subwindow. If this is the case, replace ROOT by
2564 WINDOW and leave alone any windows not contained in ROOT.
2565
2566 When WINDOW is live try to reduce display jumps by keeping the text
2567 previously visible in WINDOW in the same place on the frame. Doing this
2568 depends on the value of (window-start WINDOW), so if calling this
2569 function in a program gives strange scrolling, make sure the
2570 window-start value is reasonable when this function is called. */)
2571 (Lisp_Object window, Lisp_Object root)
2572 {
2573 struct window *w, *r, *s;
2574 struct frame *f;
2575 Lisp_Object sibling, pwindow, swindow IF_LINT (= Qnil), delta;
2576 EMACS_INT startpos IF_LINT (= 0);
2577 int top IF_LINT (= 0), new_top, resize_failed;
2578
2579 w = decode_any_window (window);
2580 XSETWINDOW (window, w);
2581 f = XFRAME (w->frame);
2582
2583 if (NILP (root))
2584 /* ROOT is the frame's root window. */
2585 {
2586 root = FRAME_ROOT_WINDOW (f);
2587 r = XWINDOW (root);
2588 }
2589 else
2590 /* ROOT must be an ancestor of WINDOW. */
2591 {
2592 r = decode_any_window (root);
2593 pwindow = XWINDOW (window)->parent;
2594 while (!NILP (pwindow))
2595 if (EQ (pwindow, root))
2596 break;
2597 else
2598 pwindow = XWINDOW (pwindow)->parent;
2599 if (!EQ (pwindow, root))
2600 error ("Specified root is not an ancestor of specified window");
2601 }
2602
2603 if (EQ (window, root))
2604 /* A noop. */
2605 return Qnil;
2606 /* I don't understand the "top > 0" part below. If we deal with a
2607 standalone minibuffer it would have been caught by the preceding
2608 test. */
2609 else if (MINI_WINDOW_P (w)) /* && top > 0) */
2610 error ("Can't expand minibuffer to full frame");
2611
2612 if (!NILP (w->buffer))
2613 {
2614 startpos = marker_position (w->start);
2615 top = WINDOW_TOP_EDGE_LINE (w)
2616 - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2617 /* Make sure WINDOW is the frame's selected window. */
2618 if (!EQ (window, FRAME_SELECTED_WINDOW (f)))
2619 {
2620 if (EQ (selected_frame, w->frame))
2621 Fselect_window (window, Qnil);
2622 else
2623 FRAME_SELECTED_WINDOW (f) = window;
2624 }
2625 }
2626 else
2627 {
2628 /* See if the frame's selected window is a subwindow of WINDOW, by
2629 finding all the selected window's parents and comparing each
2630 one with WINDOW. If it isn't we need a new selected window for
2631 this frame. */
2632 swindow = FRAME_SELECTED_WINDOW (f);
2633 while (1)
2634 {
2635 pwindow = swindow;
2636 while (!NILP (pwindow) && !EQ (window, pwindow))
2637 pwindow = XWINDOW (pwindow)->parent;
2638
2639 if (EQ (window, pwindow))
2640 /* If WINDOW is an ancestor of SWINDOW, then SWINDOW is ok
2641 as the new selected window. */
2642 break;
2643 else
2644 /* Else try the previous window of SWINDOW. */
2645 swindow = Fprevious_window (swindow, Qlambda, Qnil);
2646 }
2647
2648 if (!EQ (swindow, FRAME_SELECTED_WINDOW (f)))
2649 {
2650 if (EQ (selected_frame, w->frame))
2651 Fselect_window (swindow, Qnil);
2652 else
2653 FRAME_SELECTED_WINDOW (f) = swindow;
2654 }
2655 }
2656
2657 BLOCK_INPUT;
2658 free_window_matrices (r);
2659
2660 windows_or_buffers_changed++;
2661 Vwindow_list = Qnil;
2662 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
2663 resize_failed = 0;
2664
2665 if (NILP (w->buffer))
2666 {
2667 /* Resize subwindows vertically. */
2668 XSETINT (delta, XINT (r->total_lines) - XINT (w->total_lines));
2669 w->top_line = r->top_line;
2670 resize_root_window (window, delta, Qnil, Qnil);
2671 if (window_resize_check (w, 0))
2672 window_resize_apply (w, 0);
2673 else
2674 {
2675 resize_root_window (window, delta, Qnil, Qt);
2676 if (window_resize_check (w, 0))
2677 window_resize_apply (w, 0);
2678 else
2679 resize_failed = 1;
2680 }
2681
2682 /* Resize subwindows horizontally. */
2683 if (!resize_failed)
2684 {
2685 w->left_col = r->left_col;
2686 XSETINT (delta, XINT (r->total_cols) - XINT (w->total_cols));
2687 w->left_col = r->left_col;
2688 resize_root_window (window, delta, Qt, Qnil);
2689 if (window_resize_check (w, 1))
2690 window_resize_apply (w, 1);
2691 else
2692 {
2693 resize_root_window (window, delta, Qt, Qt);
2694 if (window_resize_check (w, 1))
2695 window_resize_apply (w, 1);
2696 else
2697 resize_failed = 1;
2698 }
2699 }
2700
2701 if (resize_failed)
2702 /* Play safe, if we still can ... */
2703 {
2704 window = swindow;
2705 w = XWINDOW (window);
2706 }
2707 }
2708
2709 /* Cleanly unlink WINDOW from window-tree. */
2710 if (!NILP (w->prev))
2711 /* Get SIBLING above (on the left of) WINDOW. */
2712 {
2713 sibling = w->prev;
2714 s = XWINDOW (sibling);
2715 s->next = w->next;
2716 if (!NILP (s->next))
2717 XWINDOW (s->next)->prev = sibling;
2718 }
2719 else
2720 /* Get SIBLING below (on the right of) WINDOW. */
2721 {
2722 sibling = w->next;
2723 s = XWINDOW (sibling);
2724 s->prev = Qnil;
2725 if (!NILP (XWINDOW (w->parent)->vchild))
2726 XWINDOW (w->parent)->vchild = sibling;
2727 else
2728 XWINDOW (w->parent)->hchild = sibling;
2729 }
2730
2731 /* Delete ROOT and all subwindows of ROOT. */
2732 if (!NILP (r->vchild))
2733 {
2734 delete_all_subwindows (r->vchild);
2735 r->vchild = Qnil;
2736 }
2737 else if (!NILP (r->hchild))
2738 {
2739 delete_all_subwindows (r->hchild);
2740 r->hchild = Qnil;
2741 }
2742
2743 replace_window (root, window, 1);
2744
2745 /* Reset WINDOW's splits status. */
2746 w->splits = Qnil;
2747
2748 /* This must become SWINDOW anyway ....... */
2749 if (!NILP (w->buffer) && !resize_failed)
2750 {
2751 /* Try to minimize scrolling, by setting the window start to the
2752 point will cause the text at the old window start to be at the
2753 same place on the frame. But don't try to do this if the
2754 window start is outside the visible portion (as might happen
2755 when the display is not current, due to typeahead). */
2756 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2757 if (new_top != top
2758 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2759 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2760 {
2761 struct position pos;
2762 struct buffer *obuf = current_buffer;
2763
2764 Fset_buffer (w->buffer);
2765 /* This computation used to temporarily move point, but that
2766 can have unwanted side effects due to text properties. */
2767 pos = *vmotion (startpos, -top, w);
2768
2769 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2770 w->window_end_valid = Qnil;
2771 w->start_at_line_beg = ((pos.bytepos == BEGV_BYTE
2772 || FETCH_BYTE (pos.bytepos - 1) == '\n') ? Qt
2773 : Qnil);
2774 /* We need to do this, so that the window-scroll-functions
2775 get called. */
2776 w->optional_new_start = Qt;
2777
2778 set_buffer_internal (obuf);
2779 }
2780 }
2781
2782 adjust_glyphs (f);
2783 UNBLOCK_INPUT;
2784
2785 run_window_configuration_change_hook (f);
2786
2787 return Qnil;
2788 }
2789
2790
2791 void
2792 replace_buffer_in_windows (Lisp_Object buffer)
2793 {
2794 call1 (Qreplace_buffer_in_windows, buffer);
2795 }
2796
2797
2798 /* Safely replace BUFFER with some other buffer in all windows of all
2799 frames, even those on other keyboards. */
2800
2801 void
2802 replace_buffer_in_windows_safely (Lisp_Object buffer)
2803 {
2804 Lisp_Object tail, frame;
2805
2806 /* A single call to window_loop won't do the job because it only
2807 considers frames on the current keyboard. So loop manually over
2808 frames, and handle each one. */
2809 FOR_EACH_FRAME (tail, frame)
2810 window_loop (REPLACE_BUFFER_IN_WINDOWS_SAFELY, buffer, 1, frame);
2811 }
2812 \f
2813 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2814 minimum allowable size. */
2815
2816 void
2817 check_frame_size (FRAME_PTR frame, int *rows, int *cols)
2818 {
2819 /* For height, we have to see:
2820 how many windows the frame has at minimum (one or two),
2821 and whether it has a menu bar or other special stuff at the top. */
2822 int min_height
2823 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
2824 ? MIN_SAFE_WINDOW_HEIGHT
2825 : 2 * MIN_SAFE_WINDOW_HEIGHT);
2826
2827 if (FRAME_TOP_MARGIN (frame) > 0)
2828 min_height += FRAME_TOP_MARGIN (frame);
2829
2830 if (*rows < min_height)
2831 *rows = min_height;
2832 if (*cols < MIN_SAFE_WINDOW_WIDTH)
2833 *cols = MIN_SAFE_WINDOW_WIDTH;
2834 }
2835
2836 /* Adjust the margins of window W if text area is too small.
2837 Return 1 if window width is ok after adjustment; 0 if window
2838 is still too narrow. */
2839
2840 static int
2841 adjust_window_margins (struct window *w)
2842 {
2843 int box_cols = (WINDOW_TOTAL_COLS (w)
2844 - WINDOW_FRINGE_COLS (w)
2845 - WINDOW_SCROLL_BAR_COLS (w));
2846 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
2847 + WINDOW_RIGHT_MARGIN_COLS (w));
2848
2849 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
2850 return 1;
2851
2852 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
2853 return 0;
2854
2855 /* Window's text area is too narrow, but reducing the window
2856 margins will fix that. */
2857 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
2858 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
2859 {
2860 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
2861 w->left_margin_cols = w->right_margin_cols
2862 = make_number (margin_cols/2);
2863 else
2864 w->right_margin_cols = make_number (margin_cols);
2865 }
2866 else
2867 w->left_margin_cols = make_number (margin_cols);
2868 return 1;
2869 }
2870 \f
2871 static Lisp_Object Fset_window_margins (Lisp_Object, Lisp_Object, Lisp_Object);
2872 static Lisp_Object Fset_window_fringes (Lisp_Object, Lisp_Object, Lisp_Object,
2873 Lisp_Object);
2874 static Lisp_Object Fset_window_scroll_bars (Lisp_Object, Lisp_Object,
2875 Lisp_Object, Lisp_Object);
2876 static Lisp_Object Fset_window_vscroll (Lisp_Object, Lisp_Object, Lisp_Object);
2877
2878 /* The following three routines are needed for running a window's
2879 configuration change hook. */
2880 static void
2881 run_funs (Lisp_Object funs)
2882 {
2883 for (; CONSP (funs); funs = XCDR (funs))
2884 if (!EQ (XCAR (funs), Qt))
2885 call0 (XCAR (funs));
2886 }
2887
2888 static Lisp_Object
2889 select_window_norecord (Lisp_Object window)
2890 {
2891 return WINDOW_LIVE_P (window)
2892 ? Fselect_window (window, Qt) : selected_window;
2893 }
2894
2895 static Lisp_Object
2896 select_frame_norecord (Lisp_Object frame)
2897 {
2898 return FRAME_LIVE_P (XFRAME (frame))
2899 ? Fselect_frame (frame, Qt) : selected_frame;
2900 }
2901
2902 void
2903 run_window_configuration_change_hook (struct frame *f)
2904 {
2905 int count = SPECPDL_INDEX ();
2906 Lisp_Object frame, global_wcch
2907 = Fdefault_value (Qwindow_configuration_change_hook);
2908 XSETFRAME (frame, f);
2909
2910 if (NILP (Vrun_hooks))
2911 return;
2912
2913 /* Use the right buffer. Matters when running the local hooks. */
2914 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
2915 {
2916 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
2917 Fset_buffer (Fwindow_buffer (Qnil));
2918 }
2919
2920 if (SELECTED_FRAME () != f)
2921 {
2922 record_unwind_protect (select_frame_norecord, Fselected_frame ());
2923 select_frame_norecord (frame);
2924 }
2925
2926 /* Look for buffer-local values. */
2927 {
2928 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
2929 for (; CONSP (windows); windows = XCDR (windows))
2930 {
2931 Lisp_Object window = XCAR (windows);
2932 Lisp_Object buffer = Fwindow_buffer (window);
2933 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
2934 buffer)))
2935 {
2936 int inner_count = SPECPDL_INDEX ();
2937 record_unwind_protect (select_window_norecord, Fselected_window ());
2938 select_window_norecord (window);
2939 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
2940 buffer));
2941 unbind_to (inner_count, Qnil);
2942 }
2943 }
2944 }
2945
2946 run_funs (global_wcch);
2947 unbind_to (count, Qnil);
2948 }
2949
2950 DEFUN ("run-window-configuration-change-hook", Frun_window_configuration_change_hook,
2951 Srun_window_configuration_change_hook, 1, 1, 0,
2952 doc: /* Run `window-configuration-change-hook' for FRAME. */)
2953 (Lisp_Object frame)
2954 {
2955 CHECK_LIVE_FRAME (frame);
2956 run_window_configuration_change_hook (XFRAME (frame));
2957 return Qnil;
2958 }
2959
2960 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
2961 means it's allowed to run hooks. See make_frame for a case where
2962 it's not allowed. KEEP_MARGINS_P non-zero means that the current
2963 margins, fringes, and scroll-bar settings of the window are not
2964 reset from the buffer's local settings. */
2965
2966 void
2967 set_window_buffer (Lisp_Object window, Lisp_Object buffer, int run_hooks_p, int keep_margins_p)
2968 {
2969 struct window *w = XWINDOW (window);
2970 struct buffer *b = XBUFFER (buffer);
2971 int count = SPECPDL_INDEX ();
2972 int samebuf = EQ (buffer, w->buffer);
2973
2974 w->buffer = buffer;
2975
2976 if (EQ (window, selected_window))
2977 BVAR (b, last_selected_window) = window;
2978
2979 /* Let redisplay errors through. */
2980 b->display_error_modiff = 0;
2981
2982 /* Update time stamps of buffer display. */
2983 if (INTEGERP (BVAR (b, display_count)))
2984 XSETINT (BVAR (b, display_count), XINT (BVAR (b, display_count)) + 1);
2985 BVAR (b, display_time) = Fcurrent_time ();
2986
2987 XSETFASTINT (w->window_end_pos, 0);
2988 XSETFASTINT (w->window_end_vpos, 0);
2989 memset (&w->last_cursor, 0, sizeof w->last_cursor);
2990 w->window_end_valid = Qnil;
2991 if (!(keep_margins_p && samebuf))
2992 { /* If we're not actually changing the buffer, don't reset hscroll and
2993 vscroll. This case happens for example when called from
2994 change_frame_size_1, where we use a dummy call to
2995 Fset_window_buffer on the frame's selected window (and no other)
2996 just in order to run window-configuration-change-hook.
2997 Resetting hscroll and vscroll here is problematic for things like
2998 image-mode and doc-view-mode since it resets the image's position
2999 whenever we resize the frame. */
3000 w->hscroll = w->min_hscroll = make_number (0);
3001 w->vscroll = 0;
3002 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3003 set_marker_restricted (w->start,
3004 make_number (b->last_window_start),
3005 buffer);
3006 w->start_at_line_beg = Qnil;
3007 w->force_start = Qnil;
3008 XSETFASTINT (w->last_modified, 0);
3009 XSETFASTINT (w->last_overlay_modified, 0);
3010 }
3011 /* Maybe we could move this into the `if' but it's not obviously safe and
3012 I doubt it's worth the trouble. */
3013 windows_or_buffers_changed++;
3014
3015 /* We must select BUFFER for running the window-scroll-functions. */
3016 /* We can't check ! NILP (Vwindow_scroll_functions) here
3017 because that might itself be a local variable. */
3018 if (window_initialized)
3019 {
3020 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3021 Fset_buffer (buffer);
3022 }
3023
3024 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3025
3026 if (!keep_margins_p)
3027 {
3028 /* Set left and right marginal area width etc. from buffer. */
3029
3030 /* This may call adjust_window_margins three times, so
3031 temporarily disable window margins. */
3032 Lisp_Object save_left = w->left_margin_cols;
3033 Lisp_Object save_right = w->right_margin_cols;
3034
3035 w->left_margin_cols = w->right_margin_cols = Qnil;
3036
3037 Fset_window_fringes (window,
3038 BVAR (b, left_fringe_width), BVAR (b, right_fringe_width),
3039 BVAR (b, fringes_outside_margins));
3040
3041 Fset_window_scroll_bars (window,
3042 BVAR (b, scroll_bar_width),
3043 BVAR (b, vertical_scroll_bar_type), Qnil);
3044
3045 w->left_margin_cols = save_left;
3046 w->right_margin_cols = save_right;
3047
3048 Fset_window_margins (window,
3049 BVAR (b, left_margin_cols), BVAR (b, right_margin_cols));
3050 }
3051
3052 if (run_hooks_p)
3053 {
3054 if (! NILP (Vwindow_scroll_functions))
3055 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3056 Fmarker_position (w->start));
3057 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3058 }
3059
3060 unbind_to (count, Qnil);
3061 }
3062
3063 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3064 doc: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3065 WINDOW has to be a live window and defaults to the selected one.
3066 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3067
3068 Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
3069 display margins, fringe widths, and scroll bar settings are preserved;
3070 the default is to reset these from the local settings for BUFFER-OR-NAME
3071 or the frame defaults. Return nil.
3072
3073 This function throws an error when WINDOW is strongly dedicated to its
3074 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3075 already display BUFFER-OR-NAME.
3076
3077 This function runs `window-scroll-functions' before running
3078 `window-configuration-change-hook'. */)
3079 (register Lisp_Object window, Lisp_Object buffer_or_name, Lisp_Object keep_margins)
3080 {
3081 register Lisp_Object tem, buffer;
3082 register struct window *w = decode_window (window);
3083
3084 XSETWINDOW (window, w);
3085 buffer = Fget_buffer (buffer_or_name);
3086 CHECK_BUFFER (buffer);
3087 if (NILP (BVAR (XBUFFER (buffer), name)))
3088 error ("Attempt to display deleted buffer");
3089
3090 tem = w->buffer;
3091 if (NILP (tem))
3092 error ("Window is deleted");
3093 else if (!EQ (tem, Qt))
3094 /* w->buffer is t when the window is first being set up. */
3095 {
3096 if (!EQ (tem, buffer))
3097 {
3098 if (EQ (w->dedicated, Qt))
3099 /* WINDOW is strongly dedicated to its buffer, signal an
3100 error. */
3101 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem), name)));
3102 else
3103 /* WINDOW is weakly dedicated to its buffer, reset
3104 dedicatedness. */
3105 w->dedicated = Qnil;
3106
3107 call1 (Qrecord_window_buffer, window);
3108 }
3109
3110 unshow_buffer (w);
3111 }
3112
3113 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3114
3115 return Qnil;
3116 }
3117 \f
3118 static Lisp_Object
3119 display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame)
3120 {
3121 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3122 }
3123
3124 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3125 0, 1, 0,
3126 doc: /* Force all windows to be updated on next redisplay.
3127 If optional arg OBJECT is a window, force redisplay of that window only.
3128 If OBJECT is a buffer or buffer name, force redisplay of all windows
3129 displaying that buffer. */)
3130 (Lisp_Object object)
3131 {
3132 if (NILP (object))
3133 {
3134 windows_or_buffers_changed++;
3135 update_mode_lines++;
3136 return Qt;
3137 }
3138
3139 if (WINDOWP (object))
3140 {
3141 struct window *w = XWINDOW (object);
3142 mark_window_display_accurate (object, 0);
3143 w->update_mode_line = Qt;
3144 if (BUFFERP (w->buffer))
3145 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3146 ++update_mode_lines;
3147 return Qt;
3148 }
3149
3150 if (STRINGP (object))
3151 object = Fget_buffer (object);
3152 if (BUFFERP (object) && !NILP (BVAR (XBUFFER (object), name)))
3153 {
3154 /* Walk all windows looking for buffer, and force update
3155 of each of those windows. */
3156
3157 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3158 return NILP (object) ? Qnil : Qt;
3159 }
3160
3161 /* If nothing suitable was found, just return.
3162 We could signal an error, but this feature will typically be used
3163 asynchronously in timers or process sentinels, so we don't. */
3164 return Qnil;
3165 }
3166
3167
3168 void
3169 temp_output_buffer_show (register Lisp_Object buf)
3170 {
3171 register struct buffer *old = current_buffer;
3172 register Lisp_Object window;
3173 register struct window *w;
3174
3175 BVAR (XBUFFER (buf), directory) = BVAR (current_buffer, directory);
3176
3177 Fset_buffer (buf);
3178 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3179 BEGV = BEG;
3180 ZV = Z;
3181 SET_PT (BEG);
3182 set_buffer_internal (old);
3183
3184 if (!NILP (Vtemp_buffer_show_function))
3185 call1 (Vtemp_buffer_show_function, buf);
3186 else
3187 {
3188 window = display_buffer (buf, Vtemp_buffer_show_specifiers, Qnil);
3189 /* Reset Vtemp_buffer_show_specifiers immediately so it won't
3190 affect subsequent calls. */
3191 Vtemp_buffer_show_specifiers = Qnil;
3192
3193 if (!EQ (XWINDOW (window)->frame, selected_frame))
3194 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3195 Vminibuf_scroll_window = window;
3196 w = XWINDOW (window);
3197 XSETFASTINT (w->hscroll, 0);
3198 XSETFASTINT (w->min_hscroll, 0);
3199 set_marker_restricted_both (w->start, buf, BEG, BEG);
3200 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3201
3202 /* Run temp-buffer-show-hook, with the chosen window selected
3203 and its buffer current. */
3204 {
3205 int count = SPECPDL_INDEX ();
3206 Lisp_Object prev_window, prev_buffer;
3207 prev_window = selected_window;
3208 XSETBUFFER (prev_buffer, old);
3209
3210 /* Select the window that was chosen, for running the hook.
3211 Note: Both Fselect_window and select_window_norecord may
3212 set-buffer to the buffer displayed in the window,
3213 so we need to save the current buffer. --stef */
3214 record_unwind_protect (Fset_buffer, prev_buffer);
3215 record_unwind_protect (select_window_norecord, prev_window);
3216 Fselect_window (window, Qt);
3217 Fset_buffer (w->buffer);
3218 Frun_hooks (1, &Qtemp_buffer_show_hook);
3219 unbind_to (count, Qnil);
3220 }
3221 }
3222 }
3223
3224 DEFUN ("internal-temp-output-buffer-show",
3225 Ftemp_output_buffer_show, Stemp_output_buffer_show,
3226 1, 1, 0,
3227 doc: /* Internal function for `with-output-to-temp-buffer''. */)
3228 (Lisp_Object buf)
3229 {
3230 temp_output_buffer_show (buf);
3231 return Qnil;
3232 }
3233 \f
3234 /* Make new window, have it replace WINDOW in window-tree, and make
3235 WINDOW its only vertical child (HORFLAG 1 means make WINDOW its only
3236 horizontal child). */
3237 static void
3238 make_parent_window (Lisp_Object window, int horflag)
3239 {
3240 Lisp_Object parent;
3241 register struct window *o, *p;
3242 int i;
3243
3244 o = XWINDOW (window);
3245 p = allocate_window ();
3246 for (i = 0; i < VECSIZE (struct window); ++i)
3247 ((struct Lisp_Vector *) p)->contents[i]
3248 = ((struct Lisp_Vector *) o)->contents[i];
3249 XSETWINDOW (parent, p);
3250
3251 ++sequence_number;
3252 XSETFASTINT (p->sequence_number, sequence_number);
3253
3254 replace_window (window, parent, 1);
3255
3256 o->next = Qnil;
3257 o->prev = Qnil;
3258 o->parent = parent;
3259
3260 p->hchild = horflag ? window : Qnil;
3261 p->vchild = horflag ? Qnil : window;
3262 p->start = Qnil;
3263 p->pointm = Qnil;
3264 p->buffer = Qnil;
3265 p->splits = Qnil;
3266 p->nest = Qnil;
3267 p->window_parameters = Qnil;
3268 }
3269
3270 /* Make new window from scratch. */
3271 Lisp_Object
3272 make_window (void)
3273 {
3274 Lisp_Object window;
3275 register struct window *w;
3276
3277 w = allocate_window ();
3278 /* Initialize all Lisp data. */
3279 w->frame = w->mini_p = Qnil;
3280 w->next = w->prev = w->hchild = w->vchild = w->parent = Qnil;
3281 XSETFASTINT (w->left_col, 0);
3282 XSETFASTINT (w->top_line, 0);
3283 XSETFASTINT (w->total_lines, 0);
3284 XSETFASTINT (w->total_cols, 0);
3285 w->normal_lines = make_float (1.0);
3286 w->normal_cols = make_float (1.0);
3287 XSETFASTINT (w->new_total, 0);
3288 XSETFASTINT (w->new_normal, 0);
3289 w->buffer = Qnil;
3290 w->start = Fmake_marker ();
3291 w->pointm = Fmake_marker ();
3292 w->force_start = w->optional_new_start = Qnil;
3293 XSETFASTINT (w->hscroll, 0);
3294 XSETFASTINT (w->min_hscroll, 0);
3295 XSETFASTINT (w->use_time, 0);
3296 ++sequence_number;
3297 XSETFASTINT (w->sequence_number, sequence_number);
3298 w->temslot = w->last_modified = w->last_overlay_modified = Qnil;
3299 XSETFASTINT (w->last_point, 0);
3300 w->last_had_star = w->vertical_scroll_bar = Qnil;
3301 w->left_margin_cols = w->right_margin_cols = Qnil;
3302 w->left_fringe_width = w->right_fringe_width = Qnil;
3303 w->fringes_outside_margins = Qnil;
3304 w->scroll_bar_width = Qnil;
3305 w->vertical_scroll_bar_type = Qt;
3306 w->last_mark_x = w->last_mark_y = Qnil;
3307 XSETFASTINT (w->window_end_pos, 0);
3308 XSETFASTINT (w->window_end_vpos, 0);
3309 w->window_end_valid = w->update_mode_line = Qnil;
3310 w->start_at_line_beg = w->display_table = w->dedicated = Qnil;
3311 w->base_line_number = w->base_line_pos = w->region_showing = Qnil;
3312 w->column_number_displayed = w->redisplay_end_trigger = Qnil;
3313 w->splits = w->nest = w->window_parameters = Qnil;
3314 w->prev_buffers = w->next_buffers = Qnil;
3315 /* Initialize non-Lisp data. */
3316 w->desired_matrix = w->current_matrix = 0;
3317 w->nrows_scale_factor = w->ncols_scale_factor = 1;
3318 memset (&w->cursor, 0, sizeof (w->cursor));
3319 memset (&w->last_cursor, 0, sizeof (w->last_cursor));
3320 memset (&w->phys_cursor, 0, sizeof (w->phys_cursor));
3321 w->phys_cursor_type = -1;
3322 w->phys_cursor_width = -1;
3323 w->last_cursor_off_p = w->cursor_off_p = 0;
3324 w->must_be_updated_p = 0;
3325 w->pseudo_window_p = 0;
3326 w->frozen_window_start_p = 0;
3327 w->vscroll = 0;
3328 /* Reset window_list. */
3329 Vwindow_list = Qnil;
3330 /* Return window. */
3331 XSETWINDOW (window, w);
3332 return window;
3333 }
3334 \f
3335 DEFUN ("set-window-new-total", Fset_window_new_total, Sset_window_new_total, 2, 3, 0,
3336 doc: /* Set new total size of WINDOW to SIZE.
3337 Return SIZE.
3338
3339 Optional argument ADD non-nil means add SIZE to the new total size of
3340 WINDOW and return the sum.
3341
3342 Note: This function does not operate on any subwindows of WINDOW. */)
3343 (Lisp_Object window, Lisp_Object size, Lisp_Object add)
3344 {
3345 struct window *w = decode_any_window (window);
3346
3347 CHECK_NUMBER (size);
3348 if (NILP (add))
3349 XSETINT (w->new_total, XINT (size));
3350 else
3351 XSETINT (w->new_total, XINT (w->new_total) + XINT (size));
3352
3353 return w->new_total;
3354 }
3355
3356 DEFUN ("set-window-new-normal", Fset_window_new_normal, Sset_window_new_normal, 1, 2, 0,
3357 doc: /* Set new normal size of WINDOW to SIZE.
3358 Return SIZE.
3359
3360 Note: This function does not operate on any subwindows of WINDOW. */)
3361 (Lisp_Object window, Lisp_Object size)
3362 {
3363 struct window *w = decode_any_window (window);
3364
3365 w->new_normal = size;
3366 return w->new_normal;
3367 }
3368
3369 /* Return 1 if setting w->total_lines (w->total_cols if HORFLAG is
3370 non-zero) to w->new_total would result in correct heights (widths)
3371 for window W and recursively all subwindows of W.
3372
3373 Note: This function does not check any of `window-fixed-size-p',
3374 `window-min-height' or `window-min-width'. It does check that window
3375 sizes do not drop below one line (two columns). */
3376 static int
3377 window_resize_check (struct window *w, int horflag)
3378 {
3379 struct window *c;
3380
3381 if (!NILP (w->vchild))
3382 /* W is a vertical combination. */
3383 {
3384 c = XWINDOW (w->vchild);
3385 if (horflag)
3386 /* All subwindows of W must have the same width as W. */
3387 {
3388 while (c)
3389 {
3390 if ((XINT (c->new_total) != XINT (w->new_total))
3391 || !window_resize_check (c, horflag))
3392 return 0;
3393 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3394 }
3395 return 1;
3396 }
3397 else
3398 /* The sum of the heights of the subwindows of W must equal W's
3399 height. */
3400 {
3401 int sum_of_sizes = 0;
3402 while (c)
3403 {
3404 if (!window_resize_check (c, horflag))
3405 return 0;
3406 sum_of_sizes = sum_of_sizes + XINT (c->new_total);
3407 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3408 }
3409 return (sum_of_sizes == XINT (w->new_total));
3410 }
3411 }
3412 else if (!NILP (w->hchild))
3413 /* W is a horizontal combination. */
3414 {
3415 c = XWINDOW (w->hchild);
3416 if (horflag)
3417 /* The sum of the widths of the subwindows of W must equal W's
3418 width. */
3419 {
3420 int sum_of_sizes = 0;
3421 while (c)
3422 {
3423 if (!window_resize_check (c, horflag))
3424 return 0;
3425 sum_of_sizes = sum_of_sizes + XINT (c->new_total);
3426 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3427 }
3428 return (sum_of_sizes == XINT (w->new_total));
3429 }
3430 else
3431 /* All subwindows of W must have the same height as W. */
3432 {
3433 while (c)
3434 {
3435 if ((XINT (c->new_total) != XINT (w->new_total))
3436 || !window_resize_check (c, horflag))
3437 return 0;
3438 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3439 }
3440 return 1;
3441 }
3442 }
3443 else
3444 /* A leaf window. Make sure it's not too small. The following
3445 hardcodes the values of `window-safe-min-width' (2) and
3446 `window-safe-min-height' (1) which are defined in window.el. */
3447 return XINT (w->new_total) >= (horflag ? 2 : 1);
3448 }
3449
3450 /* Set w->total_lines (w->total_cols if HORIZONTAL is non-zero) to
3451 w->new_total for window W and recursively all subwindows of W. Also
3452 calculate and assign the new vertical (horizontal) start positions of
3453 each of these windows.
3454
3455 This function does not perform any error checks. Make sure you have
3456 run window_resize_check on W before applying this function. */
3457 static void
3458 window_resize_apply (struct window *w, int horflag)
3459 {
3460 struct window *c;
3461 int pos;
3462
3463 /* Note: Assigning new_normal requires that the new total size of the
3464 parent window has been set *before*. */
3465 if (horflag)
3466 {
3467 w->total_cols = w->new_total;
3468 if (NUMBERP (w->new_normal))
3469 w->normal_cols = w->new_normal;
3470
3471 pos = XINT (w->left_col);
3472 }
3473 else
3474 {
3475 w->total_lines = w->new_total;
3476 if (NUMBERP (w->new_normal))
3477 w->normal_lines = w->new_normal;
3478
3479 pos = XINT (w->top_line);
3480 }
3481
3482 if (!NILP (w->vchild))
3483 /* W is a vertical combination. */
3484 {
3485 c = XWINDOW (w->vchild);
3486 while (c)
3487 {
3488 if (horflag)
3489 XSETFASTINT (c->left_col, pos);
3490 else
3491 XSETFASTINT (c->top_line, pos);
3492 window_resize_apply (c, horflag);
3493 if (!horflag)
3494 pos = pos + XINT (c->total_lines);
3495 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3496 }
3497 }
3498 else if (!NILP (w->hchild))
3499 /* W is a horizontal combination. */
3500 {
3501 c = XWINDOW (w->hchild);
3502 while (c)
3503 {
3504 if (horflag)
3505 XSETFASTINT (c->left_col, pos);
3506 else
3507 XSETFASTINT (c->top_line, pos);
3508 window_resize_apply (c, horflag);
3509 if (horflag)
3510 pos = pos + XINT (c->total_cols);
3511 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3512 }
3513 }
3514
3515 /* Clear out some redisplay caches. */
3516 XSETFASTINT (w->last_modified, 0);
3517 XSETFASTINT (w->last_overlay_modified, 0);
3518 }
3519
3520
3521 DEFUN ("window-resize-apply", Fwindow_resize_apply, Swindow_resize_apply, 1, 2, 0,
3522 doc: /* Apply requested size values for window-tree of FRAME.
3523 Optional argument HORIZONTAL omitted or nil means apply requested height
3524 values. HORIZONTAL non-nil means apply requested width values.
3525
3526 This function checks whether the requested values sum up to a valid
3527 window layout, recursively assigns the new sizes of all subwindows and
3528 calculates and assigns the new start positions of these windows.
3529
3530 Note: This function does not check any of `window-fixed-size-p',
3531 `window-min-height' or `window-min-width'. All these checks have to
3532 be applied on the Elisp level. */)
3533 (Lisp_Object frame, Lisp_Object horizontal)
3534 {
3535 struct frame *f;
3536 struct window *r;
3537 int horflag = !NILP (horizontal);
3538
3539 if (NILP (frame))
3540 frame = selected_frame;
3541 CHECK_LIVE_FRAME (frame);
3542
3543 f = XFRAME (frame);
3544 r = XWINDOW (FRAME_ROOT_WINDOW (f));
3545
3546 if (!window_resize_check (r, horflag)
3547 || ! EQ (r->new_total, (horflag ? r->total_cols : r->total_lines)))
3548 return Qnil;
3549
3550 BLOCK_INPUT;
3551 window_resize_apply (r, horflag);
3552
3553 windows_or_buffers_changed++;
3554 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3555
3556 adjust_glyphs (f);
3557 UNBLOCK_INPUT;
3558
3559 run_window_configuration_change_hook (f);
3560
3561 return Qt;
3562 }
3563
3564
3565 /* Resize frame F's windows when number of lines of F is set to SIZE.
3566 HORFLAG 1 means resize windows when number of columns of F is set to
3567 SIZE.
3568
3569 This function can delete all windows but the selected one in order to
3570 satisfy the request. The result will be meaningful if and only if
3571 F's windows have meaningful sizes when you call this. */
3572 void
3573 resize_frame_windows (struct frame *f, int size, int horflag)
3574 {
3575 Lisp_Object root = f->root_window;
3576 struct window *r = XWINDOW (root);
3577 Lisp_Object mini = f->minibuffer_window;
3578 struct window *m;
3579 /* new_size is the new size of the frame's root window. */
3580 int new_size = (horflag
3581 ? size
3582 : (size
3583 - FRAME_TOP_MARGIN (f)
3584 - ((FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3585 ? 1 : 0)));
3586
3587 XSETFASTINT (r->top_line, FRAME_TOP_MARGIN (f));
3588 if (NILP (r->vchild) && NILP (r->hchild))
3589 /* For a leaf root window just set the size. */
3590 if (horflag)
3591 XSETFASTINT (r->total_cols, new_size);
3592 else
3593 XSETFASTINT (r->total_lines, new_size);
3594 else
3595 {
3596 /* old_size is the old size of the frame's root window. */
3597 int old_size = XFASTINT (horflag ? r->total_cols : r->total_lines);
3598 Lisp_Object delta;
3599
3600 XSETINT (delta, new_size - old_size);
3601 /* Try a "normal" resize first. */
3602 resize_root_window (root, delta, horflag ? Qt : Qnil, Qnil);
3603 if (window_resize_check (r, horflag) && new_size == XINT (r->new_total))
3604 window_resize_apply (r, horflag);
3605 else
3606 {
3607 /* Try with "reasonable" minimum sizes next. */
3608 resize_root_window (root, delta, horflag ? Qt : Qnil, Qt);
3609 if (window_resize_check (r, horflag)
3610 && new_size == XINT (r->new_total))
3611 window_resize_apply (r, horflag);
3612 else
3613 {
3614 /* Finally, try with "safe" minimum sizes. */
3615 resize_root_window (root, delta, horflag ? Qt : Qnil, Qsafe);
3616 if (window_resize_check (r, horflag)
3617 && new_size == XINT (r->new_total))
3618 window_resize_apply (r, horflag);
3619 else
3620 {
3621 /* We lost. Delete all windows but the frame's
3622 selected one. */
3623 root = f->selected_window;
3624 Fdelete_other_windows_internal (root, Qnil);
3625 if (horflag)
3626 XSETFASTINT (XWINDOW (root)->total_cols, new_size);
3627 else
3628 XSETFASTINT (XWINDOW (root)->total_lines, new_size);
3629 }
3630 }
3631 }
3632 }
3633
3634 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3635 {
3636 m = XWINDOW (mini);
3637 if (horflag)
3638 XSETFASTINT (m->total_cols, size);
3639 else
3640 {
3641 /* Are we sure we always want 1 line here? */
3642 XSETFASTINT (m->total_lines, 1);
3643 XSETFASTINT (m->top_line, XINT (r->top_line) + XINT (r->total_lines));
3644 }
3645 }
3646 }
3647
3648
3649 DEFUN ("split-window-internal", Fsplit_window_internal, Ssplit_window_internal, 4, 4, 0,
3650 doc: /* Split window OLD.
3651 Second argument TOTAL-SIZE specifies the number of lines or columns of the
3652 new window. In any case TOTAL-SIZE must be a positive integer.
3653
3654 Third argument SIDE nil (or `below') specifies that the new window shall
3655 be located below WINDOW. SIDE `above' means the new window shall be
3656 located above WINDOW. In both cases TOTAL-SIZE specifies the number of
3657 lines of the new window including space reserved for the mode and/or
3658 header line.
3659
3660 SIDE t (or `right') specifies that the new window shall be located on
3661 the right side of WINDOW. SIDE `left' means the new window shall be
3662 located on the left of WINDOW. In both cases TOTAL-SIZE specifies the
3663 number of columns of the new window including space reserved for fringes
3664 and the scrollbar or a divider column.
3665
3666 Fourth argument NORMAL-SIZE specifies the normal size of the new window
3667 according to the SIDE argument.
3668
3669 The new total and normal sizes of all involved windows must have been
3670 set correctly. See the code of `split-window' for how this is done. */)
3671 (Lisp_Object old, Lisp_Object total_size, Lisp_Object side, Lisp_Object normal_size)
3672 {
3673 /* OLD (*o) is the window we have to split. (*p) is either OLD's
3674 parent window or an internal window we have to install as OLD's new
3675 parent. REFERENCE (*r) must denote a live window, or is set to OLD
3676 provided OLD is a leaf window, or to the frame's selected window.
3677 NEW (*n) is the new window created with some parameters taken from
3678 REFERENCE (*r). */
3679 register Lisp_Object new, frame, reference;
3680 register struct window *o, *p, *n, *r;
3681 struct frame *f;
3682 int horflag
3683 /* HORFLAG is 1 when we split side-by-side, 0 otherwise. */
3684 = EQ (side, Qt) || EQ (side, Qleft) || EQ (side, Qright);
3685 int do_nest = 0;
3686
3687 CHECK_WINDOW (old);
3688 o = XWINDOW (old);
3689 frame = WINDOW_FRAME (o);
3690 f = XFRAME (frame);
3691
3692 CHECK_NUMBER (total_size);
3693
3694 /* Set do_nest to 1 if we have to make a new parent window. We do
3695 that if either `window-nest' is non-nil, or OLD has no parent, or
3696 OLD is ortho-combined. */
3697 do_nest =
3698 !NILP (Vwindow_nest)
3699 || NILP (o->parent)
3700 || NILP (horflag
3701 ? (XWINDOW (o->parent)->hchild)
3702 : (XWINDOW (o->parent)->vchild));
3703
3704 /* We need a live reference window to initialize some parameters. */
3705 if (WINDOW_LIVE_P (old))
3706 /* OLD is live, use it as reference window. */
3707 reference = old;
3708 else
3709 /* Use the frame's selected window as reference window. */
3710 reference = FRAME_SELECTED_WINDOW (f);
3711 r = XWINDOW (reference);
3712
3713 /* The following bugs are caught by `split-window'. */
3714 if (MINI_WINDOW_P (o))
3715 error ("Attempt to split minibuffer window");
3716 else if (XINT (total_size) < (horflag ? 2 : 1))
3717 error ("Size of new window too small (after split)");
3718 else if (!do_nest && !NILP (Vwindow_splits))
3719 /* `window-splits' non-nil means try to resize OLD's siblings
3720 proportionally. */
3721 {
3722 p = XWINDOW (o->parent);
3723 /* Temporarily pretend we split the parent window. */
3724 XSETINT (p->new_total,
3725 XINT (horflag ? p->total_cols : p->total_lines)
3726 - XINT (total_size));
3727 if (!window_resize_check (p, horflag))
3728 error ("Window sizes don't fit");
3729 else
3730 /* Undo the temporary pretension. */
3731 p->new_total = horflag ? p->total_cols : p->total_lines;
3732 }
3733 else
3734 {
3735 if (!window_resize_check (o, horflag))
3736 error ("Resizing old window failed");
3737 else if (XINT (total_size) + XINT (o->new_total)
3738 != XINT (horflag ? o->total_cols : o->total_lines))
3739 error ("Sum of sizes of old and new window don't fit");
3740 }
3741
3742 /* This is our point of no return. */
3743 if (do_nest)
3744 {
3745 /* Save the old value of o->normal_cols/lines. It gets corrupted
3746 by make_parent_window and we need it below for assigning it to
3747 p->new_normal. */
3748 Lisp_Object new_normal = horflag ? o->normal_cols : o->normal_lines;
3749
3750 make_parent_window (old, horflag);
3751 p = XWINDOW (o->parent);
3752 /* Store value of `window-nest' in new parent's nest slot. */
3753 p->nest = Vwindow_nest;
3754 /* Have PARENT inherit splits slot value from OLD. */
3755 p->splits = o->splits;
3756 /* Store value of `window-splits' in OLD's splits slot. */
3757 o->splits = Vwindow_splits;
3758 /* These get applied below. */
3759 p->new_total = horflag ? o->total_cols : o->total_lines;
3760 p->new_normal = new_normal;
3761 }
3762 else
3763 p = XWINDOW (o->parent);
3764
3765 windows_or_buffers_changed++;
3766 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3767 new = make_window ();
3768 n = XWINDOW (new);
3769 n->frame = frame;
3770 n->parent = o->parent;
3771 n->vchild = n->hchild = Qnil;
3772
3773 if (EQ (side, Qabove) || EQ (side, Qleft))
3774 {
3775 n->prev = o->prev;
3776 if (NILP (n->prev))
3777 if (horflag)
3778 p->hchild = new;
3779 else
3780 p->vchild = new;
3781 else
3782 XWINDOW (n->prev)->next = new;
3783 n->next = old;
3784 o->prev = new;
3785 }
3786 else
3787 {
3788 n->next = o->next;
3789 if (!NILP (n->next))
3790 XWINDOW (n->next)->prev = new;
3791 n->prev = old;
3792 o->next = new;
3793 }
3794
3795 n->buffer = Qt;
3796 n->window_end_valid = Qnil;
3797 memset (&n->last_cursor, 0, sizeof n->last_cursor);
3798
3799 /* Get special geometry settings from reference window. */
3800 n->left_margin_cols = r->left_margin_cols;
3801 n->right_margin_cols = r->right_margin_cols;
3802 n->left_fringe_width = r->left_fringe_width;
3803 n->right_fringe_width = r->right_fringe_width;
3804 n->fringes_outside_margins = r->fringes_outside_margins;
3805 n->scroll_bar_width = r->scroll_bar_width;
3806 n->vertical_scroll_bar_type = r->vertical_scroll_bar_type;
3807
3808 /* Store `window-splits' in NEW's splits slot. */
3809 n->splits = Vwindow_splits;
3810
3811 /* Directly assign orthogonal coordinates and sizes. */
3812 if (horflag)
3813 {
3814 n->top_line = o->top_line;
3815 n->total_lines = o->total_lines;
3816 }
3817 else
3818 {
3819 n->left_col = o->left_col;
3820 n->total_cols = o->total_cols;
3821 }
3822
3823 /* Iso-coordinates and sizes are assigned by window_resize_apply,
3824 get them ready here. */
3825 n->new_total = total_size;
3826 n->new_normal = normal_size;
3827
3828 BLOCK_INPUT;
3829 window_resize_apply (p, horflag);
3830 adjust_glyphs (f);
3831 /* Set buffer of NEW to buffer of reference window. Don't run
3832 any hooks. */
3833 set_window_buffer (new, r->buffer, 0, 1);
3834 UNBLOCK_INPUT;
3835
3836 /* Maybe we should run the scroll functions in Elisp (which already
3837 runs the configuration change hook). */
3838 if (! NILP (Vwindow_scroll_functions))
3839 run_hook_with_args_2 (Qwindow_scroll_functions, new,
3840 Fmarker_position (n->start));
3841 /* Return NEW. */
3842 return new;
3843 }
3844
3845
3846 DEFUN ("delete-window-internal", Fdelete_window_internal, Sdelete_window_internal, 1, 1, 0,
3847 doc: /* Remove WINDOW from its frame.
3848 WINDOW defaults to the selected window. Return nil. Signal an error
3849 when WINDOW is the only window on its frame. */)
3850 (register Lisp_Object window)
3851 {
3852 register Lisp_Object parent, sibling, frame, root;
3853 struct window *w, *p, *s, *r;
3854 struct frame *f;
3855 int horflag;
3856 int before_sibling = 0;
3857
3858 w = decode_any_window (window);
3859 XSETWINDOW (window, w);
3860 if (NILP (w->buffer) && NILP (w->hchild) && NILP (w->vchild))
3861 /* It's a no-op to delete an already deleted window. */
3862 return Qnil;
3863
3864 parent = w->parent;
3865 if (NILP (parent))
3866 /* Never delete a minibuffer or frame root window. */
3867 error ("Attempt to delete minibuffer or sole ordinary window");
3868 else if (NILP (w->prev) && NILP (w->next))
3869 /* Rather bow out here, this case should be handled on the Elisp
3870 level. */
3871 error ("Attempt to delete sole window of parent");
3872
3873 p = XWINDOW (parent);
3874 horflag = NILP (p->vchild);
3875
3876 frame = WINDOW_FRAME (w);
3877 f = XFRAME (frame);
3878
3879 root = FRAME_ROOT_WINDOW (f);
3880 r = XWINDOW (root);
3881
3882 /* Unlink WINDOW from window tree. */
3883 if (NILP (w->prev))
3884 /* Get SIBLING below (on the right of) WINDOW. */
3885 {
3886 /* before_sibling 1 means WINDOW is the first child of its
3887 parent and thus before the sibling. */
3888 before_sibling = 1;
3889 sibling = w->next;
3890 s = XWINDOW (sibling);
3891 s->prev = Qnil;
3892 if (horflag)
3893 p->hchild = sibling;
3894 else
3895 p->vchild = sibling;
3896 }
3897 else
3898 /* Get SIBLING above (on the left of) WINDOW. */
3899 {
3900 sibling = w->prev;
3901 s = XWINDOW (sibling);
3902 s->next = w->next;
3903 if (!NILP (s->next))
3904 XWINDOW (s->next)->prev = sibling;
3905 }
3906
3907 if (window_resize_check (r, horflag)
3908 && EQ (r->new_total, (horflag ? r->total_cols : r->total_lines)))
3909 /* We can delete WINDOW now. */
3910 {
3911 /* Block input. */
3912 BLOCK_INPUT;
3913 window_resize_apply (p, horflag);
3914
3915 windows_or_buffers_changed++;
3916 Vwindow_list = Qnil;
3917 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3918
3919 w->next = Qnil; /* Don't delete w->next too. */
3920 free_window_matrices (w);
3921
3922 if (!NILP (w->vchild))
3923 {
3924 delete_all_subwindows (w->vchild);
3925 w->vchild = Qnil;
3926 }
3927 else if (!NILP (w->hchild))
3928 {
3929 delete_all_subwindows (w->hchild);
3930 w->hchild = Qnil;
3931 }
3932 else if (!NILP (w->buffer))
3933 {
3934 unshow_buffer (w);
3935 unchain_marker (XMARKER (w->pointm));
3936 unchain_marker (XMARKER (w->start));
3937 w->buffer = Qnil;
3938 }
3939
3940 if (NILP (s->prev) && NILP (s->next))
3941 /* A matrjoshka where SIBLING has become the only child of
3942 PARENT. */
3943 {
3944 /* Put SIBLING into PARENT's place. */
3945 replace_window (parent, sibling, 0);
3946 /* Have SIBLING inherit the following three slot values from
3947 PARENT (the nest slot is not inherited). */
3948 s->normal_cols = p->normal_cols;
3949 s->normal_lines = p->normal_lines;
3950 s->splits = p->splits;
3951 /* Mark PARENT as deleted. */
3952 p->vchild = p->hchild = Qnil;
3953 /* Try to merge SIBLING into its new parent. */
3954 recombine_windows (sibling);
3955 }
3956
3957 adjust_glyphs (f);
3958
3959 if (!WINDOW_LIVE_P (FRAME_SELECTED_WINDOW (f)))
3960 /* We deleted the frame's selected window. */
3961 {
3962 /* Use the frame's first window as fallback ... */
3963 Lisp_Object new_selected_window = Fframe_first_window (frame);
3964 /* ... but preferably use its most recently used window. */
3965 Lisp_Object mru_window;
3966
3967 /* `get-mru-window' might fail for some reason so play it safe
3968 - promote the first window _without recording it_ first. */
3969 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
3970 Fselect_window (new_selected_window, Qt);
3971 else
3972 FRAME_SELECTED_WINDOW (f) = new_selected_window;
3973
3974 UNBLOCK_INPUT;
3975
3976 /* Now look whether `get-mru-window' gets us something. */
3977 mru_window = call1 (Qget_mru_window, frame);
3978 if (WINDOW_LIVE_P (mru_window)
3979 && EQ (XWINDOW (mru_window)->frame, frame))
3980 new_selected_window = mru_window;
3981
3982 /* If all ended up well, we now promote the mru window. */
3983 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
3984 Fselect_window (new_selected_window, Qnil);
3985 else
3986 FRAME_SELECTED_WINDOW (f) = new_selected_window;
3987 }
3988 else
3989 UNBLOCK_INPUT;
3990
3991 /* Must be run by the caller:
3992 run_window_configuration_change_hook (f); */
3993 }
3994 else
3995 /* We failed: Relink WINDOW into window tree. */
3996 {
3997 if (before_sibling)
3998 {
3999 s->prev = window;
4000 if (horflag)
4001 p->hchild = window;
4002 else
4003 p->vchild = window;
4004 }
4005 else
4006 {
4007 s->next = window;
4008 if (!NILP (w->next))
4009 XWINDOW (w->next)->prev = window;
4010 }
4011 error ("Deletion failed");
4012 }
4013
4014 return Qnil;
4015 }
4016 \f
4017 /***********************************************************************
4018 Resizing Mini-Windows
4019 ***********************************************************************/
4020
4021 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we
4022 can. */
4023 void
4024 grow_mini_window (struct window *w, int delta)
4025 {
4026 struct frame *f = XFRAME (w->frame);
4027 struct window *r;
4028 Lisp_Object root, value;
4029
4030 xassert (MINI_WINDOW_P (w));
4031 xassert (delta >= 0);
4032
4033 root = FRAME_ROOT_WINDOW (f);
4034 r = XWINDOW (root);
4035 value = call2 (Qwindow_resize_root_window_vertically,
4036 root, make_number (- delta));
4037 if (INTEGERP (value) && window_resize_check (r, 0))
4038 {
4039 BLOCK_INPUT;
4040 window_resize_apply (r, 0);
4041
4042 /* Grow the mini-window. */
4043 XSETFASTINT (w->top_line, XFASTINT (r->top_line) + XFASTINT (r->total_lines));
4044 XSETFASTINT (w->total_lines, XFASTINT (w->total_lines) - XINT (value));
4045 XSETFASTINT (w->last_modified, 0);
4046 XSETFASTINT (w->last_overlay_modified, 0);
4047
4048 adjust_glyphs (f);
4049 UNBLOCK_INPUT;
4050 }
4051 }
4052
4053
4054 /* Shrink mini-window W. */
4055 void
4056 shrink_mini_window (struct window *w)
4057 {
4058 struct frame *f = XFRAME (w->frame);
4059 struct window *r;
4060 Lisp_Object root, value;
4061 EMACS_INT size;
4062
4063 xassert (MINI_WINDOW_P (w));
4064
4065 size = XINT (w->total_lines);
4066 if (size > 1)
4067 {
4068 root = FRAME_ROOT_WINDOW (f);
4069 r = XWINDOW (root);
4070 value = call2 (Qwindow_resize_root_window_vertically,
4071 root, make_number (size - 1));
4072 if (INTEGERP (value) && window_resize_check (r, 0))
4073 {
4074 BLOCK_INPUT;
4075 window_resize_apply (r, 0);
4076
4077 /* Shrink the mini-window. */
4078 XSETFASTINT (w->top_line, XFASTINT (r->top_line) + XFASTINT (r->total_lines));
4079 XSETFASTINT (w->total_lines, 1);
4080
4081 XSETFASTINT (w->last_modified, 0);
4082 XSETFASTINT (w->last_overlay_modified, 0);
4083
4084 adjust_glyphs (f);
4085 UNBLOCK_INPUT;
4086 }
4087 /* If the above failed for whatever strange reason we must make a
4088 one window frame here. The same routine will be needed when
4089 shrinking the frame (and probably when making the initial
4090 *scratch* window). For the moment leave things as they are. */
4091 }
4092 }
4093
4094 DEFUN ("resize-mini-window-internal", Fresize_mini_window_internal, Sresize_mini_window_internal, 1, 1, 0,
4095 doc: /* Resize minibuffer window WINDOW. */)
4096 (Lisp_Object window)
4097 {
4098 struct window *w = XWINDOW (window);
4099 struct window *r;
4100 struct frame *f;
4101 int height;
4102
4103 CHECK_WINDOW (window);
4104 f = XFRAME (w->frame);
4105
4106 if (!EQ (FRAME_MINIBUF_WINDOW (XFRAME (w->frame)), window))
4107 error ("Not a valid minibuffer window");
4108 else if (FRAME_MINIBUF_ONLY_P (f))
4109 error ("Cannot resize a minibuffer-only frame");
4110
4111 r = XWINDOW (FRAME_ROOT_WINDOW (f));
4112 height = XINT (r->total_lines) + XINT (w->total_lines);
4113 if (window_resize_check (r, 0)
4114 && XINT (w->new_total) > 0
4115 && height == XINT (r->new_total) + XINT (w->new_total))
4116 {
4117 BLOCK_INPUT;
4118 window_resize_apply (r, 0);
4119
4120 w->total_lines = w->new_total;
4121 XSETFASTINT (w->top_line, XINT (r->top_line) + XINT (r->total_lines));
4122
4123 windows_or_buffers_changed++;
4124 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4125 adjust_glyphs (f);
4126 UNBLOCK_INPUT;
4127
4128 run_window_configuration_change_hook (f);
4129 return Qt;
4130 }
4131 else error ("Failed to resize minibuffer window");
4132 }
4133 \f
4134 /* Mark window cursors off for all windows in the window tree rooted
4135 at W by setting their phys_cursor_on_p flag to zero. Called from
4136 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4137 the frame are cleared. */
4138
4139 void
4140 mark_window_cursors_off (struct window *w)
4141 {
4142 while (w)
4143 {
4144 if (!NILP (w->hchild))
4145 mark_window_cursors_off (XWINDOW (w->hchild));
4146 else if (!NILP (w->vchild))
4147 mark_window_cursors_off (XWINDOW (w->vchild));
4148 else
4149 w->phys_cursor_on_p = 0;
4150
4151 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4152 }
4153 }
4154
4155
4156 /* Return number of lines of text (not counting mode lines) in W. */
4157
4158 int
4159 window_internal_height (struct window *w)
4160 {
4161 int ht = XFASTINT (w->total_lines);
4162
4163 if (!MINI_WINDOW_P (w))
4164 {
4165 if (!NILP (w->parent)
4166 || !NILP (w->vchild)
4167 || !NILP (w->hchild)
4168 || !NILP (w->next)
4169 || !NILP (w->prev)
4170 || WINDOW_WANTS_MODELINE_P (w))
4171 --ht;
4172
4173 if (WINDOW_WANTS_HEADER_LINE_P (w))
4174 --ht;
4175 }
4176
4177 return ht;
4178 }
4179 \f
4180 /************************************************************************
4181 Window Scrolling
4182 ***********************************************************************/
4183
4184 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4185 N screen-fulls, which is defined as the height of the window minus
4186 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4187 instead. Negative values of N mean scroll down. NOERROR non-zero
4188 means don't signal an error if we try to move over BEGV or ZV,
4189 respectively. */
4190
4191 static void
4192 window_scroll (Lisp_Object window, int n, int whole, int noerror)
4193 {
4194 immediate_quit = 1;
4195
4196 /* If we must, use the pixel-based version which is much slower than
4197 the line-based one but can handle varying line heights. */
4198 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4199 window_scroll_pixel_based (window, n, whole, noerror);
4200 else
4201 window_scroll_line_based (window, n, whole, noerror);
4202
4203 immediate_quit = 0;
4204 }
4205
4206
4207 /* Implementation of window_scroll that works based on pixel line
4208 heights. See the comment of window_scroll for parameter
4209 descriptions. */
4210
4211 static void
4212 window_scroll_pixel_based (Lisp_Object window, int n, int whole, int noerror)
4213 {
4214 struct it it;
4215 struct window *w = XWINDOW (window);
4216 struct text_pos start;
4217 int this_scroll_margin;
4218 /* True if we fiddled the window vscroll field without really scrolling. */
4219 int vscrolled = 0;
4220 int x, y, rtop, rbot, rowh, vpos;
4221 void *itdata = NULL;
4222
4223 SET_TEXT_POS_FROM_MARKER (start, w->start);
4224
4225 /* If PT is not visible in WINDOW, move back one half of
4226 the screen. Allow PT to be partially visible, otherwise
4227 something like (scroll-down 1) with PT in the line before
4228 the partially visible one would recenter. */
4229
4230 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4231 {
4232 itdata = bidi_shelve_cache ();
4233 /* Move backward half the height of the window. Performance note:
4234 vmotion used here is about 10% faster, but would give wrong
4235 results for variable height lines. */
4236 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4237 it.current_y = it.last_visible_y;
4238 move_it_vertically_backward (&it, window_box_height (w) / 2);
4239
4240 /* The function move_iterator_vertically may move over more than
4241 the specified y-distance. If it->w is small, e.g. a
4242 mini-buffer window, we may end up in front of the window's
4243 display area. This is the case when Start displaying at the
4244 start of the line containing PT in this case. */
4245 if (it.current_y <= 0)
4246 {
4247 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4248 move_it_vertically_backward (&it, 0);
4249 it.current_y = 0;
4250 }
4251
4252 start = it.current.pos;
4253 bidi_unshelve_cache (itdata, 0);
4254 }
4255 else if (auto_window_vscroll_p)
4256 {
4257 if (rtop || rbot) /* partially visible */
4258 {
4259 int px;
4260 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4261 if (whole)
4262 dy = max ((window_box_height (w)
4263 - next_screen_context_lines * dy),
4264 dy);
4265 dy *= n;
4266
4267 if (n < 0)
4268 {
4269 /* Only vscroll backwards if already vscrolled forwards. */
4270 if (w->vscroll < 0 && rtop > 0)
4271 {
4272 px = max (0, -w->vscroll - min (rtop, -dy));
4273 Fset_window_vscroll (window, make_number (px), Qt);
4274 return;
4275 }
4276 }
4277 if (n > 0)
4278 {
4279 /* Do vscroll if already vscrolled or only display line. */
4280 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4281 {
4282 px = max (0, -w->vscroll + min (rbot, dy));
4283 Fset_window_vscroll (window, make_number (px), Qt);
4284 return;
4285 }
4286
4287 /* Maybe modify window start instead of scrolling. */
4288 if (rbot > 0 || w->vscroll < 0)
4289 {
4290 EMACS_INT spos;
4291
4292 Fset_window_vscroll (window, make_number (0), Qt);
4293 /* If there are other text lines above the current row,
4294 move window start to current row. Else to next row. */
4295 if (rbot > 0)
4296 spos = XINT (Fline_beginning_position (Qnil));
4297 else
4298 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4299 set_marker_restricted (w->start, make_number (spos),
4300 w->buffer);
4301 w->start_at_line_beg = Qt;
4302 w->update_mode_line = Qt;
4303 XSETFASTINT (w->last_modified, 0);
4304 XSETFASTINT (w->last_overlay_modified, 0);
4305 /* Set force_start so that redisplay_window will run the
4306 window-scroll-functions. */
4307 w->force_start = Qt;
4308 return;
4309 }
4310 }
4311 }
4312 /* Cancel previous vscroll. */
4313 Fset_window_vscroll (window, make_number (0), Qt);
4314 }
4315
4316 itdata = bidi_shelve_cache ();
4317 /* If scroll_preserve_screen_position is non-nil, we try to set
4318 point in the same window line as it is now, so get that line. */
4319 if (!NILP (Vscroll_preserve_screen_position))
4320 {
4321 /* We preserve the goal pixel coordinate across consecutive
4322 calls to scroll-up, scroll-down and other commands that
4323 have the `scroll-command' property. This avoids the
4324 possibility of point becoming "stuck" on a tall line when
4325 scrolling by one line. */
4326 if (window_scroll_pixel_based_preserve_y < 0
4327 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4328 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4329 {
4330 start_display (&it, w, start);
4331 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4332 window_scroll_pixel_based_preserve_y = it.current_y;
4333 window_scroll_pixel_based_preserve_x = it.current_x;
4334 }
4335 }
4336 else
4337 window_scroll_pixel_based_preserve_y
4338 = window_scroll_pixel_based_preserve_x = -1;
4339
4340 /* Move iterator it from start the specified distance forward or
4341 backward. The result is the new window start. */
4342 start_display (&it, w, start);
4343 if (whole)
4344 {
4345 EMACS_INT start_pos = IT_CHARPOS (it);
4346 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4347 dy = max ((window_box_height (w)
4348 - next_screen_context_lines * dy),
4349 dy) * n;
4350
4351 /* Note that move_it_vertically always moves the iterator to the
4352 start of a line. So, if the last line doesn't have a newline,
4353 we would end up at the start of the line ending at ZV. */
4354 if (dy <= 0)
4355 {
4356 move_it_vertically_backward (&it, -dy);
4357 /* Ensure we actually do move, e.g. in case we are currently
4358 looking at an image that is taller that the window height. */
4359 while (start_pos == IT_CHARPOS (it)
4360 && start_pos > BEGV)
4361 move_it_by_lines (&it, -1);
4362 }
4363 else if (dy > 0)
4364 {
4365 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4366 MOVE_TO_POS | MOVE_TO_Y);
4367 /* Ensure we actually do move, e.g. in case we are currently
4368 looking at an image that is taller that the window height. */
4369 while (start_pos == IT_CHARPOS (it)
4370 && start_pos < ZV)
4371 move_it_by_lines (&it, 1);
4372 }
4373 }
4374 else
4375 move_it_by_lines (&it, n);
4376
4377 /* We failed if we find ZV is already on the screen (scrolling up,
4378 means there's nothing past the end), or if we can't start any
4379 earlier (scrolling down, means there's nothing past the top). */
4380 if ((n > 0 && IT_CHARPOS (it) == ZV)
4381 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4382 {
4383 if (IT_CHARPOS (it) == ZV)
4384 {
4385 if (it.current_y < it.last_visible_y
4386 && (it.current_y + it.max_ascent + it.max_descent
4387 > it.last_visible_y))
4388 {
4389 /* The last line was only partially visible, make it fully
4390 visible. */
4391 w->vscroll = (it.last_visible_y
4392 - it.current_y + it.max_ascent + it.max_descent);
4393 adjust_glyphs (it.f);
4394 }
4395 else
4396 {
4397 bidi_unshelve_cache (itdata, 0);
4398 if (noerror)
4399 return;
4400 else if (n < 0) /* could happen with empty buffers */
4401 xsignal0 (Qbeginning_of_buffer);
4402 else
4403 xsignal0 (Qend_of_buffer);
4404 }
4405 }
4406 else
4407 {
4408 if (w->vscroll != 0)
4409 /* The first line was only partially visible, make it fully
4410 visible. */
4411 w->vscroll = 0;
4412 else
4413 {
4414 bidi_unshelve_cache (itdata, 0);
4415 if (noerror)
4416 return;
4417 else
4418 xsignal0 (Qbeginning_of_buffer);
4419 }
4420 }
4421
4422 /* If control gets here, then we vscrolled. */
4423
4424 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4425
4426 /* Don't try to change the window start below. */
4427 vscrolled = 1;
4428 }
4429
4430 if (! vscrolled)
4431 {
4432 EMACS_INT pos = IT_CHARPOS (it);
4433 EMACS_INT bytepos;
4434
4435 /* If in the middle of a multi-glyph character move forward to
4436 the next character. */
4437 if (in_display_vector_p (&it))
4438 {
4439 ++pos;
4440 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4441 }
4442
4443 /* Set the window start, and set up the window for redisplay. */
4444 set_marker_restricted (w->start, make_number (pos),
4445 w->buffer);
4446 bytepos = XMARKER (w->start)->bytepos;
4447 w->start_at_line_beg = ((pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n')
4448 ? Qt : Qnil);
4449 w->update_mode_line = Qt;
4450 XSETFASTINT (w->last_modified, 0);
4451 XSETFASTINT (w->last_overlay_modified, 0);
4452 /* Set force_start so that redisplay_window will run the
4453 window-scroll-functions. */
4454 w->force_start = Qt;
4455 }
4456
4457 /* The rest of this function uses current_y in a nonstandard way,
4458 not including the height of the header line if any. */
4459 it.current_y = it.vpos = 0;
4460
4461 /* Move PT out of scroll margins.
4462 This code wants current_y to be zero at the window start position
4463 even if there is a header line. */
4464 this_scroll_margin = max (0, scroll_margin);
4465 this_scroll_margin = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
4466 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
4467
4468 if (n > 0)
4469 {
4470 /* We moved the window start towards ZV, so PT may be now
4471 in the scroll margin at the top. */
4472 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4473 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
4474 && (NILP (Vscroll_preserve_screen_position)
4475 || EQ (Vscroll_preserve_screen_position, Qt)))
4476 /* We found PT at a legitimate height. Leave it alone. */
4477 ;
4478 else if (window_scroll_pixel_based_preserve_y >= 0)
4479 {
4480 /* If we have a header line, take account of it.
4481 This is necessary because we set it.current_y to 0, above. */
4482 move_it_to (&it, -1,
4483 window_scroll_pixel_based_preserve_x,
4484 window_scroll_pixel_based_preserve_y
4485 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
4486 -1, MOVE_TO_Y | MOVE_TO_X);
4487 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4488 }
4489 else
4490 {
4491 while (it.current_y < this_scroll_margin)
4492 {
4493 int prev = it.current_y;
4494 move_it_by_lines (&it, 1);
4495 if (prev == it.current_y)
4496 break;
4497 }
4498 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4499 }
4500 }
4501 else if (n < 0)
4502 {
4503 EMACS_INT charpos, bytepos;
4504 int partial_p;
4505
4506 /* Save our position, for the
4507 window_scroll_pixel_based_preserve_y case. */
4508 charpos = IT_CHARPOS (it);
4509 bytepos = IT_BYTEPOS (it);
4510
4511 /* We moved the window start towards BEGV, so PT may be now
4512 in the scroll margin at the bottom. */
4513 move_it_to (&it, PT, -1,
4514 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
4515 - this_scroll_margin - 1),
4516 -1,
4517 MOVE_TO_POS | MOVE_TO_Y);
4518
4519 /* Save our position, in case it's correct. */
4520 charpos = IT_CHARPOS (it);
4521 bytepos = IT_BYTEPOS (it);
4522
4523 /* See if point is on a partially visible line at the end. */
4524 if (it.what == IT_EOB)
4525 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
4526 else
4527 {
4528 move_it_by_lines (&it, 1);
4529 partial_p = it.current_y > it.last_visible_y;
4530 }
4531
4532 if (charpos == PT && !partial_p
4533 && (NILP (Vscroll_preserve_screen_position)
4534 || EQ (Vscroll_preserve_screen_position, Qt)))
4535 /* We found PT before we found the display margin, so PT is ok. */
4536 ;
4537 else if (window_scroll_pixel_based_preserve_y >= 0)
4538 {
4539 SET_TEXT_POS_FROM_MARKER (start, w->start);
4540 start_display (&it, w, start);
4541 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
4542 here because we called start_display again and did not
4543 alter it.current_y this time. */
4544 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
4545 window_scroll_pixel_based_preserve_y, -1,
4546 MOVE_TO_Y | MOVE_TO_X);
4547 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4548 }
4549 else
4550 {
4551 if (partial_p)
4552 /* The last line was only partially visible, so back up two
4553 lines to make sure we're on a fully visible line. */
4554 {
4555 move_it_by_lines (&it, -2);
4556 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4557 }
4558 else
4559 /* No, the position we saved is OK, so use it. */
4560 SET_PT_BOTH (charpos, bytepos);
4561 }
4562 }
4563 bidi_unshelve_cache (itdata, 0);
4564 }
4565
4566
4567 /* Implementation of window_scroll that works based on screen lines.
4568 See the comment of window_scroll for parameter descriptions. */
4569
4570 static void
4571 window_scroll_line_based (Lisp_Object window, int n, int whole, int noerror)
4572 {
4573 register struct window *w = XWINDOW (window);
4574 /* Fvertical_motion enters redisplay, which can trigger
4575 fontification, which in turn can modify buffer text (e.g., if the
4576 fontification functions replace escape sequences with faces, as
4577 in `grep-mode-font-lock-keywords'). So we use a marker to record
4578 the old point position, to prevent crashes in SET_PT_BOTH. */
4579 Lisp_Object opoint_marker = Fpoint_marker ();
4580 register EMACS_INT pos, pos_byte;
4581 register int ht = window_internal_height (w);
4582 register Lisp_Object tem;
4583 int lose;
4584 Lisp_Object bolp;
4585 EMACS_INT startpos;
4586 Lisp_Object original_pos = Qnil;
4587
4588 /* If scrolling screen-fulls, compute the number of lines to
4589 scroll from the window's height. */
4590 if (whole)
4591 n *= max (1, ht - next_screen_context_lines);
4592
4593 startpos = marker_position (w->start);
4594
4595 if (!NILP (Vscroll_preserve_screen_position))
4596 {
4597 if (window_scroll_preserve_vpos <= 0
4598 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4599 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4600 {
4601 struct position posit
4602 = *compute_motion (startpos, 0, 0, 0,
4603 PT, ht, 0,
4604 -1, XINT (w->hscroll),
4605 0, w);
4606 window_scroll_preserve_vpos = posit.vpos;
4607 window_scroll_preserve_hpos = posit.hpos + XINT (w->hscroll);
4608 }
4609
4610 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
4611 make_number (window_scroll_preserve_vpos));
4612 }
4613
4614 XSETFASTINT (tem, PT);
4615 tem = Fpos_visible_in_window_p (tem, window, Qnil);
4616
4617 if (NILP (tem))
4618 {
4619 Fvertical_motion (make_number (- (ht / 2)), window);
4620 startpos = PT;
4621 }
4622
4623 SET_PT (startpos);
4624 lose = n < 0 && PT == BEGV;
4625 Fvertical_motion (make_number (n), window);
4626 pos = PT;
4627 pos_byte = PT_BYTE;
4628 bolp = Fbolp ();
4629 SET_PT_BOTH (marker_position (opoint_marker),
4630 marker_byte_position (opoint_marker));
4631
4632 if (lose)
4633 {
4634 if (noerror)
4635 return;
4636 else
4637 xsignal0 (Qbeginning_of_buffer);
4638 }
4639
4640 if (pos < ZV)
4641 {
4642 /* Don't use a scroll margin that is negative or too large. */
4643 int this_scroll_margin =
4644 max (0, min (scroll_margin, XINT (w->total_lines) / 4));
4645
4646 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
4647 w->start_at_line_beg = bolp;
4648 w->update_mode_line = Qt;
4649 XSETFASTINT (w->last_modified, 0);
4650 XSETFASTINT (w->last_overlay_modified, 0);
4651 /* Set force_start so that redisplay_window will run
4652 the window-scroll-functions. */
4653 w->force_start = Qt;
4654
4655 if (!NILP (Vscroll_preserve_screen_position)
4656 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
4657 {
4658 SET_PT_BOTH (pos, pos_byte);
4659 Fvertical_motion (original_pos, window);
4660 }
4661 /* If we scrolled forward, put point enough lines down
4662 that it is outside the scroll margin. */
4663 else if (n > 0)
4664 {
4665 int top_margin;
4666
4667 if (this_scroll_margin > 0)
4668 {
4669 SET_PT_BOTH (pos, pos_byte);
4670 Fvertical_motion (make_number (this_scroll_margin), window);
4671 top_margin = PT;
4672 }
4673 else
4674 top_margin = pos;
4675
4676 if (top_margin <= marker_position (opoint_marker))
4677 SET_PT_BOTH (marker_position (opoint_marker),
4678 marker_byte_position (opoint_marker));
4679 else if (!NILP (Vscroll_preserve_screen_position))
4680 {
4681 SET_PT_BOTH (pos, pos_byte);
4682 Fvertical_motion (original_pos, window);
4683 }
4684 else
4685 SET_PT (top_margin);
4686 }
4687 else if (n < 0)
4688 {
4689 int bottom_margin;
4690
4691 /* If we scrolled backward, put point near the end of the window
4692 but not within the scroll margin. */
4693 SET_PT_BOTH (pos, pos_byte);
4694 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
4695 if (XFASTINT (tem) == ht - this_scroll_margin)
4696 bottom_margin = PT;
4697 else
4698 bottom_margin = PT + 1;
4699
4700 if (bottom_margin > marker_position (opoint_marker))
4701 SET_PT_BOTH (marker_position (opoint_marker),
4702 marker_byte_position (opoint_marker));
4703 else
4704 {
4705 if (!NILP (Vscroll_preserve_screen_position))
4706 {
4707 SET_PT_BOTH (pos, pos_byte);
4708 Fvertical_motion (original_pos, window);
4709 }
4710 else
4711 Fvertical_motion (make_number (-1), window);
4712 }
4713 }
4714 }
4715 else
4716 {
4717 if (noerror)
4718 return;
4719 else
4720 xsignal0 (Qend_of_buffer);
4721 }
4722 }
4723
4724
4725 /* Scroll selected_window up or down. If N is nil, scroll a
4726 screen-full which is defined as the height of the window minus
4727 next_screen_context_lines. If N is the symbol `-', scroll.
4728 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4729 up. This is the guts of Fscroll_up and Fscroll_down. */
4730
4731 static void
4732 scroll_command (Lisp_Object n, int direction)
4733 {
4734 int count = SPECPDL_INDEX ();
4735
4736 xassert (eabs (direction) == 1);
4737
4738 /* If selected window's buffer isn't current, make it current for
4739 the moment. But don't screw up if window_scroll gets an error. */
4740 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
4741 {
4742 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4743 Fset_buffer (XWINDOW (selected_window)->buffer);
4744
4745 /* Make redisplay consider other windows than just selected_window. */
4746 ++windows_or_buffers_changed;
4747 }
4748
4749 if (NILP (n))
4750 window_scroll (selected_window, direction, 1, 0);
4751 else if (EQ (n, Qminus))
4752 window_scroll (selected_window, -direction, 1, 0);
4753 else
4754 {
4755 n = Fprefix_numeric_value (n);
4756 window_scroll (selected_window, XINT (n) * direction, 0, 0);
4757 }
4758
4759 unbind_to (count, Qnil);
4760 }
4761
4762 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
4763 doc: /* Scroll text of selected window upward ARG lines.
4764 If ARG is omitted or nil, scroll upward by a near full screen.
4765 A near full screen is `next-screen-context-lines' less than a full screen.
4766 Negative ARG means scroll downward.
4767 If ARG is the atom `-', scroll downward by nearly full screen.
4768 When calling from a program, supply as argument a number, nil, or `-'. */)
4769 (Lisp_Object arg)
4770 {
4771 scroll_command (arg, 1);
4772 return Qnil;
4773 }
4774
4775 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
4776 doc: /* Scroll text of selected window down ARG lines.
4777 If ARG is omitted or nil, scroll down by a near full screen.
4778 A near full screen is `next-screen-context-lines' less than a full screen.
4779 Negative ARG means scroll upward.
4780 If ARG is the atom `-', scroll upward by nearly full screen.
4781 When calling from a program, supply as argument a number, nil, or `-'. */)
4782 (Lisp_Object arg)
4783 {
4784 scroll_command (arg, -1);
4785 return Qnil;
4786 }
4787 \f
4788 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
4789 doc: /* Return the other window for \"other window scroll\" commands.
4790 If `other-window-scroll-buffer' is non-nil, a window
4791 showing that buffer is used.
4792 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4793 specifies the window. This takes precedence over
4794 `other-window-scroll-buffer'. */)
4795 (void)
4796 {
4797 Lisp_Object window;
4798
4799 if (MINI_WINDOW_P (XWINDOW (selected_window))
4800 && !NILP (Vminibuf_scroll_window))
4801 window = Vminibuf_scroll_window;
4802 /* If buffer is specified, scroll that buffer. */
4803 else if (!NILP (Vother_window_scroll_buffer))
4804 {
4805 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
4806 if (NILP (window))
4807 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
4808 }
4809 else
4810 {
4811 /* Nothing specified; look for a neighboring window on the same
4812 frame. */
4813 window = Fnext_window (selected_window, Qnil, Qnil);
4814
4815 if (EQ (window, selected_window))
4816 /* That didn't get us anywhere; look for a window on another
4817 visible frame. */
4818 do
4819 window = Fnext_window (window, Qnil, Qt);
4820 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
4821 && ! EQ (window, selected_window));
4822 }
4823
4824 CHECK_LIVE_WINDOW (window);
4825
4826 if (EQ (window, selected_window))
4827 error ("There is no other window");
4828
4829 return window;
4830 }
4831
4832 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
4833 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
4834 A near full screen is `next-screen-context-lines' less than a full screen.
4835 The next window is the one below the current one; or the one at the top
4836 if the current one is at the bottom. Negative ARG means scroll downward.
4837 If ARG is the atom `-', scroll downward by nearly full screen.
4838 When calling from a program, supply as argument a number, nil, or `-'.
4839
4840 If `other-window-scroll-buffer' is non-nil, scroll the window
4841 showing that buffer, popping the buffer up if necessary.
4842 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4843 specifies the window to scroll. This takes precedence over
4844 `other-window-scroll-buffer'. */)
4845 (Lisp_Object arg)
4846 {
4847 Lisp_Object window;
4848 struct window *w;
4849 int count = SPECPDL_INDEX ();
4850
4851 window = Fother_window_for_scrolling ();
4852 w = XWINDOW (window);
4853
4854 /* Don't screw up if window_scroll gets an error. */
4855 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4856 ++windows_or_buffers_changed;
4857
4858 Fset_buffer (w->buffer);
4859 SET_PT (marker_position (w->pointm));
4860
4861 if (NILP (arg))
4862 window_scroll (window, 1, 1, 1);
4863 else if (EQ (arg, Qminus))
4864 window_scroll (window, -1, 1, 1);
4865 else
4866 {
4867 if (CONSP (arg))
4868 arg = Fcar (arg);
4869 CHECK_NUMBER (arg);
4870 window_scroll (window, XINT (arg), 0, 1);
4871 }
4872
4873 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
4874 unbind_to (count, Qnil);
4875
4876 return Qnil;
4877 }
4878 \f
4879 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
4880 doc: /* Scroll selected window display ARG columns left.
4881 Default for ARG is window width minus 2.
4882 Value is the total amount of leftward horizontal scrolling in
4883 effect after the change.
4884 If SET-MINIMUM is non-nil, the new scroll amount becomes the
4885 lower bound for automatic scrolling, i.e. automatic scrolling
4886 will not scroll a window to a column less than the value returned
4887 by this function. This happens in an interactive call. */)
4888 (register Lisp_Object arg, Lisp_Object set_minimum)
4889 {
4890 Lisp_Object result;
4891 int hscroll;
4892 struct window *w = XWINDOW (selected_window);
4893
4894 if (NILP (arg))
4895 XSETFASTINT (arg, window_body_cols (w) - 2);
4896 else
4897 arg = Fprefix_numeric_value (arg);
4898
4899 hscroll = XINT (w->hscroll) + XINT (arg);
4900 result = Fset_window_hscroll (selected_window, make_number (hscroll));
4901
4902 if (!NILP (set_minimum))
4903 w->min_hscroll = w->hscroll;
4904
4905 return result;
4906 }
4907
4908 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
4909 doc: /* Scroll selected window display ARG columns right.
4910 Default for ARG is window width minus 2.
4911 Value is the total amount of leftward horizontal scrolling in
4912 effect after the change.
4913 If SET-MINIMUM is non-nil, the new scroll amount becomes the
4914 lower bound for automatic scrolling, i.e. automatic scrolling
4915 will not scroll a window to a column less than the value returned
4916 by this function. This happens in an interactive call. */)
4917 (register Lisp_Object arg, Lisp_Object set_minimum)
4918 {
4919 Lisp_Object result;
4920 int hscroll;
4921 struct window *w = XWINDOW (selected_window);
4922
4923 if (NILP (arg))
4924 XSETFASTINT (arg, window_body_cols (w) - 2);
4925 else
4926 arg = Fprefix_numeric_value (arg);
4927
4928 hscroll = XINT (w->hscroll) - XINT (arg);
4929 result = Fset_window_hscroll (selected_window, make_number (hscroll));
4930
4931 if (!NILP (set_minimum))
4932 w->min_hscroll = w->hscroll;
4933
4934 return result;
4935 }
4936
4937 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
4938 doc: /* Return the window which was selected when entering the minibuffer.
4939 Returns nil, if selected window is not a minibuffer window. */)
4940 (void)
4941 {
4942 if (minibuf_level > 0
4943 && MINI_WINDOW_P (XWINDOW (selected_window))
4944 && WINDOW_LIVE_P (minibuf_selected_window))
4945 return minibuf_selected_window;
4946
4947 return Qnil;
4948 }
4949
4950 /* Value is the number of lines actually displayed in window W,
4951 as opposed to its height. */
4952
4953 static int
4954 displayed_window_lines (struct window *w)
4955 {
4956 struct it it;
4957 struct text_pos start;
4958 int height = window_box_height (w);
4959 struct buffer *old_buffer;
4960 int bottom_y;
4961 void *itdata = NULL;
4962
4963 if (XBUFFER (w->buffer) != current_buffer)
4964 {
4965 old_buffer = current_buffer;
4966 set_buffer_internal (XBUFFER (w->buffer));
4967 }
4968 else
4969 old_buffer = NULL;
4970
4971 /* In case W->start is out of the accessible range, do something
4972 reasonable. This happens in Info mode when Info-scroll-down
4973 calls (recenter -1) while W->start is 1. */
4974 if (XMARKER (w->start)->charpos < BEGV)
4975 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
4976 else if (XMARKER (w->start)->charpos > ZV)
4977 SET_TEXT_POS (start, ZV, ZV_BYTE);
4978 else
4979 SET_TEXT_POS_FROM_MARKER (start, w->start);
4980
4981 itdata = bidi_shelve_cache ();
4982 start_display (&it, w, start);
4983 move_it_vertically (&it, height);
4984 bottom_y = line_bottom_y (&it);
4985 bidi_unshelve_cache (itdata, 0);
4986
4987 /* rms: On a non-window display,
4988 the value of it.vpos at the bottom of the screen
4989 seems to be 1 larger than window_box_height (w).
4990 This kludge fixes a bug whereby (move-to-window-line -1)
4991 when ZV is on the last screen line
4992 moves to the previous screen line instead of the last one. */
4993 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
4994 height++;
4995
4996 /* Add in empty lines at the bottom of the window. */
4997 if (bottom_y < height)
4998 {
4999 int uy = FRAME_LINE_HEIGHT (it.f);
5000 it.vpos += (height - bottom_y + uy - 1) / uy;
5001 }
5002
5003 if (old_buffer)
5004 set_buffer_internal (old_buffer);
5005
5006 return it.vpos;
5007 }
5008
5009
5010 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5011 doc: /* Center point in selected window and maybe redisplay frame.
5012 With prefix argument ARG, recenter putting point on screen line ARG
5013 relative to the selected window. If ARG is negative, it counts up from the
5014 bottom of the window. (ARG should be less than the height of the window.)
5015
5016 If ARG is omitted or nil, then recenter with point on the middle line of
5017 the selected window; if the variable `recenter-redisplay' is non-nil,
5018 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5019 is set to `grow-only', this resets the tool-bar's height to the minimum
5020 height needed); if `recenter-redisplay' has the special value `tty',
5021 then only tty frame are redrawn.
5022
5023 Just C-u as prefix means put point in the center of the window
5024 and redisplay normally--don't erase and redraw the frame. */)
5025 (register Lisp_Object arg)
5026 {
5027 struct window *w = XWINDOW (selected_window);
5028 struct buffer *buf = XBUFFER (w->buffer);
5029 struct buffer *obuf = current_buffer;
5030 int center_p = 0;
5031 EMACS_INT charpos, bytepos;
5032 EMACS_INT iarg IF_LINT (= 0);
5033 int this_scroll_margin;
5034
5035 /* If redisplay is suppressed due to an error, try again. */
5036 obuf->display_error_modiff = 0;
5037
5038 if (NILP (arg))
5039 {
5040 if (!NILP (Vrecenter_redisplay)
5041 && (!EQ (Vrecenter_redisplay, Qtty)
5042 || !NILP (Ftty_type (selected_frame))))
5043 {
5044 ptrdiff_t i;
5045
5046 /* Invalidate pixel data calculated for all compositions. */
5047 for (i = 0; i < n_compositions; i++)
5048 composition_table[i]->font = NULL;
5049
5050 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5051
5052 Fredraw_frame (WINDOW_FRAME (w));
5053 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5054 }
5055
5056 center_p = 1;
5057 }
5058 else if (CONSP (arg)) /* Just C-u. */
5059 center_p = 1;
5060 else
5061 {
5062 arg = Fprefix_numeric_value (arg);
5063 CHECK_NUMBER (arg);
5064 iarg = XINT (arg);
5065 }
5066
5067 set_buffer_internal (buf);
5068
5069 /* Do this after making BUF current
5070 in case scroll_margin is buffer-local. */
5071 this_scroll_margin =
5072 max (0, min (scroll_margin, XFASTINT (w->total_lines) / 4));
5073
5074 /* Handle centering on a graphical frame specially. Such frames can
5075 have variable-height lines and centering point on the basis of
5076 line counts would lead to strange effects. */
5077 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5078 {
5079 if (center_p)
5080 {
5081 struct it it;
5082 struct text_pos pt;
5083 void *itdata = bidi_shelve_cache ();
5084
5085 SET_TEXT_POS (pt, PT, PT_BYTE);
5086 start_display (&it, w, pt);
5087 move_it_vertically_backward (&it, window_box_height (w) / 2);
5088 charpos = IT_CHARPOS (it);
5089 bytepos = IT_BYTEPOS (it);
5090 bidi_unshelve_cache (itdata, 0);
5091 }
5092 else if (iarg < 0)
5093 {
5094 struct it it;
5095 struct text_pos pt;
5096 int nlines = min (INT_MAX, -iarg);
5097 int extra_line_spacing;
5098 int h = window_box_height (w);
5099 void *itdata = bidi_shelve_cache ();
5100
5101 iarg = - max (-iarg, this_scroll_margin);
5102
5103 SET_TEXT_POS (pt, PT, PT_BYTE);
5104 start_display (&it, w, pt);
5105
5106 /* Be sure we have the exact height of the full line containing PT. */
5107 move_it_by_lines (&it, 0);
5108
5109 /* The amount of pixels we have to move back is the window
5110 height minus what's displayed in the line containing PT,
5111 and the lines below. */
5112 it.current_y = 0;
5113 it.vpos = 0;
5114 move_it_by_lines (&it, nlines);
5115
5116 if (it.vpos == nlines)
5117 h -= it.current_y;
5118 else
5119 {
5120 /* Last line has no newline */
5121 h -= line_bottom_y (&it);
5122 it.vpos++;
5123 }
5124
5125 /* Don't reserve space for extra line spacing of last line. */
5126 extra_line_spacing = it.max_extra_line_spacing;
5127
5128 /* If we can't move down NLINES lines because we hit
5129 the end of the buffer, count in some empty lines. */
5130 if (it.vpos < nlines)
5131 {
5132 nlines -= it.vpos;
5133 extra_line_spacing = it.extra_line_spacing;
5134 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5135 }
5136 if (h <= 0)
5137 {
5138 bidi_unshelve_cache (itdata, 0);
5139 return Qnil;
5140 }
5141
5142 /* Now find the new top line (starting position) of the window. */
5143 start_display (&it, w, pt);
5144 it.current_y = 0;
5145 move_it_vertically_backward (&it, h);
5146
5147 /* If extra line spacing is present, we may move too far
5148 back. This causes the last line to be only partially
5149 visible (which triggers redisplay to recenter that line
5150 in the middle), so move forward.
5151 But ignore extra line spacing on last line, as it is not
5152 considered to be part of the visible height of the line.
5153 */
5154 h += extra_line_spacing;
5155 while (-it.current_y > h)
5156 move_it_by_lines (&it, 1);
5157
5158 charpos = IT_CHARPOS (it);
5159 bytepos = IT_BYTEPOS (it);
5160
5161 bidi_unshelve_cache (itdata, 0);
5162 }
5163 else
5164 {
5165 struct position pos;
5166
5167 iarg = max (iarg, this_scroll_margin);
5168
5169 pos = *vmotion (PT, -iarg, w);
5170 charpos = pos.bufpos;
5171 bytepos = pos.bytepos;
5172 }
5173 }
5174 else
5175 {
5176 struct position pos;
5177 int ht = window_internal_height (w);
5178
5179 if (center_p)
5180 iarg = ht / 2;
5181 else if (iarg < 0)
5182 iarg += ht;
5183
5184 /* Don't let it get into the margin at either top or bottom. */
5185 iarg = max (iarg, this_scroll_margin);
5186 iarg = min (iarg, ht - this_scroll_margin - 1);
5187
5188 pos = *vmotion (PT, - iarg, w);
5189 charpos = pos.bufpos;
5190 bytepos = pos.bytepos;
5191 }
5192
5193 /* Set the new window start. */
5194 set_marker_both (w->start, w->buffer, charpos, bytepos);
5195 w->window_end_valid = Qnil;
5196
5197 w->optional_new_start = Qt;
5198
5199 if (bytepos == BEGV_BYTE || FETCH_BYTE (bytepos - 1) == '\n')
5200 w->start_at_line_beg = Qt;
5201 else
5202 w->start_at_line_beg = Qnil;
5203
5204 set_buffer_internal (obuf);
5205 return Qnil;
5206 }
5207
5208 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5209 0, 1, 0,
5210 doc: /* Return the height in lines of the text display area of WINDOW.
5211 WINDOW defaults to the selected window.
5212
5213 The return value does not include the mode line, any header line, nor
5214 any partial-height lines in the text display area. */)
5215 (Lisp_Object window)
5216 {
5217 struct window *w = decode_window (window);
5218 int pixel_height = window_box_height (w);
5219 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5220 return make_number (line_height);
5221 }
5222
5223
5224 \f
5225 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5226 1, 1, "P",
5227 doc: /* Position point relative to window.
5228 With no argument, position point at center of window.
5229 An argument specifies vertical position within the window;
5230 zero means top of window, negative means relative to bottom of window. */)
5231 (Lisp_Object arg)
5232 {
5233 struct window *w = XWINDOW (selected_window);
5234 int lines, start;
5235 Lisp_Object window;
5236 #if 0
5237 int this_scroll_margin;
5238 #endif
5239
5240 if (!(BUFFERP (w->buffer)
5241 && XBUFFER (w->buffer) == current_buffer))
5242 /* This test is needed to make sure PT/PT_BYTE make sense in w->buffer
5243 when passed below to set_marker_both. */
5244 error ("move-to-window-line called from unrelated buffer");
5245
5246 window = selected_window;
5247 start = marker_position (w->start);
5248 if (start < BEGV || start > ZV)
5249 {
5250 int height = window_internal_height (w);
5251 Fvertical_motion (make_number (- (height / 2)), window);
5252 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
5253 w->start_at_line_beg = Fbolp ();
5254 w->force_start = Qt;
5255 }
5256 else
5257 Fgoto_char (w->start);
5258
5259 lines = displayed_window_lines (w);
5260
5261 #if 0
5262 this_scroll_margin = max (0, min (scroll_margin, lines / 4));
5263 #endif
5264
5265 if (NILP (arg))
5266 XSETFASTINT (arg, lines / 2);
5267 else
5268 {
5269 EMACS_INT iarg = XINT (Fprefix_numeric_value (arg));
5270
5271 if (iarg < 0)
5272 iarg = iarg + lines;
5273
5274 #if 0 /* This code would prevent move-to-window-line from moving point
5275 to a place inside the scroll margins (which would cause the
5276 next redisplay to scroll). I wrote this code, but then concluded
5277 it is probably better not to install it. However, it is here
5278 inside #if 0 so as not to lose it. -- rms. */
5279
5280 /* Don't let it get into the margin at either top or bottom. */
5281 iarg = max (iarg, this_scroll_margin);
5282 iarg = min (iarg, lines - this_scroll_margin - 1);
5283 #endif
5284
5285 arg = make_number (iarg);
5286 }
5287
5288 /* Skip past a partially visible first line. */
5289 if (w->vscroll)
5290 XSETINT (arg, XINT (arg) + 1);
5291
5292 return Fvertical_motion (arg, window);
5293 }
5294
5295
5296 \f
5297 /***********************************************************************
5298 Window Configuration
5299 ***********************************************************************/
5300
5301 struct save_window_data
5302 {
5303 struct vectorlike_header header;
5304 Lisp_Object selected_frame;
5305 Lisp_Object current_window;
5306 Lisp_Object current_buffer;
5307 Lisp_Object minibuf_scroll_window;
5308 Lisp_Object minibuf_selected_window;
5309 Lisp_Object root_window;
5310 Lisp_Object focus_frame;
5311 /* A vector, each of whose elements is a struct saved_window
5312 for one window. */
5313 Lisp_Object saved_windows;
5314
5315 /* All fields above are traced by the GC.
5316 From `fame-cols' down, the fields are ignored by the GC. */
5317
5318 int frame_cols, frame_lines, frame_menu_bar_lines;
5319 int frame_tool_bar_lines;
5320 };
5321
5322 /* This is saved as a Lisp_Vector */
5323 struct saved_window
5324 {
5325 struct vectorlike_header header;
5326
5327 Lisp_Object window, buffer, start, pointm, mark;
5328 Lisp_Object left_col, top_line, total_cols, total_lines;
5329 Lisp_Object normal_cols, normal_lines;
5330 Lisp_Object hscroll, min_hscroll;
5331 Lisp_Object parent, prev;
5332 Lisp_Object start_at_line_beg;
5333 Lisp_Object display_table;
5334 Lisp_Object left_margin_cols, right_margin_cols;
5335 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5336 Lisp_Object scroll_bar_width, vertical_scroll_bar_type, dedicated;
5337 Lisp_Object splits, nest, window_parameters;
5338 };
5339
5340 #define SAVED_WINDOW_N(swv,n) \
5341 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5342
5343 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5344 doc: /* Return t if OBJECT is a window-configuration object. */)
5345 (Lisp_Object object)
5346 {
5347 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
5348 }
5349
5350 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5351 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5352 (Lisp_Object config)
5353 {
5354 register struct save_window_data *data;
5355 struct Lisp_Vector *saved_windows;
5356
5357 CHECK_WINDOW_CONFIGURATION (config);
5358
5359 data = (struct save_window_data *) XVECTOR (config);
5360 saved_windows = XVECTOR (data->saved_windows);
5361 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5362 }
5363
5364 DEFUN ("set-window-configuration", Fset_window_configuration,
5365 Sset_window_configuration, 1, 1, 0,
5366 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5367 CONFIGURATION must be a value previously returned
5368 by `current-window-configuration' (which see).
5369 If CONFIGURATION was made from a frame that is now deleted,
5370 only frame-independent values can be restored. In this case,
5371 the return value is nil. Otherwise the value is t. */)
5372 (Lisp_Object configuration)
5373 {
5374 register struct save_window_data *data;
5375 struct Lisp_Vector *saved_windows;
5376 Lisp_Object new_current_buffer;
5377 Lisp_Object frame;
5378 Lisp_Object auto_buffer_name;
5379 FRAME_PTR f;
5380 EMACS_INT old_point = -1;
5381
5382 CHECK_WINDOW_CONFIGURATION (configuration);
5383
5384 data = (struct save_window_data *) XVECTOR (configuration);
5385 saved_windows = XVECTOR (data->saved_windows);
5386
5387 new_current_buffer = data->current_buffer;
5388 if (NILP (BVAR (XBUFFER (new_current_buffer), name)))
5389 new_current_buffer = Qnil;
5390 else
5391 {
5392 if (XBUFFER (new_current_buffer) == current_buffer)
5393 /* The code further down "preserves point" by saving here PT in
5394 old_point and then setting it later back into PT. When the
5395 current-selected-window and the final-selected-window both show
5396 the current buffer, this suffers from the problem that the
5397 current PT is the window-point of the current-selected-window,
5398 while the final PT is the point of the final-selected-window, so
5399 this copy from one PT to the other would end up moving the
5400 window-point of the final-selected-window to the window-point of
5401 the current-selected-window. So we have to be careful which
5402 point of the current-buffer we copy into old_point. */
5403 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5404 && WINDOWP (selected_window)
5405 && EQ (XWINDOW (selected_window)->buffer, new_current_buffer)
5406 && !EQ (selected_window, data->current_window))
5407 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5408 else
5409 old_point = PT;
5410 else
5411 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5412 point in new_current_buffer as of the last time this buffer was
5413 used. This can be non-deterministic since it can be changed by
5414 things like jit-lock by mere temporary selection of some random
5415 window that happens to show this buffer.
5416 So if possible we want this arbitrary choice of "which point" to
5417 be the one from the to-be-selected-window so as to prevent this
5418 window's cursor from being copied from another window. */
5419 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5420 /* If current_window = selected_window, its point is in BUF_PT. */
5421 && !EQ (selected_window, data->current_window))
5422 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5423 else
5424 old_point = BUF_PT (XBUFFER (new_current_buffer));
5425 }
5426
5427 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5428 f = XFRAME (frame);
5429
5430 /* If f is a dead frame, don't bother rebuilding its window tree.
5431 However, there is other stuff we should still try to do below. */
5432 if (FRAME_LIVE_P (f))
5433 {
5434 Lisp_Object window;
5435 Lisp_Object dead_windows = Qnil;
5436 register struct window *w;
5437 register struct saved_window *p;
5438 struct window *root_window;
5439 struct window **leaf_windows;
5440 int n_leaf_windows;
5441 ptrdiff_t k;
5442 int i, n;
5443
5444 /* If the frame has been resized since this window configuration was
5445 made, we change the frame to the size specified in the
5446 configuration, restore the configuration, and then resize it
5447 back. We keep track of the prevailing height in these variables. */
5448 int previous_frame_lines = FRAME_LINES (f);
5449 int previous_frame_cols = FRAME_COLS (f);
5450 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5451 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5452
5453 /* The mouse highlighting code could get screwed up
5454 if it runs during this. */
5455 BLOCK_INPUT;
5456
5457 if (data->frame_lines != previous_frame_lines
5458 || data->frame_cols != previous_frame_cols)
5459 change_frame_size (f, data->frame_lines,
5460 data->frame_cols, 0, 0, 0);
5461 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5462 if (data->frame_menu_bar_lines
5463 != previous_frame_menu_bar_lines)
5464 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
5465 make_number (0));
5466 #ifdef HAVE_WINDOW_SYSTEM
5467 if (data->frame_tool_bar_lines
5468 != previous_frame_tool_bar_lines)
5469 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
5470 make_number (0));
5471 #endif
5472 #endif
5473
5474 /* "Swap out" point from the selected window's buffer
5475 into the window itself. (Normally the pointm of the selected
5476 window holds garbage.) We do this now, before
5477 restoring the window contents, and prevent it from
5478 being done later on when we select a new window. */
5479 if (! NILP (XWINDOW (selected_window)->buffer))
5480 {
5481 w = XWINDOW (selected_window);
5482 set_marker_both (w->pointm,
5483 w->buffer,
5484 BUF_PT (XBUFFER (w->buffer)),
5485 BUF_PT_BYTE (XBUFFER (w->buffer)));
5486 }
5487
5488 windows_or_buffers_changed++;
5489 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
5490
5491 /* Problem: Freeing all matrices and later allocating them again
5492 is a serious redisplay flickering problem. What we would
5493 really like to do is to free only those matrices not reused
5494 below. */
5495 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
5496 leaf_windows
5497 = (struct window **) alloca (count_windows (root_window)
5498 * sizeof (struct window *));
5499 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
5500
5501 /* Kludge Alert!
5502 Mark all windows now on frame as "deleted".
5503 Restoring the new configuration "undeletes" any that are in it.
5504
5505 Save their current buffers in their height fields, since we may
5506 need it later, if a buffer saved in the configuration is now
5507 dead. */
5508 delete_all_subwindows (FRAME_ROOT_WINDOW (f));
5509
5510 for (k = 0; k < saved_windows->header.size; k++)
5511 {
5512 p = SAVED_WINDOW_N (saved_windows, k);
5513 window = p->window;
5514 w = XWINDOW (window);
5515 w->next = Qnil;
5516
5517 if (!NILP (p->parent))
5518 w->parent = SAVED_WINDOW_N (saved_windows,
5519 XFASTINT (p->parent))->window;
5520 else
5521 w->parent = Qnil;
5522
5523 if (!NILP (p->prev))
5524 {
5525 w->prev = SAVED_WINDOW_N (saved_windows,
5526 XFASTINT (p->prev))->window;
5527 XWINDOW (w->prev)->next = p->window;
5528 }
5529 else
5530 {
5531 w->prev = Qnil;
5532 if (!NILP (w->parent))
5533 {
5534 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
5535 {
5536 XWINDOW (w->parent)->vchild = p->window;
5537 XWINDOW (w->parent)->hchild = Qnil;
5538 }
5539 else
5540 {
5541 XWINDOW (w->parent)->hchild = p->window;
5542 XWINDOW (w->parent)->vchild = Qnil;
5543 }
5544 }
5545 }
5546
5547 /* If we squirreled away the buffer in the window's height,
5548 restore it now. */
5549 if (BUFFERP (w->total_lines))
5550 w->buffer = w->total_lines;
5551 w->left_col = p->left_col;
5552 w->top_line = p->top_line;
5553 w->total_cols = p->total_cols;
5554 w->total_lines = p->total_lines;
5555 w->normal_cols = p->normal_cols;
5556 w->normal_lines = p->normal_lines;
5557 w->hscroll = p->hscroll;
5558 w->min_hscroll = p->min_hscroll;
5559 w->display_table = p->display_table;
5560 w->left_margin_cols = p->left_margin_cols;
5561 w->right_margin_cols = p->right_margin_cols;
5562 w->left_fringe_width = p->left_fringe_width;
5563 w->right_fringe_width = p->right_fringe_width;
5564 w->fringes_outside_margins = p->fringes_outside_margins;
5565 w->scroll_bar_width = p->scroll_bar_width;
5566 w->vertical_scroll_bar_type = p->vertical_scroll_bar_type;
5567 w->dedicated = p->dedicated;
5568 w->splits = p->splits;
5569 w->nest = p->nest;
5570 w->window_parameters = p->window_parameters;
5571 XSETFASTINT (w->last_modified, 0);
5572 XSETFASTINT (w->last_overlay_modified, 0);
5573
5574 /* Reinstall the saved buffer and pointers into it. */
5575 if (NILP (p->buffer))
5576 /* An internal window. */
5577 w->buffer = p->buffer;
5578 else if (!NILP (BVAR (XBUFFER (p->buffer), name)))
5579 /* If saved buffer is alive, install it. */
5580 {
5581 w->buffer = p->buffer;
5582 w->start_at_line_beg = p->start_at_line_beg;
5583 set_marker_restricted (w->start, p->start, w->buffer);
5584 set_marker_restricted (w->pointm, p->pointm, w->buffer);
5585 Fset_marker (BVAR (XBUFFER (w->buffer), mark),
5586 p->mark, w->buffer);
5587
5588 /* As documented in Fcurrent_window_configuration, don't
5589 restore the location of point in the buffer which was
5590 current when the window configuration was recorded. */
5591 if (!EQ (p->buffer, new_current_buffer)
5592 && XBUFFER (p->buffer) == current_buffer)
5593 Fgoto_char (w->pointm);
5594 }
5595 else if (!NILP (w->buffer) && !NILP (BVAR (XBUFFER (w->buffer), name)))
5596 /* Keep window's old buffer; make sure the markers are
5597 real. */
5598 {
5599 /* Set window markers at start of visible range. */
5600 if (XMARKER (w->start)->buffer == 0)
5601 set_marker_restricted (w->start, make_number (0),
5602 w->buffer);
5603 if (XMARKER (w->pointm)->buffer == 0)
5604 set_marker_restricted_both (w->pointm, w->buffer,
5605 BUF_PT (XBUFFER (w->buffer)),
5606 BUF_PT_BYTE (XBUFFER (w->buffer)));
5607 w->start_at_line_beg = Qt;
5608 }
5609 else if (STRINGP (auto_buffer_name =
5610 Fwindow_parameter (window, Qauto_buffer_name))
5611 && SCHARS (auto_buffer_name) != 0
5612 && !NILP (w->buffer = Fget_buffer_create (auto_buffer_name)))
5613 {
5614 set_marker_restricted (w->start, make_number (0), w->buffer);
5615 set_marker_restricted (w->pointm, make_number (0), w->buffer);
5616 w->start_at_line_beg = Qt;
5617 }
5618 else
5619 /* Window has no live buffer, get one. */
5620 {
5621 /* Get the buffer via other_buffer_safely in order to
5622 avoid showing an unimportant buffer and, if necessary, to
5623 recreate *scratch* in the course (part of Juanma's bs-show
5624 scenario from March 2011). */
5625 w->buffer = other_buffer_safely (Fcurrent_buffer ());
5626 /* This will set the markers to beginning of visible
5627 range. */
5628 set_marker_restricted (w->start, make_number (0), w->buffer);
5629 set_marker_restricted (w->pointm, make_number (0), w->buffer);
5630 w->start_at_line_beg = Qt;
5631 if (!NILP (w->dedicated))
5632 /* Record this window as dead. */
5633 dead_windows = Fcons (window, dead_windows);
5634 /* Make sure window is no more dedicated. */
5635 w->dedicated = Qnil;
5636 }
5637 }
5638
5639 FRAME_ROOT_WINDOW (f) = data->root_window;
5640 /* Arrange *not* to restore point in the buffer that was
5641 current when the window configuration was saved. */
5642 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
5643 set_marker_restricted (XWINDOW (data->current_window)->pointm,
5644 make_number (old_point),
5645 XWINDOW (data->current_window)->buffer);
5646
5647 /* In the following call to `select-window', prevent "swapping out
5648 point" in the old selected window using the buffer that has
5649 been restored into it. We already swapped out that point from
5650 that window's old buffer. */
5651 select_window (data->current_window, Qnil, 1);
5652 BVAR (XBUFFER (XWINDOW (selected_window)->buffer), last_selected_window)
5653 = selected_window;
5654
5655 if (NILP (data->focus_frame)
5656 || (FRAMEP (data->focus_frame)
5657 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
5658 Fredirect_frame_focus (frame, data->focus_frame);
5659
5660 /* Set the screen height to the value it had before this function. */
5661 if (previous_frame_lines != FRAME_LINES (f)
5662 || previous_frame_cols != FRAME_COLS (f))
5663 change_frame_size (f, previous_frame_lines, previous_frame_cols,
5664 0, 0, 0);
5665 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5666 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
5667 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
5668 make_number (0));
5669 #ifdef HAVE_WINDOW_SYSTEM
5670 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
5671 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
5672 make_number (0));
5673 #endif
5674 #endif
5675
5676 /* Now, free glyph matrices in windows that were not reused. */
5677 for (i = n = 0; i < n_leaf_windows; ++i)
5678 {
5679 if (NILP (leaf_windows[i]->buffer))
5680 {
5681 /* Assert it's not reused as a combination. */
5682 xassert (NILP (leaf_windows[i]->hchild)
5683 && NILP (leaf_windows[i]->vchild));
5684 free_window_matrices (leaf_windows[i]);
5685 }
5686 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
5687 ++n;
5688 }
5689
5690 adjust_glyphs (f);
5691 UNBLOCK_INPUT;
5692
5693 /* Scan dead buffer windows. */
5694 for (; CONSP (dead_windows); dead_windows = XCDR (dead_windows))
5695 {
5696 window = XCAR (dead_windows);
5697 if (WINDOW_LIVE_P (window) && !EQ (window, FRAME_ROOT_WINDOW (f)))
5698 delete_deletable_window (window);
5699 }
5700
5701 /* Fselect_window will have made f the selected frame, so we
5702 reselect the proper frame here. Fhandle_switch_frame will change the
5703 selected window too, but that doesn't make the call to
5704 Fselect_window above totally superfluous; it still sets f's
5705 selected window. */
5706 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
5707 do_switch_frame (data->selected_frame, 0, 0, Qnil);
5708
5709 run_window_configuration_change_hook (f);
5710 }
5711
5712 if (!NILP (new_current_buffer))
5713 Fset_buffer (new_current_buffer);
5714
5715 Vminibuf_scroll_window = data->minibuf_scroll_window;
5716 minibuf_selected_window = data->minibuf_selected_window;
5717
5718 return (FRAME_LIVE_P (f) ? Qt : Qnil);
5719 }
5720
5721
5722 /* Delete all subwindows reachable via the next, vchild, and hchild
5723 slots of WINDOW. */
5724 void
5725 delete_all_subwindows (Lisp_Object window)
5726 {
5727 register struct window *w;
5728
5729 w = XWINDOW (window);
5730
5731 if (!NILP (w->next))
5732 /* Delete WINDOW's siblings (we traverse postorderly). */
5733 delete_all_subwindows (w->next);
5734
5735 w->total_lines = w->buffer; /* See Fset_window_configuration for excuse. */
5736
5737 if (!NILP (w->vchild))
5738 {
5739 delete_all_subwindows (w->vchild);
5740 w->vchild = Qnil;
5741 }
5742 else if (!NILP (w->hchild))
5743 {
5744 delete_all_subwindows (w->hchild);
5745 w->hchild = Qnil;
5746 }
5747 else if (!NILP (w->buffer))
5748 {
5749 unshow_buffer (w);
5750 unchain_marker (XMARKER (w->pointm));
5751 unchain_marker (XMARKER (w->start));
5752 w->buffer = Qnil;
5753 }
5754
5755 Vwindow_list = Qnil;
5756 }
5757 \f
5758 static int
5759 count_windows (register struct window *window)
5760 {
5761 register int count = 1;
5762 if (!NILP (window->next))
5763 count += count_windows (XWINDOW (window->next));
5764 if (!NILP (window->vchild))
5765 count += count_windows (XWINDOW (window->vchild));
5766 if (!NILP (window->hchild))
5767 count += count_windows (XWINDOW (window->hchild));
5768 return count;
5769 }
5770
5771
5772 /* Fill vector FLAT with leaf windows under W, starting at index I.
5773 Value is last index + 1. */
5774 static int
5775 get_leaf_windows (struct window *w, struct window **flat, int i)
5776 {
5777 while (w)
5778 {
5779 if (!NILP (w->hchild))
5780 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
5781 else if (!NILP (w->vchild))
5782 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
5783 else
5784 flat[i++] = w;
5785
5786 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5787 }
5788
5789 return i;
5790 }
5791
5792
5793 /* Return a pointer to the glyph W's physical cursor is on. Value is
5794 null if W's current matrix is invalid, so that no meaningfull glyph
5795 can be returned. */
5796 struct glyph *
5797 get_phys_cursor_glyph (struct window *w)
5798 {
5799 struct glyph_row *row;
5800 struct glyph *glyph;
5801
5802 if (w->phys_cursor.vpos >= 0
5803 && w->phys_cursor.vpos < w->current_matrix->nrows
5804 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
5805 row->enabled_p)
5806 && row->used[TEXT_AREA] > w->phys_cursor.hpos)
5807 glyph = row->glyphs[TEXT_AREA] + w->phys_cursor.hpos;
5808 else
5809 glyph = NULL;
5810
5811 return glyph;
5812 }
5813
5814
5815 static int
5816 save_window_save (Lisp_Object window, struct Lisp_Vector *vector, int i)
5817 {
5818 register struct saved_window *p;
5819 register struct window *w;
5820 register Lisp_Object tem;
5821
5822 for (;!NILP (window); window = w->next)
5823 {
5824 p = SAVED_WINDOW_N (vector, i);
5825 w = XWINDOW (window);
5826
5827 XSETFASTINT (w->temslot, i); i++;
5828 p->window = window;
5829 p->buffer = w->buffer;
5830 p->left_col = w->left_col;
5831 p->top_line = w->top_line;
5832 p->total_cols = w->total_cols;
5833 p->total_lines = w->total_lines;
5834 p->normal_cols = w->normal_cols;
5835 p->normal_lines = w->normal_lines;
5836 p->hscroll = w->hscroll;
5837 p->min_hscroll = w->min_hscroll;
5838 p->display_table = w->display_table;
5839 p->left_margin_cols = w->left_margin_cols;
5840 p->right_margin_cols = w->right_margin_cols;
5841 p->left_fringe_width = w->left_fringe_width;
5842 p->right_fringe_width = w->right_fringe_width;
5843 p->fringes_outside_margins = w->fringes_outside_margins;
5844 p->scroll_bar_width = w->scroll_bar_width;
5845 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
5846 p->dedicated = w->dedicated;
5847 p->splits = w->splits;
5848 p->nest = w->nest;
5849 p->window_parameters = w->window_parameters;
5850 if (!NILP (w->buffer))
5851 {
5852 /* Save w's value of point in the window configuration.
5853 If w is the selected window, then get the value of point
5854 from the buffer; pointm is garbage in the selected window. */
5855 if (EQ (window, selected_window))
5856 {
5857 p->pointm = Fmake_marker ();
5858 set_marker_both (p->pointm, w->buffer,
5859 BUF_PT (XBUFFER (w->buffer)),
5860 BUF_PT_BYTE (XBUFFER (w->buffer)));
5861 }
5862 else
5863 p->pointm = Fcopy_marker (w->pointm, Qnil);
5864
5865 p->start = Fcopy_marker (w->start, Qnil);
5866 p->start_at_line_beg = w->start_at_line_beg;
5867
5868 tem = BVAR (XBUFFER (w->buffer), mark);
5869 p->mark = Fcopy_marker (tem, Qnil);
5870 }
5871 else
5872 {
5873 p->pointm = Qnil;
5874 p->start = Qnil;
5875 p->mark = Qnil;
5876 p->start_at_line_beg = Qnil;
5877 }
5878
5879 if (NILP (w->parent))
5880 p->parent = Qnil;
5881 else
5882 p->parent = XWINDOW (w->parent)->temslot;
5883
5884 if (NILP (w->prev))
5885 p->prev = Qnil;
5886 else
5887 p->prev = XWINDOW (w->prev)->temslot;
5888
5889 if (!NILP (w->vchild))
5890 i = save_window_save (w->vchild, vector, i);
5891 if (!NILP (w->hchild))
5892 i = save_window_save (w->hchild, vector, i);
5893 }
5894
5895 return i;
5896 }
5897
5898 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
5899 Scurrent_window_configuration, 0, 1, 0,
5900 doc: /* Return an object representing the current window configuration of FRAME.
5901 If FRAME is nil or omitted, use the selected frame.
5902 This describes the number of windows, their sizes and current buffers,
5903 and for each displayed buffer, where display starts, and the positions of
5904 point and mark. An exception is made for point in the current buffer:
5905 its value is -not- saved.
5906 This also records the currently selected frame, and FRAME's focus
5907 redirection (see `redirect-frame-focus'). */)
5908 (Lisp_Object frame)
5909 {
5910 register Lisp_Object tem;
5911 register int n_windows;
5912 register struct save_window_data *data;
5913 register int i;
5914 FRAME_PTR f;
5915
5916 if (NILP (frame))
5917 frame = selected_frame;
5918 CHECK_LIVE_FRAME (frame);
5919 f = XFRAME (frame);
5920
5921 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
5922 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
5923 PVEC_WINDOW_CONFIGURATION);
5924
5925 data->frame_cols = FRAME_COLS (f);
5926 data->frame_lines = FRAME_LINES (f);
5927 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5928 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5929 data->selected_frame = selected_frame;
5930 data->current_window = FRAME_SELECTED_WINDOW (f);
5931 XSETBUFFER (data->current_buffer, current_buffer);
5932 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
5933 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
5934 data->root_window = FRAME_ROOT_WINDOW (f);
5935 data->focus_frame = FRAME_FOCUS_FRAME (f);
5936 tem = Fmake_vector (make_number (n_windows), Qnil);
5937 data->saved_windows = tem;
5938 for (i = 0; i < n_windows; i++)
5939 XVECTOR (tem)->contents[i]
5940 = Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil);
5941 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
5942 XSETWINDOW_CONFIGURATION (tem, data);
5943 return (tem);
5944 }
5945 \f
5946 /***********************************************************************
5947 Marginal Areas
5948 ***********************************************************************/
5949
5950 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
5951 2, 3, 0,
5952 doc: /* Set width of marginal areas of window WINDOW.
5953 If WINDOW is nil, set margins of the currently selected window.
5954 Second arg LEFT-WIDTH specifies the number of character cells to
5955 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
5956 does the same for the right marginal area. A nil width parameter
5957 means no margin. */)
5958 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width)
5959 {
5960 struct window *w = decode_window (window);
5961
5962 /* Translate negative or zero widths to nil.
5963 Margins that are too wide have to be checked elsewhere. */
5964
5965 if (!NILP (left_width))
5966 {
5967 CHECK_NUMBER (left_width);
5968 if (XINT (left_width) <= 0)
5969 left_width = Qnil;
5970 }
5971
5972 if (!NILP (right_width))
5973 {
5974 CHECK_NUMBER (right_width);
5975 if (XINT (right_width) <= 0)
5976 right_width = Qnil;
5977 }
5978
5979 if (!EQ (w->left_margin_cols, left_width)
5980 || !EQ (w->right_margin_cols, right_width))
5981 {
5982 w->left_margin_cols = left_width;
5983 w->right_margin_cols = right_width;
5984
5985 adjust_window_margins (w);
5986
5987 ++windows_or_buffers_changed;
5988 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
5989 }
5990
5991 return Qnil;
5992 }
5993
5994
5995 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
5996 0, 1, 0,
5997 doc: /* Get width of marginal areas of window WINDOW.
5998 If WINDOW is omitted or nil, use the currently selected window.
5999 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6000 If a marginal area does not exist, its width will be returned
6001 as nil. */)
6002 (Lisp_Object window)
6003 {
6004 struct window *w = decode_window (window);
6005 return Fcons (w->left_margin_cols, w->right_margin_cols);
6006 }
6007
6008
6009 \f
6010 /***********************************************************************
6011 Fringes
6012 ***********************************************************************/
6013
6014 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6015 2, 4, 0,
6016 doc: /* Set the fringe widths of window WINDOW.
6017 If WINDOW is nil, set the fringe widths of the currently selected
6018 window.
6019 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6020 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6021 fringe width. If a fringe width arg is nil, that means to use the
6022 frame's default fringe width. Default fringe widths can be set with
6023 the command `set-fringe-style'.
6024 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6025 outside of the display margins. By default, fringes are drawn between
6026 display marginal areas and the text area. */)
6027 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width, Lisp_Object outside_margins)
6028 {
6029 struct window *w = decode_window (window);
6030
6031 if (!NILP (left_width))
6032 CHECK_NATNUM (left_width);
6033 if (!NILP (right_width))
6034 CHECK_NATNUM (right_width);
6035
6036 /* Do nothing on a tty. */
6037 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6038 && (!EQ (w->left_fringe_width, left_width)
6039 || !EQ (w->right_fringe_width, right_width)
6040 || !EQ (w->fringes_outside_margins, outside_margins)))
6041 {
6042 w->left_fringe_width = left_width;
6043 w->right_fringe_width = right_width;
6044 w->fringes_outside_margins = outside_margins;
6045
6046 adjust_window_margins (w);
6047
6048 clear_glyph_matrix (w->current_matrix);
6049 w->window_end_valid = Qnil;
6050
6051 ++windows_or_buffers_changed;
6052 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6053 }
6054
6055 return Qnil;
6056 }
6057
6058
6059 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6060 0, 1, 0,
6061 doc: /* Get width of fringes of window WINDOW.
6062 If WINDOW is omitted or nil, use the currently selected window.
6063 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6064 (Lisp_Object window)
6065 {
6066 struct window *w = decode_window (window);
6067
6068 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6069 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6070 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6071 ? Qt : Qnil), Qnil)));
6072 }
6073
6074
6075 \f
6076 /***********************************************************************
6077 Scroll bars
6078 ***********************************************************************/
6079
6080 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars,
6081 Sset_window_scroll_bars, 2, 4, 0,
6082 doc: /* Set width and type of scroll bars of window WINDOW.
6083 If window is nil, set scroll bars of the currently selected window.
6084 Second parameter WIDTH specifies the pixel width for the scroll bar;
6085 this is automatically adjusted to a multiple of the frame column width.
6086 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6087 bar: left, right, or nil.
6088 If WIDTH is nil, use the frame's scroll-bar width.
6089 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6090 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6091 (Lisp_Object window, Lisp_Object width, Lisp_Object vertical_type, Lisp_Object horizontal_type)
6092 {
6093 struct window *w = decode_window (window);
6094
6095 if (!NILP (width))
6096 {
6097 CHECK_NATNUM (width);
6098
6099 if (XINT (width) == 0)
6100 vertical_type = Qnil;
6101 }
6102
6103 if (!(NILP (vertical_type)
6104 || EQ (vertical_type, Qleft)
6105 || EQ (vertical_type, Qright)
6106 || EQ (vertical_type, Qt)))
6107 error ("Invalid type of vertical scroll bar");
6108
6109 if (!EQ (w->scroll_bar_width, width)
6110 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6111 {
6112 w->scroll_bar_width = width;
6113 w->vertical_scroll_bar_type = vertical_type;
6114
6115 adjust_window_margins (w);
6116
6117 clear_glyph_matrix (w->current_matrix);
6118 w->window_end_valid = Qnil;
6119
6120 ++windows_or_buffers_changed;
6121 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6122 }
6123
6124 return Qnil;
6125 }
6126
6127
6128 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6129 0, 1, 0,
6130 doc: /* Get width and type of scroll bars of window WINDOW.
6131 If WINDOW is omitted or nil, use the currently selected window.
6132 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6133 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6134 value. */)
6135 (Lisp_Object window)
6136 {
6137 struct window *w = decode_window (window);
6138 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6139 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6140 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6141 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
6142 Fcons (w->vertical_scroll_bar_type,
6143 Fcons (Qnil, Qnil))));
6144 }
6145
6146
6147 \f
6148 /***********************************************************************
6149 Smooth scrolling
6150 ***********************************************************************/
6151
6152 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6153 doc: /* Return the amount by which WINDOW is scrolled vertically.
6154 Use the selected window if WINDOW is nil or omitted.
6155 Normally, value is a multiple of the canonical character height of WINDOW;
6156 optional second arg PIXELS-P means value is measured in pixels. */)
6157 (Lisp_Object window, Lisp_Object pixels_p)
6158 {
6159 Lisp_Object result;
6160 struct frame *f;
6161 struct window *w;
6162
6163 if (NILP (window))
6164 window = selected_window;
6165 else
6166 CHECK_WINDOW (window);
6167 w = XWINDOW (window);
6168 f = XFRAME (w->frame);
6169
6170 if (FRAME_WINDOW_P (f))
6171 result = (NILP (pixels_p)
6172 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
6173 : make_number (-w->vscroll));
6174 else
6175 result = make_number (0);
6176 return result;
6177 }
6178
6179
6180 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
6181 2, 3, 0,
6182 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6183 WINDOW nil means use the selected window. Normally, VSCROLL is a
6184 non-negative multiple of the canonical character height of WINDOW;
6185 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6186 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6187 corresponds to an integral number of pixels. The return value is the
6188 result of this rounding.
6189 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6190 (Lisp_Object window, Lisp_Object vscroll, Lisp_Object pixels_p)
6191 {
6192 struct window *w;
6193 struct frame *f;
6194
6195 if (NILP (window))
6196 window = selected_window;
6197 else
6198 CHECK_WINDOW (window);
6199 CHECK_NUMBER_OR_FLOAT (vscroll);
6200
6201 w = XWINDOW (window);
6202 f = XFRAME (w->frame);
6203
6204 if (FRAME_WINDOW_P (f))
6205 {
6206 int old_dy = w->vscroll;
6207
6208 w->vscroll = - (NILP (pixels_p)
6209 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6210 : XFLOATINT (vscroll));
6211 w->vscroll = min (w->vscroll, 0);
6212
6213 if (w->vscroll != old_dy)
6214 {
6215 /* Adjust glyph matrix of the frame if the virtual display
6216 area becomes larger than before. */
6217 if (w->vscroll < 0 && w->vscroll < old_dy)
6218 adjust_glyphs (f);
6219
6220 /* Prevent redisplay shortcuts. */
6221 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
6222 }
6223 }
6224
6225 return Fwindow_vscroll (window, pixels_p);
6226 }
6227
6228 \f
6229 /* Call FN for all leaf windows on frame F. FN is called with the
6230 first argument being a pointer to the leaf window, and with
6231 additional argument USER_DATA. Stops when FN returns 0. */
6232
6233 static void
6234 foreach_window (struct frame *f, int (*fn) (struct window *, void *),
6235 void *user_data)
6236 {
6237 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6238 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6239 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6240 }
6241
6242
6243 /* Helper function for foreach_window. Call FN for all leaf windows
6244 reachable from W. FN is called with the first argument being a
6245 pointer to the leaf window, and with additional argument USER_DATA.
6246 Stop when FN returns 0. Value is 0 if stopped by FN. */
6247
6248 static int
6249 foreach_window_1 (struct window *w, int (*fn) (struct window *, void *), void *user_data)
6250 {
6251 int cont;
6252
6253 for (cont = 1; w && cont;)
6254 {
6255 if (!NILP (w->hchild))
6256 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6257 else if (!NILP (w->vchild))
6258 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6259 else
6260 cont = fn (w, user_data);
6261
6262 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6263 }
6264
6265 return cont;
6266 }
6267
6268
6269 /* Freeze or unfreeze the window start of W unless it is a
6270 mini-window or the selected window. FREEZE_P non-null means freeze
6271 the window start. */
6272
6273 static int
6274 freeze_window_start (struct window *w, void *freeze_p)
6275 {
6276 if (MINI_WINDOW_P (w)
6277 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6278 && (w == XWINDOW (selected_window)
6279 || (MINI_WINDOW_P (XWINDOW (selected_window))
6280 && ! NILP (Vminibuf_scroll_window)
6281 && w == XWINDOW (Vminibuf_scroll_window)))))
6282 freeze_p = NULL;
6283
6284 w->frozen_window_start_p = freeze_p != NULL;
6285 return 1;
6286 }
6287
6288
6289 /* Freeze or unfreeze the window starts of all leaf windows on frame
6290 F, except the selected window and a mini-window. FREEZE_P non-zero
6291 means freeze the window start. */
6292
6293 void
6294 freeze_window_starts (struct frame *f, int freeze_p)
6295 {
6296 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6297 }
6298
6299 \f
6300 /***********************************************************************
6301 Initialization
6302 ***********************************************************************/
6303
6304 /* Return 1 if window configurations CONFIGURATION1 and CONFIGURATION2
6305 describe the same state of affairs. This is used by Fequal.
6306
6307 ignore_positions non-zero means ignore non-matching scroll positions
6308 and the like.
6309
6310 This ignores a couple of things like the dedicatedness status of
6311 window, splits, nest and the like. This might have to be fixed. */
6312
6313 int
6314 compare_window_configurations (Lisp_Object configuration1, Lisp_Object configuration2, int ignore_positions)
6315 {
6316 register struct save_window_data *d1, *d2;
6317 struct Lisp_Vector *sws1, *sws2;
6318 ptrdiff_t i;
6319
6320 CHECK_WINDOW_CONFIGURATION (configuration1);
6321 CHECK_WINDOW_CONFIGURATION (configuration2);
6322
6323 d1 = (struct save_window_data *) XVECTOR (configuration1);
6324 d2 = (struct save_window_data *) XVECTOR (configuration2);
6325 sws1 = XVECTOR (d1->saved_windows);
6326 sws2 = XVECTOR (d2->saved_windows);
6327
6328 /* Frame settings must match. */
6329 if (d1->frame_cols != d2->frame_cols
6330 || d1->frame_lines != d2->frame_lines
6331 || d1->frame_menu_bar_lines != d2->frame_menu_bar_lines
6332 || !EQ (d1->selected_frame, d2->selected_frame)
6333 || !EQ (d1->current_buffer, d2->current_buffer)
6334 || (!ignore_positions
6335 && (!EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window)
6336 || !EQ (d1->minibuf_selected_window, d2->minibuf_selected_window)))
6337 || !EQ (d1->focus_frame, d2->focus_frame)
6338 /* Verify that the two configurations have the same number of windows. */
6339 || sws1->header.size != sws2->header.size)
6340 return 0;
6341
6342 for (i = 0; i < sws1->header.size; i++)
6343 {
6344 struct saved_window *sw1, *sw2;
6345
6346 sw1 = SAVED_WINDOW_N (sws1, i);
6347 sw2 = SAVED_WINDOW_N (sws2, i);
6348
6349 if (
6350 /* The "current" windows in the two configurations must
6351 correspond to each other. */
6352 EQ (d1->current_window, sw1->window)
6353 != EQ (d2->current_window, sw2->window)
6354 /* Windows' buffers must match. */
6355 || !EQ (sw1->buffer, sw2->buffer)
6356 || !EQ (sw1->left_col, sw2->left_col)
6357 || !EQ (sw1->top_line, sw2->top_line)
6358 || !EQ (sw1->total_cols, sw2->total_cols)
6359 || !EQ (sw1->total_lines, sw2->total_lines)
6360 || !EQ (sw1->display_table, sw2->display_table)
6361 /* The next two disjuncts check the window structure for
6362 equality. */
6363 || !EQ (sw1->parent, sw2->parent)
6364 || !EQ (sw1->prev, sw2->prev)
6365 || (!ignore_positions
6366 && (!EQ (sw1->hscroll, sw2->hscroll)
6367 || !EQ (sw1->min_hscroll, sw2->min_hscroll)
6368 || !EQ (sw1->start_at_line_beg, sw2->start_at_line_beg)
6369 || NILP (Fequal (sw1->start, sw2->start))
6370 || NILP (Fequal (sw1->pointm, sw2->pointm))
6371 || NILP (Fequal (sw1->mark, sw2->mark))))
6372 || !EQ (sw1->left_margin_cols, sw2->left_margin_cols)
6373 || !EQ (sw1->right_margin_cols, sw2->right_margin_cols)
6374 || !EQ (sw1->left_fringe_width, sw2->left_fringe_width)
6375 || !EQ (sw1->right_fringe_width, sw2->right_fringe_width)
6376 || !EQ (sw1->fringes_outside_margins, sw2->fringes_outside_margins)
6377 || !EQ (sw1->scroll_bar_width, sw2->scroll_bar_width)
6378 || !EQ (sw1->vertical_scroll_bar_type, sw2->vertical_scroll_bar_type))
6379 return 0;
6380 }
6381
6382 return 1;
6383 }
6384
6385 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
6386 Scompare_window_configurations, 2, 2, 0,
6387 doc: /* Compare two window configurations as regards the structure of windows.
6388 This function ignores details such as the values of point and mark
6389 and scrolling positions. */)
6390 (Lisp_Object x, Lisp_Object y)
6391 {
6392 if (compare_window_configurations (x, y, 1))
6393 return Qt;
6394 return Qnil;
6395 }
6396 \f
6397 void
6398 init_window_once (void)
6399 {
6400 struct frame *f = make_initial_frame ();
6401 XSETFRAME (selected_frame, f);
6402 Vterminal_frame = selected_frame;
6403 minibuf_window = f->minibuffer_window;
6404 selected_window = f->selected_window;
6405 last_nonminibuf_frame = f;
6406
6407 window_initialized = 1;
6408 }
6409
6410 void
6411 init_window (void)
6412 {
6413 Vwindow_list = Qnil;
6414 }
6415
6416 void
6417 syms_of_window (void)
6418 {
6419 DEFSYM (Qscroll_up, "scroll-up");
6420 DEFSYM (Qscroll_down, "scroll-down");
6421 DEFSYM (Qscroll_command, "scroll-command");
6422
6423 Fput (Qscroll_up, Qscroll_command, Qt);
6424 Fput (Qscroll_down, Qscroll_command, Qt);
6425
6426 DEFSYM (Qwindow_configuration_change_hook, "window-configuration-change-hook");
6427 DEFSYM (Qwindowp, "windowp");
6428 DEFSYM (Qwindow_configuration_p, "window-configuration-p");
6429 DEFSYM (Qwindow_live_p, "window-live-p");
6430 DEFSYM (Qwindow_deletable_p, "window-deletable-p");
6431 DEFSYM (Qdelete_window, "delete-window");
6432 DEFSYM (Qwindow_resize_root_window, "window--resize-root-window");
6433 DEFSYM (Qwindow_resize_root_window_vertically, "window--resize-root-window-vertically");
6434 DEFSYM (Qsafe, "safe");
6435 DEFSYM (Qdisplay_buffer, "display-buffer");
6436 DEFSYM (Qreplace_buffer_in_windows, "replace-buffer-in-windows");
6437 DEFSYM (Qrecord_window_buffer, "record-window-buffer");
6438 DEFSYM (Qget_mru_window, "get-mru-window");
6439 DEFSYM (Qtemp_buffer_show_hook, "temp-buffer-show-hook");
6440 DEFSYM (Qabove, "above");
6441 DEFSYM (Qbelow, "below");
6442 DEFSYM (Qauto_buffer_name, "auto-buffer-name");
6443
6444 staticpro (&Vwindow_list);
6445
6446 minibuf_selected_window = Qnil;
6447 staticpro (&minibuf_selected_window);
6448
6449 window_scroll_pixel_based_preserve_x = -1;
6450 window_scroll_pixel_based_preserve_y = -1;
6451 window_scroll_preserve_hpos = -1;
6452 window_scroll_preserve_vpos = -1;
6453
6454 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function,
6455 doc: /* Non-nil means call as function to display a help buffer.
6456 The function is called with one argument, the buffer to be displayed.
6457 Used by `with-output-to-temp-buffer'.
6458 If this function is used, then it must do the entire job of showing
6459 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
6460 Vtemp_buffer_show_function = Qnil;
6461
6462 DEFVAR_LISP ("temp-buffer-show-specifiers", Vtemp_buffer_show_specifiers,
6463 doc: /* Buffer display specifiers used by `with-output-to-temp-buffer'.
6464 These specifiers are passed by `with-output-to-temp-buffer' as second
6465 argument to `display-buffer'. Applications should only let-bind this
6466 around a call to `with-output-to-temp-buffer'.
6467
6468 For a description of buffer display specifiers see the variable
6469 `display-buffer-alist'. */);
6470 Vtemp_buffer_show_specifiers = Qnil;
6471
6472 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window,
6473 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
6474 Vminibuf_scroll_window = Qnil;
6475
6476 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows,
6477 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
6478 If the minibuffer is active, the `minibuffer-scroll-window' mode line
6479 is displayed in the `mode-line' face. */);
6480 mode_line_in_non_selected_windows = 1;
6481
6482 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer,
6483 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
6484 Vother_window_scroll_buffer = Qnil;
6485
6486 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p,
6487 doc: /* Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
6488 auto_window_vscroll_p = 1;
6489
6490 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines,
6491 doc: /* Number of lines of continuity when scrolling by screenfuls. */);
6492 next_screen_context_lines = 2;
6493
6494 DEFVAR_LISP ("scroll-preserve-screen-position",
6495 Vscroll_preserve_screen_position,
6496 doc: /* Controls if scroll commands move point to keep its screen position unchanged.
6497 A value of nil means point does not keep its screen position except
6498 at the scroll margin or window boundary respectively.
6499 A value of t means point keeps its screen position if the scroll
6500 command moved it vertically out of the window, e.g. when scrolling
6501 by full screens.
6502 Any other value means point always keeps its screen position.
6503 Scroll commands should have the `scroll-command' property
6504 on their symbols to be controlled by this variable. */);
6505 Vscroll_preserve_screen_position = Qnil;
6506
6507 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type,
6508 doc: /* Type of marker to use for `window-point'. */);
6509 Vwindow_point_insertion_type = Qnil;
6510
6511 DEFVAR_LISP ("window-configuration-change-hook",
6512 Vwindow_configuration_change_hook,
6513 doc: /* Functions to call when window configuration changes.
6514 The buffer-local part is run once per window, with the relevant window
6515 selected; while the global part is run only once for the modified frame,
6516 with the relevant frame selected. */);
6517 Vwindow_configuration_change_hook = Qnil;
6518
6519 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay,
6520 doc: /* If non-nil, then the `recenter' command with a nil argument
6521 will redraw the entire frame; the special value `tty' causes the
6522 frame to be redrawn only if it is a tty frame. */);
6523 Vrecenter_redisplay = Qtty;
6524
6525 DEFVAR_LISP ("window-splits", Vwindow_splits,
6526 doc: /* Non-nil means splitting windows is handled specially.
6527 If this variable is nil, splitting a window gets the entire screen space
6528 for displaying the new window from the window to split. If this
6529 variable is non-nil, splitting a window may resize all windows in the
6530 same combination. This also allows to split a window that is otherwise
6531 too small or of fixed size.
6532
6533 The value of this variable is also assigned to the split status of the
6534 new window and, provided the old and new window form a new combination,
6535 to the window that was split as well. The split status of a window can
6536 be retrieved with the function `window-splits' and altered by the
6537 function `set-window-splits'.
6538
6539 If the value of the variable `window-nest' is non-nil, the space for the
6540 new window is exclusively taken from the window that shall be split, but
6541 the split status of the window that is split as well as that of the new
6542 window are still set to the value of this variable. */);
6543 Vwindow_splits = Qnil;
6544
6545 DEFVAR_LISP ("window-nest", Vwindow_nest,
6546 doc: /* Non-nil means splitting a window makes a new parent window.
6547 If this variable is nil, splitting a window will create a new parent
6548 window only if the window has no parent window or the window shall
6549 become a combination orthogonal to the one it it is part of.
6550
6551 If this variable is non-nil, splitting a window always creates a new
6552 parent window. If all splits behave this way, each frame's window tree
6553 is a binary tree and every window but the frame's root window has
6554 exactly one sibling.
6555
6556 The value of this variable is also assigned to the nest status of the
6557 new parent window. The nest status of a window can be retrieved via the
6558 function `window-nest' and altered by the function `set-window-nest'. */);
6559 Vwindow_nest = Qnil;
6560
6561 defsubr (&Sselected_window);
6562 defsubr (&Sminibuffer_window);
6563 defsubr (&Swindow_minibuffer_p);
6564 defsubr (&Swindowp);
6565 defsubr (&Swindow_live_p);
6566 defsubr (&Swindow_frame);
6567 defsubr (&Sframe_root_window);
6568 defsubr (&Sframe_first_window);
6569 defsubr (&Sframe_selected_window);
6570 defsubr (&Sset_frame_selected_window);
6571 defsubr (&Spos_visible_in_window_p);
6572 defsubr (&Swindow_line_height);
6573 defsubr (&Swindow_buffer);
6574 defsubr (&Swindow_parent);
6575 defsubr (&Swindow_top_child);
6576 defsubr (&Swindow_left_child);
6577 defsubr (&Swindow_next_sibling);
6578 defsubr (&Swindow_prev_sibling);
6579 defsubr (&Swindow_splits);
6580 defsubr (&Sset_window_splits);
6581 defsubr (&Swindow_nest);
6582 defsubr (&Sset_window_nest);
6583 defsubr (&Swindow_use_time);
6584 defsubr (&Swindow_top_line);
6585 defsubr (&Swindow_left_column);
6586 defsubr (&Swindow_total_size);
6587 defsubr (&Swindow_normal_size);
6588 defsubr (&Swindow_new_total);
6589 defsubr (&Swindow_new_normal);
6590 defsubr (&Sset_window_new_total);
6591 defsubr (&Sset_window_new_normal);
6592 defsubr (&Swindow_resize_apply);
6593 defsubr (&Swindow_body_size);
6594 defsubr (&Swindow_hscroll);
6595 defsubr (&Sset_window_hscroll);
6596 defsubr (&Swindow_redisplay_end_trigger);
6597 defsubr (&Sset_window_redisplay_end_trigger);
6598 defsubr (&Swindow_edges);
6599 defsubr (&Swindow_pixel_edges);
6600 defsubr (&Swindow_absolute_pixel_edges);
6601 defsubr (&Swindow_inside_edges);
6602 defsubr (&Swindow_inside_pixel_edges);
6603 defsubr (&Swindow_inside_absolute_pixel_edges);
6604 defsubr (&Scoordinates_in_window_p);
6605 defsubr (&Swindow_at);
6606 defsubr (&Swindow_point);
6607 defsubr (&Swindow_start);
6608 defsubr (&Swindow_end);
6609 defsubr (&Sset_window_point);
6610 defsubr (&Sset_window_start);
6611 defsubr (&Swindow_dedicated_p);
6612 defsubr (&Sset_window_dedicated_p);
6613 defsubr (&Swindow_display_table);
6614 defsubr (&Sset_window_display_table);
6615 defsubr (&Snext_window);
6616 defsubr (&Sprevious_window);
6617 defsubr (&Sget_buffer_window);
6618 defsubr (&Sdelete_other_windows_internal);
6619 defsubr (&Sdelete_window_internal);
6620 defsubr (&Sresize_mini_window_internal);
6621 defsubr (&Sset_window_buffer);
6622 defsubr (&Srun_window_configuration_change_hook);
6623 defsubr (&Sselect_window);
6624 defsubr (&Sforce_window_update);
6625 defsubr (&Stemp_output_buffer_show);
6626 defsubr (&Ssplit_window_internal);
6627 defsubr (&Sscroll_up);
6628 defsubr (&Sscroll_down);
6629 defsubr (&Sscroll_left);
6630 defsubr (&Sscroll_right);
6631 defsubr (&Sother_window_for_scrolling);
6632 defsubr (&Sscroll_other_window);
6633 defsubr (&Sminibuffer_selected_window);
6634 defsubr (&Srecenter);
6635 defsubr (&Swindow_text_height);
6636 defsubr (&Smove_to_window_line);
6637 defsubr (&Swindow_configuration_p);
6638 defsubr (&Swindow_configuration_frame);
6639 defsubr (&Sset_window_configuration);
6640 defsubr (&Scurrent_window_configuration);
6641 defsubr (&Sset_window_margins);
6642 defsubr (&Swindow_margins);
6643 defsubr (&Sset_window_fringes);
6644 defsubr (&Swindow_fringes);
6645 defsubr (&Sset_window_scroll_bars);
6646 defsubr (&Swindow_scroll_bars);
6647 defsubr (&Swindow_vscroll);
6648 defsubr (&Sset_window_vscroll);
6649 defsubr (&Scompare_window_configurations);
6650 defsubr (&Swindow_list);
6651 defsubr (&Swindow_list_1);
6652 defsubr (&Swindow_prev_buffers);
6653 defsubr (&Sset_window_prev_buffers);
6654 defsubr (&Swindow_next_buffers);
6655 defsubr (&Sset_window_next_buffers);
6656 defsubr (&Swindow_parameters);
6657 defsubr (&Swindow_parameter);
6658 defsubr (&Sset_window_parameter);
6659 }
6660
6661 void
6662 keys_of_window (void)
6663 {
6664 initial_define_key (control_x_map, '<', "scroll-left");
6665 initial_define_key (control_x_map, '>', "scroll-right");
6666
6667 initial_define_key (global_map, Ctl ('V'), "scroll-up-command");
6668 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
6669 initial_define_key (meta_map, 'v', "scroll-down-command");
6670 }