Move note on lack of setf functions from cl.texi to lispref
[emacs.git] / src / window.c
blobdfcabda59b96d6b75f34445f4520eccedecaca27
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.
6 This file is part of GNU Emacs.
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.
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.
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/>. */
21 #include <config.h>
23 #define WINDOW_INLINE EXTERN_INLINE
25 #include <stdio.h>
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. */
43 #ifdef HAVE_X_WINDOWS
44 #include "xterm.h"
45 #endif /* HAVE_X_WINDOWS */
46 #ifdef HAVE_NTGUI
47 #include "w32term.h"
48 #endif
49 #ifdef MSDOS
50 #include "msdos.h"
51 #endif
52 #ifdef HAVE_NS
53 #include "nsterm.h"
54 #endif
56 Lisp_Object Qwindowp, Qwindow_live_p;
57 static Lisp_Object Qwindow_valid_p;
58 static Lisp_Object Qwindow_configuration_p, Qrecord_window_buffer;
59 static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
60 static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
61 static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
62 static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
63 static Lisp_Object Qsafe, Qabove, Qbelow, Qwindow_size, Qclone_of;
65 static int displayed_window_lines (struct window *);
66 static int count_windows (struct window *);
67 static int get_leaf_windows (struct window *, struct window **, int);
68 static void window_scroll (Lisp_Object, EMACS_INT, int, int);
69 static void window_scroll_pixel_based (Lisp_Object, int, int, int);
70 static void window_scroll_line_based (Lisp_Object, int, int, int);
71 static int freeze_window_start (struct window *, void *);
72 static Lisp_Object window_list (void);
73 static int add_window_to_list (struct window *, void *);
74 static int candidate_window_p (Lisp_Object, Lisp_Object, Lisp_Object,
75 Lisp_Object);
76 static Lisp_Object next_window (Lisp_Object, Lisp_Object,
77 Lisp_Object, int);
78 static void decode_next_window_args (Lisp_Object *, Lisp_Object *,
79 Lisp_Object *);
80 static void foreach_window (struct frame *,
81 int (* fn) (struct window *, void *),
82 void *);
83 static int foreach_window_1 (struct window *,
84 int (* fn) (struct window *, void *),
85 void *);
86 static Lisp_Object window_list_1 (Lisp_Object, Lisp_Object, Lisp_Object);
87 static int window_resize_check (struct window *, int);
88 static void window_resize_apply (struct window *, int);
89 static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
91 /* This is the window in which the terminal's cursor should
92 be left when nothing is being done with it. This must
93 always be a leaf window, and its buffer is selected by
94 the top level editing loop at the end of each command.
96 This value is always the same as
97 FRAME_SELECTED_WINDOW (selected_frame). */
98 Lisp_Object selected_window;
100 /* A list of all windows for use by next_window and Fwindow_list.
101 Functions creating or deleting windows should invalidate this cache
102 by setting it to nil. */
103 Lisp_Object Vwindow_list;
105 /* The mini-buffer window of the selected frame.
106 Note that you cannot test for mini-bufferness of an arbitrary window
107 by comparing against this; but you can test for mini-bufferness of
108 the selected window. */
109 Lisp_Object minibuf_window;
111 /* Non-nil means it is the window whose mode line should be
112 shown as the selected window when the minibuffer is selected. */
113 Lisp_Object minibuf_selected_window;
115 /* Hook run at end of temp_output_buffer_show. */
116 static Lisp_Object Qtemp_buffer_show_hook;
118 /* Incremented for each window created. */
119 static int sequence_number;
121 /* Nonzero after init_window_once has finished. */
122 static int window_initialized;
124 /* Hook to run when window config changes. */
125 static Lisp_Object Qwindow_configuration_change_hook;
127 /* Used by the function window_scroll_pixel_based */
128 static int window_scroll_pixel_based_preserve_x;
129 static int window_scroll_pixel_based_preserve_y;
131 /* Same for window_scroll_line_based. */
132 static EMACS_INT window_scroll_preserve_hpos;
133 static EMACS_INT window_scroll_preserve_vpos;
135 /* These setters are used only in this file, so they can be private. */
136 static void
137 wset_combination_limit (struct window *w, Lisp_Object val)
139 w->combination_limit = val;
141 static void
142 wset_dedicated (struct window *w, Lisp_Object val)
144 w->dedicated = val;
146 static void
147 wset_display_table (struct window *w, Lisp_Object val)
149 w->display_table = val;
151 static void
152 wset_hchild (struct window *w, Lisp_Object val)
154 w->hchild = val;
156 static void
157 wset_left_fringe_width (struct window *w, Lisp_Object val)
159 w->left_fringe_width = val;
161 static void
162 wset_left_margin_cols (struct window *w, Lisp_Object val)
164 w->left_margin_cols = val;
166 static void
167 wset_new_normal (struct window *w, Lisp_Object val)
169 w->new_normal = val;
171 static void
172 wset_new_total (struct window *w, Lisp_Object val)
174 w->new_total = val;
176 static void
177 wset_normal_cols (struct window *w, Lisp_Object val)
179 w->normal_cols = val;
181 static void
182 wset_normal_lines (struct window *w, Lisp_Object val)
184 w->normal_lines = val;
186 static void
187 wset_parent (struct window *w, Lisp_Object val)
189 w->parent = val;
191 static void
192 wset_pointm (struct window *w, Lisp_Object val)
194 w->pointm = val;
196 static void
197 wset_right_fringe_width (struct window *w, Lisp_Object val)
199 w->right_fringe_width = val;
201 static void
202 wset_right_margin_cols (struct window *w, Lisp_Object val)
204 w->right_margin_cols = val;
206 static void
207 wset_scroll_bar_width (struct window *w, Lisp_Object val)
209 w->scroll_bar_width = val;
211 static void
212 wset_start (struct window *w, Lisp_Object val)
214 w->start = val;
216 static void
217 wset_temslot (struct window *w, Lisp_Object val)
219 w->temslot = val;
221 static void
222 wset_vchild (struct window *w, Lisp_Object val)
224 w->vchild = val;
226 static void
227 wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
229 w->vertical_scroll_bar_type = val;
231 static void
232 wset_window_parameters (struct window *w, Lisp_Object val)
234 w->window_parameters = val;
237 struct window *
238 decode_live_window (register Lisp_Object window)
240 if (NILP (window))
241 return XWINDOW (selected_window);
243 CHECK_LIVE_WINDOW (window);
244 return XWINDOW (window);
247 static struct window *
248 decode_any_window (register Lisp_Object window)
250 struct window *w;
252 if (NILP (window))
253 return XWINDOW (selected_window);
255 CHECK_WINDOW (window);
256 w = XWINDOW (window);
257 return w;
260 static struct window *
261 decode_valid_window (register Lisp_Object window)
263 struct window *w;
265 if (NILP (window))
266 return XWINDOW (selected_window);
268 CHECK_VALID_WINDOW (window);
269 w = XWINDOW (window);
270 return w;
273 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
274 doc: /* Return t if OBJECT is a window and nil otherwise. */)
275 (Lisp_Object object)
277 return WINDOWP (object) ? Qt : Qnil;
280 DEFUN ("window-valid-p", Fwindow_valid_p, Swindow_valid_p, 1, 1, 0,
281 doc: /* Return t if OBJECT is a valid window and nil otherwise.
282 A valid window is either a window that displays a buffer or an internal
283 window. Deleted windows are not live. */)
284 (Lisp_Object object)
286 return WINDOW_VALID_P (object) ? Qt : Qnil;
289 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
290 doc: /* Return t if OBJECT is a live window and nil otherwise.
291 A live window is a window that displays a buffer.
292 Internal windows and deleted windows are not live. */)
293 (Lisp_Object object)
295 return WINDOW_LIVE_P (object) ? Qt : Qnil;
298 /* Frames and windows. */
299 DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 1, 1, 0,
300 doc: /* Return the frame that window WINDOW is on.
301 WINDOW must be a valid window and defaults to the selected one. */)
302 (Lisp_Object window)
304 return decode_valid_window (window)->frame;
307 DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
308 doc: /* Return the root window of FRAME-OR-WINDOW.
309 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
310 With a frame argument, return that frame's root window.
311 With a window argument, return the root window of that window's frame. */)
312 (Lisp_Object frame_or_window)
314 Lisp_Object window;
316 if (NILP (frame_or_window))
317 window = SELECTED_FRAME ()->root_window;
318 else if (WINDOW_VALID_P (frame_or_window))
319 window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
320 else
322 CHECK_LIVE_FRAME (frame_or_window);
323 window = XFRAME (frame_or_window)->root_window;
326 return window;
329 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
330 doc: /* Return the minibuffer window for frame FRAME.
331 If FRAME is omitted or nil, it defaults to the selected frame. */)
332 (Lisp_Object frame)
334 if (NILP (frame))
335 frame = selected_frame;
336 CHECK_LIVE_FRAME (frame);
337 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
340 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
341 Swindow_minibuffer_p, 0, 1, 0,
342 doc: /* Return non-nil if WINDOW is a minibuffer window.
343 WINDOW must be a valid window and defaults to the selected one. */)
344 (Lisp_Object window)
346 return MINI_WINDOW_P (decode_valid_window (window)) ? Qt : Qnil;
349 /* Don't move this to window.el - this must be a safe routine. */
350 DEFUN ("frame-first-window", Fframe_first_window, Sframe_first_window, 0, 1, 0,
351 doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
352 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
353 Else if FRAME-OR-WINDOW denotes a valid window, return the first window
354 of that window's frame. If FRAME-OR-WINDOW denotes a live frame, return
355 the first window of that frame. */)
356 (Lisp_Object frame_or_window)
358 Lisp_Object window;
360 if (NILP (frame_or_window))
361 window = SELECTED_FRAME ()->root_window;
362 else if (WINDOW_VALID_P (frame_or_window))
363 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
364 else
366 CHECK_LIVE_FRAME (frame_or_window);
367 window = XFRAME (frame_or_window)->root_window;
370 while (NILP (XWINDOW (window)->buffer))
372 if (! NILP (XWINDOW (window)->hchild))
373 window = XWINDOW (window)->hchild;
374 else if (! NILP (XWINDOW (window)->vchild))
375 window = XWINDOW (window)->vchild;
376 else
377 emacs_abort ();
380 return window;
383 DEFUN ("frame-selected-window", Fframe_selected_window,
384 Sframe_selected_window, 0, 1, 0,
385 doc: /* Return the selected window of FRAME-OR-WINDOW.
386 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
387 Else if FRAME-OR-WINDOW denotes a valid window, return the selected
388 window of that window's frame. If FRAME-OR-WINDOW denotes a live frame,
389 return the selected window of that frame. */)
390 (Lisp_Object frame_or_window)
392 Lisp_Object window;
394 if (NILP (frame_or_window))
395 window = SELECTED_FRAME ()->selected_window;
396 else if (WINDOW_VALID_P (frame_or_window))
397 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
398 else
400 CHECK_LIVE_FRAME (frame_or_window);
401 window = XFRAME (frame_or_window)->selected_window;
404 return window;
407 DEFUN ("set-frame-selected-window", Fset_frame_selected_window,
408 Sset_frame_selected_window, 2, 3, 0,
409 doc: /* Set selected window of FRAME to WINDOW.
410 FRAME must be a live frame and defaults to the selected one. If FRAME
411 is the selected frame, this makes WINDOW the selected window. Optional
412 argument NORECORD non-nil means to neither change the order of recently
413 selected windows nor the buffer list. WINDOW must denote a live window.
414 Return WINDOW. */)
415 (Lisp_Object frame, Lisp_Object window, Lisp_Object norecord)
417 if (NILP (frame))
418 frame = selected_frame;
420 CHECK_LIVE_FRAME (frame);
421 CHECK_LIVE_WINDOW (window);
423 if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
424 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
426 if (EQ (frame, selected_frame))
427 return Fselect_window (window, norecord);
428 else
430 fset_selected_window (XFRAME (frame), window);
431 return window;
435 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
436 doc: /* Return the selected window.
437 The selected window is the window in which the standard cursor for
438 selected windows appears and to which many commands apply. */)
439 (void)
441 return selected_window;
444 int window_select_count;
446 /* If select_window is called with inhibit_point_swap non-zero it will
447 not store point of the old selected window's buffer back into that
448 window's pointm slot. This is needed by Fset_window_configuration to
449 avoid that the display routine is called with selected_window set to
450 Qnil causing a subsequent crash. */
451 static Lisp_Object
452 select_window (Lisp_Object window, Lisp_Object norecord, int inhibit_point_swap)
454 register struct window *w;
455 register struct window *ow;
456 struct frame *sf;
458 CHECK_LIVE_WINDOW (window);
460 w = XWINDOW (window);
461 w->frozen_window_start_p = 0;
463 if (NILP (norecord))
465 w->use_time = ++window_select_count;
466 record_buffer (w->buffer);
469 /* Make the selected window's buffer current. */
470 Fset_buffer (w->buffer);
472 if (EQ (window, selected_window) && !inhibit_point_swap)
473 return window;
475 sf = SELECTED_FRAME ();
476 if (XFRAME (WINDOW_FRAME (w)) != sf)
478 fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
479 /* Use this rather than Fhandle_switch_frame
480 so that FRAME_FOCUS_FRAME is moved appropriately as we
481 move around in the state where a minibuffer in a separate
482 frame is active. */
483 Fselect_frame (WINDOW_FRAME (w), norecord);
484 /* Fselect_frame called us back so we've done all the work already. */
485 eassert (EQ (window, selected_window));
486 return window;
488 else
489 fset_selected_window (sf, window);
491 /* Store the old selected window's buffer's point in pointm of the old
492 selected window. It belongs to that window, and when the window is
493 not selected, must be in the window. */
494 if (!inhibit_point_swap)
496 ow = XWINDOW (selected_window);
497 if (! NILP (ow->buffer))
498 set_marker_both (ow->pointm, ow->buffer,
499 BUF_PT (XBUFFER (ow->buffer)),
500 BUF_PT_BYTE (XBUFFER (ow->buffer)));
503 selected_window = window;
504 bset_last_selected_window (XBUFFER (w->buffer), window);
506 /* Go to the point recorded in the window.
507 This is important when the buffer is in more
508 than one window. It also matters when
509 redisplay_window has altered point after scrolling,
510 because it makes the change only in the window. */
512 register ptrdiff_t new_point = marker_position (w->pointm);
513 if (new_point < BEGV)
514 SET_PT (BEGV);
515 else if (new_point > ZV)
516 SET_PT (ZV);
517 else
518 SET_PT (new_point);
521 windows_or_buffers_changed++;
522 return window;
525 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
526 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
527 Also make WINDOW's buffer current and make WINDOW the frame's selected
528 window. Return WINDOW.
530 Optional second arg NORECORD non-nil means do not put this buffer at the
531 front of the buffer list and do not make this window the most recently
532 selected one.
534 Note that the main editor command loop sets the current buffer to the
535 buffer of the selected window before each command. */)
536 (register Lisp_Object window, Lisp_Object norecord)
538 return select_window (window, norecord, 0);
541 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
542 doc: /* Return the buffer displayed in window WINDOW.
543 If WINDOW is omitted or nil, it defaults to the selected window.
544 Return nil for an internal window or a deleted window. */)
545 (Lisp_Object window)
547 return decode_any_window (window)->buffer;
550 DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
551 doc: /* Return the parent window of window WINDOW.
552 WINDOW must be a valid window and defaults to the selected one.
553 Return nil for a window with no parent (e.g. a root window). */)
554 (Lisp_Object window)
556 return decode_valid_window (window)->parent;
559 DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 1, 1, 0,
560 doc: /* Return the topmost child window of window WINDOW.
561 WINDOW must be a valid window and defaults to the selected one.
562 Return nil if WINDOW is a live window (live windows have no children).
563 Return nil if WINDOW is an internal window whose children form a
564 horizontal combination. */)
565 (Lisp_Object window)
567 CHECK_WINDOW (window);
568 return decode_valid_window (window)->vchild;
571 DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 1, 1, 0,
572 doc: /* Return the leftmost child window of window WINDOW.
573 WINDOW must be a valid window and defaults to the selected one.
574 Return nil if WINDOW is a live window (live windows have no children).
575 Return nil if WINDOW is an internal window whose children form a
576 vertical combination. */)
577 (Lisp_Object window)
579 CHECK_WINDOW (window);
580 return decode_valid_window (window)->hchild;
583 DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
584 doc: /* Return the next sibling window of window WINDOW.
585 WINDOW must be a valid window and defaults to the selected one.
586 Return nil if WINDOW has no next sibling. */)
587 (Lisp_Object window)
589 return decode_valid_window (window)->next;
592 DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
593 doc: /* Return the previous sibling window of window WINDOW.
594 WINDOW must be a valid window and defaults to the selected one.
595 Return nil if WINDOW has no previous sibling. */)
596 (Lisp_Object window)
598 return decode_valid_window (window)->prev;
601 DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
602 doc: /* Return combination limit of window WINDOW.
603 WINDOW must be a valid window and defaults to the selected one.
604 If the return value is nil, child windows of WINDOW can be recombined with
605 WINDOW's siblings. A return value of t means that child windows of
606 WINDOW are never \(re-)combined with WINDOW's siblings. */)
607 (Lisp_Object window)
609 return decode_valid_window (window)->combination_limit;
612 DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
613 doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
614 WINDOW must be a valid window and defaults to the selected one.
615 If LIMIT is nil, child windows of WINDOW can be recombined with WINDOW's
616 siblings. LIMIT t means that child windows of WINDOW are never
617 \(re-)combined with WINDOW's siblings. Other values are reserved for
618 future use. */)
619 (Lisp_Object window, Lisp_Object limit)
621 wset_combination_limit (decode_valid_window (window), limit);
622 return limit;
625 DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
626 doc: /* Return the use time of window WINDOW.
627 WINDOW must be a live window and defaults to the selected one.
628 The window with the highest use time is the most recently selected
629 one. The window with the lowest use time is the least recently
630 selected one. */)
631 (Lisp_Object window)
633 return make_number (decode_live_window (window)->use_time);
636 DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
637 doc: /* Return the total height, in lines, of window WINDOW.
638 WINDOW must be a valid window and defaults to the selected one.
640 The return value includes the mode line and header line, if any.
641 If WINDOW is an internal window, the total height is the height
642 of the screen areas spanned by its children.
644 On a graphical display, this total height is reported as an
645 integer multiple of the default character height. */)
646 (Lisp_Object window)
648 return decode_valid_window (window)->total_lines;
651 DEFUN ("window-total-width", Fwindow_total_width, Swindow_total_width, 0, 1, 0,
652 doc: /* Return the total width, in columns, of window WINDOW.
653 WINDOW must be a valid window and defaults to the selected one.
655 The return value includes any vertical dividers or scroll bars
656 belonging to WINDOW. If WINDOW is an internal window, the total width
657 is the width of the screen areas spanned by its children.
659 On a graphical display, this total width is reported as an
660 integer multiple of the default character width. */)
661 (Lisp_Object window)
663 return decode_valid_window (window)->total_cols;
666 DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
667 doc: /* Return the new total size of window WINDOW.
668 WINDOW must be a valid window and defaults to the selected one. */)
669 (Lisp_Object window)
671 return decode_valid_window (window)->new_total;
674 DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
675 doc: /* Return the normal height of window WINDOW.
676 WINDOW must be a valid window and defaults to the selected one.
677 If HORIZONTAL is non-nil, return the normal width of WINDOW. */)
678 (Lisp_Object window, Lisp_Object horizontal)
680 struct window *w = decode_valid_window (window);
682 return NILP (horizontal) ? w->normal_lines : w->normal_cols;
685 DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
686 doc: /* Return new normal size of window WINDOW.
687 WINDOW must be a valid window and defaults to the selected one. */)
688 (Lisp_Object window)
690 return decode_valid_window (window)->new_normal;
693 DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
694 doc: /* Return left column of window WINDOW.
695 This is the distance, in columns, between the left edge of WINDOW and
696 the left edge of the frame's window area. For instance, the return
697 value is 0 if there is no window to the left of WINDOW.
699 WINDOW must be a valid window and defaults to the selected one. */)
700 (Lisp_Object window)
702 return decode_valid_window (window)->left_col;
705 DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
706 doc: /* Return top line of window WINDOW.
707 This is the distance, in lines, between the top of WINDOW and the top
708 of the frame's window area. For instance, the return value is 0 if
709 there is no window above WINDOW.
711 WINDOW must be a valid window and defaults to the selected one. */)
712 (Lisp_Object window)
714 return decode_valid_window (window)->top_line;
717 /* Return the number of lines of W's body. Don't count any mode or
718 header line of W. */
720 static int
721 window_body_lines (struct window *w)
723 int height = XFASTINT (w->total_lines);
725 if (!MINI_WINDOW_P (w))
727 if (WINDOW_WANTS_MODELINE_P (w))
728 --height;
729 if (WINDOW_WANTS_HEADER_LINE_P (w))
730 --height;
733 return height;
736 /* Return the number of columns of W's body. Don't count columns
737 occupied by the scroll bar or the vertical bar separating W from its
738 right sibling. On window-systems don't count fringes or display
739 margins either. */
742 window_body_cols (struct window *w)
744 struct frame *f = XFRAME (WINDOW_FRAME (w));
745 int width = XINT (w->total_cols);
747 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
748 /* Scroll bars occupy a few columns. */
749 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
750 else if (!FRAME_WINDOW_P (f)
751 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
752 /* The column of `|' characters separating side-by-side windows
753 occupies one column only. */
754 width -= 1;
756 if (FRAME_WINDOW_P (f))
757 /* On window-systems, fringes and display margins cannot be
758 used for normal text. */
759 width -= (WINDOW_FRINGE_COLS (w)
760 + WINDOW_LEFT_MARGIN_COLS (w)
761 + WINDOW_RIGHT_MARGIN_COLS (w));
763 return width;
766 DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 1, 0,
767 doc: /* Return the height, in lines, of WINDOW's text area.
768 WINDOW must be a live window and defaults to the selected one.
770 The returned height does not include the mode line or header line.
771 On a graphical display, the height is expressed as an integer multiple
772 of the default character height. If a line at the bottom of the text
773 area is only partially visible, that counts as a whole line; to
774 exclude partially-visible lines, use `window-text-height'. */)
775 (Lisp_Object window)
777 struct window *w = decode_live_window (window);
778 return make_number (window_body_lines (w));
781 DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 1, 0,
782 doc: /* Return the width, in columns, of WINDOW's text area.
783 WINDOW must be a live window and defaults to the selected one.
785 The return value does not include any vertical dividers, fringe or
786 marginal areas, or scroll bars. On a graphical display, the width is
787 expressed as an integer multiple of the default character width. */)
788 (Lisp_Object window)
790 struct window *w = decode_live_window (window);
791 return make_number (window_body_cols (w));
794 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
795 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
796 WINDOW must be a live window and defaults to the selected one. */)
797 (Lisp_Object window)
799 return make_number (decode_live_window (window)->hscroll);
802 /* Set W's horizontal scroll amount to HSCROLL clipped to a reasonable
803 range, returning the new amount as a fixnum. */
804 static Lisp_Object
805 set_window_hscroll (struct window *w, EMACS_INT hscroll)
807 /* Horizontal scrolling has problems with large scroll amounts.
808 It's too slow with long lines, and even with small lines the
809 display can be messed up. For now, though, impose only the limits
810 required by the internal representation: horizontal scrolling must
811 fit in fixnum (since it's visible to Elisp) and into ptrdiff_t
812 (since it's stored in a ptrdiff_t). */
813 ptrdiff_t hscroll_max = min (MOST_POSITIVE_FIXNUM, PTRDIFF_MAX);
814 ptrdiff_t new_hscroll = clip_to_bounds (0, hscroll, hscroll_max);
816 /* Prevent redisplay shortcuts when changing the hscroll. */
817 if (w->hscroll != new_hscroll)
818 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
820 w->hscroll = new_hscroll;
821 return make_number (new_hscroll);
824 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
825 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
826 WINDOW must be a live window and defaults to the selected one.
827 Clip the number to a reasonable value if out of range.
828 Return the new number. NCOL should be zero or positive.
830 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
831 window so that the location of point moves off-window. */)
832 (Lisp_Object window, Lisp_Object ncol)
834 struct window *w = decode_live_window (window);
836 CHECK_NUMBER (ncol);
837 return set_window_hscroll (w, XINT (ncol));
840 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
841 Swindow_redisplay_end_trigger, 0, 1, 0,
842 doc: /* Return WINDOW's redisplay end trigger value.
843 WINDOW must be a live window and defaults to the selected one.
844 See `set-window-redisplay-end-trigger' for more information. */)
845 (Lisp_Object window)
847 return decode_live_window (window)->redisplay_end_trigger;
850 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
851 Sset_window_redisplay_end_trigger, 2, 2, 0,
852 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
853 WINDOW must be a live window and defaults to the selected one. VALUE
854 should be a buffer position (typically a marker) or nil. If it is a
855 buffer position, then if redisplay in WINDOW reaches a position beyond
856 VALUE, the functions in `redisplay-end-trigger-functions' are called
857 with two arguments: WINDOW, and the end trigger value. Afterwards the
858 end-trigger value is reset to nil. */)
859 (register Lisp_Object window, Lisp_Object value)
861 wset_redisplay_end_trigger (decode_live_window (window), value);
862 return value;
865 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
866 doc: /* Return a list of the edge coordinates of WINDOW.
867 WINDOW must be a valid window and defaults to the selected one.
869 The returned list has the form (LEFT TOP RIGHT BOTTOM). TOP and BOTTOM
870 count by lines, and LEFT and RIGHT count by columns, all relative to 0,
871 0 at top left corner of frame.
873 RIGHT is one more than the rightmost column occupied by WINDOW. BOTTOM
874 is one more than the bottommost row occupied by WINDOW. The edges
875 include the space used by WINDOW's scroll bar, display margins, fringes,
876 header line, and/or mode line. For the edges of just the text area, use
877 `window-inside-edges'. */)
878 (Lisp_Object window)
880 register struct window *w = decode_valid_window (window);
882 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
883 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
884 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
885 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
886 Qnil))));
889 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
890 doc: /* Return a list of the edge pixel coordinates of WINDOW.
891 WINDOW must be a valid window and defaults to the selected one.
893 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
894 0, 0 at the top left corner of the frame.
896 RIGHT is one more than the rightmost x position occupied by WINDOW.
897 BOTTOM is one more than the bottommost y position occupied by WINDOW.
898 The pixel edges include the space used by WINDOW's scroll bar, display
899 margins, fringes, header line, and/or mode line. For the pixel edges
900 of just the text area, use `window-inside-pixel-edges'. */)
901 (Lisp_Object window)
903 register struct window *w = decode_valid_window (window);
905 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
906 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
907 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
908 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
909 Qnil))));
912 static void
913 calc_absolute_offset (struct window *w, int *add_x, int *add_y)
915 struct frame *f = XFRAME (w->frame);
916 *add_y = f->top_pos;
917 #ifdef FRAME_MENUBAR_HEIGHT
918 *add_y += FRAME_MENUBAR_HEIGHT (f);
919 #endif
920 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
921 *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
922 #elif FRAME_TOOLBAR_HEIGHT
923 *add_y += FRAME_TOOLBAR_HEIGHT (f);
924 #endif
925 #ifdef FRAME_NS_TITLEBAR_HEIGHT
926 *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
927 #endif
928 *add_x = f->left_pos;
929 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
930 *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
931 #endif
934 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
935 Swindow_absolute_pixel_edges, 0, 1, 0,
936 doc: /* Return a list of the edge pixel coordinates of WINDOW.
937 WINDOW must be a valid window and defaults to the selected one.
939 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
940 0, 0 at the top left corner of the display.
942 RIGHT is one more than the rightmost x position occupied by WINDOW.
943 BOTTOM is one more than the bottommost y position occupied by WINDOW.
944 The pixel edges include the space used by WINDOW's scroll bar, display
945 margins, fringes, header line, and/or mode line. For the pixel edges
946 of just the text area, use `window-inside-absolute-pixel-edges'. */)
947 (Lisp_Object window)
949 register struct window *w = decode_valid_window (window);
950 int add_x, add_y;
951 calc_absolute_offset (w, &add_x, &add_y);
953 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w) + add_x),
954 Fcons (make_number (WINDOW_TOP_EDGE_Y (w) + add_y),
955 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w) + add_x),
956 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w) + add_y),
957 Qnil))));
960 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
961 doc: /* Return a list of the edge coordinates of WINDOW.
962 WINDOW must be a live window and defaults to the selected one.
964 The returned list has the form (LEFT TOP RIGHT BOTTOM). TOP and BOTTOM
965 count by lines, and LEFT and RIGHT count by columns, all relative to 0,
966 0 at top left corner of frame.
968 RIGHT is one more than the rightmost column of WINDOW's text area.
969 BOTTOM is one more than the bottommost row of WINDOW's text area. The
970 inside edges do not include the space used by the WINDOW's scroll bar,
971 display margins, fringes, header line, and/or mode line. */)
972 (Lisp_Object window)
974 register struct window *w = decode_live_window (window);
976 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
977 + WINDOW_LEFT_MARGIN_COLS (w)
978 + WINDOW_LEFT_FRINGE_COLS (w)),
979 make_number (WINDOW_TOP_EDGE_LINE (w)
980 + WINDOW_HEADER_LINE_LINES (w)),
981 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
982 - WINDOW_RIGHT_MARGIN_COLS (w)
983 - WINDOW_RIGHT_FRINGE_COLS (w)),
984 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
985 - WINDOW_MODE_LINE_LINES (w)));
988 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
989 doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
990 WINDOW must be a live window and defaults to the selected one.
992 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
993 (0,0) at the top left corner of the frame's window area.
995 RIGHT is one more than the rightmost x position of WINDOW's text area.
996 BOTTOM is one more than the bottommost y position of WINDOW's text area.
997 The inside edges do not include the space used by WINDOW's scroll bar,
998 display margins, fringes, header line, and/or mode line. */)
999 (Lisp_Object window)
1001 register struct window *w = decode_live_window (window);
1003 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
1004 + WINDOW_LEFT_MARGIN_WIDTH (w)
1005 + WINDOW_LEFT_FRINGE_WIDTH (w)),
1006 make_number (WINDOW_TOP_EDGE_Y (w)
1007 + WINDOW_HEADER_LINE_HEIGHT (w)),
1008 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
1009 - WINDOW_RIGHT_MARGIN_WIDTH (w)
1010 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
1011 make_number (WINDOW_BOTTOM_EDGE_Y (w)
1012 - WINDOW_MODE_LINE_HEIGHT (w)));
1015 DEFUN ("window-inside-absolute-pixel-edges",
1016 Fwindow_inside_absolute_pixel_edges,
1017 Swindow_inside_absolute_pixel_edges, 0, 1, 0,
1018 doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
1019 WINDOW must be a live window and defaults to the selected one.
1021 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
1022 (0,0) at the top left corner of the frame's window area.
1024 RIGHT is one more than the rightmost x position of WINDOW's text area.
1025 BOTTOM is one more than the bottommost y position of WINDOW's text area.
1026 The inside edges do not include the space used by WINDOW's scroll bar,
1027 display margins, fringes, header line, and/or mode line. */)
1028 (Lisp_Object window)
1030 register struct window *w = decode_live_window (window);
1031 int add_x, add_y;
1032 calc_absolute_offset (w, &add_x, &add_y);
1034 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
1035 + WINDOW_LEFT_MARGIN_WIDTH (w)
1036 + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
1037 make_number (WINDOW_TOP_EDGE_Y (w)
1038 + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
1039 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
1040 - WINDOW_RIGHT_MARGIN_WIDTH (w)
1041 - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
1042 make_number (WINDOW_BOTTOM_EDGE_Y (w)
1043 - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
1046 /* Test if the character at column X, row Y is within window W.
1047 If it is not, return ON_NOTHING;
1048 if it is in the window's text area, return ON_TEXT;
1049 if it is on the window's modeline, return ON_MODE_LINE;
1050 if it is on the border between the window and its right sibling,
1051 return ON_VERTICAL_BORDER.
1052 if it is on a scroll bar, return ON_SCROLL_BAR.
1053 if it is on the window's top line, return ON_HEADER_LINE;
1054 if it is in left or right fringe of the window,
1055 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
1056 if it is in the marginal area to the left/right of the window,
1057 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
1059 X and Y are frame relative pixel coordinates. */
1061 static enum window_part
1062 coordinates_in_window (register struct window *w, int x, int y)
1064 struct frame *f = XFRAME (WINDOW_FRAME (w));
1065 enum window_part part;
1066 int ux = FRAME_COLUMN_WIDTH (f);
1067 int left_x = WINDOW_LEFT_EDGE_X (w);
1068 int right_x = WINDOW_RIGHT_EDGE_X (w);
1069 int top_y = WINDOW_TOP_EDGE_Y (w);
1070 int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
1071 /* The width of the area where the vertical line can be dragged.
1072 (Between mode lines for instance. */
1073 int grabbable_width = ux;
1074 int lmargin_width, rmargin_width, text_left, text_right;
1076 /* Outside any interesting row or column? */
1077 if (y < top_y || y >= bottom_y || x < left_x || x >= right_x)
1078 return ON_NOTHING;
1080 /* On the mode line or header line? */
1081 if ((WINDOW_WANTS_MODELINE_P (w)
1082 && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
1083 && (part = ON_MODE_LINE))
1084 || (WINDOW_WANTS_HEADER_LINE_P (w)
1085 && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
1086 && (part = ON_HEADER_LINE)))
1088 /* If it's under/over the scroll bar portion of the mode/header
1089 line, say it's on the vertical line. That's to be able to
1090 resize windows horizontally in case we're using toolkit scroll
1091 bars. Note: If scrollbars are on the left, the window that
1092 must be eventually resized is that on the left of WINDOW. */
1093 if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
1094 && !WINDOW_LEFTMOST_P (w)
1095 && eabs (x - left_x) < grabbable_width)
1096 || (!WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
1097 && !WINDOW_RIGHTMOST_P (w)
1098 && eabs (x - right_x) < grabbable_width))
1099 return ON_VERTICAL_BORDER;
1100 else
1101 return part;
1104 /* In what's below, we subtract 1 when computing right_x because we
1105 want the rightmost pixel, which is given by left_pixel+width-1. */
1106 if (w->pseudo_window_p)
1108 left_x = 0;
1109 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
1111 else
1113 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
1114 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
1117 /* Outside any interesting column? */
1118 if (x < left_x || x > right_x)
1119 return ON_SCROLL_BAR;
1121 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
1122 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
1124 text_left = window_box_left (w, TEXT_AREA);
1125 text_right = text_left + window_box_width (w, TEXT_AREA);
1127 if (FRAME_WINDOW_P (f))
1129 if (!w->pseudo_window_p
1130 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
1131 && !WINDOW_RIGHTMOST_P (w)
1132 && (eabs (x - right_x) < grabbable_width))
1133 return ON_VERTICAL_BORDER;
1135 /* Need to say "x > right_x" rather than >=, since on character
1136 terminals, the vertical line's x coordinate is right_x. */
1137 else if (!w->pseudo_window_p
1138 && !WINDOW_RIGHTMOST_P (w)
1139 && x > right_x - ux)
1140 return ON_VERTICAL_BORDER;
1142 if (x < text_left)
1144 if (lmargin_width > 0
1145 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1146 ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
1147 : (x < left_x + lmargin_width)))
1148 return ON_LEFT_MARGIN;
1150 return ON_LEFT_FRINGE;
1153 if (x >= text_right)
1155 if (rmargin_width > 0
1156 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1157 ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
1158 : (x >= right_x - rmargin_width)))
1159 return ON_RIGHT_MARGIN;
1161 return ON_RIGHT_FRINGE;
1164 /* Everything special ruled out - must be on text area */
1165 return ON_TEXT;
1168 /* Take X is the frame-relative pixel x-coordinate, and return the
1169 x-coordinate relative to part PART of window W. */
1171 window_relative_x_coord (struct window *w, enum window_part part, int x)
1173 int left_x = (w->pseudo_window_p) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w);
1175 switch (part)
1177 case ON_TEXT:
1178 return x - window_box_left (w, TEXT_AREA);
1180 case ON_LEFT_FRINGE:
1181 return x - left_x;
1183 case ON_RIGHT_FRINGE:
1184 return x - left_x - WINDOW_LEFT_FRINGE_WIDTH (w);
1186 case ON_LEFT_MARGIN:
1187 return (x - left_x
1188 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1189 ? WINDOW_LEFT_FRINGE_WIDTH (w) : 0));
1191 case ON_RIGHT_MARGIN:
1192 return (x + 1
1193 - ((w->pseudo_window_p)
1194 ? WINDOW_TOTAL_WIDTH (w)
1195 : WINDOW_BOX_RIGHT_EDGE_X (w))
1196 + window_box_width (w, RIGHT_MARGIN_AREA)
1197 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1198 ? WINDOW_RIGHT_FRINGE_WIDTH (w) : 0));
1201 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
1202 return 0;
1206 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
1207 Scoordinates_in_window_p, 2, 2, 0,
1208 doc: /* Return non-nil if COORDINATES are in WINDOW.
1209 WINDOW must be a live window and defaults to the selected one.
1210 COORDINATES is a cons of the form (X . Y), X and Y being distances
1211 measured in characters from the upper-left corner of the frame.
1212 \(0 . 0) denotes the character in the upper left corner of the
1213 frame.
1214 If COORDINATES are in the text portion of WINDOW,
1215 the coordinates relative to the window are returned.
1216 If they are in the mode line of WINDOW, `mode-line' is returned.
1217 If they are in the top mode line of WINDOW, `header-line' is returned.
1218 If they are in the left fringe of WINDOW, `left-fringe' is returned.
1219 If they are in the right fringe of WINDOW, `right-fringe' is returned.
1220 If they are on the border between WINDOW and its right sibling,
1221 `vertical-line' is returned.
1222 If they are in the windows's left or right marginal areas, `left-margin'\n\
1223 or `right-margin' is returned. */)
1224 (register Lisp_Object coordinates, Lisp_Object window)
1226 struct window *w;
1227 struct frame *f;
1228 int x, y;
1229 Lisp_Object lx, ly;
1231 w = decode_live_window (window);
1232 f = XFRAME (w->frame);
1233 CHECK_CONS (coordinates);
1234 lx = Fcar (coordinates);
1235 ly = Fcdr (coordinates);
1236 CHECK_NUMBER_OR_FLOAT (lx);
1237 CHECK_NUMBER_OR_FLOAT (ly);
1238 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
1239 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
1241 switch (coordinates_in_window (w, x, y))
1243 case ON_NOTHING:
1244 return Qnil;
1246 case ON_TEXT:
1247 /* Convert X and Y to window relative pixel coordinates, and
1248 return the canonical char units. */
1249 x -= window_box_left (w, TEXT_AREA);
1250 y -= WINDOW_TOP_EDGE_Y (w);
1251 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
1252 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
1254 case ON_MODE_LINE:
1255 return Qmode_line;
1257 case ON_VERTICAL_BORDER:
1258 return Qvertical_line;
1260 case ON_HEADER_LINE:
1261 return Qheader_line;
1263 case ON_LEFT_FRINGE:
1264 return Qleft_fringe;
1266 case ON_RIGHT_FRINGE:
1267 return Qright_fringe;
1269 case ON_LEFT_MARGIN:
1270 return Qleft_margin;
1272 case ON_RIGHT_MARGIN:
1273 return Qright_margin;
1275 case ON_SCROLL_BAR:
1276 /* Historically we are supposed to return nil in this case. */
1277 return Qnil;
1279 default:
1280 emacs_abort ();
1285 /* Callback for foreach_window, used in window_from_coordinates.
1286 Check if window W contains coordinates specified by USER_DATA which
1287 is actually a pointer to a struct check_window_data CW.
1289 Check if window W contains coordinates *CW->x and *CW->y. If it
1290 does, return W in *CW->window, as Lisp_Object, and return in
1291 *CW->part the part of the window under coordinates *X,*Y. Return
1292 zero from this function to stop iterating over windows. */
1294 struct check_window_data
1296 Lisp_Object *window;
1297 int x, y;
1298 enum window_part *part;
1301 static int
1302 check_window_containing (struct window *w, void *user_data)
1304 struct check_window_data *cw = (struct check_window_data *) user_data;
1305 enum window_part found;
1306 int continue_p = 1;
1308 found = coordinates_in_window (w, cw->x, cw->y);
1309 if (found != ON_NOTHING)
1311 *cw->part = found;
1312 XSETWINDOW (*cw->window, w);
1313 continue_p = 0;
1316 return continue_p;
1320 /* Find the window containing frame-relative pixel position X/Y and
1321 return it as a Lisp_Object.
1323 If X, Y is on one of the window's special `window_part' elements,
1324 set *PART to the id of that element.
1326 If there is no window under X, Y return nil and leave *PART
1327 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1329 This function was previously implemented with a loop cycling over
1330 windows with Fnext_window, and starting with the frame's selected
1331 window. It turned out that this doesn't work with an
1332 implementation of next_window using Vwindow_list, because
1333 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1334 tree of F when this function is called asynchronously from
1335 note_mouse_highlight. The original loop didn't terminate in this
1336 case. */
1338 Lisp_Object
1339 window_from_coordinates (struct frame *f, int x, int y,
1340 enum window_part *part, int tool_bar_p)
1342 Lisp_Object window;
1343 struct check_window_data cw;
1344 enum window_part dummy;
1346 if (part == 0)
1347 part = &dummy;
1349 window = Qnil;
1350 cw.window = &window, cw.x = x, cw.y = y; cw.part = part;
1351 foreach_window (f, check_window_containing, &cw);
1353 /* If not found above, see if it's in the tool bar window, if a tool
1354 bar exists. */
1355 if (NILP (window)
1356 && tool_bar_p
1357 && WINDOWP (f->tool_bar_window)
1358 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1359 && (coordinates_in_window (XWINDOW (f->tool_bar_window), x, y)
1360 != ON_NOTHING))
1362 *part = ON_TEXT;
1363 window = f->tool_bar_window;
1366 return window;
1369 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1370 doc: /* Return window containing coordinates X and Y on FRAME.
1371 FRAME must be a live frame and defaults to the selected one.
1372 The top left corner of the frame is considered to be row 0,
1373 column 0. */)
1374 (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
1376 struct frame *f;
1378 if (NILP (frame))
1379 frame = selected_frame;
1380 CHECK_LIVE_FRAME (frame);
1381 f = XFRAME (frame);
1383 /* Check that arguments are integers or floats. */
1384 CHECK_NUMBER_OR_FLOAT (x);
1385 CHECK_NUMBER_OR_FLOAT (y);
1387 return window_from_coordinates (f,
1388 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1389 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1390 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1391 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1392 0, 0);
1395 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1396 doc: /* Return current value of point in WINDOW.
1397 WINDOW must be a live window and defaults to the selected one.
1399 For a nonselected window, this is the value point would have if that
1400 window were selected.
1402 Note that, when WINDOW is selected, the value returned is the same as
1403 that returned by `point' for WINDOW's buffer. It would be more strictly
1404 correct to return the `top-level' value of `point', outside of any
1405 `save-excursion' forms. But that is hard to define. */)
1406 (Lisp_Object window)
1408 register struct window *w = decode_live_window (window);
1410 if (w == XWINDOW (selected_window))
1411 return make_number (BUF_PT (XBUFFER (w->buffer)));
1412 else
1413 return Fmarker_position (w->pointm);
1416 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1417 doc: /* Return position at which display currently starts in WINDOW.
1418 WINDOW must be a live window and defaults to the selected one.
1419 This is updated by redisplay or by calling `set-window-start'. */)
1420 (Lisp_Object window)
1422 return Fmarker_position (decode_live_window (window)->start);
1425 /* This is text temporarily removed from the doc string below.
1427 This function returns nil if the position is not currently known.
1428 That happens when redisplay is preempted and doesn't finish.
1429 If in that case you want to compute where the end of the window would
1430 have been if redisplay had finished, do this:
1431 (save-excursion
1432 (goto-char (window-start window))
1433 (vertical-motion (1- (window-height window)) window)
1434 (point))") */
1436 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1437 doc: /* Return position at which display currently ends in WINDOW.
1438 WINDOW must be a live window and defaults to the selected one.
1439 This is updated by redisplay, when it runs to completion.
1440 Simply changing the buffer text or setting `window-start'
1441 does not update this value.
1442 Return nil if there is no recorded value. (This can happen if the
1443 last redisplay of WINDOW was preempted, and did not finish.)
1444 If UPDATE is non-nil, compute the up-to-date position
1445 if it isn't already recorded. */)
1446 (Lisp_Object window, Lisp_Object update)
1448 Lisp_Object value;
1449 struct window *w = decode_live_window (window);
1450 Lisp_Object buf;
1451 struct buffer *b;
1453 buf = w->buffer;
1454 CHECK_BUFFER (buf);
1455 b = XBUFFER (buf);
1457 #if 0 /* This change broke some things. We should make it later. */
1458 /* If we don't know the end position, return nil.
1459 The user can compute it with vertical-motion if he wants to.
1460 It would be nicer to do it automatically,
1461 but that's so slow that it would probably bother people. */
1462 if (NILP (w->window_end_valid))
1463 return Qnil;
1464 #endif
1466 if (! NILP (update)
1467 && (windows_or_buffers_changed || NILP (w->window_end_valid))
1468 && !noninteractive)
1470 struct text_pos startp;
1471 struct it it;
1472 struct buffer *old_buffer = NULL;
1473 void *itdata = NULL;
1475 /* Cannot use Fvertical_motion because that function doesn't
1476 cope with variable-height lines. */
1477 if (b != current_buffer)
1479 old_buffer = current_buffer;
1480 set_buffer_internal (b);
1483 /* In case W->start is out of the range, use something
1484 reasonable. This situation occurred when loading a file with
1485 `-l' containing a call to `rmail' with subsequent other
1486 commands. At the end, W->start happened to be BEG, while
1487 rmail had already narrowed the buffer. */
1488 if (XMARKER (w->start)->charpos < BEGV)
1489 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1490 else if (XMARKER (w->start)->charpos > ZV)
1491 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1492 else
1493 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1495 itdata = bidi_shelve_cache ();
1496 start_display (&it, w, startp);
1497 move_it_vertically (&it, window_box_height (w));
1498 if (it.current_y < it.last_visible_y)
1499 move_it_past_eol (&it);
1500 value = make_number (IT_CHARPOS (it));
1501 bidi_unshelve_cache (itdata, 0);
1503 if (old_buffer)
1504 set_buffer_internal (old_buffer);
1506 else
1507 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1509 return value;
1512 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1513 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1514 WINDOW must be a live window and defaults to the selected one.
1515 Return POS. */)
1516 (Lisp_Object window, Lisp_Object pos)
1518 register struct window *w = decode_live_window (window);
1520 CHECK_NUMBER_COERCE_MARKER (pos);
1522 if (w == XWINDOW (selected_window))
1524 if (XBUFFER (w->buffer) == current_buffer)
1525 Fgoto_char (pos);
1526 else
1528 struct buffer *old_buffer = current_buffer;
1530 set_buffer_internal (XBUFFER (w->buffer));
1531 Fgoto_char (pos);
1532 set_buffer_internal (old_buffer);
1535 else
1537 set_marker_restricted (w->pointm, pos, w->buffer);
1538 /* We have to make sure that redisplay updates the window to show
1539 the new value of point. */
1540 ++windows_or_buffers_changed;
1543 return pos;
1546 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1547 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1548 WINDOW must be a live window and defaults to the selected one. Return
1549 POS. Optional third arg NOFORCE non-nil inhibits next redisplay from
1550 overriding motion of point in order to display at this exact start. */)
1551 (Lisp_Object window, Lisp_Object pos, Lisp_Object noforce)
1553 register struct window *w = decode_live_window (window);
1555 CHECK_NUMBER_COERCE_MARKER (pos);
1556 set_marker_restricted (w->start, pos, w->buffer);
1557 /* this is not right, but much easier than doing what is right. */
1558 w->start_at_line_beg = 0;
1559 if (NILP (noforce))
1560 w->force_start = 1;
1561 w->update_mode_line = 1;
1562 w->last_modified = 0;
1563 w->last_overlay_modified = 0;
1564 if (!EQ (window, selected_window))
1565 windows_or_buffers_changed++;
1567 return pos;
1570 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
1571 Spos_visible_in_window_p, 0, 3, 0,
1572 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
1573 WINDOW must be a live window and defaults to the selected one.
1575 Return nil if that position is scrolled vertically out of view. If a
1576 character is only partially visible, nil is returned, unless the
1577 optional argument PARTIALLY is non-nil. If POS is only out of view
1578 because of horizontal scrolling, return non-nil. If POS is t, it
1579 specifies the position of the last visible glyph in WINDOW. POS
1580 defaults to point in WINDOW; WINDOW defaults to the selected window.
1582 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
1583 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
1584 where X and Y are the pixel coordinates relative to the top left corner
1585 of the window. The remaining elements are omitted if the character after
1586 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
1587 off-window at the top and bottom of the row, ROWH is the height of the
1588 display row, and VPOS is the row number (0-based) containing POS. */)
1589 (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
1591 register struct window *w;
1592 register EMACS_INT posint;
1593 register struct buffer *buf;
1594 struct text_pos top;
1595 Lisp_Object in_window = Qnil;
1596 int rtop, rbot, rowh, vpos, fully_p = 1;
1597 int x, y;
1599 w = decode_live_window (window);
1600 buf = XBUFFER (w->buffer);
1601 SET_TEXT_POS_FROM_MARKER (top, w->start);
1603 if (EQ (pos, Qt))
1604 posint = -1;
1605 else if (!NILP (pos))
1607 CHECK_NUMBER_COERCE_MARKER (pos);
1608 posint = XINT (pos);
1610 else if (w == XWINDOW (selected_window))
1611 posint = PT;
1612 else
1613 posint = XMARKER (w->pointm)->charpos;
1615 /* If position is above window start or outside buffer boundaries,
1616 or if window start is out of range, position is not visible. */
1617 if ((EQ (pos, Qt)
1618 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
1619 && CHARPOS (top) >= BUF_BEGV (buf)
1620 && CHARPOS (top) <= BUF_ZV (buf)
1621 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
1622 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
1623 in_window = Qt;
1625 if (!NILP (in_window) && !NILP (partially))
1627 Lisp_Object part = Qnil;
1628 if (!fully_p)
1629 part = list4 (make_number (rtop), make_number (rbot),
1630 make_number (rowh), make_number (vpos));
1631 in_window = Fcons (make_number (x),
1632 Fcons (make_number (y), part));
1635 return in_window;
1638 DEFUN ("window-line-height", Fwindow_line_height,
1639 Swindow_line_height, 0, 2, 0,
1640 doc: /* Return height in pixels of text line LINE in window WINDOW.
1641 WINDOW must be a live window and defaults to the selected one.
1643 Return height of current line if LINE is omitted or nil. Return height of
1644 header or mode line if LINE is `header-line' or `mode-line'.
1645 Otherwise, LINE is a text line number starting from 0. A negative number
1646 counts from the end of the window.
1648 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
1649 in pixels of the visible part of the line, VPOS and YPOS are the
1650 vertical position in lines and pixels of the line, relative to the top
1651 of the first text line, and OFFBOT is the number of off-window pixels at
1652 the bottom of the text line. If there are off-window pixels at the top
1653 of the (first) text line, YPOS is negative.
1655 Return nil if window display is not up-to-date. In that case, use
1656 `pos-visible-in-window-p' to obtain the information. */)
1657 (Lisp_Object line, Lisp_Object window)
1659 register struct window *w;
1660 register struct buffer *b;
1661 struct glyph_row *row, *end_row;
1662 int max_y, crop, i;
1663 EMACS_INT n;
1665 w = decode_live_window (window);
1667 if (noninteractive || w->pseudo_window_p)
1668 return Qnil;
1670 CHECK_BUFFER (w->buffer);
1671 b = XBUFFER (w->buffer);
1673 /* Fail if current matrix is not up-to-date. */
1674 if (NILP (w->window_end_valid)
1675 || current_buffer->clip_changed
1676 || current_buffer->prevent_redisplay_optimizations_p
1677 || w->last_modified < BUF_MODIFF (b)
1678 || w->last_overlay_modified < BUF_OVERLAY_MODIFF (b))
1679 return Qnil;
1681 if (NILP (line))
1683 i = w->cursor.vpos;
1684 if (i < 0 || i >= w->current_matrix->nrows
1685 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
1686 return Qnil;
1687 max_y = window_text_bottom_y (w);
1688 goto found_row;
1691 if (EQ (line, Qheader_line))
1693 if (!WINDOW_WANTS_HEADER_LINE_P (w))
1694 return Qnil;
1695 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
1696 if (!row->enabled_p)
1697 return Qnil;
1698 return list4 (make_number (row->height),
1699 make_number (0), make_number (0),
1700 make_number (0));
1703 if (EQ (line, Qmode_line))
1705 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
1706 if (!row->enabled_p)
1707 return Qnil;
1708 return list4 (make_number (row->height),
1709 make_number (0), /* not accurate */
1710 make_number (WINDOW_HEADER_LINE_HEIGHT (w)
1711 + window_text_bottom_y (w)),
1712 make_number (0));
1715 CHECK_NUMBER (line);
1716 n = XINT (line);
1718 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
1719 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
1720 max_y = window_text_bottom_y (w);
1721 i = 0;
1723 while ((n < 0 || i < n)
1724 && row <= end_row && row->enabled_p
1725 && row->y + row->height < max_y)
1726 row++, i++;
1728 if (row > end_row || !row->enabled_p)
1729 return Qnil;
1731 if (++n < 0)
1733 if (-n > i)
1734 return Qnil;
1735 row += n;
1736 i += n;
1739 found_row:
1740 crop = max (0, (row->y + row->height) - max_y);
1741 return list4 (make_number (row->height + min (0, row->y) - crop),
1742 make_number (i),
1743 make_number (row->y),
1744 make_number (crop));
1747 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1748 0, 1, 0,
1749 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1750 More precisely, return the value assigned by the last call of
1751 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1752 never called with WINDOW as its argument, or the value set by that
1753 function was internally reset since its last call. WINDOW must be a
1754 live window and defaults to the selected one.
1756 When a window is dedicated to its buffer, `display-buffer' will refrain
1757 from displaying another buffer in it. `get-lru-window' and
1758 `get-largest-window' treat dedicated windows specially.
1759 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1760 `kill-buffer' can delete a dedicated window and the containing frame.
1762 Functions like `set-window-buffer' may change the buffer displayed by a
1763 window, unless that window is "strongly" dedicated to its buffer, that
1764 is the value returned by `window-dedicated-p' is t. */)
1765 (Lisp_Object window)
1767 return decode_live_window (window)->dedicated;
1770 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1771 Sset_window_dedicated_p, 2, 2, 0,
1772 doc: /* Mark WINDOW as dedicated according to FLAG.
1773 WINDOW must be a live window and defaults to the selected one. FLAG
1774 non-nil means mark WINDOW as dedicated to its buffer. FLAG nil means
1775 mark WINDOW as non-dedicated. Return FLAG.
1777 When a window is dedicated to its buffer, `display-buffer' will refrain
1778 from displaying another buffer in it. `get-lru-window' and
1779 `get-largest-window' treat dedicated windows specially.
1780 `delete-windows-on', `replace-buffer-in-windows', `quit-window',
1781 `quit-restore-window' and `kill-buffer' can delete a dedicated window
1782 and the containing frame.
1784 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1785 its buffer. Functions like `set-window-buffer' may change the buffer
1786 displayed by a window, unless that window is strongly dedicated to its
1787 buffer. If and when `set-window-buffer' displays another buffer in a
1788 window, it also makes sure that the window is no more dedicated. */)
1789 (Lisp_Object window, Lisp_Object flag)
1791 wset_dedicated (decode_live_window (window), flag);
1792 return flag;
1795 DEFUN ("window-prev-buffers", Fwindow_prev_buffers, Swindow_prev_buffers,
1796 0, 1, 0,
1797 doc: /* Return buffers previously shown in WINDOW.
1798 WINDOW must be a live window and defaults to the selected one.
1800 The return value is a list of elements (BUFFER WINDOW-START POS),
1801 where BUFFER is a buffer, WINDOW-START is the start position of the
1802 window for that buffer, and POS is a window-specific point value. */)
1803 (Lisp_Object window)
1805 return decode_live_window (window)->prev_buffers;
1808 DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers,
1809 Sset_window_prev_buffers, 2, 2, 0,
1810 doc: /* Set WINDOW's previous buffers to PREV-BUFFERS.
1811 WINDOW must be a live window and defaults to the selected one.
1813 PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
1814 where BUFFER is a buffer, WINDOW-START is the start position of the
1815 window for that buffer, and POS is a window-specific point value. */)
1816 (Lisp_Object window, Lisp_Object prev_buffers)
1818 wset_prev_buffers (decode_live_window (window), prev_buffers);
1819 return prev_buffers;
1822 DEFUN ("window-next-buffers", Fwindow_next_buffers, Swindow_next_buffers,
1823 0, 1, 0,
1824 doc: /* Return list of buffers recently re-shown in WINDOW.
1825 WINDOW must be a live window and defaults to the selected one. */)
1826 (Lisp_Object window)
1828 return decode_live_window (window)->next_buffers;
1831 DEFUN ("set-window-next-buffers", Fset_window_next_buffers,
1832 Sset_window_next_buffers, 2, 2, 0,
1833 doc: /* Set WINDOW's next buffers to NEXT-BUFFERS.
1834 WINDOW must be a live window and defaults to the selected one.
1835 NEXT-BUFFERS should be a list of buffers. */)
1836 (Lisp_Object window, Lisp_Object next_buffers)
1838 wset_next_buffers (decode_live_window (window), next_buffers);
1839 return next_buffers;
1842 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1843 0, 1, 0,
1844 doc: /* Return the parameters of WINDOW and their values.
1845 WINDOW must be a valid window and defaults to the selected one. The
1846 return value is a list of elements of the form (PARAMETER . VALUE). */)
1847 (Lisp_Object window)
1849 return Fcopy_alist (decode_valid_window (window)->window_parameters);
1852 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1853 2, 2, 0,
1854 doc: /* Return WINDOW's value for PARAMETER.
1855 WINDOW can be any window and defaults to the selected one. */)
1856 (Lisp_Object window, Lisp_Object parameter)
1858 Lisp_Object result;
1860 result = Fassq (parameter, decode_any_window (window)->window_parameters);
1861 return CDR_SAFE (result);
1864 DEFUN ("set-window-parameter", Fset_window_parameter,
1865 Sset_window_parameter, 3, 3, 0,
1866 doc: /* Set WINDOW's value of PARAMETER to VALUE.
1867 WINDOW can be any window and defaults to the selected one.
1868 Return VALUE. */)
1869 (Lisp_Object window, Lisp_Object parameter, Lisp_Object value)
1871 register struct window *w = decode_any_window (window);
1872 Lisp_Object old_alist_elt;
1874 old_alist_elt = Fassq (parameter, w->window_parameters);
1875 if (NILP (old_alist_elt))
1876 wset_window_parameters
1877 (w, Fcons (Fcons (parameter, value), w->window_parameters));
1878 else
1879 Fsetcdr (old_alist_elt, value);
1880 return value;
1883 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1884 0, 1, 0,
1885 doc: /* Return the display-table that WINDOW is using.
1886 WINDOW must be a live window and defaults to the selected one. */)
1887 (Lisp_Object window)
1889 return decode_live_window (window)->display_table;
1892 /* Get the display table for use on window W. This is either W's
1893 display table or W's buffer's display table. Ignore the specified
1894 tables if they are not valid; if no valid table is specified,
1895 return 0. */
1897 struct Lisp_Char_Table *
1898 window_display_table (struct window *w)
1900 struct Lisp_Char_Table *dp = NULL;
1902 if (DISP_TABLE_P (w->display_table))
1903 dp = XCHAR_TABLE (w->display_table);
1904 else if (BUFFERP (w->buffer))
1906 struct buffer *b = XBUFFER (w->buffer);
1908 if (DISP_TABLE_P (BVAR (b, display_table)))
1909 dp = XCHAR_TABLE (BVAR (b, display_table));
1910 else if (DISP_TABLE_P (Vstandard_display_table))
1911 dp = XCHAR_TABLE (Vstandard_display_table);
1914 return dp;
1917 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1918 doc: /* Set WINDOW's display-table to TABLE.
1919 WINDOW must be a live window and defaults to the selected one. */)
1920 (register Lisp_Object window, Lisp_Object table)
1922 wset_display_table (decode_live_window (window), table);
1923 return table;
1926 /* Record info on buffer window W is displaying
1927 when it is about to cease to display that buffer. */
1928 static void
1929 unshow_buffer (register struct window *w)
1931 Lisp_Object buf;
1932 struct buffer *b;
1934 buf = w->buffer;
1935 b = XBUFFER (buf);
1936 if (b != XMARKER (w->pointm)->buffer)
1937 emacs_abort ();
1939 #if 0
1940 if (w == XWINDOW (selected_window)
1941 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1942 /* Do this except when the selected window's buffer
1943 is being removed from some other window. */
1944 #endif
1945 /* last_window_start records the start position that this buffer
1946 had in the last window to be disconnected from it.
1947 Now that this statement is unconditional,
1948 it is possible for the buffer to be displayed in the
1949 selected window, while last_window_start reflects another
1950 window which was recently showing the same buffer.
1951 Some people might say that might be a good thing. Let's see. */
1952 b->last_window_start = marker_position (w->start);
1954 /* Point in the selected window's buffer
1955 is actually stored in that buffer, and the window's pointm isn't used.
1956 So don't clobber point in that buffer. */
1957 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1958 /* Don't clobber point in current buffer either (this could be
1959 useful in connection with bug#12208).
1960 && XBUFFER (buf) != current_buffer */
1961 /* This line helps to fix Horsley's testbug.el bug. */
1962 && !(WINDOWP (BVAR (b, last_selected_window))
1963 && w != XWINDOW (BVAR (b, last_selected_window))
1964 && EQ (buf, XWINDOW (BVAR (b, last_selected_window))->buffer)))
1965 temp_set_point_both (b,
1966 clip_to_bounds (BUF_BEGV (b),
1967 XMARKER (w->pointm)->charpos,
1968 BUF_ZV (b)),
1969 clip_to_bounds (BUF_BEGV_BYTE (b),
1970 marker_byte_position (w->pointm),
1971 BUF_ZV_BYTE (b)));
1973 if (WINDOWP (BVAR (b, last_selected_window))
1974 && w == XWINDOW (BVAR (b, last_selected_window)))
1975 bset_last_selected_window (b, Qnil);
1978 /* Put NEW into the window structure in place of OLD. SETFLAG zero
1979 means change window structure only. Otherwise store geometry and
1980 other settings as well. */
1981 static void
1982 replace_window (Lisp_Object old, Lisp_Object new, int setflag)
1984 register Lisp_Object tem;
1985 register struct window *o = XWINDOW (old), *n = XWINDOW (new);
1987 /* If OLD is its frame's root window, then NEW is the new
1988 root window for that frame. */
1989 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1990 fset_root_window (XFRAME (o->frame), new);
1992 if (setflag)
1994 wset_left_col (n, o->left_col);
1995 wset_top_line (n, o->top_line);
1996 wset_total_cols (n, o->total_cols);
1997 wset_total_lines (n, o->total_lines);
1998 wset_normal_cols (n, o->normal_cols);
1999 wset_normal_cols (o, make_float (1.0));
2000 wset_normal_lines (n, o->normal_lines);
2001 wset_normal_lines (o, make_float (1.0));
2002 n->desired_matrix = n->current_matrix = 0;
2003 n->vscroll = 0;
2004 memset (&n->cursor, 0, sizeof (n->cursor));
2005 memset (&n->last_cursor, 0, sizeof (n->last_cursor));
2006 memset (&n->phys_cursor, 0, sizeof (n->phys_cursor));
2007 n->phys_cursor_type = -1;
2008 n->phys_cursor_width = -1;
2009 n->must_be_updated_p = 0;
2010 n->pseudo_window_p = 0;
2011 wset_window_end_vpos (n, make_number (0));
2012 wset_window_end_pos (n, make_number (0));
2013 wset_window_end_valid (n, Qnil);
2014 n->frozen_window_start_p = 0;
2017 tem = o->next;
2018 wset_next (n, tem);
2019 if (!NILP (tem))
2020 wset_prev (XWINDOW (tem), new);
2022 tem = o->prev;
2023 wset_prev (n, tem);
2024 if (!NILP (tem))
2025 wset_next (XWINDOW (tem), new);
2027 tem = o->parent;
2028 wset_parent (n, tem);
2029 if (!NILP (tem))
2031 if (EQ (XWINDOW (tem)->vchild, old))
2032 wset_vchild (XWINDOW (tem), new);
2033 if (EQ (XWINDOW (tem)->hchild, old))
2034 wset_hchild (XWINDOW (tem), new);
2038 /* If window WINDOW and its parent window are iso-combined, merge
2039 WINDOW's children into those of its parent window and mark WINDOW as
2040 deleted. */
2042 static void
2043 recombine_windows (Lisp_Object window)
2045 struct window *w, *p, *c;
2046 Lisp_Object parent, child;
2047 int horflag;
2049 w = XWINDOW (window);
2050 parent = w->parent;
2051 if (!NILP (parent) && NILP (w->combination_limit))
2053 p = XWINDOW (parent);
2054 if (((!NILP (p->vchild) && !NILP (w->vchild))
2055 || (!NILP (p->hchild) && !NILP (w->hchild))))
2056 /* WINDOW and PARENT are both either a vertical or a horizontal
2057 combination. */
2059 horflag = NILP (w->vchild);
2060 child = horflag ? w->hchild : w->vchild;
2061 c = XWINDOW (child);
2063 /* Splice WINDOW's children into its parent's children and
2064 assign new normal sizes. */
2065 if (NILP (w->prev))
2066 if (horflag)
2067 wset_hchild (p, child);
2068 else
2069 wset_vchild (p, child);
2070 else
2072 wset_prev (c, w->prev);
2073 wset_next (XWINDOW (w->prev), child);
2076 while (c)
2078 wset_parent (c, parent);
2080 if (horflag)
2081 wset_normal_cols (c,
2082 make_float (XFLOATINT (c->total_cols)
2083 / XFLOATINT (p->total_cols)));
2084 else
2085 wset_normal_lines (c,
2086 make_float (XFLOATINT (c->total_lines)
2087 / XFLOATINT (p->total_lines)));
2089 if (NILP (c->next))
2091 if (!NILP (w->next))
2093 wset_next (c, w->next);
2094 wset_prev (XWINDOW (c->next), child);
2097 c = 0;
2099 else
2101 child = c->next;
2102 c = XWINDOW (child);
2106 /* WINDOW can be deleted now. */
2107 wset_vchild (w, Qnil);
2108 wset_hchild (w, Qnil);
2113 /* If WINDOW can be deleted, delete it. */
2114 static void
2115 delete_deletable_window (Lisp_Object window)
2117 if (!NILP (call1 (Qwindow_deletable_p, window)))
2118 call1 (Qdelete_window, window);
2121 /***********************************************************************
2122 Window List
2123 ***********************************************************************/
2125 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
2126 pointer. This is a callback function for foreach_window, used in
2127 the window_list function. */
2129 static int
2130 add_window_to_list (struct window *w, void *user_data)
2132 Lisp_Object *list = (Lisp_Object *) user_data;
2133 Lisp_Object window;
2134 XSETWINDOW (window, w);
2135 *list = Fcons (window, *list);
2136 return 1;
2140 /* Return a list of all windows, for use by next_window. If
2141 Vwindow_list is a list, return that list. Otherwise, build a new
2142 list, cache it in Vwindow_list, and return that. */
2144 static Lisp_Object
2145 window_list (void)
2147 if (!CONSP (Vwindow_list))
2149 Lisp_Object tail;
2151 Vwindow_list = Qnil;
2152 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
2154 Lisp_Object args[2];
2156 /* We are visiting windows in canonical order, and add
2157 new windows at the front of args[1], which means we
2158 have to reverse this list at the end. */
2159 args[1] = Qnil;
2160 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
2161 args[0] = Vwindow_list;
2162 args[1] = Fnreverse (args[1]);
2163 Vwindow_list = Fnconc (2, args);
2167 return Vwindow_list;
2171 /* Value is non-zero if WINDOW satisfies the constraints given by
2172 OWINDOW, MINIBUF and ALL_FRAMES.
2174 MINIBUF t means WINDOW may be minibuffer windows.
2175 `lambda' means WINDOW may not be a minibuffer window.
2176 a window means a specific minibuffer window
2178 ALL_FRAMES t means search all frames,
2179 nil means search just current frame,
2180 `visible' means search just visible frames on the
2181 current terminal,
2182 0 means search visible and iconified frames on the
2183 current terminal,
2184 a window means search the frame that window belongs to,
2185 a frame means consider windows on that frame, only. */
2187 static int
2188 candidate_window_p (Lisp_Object window, Lisp_Object owindow, Lisp_Object minibuf, Lisp_Object all_frames)
2190 struct window *w = XWINDOW (window);
2191 struct frame *f = XFRAME (w->frame);
2192 int candidate_p = 1;
2194 if (!BUFFERP (w->buffer))
2195 candidate_p = 0;
2196 else if (MINI_WINDOW_P (w)
2197 && (EQ (minibuf, Qlambda)
2198 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
2200 /* If MINIBUF is `lambda' don't consider any mini-windows.
2201 If it is a window, consider only that one. */
2202 candidate_p = 0;
2204 else if (EQ (all_frames, Qt))
2205 candidate_p = 1;
2206 else if (NILP (all_frames))
2208 eassert (WINDOWP (owindow));
2209 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
2211 else if (EQ (all_frames, Qvisible))
2213 FRAME_SAMPLE_VISIBILITY (f);
2214 candidate_p = FRAME_VISIBLE_P (f)
2215 && (FRAME_TERMINAL (XFRAME (w->frame))
2216 == FRAME_TERMINAL (XFRAME (selected_frame)));
2219 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
2221 FRAME_SAMPLE_VISIBILITY (f);
2222 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
2223 #ifdef HAVE_X_WINDOWS
2224 /* Yuck!! If we've just created the frame and the
2225 window-manager requested the user to place it
2226 manually, the window may still not be considered
2227 `visible'. I'd argue it should be at least
2228 something like `iconified', but don't know how to do
2229 that yet. --Stef */
2230 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
2231 && !f->output_data.x->has_been_visible)
2232 #endif
2234 && (FRAME_TERMINAL (XFRAME (w->frame))
2235 == FRAME_TERMINAL (XFRAME (selected_frame)));
2237 else if (WINDOWP (all_frames))
2238 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
2239 || EQ (XWINDOW (all_frames)->frame, w->frame)
2240 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
2241 else if (FRAMEP (all_frames))
2242 candidate_p = EQ (all_frames, w->frame);
2244 return candidate_p;
2248 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
2249 Fwindow_list. See candidate_window_p for the meaning of WINDOW,
2250 MINIBUF, and ALL_FRAMES. */
2252 static void
2253 decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object *all_frames)
2255 if (NILP (*window))
2256 *window = selected_window;
2257 else
2258 CHECK_LIVE_WINDOW (*window);
2260 /* MINIBUF nil may or may not include minibuffers. Decide if it
2261 does. */
2262 if (NILP (*minibuf))
2263 *minibuf = minibuf_level ? minibuf_window : Qlambda;
2264 else if (!EQ (*minibuf, Qt))
2265 *minibuf = Qlambda;
2267 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
2268 => count none of them, or a specific minibuffer window (the
2269 active one) to count. */
2271 /* ALL_FRAMES nil doesn't specify which frames to include. */
2272 if (NILP (*all_frames))
2273 *all_frames
2274 = (!EQ (*minibuf, Qlambda)
2275 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
2276 : Qnil);
2277 else if (EQ (*all_frames, Qvisible))
2279 else if (EQ (*all_frames, make_number (0)))
2281 else if (FRAMEP (*all_frames))
2283 else if (!EQ (*all_frames, Qt))
2284 *all_frames = Qnil;
2288 /* Return the next or previous window of WINDOW in cyclic ordering
2289 of windows. NEXT_P non-zero means return the next window. See the
2290 documentation string of next-window for the meaning of MINIBUF and
2291 ALL_FRAMES. */
2293 static Lisp_Object
2294 next_window (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames, int next_p)
2296 decode_next_window_args (&window, &minibuf, &all_frames);
2298 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
2299 return the first window on the frame. */
2300 if (FRAMEP (all_frames)
2301 && !EQ (all_frames, XWINDOW (window)->frame))
2302 return Fframe_first_window (all_frames);
2304 if (next_p)
2306 Lisp_Object list;
2308 /* Find WINDOW in the list of all windows. */
2309 list = Fmemq (window, window_list ());
2311 /* Scan forward from WINDOW to the end of the window list. */
2312 if (CONSP (list))
2313 for (list = XCDR (list); CONSP (list); list = XCDR (list))
2314 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2315 break;
2317 /* Scan from the start of the window list up to WINDOW. */
2318 if (!CONSP (list))
2319 for (list = Vwindow_list;
2320 CONSP (list) && !EQ (XCAR (list), window);
2321 list = XCDR (list))
2322 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2323 break;
2325 if (CONSP (list))
2326 window = XCAR (list);
2328 else
2330 Lisp_Object candidate, list;
2332 /* Scan through the list of windows for candidates. If there are
2333 candidate windows in front of WINDOW, the last one of these
2334 is the one we want. If there are candidates following WINDOW
2335 in the list, again the last one of these is the one we want. */
2336 candidate = Qnil;
2337 for (list = window_list (); CONSP (list); list = XCDR (list))
2339 if (EQ (XCAR (list), window))
2341 if (WINDOWP (candidate))
2342 break;
2344 else if (candidate_window_p (XCAR (list), window, minibuf,
2345 all_frames))
2346 candidate = XCAR (list);
2349 if (WINDOWP (candidate))
2350 window = candidate;
2353 return window;
2357 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
2358 doc: /* Return live window after WINDOW in the cyclic ordering of windows.
2359 WINDOW must be a live window and defaults to the selected one. The
2360 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2361 consider.
2363 MINIBUF nil or omitted means consider the minibuffer window only if the
2364 minibuffer is active. MINIBUF t means consider the minibuffer window
2365 even if the minibuffer is not active. Any other value means do not
2366 consider the minibuffer window even if the minibuffer is active.
2368 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2369 plus the minibuffer window if specified by the MINIBUF argument. If the
2370 minibuffer counts, consider all windows on all frames that share that
2371 minibuffer too. The following non-nil values of ALL-FRAMES have special
2372 meanings:
2374 - t means consider all windows on all existing frames.
2376 - `visible' means consider all windows on all visible frames.
2378 - 0 (the number zero) means consider all windows on all visible and
2379 iconified frames.
2381 - A frame means consider all windows on that frame only.
2383 Anything else means consider all windows on WINDOW's frame and no
2384 others.
2386 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2387 `next-window' to iterate through the entire cycle of acceptable
2388 windows, eventually ending up back at the window you started with.
2389 `previous-window' traverses the same cycle, in the reverse order. */)
2390 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2392 return next_window (window, minibuf, all_frames, 1);
2396 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
2397 doc: /* Return live window before WINDOW in the cyclic ordering of windows.
2398 WINDOW must be a live window and defaults to the selected one. The
2399 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2400 consider.
2402 MINIBUF nil or omitted means consider the minibuffer window only if the
2403 minibuffer is active. MINIBUF t means consider the minibuffer window
2404 even if the minibuffer is not active. Any other value means do not
2405 consider the minibuffer window even if the minibuffer is active.
2407 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2408 plus the minibuffer window if specified by the MINIBUF argument. If the
2409 minibuffer counts, consider all windows on all frames that share that
2410 minibuffer too. The following non-nil values of ALL-FRAMES have special
2411 meanings:
2413 - t means consider all windows on all existing frames.
2415 - `visible' means consider all windows on all visible frames.
2417 - 0 (the number zero) means consider all windows on all visible and
2418 iconified frames.
2420 - A frame means consider all windows on that frame only.
2422 Anything else means consider all windows on WINDOW's frame and no
2423 others.
2425 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2426 use `previous-window' to iterate through the entire cycle of
2427 acceptable windows, eventually ending up back at the window you
2428 started with. `next-window' traverses the same cycle, in the
2429 reverse order. */)
2430 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2432 return next_window (window, minibuf, all_frames, 0);
2436 /* Return a list of windows in cyclic ordering. Arguments are like
2437 for `next-window'. */
2439 static Lisp_Object
2440 window_list_1 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2442 Lisp_Object tail, list, rest;
2444 decode_next_window_args (&window, &minibuf, &all_frames);
2445 list = Qnil;
2447 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2448 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2449 list = Fcons (XCAR (tail), list);
2451 /* Rotate the list to start with WINDOW. */
2452 list = Fnreverse (list);
2453 rest = Fmemq (window, list);
2454 if (!NILP (rest) && !EQ (rest, list))
2456 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2458 XSETCDR (tail, Qnil);
2459 list = nconc2 (rest, list);
2461 return list;
2465 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2466 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2467 FRAME nil or omitted means use the selected frame.
2468 WINDOW nil or omitted means use the window selected within FRAME.
2469 MINIBUF t means include the minibuffer window, even if it isn't active.
2470 MINIBUF nil or omitted means include the minibuffer window only
2471 if it's active.
2472 MINIBUF neither nil nor t means never include the minibuffer window. */)
2473 (Lisp_Object frame, Lisp_Object minibuf, Lisp_Object window)
2475 if (NILP (window))
2476 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2477 CHECK_WINDOW (window);
2478 if (NILP (frame))
2479 frame = selected_frame;
2481 if (!EQ (frame, XWINDOW (window)->frame))
2482 error ("Window is on a different frame");
2484 return window_list_1 (window, minibuf, frame);
2488 DEFUN ("window-list-1", Fwindow_list_1, Swindow_list_1, 0, 3, 0,
2489 doc: /* Return a list of all live windows.
2490 WINDOW specifies the first window to list and defaults to the selected
2491 window.
2493 Optional argument MINIBUF nil or omitted means consider the minibuffer
2494 window only if the minibuffer is active. MINIBUF t means consider the
2495 minibuffer window even if the minibuffer is not active. Any other value
2496 means do not consider the minibuffer window even if the minibuffer is
2497 active.
2499 Optional argument ALL-FRAMES nil or omitted means consider all windows
2500 on WINDOW's frame, plus the minibuffer window if specified by the
2501 MINIBUF argument. If the minibuffer counts, consider all windows on all
2502 frames that share that minibuffer too. The following non-nil values of
2503 ALL-FRAMES have special meanings:
2505 - t means consider all windows on all existing frames.
2507 - `visible' means consider all windows on all visible frames.
2509 - 0 (the number zero) means consider all windows on all visible and
2510 iconified frames.
2512 - A frame means consider all windows on that frame only.
2514 Anything else means consider all windows on WINDOW's frame and no
2515 others.
2517 If WINDOW is not on the list of windows returned, some other window will
2518 be listed first but no error is signaled. */)
2519 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2521 return window_list_1 (window, minibuf, all_frames);
2524 /* Look at all windows, performing an operation specified by TYPE
2525 with argument OBJ.
2526 If FRAMES is Qt, look at all frames;
2527 Qnil, look at just the selected frame;
2528 Qvisible, look at visible frames;
2529 a frame, just look at windows on that frame.
2530 If MINI is non-zero, perform the operation on minibuffer windows too. */
2532 enum window_loop
2534 WINDOW_LOOP_UNUSED,
2535 GET_BUFFER_WINDOW, /* Arg is buffer */
2536 REPLACE_BUFFER_IN_WINDOWS_SAFELY, /* Arg is buffer */
2537 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2538 CHECK_ALL_WINDOWS
2541 static Lisp_Object
2542 window_loop (enum window_loop type, Lisp_Object obj, int mini, Lisp_Object frames)
2544 Lisp_Object window, windows, best_window, frame_arg;
2545 int frame_best_window_flag = 0;
2546 struct frame *f;
2547 struct gcpro gcpro1;
2549 /* If we're only looping through windows on a particular frame,
2550 frame points to that frame. If we're looping through windows
2551 on all frames, frame is 0. */
2552 if (FRAMEP (frames))
2553 f = XFRAME (frames);
2554 else if (NILP (frames))
2555 f = SELECTED_FRAME ();
2556 else
2557 f = NULL;
2559 if (f)
2560 frame_arg = Qlambda;
2561 else if (EQ (frames, make_number (0)))
2562 frame_arg = frames;
2563 else if (EQ (frames, Qvisible))
2564 frame_arg = frames;
2565 else
2566 frame_arg = Qt;
2568 /* frame_arg is Qlambda to stick to one frame,
2569 Qvisible to consider all visible frames,
2570 or Qt otherwise. */
2572 /* Pick a window to start with. */
2573 if (WINDOWP (obj))
2574 window = obj;
2575 else if (f)
2576 window = FRAME_SELECTED_WINDOW (f);
2577 else
2578 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2580 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2581 GCPRO1 (windows);
2582 best_window = Qnil;
2584 for (; CONSP (windows); windows = XCDR (windows))
2586 struct window *w;
2588 window = XCAR (windows);
2589 w = XWINDOW (window);
2591 /* Note that we do not pay attention here to whether the frame
2592 is visible, since Fwindow_list skips non-visible frames if
2593 that is desired, under the control of frame_arg. */
2594 if (!MINI_WINDOW_P (w)
2595 /* For REPLACE_BUFFER_IN_WINDOWS_SAFELY, we must always
2596 consider all windows. */
2597 || type == REPLACE_BUFFER_IN_WINDOWS_SAFELY
2598 || (mini && minibuf_level > 0))
2599 switch (type)
2601 case GET_BUFFER_WINDOW:
2602 if (EQ (w->buffer, obj)
2603 /* Don't find any minibuffer window except the one that
2604 is currently in use. */
2605 && (MINI_WINDOW_P (w) ? EQ (window, minibuf_window) : 1))
2607 if (EQ (window, selected_window))
2608 /* Preferably return the selected window. */
2609 RETURN_UNGCPRO (window);
2610 else if (EQ (XWINDOW (window)->frame, selected_frame)
2611 && !frame_best_window_flag)
2612 /* Prefer windows on the current frame (but don't
2613 choose another one if we have one already). */
2615 best_window = window;
2616 frame_best_window_flag = 1;
2618 else if (NILP (best_window))
2619 best_window = window;
2621 break;
2623 case REPLACE_BUFFER_IN_WINDOWS_SAFELY:
2624 /* We could simply check whether the buffer shown by window
2625 is live, and show another buffer in case it isn't. */
2626 if (EQ (w->buffer, obj))
2628 /* Undedicate WINDOW. */
2629 wset_dedicated (w, Qnil);
2630 /* Make WINDOW show the buffer returned by
2631 other_buffer_safely, don't run any hooks. */
2632 set_window_buffer
2633 (window, other_buffer_safely (w->buffer), 0, 0);
2634 /* If WINDOW is the selected window, make its buffer
2635 current. But do so only if the window shows the
2636 current buffer (Bug#6454). */
2637 if (EQ (window, selected_window)
2638 && XBUFFER (w->buffer) == current_buffer)
2639 Fset_buffer (w->buffer);
2641 break;
2643 case REDISPLAY_BUFFER_WINDOWS:
2644 if (EQ (w->buffer, obj))
2646 mark_window_display_accurate (window, 0);
2647 w->update_mode_line = 1;
2648 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2649 ++update_mode_lines;
2650 best_window = window;
2652 break;
2654 /* Check for a window that has a killed buffer. */
2655 case CHECK_ALL_WINDOWS:
2656 if (! NILP (w->buffer)
2657 && !BUFFER_LIVE_P (XBUFFER (w->buffer)))
2658 emacs_abort ();
2659 break;
2661 case WINDOW_LOOP_UNUSED:
2662 break;
2666 UNGCPRO;
2667 return best_window;
2670 /* Used for debugging. Abort if any window has a dead buffer. */
2672 extern void check_all_windows (void) EXTERNALLY_VISIBLE;
2673 void
2674 check_all_windows (void)
2676 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2679 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 0, 2, 0,
2680 doc: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2681 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
2682 the current buffer.
2684 The optional argument ALL-FRAMES specifies the frames to consider:
2686 - t means consider all windows on all existing frames.
2688 - `visible' means consider all windows on all visible frames.
2690 - 0 (the number zero) means consider all windows on all visible
2691 and iconified frames.
2693 - A frame means consider all windows on that frame only.
2695 Any other value of ALL-FRAMES means consider all windows on the
2696 selected frame and no others. */)
2697 (Lisp_Object buffer_or_name, Lisp_Object all_frames)
2699 Lisp_Object buffer;
2701 if (NILP (buffer_or_name))
2702 buffer = Fcurrent_buffer ();
2703 else
2704 buffer = Fget_buffer (buffer_or_name);
2706 if (BUFFERP (buffer))
2707 return window_loop (GET_BUFFER_WINDOW, buffer, 1, all_frames);
2708 else
2709 return Qnil;
2712 static Lisp_Object
2713 resize_root_window (Lisp_Object window, Lisp_Object delta, Lisp_Object horizontal, Lisp_Object ignore)
2715 return call4 (Qwindow_resize_root_window, window, delta, horizontal, ignore);
2719 DEFUN ("delete-other-windows-internal", Fdelete_other_windows_internal,
2720 Sdelete_other_windows_internal, 0, 2, "",
2721 doc: /* Make WINDOW fill its frame.
2722 Only the frame WINDOW is on is affected. WINDOW must be a valid window
2723 and defaults to the selected one.
2725 Optional argument ROOT, if non-nil, must specify an internal window such
2726 that WINDOW is in its window subtree. If this is the case, replace ROOT
2727 by WINDOW and leave alone any windows not part of ROOT's subtree.
2729 When WINDOW is live try to reduce display jumps by keeping the text
2730 previously visible in WINDOW in the same place on the frame. Doing this
2731 depends on the value of (window-start WINDOW), so if calling this
2732 function in a program gives strange scrolling, make sure the
2733 window-start value is reasonable when this function is called. */)
2734 (Lisp_Object window, Lisp_Object root)
2736 struct window *w, *r, *s;
2737 struct frame *f;
2738 Lisp_Object sibling, pwindow, swindow IF_LINT (= Qnil), delta;
2739 ptrdiff_t startpos IF_LINT (= 0);
2740 int top IF_LINT (= 0), new_top, resize_failed;
2742 w = decode_valid_window (window);
2743 XSETWINDOW (window, w);
2744 f = XFRAME (w->frame);
2746 if (NILP (root))
2747 /* ROOT is the frame's root window. */
2749 root = FRAME_ROOT_WINDOW (f);
2750 r = XWINDOW (root);
2752 else
2753 /* ROOT must be an ancestor of WINDOW. */
2755 r = decode_valid_window (root);
2756 pwindow = XWINDOW (window)->parent;
2757 while (!NILP (pwindow))
2758 if (EQ (pwindow, root))
2759 break;
2760 else
2761 pwindow = XWINDOW (pwindow)->parent;
2762 if (!EQ (pwindow, root))
2763 error ("Specified root is not an ancestor of specified window");
2766 if (EQ (window, root))
2767 /* A noop. */
2768 return Qnil;
2769 /* I don't understand the "top > 0" part below. If we deal with a
2770 standalone minibuffer it would have been caught by the preceding
2771 test. */
2772 else if (MINI_WINDOW_P (w)) /* && top > 0) */
2773 error ("Can't expand minibuffer to full frame");
2775 if (!NILP (w->buffer))
2777 startpos = marker_position (w->start);
2778 top = WINDOW_TOP_EDGE_LINE (w)
2779 - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2780 /* Make sure WINDOW is the frame's selected window. */
2781 if (!EQ (window, FRAME_SELECTED_WINDOW (f)))
2783 if (EQ (selected_frame, w->frame))
2784 Fselect_window (window, Qnil);
2785 else
2786 fset_selected_window (f, window);
2789 else
2791 /* See if the frame's selected window is a part of the window
2792 subtree rooted at WINDOW, by finding all the selected window's
2793 parents and comparing each one with WINDOW. If it isn't we
2794 need a new selected window for this frame. */
2795 swindow = FRAME_SELECTED_WINDOW (f);
2796 while (1)
2798 pwindow = swindow;
2799 while (!NILP (pwindow) && !EQ (window, pwindow))
2800 pwindow = XWINDOW (pwindow)->parent;
2802 if (EQ (window, pwindow))
2803 /* If WINDOW is an ancestor of SWINDOW, then SWINDOW is ok
2804 as the new selected window. */
2805 break;
2806 else
2807 /* Else try the previous window of SWINDOW. */
2808 swindow = Fprevious_window (swindow, Qlambda, Qnil);
2811 if (!EQ (swindow, FRAME_SELECTED_WINDOW (f)))
2813 if (EQ (selected_frame, w->frame))
2814 Fselect_window (swindow, Qnil);
2815 else
2816 fset_selected_window (f, swindow);
2820 block_input ();
2821 if (!FRAME_INITIAL_P (f))
2823 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
2825 /* We are going to free the glyph matrices of WINDOW, and with
2826 that we might lose any information about glyph rows that have
2827 some of their glyphs highlighted in mouse face. (These rows
2828 are marked with a non-zero mouse_face_p flag.) If WINDOW
2829 indeed has some glyphs highlighted in mouse face, signal to
2830 frame's up-to-date hook that mouse highlight was overwritten,
2831 so that it will arrange for redisplaying the highlight. */
2832 if (EQ (hlinfo->mouse_face_window, window))
2834 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
2835 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
2836 hlinfo->mouse_face_window = Qnil;
2839 free_window_matrices (r);
2841 windows_or_buffers_changed++;
2842 Vwindow_list = Qnil;
2843 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
2844 resize_failed = 0;
2846 if (NILP (w->buffer))
2848 /* Resize child windows vertically. */
2849 XSETINT (delta, XINT (r->total_lines)
2850 - XINT (w->total_lines));
2851 wset_top_line (w, r->top_line);
2852 resize_root_window (window, delta, Qnil, Qnil);
2853 if (window_resize_check (w, 0))
2854 window_resize_apply (w, 0);
2855 else
2857 resize_root_window (window, delta, Qnil, Qt);
2858 if (window_resize_check (w, 0))
2859 window_resize_apply (w, 0);
2860 else
2861 resize_failed = 1;
2864 /* Resize child windows horizontally. */
2865 if (!resize_failed)
2867 wset_left_col (w, r->left_col);
2868 XSETINT (delta,
2869 XINT (r->total_cols) - XINT (w->total_cols));
2870 wset_left_col (w, r->left_col);
2871 resize_root_window (window, delta, Qt, Qnil);
2872 if (window_resize_check (w, 1))
2873 window_resize_apply (w, 1);
2874 else
2876 resize_root_window (window, delta, Qt, Qt);
2877 if (window_resize_check (w, 1))
2878 window_resize_apply (w, 1);
2879 else
2880 resize_failed = 1;
2884 if (resize_failed)
2885 /* Play safe, if we still can ... */
2887 window = swindow;
2888 w = XWINDOW (window);
2892 /* Cleanly unlink WINDOW from window-tree. */
2893 if (!NILP (w->prev))
2894 /* Get SIBLING above (on the left of) WINDOW. */
2896 sibling = w->prev;
2897 s = XWINDOW (sibling);
2898 wset_next (s, w->next);
2899 if (!NILP (s->next))
2900 wset_prev (XWINDOW (s->next), sibling);
2902 else
2903 /* Get SIBLING below (on the right of) WINDOW. */
2905 sibling = w->next;
2906 s = XWINDOW (sibling);
2907 wset_prev (s, Qnil);
2908 if (!NILP (XWINDOW (w->parent)->vchild))
2909 wset_vchild (XWINDOW (w->parent), sibling);
2910 else
2911 wset_hchild (XWINDOW (w->parent), sibling);
2914 /* Delete ROOT and all child windows of ROOT. */
2915 if (!NILP (r->vchild))
2917 delete_all_child_windows (r->vchild);
2918 wset_vchild (r, Qnil);
2920 else if (!NILP (r->hchild))
2922 delete_all_child_windows (r->hchild);
2923 wset_hchild (r, Qnil);
2926 replace_window (root, window, 1);
2928 /* This must become SWINDOW anyway ....... */
2929 if (!NILP (w->buffer) && !resize_failed)
2931 /* Try to minimize scrolling, by setting the window start to the
2932 point will cause the text at the old window start to be at the
2933 same place on the frame. But don't try to do this if the
2934 window start is outside the visible portion (as might happen
2935 when the display is not current, due to typeahead). */
2936 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2937 if (new_top != top
2938 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2939 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2941 struct position pos;
2942 struct buffer *obuf = current_buffer;
2944 Fset_buffer (w->buffer);
2945 /* This computation used to temporarily move point, but that
2946 can have unwanted side effects due to text properties. */
2947 pos = *vmotion (startpos, -top, w);
2949 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2950 wset_window_end_valid (w, Qnil);
2951 w->start_at_line_beg = (pos.bytepos == BEGV_BYTE
2952 || FETCH_BYTE (pos.bytepos - 1) == '\n');
2953 /* We need to do this, so that the window-scroll-functions
2954 get called. */
2955 w->optional_new_start = 1;
2957 set_buffer_internal (obuf);
2961 adjust_glyphs (f);
2962 unblock_input ();
2964 run_window_configuration_change_hook (f);
2966 return Qnil;
2970 void
2971 replace_buffer_in_windows (Lisp_Object buffer)
2973 call1 (Qreplace_buffer_in_windows, buffer);
2977 /* Safely replace BUFFER with some other buffer in all windows of all
2978 frames, even those on other keyboards. */
2980 void
2981 replace_buffer_in_windows_safely (Lisp_Object buffer)
2983 Lisp_Object tail, frame;
2985 /* A single call to window_loop won't do the job because it only
2986 considers frames on the current keyboard. So loop manually over
2987 frames, and handle each one. */
2988 FOR_EACH_FRAME (tail, frame)
2989 window_loop (REPLACE_BUFFER_IN_WINDOWS_SAFELY, buffer, 1, frame);
2992 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2993 minimum allowable size. */
2995 void
2996 check_frame_size (FRAME_PTR frame, int *rows, int *cols)
2998 /* For height, we have to see:
2999 how many windows the frame has at minimum (one or two),
3000 and whether it has a menu bar or other special stuff at the top. */
3001 int min_height
3002 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
3003 ? MIN_SAFE_WINDOW_HEIGHT
3004 : 2 * MIN_SAFE_WINDOW_HEIGHT);
3006 if (FRAME_TOP_MARGIN (frame) > 0)
3007 min_height += FRAME_TOP_MARGIN (frame);
3009 if (*rows < min_height)
3010 *rows = min_height;
3011 if (*cols < MIN_SAFE_WINDOW_WIDTH)
3012 *cols = MIN_SAFE_WINDOW_WIDTH;
3015 /* Adjust the margins of window W if text area is too small.
3016 Return 1 if window width is ok after adjustment; 0 if window
3017 is still too narrow. */
3019 static int
3020 adjust_window_margins (struct window *w)
3022 int box_cols = (WINDOW_TOTAL_COLS (w)
3023 - WINDOW_FRINGE_COLS (w)
3024 - WINDOW_SCROLL_BAR_COLS (w));
3025 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
3026 + WINDOW_RIGHT_MARGIN_COLS (w));
3028 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
3029 return 1;
3031 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
3032 return 0;
3034 /* Window's text area is too narrow, but reducing the window
3035 margins will fix that. */
3036 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
3037 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
3039 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
3041 wset_left_margin_cols (w, make_number (margin_cols / 2));
3042 wset_right_margin_cols (w, make_number (margin_cols / 2));
3044 else
3045 wset_right_margin_cols (w, make_number (margin_cols));
3047 else
3048 wset_left_margin_cols (w, make_number (margin_cols));
3049 return 1;
3052 /* The following three routines are needed for running a window's
3053 configuration change hook. */
3054 static void
3055 run_funs (Lisp_Object funs)
3057 for (; CONSP (funs); funs = XCDR (funs))
3058 if (!EQ (XCAR (funs), Qt))
3059 call0 (XCAR (funs));
3062 static Lisp_Object
3063 select_window_norecord (Lisp_Object window)
3065 return WINDOW_LIVE_P (window)
3066 ? Fselect_window (window, Qt) : selected_window;
3069 static Lisp_Object
3070 select_frame_norecord (Lisp_Object frame)
3072 return FRAME_LIVE_P (XFRAME (frame))
3073 ? Fselect_frame (frame, Qt) : selected_frame;
3076 void
3077 run_window_configuration_change_hook (struct frame *f)
3079 ptrdiff_t count = SPECPDL_INDEX ();
3080 Lisp_Object frame, global_wcch
3081 = Fdefault_value (Qwindow_configuration_change_hook);
3082 XSETFRAME (frame, f);
3084 if (NILP (Vrun_hooks) || !NILP (inhibit_lisp_code))
3085 return;
3087 /* Use the right buffer. Matters when running the local hooks. */
3088 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3090 record_unwind_current_buffer ();
3091 Fset_buffer (Fwindow_buffer (Qnil));
3094 if (SELECTED_FRAME () != f)
3096 record_unwind_protect (select_frame_norecord, Fselected_frame ());
3097 select_frame_norecord (frame);
3100 /* Look for buffer-local values. */
3102 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3103 for (; CONSP (windows); windows = XCDR (windows))
3105 Lisp_Object window = XCAR (windows);
3106 Lisp_Object buffer = Fwindow_buffer (window);
3107 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3108 buffer)))
3110 ptrdiff_t inner_count = SPECPDL_INDEX ();
3111 record_unwind_protect (select_window_norecord, Fselected_window ());
3112 select_window_norecord (window);
3113 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3114 buffer));
3115 unbind_to (inner_count, Qnil);
3120 run_funs (global_wcch);
3121 unbind_to (count, Qnil);
3124 DEFUN ("run-window-configuration-change-hook", Frun_window_configuration_change_hook,
3125 Srun_window_configuration_change_hook, 1, 1, 0,
3126 doc: /* Run `window-configuration-change-hook' for FRAME. */)
3127 (Lisp_Object frame)
3129 CHECK_LIVE_FRAME (frame);
3130 run_window_configuration_change_hook (XFRAME (frame));
3131 return Qnil;
3134 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
3135 means it's allowed to run hooks. See make_frame for a case where
3136 it's not allowed. KEEP_MARGINS_P non-zero means that the current
3137 margins, fringes, and scroll-bar settings of the window are not
3138 reset from the buffer's local settings. */
3140 void
3141 set_window_buffer (Lisp_Object window, Lisp_Object buffer, int run_hooks_p, int keep_margins_p)
3143 struct window *w = XWINDOW (window);
3144 struct buffer *b = XBUFFER (buffer);
3145 ptrdiff_t count = SPECPDL_INDEX ();
3146 int samebuf = EQ (buffer, w->buffer);
3148 wset_buffer (w, buffer);
3150 if (EQ (window, selected_window))
3151 bset_last_selected_window (b, window);
3153 /* Let redisplay errors through. */
3154 b->display_error_modiff = 0;
3156 /* Update time stamps of buffer display. */
3157 if (INTEGERP (BVAR (b, display_count)))
3158 bset_display_count (b, make_number (XINT (BVAR (b, display_count)) + 1));
3159 bset_display_time (b, Fcurrent_time ());
3161 wset_window_end_pos (w, make_number (0));
3162 wset_window_end_vpos (w, make_number (0));
3163 memset (&w->last_cursor, 0, sizeof w->last_cursor);
3164 wset_window_end_valid (w, Qnil);
3165 if (!(keep_margins_p && samebuf))
3166 { /* If we're not actually changing the buffer, don't reset hscroll and
3167 vscroll. This case happens for example when called from
3168 change_frame_size_1, where we use a dummy call to
3169 Fset_window_buffer on the frame's selected window (and no other)
3170 just in order to run window-configuration-change-hook.
3171 Resetting hscroll and vscroll here is problematic for things like
3172 image-mode and doc-view-mode since it resets the image's position
3173 whenever we resize the frame. */
3174 w->hscroll = w->min_hscroll = 0;
3175 w->vscroll = 0;
3176 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3177 set_marker_restricted (w->start,
3178 make_number (b->last_window_start),
3179 buffer);
3180 w->start_at_line_beg = 0;
3181 w->force_start = 0;
3182 w->last_modified = 0;
3183 w->last_overlay_modified = 0;
3185 /* Maybe we could move this into the `if' but it's not obviously safe and
3186 I doubt it's worth the trouble. */
3187 windows_or_buffers_changed++;
3189 /* We must select BUFFER for running the window-scroll-functions. */
3190 /* We can't check ! NILP (Vwindow_scroll_functions) here
3191 because that might itself be a local variable. */
3192 if (window_initialized)
3194 record_unwind_current_buffer ();
3195 Fset_buffer (buffer);
3198 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3200 if (!keep_margins_p)
3202 /* Set left and right marginal area width etc. from buffer. */
3204 /* This may call adjust_window_margins three times, so
3205 temporarily disable window margins. */
3206 Lisp_Object save_left = w->left_margin_cols;
3207 Lisp_Object save_right = w->right_margin_cols;
3209 wset_left_margin_cols (w, Qnil);
3210 wset_right_margin_cols (w, Qnil);
3212 Fset_window_fringes (window,
3213 BVAR (b, left_fringe_width), BVAR (b, right_fringe_width),
3214 BVAR (b, fringes_outside_margins));
3216 Fset_window_scroll_bars (window,
3217 BVAR (b, scroll_bar_width),
3218 BVAR (b, vertical_scroll_bar_type), Qnil);
3220 wset_left_margin_cols (w, save_left);
3221 wset_right_margin_cols (w, save_right);
3223 Fset_window_margins (window,
3224 BVAR (b, left_margin_cols), BVAR (b, right_margin_cols));
3227 if (run_hooks_p)
3229 if (! NILP (Vwindow_scroll_functions))
3230 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3231 Fmarker_position (w->start));
3232 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3235 unbind_to (count, Qnil);
3238 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3239 doc: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3240 WINDOW must be a live window and defaults to the selected one.
3241 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3243 Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
3244 display margins, fringe widths, and scroll bar settings are preserved;
3245 the default is to reset these from the local settings for BUFFER-OR-NAME
3246 or the frame defaults. Return nil.
3248 This function throws an error when WINDOW is strongly dedicated to its
3249 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3250 already display BUFFER-OR-NAME.
3252 This function runs `window-scroll-functions' before running
3253 `window-configuration-change-hook'. */)
3254 (register Lisp_Object window, Lisp_Object buffer_or_name, Lisp_Object keep_margins)
3256 register Lisp_Object tem, buffer;
3257 register struct window *w = decode_live_window (window);
3259 XSETWINDOW (window, w);
3260 buffer = Fget_buffer (buffer_or_name);
3261 CHECK_BUFFER (buffer);
3262 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
3263 error ("Attempt to display deleted buffer");
3265 tem = w->buffer;
3266 if (NILP (tem))
3267 error ("Window is deleted");
3268 else if (!EQ (tem, Qt))
3269 /* w->buffer is t when the window is first being set up. */
3271 if (!EQ (tem, buffer))
3273 if (EQ (w->dedicated, Qt))
3274 /* WINDOW is strongly dedicated to its buffer, signal an
3275 error. */
3276 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem), name)));
3277 else
3278 /* WINDOW is weakly dedicated to its buffer, reset
3279 dedication. */
3280 wset_dedicated (w, Qnil);
3282 call1 (Qrecord_window_buffer, window);
3285 unshow_buffer (w);
3288 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3290 return Qnil;
3293 static Lisp_Object
3294 display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame)
3296 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3299 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3300 0, 1, 0,
3301 doc: /* Force all windows to be updated on next redisplay.
3302 If optional arg OBJECT is a window, force redisplay of that window only.
3303 If OBJECT is a buffer or buffer name, force redisplay of all windows
3304 displaying that buffer. */)
3305 (Lisp_Object object)
3307 if (NILP (object))
3309 windows_or_buffers_changed++;
3310 update_mode_lines++;
3311 return Qt;
3314 if (WINDOWP (object))
3316 struct window *w = XWINDOW (object);
3317 mark_window_display_accurate (object, 0);
3318 w->update_mode_line = 1;
3319 if (BUFFERP (w->buffer))
3320 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3321 ++update_mode_lines;
3322 return Qt;
3325 if (STRINGP (object))
3326 object = Fget_buffer (object);
3327 if (BUFFERP (object) && BUFFER_LIVE_P (XBUFFER (object)))
3329 /* Walk all windows looking for buffer, and force update
3330 of each of those windows. */
3332 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3333 return NILP (object) ? Qnil : Qt;
3336 /* If nothing suitable was found, just return.
3337 We could signal an error, but this feature will typically be used
3338 asynchronously in timers or process sentinels, so we don't. */
3339 return Qnil;
3342 /* Obsolete since 24.3. */
3343 void
3344 temp_output_buffer_show (register Lisp_Object buf)
3346 register struct buffer *old = current_buffer;
3347 register Lisp_Object window;
3348 register struct window *w;
3350 bset_directory (XBUFFER (buf), BVAR (current_buffer, directory));
3352 Fset_buffer (buf);
3353 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3354 BEGV = BEG;
3355 ZV = Z;
3356 SET_PT (BEG);
3357 set_buffer_internal (old);
3359 if (!NILP (Vtemp_buffer_show_function))
3360 call1 (Vtemp_buffer_show_function, buf);
3361 else
3363 window = display_buffer (buf, Qnil, Qnil);
3365 if (!EQ (XWINDOW (window)->frame, selected_frame))
3366 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3367 Vminibuf_scroll_window = window;
3368 w = XWINDOW (window);
3369 w->hscroll = 0;
3370 w->min_hscroll = 0;
3371 set_marker_restricted_both (w->start, buf, BEG, BEG);
3372 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3374 /* Run temp-buffer-show-hook, with the chosen window selected
3375 and its buffer current. */
3377 ptrdiff_t count = SPECPDL_INDEX ();
3378 Lisp_Object prev_window, prev_buffer;
3379 prev_window = selected_window;
3380 XSETBUFFER (prev_buffer, old);
3382 /* Select the window that was chosen, for running the hook.
3383 Note: Both Fselect_window and select_window_norecord may
3384 set-buffer to the buffer displayed in the window,
3385 so we need to save the current buffer. --stef */
3386 record_unwind_protect (Fset_buffer, prev_buffer);
3387 record_unwind_protect (select_window_norecord, prev_window);
3388 Fselect_window (window, Qt);
3389 Fset_buffer (w->buffer);
3390 Frun_hooks (1, &Qtemp_buffer_show_hook);
3391 unbind_to (count, Qnil);
3396 /* Make new window, have it replace WINDOW in window-tree, and make
3397 WINDOW its only vertical child (HORFLAG 1 means make WINDOW its only
3398 horizontal child). */
3399 static void
3400 make_parent_window (Lisp_Object window, int horflag)
3402 Lisp_Object parent;
3403 register struct window *o, *p;
3405 o = XWINDOW (window);
3406 p = allocate_window ();
3407 memcpy ((char *) p + sizeof (struct vectorlike_header),
3408 (char *) o + sizeof (struct vectorlike_header),
3409 word_size * VECSIZE (struct window));
3410 XSETWINDOW (parent, p);
3412 p->sequence_number = ++sequence_number;
3414 replace_window (window, parent, 1);
3416 wset_next (o, Qnil);
3417 wset_prev (o, Qnil);
3418 wset_parent (o, parent);
3420 wset_hchild (p, horflag ? window : Qnil);
3421 wset_vchild (p, horflag ? Qnil : window);
3422 wset_start (p, Qnil);
3423 wset_pointm (p, Qnil);
3424 wset_buffer (p, Qnil);
3425 wset_combination_limit (p, Qnil);
3426 wset_window_parameters (p, Qnil);
3429 /* Make new window from scratch. */
3430 Lisp_Object
3431 make_window (void)
3433 Lisp_Object window;
3434 register struct window *w;
3436 w = allocate_window ();
3437 /* Initialize Lisp data. Note that allocate_window initializes all
3438 Lisp data to nil, so do it only for slots which should not be nil. */
3439 wset_left_col (w, make_number (0));
3440 wset_top_line (w, make_number (0));
3441 wset_total_lines (w, make_number (0));
3442 wset_total_cols (w, make_number (0));
3443 wset_normal_lines (w, make_float (1.0));
3444 wset_normal_cols (w, make_float (1.0));
3445 wset_new_total (w, make_number (0));
3446 wset_new_normal (w, make_number (0));
3447 wset_start (w, Fmake_marker ());
3448 wset_pointm (w, Fmake_marker ());
3449 wset_vertical_scroll_bar_type (w, Qt);
3450 wset_window_end_pos (w, make_number (0));
3451 wset_window_end_vpos (w, make_number (0));
3452 /* These Lisp fields are marked specially so they're not set to nil by
3453 allocate_window. */
3454 wset_prev_buffers (w, Qnil);
3455 wset_next_buffers (w, Qnil);
3457 /* Initialize non-Lisp data. Note that allocate_window zeroes out all
3458 non-Lisp data, so do it only for slots which should not be zero. */
3459 w->nrows_scale_factor = w->ncols_scale_factor = 1;
3460 w->phys_cursor_type = -1;
3461 w->phys_cursor_width = -1;
3462 w->sequence_number = ++sequence_number;
3464 /* Reset window_list. */
3465 Vwindow_list = Qnil;
3466 /* Return window. */
3467 XSETWINDOW (window, w);
3468 return window;
3471 DEFUN ("set-window-new-total", Fset_window_new_total, Sset_window_new_total, 2, 3, 0,
3472 doc: /* Set new total size of WINDOW to SIZE.
3473 WINDOW must be a valid window and defaults to the selected one.
3474 Return SIZE.
3476 Optional argument ADD non-nil means add SIZE to the new total size of
3477 WINDOW and return the sum.
3479 Note: This function does not operate on any child windows of WINDOW. */)
3480 (Lisp_Object window, Lisp_Object size, Lisp_Object add)
3482 struct window *w = decode_valid_window (window);
3484 CHECK_NUMBER (size);
3485 if (NILP (add))
3486 wset_new_total (w, size);
3487 else
3488 wset_new_total (w, make_number (XINT (w->new_total) + XINT (size)));
3490 return w->new_total;
3493 DEFUN ("set-window-new-normal", Fset_window_new_normal, Sset_window_new_normal, 1, 2, 0,
3494 doc: /* Set new normal size of WINDOW to SIZE.
3495 WINDOW must be a valid window and defaults to the selected one.
3496 Return SIZE.
3498 Note: This function does not operate on any child windows of WINDOW. */)
3499 (Lisp_Object window, Lisp_Object size)
3501 wset_new_normal (decode_valid_window (window), size);
3502 return size;
3505 /* Return 1 if setting w->total_lines (w->total_cols if HORFLAG is
3506 non-zero) to w->new_total would result in correct heights (widths)
3507 for window W and recursively all child windows of W.
3509 Note: This function does not check any of `window-fixed-size-p',
3510 `window-min-height' or `window-min-width'. It does check that window
3511 sizes do not drop below one line (two columns). */
3512 static int
3513 window_resize_check (struct window *w, int horflag)
3515 struct window *c;
3517 if (!NILP (w->vchild))
3518 /* W is a vertical combination. */
3520 c = XWINDOW (w->vchild);
3521 if (horflag)
3522 /* All child windows of W must have the same width as W. */
3524 while (c)
3526 if ((XINT (c->new_total) != XINT (w->new_total))
3527 || !window_resize_check (c, horflag))
3528 return 0;
3529 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3531 return 1;
3533 else
3534 /* The sum of the heights of the child windows of W must equal
3535 W's height. */
3537 int sum_of_sizes = 0;
3538 while (c)
3540 if (!window_resize_check (c, horflag))
3541 return 0;
3542 sum_of_sizes = sum_of_sizes + XINT (c->new_total);
3543 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3545 return (sum_of_sizes == XINT (w->new_total));
3548 else if (!NILP (w->hchild))
3549 /* W is a horizontal combination. */
3551 c = XWINDOW (w->hchild);
3552 if (horflag)
3553 /* The sum of the widths of the child windows of W must equal W's
3554 width. */
3556 int sum_of_sizes = 0;
3557 while (c)
3559 if (!window_resize_check (c, horflag))
3560 return 0;
3561 sum_of_sizes = sum_of_sizes + XINT (c->new_total);
3562 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3564 return (sum_of_sizes == XINT (w->new_total));
3566 else
3567 /* All child windows of W must have the same height as W. */
3569 while (c)
3571 if ((XINT (c->new_total) != XINT (w->new_total))
3572 || !window_resize_check (c, horflag))
3573 return 0;
3574 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3576 return 1;
3579 else
3580 /* A leaf window. Make sure it's not too small. The following
3581 hardcodes the values of `window-safe-min-width' (2) and
3582 `window-safe-min-height' (1) which are defined in window.el. */
3583 return XINT (w->new_total) >= (horflag ? 2 : 1);
3586 /* Set w->total_lines (w->total_cols if HORIZONTAL is non-zero) to
3587 w->new_total for window W and recursively all child windows of W.
3588 Also calculate and assign the new vertical (horizontal) start
3589 positions of each of these windows.
3591 This function does not perform any error checks. Make sure you have
3592 run window_resize_check on W before applying this function. */
3593 static void
3594 window_resize_apply (struct window *w, int horflag)
3596 struct window *c;
3597 int pos;
3599 /* Note: Assigning new_normal requires that the new total size of the
3600 parent window has been set *before*. */
3601 if (horflag)
3603 wset_total_cols (w, w->new_total);
3604 if (NUMBERP (w->new_normal))
3605 wset_normal_cols (w, w->new_normal);
3607 pos = XINT (w->left_col);
3609 else
3611 wset_total_lines (w, w->new_total);
3612 if (NUMBERP (w->new_normal))
3613 wset_normal_lines (w, w->new_normal);
3615 pos = XINT (w->top_line);
3618 if (!NILP (w->vchild))
3619 /* W is a vertical combination. */
3621 c = XWINDOW (w->vchild);
3622 while (c)
3624 if (horflag)
3625 wset_left_col (c, make_number (pos));
3626 else
3627 wset_top_line (c, make_number (pos));
3628 window_resize_apply (c, horflag);
3629 if (!horflag)
3630 pos = pos + XINT (c->total_lines);
3631 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3634 else if (!NILP (w->hchild))
3635 /* W is a horizontal combination. */
3637 c = XWINDOW (w->hchild);
3638 while (c)
3640 if (horflag)
3641 wset_left_col (c, make_number (pos));
3642 else
3643 wset_top_line (c, make_number (pos));
3644 window_resize_apply (c, horflag);
3645 if (horflag)
3646 pos = pos + XINT (c->total_cols);
3647 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3651 /* Clear out some redisplay caches. */
3652 w->last_modified = 0;
3653 w->last_overlay_modified = 0;
3657 DEFUN ("window-resize-apply", Fwindow_resize_apply, Swindow_resize_apply, 1, 2, 0,
3658 doc: /* Apply requested size values for window-tree of FRAME.
3659 Optional argument HORIZONTAL omitted or nil means apply requested height
3660 values. HORIZONTAL non-nil means apply requested width values.
3662 This function checks whether the requested values sum up to a valid
3663 window layout, recursively assigns the new sizes of all child windows
3664 and calculates and assigns the new start positions of these windows.
3666 Note: This function does not check any of `window-fixed-size-p',
3667 `window-min-height' or `window-min-width'. All these checks have to
3668 be applied on the Elisp level. */)
3669 (Lisp_Object frame, Lisp_Object horizontal)
3671 struct frame *f;
3672 struct window *r;
3673 int horflag = !NILP (horizontal);
3675 if (NILP (frame))
3676 frame = selected_frame;
3677 CHECK_LIVE_FRAME (frame);
3679 f = XFRAME (frame);
3680 r = XWINDOW (FRAME_ROOT_WINDOW (f));
3682 if (!window_resize_check (r, horflag)
3683 || ! EQ (r->new_total,
3684 (horflag ? r->total_cols : r->total_lines)))
3685 return Qnil;
3687 block_input ();
3688 window_resize_apply (r, horflag);
3690 windows_or_buffers_changed++;
3691 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3693 adjust_glyphs (f);
3694 unblock_input ();
3696 run_window_configuration_change_hook (f);
3698 return Qt;
3702 /* Resize frame F's windows when number of lines of F is set to SIZE.
3703 HORFLAG 1 means resize windows when number of columns of F is set to
3704 SIZE.
3706 This function can delete all windows but the selected one in order to
3707 satisfy the request. The result will be meaningful if and only if
3708 F's windows have meaningful sizes when you call this. */
3709 void
3710 resize_frame_windows (struct frame *f, int size, int horflag)
3712 Lisp_Object root = f->root_window;
3713 struct window *r = XWINDOW (root);
3714 Lisp_Object mini = f->minibuffer_window;
3715 struct window *m;
3716 /* new_size is the new size of the frame's root window. */
3717 int new_size = (horflag
3718 ? size
3719 : (size
3720 - FRAME_TOP_MARGIN (f)
3721 - ((FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3722 ? 1 : 0)));
3724 wset_top_line (r, make_number (FRAME_TOP_MARGIN (f)));
3725 if (NILP (r->vchild) && NILP (r->hchild))
3726 /* For a leaf root window just set the size. */
3727 if (horflag)
3728 wset_total_cols (r, make_number (new_size));
3729 else
3730 wset_total_lines (r, make_number (new_size));
3731 else
3733 /* old_size is the old size of the frame's root window. */
3734 int old_size = XFASTINT (horflag ? r->total_cols
3735 : r->total_lines);
3736 Lisp_Object delta;
3738 XSETINT (delta, new_size - old_size);
3739 /* Try a "normal" resize first. */
3740 resize_root_window (root, delta, horflag ? Qt : Qnil, Qnil);
3741 if (window_resize_check (r, horflag)
3742 && new_size == XINT (r->new_total))
3743 window_resize_apply (r, horflag);
3744 else
3746 /* Try with "reasonable" minimum sizes next. */
3747 resize_root_window (root, delta, horflag ? Qt : Qnil, Qt);
3748 if (window_resize_check (r, horflag)
3749 && new_size == XINT (r->new_total))
3750 window_resize_apply (r, horflag);
3751 else
3753 /* Finally, try with "safe" minimum sizes. */
3754 resize_root_window (root, delta, horflag ? Qt : Qnil, Qsafe);
3755 if (window_resize_check (r, horflag)
3756 && new_size == XINT (r->new_total))
3757 window_resize_apply (r, horflag);
3758 else
3760 /* We lost. Delete all windows but the frame's
3761 selected one. */
3762 root = f->selected_window;
3763 Fdelete_other_windows_internal (root, Qnil);
3764 if (horflag)
3765 wset_total_cols (XWINDOW (root), make_number (new_size));
3766 else
3767 wset_total_lines (XWINDOW (root), make_number (new_size));
3773 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3775 m = XWINDOW (mini);
3776 if (horflag)
3777 wset_total_cols (m, make_number (size));
3778 else
3780 /* Are we sure we always want 1 line here? */
3781 wset_total_lines (m, make_number (1));
3782 wset_top_line
3783 (m, make_number (XINT (r->top_line) + XINT (r->total_lines)));
3787 windows_or_buffers_changed++;
3791 DEFUN ("split-window-internal", Fsplit_window_internal, Ssplit_window_internal, 4, 4, 0,
3792 doc: /* Split window OLD.
3793 Second argument TOTAL-SIZE specifies the number of lines or columns of the
3794 new window. In any case TOTAL-SIZE must be a positive integer.
3796 Third argument SIDE nil (or `below') specifies that the new window shall
3797 be located below WINDOW. SIDE `above' means the new window shall be
3798 located above WINDOW. In both cases TOTAL-SIZE specifies the number of
3799 lines of the new window including space reserved for the mode and/or
3800 header line.
3802 SIDE t (or `right') specifies that the new window shall be located on
3803 the right side of WINDOW. SIDE `left' means the new window shall be
3804 located on the left of WINDOW. In both cases TOTAL-SIZE specifies the
3805 number of columns of the new window including space reserved for fringes
3806 and the scrollbar or a divider column.
3808 Fourth argument NORMAL-SIZE specifies the normal size of the new window
3809 according to the SIDE argument.
3811 The new total and normal sizes of all involved windows must have been
3812 set correctly. See the code of `split-window' for how this is done. */)
3813 (Lisp_Object old, Lisp_Object total_size, Lisp_Object side, Lisp_Object normal_size)
3815 /* OLD (*o) is the window we have to split. (*p) is either OLD's
3816 parent window or an internal window we have to install as OLD's new
3817 parent. REFERENCE (*r) must denote a live window, or is set to OLD
3818 provided OLD is a leaf window, or to the frame's selected window.
3819 NEW (*n) is the new window created with some parameters taken from
3820 REFERENCE (*r). */
3821 register Lisp_Object new, frame, reference;
3822 register struct window *o, *p, *n, *r;
3823 struct frame *f;
3824 int horflag
3825 /* HORFLAG is 1 when we split side-by-side, 0 otherwise. */
3826 = EQ (side, Qt) || EQ (side, Qleft) || EQ (side, Qright);
3827 int combination_limit = 0;
3829 CHECK_WINDOW (old);
3830 o = XWINDOW (old);
3831 frame = WINDOW_FRAME (o);
3832 f = XFRAME (frame);
3834 CHECK_NUMBER (total_size);
3836 /* Set combination_limit to 1 if we have to make a new parent window.
3837 We do that if either `window-combination-limit' is t, or OLD has no
3838 parent, or OLD is ortho-combined. */
3839 combination_limit =
3840 EQ (Vwindow_combination_limit, Qt)
3841 || NILP (o->parent)
3842 || NILP (horflag
3843 ? (XWINDOW (o->parent)->hchild)
3844 : (XWINDOW (o->parent)->vchild));
3846 /* We need a live reference window to initialize some parameters. */
3847 if (WINDOW_LIVE_P (old))
3848 /* OLD is live, use it as reference window. */
3849 reference = old;
3850 else
3851 /* Use the frame's selected window as reference window. */
3852 reference = FRAME_SELECTED_WINDOW (f);
3853 r = XWINDOW (reference);
3855 /* The following bugs are caught by `split-window'. */
3856 if (MINI_WINDOW_P (o))
3857 error ("Attempt to split minibuffer window");
3858 else if (XINT (total_size) < (horflag ? 2 : 1))
3859 error ("Size of new window too small (after split)");
3860 else if (!combination_limit && !NILP (Vwindow_combination_resize))
3861 /* `window-combination-resize' non-nil means try to resize OLD's siblings
3862 proportionally. */
3864 p = XWINDOW (o->parent);
3865 /* Temporarily pretend we split the parent window. */
3866 wset_new_total
3867 (p, make_number (XINT (horflag ? p->total_cols : p->total_lines)
3868 - XINT (total_size)));
3869 if (!window_resize_check (p, horflag))
3870 error ("Window sizes don't fit");
3871 else
3872 /* Undo the temporary pretension. */
3873 wset_new_total (p, horflag ? p->total_cols : p->total_lines);
3875 else
3877 if (!window_resize_check (o, horflag))
3878 error ("Resizing old window failed");
3879 else if (XINT (total_size) + XINT (o->new_total)
3880 != XINT (horflag ? o->total_cols : o->total_lines))
3881 error ("Sum of sizes of old and new window don't fit");
3884 /* This is our point of no return. */
3885 if (combination_limit)
3887 /* Save the old value of o->normal_cols/lines. It gets corrupted
3888 by make_parent_window and we need it below for assigning it to
3889 p->new_normal. */
3890 Lisp_Object new_normal
3891 = horflag ? o->normal_cols : o->normal_lines;
3893 make_parent_window (old, horflag);
3894 p = XWINDOW (o->parent);
3895 /* Store t in the new parent's combination_limit slot to avoid
3896 that its children get merged into another window. */
3897 wset_combination_limit (p, Qt);
3898 /* These get applied below. */
3899 wset_new_total (p, horflag ? o->total_cols : o->total_lines);
3900 wset_new_normal (p, new_normal);
3902 else
3903 p = XWINDOW (o->parent);
3905 windows_or_buffers_changed++;
3906 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3907 new = make_window ();
3908 n = XWINDOW (new);
3909 wset_frame (n, frame);
3910 wset_parent (n, o->parent);
3911 wset_vchild (n, Qnil);
3912 wset_hchild (n, Qnil);
3914 if (EQ (side, Qabove) || EQ (side, Qleft))
3916 wset_prev (n, o->prev);
3917 if (NILP (n->prev))
3918 if (horflag)
3919 wset_hchild (p, new);
3920 else
3921 wset_vchild (p, new);
3922 else
3923 wset_next (XWINDOW (n->prev), new);
3924 wset_next (n, old);
3925 wset_prev (o, new);
3927 else
3929 wset_next (n, o->next);
3930 if (!NILP (n->next))
3931 wset_prev (XWINDOW (n->next), new);
3932 wset_prev (n, old);
3933 wset_next (o, new);
3936 wset_buffer (n, Qt);
3937 wset_window_end_valid (n, Qnil);
3938 memset (&n->last_cursor, 0, sizeof n->last_cursor);
3940 /* Get special geometry settings from reference window. */
3941 wset_left_margin_cols (n, r->left_margin_cols);
3942 wset_right_margin_cols (n, r->right_margin_cols);
3943 wset_left_fringe_width (n, r->left_fringe_width);
3944 wset_right_fringe_width (n, r->right_fringe_width);
3945 n->fringes_outside_margins = r->fringes_outside_margins;
3946 wset_scroll_bar_width (n, r->scroll_bar_width);
3947 wset_vertical_scroll_bar_type (n, r->vertical_scroll_bar_type);
3949 /* Directly assign orthogonal coordinates and sizes. */
3950 if (horflag)
3952 wset_top_line (n, o->top_line);
3953 wset_total_lines (n, o->total_lines);
3955 else
3957 wset_left_col (n, o->left_col);
3958 wset_total_cols (n, o->total_cols);
3961 /* Iso-coordinates and sizes are assigned by window_resize_apply,
3962 get them ready here. */
3963 wset_new_total (n, total_size);
3964 wset_new_normal (n, normal_size);
3966 block_input ();
3967 window_resize_apply (p, horflag);
3968 adjust_glyphs (f);
3969 /* Set buffer of NEW to buffer of reference window. Don't run
3970 any hooks. */
3971 set_window_buffer (new, r->buffer, 0, 1);
3972 unblock_input ();
3974 /* Maybe we should run the scroll functions in Elisp (which already
3975 runs the configuration change hook). */
3976 if (! NILP (Vwindow_scroll_functions))
3977 run_hook_with_args_2 (Qwindow_scroll_functions, new,
3978 Fmarker_position (n->start));
3979 /* Return NEW. */
3980 return new;
3984 DEFUN ("delete-window-internal", Fdelete_window_internal, Sdelete_window_internal, 1, 1, 0,
3985 doc: /* Remove WINDOW from its frame.
3986 WINDOW defaults to the selected window. Return nil.
3987 Signal an error when WINDOW is the only window on its frame. */)
3988 (register Lisp_Object window)
3990 register Lisp_Object parent, sibling, frame, root;
3991 struct window *w, *p, *s, *r;
3992 struct frame *f;
3993 int horflag;
3994 int before_sibling = 0;
3996 w = decode_any_window (window);
3997 XSETWINDOW (window, w);
3998 if (NILP (w->buffer)
3999 && NILP (w->hchild) && NILP (w->vchild))
4000 /* It's a no-op to delete an already deleted window. */
4001 return Qnil;
4003 parent = w->parent;
4004 if (NILP (parent))
4005 /* Never delete a minibuffer or frame root window. */
4006 error ("Attempt to delete minibuffer or sole ordinary window");
4007 else if (NILP (w->prev) && NILP (w->next))
4008 /* Rather bow out here, this case should be handled on the Elisp
4009 level. */
4010 error ("Attempt to delete sole window of parent");
4012 p = XWINDOW (parent);
4013 horflag = NILP (p->vchild);
4015 frame = WINDOW_FRAME (w);
4016 f = XFRAME (frame);
4018 root = FRAME_ROOT_WINDOW (f);
4019 r = XWINDOW (root);
4021 /* Unlink WINDOW from window tree. */
4022 if (NILP (w->prev))
4023 /* Get SIBLING below (on the right of) WINDOW. */
4025 /* before_sibling 1 means WINDOW is the first child of its
4026 parent and thus before the sibling. */
4027 before_sibling = 1;
4028 sibling = w->next;
4029 s = XWINDOW (sibling);
4030 wset_prev (s, Qnil);
4031 if (horflag)
4032 wset_hchild (p, sibling);
4033 else
4034 wset_vchild (p, sibling);
4036 else
4037 /* Get SIBLING above (on the left of) WINDOW. */
4039 sibling = w->prev;
4040 s = XWINDOW (sibling);
4041 wset_next (s, w->next);
4042 if (!NILP (s->next))
4043 wset_prev (XWINDOW (s->next), sibling);
4046 if (window_resize_check (r, horflag)
4047 && EQ (r->new_total,
4048 (horflag ? r->total_cols : r->total_lines)))
4049 /* We can delete WINDOW now. */
4052 /* Block input. */
4053 block_input ();
4054 window_resize_apply (p, horflag);
4056 /* If this window is referred to by the dpyinfo's mouse
4057 highlight, invalidate that slot to be safe (Bug#9904). */
4058 if (!FRAME_INITIAL_P (f))
4060 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
4062 if (EQ (hlinfo->mouse_face_window, window))
4063 hlinfo->mouse_face_window = Qnil;
4066 windows_or_buffers_changed++;
4067 Vwindow_list = Qnil;
4068 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4070 wset_next (w, Qnil); /* Don't delete w->next too. */
4071 free_window_matrices (w);
4073 if (!NILP (w->vchild))
4075 delete_all_child_windows (w->vchild);
4076 wset_vchild (w, Qnil);
4078 else if (!NILP (w->hchild))
4080 delete_all_child_windows (w->hchild);
4081 wset_hchild (w, Qnil);
4083 else if (!NILP (w->buffer))
4085 unshow_buffer (w);
4086 unchain_marker (XMARKER (w->pointm));
4087 unchain_marker (XMARKER (w->start));
4088 wset_buffer (w, Qnil);
4091 if (NILP (s->prev) && NILP (s->next))
4092 /* A matrjoshka where SIBLING has become the only child of
4093 PARENT. */
4095 /* Put SIBLING into PARENT's place. */
4096 replace_window (parent, sibling, 0);
4097 /* Have SIBLING inherit the following three slot values from
4098 PARENT (the combination_limit slot is not inherited). */
4099 wset_normal_cols (s, p->normal_cols);
4100 wset_normal_lines (s, p->normal_lines);
4101 /* Mark PARENT as deleted. */
4102 wset_vchild (p, Qnil);
4103 wset_hchild (p, Qnil);
4104 /* Try to merge SIBLING into its new parent. */
4105 recombine_windows (sibling);
4108 adjust_glyphs (f);
4110 if (!WINDOW_LIVE_P (FRAME_SELECTED_WINDOW (f)))
4111 /* We deleted the frame's selected window. */
4113 /* Use the frame's first window as fallback ... */
4114 Lisp_Object new_selected_window = Fframe_first_window (frame);
4115 /* ... but preferably use its most recently used window. */
4116 Lisp_Object mru_window;
4118 /* `get-mru-window' might fail for some reason so play it safe
4119 - promote the first window _without recording it_ first. */
4120 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4121 Fselect_window (new_selected_window, Qt);
4122 else
4123 fset_selected_window (f, new_selected_window);
4125 unblock_input ();
4127 /* Now look whether `get-mru-window' gets us something. */
4128 mru_window = call1 (Qget_mru_window, frame);
4129 if (WINDOW_LIVE_P (mru_window)
4130 && EQ (XWINDOW (mru_window)->frame, frame))
4131 new_selected_window = mru_window;
4133 /* If all ended up well, we now promote the mru window. */
4134 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4135 Fselect_window (new_selected_window, Qnil);
4136 else
4137 fset_selected_window (f, new_selected_window);
4139 else
4140 unblock_input ();
4142 /* Must be run by the caller:
4143 run_window_configuration_change_hook (f); */
4145 else
4146 /* We failed: Relink WINDOW into window tree. */
4148 if (before_sibling)
4150 wset_prev (s, window);
4151 if (horflag)
4152 wset_hchild (p, window);
4153 else
4154 wset_vchild (p, window);
4156 else
4158 wset_next (s, window);
4159 if (!NILP (w->next))
4160 wset_prev (XWINDOW (w->next), window);
4162 error ("Deletion failed");
4165 return Qnil;
4168 /***********************************************************************
4169 Resizing Mini-Windows
4170 ***********************************************************************/
4172 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we
4173 can. */
4174 void
4175 grow_mini_window (struct window *w, int delta)
4177 struct frame *f = XFRAME (w->frame);
4178 struct window *r;
4179 Lisp_Object root, value;
4181 eassert (MINI_WINDOW_P (w));
4182 eassert (delta >= 0);
4184 root = FRAME_ROOT_WINDOW (f);
4185 r = XWINDOW (root);
4186 value = call2 (Qwindow_resize_root_window_vertically,
4187 root, make_number (- delta));
4188 if (INTEGERP (value) && window_resize_check (r, 0))
4190 block_input ();
4191 window_resize_apply (r, 0);
4193 /* Grow the mini-window. */
4194 wset_top_line
4195 (w, make_number (XFASTINT (r->top_line) + XFASTINT (r->total_lines)));
4196 wset_total_lines
4197 (w, make_number (XFASTINT (w->total_lines) - XINT (value)));
4198 w->last_modified = 0;
4199 w->last_overlay_modified = 0;
4201 windows_or_buffers_changed++;
4202 adjust_glyphs (f);
4203 unblock_input ();
4208 /* Shrink mini-window W. */
4209 void
4210 shrink_mini_window (struct window *w)
4212 struct frame *f = XFRAME (w->frame);
4213 struct window *r;
4214 Lisp_Object root, value;
4215 EMACS_INT size;
4217 eassert (MINI_WINDOW_P (w));
4219 size = XINT (w->total_lines);
4220 if (size > 1)
4222 root = FRAME_ROOT_WINDOW (f);
4223 r = XWINDOW (root);
4224 value = call2 (Qwindow_resize_root_window_vertically,
4225 root, make_number (size - 1));
4226 if (INTEGERP (value) && window_resize_check (r, 0))
4228 block_input ();
4229 window_resize_apply (r, 0);
4231 /* Shrink the mini-window. */
4232 wset_top_line (w, make_number (XFASTINT (r->top_line)
4233 + XFASTINT (r->total_lines)));
4234 wset_total_lines (w, make_number (1));
4236 w->last_modified = 0;
4237 w->last_overlay_modified = 0;
4239 windows_or_buffers_changed++;
4240 adjust_glyphs (f);
4241 unblock_input ();
4243 /* If the above failed for whatever strange reason we must make a
4244 one window frame here. The same routine will be needed when
4245 shrinking the frame (and probably when making the initial
4246 *scratch* window). For the moment leave things as they are. */
4250 DEFUN ("resize-mini-window-internal", Fresize_mini_window_internal, Sresize_mini_window_internal, 1, 1, 0,
4251 doc: /* Resize minibuffer window WINDOW. */)
4252 (Lisp_Object window)
4254 struct window *w = XWINDOW (window);
4255 struct window *r;
4256 struct frame *f;
4257 int height;
4259 CHECK_WINDOW (window);
4260 f = XFRAME (w->frame);
4262 if (!EQ (FRAME_MINIBUF_WINDOW (XFRAME (w->frame)), window))
4263 error ("Not a valid minibuffer window");
4264 else if (FRAME_MINIBUF_ONLY_P (f))
4265 error ("Cannot resize a minibuffer-only frame");
4267 r = XWINDOW (FRAME_ROOT_WINDOW (f));
4268 height = XINT (r->total_lines) + XINT (w->total_lines);
4269 if (window_resize_check (r, 0)
4270 && XINT (w->new_total) > 0
4271 && height == XINT (r->new_total) + XINT (w->new_total))
4273 block_input ();
4274 window_resize_apply (r, 0);
4276 wset_total_lines (w, w->new_total);
4277 wset_top_line (w, make_number (XINT (r->top_line)
4278 + XINT (r->total_lines)));
4280 windows_or_buffers_changed++;
4281 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4282 adjust_glyphs (f);
4283 unblock_input ();
4285 run_window_configuration_change_hook (f);
4286 return Qt;
4288 else error ("Failed to resize minibuffer window");
4291 /* Mark window cursors off for all windows in the window tree rooted
4292 at W by setting their phys_cursor_on_p flag to zero. Called from
4293 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4294 the frame are cleared. */
4296 void
4297 mark_window_cursors_off (struct window *w)
4299 while (w)
4301 if (!NILP (w->hchild))
4302 mark_window_cursors_off (XWINDOW (w->hchild));
4303 else if (!NILP (w->vchild))
4304 mark_window_cursors_off (XWINDOW (w->vchild));
4305 else
4306 w->phys_cursor_on_p = 0;
4308 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4313 /* Return number of lines of text (not counting mode lines) in W. */
4316 window_internal_height (struct window *w)
4318 int ht = XFASTINT (w->total_lines);
4320 if (!MINI_WINDOW_P (w))
4322 if (!NILP (w->parent)
4323 || !NILP (w->vchild)
4324 || !NILP (w->hchild)
4325 || !NILP (w->next)
4326 || !NILP (w->prev)
4327 || WINDOW_WANTS_MODELINE_P (w))
4328 --ht;
4330 if (WINDOW_WANTS_HEADER_LINE_P (w))
4331 --ht;
4334 return ht;
4337 /************************************************************************
4338 Window Scrolling
4339 ***********************************************************************/
4341 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4342 N screen-fulls, which is defined as the height of the window minus
4343 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4344 instead. Negative values of N mean scroll down. NOERROR non-zero
4345 means don't signal an error if we try to move over BEGV or ZV,
4346 respectively. */
4348 static void
4349 window_scroll (Lisp_Object window, EMACS_INT n, int whole, int noerror)
4351 immediate_quit = 1;
4352 n = clip_to_bounds (INT_MIN, n, INT_MAX);
4354 /* If we must, use the pixel-based version which is much slower than
4355 the line-based one but can handle varying line heights. */
4356 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4357 window_scroll_pixel_based (window, n, whole, noerror);
4358 else
4359 window_scroll_line_based (window, n, whole, noerror);
4361 immediate_quit = 0;
4365 /* Implementation of window_scroll that works based on pixel line
4366 heights. See the comment of window_scroll for parameter
4367 descriptions. */
4369 static void
4370 window_scroll_pixel_based (Lisp_Object window, int n, int whole, int noerror)
4372 struct it it;
4373 struct window *w = XWINDOW (window);
4374 struct text_pos start;
4375 int this_scroll_margin;
4376 /* True if we fiddled the window vscroll field without really scrolling. */
4377 int vscrolled = 0;
4378 int x, y, rtop, rbot, rowh, vpos;
4379 void *itdata = NULL;
4381 SET_TEXT_POS_FROM_MARKER (start, w->start);
4382 /* Scrolling a minibuffer window via scroll bar when the echo area
4383 shows long text sometimes resets the minibuffer contents behind
4384 our backs. */
4385 if (CHARPOS (start) > ZV)
4386 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
4388 /* If PT is not visible in WINDOW, move back one half of
4389 the screen. Allow PT to be partially visible, otherwise
4390 something like (scroll-down 1) with PT in the line before
4391 the partially visible one would recenter. */
4393 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4395 itdata = bidi_shelve_cache ();
4396 /* Move backward half the height of the window. Performance note:
4397 vmotion used here is about 10% faster, but would give wrong
4398 results for variable height lines. */
4399 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4400 it.current_y = it.last_visible_y;
4401 move_it_vertically_backward (&it, window_box_height (w) / 2);
4403 /* The function move_iterator_vertically may move over more than
4404 the specified y-distance. If it->w is small, e.g. a
4405 mini-buffer window, we may end up in front of the window's
4406 display area. This is the case when Start displaying at the
4407 start of the line containing PT in this case. */
4408 if (it.current_y <= 0)
4410 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4411 move_it_vertically_backward (&it, 0);
4412 it.current_y = 0;
4415 start = it.current.pos;
4416 bidi_unshelve_cache (itdata, 0);
4418 else if (auto_window_vscroll_p)
4420 if (rtop || rbot) /* partially visible */
4422 int px;
4423 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4424 if (whole)
4425 dy = max ((window_box_height (w)
4426 - next_screen_context_lines * dy),
4427 dy);
4428 dy *= n;
4430 if (n < 0)
4432 /* Only vscroll backwards if already vscrolled forwards. */
4433 if (w->vscroll < 0 && rtop > 0)
4435 px = max (0, -w->vscroll - min (rtop, -dy));
4436 Fset_window_vscroll (window, make_number (px), Qt);
4437 return;
4440 if (n > 0)
4442 /* Do vscroll if already vscrolled or only display line. */
4443 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4445 px = max (0, -w->vscroll + min (rbot, dy));
4446 Fset_window_vscroll (window, make_number (px), Qt);
4447 return;
4450 /* Maybe modify window start instead of scrolling. */
4451 if (rbot > 0 || w->vscroll < 0)
4453 ptrdiff_t spos;
4455 Fset_window_vscroll (window, make_number (0), Qt);
4456 /* If there are other text lines above the current row,
4457 move window start to current row. Else to next row. */
4458 if (rbot > 0)
4459 spos = XINT (Fline_beginning_position (Qnil));
4460 else
4461 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4462 set_marker_restricted (w->start, make_number (spos),
4463 w->buffer);
4464 w->start_at_line_beg = 1;
4465 w->update_mode_line = 1;
4466 w->last_modified = 0;
4467 w->last_overlay_modified = 0;
4468 /* Set force_start so that redisplay_window will run the
4469 window-scroll-functions. */
4470 w->force_start = 1;
4471 return;
4475 /* Cancel previous vscroll. */
4476 Fset_window_vscroll (window, make_number (0), Qt);
4479 itdata = bidi_shelve_cache ();
4480 /* If scroll_preserve_screen_position is non-nil, we try to set
4481 point in the same window line as it is now, so get that line. */
4482 if (!NILP (Vscroll_preserve_screen_position))
4484 /* We preserve the goal pixel coordinate across consecutive
4485 calls to scroll-up, scroll-down and other commands that
4486 have the `scroll-command' property. This avoids the
4487 possibility of point becoming "stuck" on a tall line when
4488 scrolling by one line. */
4489 if (window_scroll_pixel_based_preserve_y < 0
4490 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4491 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4493 start_display (&it, w, start);
4494 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4495 window_scroll_pixel_based_preserve_y = it.current_y;
4496 window_scroll_pixel_based_preserve_x = it.current_x;
4499 else
4500 window_scroll_pixel_based_preserve_y
4501 = window_scroll_pixel_based_preserve_x = -1;
4503 /* Move iterator it from start the specified distance forward or
4504 backward. The result is the new window start. */
4505 start_display (&it, w, start);
4506 if (whole)
4508 ptrdiff_t start_pos = IT_CHARPOS (it);
4509 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4510 dy = max ((window_box_height (w)
4511 - next_screen_context_lines * dy),
4512 dy) * n;
4514 /* Note that move_it_vertically always moves the iterator to the
4515 start of a line. So, if the last line doesn't have a newline,
4516 we would end up at the start of the line ending at ZV. */
4517 if (dy <= 0)
4519 move_it_vertically_backward (&it, -dy);
4520 /* Ensure we actually do move, e.g. in case we are currently
4521 looking at an image that is taller that the window height. */
4522 while (start_pos == IT_CHARPOS (it)
4523 && start_pos > BEGV)
4524 move_it_by_lines (&it, -1);
4526 else if (dy > 0)
4528 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4529 MOVE_TO_POS | MOVE_TO_Y);
4530 /* Ensure we actually do move, e.g. in case we are currently
4531 looking at an image that is taller that the window height. */
4532 while (start_pos == IT_CHARPOS (it)
4533 && start_pos < ZV)
4534 move_it_by_lines (&it, 1);
4537 else
4538 move_it_by_lines (&it, n);
4540 /* We failed if we find ZV is already on the screen (scrolling up,
4541 means there's nothing past the end), or if we can't start any
4542 earlier (scrolling down, means there's nothing past the top). */
4543 if ((n > 0 && IT_CHARPOS (it) == ZV)
4544 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4546 if (IT_CHARPOS (it) == ZV)
4548 if (it.current_y < it.last_visible_y
4549 && (it.current_y + it.max_ascent + it.max_descent
4550 > it.last_visible_y))
4552 /* The last line was only partially visible, make it fully
4553 visible. */
4554 w->vscroll = (it.last_visible_y
4555 - it.current_y + it.max_ascent + it.max_descent);
4556 adjust_glyphs (it.f);
4558 else
4560 bidi_unshelve_cache (itdata, 0);
4561 if (noerror)
4562 return;
4563 else if (n < 0) /* could happen with empty buffers */
4564 xsignal0 (Qbeginning_of_buffer);
4565 else
4566 xsignal0 (Qend_of_buffer);
4569 else
4571 if (w->vscroll != 0)
4572 /* The first line was only partially visible, make it fully
4573 visible. */
4574 w->vscroll = 0;
4575 else
4577 bidi_unshelve_cache (itdata, 0);
4578 if (noerror)
4579 return;
4580 else
4581 xsignal0 (Qbeginning_of_buffer);
4585 /* If control gets here, then we vscrolled. */
4587 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4589 /* Don't try to change the window start below. */
4590 vscrolled = 1;
4593 if (! vscrolled)
4595 ptrdiff_t pos = IT_CHARPOS (it);
4596 ptrdiff_t bytepos;
4598 /* If in the middle of a multi-glyph character move forward to
4599 the next character. */
4600 if (in_display_vector_p (&it))
4602 ++pos;
4603 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4606 /* Set the window start, and set up the window for redisplay. */
4607 set_marker_restricted (w->start, make_number (pos),
4608 w->buffer);
4609 bytepos = XMARKER (w->start)->bytepos;
4610 w->start_at_line_beg = (pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n');
4611 w->update_mode_line = 1;
4612 w->last_modified = 0;
4613 w->last_overlay_modified = 0;
4614 /* Set force_start so that redisplay_window will run the
4615 window-scroll-functions. */
4616 w->force_start = 1;
4619 /* The rest of this function uses current_y in a nonstandard way,
4620 not including the height of the header line if any. */
4621 it.current_y = it.vpos = 0;
4623 /* Move PT out of scroll margins.
4624 This code wants current_y to be zero at the window start position
4625 even if there is a header line. */
4626 this_scroll_margin = max (0, scroll_margin);
4627 this_scroll_margin
4628 = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
4629 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
4631 if (n > 0)
4633 /* We moved the window start towards ZV, so PT may be now
4634 in the scroll margin at the top. */
4635 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4636 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
4637 && (NILP (Vscroll_preserve_screen_position)
4638 || EQ (Vscroll_preserve_screen_position, Qt)))
4639 /* We found PT at a legitimate height. Leave it alone. */
4641 else if (window_scroll_pixel_based_preserve_y >= 0)
4643 /* If we have a header line, take account of it.
4644 This is necessary because we set it.current_y to 0, above. */
4645 move_it_to (&it, -1,
4646 window_scroll_pixel_based_preserve_x,
4647 window_scroll_pixel_based_preserve_y
4648 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
4649 -1, MOVE_TO_Y | MOVE_TO_X);
4650 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4652 else
4654 while (it.current_y < this_scroll_margin)
4656 int prev = it.current_y;
4657 move_it_by_lines (&it, 1);
4658 if (prev == it.current_y)
4659 break;
4661 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4664 else if (n < 0)
4666 ptrdiff_t charpos, bytepos;
4667 int partial_p;
4669 /* Save our position, for the
4670 window_scroll_pixel_based_preserve_y case. */
4671 charpos = IT_CHARPOS (it);
4672 bytepos = IT_BYTEPOS (it);
4674 /* We moved the window start towards BEGV, so PT may be now
4675 in the scroll margin at the bottom. */
4676 move_it_to (&it, PT, -1,
4677 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
4678 - this_scroll_margin - 1),
4680 MOVE_TO_POS | MOVE_TO_Y);
4682 /* Save our position, in case it's correct. */
4683 charpos = IT_CHARPOS (it);
4684 bytepos = IT_BYTEPOS (it);
4686 /* See if point is on a partially visible line at the end. */
4687 if (it.what == IT_EOB)
4688 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
4689 else
4691 move_it_by_lines (&it, 1);
4692 partial_p = it.current_y > it.last_visible_y;
4695 if (charpos == PT && !partial_p
4696 && (NILP (Vscroll_preserve_screen_position)
4697 || EQ (Vscroll_preserve_screen_position, Qt)))
4698 /* We found PT before we found the display margin, so PT is ok. */
4700 else if (window_scroll_pixel_based_preserve_y >= 0)
4702 SET_TEXT_POS_FROM_MARKER (start, w->start);
4703 start_display (&it, w, start);
4704 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
4705 here because we called start_display again and did not
4706 alter it.current_y this time. */
4707 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
4708 window_scroll_pixel_based_preserve_y, -1,
4709 MOVE_TO_Y | MOVE_TO_X);
4710 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4712 else
4714 if (partial_p)
4715 /* The last line was only partially visible, so back up two
4716 lines to make sure we're on a fully visible line. */
4718 move_it_by_lines (&it, -2);
4719 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4721 else
4722 /* No, the position we saved is OK, so use it. */
4723 SET_PT_BOTH (charpos, bytepos);
4726 bidi_unshelve_cache (itdata, 0);
4730 /* Implementation of window_scroll that works based on screen lines.
4731 See the comment of window_scroll for parameter descriptions. */
4733 static void
4734 window_scroll_line_based (Lisp_Object window, int n, int whole, int noerror)
4736 register struct window *w = XWINDOW (window);
4737 /* Fvertical_motion enters redisplay, which can trigger
4738 fontification, which in turn can modify buffer text (e.g., if the
4739 fontification functions replace escape sequences with faces, as
4740 in `grep-mode-font-lock-keywords'). So we use a marker to record
4741 the old point position, to prevent crashes in SET_PT_BOTH. */
4742 Lisp_Object opoint_marker = Fpoint_marker ();
4743 register ptrdiff_t pos, pos_byte;
4744 register int ht = window_internal_height (w);
4745 register Lisp_Object tem;
4746 int lose;
4747 Lisp_Object bolp;
4748 ptrdiff_t startpos;
4749 Lisp_Object original_pos = Qnil;
4751 /* If scrolling screen-fulls, compute the number of lines to
4752 scroll from the window's height. */
4753 if (whole)
4754 n *= max (1, ht - next_screen_context_lines);
4756 startpos = marker_position (w->start);
4758 if (!NILP (Vscroll_preserve_screen_position))
4760 if (window_scroll_preserve_vpos <= 0
4761 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4762 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4764 struct position posit
4765 = *compute_motion (startpos, 0, 0, 0,
4766 PT, ht, 0,
4767 -1, w->hscroll,
4768 0, w);
4769 window_scroll_preserve_vpos = posit.vpos;
4770 window_scroll_preserve_hpos = posit.hpos + w->hscroll;
4773 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
4774 make_number (window_scroll_preserve_vpos));
4777 XSETFASTINT (tem, PT);
4778 tem = Fpos_visible_in_window_p (tem, window, Qnil);
4780 if (NILP (tem))
4782 Fvertical_motion (make_number (- (ht / 2)), window);
4783 startpos = PT;
4786 SET_PT (startpos);
4787 lose = n < 0 && PT == BEGV;
4788 Fvertical_motion (make_number (n), window);
4789 pos = PT;
4790 pos_byte = PT_BYTE;
4791 bolp = Fbolp ();
4792 SET_PT_BOTH (marker_position (opoint_marker),
4793 marker_byte_position (opoint_marker));
4795 if (lose)
4797 if (noerror)
4798 return;
4799 else
4800 xsignal0 (Qbeginning_of_buffer);
4803 if (pos < ZV)
4805 /* Don't use a scroll margin that is negative or too large. */
4806 int this_scroll_margin =
4807 max (0, min (scroll_margin, XINT (w->total_lines) / 4));
4809 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
4810 w->start_at_line_beg = !NILP (bolp);
4811 w->update_mode_line = 1;
4812 w->last_modified = 0;
4813 w->last_overlay_modified = 0;
4814 /* Set force_start so that redisplay_window will run
4815 the window-scroll-functions. */
4816 w->force_start = 1;
4818 if (!NILP (Vscroll_preserve_screen_position)
4819 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
4821 SET_PT_BOTH (pos, pos_byte);
4822 Fvertical_motion (original_pos, window);
4824 /* If we scrolled forward, put point enough lines down
4825 that it is outside the scroll margin. */
4826 else if (n > 0)
4828 int top_margin;
4830 if (this_scroll_margin > 0)
4832 SET_PT_BOTH (pos, pos_byte);
4833 Fvertical_motion (make_number (this_scroll_margin), window);
4834 top_margin = PT;
4836 else
4837 top_margin = pos;
4839 if (top_margin <= marker_position (opoint_marker))
4840 SET_PT_BOTH (marker_position (opoint_marker),
4841 marker_byte_position (opoint_marker));
4842 else if (!NILP (Vscroll_preserve_screen_position))
4844 SET_PT_BOTH (pos, pos_byte);
4845 Fvertical_motion (original_pos, window);
4847 else
4848 SET_PT (top_margin);
4850 else if (n < 0)
4852 int bottom_margin;
4854 /* If we scrolled backward, put point near the end of the window
4855 but not within the scroll margin. */
4856 SET_PT_BOTH (pos, pos_byte);
4857 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
4858 if (XFASTINT (tem) == ht - this_scroll_margin)
4859 bottom_margin = PT;
4860 else
4861 bottom_margin = PT + 1;
4863 if (bottom_margin > marker_position (opoint_marker))
4864 SET_PT_BOTH (marker_position (opoint_marker),
4865 marker_byte_position (opoint_marker));
4866 else
4868 if (!NILP (Vscroll_preserve_screen_position))
4870 SET_PT_BOTH (pos, pos_byte);
4871 Fvertical_motion (original_pos, window);
4873 else
4874 Fvertical_motion (make_number (-1), window);
4878 else
4880 if (noerror)
4881 return;
4882 else
4883 xsignal0 (Qend_of_buffer);
4888 /* Scroll selected_window up or down. If N is nil, scroll a
4889 screen-full which is defined as the height of the window minus
4890 next_screen_context_lines. If N is the symbol `-', scroll.
4891 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4892 up. This is the guts of Fscroll_up and Fscroll_down. */
4894 static void
4895 scroll_command (Lisp_Object n, int direction)
4897 ptrdiff_t count = SPECPDL_INDEX ();
4899 eassert (eabs (direction) == 1);
4901 /* If selected window's buffer isn't current, make it current for
4902 the moment. But don't screw up if window_scroll gets an error. */
4903 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
4905 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4906 Fset_buffer (XWINDOW (selected_window)->buffer);
4908 /* Make redisplay consider other windows than just selected_window. */
4909 ++windows_or_buffers_changed;
4912 if (NILP (n))
4913 window_scroll (selected_window, direction, 1, 0);
4914 else if (EQ (n, Qminus))
4915 window_scroll (selected_window, -direction, 1, 0);
4916 else
4918 n = Fprefix_numeric_value (n);
4919 window_scroll (selected_window, XINT (n) * direction, 0, 0);
4922 unbind_to (count, Qnil);
4925 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
4926 doc: /* Scroll text of selected window upward ARG lines.
4927 If ARG is omitted or nil, scroll upward by a near full screen.
4928 A near full screen is `next-screen-context-lines' less than a full screen.
4929 Negative ARG means scroll downward.
4930 If ARG is the atom `-', scroll downward by nearly full screen.
4931 When calling from a program, supply as argument a number, nil, or `-'. */)
4932 (Lisp_Object arg)
4934 scroll_command (arg, 1);
4935 return Qnil;
4938 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
4939 doc: /* Scroll text of selected window down ARG lines.
4940 If ARG is omitted or nil, scroll down by a near full screen.
4941 A near full screen is `next-screen-context-lines' less than a full screen.
4942 Negative ARG means scroll upward.
4943 If ARG is the atom `-', scroll upward by nearly full screen.
4944 When calling from a program, supply as argument a number, nil, or `-'. */)
4945 (Lisp_Object arg)
4947 scroll_command (arg, -1);
4948 return Qnil;
4951 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
4952 doc: /* Return the other window for \"other window scroll\" commands.
4953 If `other-window-scroll-buffer' is non-nil, a window
4954 showing that buffer is used.
4955 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4956 specifies the window. This takes precedence over
4957 `other-window-scroll-buffer'. */)
4958 (void)
4960 Lisp_Object window;
4962 if (MINI_WINDOW_P (XWINDOW (selected_window))
4963 && !NILP (Vminibuf_scroll_window))
4964 window = Vminibuf_scroll_window;
4965 /* If buffer is specified, scroll that buffer. */
4966 else if (!NILP (Vother_window_scroll_buffer))
4968 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
4969 if (NILP (window))
4970 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
4972 else
4974 /* Nothing specified; look for a neighboring window on the same
4975 frame. */
4976 window = Fnext_window (selected_window, Qnil, Qnil);
4978 if (EQ (window, selected_window))
4979 /* That didn't get us anywhere; look for a window on another
4980 visible frame. */
4982 window = Fnext_window (window, Qnil, Qt);
4983 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
4984 && ! EQ (window, selected_window));
4987 CHECK_LIVE_WINDOW (window);
4989 if (EQ (window, selected_window))
4990 error ("There is no other window");
4992 return window;
4995 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
4996 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
4997 A near full screen is `next-screen-context-lines' less than a full screen.
4998 The next window is the one below the current one; or the one at the top
4999 if the current one is at the bottom. Negative ARG means scroll downward.
5000 If ARG is the atom `-', scroll downward by nearly full screen.
5001 When calling from a program, supply as argument a number, nil, or `-'.
5003 If `other-window-scroll-buffer' is non-nil, scroll the window
5004 showing that buffer, popping the buffer up if necessary.
5005 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5006 specifies the window to scroll. This takes precedence over
5007 `other-window-scroll-buffer'. */)
5008 (Lisp_Object arg)
5010 Lisp_Object window;
5011 struct window *w;
5012 ptrdiff_t count = SPECPDL_INDEX ();
5014 window = Fother_window_for_scrolling ();
5015 w = XWINDOW (window);
5017 /* Don't screw up if window_scroll gets an error. */
5018 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5019 ++windows_or_buffers_changed;
5021 Fset_buffer (w->buffer);
5022 SET_PT (marker_position (w->pointm));
5024 if (NILP (arg))
5025 window_scroll (window, 1, 1, 1);
5026 else if (EQ (arg, Qminus))
5027 window_scroll (window, -1, 1, 1);
5028 else
5030 if (CONSP (arg))
5031 arg = XCAR (arg);
5032 CHECK_NUMBER (arg);
5033 window_scroll (window, XINT (arg), 0, 1);
5036 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5037 unbind_to (count, Qnil);
5039 return Qnil;
5042 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5043 doc: /* Scroll selected window display ARG columns left.
5044 Default for ARG is window width minus 2.
5045 Value is the total amount of leftward horizontal scrolling in
5046 effect after the change.
5047 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5048 lower bound for automatic scrolling, i.e. automatic scrolling
5049 will not scroll a window to a column less than the value returned
5050 by this function. This happens in an interactive call. */)
5051 (register Lisp_Object arg, Lisp_Object set_minimum)
5053 struct window *w = XWINDOW (selected_window);
5054 EMACS_INT requested_arg = (NILP (arg)
5055 ? window_body_cols (w) - 2
5056 : XINT (Fprefix_numeric_value (arg)));
5057 Lisp_Object result = set_window_hscroll (w, w->hscroll + requested_arg);
5059 if (!NILP (set_minimum))
5060 w->min_hscroll = w->hscroll;
5062 return result;
5065 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5066 doc: /* Scroll selected window display ARG columns right.
5067 Default for ARG is window width minus 2.
5068 Value is the total amount of leftward horizontal scrolling in
5069 effect after the change.
5070 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5071 lower bound for automatic scrolling, i.e. automatic scrolling
5072 will not scroll a window to a column less than the value returned
5073 by this function. This happens in an interactive call. */)
5074 (register Lisp_Object arg, Lisp_Object set_minimum)
5076 struct window *w = XWINDOW (selected_window);
5077 EMACS_INT requested_arg = (NILP (arg)
5078 ? window_body_cols (w) - 2
5079 : XINT (Fprefix_numeric_value (arg)));
5080 Lisp_Object result = set_window_hscroll (w, w->hscroll - requested_arg);
5082 if (!NILP (set_minimum))
5083 w->min_hscroll = w->hscroll;
5085 return result;
5088 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5089 doc: /* Return the window which was selected when entering the minibuffer.
5090 Returns nil, if selected window is not a minibuffer window. */)
5091 (void)
5093 if (minibuf_level > 0
5094 && MINI_WINDOW_P (XWINDOW (selected_window))
5095 && WINDOW_LIVE_P (minibuf_selected_window))
5096 return minibuf_selected_window;
5098 return Qnil;
5101 /* Value is the number of lines actually displayed in window W,
5102 as opposed to its height. */
5104 static int
5105 displayed_window_lines (struct window *w)
5107 struct it it;
5108 struct text_pos start;
5109 int height = window_box_height (w);
5110 struct buffer *old_buffer;
5111 int bottom_y;
5112 void *itdata = NULL;
5114 if (XBUFFER (w->buffer) != current_buffer)
5116 old_buffer = current_buffer;
5117 set_buffer_internal (XBUFFER (w->buffer));
5119 else
5120 old_buffer = NULL;
5122 /* In case W->start is out of the accessible range, do something
5123 reasonable. This happens in Info mode when Info-scroll-down
5124 calls (recenter -1) while W->start is 1. */
5125 if (XMARKER (w->start)->charpos < BEGV)
5126 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
5127 else if (XMARKER (w->start)->charpos > ZV)
5128 SET_TEXT_POS (start, ZV, ZV_BYTE);
5129 else
5130 SET_TEXT_POS_FROM_MARKER (start, w->start);
5132 itdata = bidi_shelve_cache ();
5133 start_display (&it, w, start);
5134 move_it_vertically (&it, height);
5135 bottom_y = line_bottom_y (&it);
5136 bidi_unshelve_cache (itdata, 0);
5138 /* rms: On a non-window display,
5139 the value of it.vpos at the bottom of the screen
5140 seems to be 1 larger than window_box_height (w).
5141 This kludge fixes a bug whereby (move-to-window-line -1)
5142 when ZV is on the last screen line
5143 moves to the previous screen line instead of the last one. */
5144 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5145 height++;
5147 /* Add in empty lines at the bottom of the window. */
5148 if (bottom_y < height)
5150 int uy = FRAME_LINE_HEIGHT (it.f);
5151 it.vpos += (height - bottom_y + uy - 1) / uy;
5154 if (old_buffer)
5155 set_buffer_internal (old_buffer);
5157 return it.vpos;
5161 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5162 doc: /* Center point in selected window and maybe redisplay frame.
5163 With prefix argument ARG, recenter putting point on screen line ARG
5164 relative to the selected window. If ARG is negative, it counts up from the
5165 bottom of the window. (ARG should be less than the height of the window.)
5167 If ARG is omitted or nil, then recenter with point on the middle line of
5168 the selected window; if the variable `recenter-redisplay' is non-nil,
5169 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5170 is set to `grow-only', this resets the tool-bar's height to the minimum
5171 height needed); if `recenter-redisplay' has the special value `tty',
5172 then only tty frames are redrawn.
5174 Just C-u as prefix means put point in the center of the window
5175 and redisplay normally--don't erase and redraw the frame. */)
5176 (register Lisp_Object arg)
5178 struct window *w = XWINDOW (selected_window);
5179 struct buffer *buf = XBUFFER (w->buffer);
5180 struct buffer *obuf = current_buffer;
5181 int center_p = 0;
5182 ptrdiff_t charpos, bytepos;
5183 EMACS_INT iarg IF_LINT (= 0);
5184 int this_scroll_margin;
5186 /* If redisplay is suppressed due to an error, try again. */
5187 obuf->display_error_modiff = 0;
5189 if (NILP (arg))
5191 if (!NILP (Vrecenter_redisplay)
5192 && (!EQ (Vrecenter_redisplay, Qtty)
5193 || !NILP (Ftty_type (selected_frame))))
5195 ptrdiff_t i;
5197 /* Invalidate pixel data calculated for all compositions. */
5198 for (i = 0; i < n_compositions; i++)
5199 composition_table[i]->font = NULL;
5201 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5203 Fredraw_frame (WINDOW_FRAME (w));
5204 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5207 center_p = 1;
5209 else if (CONSP (arg)) /* Just C-u. */
5210 center_p = 1;
5211 else
5213 arg = Fprefix_numeric_value (arg);
5214 CHECK_NUMBER (arg);
5215 iarg = XINT (arg);
5218 set_buffer_internal (buf);
5220 /* Do this after making BUF current
5221 in case scroll_margin is buffer-local. */
5222 this_scroll_margin =
5223 max (0, min (scroll_margin, XFASTINT (w->total_lines) / 4));
5225 /* Handle centering on a graphical frame specially. Such frames can
5226 have variable-height lines and centering point on the basis of
5227 line counts would lead to strange effects. */
5228 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5230 if (center_p)
5232 struct it it;
5233 struct text_pos pt;
5234 void *itdata = bidi_shelve_cache ();
5236 SET_TEXT_POS (pt, PT, PT_BYTE);
5237 start_display (&it, w, pt);
5238 move_it_vertically_backward (&it, window_box_height (w) / 2);
5239 charpos = IT_CHARPOS (it);
5240 bytepos = IT_BYTEPOS (it);
5241 bidi_unshelve_cache (itdata, 0);
5243 else if (iarg < 0)
5245 struct it it;
5246 struct text_pos pt;
5247 ptrdiff_t nlines = min (PTRDIFF_MAX, -iarg);
5248 int extra_line_spacing;
5249 int h = window_box_height (w);
5250 void *itdata = bidi_shelve_cache ();
5252 iarg = - max (-iarg, this_scroll_margin);
5254 SET_TEXT_POS (pt, PT, PT_BYTE);
5255 start_display (&it, w, pt);
5257 /* Be sure we have the exact height of the full line containing PT. */
5258 move_it_by_lines (&it, 0);
5260 /* The amount of pixels we have to move back is the window
5261 height minus what's displayed in the line containing PT,
5262 and the lines below. */
5263 it.current_y = 0;
5264 it.vpos = 0;
5265 move_it_by_lines (&it, nlines);
5267 if (it.vpos == nlines)
5268 h -= it.current_y;
5269 else
5271 /* Last line has no newline */
5272 h -= line_bottom_y (&it);
5273 it.vpos++;
5276 /* Don't reserve space for extra line spacing of last line. */
5277 extra_line_spacing = it.max_extra_line_spacing;
5279 /* If we can't move down NLINES lines because we hit
5280 the end of the buffer, count in some empty lines. */
5281 if (it.vpos < nlines)
5283 nlines -= it.vpos;
5284 extra_line_spacing = it.extra_line_spacing;
5285 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5287 if (h <= 0)
5289 bidi_unshelve_cache (itdata, 0);
5290 return Qnil;
5293 /* Now find the new top line (starting position) of the window. */
5294 start_display (&it, w, pt);
5295 it.current_y = 0;
5296 move_it_vertically_backward (&it, h);
5298 /* If extra line spacing is present, we may move too far
5299 back. This causes the last line to be only partially
5300 visible (which triggers redisplay to recenter that line
5301 in the middle), so move forward.
5302 But ignore extra line spacing on last line, as it is not
5303 considered to be part of the visible height of the line.
5305 h += extra_line_spacing;
5306 while (-it.current_y > h)
5307 move_it_by_lines (&it, 1);
5309 charpos = IT_CHARPOS (it);
5310 bytepos = IT_BYTEPOS (it);
5312 bidi_unshelve_cache (itdata, 0);
5314 else
5316 struct position pos;
5318 iarg = max (iarg, this_scroll_margin);
5320 pos = *vmotion (PT, -iarg, w);
5321 charpos = pos.bufpos;
5322 bytepos = pos.bytepos;
5325 else
5327 struct position pos;
5328 int ht = window_internal_height (w);
5330 if (center_p)
5331 iarg = ht / 2;
5332 else if (iarg < 0)
5333 iarg += ht;
5335 /* Don't let it get into the margin at either top or bottom. */
5336 iarg = max (iarg, this_scroll_margin);
5337 iarg = min (iarg, ht - this_scroll_margin - 1);
5339 pos = *vmotion (PT, - iarg, w);
5340 charpos = pos.bufpos;
5341 bytepos = pos.bytepos;
5344 /* Set the new window start. */
5345 set_marker_both (w->start, w->buffer, charpos, bytepos);
5346 wset_window_end_valid (w, Qnil);
5348 w->optional_new_start = 1;
5350 w->start_at_line_beg = (bytepos == BEGV_BYTE ||
5351 FETCH_BYTE (bytepos - 1) == '\n');
5353 set_buffer_internal (obuf);
5354 return Qnil;
5357 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5358 0, 1, 0,
5359 doc: /* Return the height in lines of the text display area of WINDOW.
5360 WINDOW must be a live window and defaults to the selected one.
5362 The returned height does not include the mode line, any header line,
5363 nor any partial-height lines at the bottom of the text area. */)
5364 (Lisp_Object window)
5366 struct window *w = decode_live_window (window);
5367 int pixel_height = window_box_height (w);
5368 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5369 return make_number (line_height);
5374 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5375 1, 1, "P",
5376 doc: /* Position point relative to window.
5377 ARG nil means position point at center of window.
5378 Else, ARG specifies vertical position within the window;
5379 zero means top of window, negative means relative to bottom of window. */)
5380 (Lisp_Object arg)
5382 struct window *w = XWINDOW (selected_window);
5383 int lines, start;
5384 Lisp_Object window;
5385 #if 0
5386 int this_scroll_margin;
5387 #endif
5389 if (!(BUFFERP (w->buffer)
5390 && XBUFFER (w->buffer) == current_buffer))
5391 /* This test is needed to make sure PT/PT_BYTE make sense in w->buffer
5392 when passed below to set_marker_both. */
5393 error ("move-to-window-line called from unrelated buffer");
5395 window = selected_window;
5396 start = marker_position (w->start);
5397 if (start < BEGV || start > ZV)
5399 int height = window_internal_height (w);
5400 Fvertical_motion (make_number (- (height / 2)), window);
5401 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
5402 w->start_at_line_beg = !NILP (Fbolp ());
5403 w->force_start = 1;
5405 else
5406 Fgoto_char (w->start);
5408 lines = displayed_window_lines (w);
5410 #if 0
5411 this_scroll_margin = max (0, min (scroll_margin, lines / 4));
5412 #endif
5414 if (NILP (arg))
5415 XSETFASTINT (arg, lines / 2);
5416 else
5418 EMACS_INT iarg = XINT (Fprefix_numeric_value (arg));
5420 if (iarg < 0)
5421 iarg = iarg + lines;
5423 #if 0 /* This code would prevent move-to-window-line from moving point
5424 to a place inside the scroll margins (which would cause the
5425 next redisplay to scroll). I wrote this code, but then concluded
5426 it is probably better not to install it. However, it is here
5427 inside #if 0 so as not to lose it. -- rms. */
5429 /* Don't let it get into the margin at either top or bottom. */
5430 iarg = max (iarg, this_scroll_margin);
5431 iarg = min (iarg, lines - this_scroll_margin - 1);
5432 #endif
5434 arg = make_number (iarg);
5437 /* Skip past a partially visible first line. */
5438 if (w->vscroll)
5439 XSETINT (arg, XINT (arg) + 1);
5441 return Fvertical_motion (arg, window);
5446 /***********************************************************************
5447 Window Configuration
5448 ***********************************************************************/
5450 struct save_window_data
5452 struct vectorlike_header header;
5453 Lisp_Object selected_frame;
5454 Lisp_Object current_window;
5455 Lisp_Object current_buffer;
5456 Lisp_Object minibuf_scroll_window;
5457 Lisp_Object minibuf_selected_window;
5458 Lisp_Object root_window;
5459 Lisp_Object focus_frame;
5460 /* A vector, each of whose elements is a struct saved_window
5461 for one window. */
5462 Lisp_Object saved_windows;
5464 /* All fields above are traced by the GC.
5465 From `fame-cols' down, the fields are ignored by the GC. */
5467 int frame_cols, frame_lines, frame_menu_bar_lines;
5468 int frame_tool_bar_lines;
5471 /* This is saved as a Lisp_Vector */
5472 struct saved_window
5474 struct vectorlike_header header;
5476 Lisp_Object window, buffer, start, pointm, mark;
5477 Lisp_Object left_col, top_line, total_cols, total_lines;
5478 Lisp_Object normal_cols, normal_lines;
5479 Lisp_Object hscroll, min_hscroll;
5480 Lisp_Object parent, prev;
5481 Lisp_Object start_at_line_beg;
5482 Lisp_Object display_table;
5483 Lisp_Object left_margin_cols, right_margin_cols;
5484 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5485 Lisp_Object scroll_bar_width, vertical_scroll_bar_type, dedicated;
5486 Lisp_Object combination_limit, window_parameters;
5489 #define SAVED_WINDOW_N(swv,n) \
5490 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5492 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5493 doc: /* Return t if OBJECT is a window-configuration object. */)
5494 (Lisp_Object object)
5496 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
5499 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5500 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5501 (Lisp_Object config)
5503 register struct save_window_data *data;
5504 struct Lisp_Vector *saved_windows;
5506 CHECK_WINDOW_CONFIGURATION (config);
5508 data = (struct save_window_data *) XVECTOR (config);
5509 saved_windows = XVECTOR (data->saved_windows);
5510 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5513 DEFUN ("set-window-configuration", Fset_window_configuration,
5514 Sset_window_configuration, 1, 1, 0,
5515 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5516 CONFIGURATION must be a value previously returned
5517 by `current-window-configuration' (which see).
5518 If CONFIGURATION was made from a frame that is now deleted,
5519 only frame-independent values can be restored. In this case,
5520 the return value is nil. Otherwise the value is t. */)
5521 (Lisp_Object configuration)
5523 register struct save_window_data *data;
5524 struct Lisp_Vector *saved_windows;
5525 Lisp_Object new_current_buffer;
5526 Lisp_Object frame;
5527 FRAME_PTR f;
5528 ptrdiff_t old_point = -1;
5530 CHECK_WINDOW_CONFIGURATION (configuration);
5532 data = (struct save_window_data *) XVECTOR (configuration);
5533 saved_windows = XVECTOR (data->saved_windows);
5535 new_current_buffer = data->current_buffer;
5536 if (!BUFFER_LIVE_P (XBUFFER (new_current_buffer)))
5537 new_current_buffer = Qnil;
5538 else
5540 if (XBUFFER (new_current_buffer) == current_buffer)
5541 /* The code further down "preserves point" by saving here PT in
5542 old_point and then setting it later back into PT. When the
5543 current-selected-window and the final-selected-window both show
5544 the current buffer, this suffers from the problem that the
5545 current PT is the window-point of the current-selected-window,
5546 while the final PT is the point of the final-selected-window, so
5547 this copy from one PT to the other would end up moving the
5548 window-point of the final-selected-window to the window-point of
5549 the current-selected-window. So we have to be careful which
5550 point of the current-buffer we copy into old_point. */
5551 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5552 && WINDOWP (selected_window)
5553 && EQ (XWINDOW (selected_window)->buffer, new_current_buffer)
5554 && !EQ (selected_window, data->current_window))
5555 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5556 else
5557 old_point = PT;
5558 else
5559 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5560 point in new_current_buffer as of the last time this buffer was
5561 used. This can be non-deterministic since it can be changed by
5562 things like jit-lock by mere temporary selection of some random
5563 window that happens to show this buffer.
5564 So if possible we want this arbitrary choice of "which point" to
5565 be the one from the to-be-selected-window so as to prevent this
5566 window's cursor from being copied from another window. */
5567 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5568 /* If current_window = selected_window, its point is in BUF_PT. */
5569 && !EQ (selected_window, data->current_window))
5570 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5571 else
5572 old_point = BUF_PT (XBUFFER (new_current_buffer));
5575 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5576 f = XFRAME (frame);
5578 /* If f is a dead frame, don't bother rebuilding its window tree.
5579 However, there is other stuff we should still try to do below. */
5580 if (FRAME_LIVE_P (f))
5582 Lisp_Object window;
5583 Lisp_Object dead_windows = Qnil;
5584 register Lisp_Object tem, par, pers;
5585 register struct window *w;
5586 register struct saved_window *p;
5587 struct window *root_window;
5588 struct window **leaf_windows;
5589 int n_leaf_windows;
5590 ptrdiff_t k;
5591 int i, n;
5593 /* If the frame has been resized since this window configuration was
5594 made, we change the frame to the size specified in the
5595 configuration, restore the configuration, and then resize it
5596 back. We keep track of the prevailing height in these variables. */
5597 int previous_frame_lines = FRAME_LINES (f);
5598 int previous_frame_cols = FRAME_COLS (f);
5599 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5600 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5602 /* Don't do this within the main loop below: This may call Lisp
5603 code and is thus potentially unsafe while input is blocked. */
5604 for (k = 0; k < saved_windows->header.size; k++)
5606 p = SAVED_WINDOW_N (saved_windows, k);
5607 window = p->window;
5608 w = XWINDOW (window);
5609 if (!NILP (w->buffer)
5610 && !EQ (w->buffer, p->buffer)
5611 && BUFFER_LIVE_P (XBUFFER (p->buffer)))
5612 /* If a window we restore gets another buffer, record the
5613 window's old buffer. */
5614 call1 (Qrecord_window_buffer, window);
5617 /* The mouse highlighting code could get screwed up
5618 if it runs during this. */
5619 block_input ();
5621 if (data->frame_lines != previous_frame_lines
5622 || data->frame_cols != previous_frame_cols)
5623 change_frame_size (f, data->frame_lines,
5624 data->frame_cols, 0, 0, 0);
5625 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5626 if (data->frame_menu_bar_lines
5627 != previous_frame_menu_bar_lines)
5628 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
5629 make_number (0));
5630 #ifdef HAVE_WINDOW_SYSTEM
5631 if (data->frame_tool_bar_lines
5632 != previous_frame_tool_bar_lines)
5633 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
5634 make_number (0));
5635 #endif
5636 #endif
5638 /* "Swap out" point from the selected window's buffer
5639 into the window itself. (Normally the pointm of the selected
5640 window holds garbage.) We do this now, before
5641 restoring the window contents, and prevent it from
5642 being done later on when we select a new window. */
5643 if (! NILP (XWINDOW (selected_window)->buffer))
5645 w = XWINDOW (selected_window);
5646 set_marker_both (w->pointm,
5647 w->buffer,
5648 BUF_PT (XBUFFER (w->buffer)),
5649 BUF_PT_BYTE (XBUFFER (w->buffer)));
5652 windows_or_buffers_changed++;
5653 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
5655 /* Problem: Freeing all matrices and later allocating them again
5656 is a serious redisplay flickering problem. What we would
5657 really like to do is to free only those matrices not reused
5658 below. */
5659 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
5660 leaf_windows = alloca (count_windows (root_window)
5661 * sizeof *leaf_windows);
5662 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
5664 /* Kludge Alert!
5665 Mark all windows now on frame as "deleted".
5666 Restoring the new configuration "undeletes" any that are in it.
5668 Save their current buffers in their height fields, since we may
5669 need it later, if a buffer saved in the configuration is now
5670 dead. */
5671 delete_all_child_windows (FRAME_ROOT_WINDOW (f));
5673 for (k = 0; k < saved_windows->header.size; k++)
5675 p = SAVED_WINDOW_N (saved_windows, k);
5676 window = p->window;
5677 w = XWINDOW (window);
5678 wset_next (w, Qnil);
5680 if (!NILP (p->parent))
5681 wset_parent
5682 (w, SAVED_WINDOW_N (saved_windows, XFASTINT (p->parent))->window);
5683 else
5684 wset_parent (w, Qnil);
5686 if (!NILP (p->prev))
5688 wset_prev
5689 (w, SAVED_WINDOW_N (saved_windows, XFASTINT (p->prev))->window);
5690 wset_next (XWINDOW (w->prev), p->window);
5692 else
5694 wset_prev (w, Qnil);
5695 if (!NILP (w->parent))
5697 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
5699 wset_vchild (XWINDOW (w->parent), p->window);
5700 wset_hchild (XWINDOW (w->parent), Qnil);
5702 else
5704 wset_hchild (XWINDOW (w->parent), p->window);
5705 wset_vchild (XWINDOW (w->parent), Qnil);
5710 /* If we squirreled away the buffer in the window's height,
5711 restore it now. */
5712 if (BUFFERP (w->total_lines))
5713 wset_buffer (w, w->total_lines);
5714 wset_left_col (w, p->left_col);
5715 wset_top_line (w, p->top_line);
5716 wset_total_cols (w, p->total_cols);
5717 wset_total_lines (w, p->total_lines);
5718 wset_normal_cols (w, p->normal_cols);
5719 wset_normal_lines (w, p->normal_lines);
5720 w->hscroll = XFASTINT (p->hscroll);
5721 w->min_hscroll = XFASTINT (p->min_hscroll);
5722 wset_display_table (w, p->display_table);
5723 wset_left_margin_cols (w, p->left_margin_cols);
5724 wset_right_margin_cols (w, p->right_margin_cols);
5725 wset_left_fringe_width (w, p->left_fringe_width);
5726 wset_right_fringe_width (w, p->right_fringe_width);
5727 w->fringes_outside_margins = !NILP (p->fringes_outside_margins);
5728 wset_scroll_bar_width (w, p->scroll_bar_width);
5729 wset_vertical_scroll_bar_type (w, p->vertical_scroll_bar_type);
5730 wset_dedicated (w, p->dedicated);
5731 wset_combination_limit (w, p->combination_limit);
5732 /* Restore any window parameters that have been saved.
5733 Parameters that have not been saved are left alone. */
5734 for (tem = p->window_parameters; CONSP (tem); tem = XCDR (tem))
5736 pers = XCAR (tem);
5737 if (CONSP (pers))
5739 if (NILP (XCDR (pers)))
5741 par = Fassq (XCAR (pers), w->window_parameters);
5742 if (CONSP (par) && !NILP (XCDR (par)))
5743 /* Reset a parameter to nil if and only if it
5744 has a non-nil association. Don't make new
5745 associations. */
5746 Fsetcdr (par, Qnil);
5748 else
5749 /* Always restore a non-nil value. */
5750 Fset_window_parameter (window, XCAR (pers), XCDR (pers));
5754 w->last_modified = 0;
5755 w->last_overlay_modified = 0;
5757 /* Reinstall the saved buffer and pointers into it. */
5758 if (NILP (p->buffer))
5759 /* An internal window. */
5760 wset_buffer (w, p->buffer);
5761 else if (BUFFER_LIVE_P (XBUFFER (p->buffer)))
5762 /* If saved buffer is alive, install it. */
5764 wset_buffer (w, p->buffer);
5765 w->start_at_line_beg = !NILP (p->start_at_line_beg);
5766 set_marker_restricted (w->start, p->start, w->buffer);
5767 set_marker_restricted (w->pointm, p->pointm,
5768 w->buffer);
5769 Fset_marker (BVAR (XBUFFER (w->buffer), mark),
5770 p->mark, w->buffer);
5772 /* As documented in Fcurrent_window_configuration, don't
5773 restore the location of point in the buffer which was
5774 current when the window configuration was recorded. */
5775 if (!EQ (p->buffer, new_current_buffer)
5776 && XBUFFER (p->buffer) == current_buffer)
5777 Fgoto_char (w->pointm);
5779 else if (!NILP (w->buffer)
5780 && BUFFER_LIVE_P (XBUFFER (w->buffer)))
5781 /* Keep window's old buffer; make sure the markers are
5782 real. */
5784 /* Set window markers at start of visible range. */
5785 if (XMARKER (w->start)->buffer == 0)
5786 set_marker_restricted (w->start, make_number (0),
5787 w->buffer);
5788 if (XMARKER (w->pointm)->buffer == 0)
5789 set_marker_restricted_both
5790 (w->pointm, w->buffer,
5791 BUF_PT (XBUFFER (w->buffer)),
5792 BUF_PT_BYTE (XBUFFER (w->buffer)));
5793 w->start_at_line_beg = 1;
5795 else
5796 /* Window has no live buffer, get one. */
5798 /* Get the buffer via other_buffer_safely in order to
5799 avoid showing an unimportant buffer and, if necessary, to
5800 recreate *scratch* in the course (part of Juanma's bs-show
5801 scenario from March 2011). */
5802 wset_buffer (w, other_buffer_safely (Fcurrent_buffer ()));
5803 /* This will set the markers to beginning of visible
5804 range. */
5805 set_marker_restricted (w->start,
5806 make_number (0), w->buffer);
5807 set_marker_restricted (w->pointm,
5808 make_number (0), w->buffer);
5809 w->start_at_line_beg = 1;
5810 if (!NILP (w->dedicated))
5811 /* Record this window as dead. */
5812 dead_windows = Fcons (window, dead_windows);
5813 /* Make sure window is no more dedicated. */
5814 wset_dedicated (w, Qnil);
5818 fset_root_window (f, data->root_window);
5819 /* Arrange *not* to restore point in the buffer that was
5820 current when the window configuration was saved. */
5821 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
5822 set_marker_restricted (XWINDOW (data->current_window)->pointm,
5823 make_number (old_point),
5824 XWINDOW (data->current_window)->buffer);
5826 /* In the following call to `select-window', prevent "swapping out
5827 point" in the old selected window using the buffer that has
5828 been restored into it. We already swapped out that point from
5829 that window's old buffer. */
5830 select_window (data->current_window, Qnil, 1);
5831 BVAR (XBUFFER (XWINDOW (selected_window)->buffer), last_selected_window)
5832 = selected_window;
5834 if (NILP (data->focus_frame)
5835 || (FRAMEP (data->focus_frame)
5836 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
5837 Fredirect_frame_focus (frame, data->focus_frame);
5839 /* Set the screen height to the value it had before this function. */
5840 if (previous_frame_lines != FRAME_LINES (f)
5841 || previous_frame_cols != FRAME_COLS (f))
5842 change_frame_size (f, previous_frame_lines, previous_frame_cols,
5843 0, 0, 0);
5844 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5845 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
5846 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
5847 make_number (0));
5848 #ifdef HAVE_WINDOW_SYSTEM
5849 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
5850 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
5851 make_number (0));
5852 #endif
5853 #endif
5855 /* Now, free glyph matrices in windows that were not reused. */
5856 for (i = n = 0; i < n_leaf_windows; ++i)
5858 if (NILP (leaf_windows[i]->buffer))
5860 /* Assert it's not reused as a combination. */
5861 eassert (NILP (leaf_windows[i]->hchild)
5862 && NILP (leaf_windows[i]->vchild));
5863 free_window_matrices (leaf_windows[i]);
5865 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
5866 ++n;
5869 adjust_glyphs (f);
5870 unblock_input ();
5872 /* Scan dead buffer windows. */
5873 for (; CONSP (dead_windows); dead_windows = XCDR (dead_windows))
5875 window = XCAR (dead_windows);
5876 if (WINDOW_LIVE_P (window) && !EQ (window, FRAME_ROOT_WINDOW (f)))
5877 delete_deletable_window (window);
5880 /* Fselect_window will have made f the selected frame, so we
5881 reselect the proper frame here. Fhandle_switch_frame will change the
5882 selected window too, but that doesn't make the call to
5883 Fselect_window above totally superfluous; it still sets f's
5884 selected window. */
5885 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
5886 do_switch_frame (data->selected_frame, 0, 0, Qnil);
5888 run_window_configuration_change_hook (f);
5891 if (!NILP (new_current_buffer))
5893 Fset_buffer (new_current_buffer);
5894 /* If the new current buffer doesn't appear in the selected
5895 window, go to its old point (see bug#12208). */
5896 if (!EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
5897 Fgoto_char (make_number (old_point));
5900 Vminibuf_scroll_window = data->minibuf_scroll_window;
5901 minibuf_selected_window = data->minibuf_selected_window;
5903 return (FRAME_LIVE_P (f) ? Qt : Qnil);
5907 /* Recursively delete all child windows reachable via the next, vchild,
5908 and hchild slots of WINDOW. */
5909 void
5910 delete_all_child_windows (Lisp_Object window)
5912 register struct window *w;
5914 w = XWINDOW (window);
5916 if (!NILP (w->next))
5917 /* Delete WINDOW's siblings (we traverse postorderly). */
5918 delete_all_child_windows (w->next);
5920 /* See Fset_window_configuration for excuse. */
5921 wset_total_lines (w, w->buffer);
5923 if (!NILP (w->vchild))
5925 delete_all_child_windows (w->vchild);
5926 wset_vchild (w, Qnil);
5928 else if (!NILP (w->hchild))
5930 delete_all_child_windows (w->hchild);
5931 wset_hchild (w, Qnil);
5933 else if (!NILP (w->buffer))
5935 unshow_buffer (w);
5936 unchain_marker (XMARKER (w->pointm));
5937 unchain_marker (XMARKER (w->start));
5938 wset_buffer (w, Qnil);
5941 Vwindow_list = Qnil;
5944 static int
5945 count_windows (register struct window *window)
5947 register int count = 1;
5948 if (!NILP (window->next))
5949 count += count_windows (XWINDOW (window->next));
5950 if (!NILP (window->vchild))
5951 count += count_windows (XWINDOW (window->vchild));
5952 if (!NILP (window->hchild))
5953 count += count_windows (XWINDOW (window->hchild));
5954 return count;
5958 /* Fill vector FLAT with leaf windows under W, starting at index I.
5959 Value is last index + 1. */
5960 static int
5961 get_leaf_windows (struct window *w, struct window **flat, int i)
5963 while (w)
5965 if (!NILP (w->hchild))
5966 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
5967 else if (!NILP (w->vchild))
5968 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
5969 else
5970 flat[i++] = w;
5972 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5975 return i;
5979 /* Return a pointer to the glyph W's physical cursor is on. Value is
5980 null if W's current matrix is invalid, so that no meaningful glyph
5981 can be returned. */
5982 struct glyph *
5983 get_phys_cursor_glyph (struct window *w)
5985 struct glyph_row *row;
5986 struct glyph *glyph;
5987 int hpos = w->phys_cursor.hpos;
5989 if (!(w->phys_cursor.vpos >= 0
5990 && w->phys_cursor.vpos < w->current_matrix->nrows))
5991 return NULL;
5993 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
5994 if (!row->enabled_p)
5995 return NULL;
5997 if (w->hscroll)
5999 /* When the window is hscrolled, cursor hpos can legitimately be
6000 out of bounds, but we draw the cursor at the corresponding
6001 window margin in that case. */
6002 if (!row->reversed_p && hpos < 0)
6003 hpos = 0;
6004 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
6005 hpos = row->used[TEXT_AREA] - 1;
6008 if (row->used[TEXT_AREA] > hpos
6009 && 0 <= hpos)
6010 glyph = row->glyphs[TEXT_AREA] + hpos;
6011 else
6012 glyph = NULL;
6014 return glyph;
6018 static int
6019 save_window_save (Lisp_Object window, struct Lisp_Vector *vector, int i)
6021 register struct saved_window *p;
6022 register struct window *w;
6023 register Lisp_Object tem, pers, par;
6025 for (;!NILP (window); window = w->next)
6027 p = SAVED_WINDOW_N (vector, i);
6028 w = XWINDOW (window);
6030 wset_temslot (w, make_number (i)); i++;
6031 p->window = window;
6032 p->buffer = w->buffer;
6033 p->left_col = w->left_col;
6034 p->top_line = w->top_line;
6035 p->total_cols = w->total_cols;
6036 p->total_lines = w->total_lines;
6037 p->normal_cols = w->normal_cols;
6038 p->normal_lines = w->normal_lines;
6039 XSETFASTINT (p->hscroll, w->hscroll);
6040 XSETFASTINT (p->min_hscroll, w->min_hscroll);
6041 p->display_table = w->display_table;
6042 p->left_margin_cols = w->left_margin_cols;
6043 p->right_margin_cols = w->right_margin_cols;
6044 p->left_fringe_width = w->left_fringe_width;
6045 p->right_fringe_width = w->right_fringe_width;
6046 p->fringes_outside_margins = w->fringes_outside_margins ? Qt : Qnil;
6047 p->scroll_bar_width = w->scroll_bar_width;
6048 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
6049 p->dedicated = w->dedicated;
6050 p->combination_limit = w->combination_limit;
6051 p->window_parameters = Qnil;
6053 if (!NILP (Vwindow_persistent_parameters))
6055 /* Run cycle detection on Vwindow_persistent_parameters. */
6056 Lisp_Object tortoise, hare;
6058 hare = tortoise = Vwindow_persistent_parameters;
6059 while (CONSP (hare))
6061 hare = XCDR (hare);
6062 if (!CONSP (hare))
6063 break;
6065 hare = XCDR (hare);
6066 tortoise = XCDR (tortoise);
6068 if (EQ (hare, tortoise))
6069 /* Reset Vwindow_persistent_parameters to Qnil. */
6071 Vwindow_persistent_parameters = Qnil;
6072 break;
6076 for (tem = Vwindow_persistent_parameters; CONSP (tem);
6077 tem = XCDR (tem))
6079 pers = XCAR (tem);
6080 /* Save values for persistent window parameters. */
6081 if (CONSP (pers) && !NILP (XCDR (pers)))
6083 par = Fassq (XCAR (pers), w->window_parameters);
6084 if (NILP (par))
6085 /* If the window has no value for the parameter,
6086 make one. */
6087 p->window_parameters = Fcons (Fcons (XCAR (pers), Qnil),
6088 p->window_parameters);
6089 else
6090 /* If the window has a value for the parameter,
6091 save it. */
6092 p->window_parameters = Fcons (Fcons (XCAR (par),
6093 XCDR (par)),
6094 p->window_parameters);
6099 if (!NILP (w->buffer))
6101 /* Save w's value of point in the window configuration. If w
6102 is the selected window, then get the value of point from
6103 the buffer; pointm is garbage in the selected window. */
6104 if (EQ (window, selected_window))
6105 p->pointm = build_marker (XBUFFER (w->buffer),
6106 BUF_PT (XBUFFER (w->buffer)),
6107 BUF_PT_BYTE (XBUFFER (w->buffer)));
6108 else
6109 p->pointm = Fcopy_marker (w->pointm, Qnil);
6110 XMARKER (p->pointm)->insertion_type
6111 = !NILP (Vwindow_point_insertion_type);
6113 p->start = Fcopy_marker (w->start, Qnil);
6114 p->start_at_line_beg = w->start_at_line_beg ? Qt : Qnil;
6116 tem = BVAR (XBUFFER (w->buffer), mark);
6117 p->mark = Fcopy_marker (tem, Qnil);
6119 else
6121 p->pointm = Qnil;
6122 p->start = Qnil;
6123 p->mark = Qnil;
6124 p->start_at_line_beg = Qnil;
6127 if (NILP (w->parent))
6128 p->parent = Qnil;
6129 else
6130 p->parent = XWINDOW (w->parent)->temslot;
6132 if (NILP (w->prev))
6133 p->prev = Qnil;
6134 else
6135 p->prev = XWINDOW (w->prev)->temslot;
6137 if (!NILP (w->vchild))
6138 i = save_window_save (w->vchild, vector, i);
6139 if (!NILP (w->hchild))
6140 i = save_window_save (w->hchild, vector, i);
6143 return i;
6146 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
6147 Scurrent_window_configuration, 0, 1, 0,
6148 doc: /* Return an object representing the current window configuration of FRAME.
6149 If FRAME is nil or omitted, use the selected frame.
6150 This describes the number of windows, their sizes and current buffers,
6151 and for each displayed buffer, where display starts, and the positions of
6152 point and mark. An exception is made for point in the current buffer:
6153 its value is -not- saved.
6154 This also records the currently selected frame, and FRAME's focus
6155 redirection (see `redirect-frame-focus'). The variable
6156 `window-persistent-parameters' specifies which window parameters are
6157 saved by this function. */)
6158 (Lisp_Object frame)
6160 register Lisp_Object tem;
6161 register int n_windows;
6162 register struct save_window_data *data;
6163 register int i;
6164 FRAME_PTR f;
6166 if (NILP (frame))
6167 frame = selected_frame;
6168 CHECK_LIVE_FRAME (frame);
6169 f = XFRAME (frame);
6171 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6172 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6173 PVEC_WINDOW_CONFIGURATION);
6175 data->frame_cols = FRAME_COLS (f);
6176 data->frame_lines = FRAME_LINES (f);
6177 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6178 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6179 data->selected_frame = selected_frame;
6180 data->current_window = FRAME_SELECTED_WINDOW (f);
6181 XSETBUFFER (data->current_buffer, current_buffer);
6182 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6183 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6184 data->root_window = FRAME_ROOT_WINDOW (f);
6185 data->focus_frame = FRAME_FOCUS_FRAME (f);
6186 tem = Fmake_vector (make_number (n_windows), Qnil);
6187 data->saved_windows = tem;
6188 for (i = 0; i < n_windows; i++)
6189 ASET (tem, i,
6190 Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil));
6191 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6192 XSETWINDOW_CONFIGURATION (tem, data);
6193 return (tem);
6196 /***********************************************************************
6197 Marginal Areas
6198 ***********************************************************************/
6200 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6201 2, 3, 0,
6202 doc: /* Set width of marginal areas of window WINDOW.
6203 WINDOW must be a live window and defaults to the selected one.
6205 Second arg LEFT-WIDTH specifies the number of character cells to
6206 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6207 does the same for the right marginal area. A nil width parameter
6208 means no margin. */)
6209 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width)
6211 struct window *w = decode_live_window (window);
6213 /* Translate negative or zero widths to nil.
6214 Margins that are too wide have to be checked elsewhere. */
6216 if (!NILP (left_width))
6218 CHECK_NUMBER (left_width);
6219 if (XINT (left_width) <= 0)
6220 left_width = Qnil;
6223 if (!NILP (right_width))
6225 CHECK_NUMBER (right_width);
6226 if (XINT (right_width) <= 0)
6227 right_width = Qnil;
6230 if (!EQ (w->left_margin_cols, left_width)
6231 || !EQ (w->right_margin_cols, right_width))
6233 wset_left_margin_cols (w, left_width);
6234 wset_right_margin_cols (w, right_width);
6236 adjust_window_margins (w);
6238 ++windows_or_buffers_changed;
6239 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6242 return Qnil;
6246 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6247 0, 1, 0,
6248 doc: /* Get width of marginal areas of window WINDOW.
6249 WINDOW must be a live window and defaults to the selected one.
6251 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6252 If a marginal area does not exist, its width will be returned
6253 as nil. */)
6254 (Lisp_Object window)
6256 struct window *w = decode_live_window (window);
6257 return Fcons (w->left_margin_cols, w->right_margin_cols);
6262 /***********************************************************************
6263 Fringes
6264 ***********************************************************************/
6266 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6267 2, 4, 0,
6268 doc: /* Set the fringe widths of window WINDOW.
6269 WINDOW must be a live window and defaults to the selected one.
6271 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6272 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6273 fringe width. If a fringe width arg is nil, that means to use the
6274 frame's default fringe width. Default fringe widths can be set with
6275 the command `set-fringe-style'.
6276 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6277 outside of the display margins. By default, fringes are drawn between
6278 display marginal areas and the text area. */)
6279 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width, Lisp_Object outside_margins)
6281 struct window *w = decode_live_window (window);
6282 int outside = !NILP (outside_margins);
6284 if (!NILP (left_width))
6285 CHECK_NATNUM (left_width);
6286 if (!NILP (right_width))
6287 CHECK_NATNUM (right_width);
6289 /* Do nothing on a tty. */
6290 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6291 && (!EQ (w->left_fringe_width, left_width)
6292 || !EQ (w->right_fringe_width, right_width)
6293 || w->fringes_outside_margins != outside))
6295 wset_left_fringe_width (w, left_width);
6296 wset_right_fringe_width (w, right_width);
6297 w->fringes_outside_margins = outside;
6299 adjust_window_margins (w);
6301 clear_glyph_matrix (w->current_matrix);
6302 wset_window_end_valid (w, Qnil);
6304 ++windows_or_buffers_changed;
6305 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6308 return Qnil;
6312 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6313 0, 1, 0,
6314 doc: /* Get width of fringes of window WINDOW.
6315 WINDOW must be a live window and defaults to the selected one.
6317 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6318 (Lisp_Object window)
6320 struct window *w = decode_live_window (window);
6322 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6323 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6324 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6325 ? Qt : Qnil), Qnil)));
6330 /***********************************************************************
6331 Scroll bars
6332 ***********************************************************************/
6334 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars,
6335 Sset_window_scroll_bars, 2, 4, 0,
6336 doc: /* Set width and type of scroll bars of window WINDOW.
6337 WINDOW must be a live window and defaults to the selected one.
6339 Second parameter WIDTH specifies the pixel width for the scroll bar;
6340 this is automatically adjusted to a multiple of the frame column width.
6341 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6342 bar: left, right, or nil.
6343 If WIDTH is nil, use the frame's scroll-bar width.
6344 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6345 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6346 (Lisp_Object window, Lisp_Object width, Lisp_Object vertical_type, Lisp_Object horizontal_type)
6348 struct window *w = decode_live_window (window);
6350 if (!NILP (width))
6352 CHECK_RANGED_INTEGER (width, 0, INT_MAX);
6354 if (XINT (width) == 0)
6355 vertical_type = Qnil;
6358 if (!(NILP (vertical_type)
6359 || EQ (vertical_type, Qleft)
6360 || EQ (vertical_type, Qright)
6361 || EQ (vertical_type, Qt)))
6362 error ("Invalid type of vertical scroll bar");
6364 if (!EQ (w->scroll_bar_width, width)
6365 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6367 wset_scroll_bar_width (w, width);
6368 wset_vertical_scroll_bar_type (w, vertical_type);
6370 adjust_window_margins (w);
6372 clear_glyph_matrix (w->current_matrix);
6373 wset_window_end_valid (w, Qnil);
6375 ++windows_or_buffers_changed;
6376 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6379 return Qnil;
6383 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6384 0, 1, 0,
6385 doc: /* Get width and type of scroll bars of window WINDOW.
6386 WINDOW must be a live window and defaults to the selected one.
6388 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6389 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6390 value. */)
6391 (Lisp_Object window)
6393 struct window *w = decode_live_window (window);
6394 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6395 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6396 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6397 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
6398 Fcons (w->vertical_scroll_bar_type,
6399 Fcons (Qnil, Qnil))));
6404 /***********************************************************************
6405 Smooth scrolling
6406 ***********************************************************************/
6408 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6409 doc: /* Return the amount by which WINDOW is scrolled vertically.
6410 If WINDOW is omitted or nil, it defaults to the selected window.
6411 Normally, value is a multiple of the canonical character height of WINDOW;
6412 optional second arg PIXELS-P means value is measured in pixels. */)
6413 (Lisp_Object window, Lisp_Object pixels_p)
6415 Lisp_Object result;
6416 struct window *w = decode_live_window (window);
6417 struct frame *f = XFRAME (w->frame);
6419 if (FRAME_WINDOW_P (f))
6420 result = (NILP (pixels_p)
6421 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
6422 : make_number (-w->vscroll));
6423 else
6424 result = make_number (0);
6425 return result;
6429 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
6430 2, 3, 0,
6431 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6432 WINDOW nil means use the selected window. Normally, VSCROLL is a
6433 non-negative multiple of the canonical character height of WINDOW;
6434 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6435 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6436 corresponds to an integral number of pixels. The return value is the
6437 result of this rounding.
6438 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6439 (Lisp_Object window, Lisp_Object vscroll, Lisp_Object pixels_p)
6441 struct window *w = decode_live_window (window);
6442 struct frame *f = XFRAME (w->frame);
6444 CHECK_NUMBER_OR_FLOAT (vscroll);
6446 if (FRAME_WINDOW_P (f))
6448 int old_dy = w->vscroll;
6450 w->vscroll = - (NILP (pixels_p)
6451 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6452 : XFLOATINT (vscroll));
6453 w->vscroll = min (w->vscroll, 0);
6455 if (w->vscroll != old_dy)
6457 /* Adjust glyph matrix of the frame if the virtual display
6458 area becomes larger than before. */
6459 if (w->vscroll < 0 && w->vscroll < old_dy)
6460 adjust_glyphs (f);
6462 /* Prevent redisplay shortcuts. */
6463 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
6467 return Fwindow_vscroll (window, pixels_p);
6471 /* Call FN for all leaf windows on frame F. FN is called with the
6472 first argument being a pointer to the leaf window, and with
6473 additional argument USER_DATA. Stops when FN returns 0. */
6475 static void
6476 foreach_window (struct frame *f, int (*fn) (struct window *, void *),
6477 void *user_data)
6479 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6480 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6481 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6485 /* Helper function for foreach_window. Call FN for all leaf windows
6486 reachable from W. FN is called with the first argument being a
6487 pointer to the leaf window, and with additional argument USER_DATA.
6488 Stop when FN returns 0. Value is 0 if stopped by FN. */
6490 static int
6491 foreach_window_1 (struct window *w, int (*fn) (struct window *, void *), void *user_data)
6493 int cont;
6495 for (cont = 1; w && cont;)
6497 if (!NILP (w->hchild))
6498 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6499 else if (!NILP (w->vchild))
6500 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6501 else
6502 cont = fn (w, user_data);
6504 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6507 return cont;
6511 /* Freeze or unfreeze the window start of W unless it is a
6512 mini-window or the selected window. FREEZE_P non-null means freeze
6513 the window start. */
6515 static int
6516 freeze_window_start (struct window *w, void *freeze_p)
6518 if (MINI_WINDOW_P (w)
6519 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6520 && (w == XWINDOW (selected_window)
6521 || (MINI_WINDOW_P (XWINDOW (selected_window))
6522 && ! NILP (Vminibuf_scroll_window)
6523 && w == XWINDOW (Vminibuf_scroll_window)))))
6524 freeze_p = NULL;
6526 w->frozen_window_start_p = freeze_p != NULL;
6527 return 1;
6531 /* Freeze or unfreeze the window starts of all leaf windows on frame
6532 F, except the selected window and a mini-window. FREEZE_P non-zero
6533 means freeze the window start. */
6535 void
6536 freeze_window_starts (struct frame *f, int freeze_p)
6538 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6542 /***********************************************************************
6543 Initialization
6544 ***********************************************************************/
6546 /* Return 1 if window configurations CONFIGURATION1 and CONFIGURATION2
6547 describe the same state of affairs. This is used by Fequal.
6549 IGNORE_POSITIONS means ignore non-matching scroll positions
6550 and the like.
6552 This ignores a couple of things like the dedication status of
6553 window, combination_limit and the like. This might have to be
6554 fixed. */
6556 bool
6557 compare_window_configurations (Lisp_Object configuration1,
6558 Lisp_Object configuration2,
6559 bool ignore_positions)
6561 register struct save_window_data *d1, *d2;
6562 struct Lisp_Vector *sws1, *sws2;
6563 ptrdiff_t i;
6565 CHECK_WINDOW_CONFIGURATION (configuration1);
6566 CHECK_WINDOW_CONFIGURATION (configuration2);
6568 d1 = (struct save_window_data *) XVECTOR (configuration1);
6569 d2 = (struct save_window_data *) XVECTOR (configuration2);
6570 sws1 = XVECTOR (d1->saved_windows);
6571 sws2 = XVECTOR (d2->saved_windows);
6573 /* Frame settings must match. */
6574 if (d1->frame_cols != d2->frame_cols
6575 || d1->frame_lines != d2->frame_lines
6576 || d1->frame_menu_bar_lines != d2->frame_menu_bar_lines
6577 || !EQ (d1->selected_frame, d2->selected_frame)
6578 || !EQ (d1->current_buffer, d2->current_buffer)
6579 || (!ignore_positions
6580 && (!EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window)
6581 || !EQ (d1->minibuf_selected_window, d2->minibuf_selected_window)))
6582 || !EQ (d1->focus_frame, d2->focus_frame)
6583 /* Verify that the two configurations have the same number of windows. */
6584 || sws1->header.size != sws2->header.size)
6585 return 0;
6587 for (i = 0; i < sws1->header.size; i++)
6589 struct saved_window *sw1, *sw2;
6591 sw1 = SAVED_WINDOW_N (sws1, i);
6592 sw2 = SAVED_WINDOW_N (sws2, i);
6594 if (
6595 /* The "current" windows in the two configurations must
6596 correspond to each other. */
6597 EQ (d1->current_window, sw1->window)
6598 != EQ (d2->current_window, sw2->window)
6599 /* Windows' buffers must match. */
6600 || !EQ (sw1->buffer, sw2->buffer)
6601 || !EQ (sw1->left_col, sw2->left_col)
6602 || !EQ (sw1->top_line, sw2->top_line)
6603 || !EQ (sw1->total_cols, sw2->total_cols)
6604 || !EQ (sw1->total_lines, sw2->total_lines)
6605 || !EQ (sw1->display_table, sw2->display_table)
6606 /* The next two disjuncts check the window structure for
6607 equality. */
6608 || !EQ (sw1->parent, sw2->parent)
6609 || !EQ (sw1->prev, sw2->prev)
6610 || (!ignore_positions
6611 && (!EQ (sw1->hscroll, sw2->hscroll)
6612 || !EQ (sw1->min_hscroll, sw2->min_hscroll)
6613 || !EQ (sw1->start_at_line_beg, sw2->start_at_line_beg)
6614 || NILP (Fequal (sw1->start, sw2->start))
6615 || NILP (Fequal (sw1->pointm, sw2->pointm))
6616 || NILP (Fequal (sw1->mark, sw2->mark))))
6617 || !EQ (sw1->left_margin_cols, sw2->left_margin_cols)
6618 || !EQ (sw1->right_margin_cols, sw2->right_margin_cols)
6619 || !EQ (sw1->left_fringe_width, sw2->left_fringe_width)
6620 || !EQ (sw1->right_fringe_width, sw2->right_fringe_width)
6621 || !EQ (sw1->fringes_outside_margins, sw2->fringes_outside_margins)
6622 || !EQ (sw1->scroll_bar_width, sw2->scroll_bar_width)
6623 || !EQ (sw1->vertical_scroll_bar_type, sw2->vertical_scroll_bar_type))
6624 return 0;
6627 return 1;
6630 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
6631 Scompare_window_configurations, 2, 2, 0,
6632 doc: /* Compare two window configurations as regards the structure of windows.
6633 This function ignores details such as the values of point and mark
6634 and scrolling positions. */)
6635 (Lisp_Object x, Lisp_Object y)
6637 if (compare_window_configurations (x, y, 1))
6638 return Qt;
6639 return Qnil;
6642 void
6643 init_window_once (void)
6645 struct frame *f = make_initial_frame ();
6646 XSETFRAME (selected_frame, f);
6647 Vterminal_frame = selected_frame;
6648 minibuf_window = f->minibuffer_window;
6649 selected_window = f->selected_window;
6650 last_nonminibuf_frame = f;
6652 window_initialized = 1;
6655 void
6656 init_window (void)
6658 Vwindow_list = Qnil;
6661 void
6662 syms_of_window (void)
6664 DEFSYM (Qscroll_up, "scroll-up");
6665 DEFSYM (Qscroll_down, "scroll-down");
6666 DEFSYM (Qscroll_command, "scroll-command");
6668 Fput (Qscroll_up, Qscroll_command, Qt);
6669 Fput (Qscroll_down, Qscroll_command, Qt);
6671 DEFSYM (Qwindow_configuration_change_hook, "window-configuration-change-hook");
6672 DEFSYM (Qwindowp, "windowp");
6673 DEFSYM (Qwindow_configuration_p, "window-configuration-p");
6674 DEFSYM (Qwindow_live_p, "window-live-p");
6675 DEFSYM (Qwindow_valid_p, "window-valid-p");
6676 DEFSYM (Qwindow_deletable_p, "window-deletable-p");
6677 DEFSYM (Qdelete_window, "delete-window");
6678 DEFSYM (Qwindow_resize_root_window, "window--resize-root-window");
6679 DEFSYM (Qwindow_resize_root_window_vertically, "window--resize-root-window-vertically");
6680 DEFSYM (Qsafe, "safe");
6681 DEFSYM (Qdisplay_buffer, "display-buffer");
6682 DEFSYM (Qreplace_buffer_in_windows, "replace-buffer-in-windows");
6683 DEFSYM (Qrecord_window_buffer, "record-window-buffer");
6684 DEFSYM (Qget_mru_window, "get-mru-window");
6685 DEFSYM (Qwindow_size, "window-size");
6686 DEFSYM (Qtemp_buffer_show_hook, "temp-buffer-show-hook");
6687 DEFSYM (Qabove, "above");
6688 DEFSYM (Qbelow, "below");
6689 DEFSYM (Qclone_of, "clone-of");
6691 staticpro (&Vwindow_list);
6693 minibuf_selected_window = Qnil;
6694 staticpro (&minibuf_selected_window);
6696 window_scroll_pixel_based_preserve_x = -1;
6697 window_scroll_pixel_based_preserve_y = -1;
6698 window_scroll_preserve_hpos = -1;
6699 window_scroll_preserve_vpos = -1;
6701 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function,
6702 doc: /* Non-nil means call as function to display a help buffer.
6703 The function is called with one argument, the buffer to be displayed.
6704 Used by `with-output-to-temp-buffer'.
6705 If this function is used, then it must do the entire job of showing
6706 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
6707 Vtemp_buffer_show_function = Qnil;
6709 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window,
6710 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
6711 Vminibuf_scroll_window = Qnil;
6713 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows,
6714 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
6715 If the minibuffer is active, the `minibuffer-scroll-window' mode line
6716 is displayed in the `mode-line' face. */);
6717 mode_line_in_non_selected_windows = 1;
6719 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer,
6720 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
6721 Vother_window_scroll_buffer = Qnil;
6723 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p,
6724 doc: /* Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
6725 auto_window_vscroll_p = 1;
6727 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines,
6728 doc: /* Number of lines of continuity when scrolling by screenfuls. */);
6729 next_screen_context_lines = 2;
6731 DEFVAR_LISP ("scroll-preserve-screen-position",
6732 Vscroll_preserve_screen_position,
6733 doc: /* Controls if scroll commands move point to keep its screen position unchanged.
6734 A value of nil means point does not keep its screen position except
6735 at the scroll margin or window boundary respectively.
6736 A value of t means point keeps its screen position if the scroll
6737 command moved it vertically out of the window, e.g. when scrolling
6738 by full screens.
6739 Any other value means point always keeps its screen position.
6740 Scroll commands should have the `scroll-command' property
6741 on their symbols to be controlled by this variable. */);
6742 Vscroll_preserve_screen_position = Qnil;
6744 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type,
6745 doc: /* Type of marker to use for `window-point'. */);
6746 Vwindow_point_insertion_type = Qnil;
6748 DEFVAR_LISP ("window-configuration-change-hook",
6749 Vwindow_configuration_change_hook,
6750 doc: /* Functions to call when window configuration changes.
6751 The buffer-local part is run once per window, with the relevant window
6752 selected; while the global part is run only once for the modified frame,
6753 with the relevant frame selected. */);
6754 Vwindow_configuration_change_hook = Qnil;
6756 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay,
6757 doc: /* Non-nil means `recenter' redraws entire frame.
6758 If this option is non-nil, then the `recenter' command with a nil
6759 argument will redraw the entire frame; the special value `tty' causes
6760 the frame to be redrawn only if it is a tty frame. */);
6761 Vrecenter_redisplay = Qtty;
6763 DEFVAR_LISP ("window-combination-resize", Vwindow_combination_resize,
6764 doc: /* If t, resize window combinations proportionally.
6765 If this variable is nil, splitting a window gets the entire screen space
6766 for displaying the new window from the window to split. Deleting and
6767 resizing a window preferably resizes one adjacent window only.
6769 If this variable is t, splitting a window tries to get the space
6770 proportionally from all windows in the same combination. This also
6771 allows to split a window that is otherwise too small or of fixed size.
6772 Resizing and deleting a window proportionally resize all windows in the
6773 same combination.
6775 Other values are reserved for future use.
6777 This variable takes no effect if `window-combination-limit' is non-nil. */);
6778 Vwindow_combination_resize = Qnil;
6780 DEFVAR_LISP ("window-combination-limit", Vwindow_combination_limit,
6781 doc: /* If non-nil, splitting a window makes a new parent window.
6782 The following values are recognized:
6784 nil means splitting a window will create a new parent window only if the
6785 window has no parent window or the window shall become part of a
6786 combination orthogonal to the one it is part of.
6788 `window-size' means that splitting a window for displaying a buffer
6789 makes a new parent window provided `display-buffer' is supposed to
6790 explicitly set the window's size due to the presence of a
6791 `window-height' or `window-width' entry in the alist used by
6792 `display-buffer'. Otherwise, this value is handled like nil.
6794 `temp-buffer' means that splitting a window for displaying a temporary
6795 buffer always makes a new parent window. Otherwise, this value is
6796 handled like nil.
6798 `display-buffer' means that splitting a window for displaying a buffer
6799 always makes a new parent window. Since temporary buffers are
6800 displayed by the function `display-buffer', this value is stronger
6801 than `temp-buffer'. Splitting a window for other purpose makes a
6802 new parent window only if needed.
6804 t means that splitting a window always creates a new parent window. If
6805 all splits behave this way, each frame's window tree is a binary
6806 tree and every window but the frame's root window has exactly one
6807 sibling.
6809 Other values are reserved for future use. */);
6810 Vwindow_combination_limit = Qwindow_size;
6812 DEFVAR_LISP ("window-persistent-parameters", Vwindow_persistent_parameters,
6813 doc: /* Alist of persistent window parameters.
6814 This alist specifies which window parameters shall get saved by
6815 `current-window-configuration' and `window-state-get' and subsequently
6816 restored to their previous values by `set-window-configuration' and
6817 `window-state-put'.
6819 The car of each entry of this alist is the symbol specifying the
6820 parameter. The cdr is one of the following:
6822 nil means the parameter is neither saved by `window-state-get' nor by
6823 `current-window-configuration'.
6825 t means the parameter is saved by `current-window-configuration' and,
6826 provided its WRITABLE argument is nil, by `window-state-get'.
6828 The symbol `writable' means the parameter is saved unconditionally by
6829 both `current-window-configuration' and `window-state-get'. Do not use
6830 this value for parameters without read syntax (like windows or frames).
6832 Parameters not saved by `current-window-configuration' or
6833 `window-state-get' are left alone by `set-window-configuration'
6834 respectively are not installed by `window-state-put'. */);
6835 Vwindow_persistent_parameters = list1 (Fcons (Qclone_of, Qt));
6837 defsubr (&Sselected_window);
6838 defsubr (&Sminibuffer_window);
6839 defsubr (&Swindow_minibuffer_p);
6840 defsubr (&Swindowp);
6841 defsubr (&Swindow_valid_p);
6842 defsubr (&Swindow_live_p);
6843 defsubr (&Swindow_frame);
6844 defsubr (&Sframe_root_window);
6845 defsubr (&Sframe_first_window);
6846 defsubr (&Sframe_selected_window);
6847 defsubr (&Sset_frame_selected_window);
6848 defsubr (&Spos_visible_in_window_p);
6849 defsubr (&Swindow_line_height);
6850 defsubr (&Swindow_buffer);
6851 defsubr (&Swindow_parent);
6852 defsubr (&Swindow_top_child);
6853 defsubr (&Swindow_left_child);
6854 defsubr (&Swindow_next_sibling);
6855 defsubr (&Swindow_prev_sibling);
6856 defsubr (&Swindow_combination_limit);
6857 defsubr (&Sset_window_combination_limit);
6858 defsubr (&Swindow_use_time);
6859 defsubr (&Swindow_top_line);
6860 defsubr (&Swindow_left_column);
6861 defsubr (&Swindow_total_height);
6862 defsubr (&Swindow_total_width);
6863 defsubr (&Swindow_normal_size);
6864 defsubr (&Swindow_new_total);
6865 defsubr (&Swindow_new_normal);
6866 defsubr (&Sset_window_new_total);
6867 defsubr (&Sset_window_new_normal);
6868 defsubr (&Swindow_resize_apply);
6869 defsubr (&Swindow_body_height);
6870 defsubr (&Swindow_body_width);
6871 defsubr (&Swindow_hscroll);
6872 defsubr (&Sset_window_hscroll);
6873 defsubr (&Swindow_redisplay_end_trigger);
6874 defsubr (&Sset_window_redisplay_end_trigger);
6875 defsubr (&Swindow_edges);
6876 defsubr (&Swindow_pixel_edges);
6877 defsubr (&Swindow_absolute_pixel_edges);
6878 defsubr (&Swindow_inside_edges);
6879 defsubr (&Swindow_inside_pixel_edges);
6880 defsubr (&Swindow_inside_absolute_pixel_edges);
6881 defsubr (&Scoordinates_in_window_p);
6882 defsubr (&Swindow_at);
6883 defsubr (&Swindow_point);
6884 defsubr (&Swindow_start);
6885 defsubr (&Swindow_end);
6886 defsubr (&Sset_window_point);
6887 defsubr (&Sset_window_start);
6888 defsubr (&Swindow_dedicated_p);
6889 defsubr (&Sset_window_dedicated_p);
6890 defsubr (&Swindow_display_table);
6891 defsubr (&Sset_window_display_table);
6892 defsubr (&Snext_window);
6893 defsubr (&Sprevious_window);
6894 defsubr (&Sget_buffer_window);
6895 defsubr (&Sdelete_other_windows_internal);
6896 defsubr (&Sdelete_window_internal);
6897 defsubr (&Sresize_mini_window_internal);
6898 defsubr (&Sset_window_buffer);
6899 defsubr (&Srun_window_configuration_change_hook);
6900 defsubr (&Sselect_window);
6901 defsubr (&Sforce_window_update);
6902 defsubr (&Ssplit_window_internal);
6903 defsubr (&Sscroll_up);
6904 defsubr (&Sscroll_down);
6905 defsubr (&Sscroll_left);
6906 defsubr (&Sscroll_right);
6907 defsubr (&Sother_window_for_scrolling);
6908 defsubr (&Sscroll_other_window);
6909 defsubr (&Sminibuffer_selected_window);
6910 defsubr (&Srecenter);
6911 defsubr (&Swindow_text_height);
6912 defsubr (&Smove_to_window_line);
6913 defsubr (&Swindow_configuration_p);
6914 defsubr (&Swindow_configuration_frame);
6915 defsubr (&Sset_window_configuration);
6916 defsubr (&Scurrent_window_configuration);
6917 defsubr (&Sset_window_margins);
6918 defsubr (&Swindow_margins);
6919 defsubr (&Sset_window_fringes);
6920 defsubr (&Swindow_fringes);
6921 defsubr (&Sset_window_scroll_bars);
6922 defsubr (&Swindow_scroll_bars);
6923 defsubr (&Swindow_vscroll);
6924 defsubr (&Sset_window_vscroll);
6925 defsubr (&Scompare_window_configurations);
6926 defsubr (&Swindow_list);
6927 defsubr (&Swindow_list_1);
6928 defsubr (&Swindow_prev_buffers);
6929 defsubr (&Sset_window_prev_buffers);
6930 defsubr (&Swindow_next_buffers);
6931 defsubr (&Sset_window_next_buffers);
6932 defsubr (&Swindow_parameters);
6933 defsubr (&Swindow_parameter);
6934 defsubr (&Sset_window_parameter);
6937 void
6938 keys_of_window (void)
6940 initial_define_key (control_x_map, '<', "scroll-left");
6941 initial_define_key (control_x_map, '>', "scroll-right");
6943 initial_define_key (global_map, Ctl ('V'), "scroll-up-command");
6944 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
6945 initial_define_key (meta_map, 'v', "scroll-down-command");