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