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