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