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