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