vc-hooks.el workaround for bug#11490
[emacs.git] / src / window.c
blob4981b8cd7c07ad668df1d61fe8c7ae64ef45a7cc
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 If the return value is nil, child windows of WINDOW can be recombined
604 with WINDOW's siblings. A return value of t means that child windows of
605 WINDOW are never \(re-)combined with WINDOW's siblings.
607 WINDOW must be a valid window. The return value is meaningful for
608 internal windows only. */)
609 (Lisp_Object window)
611 return decode_valid_window (window)->combination_limit;
614 DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
615 doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
616 If LIMIT is nil, child windows of WINDOW can be recombined with WINDOW's
617 siblings. LIMIT t means that child windows of WINDOW are never
618 \(re-)combined with WINDOW's siblings. Other values are reserved for
619 future use.
621 WINDOW must be a valid window. Setting the combination limit is
622 meaningful for internal windows only. */)
623 (Lisp_Object window, Lisp_Object limit)
625 wset_combination_limit (decode_valid_window (window), limit);
626 return limit;
629 DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
630 doc: /* Return the use time of window WINDOW.
631 WINDOW must be a live window and defaults to the selected one.
632 The window with the highest use time is the most recently selected
633 one. The window with the lowest use time is the least recently
634 selected one. */)
635 (Lisp_Object window)
637 return make_number (decode_live_window (window)->use_time);
640 DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
641 doc: /* Return the total height, in lines, of window WINDOW.
642 WINDOW must be a valid window and defaults to the selected one.
644 The return value includes the mode line and header line, if any.
645 If WINDOW is an internal window, the total height is the height
646 of the screen areas spanned by its children.
648 On a graphical display, this total height is reported as an
649 integer multiple of the default character height. */)
650 (Lisp_Object window)
652 return decode_valid_window (window)->total_lines;
655 DEFUN ("window-total-width", Fwindow_total_width, Swindow_total_width, 0, 1, 0,
656 doc: /* Return the total width, in columns, of window WINDOW.
657 WINDOW must be a valid window and defaults to the selected one.
659 The return value includes any vertical dividers or scroll bars
660 belonging to WINDOW. If WINDOW is an internal window, the total width
661 is the width of the screen areas spanned by its children.
663 On a graphical display, this total width is reported as an
664 integer multiple of the default character width. */)
665 (Lisp_Object window)
667 return decode_valid_window (window)->total_cols;
670 DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
671 doc: /* Return the new total size of window WINDOW.
672 WINDOW must be a valid window and defaults to the selected one. */)
673 (Lisp_Object window)
675 return decode_valid_window (window)->new_total;
678 DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
679 doc: /* Return the normal height of window WINDOW.
680 WINDOW must be a valid window and defaults to the selected one.
681 If HORIZONTAL is non-nil, return the normal width of WINDOW. */)
682 (Lisp_Object window, Lisp_Object horizontal)
684 struct window *w = decode_valid_window (window);
686 return NILP (horizontal) ? w->normal_lines : w->normal_cols;
689 DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
690 doc: /* Return new normal size of window WINDOW.
691 WINDOW must be a valid window and defaults to the selected one. */)
692 (Lisp_Object window)
694 return decode_valid_window (window)->new_normal;
697 DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
698 doc: /* Return left column of window WINDOW.
699 This is the distance, in columns, between the left edge of WINDOW and
700 the left edge of the frame's window area. For instance, the return
701 value is 0 if there is no window to the left of WINDOW.
703 WINDOW must be a valid window and defaults to the selected one. */)
704 (Lisp_Object window)
706 return decode_valid_window (window)->left_col;
709 DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
710 doc: /* Return top line of window WINDOW.
711 This is the distance, in lines, between the top of WINDOW and the top
712 of the frame's window area. For instance, the return value is 0 if
713 there is no window above WINDOW.
715 WINDOW must be a valid window and defaults to the selected one. */)
716 (Lisp_Object window)
718 return decode_valid_window (window)->top_line;
721 /* Return the number of lines of W's body. Don't count any mode or
722 header line of W. */
724 static int
725 window_body_lines (struct window *w)
727 int height = XFASTINT (w->total_lines);
729 if (!MINI_WINDOW_P (w))
731 if (WINDOW_WANTS_MODELINE_P (w))
732 --height;
733 if (WINDOW_WANTS_HEADER_LINE_P (w))
734 --height;
737 return height;
740 /* Return the number of columns of W's body. Don't count columns
741 occupied by the scroll bar or the vertical bar separating W from its
742 right sibling. On window-systems don't count fringes or display
743 margins either. */
746 window_body_cols (struct window *w)
748 struct frame *f = XFRAME (WINDOW_FRAME (w));
749 int width = XINT (w->total_cols);
751 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
752 /* Scroll bars occupy a few columns. */
753 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
754 else if (!FRAME_WINDOW_P (f)
755 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
756 /* The column of `|' characters separating side-by-side windows
757 occupies one column only. */
758 width -= 1;
760 if (FRAME_WINDOW_P (f))
761 /* On window-systems, fringes and display margins cannot be
762 used for normal text. */
763 width -= (WINDOW_FRINGE_COLS (w)
764 + WINDOW_LEFT_MARGIN_COLS (w)
765 + WINDOW_RIGHT_MARGIN_COLS (w));
767 return width;
770 DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 1, 0,
771 doc: /* Return the height, in lines, of WINDOW's text area.
772 WINDOW must be a live window and defaults to the selected one.
774 The returned height does not include the mode line or header line.
775 On a graphical display, the height is expressed as an integer multiple
776 of the default character height. If a line at the bottom of the text
777 area is only partially visible, that counts as a whole line; to
778 exclude partially-visible lines, use `window-text-height'. */)
779 (Lisp_Object window)
781 struct window *w = decode_live_window (window);
782 return make_number (window_body_lines (w));
785 DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 1, 0,
786 doc: /* Return the width, in columns, of WINDOW's text area.
787 WINDOW must be a live window and defaults to the selected one.
789 The return value does not include any vertical dividers, fringe or
790 marginal areas, or scroll bars. On a graphical display, the width is
791 expressed as an integer multiple of the default character width. */)
792 (Lisp_Object window)
794 struct window *w = decode_live_window (window);
795 return make_number (window_body_cols (w));
798 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
799 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
800 WINDOW must be a live window and defaults to the selected one. */)
801 (Lisp_Object window)
803 return make_number (decode_live_window (window)->hscroll);
806 /* Set W's horizontal scroll amount to HSCROLL clipped to a reasonable
807 range, returning the new amount as a fixnum. */
808 static Lisp_Object
809 set_window_hscroll (struct window *w, EMACS_INT hscroll)
811 /* Horizontal scrolling has problems with large scroll amounts.
812 It's too slow with long lines, and even with small lines the
813 display can be messed up. For now, though, impose only the limits
814 required by the internal representation: horizontal scrolling must
815 fit in fixnum (since it's visible to Elisp) and into ptrdiff_t
816 (since it's stored in a ptrdiff_t). */
817 ptrdiff_t hscroll_max = min (MOST_POSITIVE_FIXNUM, PTRDIFF_MAX);
818 ptrdiff_t new_hscroll = clip_to_bounds (0, hscroll, hscroll_max);
820 /* Prevent redisplay shortcuts when changing the hscroll. */
821 if (w->hscroll != new_hscroll)
822 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
824 w->hscroll = new_hscroll;
825 return make_number (new_hscroll);
828 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
829 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
830 WINDOW must be a live window and defaults to the selected one.
831 Clip the number to a reasonable value if out of range.
832 Return the new number. NCOL should be zero or positive.
834 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
835 window so that the location of point moves off-window. */)
836 (Lisp_Object window, Lisp_Object ncol)
838 struct window *w = decode_live_window (window);
840 CHECK_NUMBER (ncol);
841 return set_window_hscroll (w, XINT (ncol));
844 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
845 Swindow_redisplay_end_trigger, 0, 1, 0,
846 doc: /* Return WINDOW's redisplay end trigger value.
847 WINDOW must be a live window and defaults to the selected one.
848 See `set-window-redisplay-end-trigger' for more information. */)
849 (Lisp_Object window)
851 return decode_live_window (window)->redisplay_end_trigger;
854 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
855 Sset_window_redisplay_end_trigger, 2, 2, 0,
856 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
857 WINDOW must be a live window and defaults to the selected one. VALUE
858 should be a buffer position (typically a marker) or nil. If it is a
859 buffer position, then if redisplay in WINDOW reaches a position beyond
860 VALUE, the functions in `redisplay-end-trigger-functions' are called
861 with two arguments: WINDOW, and the end trigger value. Afterwards the
862 end-trigger value is reset to nil. */)
863 (register Lisp_Object window, Lisp_Object value)
865 wset_redisplay_end_trigger (decode_live_window (window), value);
866 return value;
869 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
870 doc: /* Return a list of the edge coordinates of WINDOW.
871 WINDOW must be a valid window and defaults to the selected one.
873 The returned list has the form (LEFT TOP RIGHT BOTTOM). TOP and BOTTOM
874 count by lines, and LEFT and RIGHT count by columns, all relative to 0,
875 0 at top left corner of frame.
877 RIGHT is one more than the rightmost column occupied by WINDOW. BOTTOM
878 is one more than the bottommost row occupied by WINDOW. The edges
879 include the space used by WINDOW's scroll bar, display margins, fringes,
880 header line, and/or mode line. For the edges of just the text area, use
881 `window-inside-edges'. */)
882 (Lisp_Object window)
884 register struct window *w = decode_valid_window (window);
886 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
887 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
888 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
889 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
890 Qnil))));
893 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
894 doc: /* Return a list of the edge pixel coordinates of WINDOW.
895 WINDOW must be a valid window and defaults to the selected one.
897 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
898 0, 0 at the top left corner of the frame.
900 RIGHT is one more than the rightmost x position occupied by WINDOW.
901 BOTTOM is one more than the bottommost y position occupied by WINDOW.
902 The pixel edges include the space used by WINDOW's scroll bar, display
903 margins, fringes, header line, and/or mode line. For the pixel edges
904 of just the text area, use `window-inside-pixel-edges'. */)
905 (Lisp_Object window)
907 register struct window *w = decode_valid_window (window);
909 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
910 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
911 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
912 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
913 Qnil))));
916 static void
917 calc_absolute_offset (struct window *w, int *add_x, int *add_y)
919 struct frame *f = XFRAME (w->frame);
920 *add_y = f->top_pos;
921 #ifdef FRAME_MENUBAR_HEIGHT
922 *add_y += FRAME_MENUBAR_HEIGHT (f);
923 #endif
924 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
925 *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
926 #elif FRAME_TOOLBAR_HEIGHT
927 *add_y += FRAME_TOOLBAR_HEIGHT (f);
928 #endif
929 #ifdef FRAME_NS_TITLEBAR_HEIGHT
930 *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
931 #endif
932 *add_x = f->left_pos;
933 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
934 *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
935 #endif
938 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
939 Swindow_absolute_pixel_edges, 0, 1, 0,
940 doc: /* Return a list of the edge pixel coordinates of WINDOW.
941 WINDOW must be a valid window and defaults to the selected one.
943 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
944 0, 0 at the top left corner of the display.
946 RIGHT is one more than the rightmost x position occupied by WINDOW.
947 BOTTOM is one more than the bottommost y position occupied by WINDOW.
948 The pixel edges include the space used by WINDOW's scroll bar, display
949 margins, fringes, header line, and/or mode line. For the pixel edges
950 of just the text area, use `window-inside-absolute-pixel-edges'. */)
951 (Lisp_Object window)
953 register struct window *w = decode_valid_window (window);
954 int add_x, add_y;
955 calc_absolute_offset (w, &add_x, &add_y);
957 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w) + add_x),
958 Fcons (make_number (WINDOW_TOP_EDGE_Y (w) + add_y),
959 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w) + add_x),
960 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w) + add_y),
961 Qnil))));
964 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
965 doc: /* Return a list of the edge coordinates of WINDOW.
966 WINDOW must be a live window and defaults to the selected one.
968 The returned list has the form (LEFT TOP RIGHT BOTTOM). TOP and BOTTOM
969 count by lines, and LEFT and RIGHT count by columns, all relative to 0,
970 0 at top left corner of frame.
972 RIGHT is one more than the rightmost column of WINDOW's text area.
973 BOTTOM is one more than the bottommost row of WINDOW's text area. The
974 inside edges do not include the space used by the WINDOW's scroll bar,
975 display margins, fringes, header line, and/or mode line. */)
976 (Lisp_Object window)
978 register struct window *w = decode_live_window (window);
980 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
981 + WINDOW_LEFT_MARGIN_COLS (w)
982 + WINDOW_LEFT_FRINGE_COLS (w)),
983 make_number (WINDOW_TOP_EDGE_LINE (w)
984 + WINDOW_HEADER_LINE_LINES (w)),
985 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
986 - WINDOW_RIGHT_MARGIN_COLS (w)
987 - WINDOW_RIGHT_FRINGE_COLS (w)),
988 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
989 - WINDOW_MODE_LINE_LINES (w)));
992 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
993 doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
994 WINDOW must be a live window and defaults to the selected one.
996 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
997 (0,0) at the top left corner of the frame's window area.
999 RIGHT is one more than the rightmost x position of WINDOW's text area.
1000 BOTTOM is one more than the bottommost y position of WINDOW's text area.
1001 The inside edges do not include the space used by WINDOW's scroll bar,
1002 display margins, fringes, header line, and/or mode line. */)
1003 (Lisp_Object window)
1005 register struct window *w = decode_live_window (window);
1007 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
1008 + WINDOW_LEFT_MARGIN_WIDTH (w)
1009 + WINDOW_LEFT_FRINGE_WIDTH (w)),
1010 make_number (WINDOW_TOP_EDGE_Y (w)
1011 + WINDOW_HEADER_LINE_HEIGHT (w)),
1012 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
1013 - WINDOW_RIGHT_MARGIN_WIDTH (w)
1014 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
1015 make_number (WINDOW_BOTTOM_EDGE_Y (w)
1016 - WINDOW_MODE_LINE_HEIGHT (w)));
1019 DEFUN ("window-inside-absolute-pixel-edges",
1020 Fwindow_inside_absolute_pixel_edges,
1021 Swindow_inside_absolute_pixel_edges, 0, 1, 0,
1022 doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
1023 WINDOW must be a live window and defaults to the selected one.
1025 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
1026 (0,0) at the top left corner of the frame's window area.
1028 RIGHT is one more than the rightmost x position of WINDOW's text area.
1029 BOTTOM is one more than the bottommost y position of WINDOW's text area.
1030 The inside edges do not include the space used by WINDOW's scroll bar,
1031 display margins, fringes, header line, and/or mode line. */)
1032 (Lisp_Object window)
1034 register struct window *w = decode_live_window (window);
1035 int add_x, add_y;
1036 calc_absolute_offset (w, &add_x, &add_y);
1038 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
1039 + WINDOW_LEFT_MARGIN_WIDTH (w)
1040 + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
1041 make_number (WINDOW_TOP_EDGE_Y (w)
1042 + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
1043 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
1044 - WINDOW_RIGHT_MARGIN_WIDTH (w)
1045 - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
1046 make_number (WINDOW_BOTTOM_EDGE_Y (w)
1047 - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
1050 /* Test if the character at column X, row Y is within window W.
1051 If it is not, return ON_NOTHING;
1052 if it is in the window's text area, return ON_TEXT;
1053 if it is on the window's modeline, return ON_MODE_LINE;
1054 if it is on the border between the window and its right sibling,
1055 return ON_VERTICAL_BORDER.
1056 if it is on a scroll bar, return ON_SCROLL_BAR.
1057 if it is on the window's top line, return ON_HEADER_LINE;
1058 if it is in left or right fringe of the window,
1059 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
1060 if it is in the marginal area to the left/right of the window,
1061 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
1063 X and Y are frame relative pixel coordinates. */
1065 static enum window_part
1066 coordinates_in_window (register struct window *w, int x, int y)
1068 struct frame *f = XFRAME (WINDOW_FRAME (w));
1069 enum window_part part;
1070 int ux = FRAME_COLUMN_WIDTH (f);
1071 int left_x = WINDOW_LEFT_EDGE_X (w);
1072 int right_x = WINDOW_RIGHT_EDGE_X (w);
1073 int top_y = WINDOW_TOP_EDGE_Y (w);
1074 int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
1075 /* The width of the area where the vertical line can be dragged.
1076 (Between mode lines for instance. */
1077 int grabbable_width = ux;
1078 int lmargin_width, rmargin_width, text_left, text_right;
1080 /* Outside any interesting row or column? */
1081 if (y < top_y || y >= bottom_y || x < left_x || x >= right_x)
1082 return ON_NOTHING;
1084 /* On the mode line or header line? */
1085 if ((WINDOW_WANTS_MODELINE_P (w)
1086 && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
1087 && (part = ON_MODE_LINE))
1088 || (WINDOW_WANTS_HEADER_LINE_P (w)
1089 && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
1090 && (part = ON_HEADER_LINE)))
1092 /* If it's under/over the scroll bar portion of the mode/header
1093 line, say it's on the vertical line. That's to be able to
1094 resize windows horizontally in case we're using toolkit scroll
1095 bars. Note: If scrollbars are on the left, the window that
1096 must be eventually resized is that on the left of WINDOW. */
1097 if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
1098 && !WINDOW_LEFTMOST_P (w)
1099 && eabs (x - left_x) < grabbable_width)
1100 || (!WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
1101 && !WINDOW_RIGHTMOST_P (w)
1102 && eabs (x - right_x) < grabbable_width))
1103 return ON_VERTICAL_BORDER;
1104 else
1105 return part;
1108 /* In what's below, we subtract 1 when computing right_x because we
1109 want the rightmost pixel, which is given by left_pixel+width-1. */
1110 if (w->pseudo_window_p)
1112 left_x = 0;
1113 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
1115 else
1117 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
1118 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
1121 /* Outside any interesting column? */
1122 if (x < left_x || x > right_x)
1123 return ON_SCROLL_BAR;
1125 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
1126 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
1128 text_left = window_box_left (w, TEXT_AREA);
1129 text_right = text_left + window_box_width (w, TEXT_AREA);
1131 if (FRAME_WINDOW_P (f))
1133 if (!w->pseudo_window_p
1134 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
1135 && !WINDOW_RIGHTMOST_P (w)
1136 && (eabs (x - right_x) < grabbable_width))
1137 return ON_VERTICAL_BORDER;
1139 /* Need to say "x > right_x" rather than >=, since on character
1140 terminals, the vertical line's x coordinate is right_x. */
1141 else if (!w->pseudo_window_p
1142 && !WINDOW_RIGHTMOST_P (w)
1143 && x > right_x - ux)
1144 return ON_VERTICAL_BORDER;
1146 if (x < text_left)
1148 if (lmargin_width > 0
1149 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1150 ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
1151 : (x < left_x + lmargin_width)))
1152 return ON_LEFT_MARGIN;
1154 return ON_LEFT_FRINGE;
1157 if (x >= text_right)
1159 if (rmargin_width > 0
1160 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1161 ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
1162 : (x >= right_x - rmargin_width)))
1163 return ON_RIGHT_MARGIN;
1165 return ON_RIGHT_FRINGE;
1168 /* Everything special ruled out - must be on text area */
1169 return ON_TEXT;
1172 /* Take X is the frame-relative pixel x-coordinate, and return the
1173 x-coordinate relative to part PART of window W. */
1175 window_relative_x_coord (struct window *w, enum window_part part, int x)
1177 int left_x = (w->pseudo_window_p) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w);
1179 switch (part)
1181 case ON_TEXT:
1182 return x - window_box_left (w, TEXT_AREA);
1184 case ON_LEFT_FRINGE:
1185 return x - left_x;
1187 case ON_RIGHT_FRINGE:
1188 return x - left_x - WINDOW_LEFT_FRINGE_WIDTH (w);
1190 case ON_LEFT_MARGIN:
1191 return (x - left_x
1192 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1193 ? WINDOW_LEFT_FRINGE_WIDTH (w) : 0));
1195 case ON_RIGHT_MARGIN:
1196 return (x + 1
1197 - ((w->pseudo_window_p)
1198 ? WINDOW_TOTAL_WIDTH (w)
1199 : WINDOW_BOX_RIGHT_EDGE_X (w))
1200 + window_box_width (w, RIGHT_MARGIN_AREA)
1201 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1202 ? WINDOW_RIGHT_FRINGE_WIDTH (w) : 0));
1205 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
1206 return 0;
1210 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
1211 Scoordinates_in_window_p, 2, 2, 0,
1212 doc: /* Return non-nil if COORDINATES are in WINDOW.
1213 WINDOW must be a live window and defaults to the selected one.
1214 COORDINATES is a cons of the form (X . Y), X and Y being distances
1215 measured in characters from the upper-left corner of the frame.
1216 \(0 . 0) denotes the character in the upper left corner of the
1217 frame.
1218 If COORDINATES are in the text portion of WINDOW,
1219 the coordinates relative to the window are returned.
1220 If they are in the mode line of WINDOW, `mode-line' is returned.
1221 If they are in the top mode line of WINDOW, `header-line' is returned.
1222 If they are in the left fringe of WINDOW, `left-fringe' is returned.
1223 If they are in the right fringe of WINDOW, `right-fringe' is returned.
1224 If they are on the border between WINDOW and its right sibling,
1225 `vertical-line' is returned.
1226 If they are in the windows's left or right marginal areas, `left-margin'\n\
1227 or `right-margin' is returned. */)
1228 (register Lisp_Object coordinates, Lisp_Object window)
1230 struct window *w;
1231 struct frame *f;
1232 int x, y;
1233 Lisp_Object lx, ly;
1235 w = decode_live_window (window);
1236 f = XFRAME (w->frame);
1237 CHECK_CONS (coordinates);
1238 lx = Fcar (coordinates);
1239 ly = Fcdr (coordinates);
1240 CHECK_NUMBER_OR_FLOAT (lx);
1241 CHECK_NUMBER_OR_FLOAT (ly);
1242 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
1243 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
1245 switch (coordinates_in_window (w, x, y))
1247 case ON_NOTHING:
1248 return Qnil;
1250 case ON_TEXT:
1251 /* Convert X and Y to window relative pixel coordinates, and
1252 return the canonical char units. */
1253 x -= window_box_left (w, TEXT_AREA);
1254 y -= WINDOW_TOP_EDGE_Y (w);
1255 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
1256 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
1258 case ON_MODE_LINE:
1259 return Qmode_line;
1261 case ON_VERTICAL_BORDER:
1262 return Qvertical_line;
1264 case ON_HEADER_LINE:
1265 return Qheader_line;
1267 case ON_LEFT_FRINGE:
1268 return Qleft_fringe;
1270 case ON_RIGHT_FRINGE:
1271 return Qright_fringe;
1273 case ON_LEFT_MARGIN:
1274 return Qleft_margin;
1276 case ON_RIGHT_MARGIN:
1277 return Qright_margin;
1279 case ON_SCROLL_BAR:
1280 /* Historically we are supposed to return nil in this case. */
1281 return Qnil;
1283 default:
1284 emacs_abort ();
1289 /* Callback for foreach_window, used in window_from_coordinates.
1290 Check if window W contains coordinates specified by USER_DATA which
1291 is actually a pointer to a struct check_window_data CW.
1293 Check if window W contains coordinates *CW->x and *CW->y. If it
1294 does, return W in *CW->window, as Lisp_Object, and return in
1295 *CW->part the part of the window under coordinates *X,*Y. Return
1296 zero from this function to stop iterating over windows. */
1298 struct check_window_data
1300 Lisp_Object *window;
1301 int x, y;
1302 enum window_part *part;
1305 static int
1306 check_window_containing (struct window *w, void *user_data)
1308 struct check_window_data *cw = (struct check_window_data *) user_data;
1309 enum window_part found;
1310 int continue_p = 1;
1312 found = coordinates_in_window (w, cw->x, cw->y);
1313 if (found != ON_NOTHING)
1315 *cw->part = found;
1316 XSETWINDOW (*cw->window, w);
1317 continue_p = 0;
1320 return continue_p;
1324 /* Find the window containing frame-relative pixel position X/Y and
1325 return it as a Lisp_Object.
1327 If X, Y is on one of the window's special `window_part' elements,
1328 set *PART to the id of that element.
1330 If there is no window under X, Y return nil and leave *PART
1331 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1333 This function was previously implemented with a loop cycling over
1334 windows with Fnext_window, and starting with the frame's selected
1335 window. It turned out that this doesn't work with an
1336 implementation of next_window using Vwindow_list, because
1337 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1338 tree of F when this function is called asynchronously from
1339 note_mouse_highlight. The original loop didn't terminate in this
1340 case. */
1342 Lisp_Object
1343 window_from_coordinates (struct frame *f, int x, int y,
1344 enum window_part *part, int tool_bar_p)
1346 Lisp_Object window;
1347 struct check_window_data cw;
1348 enum window_part dummy;
1350 if (part == 0)
1351 part = &dummy;
1353 window = Qnil;
1354 cw.window = &window, cw.x = x, cw.y = y; cw.part = part;
1355 foreach_window (f, check_window_containing, &cw);
1357 /* If not found above, see if it's in the tool bar window, if a tool
1358 bar exists. */
1359 if (NILP (window)
1360 && tool_bar_p
1361 && WINDOWP (f->tool_bar_window)
1362 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1363 && (coordinates_in_window (XWINDOW (f->tool_bar_window), x, y)
1364 != ON_NOTHING))
1366 *part = ON_TEXT;
1367 window = f->tool_bar_window;
1370 return window;
1373 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1374 doc: /* Return window containing coordinates X and Y on FRAME.
1375 FRAME must be a live frame and defaults to the selected one.
1376 The top left corner of the frame is considered to be row 0,
1377 column 0. */)
1378 (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
1380 struct frame *f;
1382 if (NILP (frame))
1383 frame = selected_frame;
1384 CHECK_LIVE_FRAME (frame);
1385 f = XFRAME (frame);
1387 /* Check that arguments are integers or floats. */
1388 CHECK_NUMBER_OR_FLOAT (x);
1389 CHECK_NUMBER_OR_FLOAT (y);
1391 return window_from_coordinates (f,
1392 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1393 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1394 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1395 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1396 0, 0);
1399 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1400 doc: /* Return current value of point in WINDOW.
1401 WINDOW must be a live window and defaults to the selected one.
1403 For a nonselected window, this is the value point would have if that
1404 window were selected.
1406 Note that, when WINDOW is selected, the value returned is the same as
1407 that returned by `point' for WINDOW's buffer. It would be more strictly
1408 correct to return the `top-level' value of `point', outside of any
1409 `save-excursion' forms. But that is hard to define. */)
1410 (Lisp_Object window)
1412 register struct window *w = decode_live_window (window);
1414 if (w == XWINDOW (selected_window))
1415 return make_number (BUF_PT (XBUFFER (w->buffer)));
1416 else
1417 return Fmarker_position (w->pointm);
1420 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1421 doc: /* Return position at which display currently starts in WINDOW.
1422 WINDOW must be a live window and defaults to the selected one.
1423 This is updated by redisplay or by calling `set-window-start'. */)
1424 (Lisp_Object window)
1426 return Fmarker_position (decode_live_window (window)->start);
1429 /* This is text temporarily removed from the doc string below.
1431 This function returns nil if the position is not currently known.
1432 That happens when redisplay is preempted and doesn't finish.
1433 If in that case you want to compute where the end of the window would
1434 have been if redisplay had finished, do this:
1435 (save-excursion
1436 (goto-char (window-start window))
1437 (vertical-motion (1- (window-height window)) window)
1438 (point))") */
1440 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1441 doc: /* Return position at which display currently ends in WINDOW.
1442 WINDOW must be a live window and defaults to the selected one.
1443 This is updated by redisplay, when it runs to completion.
1444 Simply changing the buffer text or setting `window-start'
1445 does not update this value.
1446 Return nil if there is no recorded value. (This can happen if the
1447 last redisplay of WINDOW was preempted, and did not finish.)
1448 If UPDATE is non-nil, compute the up-to-date position
1449 if it isn't already recorded. */)
1450 (Lisp_Object window, Lisp_Object update)
1452 Lisp_Object value;
1453 struct window *w = decode_live_window (window);
1454 Lisp_Object buf;
1455 struct buffer *b;
1457 buf = w->buffer;
1458 CHECK_BUFFER (buf);
1459 b = XBUFFER (buf);
1461 #if 0 /* This change broke some things. We should make it later. */
1462 /* If we don't know the end position, return nil.
1463 The user can compute it with vertical-motion if he wants to.
1464 It would be nicer to do it automatically,
1465 but that's so slow that it would probably bother people. */
1466 if (NILP (w->window_end_valid))
1467 return Qnil;
1468 #endif
1470 if (! NILP (update)
1471 && (windows_or_buffers_changed || NILP (w->window_end_valid))
1472 && !noninteractive)
1474 struct text_pos startp;
1475 struct it it;
1476 struct buffer *old_buffer = NULL;
1477 void *itdata = NULL;
1479 /* Cannot use Fvertical_motion because that function doesn't
1480 cope with variable-height lines. */
1481 if (b != current_buffer)
1483 old_buffer = current_buffer;
1484 set_buffer_internal (b);
1487 /* In case W->start is out of the range, use something
1488 reasonable. This situation occurred when loading a file with
1489 `-l' containing a call to `rmail' with subsequent other
1490 commands. At the end, W->start happened to be BEG, while
1491 rmail had already narrowed the buffer. */
1492 if (XMARKER (w->start)->charpos < BEGV)
1493 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1494 else if (XMARKER (w->start)->charpos > ZV)
1495 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1496 else
1497 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1499 itdata = bidi_shelve_cache ();
1500 start_display (&it, w, startp);
1501 move_it_vertically (&it, window_box_height (w));
1502 if (it.current_y < it.last_visible_y)
1503 move_it_past_eol (&it);
1504 value = make_number (IT_CHARPOS (it));
1505 bidi_unshelve_cache (itdata, 0);
1507 if (old_buffer)
1508 set_buffer_internal (old_buffer);
1510 else
1511 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1513 return value;
1516 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1517 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1518 WINDOW must be a live window and defaults to the selected one.
1519 Return POS. */)
1520 (Lisp_Object window, Lisp_Object pos)
1522 register struct window *w = decode_live_window (window);
1524 CHECK_NUMBER_COERCE_MARKER (pos);
1526 if (w == XWINDOW (selected_window))
1528 if (XBUFFER (w->buffer) == current_buffer)
1529 Fgoto_char (pos);
1530 else
1532 struct buffer *old_buffer = current_buffer;
1534 set_buffer_internal (XBUFFER (w->buffer));
1535 Fgoto_char (pos);
1536 set_buffer_internal (old_buffer);
1539 else
1541 set_marker_restricted (w->pointm, pos, w->buffer);
1542 /* We have to make sure that redisplay updates the window to show
1543 the new value of point. */
1544 ++windows_or_buffers_changed;
1547 return pos;
1550 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1551 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1552 WINDOW must be a live window and defaults to the selected one. Return
1553 POS. Optional third arg NOFORCE non-nil inhibits next redisplay from
1554 overriding motion of point in order to display at this exact start. */)
1555 (Lisp_Object window, Lisp_Object pos, Lisp_Object noforce)
1557 register struct window *w = decode_live_window (window);
1559 CHECK_NUMBER_COERCE_MARKER (pos);
1560 set_marker_restricted (w->start, pos, w->buffer);
1561 /* this is not right, but much easier than doing what is right. */
1562 w->start_at_line_beg = 0;
1563 if (NILP (noforce))
1564 w->force_start = 1;
1565 w->update_mode_line = 1;
1566 w->last_modified = 0;
1567 w->last_overlay_modified = 0;
1568 if (!EQ (window, selected_window))
1569 windows_or_buffers_changed++;
1571 return pos;
1574 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
1575 Spos_visible_in_window_p, 0, 3, 0,
1576 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
1577 WINDOW must be a live window and defaults to the selected one.
1579 Return nil if that position is scrolled vertically out of view. If a
1580 character is only partially visible, nil is returned, unless the
1581 optional argument PARTIALLY is non-nil. If POS is only out of view
1582 because of horizontal scrolling, return non-nil. If POS is t, it
1583 specifies the position of the last visible glyph in WINDOW. POS
1584 defaults to point in WINDOW; WINDOW defaults to the selected window.
1586 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
1587 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
1588 where X and Y are the pixel coordinates relative to the top left corner
1589 of the window. The remaining elements are omitted if the character after
1590 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
1591 off-window at the top and bottom of the row, ROWH is the height of the
1592 display row, and VPOS is the row number (0-based) containing POS. */)
1593 (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
1595 register struct window *w;
1596 register EMACS_INT posint;
1597 register struct buffer *buf;
1598 struct text_pos top;
1599 Lisp_Object in_window = Qnil;
1600 int rtop, rbot, rowh, vpos, fully_p = 1;
1601 int x, y;
1603 w = decode_live_window (window);
1604 buf = XBUFFER (w->buffer);
1605 SET_TEXT_POS_FROM_MARKER (top, w->start);
1607 if (EQ (pos, Qt))
1608 posint = -1;
1609 else if (!NILP (pos))
1611 CHECK_NUMBER_COERCE_MARKER (pos);
1612 posint = XINT (pos);
1614 else if (w == XWINDOW (selected_window))
1615 posint = PT;
1616 else
1617 posint = XMARKER (w->pointm)->charpos;
1619 /* If position is above window start or outside buffer boundaries,
1620 or if window start is out of range, position is not visible. */
1621 if ((EQ (pos, Qt)
1622 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
1623 && CHARPOS (top) >= BUF_BEGV (buf)
1624 && CHARPOS (top) <= BUF_ZV (buf)
1625 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
1626 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
1627 in_window = Qt;
1629 if (!NILP (in_window) && !NILP (partially))
1631 Lisp_Object part = Qnil;
1632 if (!fully_p)
1633 part = list4 (make_number (rtop), make_number (rbot),
1634 make_number (rowh), make_number (vpos));
1635 in_window = Fcons (make_number (x),
1636 Fcons (make_number (y), part));
1639 return in_window;
1642 DEFUN ("window-line-height", Fwindow_line_height,
1643 Swindow_line_height, 0, 2, 0,
1644 doc: /* Return height in pixels of text line LINE in window WINDOW.
1645 WINDOW must be a live window and defaults to the selected one.
1647 Return height of current line if LINE is omitted or nil. Return height of
1648 header or mode line if LINE is `header-line' or `mode-line'.
1649 Otherwise, LINE is a text line number starting from 0. A negative number
1650 counts from the end of the window.
1652 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
1653 in pixels of the visible part of the line, VPOS and YPOS are the
1654 vertical position in lines and pixels of the line, relative to the top
1655 of the first text line, and OFFBOT is the number of off-window pixels at
1656 the bottom of the text line. If there are off-window pixels at the top
1657 of the (first) text line, YPOS is negative.
1659 Return nil if window display is not up-to-date. In that case, use
1660 `pos-visible-in-window-p' to obtain the information. */)
1661 (Lisp_Object line, Lisp_Object window)
1663 register struct window *w;
1664 register struct buffer *b;
1665 struct glyph_row *row, *end_row;
1666 int max_y, crop, i;
1667 EMACS_INT n;
1669 w = decode_live_window (window);
1671 if (noninteractive || w->pseudo_window_p)
1672 return Qnil;
1674 CHECK_BUFFER (w->buffer);
1675 b = XBUFFER (w->buffer);
1677 /* Fail if current matrix is not up-to-date. */
1678 if (NILP (w->window_end_valid)
1679 || current_buffer->clip_changed
1680 || current_buffer->prevent_redisplay_optimizations_p
1681 || w->last_modified < BUF_MODIFF (b)
1682 || w->last_overlay_modified < BUF_OVERLAY_MODIFF (b))
1683 return Qnil;
1685 if (NILP (line))
1687 i = w->cursor.vpos;
1688 if (i < 0 || i >= w->current_matrix->nrows
1689 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
1690 return Qnil;
1691 max_y = window_text_bottom_y (w);
1692 goto found_row;
1695 if (EQ (line, Qheader_line))
1697 if (!WINDOW_WANTS_HEADER_LINE_P (w))
1698 return Qnil;
1699 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
1700 if (!row->enabled_p)
1701 return Qnil;
1702 return list4 (make_number (row->height),
1703 make_number (0), make_number (0),
1704 make_number (0));
1707 if (EQ (line, Qmode_line))
1709 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
1710 if (!row->enabled_p)
1711 return Qnil;
1712 return list4 (make_number (row->height),
1713 make_number (0), /* not accurate */
1714 make_number (WINDOW_HEADER_LINE_HEIGHT (w)
1715 + window_text_bottom_y (w)),
1716 make_number (0));
1719 CHECK_NUMBER (line);
1720 n = XINT (line);
1722 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
1723 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
1724 max_y = window_text_bottom_y (w);
1725 i = 0;
1727 while ((n < 0 || i < n)
1728 && row <= end_row && row->enabled_p
1729 && row->y + row->height < max_y)
1730 row++, i++;
1732 if (row > end_row || !row->enabled_p)
1733 return Qnil;
1735 if (++n < 0)
1737 if (-n > i)
1738 return Qnil;
1739 row += n;
1740 i += n;
1743 found_row:
1744 crop = max (0, (row->y + row->height) - max_y);
1745 return list4 (make_number (row->height + min (0, row->y) - crop),
1746 make_number (i),
1747 make_number (row->y),
1748 make_number (crop));
1751 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1752 0, 1, 0,
1753 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1754 More precisely, return the value assigned by the last call of
1755 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1756 never called with WINDOW as its argument, or the value set by that
1757 function was internally reset since its last call. WINDOW must be a
1758 live window and defaults to the selected one.
1760 When a window is dedicated to its buffer, `display-buffer' will refrain
1761 from displaying another buffer in it. `get-lru-window' and
1762 `get-largest-window' treat dedicated windows specially.
1763 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1764 `kill-buffer' can delete a dedicated window and the containing frame.
1766 Functions like `set-window-buffer' may change the buffer displayed by a
1767 window, unless that window is "strongly" dedicated to its buffer, that
1768 is the value returned by `window-dedicated-p' is t. */)
1769 (Lisp_Object window)
1771 return decode_live_window (window)->dedicated;
1774 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1775 Sset_window_dedicated_p, 2, 2, 0,
1776 doc: /* Mark WINDOW as dedicated according to FLAG.
1777 WINDOW must be a live window and defaults to the selected one. FLAG
1778 non-nil means mark WINDOW as dedicated to its buffer. FLAG nil means
1779 mark WINDOW as non-dedicated. Return FLAG.
1781 When a window is dedicated to its buffer, `display-buffer' will refrain
1782 from displaying another buffer in it. `get-lru-window' and
1783 `get-largest-window' treat dedicated windows specially.
1784 `delete-windows-on', `replace-buffer-in-windows', `quit-window',
1785 `quit-restore-window' and `kill-buffer' can delete a dedicated window
1786 and the containing frame.
1788 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1789 its buffer. Functions like `set-window-buffer' may change the buffer
1790 displayed by a window, unless that window is strongly dedicated to its
1791 buffer. If and when `set-window-buffer' displays another buffer in a
1792 window, it also makes sure that the window is no more dedicated. */)
1793 (Lisp_Object window, Lisp_Object flag)
1795 wset_dedicated (decode_live_window (window), flag);
1796 return flag;
1799 DEFUN ("window-prev-buffers", Fwindow_prev_buffers, Swindow_prev_buffers,
1800 0, 1, 0,
1801 doc: /* Return buffers previously shown in WINDOW.
1802 WINDOW must be a live window and defaults to the selected one.
1804 The return value is a list of elements (BUFFER WINDOW-START POS),
1805 where BUFFER is a buffer, WINDOW-START is the start position of the
1806 window for that buffer, and POS is a window-specific point value. */)
1807 (Lisp_Object window)
1809 return decode_live_window (window)->prev_buffers;
1812 DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers,
1813 Sset_window_prev_buffers, 2, 2, 0,
1814 doc: /* Set WINDOW's previous buffers to PREV-BUFFERS.
1815 WINDOW must be a live window and defaults to the selected one.
1817 PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
1818 where BUFFER is a buffer, WINDOW-START is the start position of the
1819 window for that buffer, and POS is a window-specific point value. */)
1820 (Lisp_Object window, Lisp_Object prev_buffers)
1822 wset_prev_buffers (decode_live_window (window), prev_buffers);
1823 return prev_buffers;
1826 DEFUN ("window-next-buffers", Fwindow_next_buffers, Swindow_next_buffers,
1827 0, 1, 0,
1828 doc: /* Return list of buffers recently re-shown in WINDOW.
1829 WINDOW must be a live window and defaults to the selected one. */)
1830 (Lisp_Object window)
1832 return decode_live_window (window)->next_buffers;
1835 DEFUN ("set-window-next-buffers", Fset_window_next_buffers,
1836 Sset_window_next_buffers, 2, 2, 0,
1837 doc: /* Set WINDOW's next buffers to NEXT-BUFFERS.
1838 WINDOW must be a live window and defaults to the selected one.
1839 NEXT-BUFFERS should be a list of buffers. */)
1840 (Lisp_Object window, Lisp_Object next_buffers)
1842 wset_next_buffers (decode_live_window (window), next_buffers);
1843 return next_buffers;
1846 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1847 0, 1, 0,
1848 doc: /* Return the parameters of WINDOW and their values.
1849 WINDOW must be a valid window and defaults to the selected one. The
1850 return value is a list of elements of the form (PARAMETER . VALUE). */)
1851 (Lisp_Object window)
1853 return Fcopy_alist (decode_valid_window (window)->window_parameters);
1856 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1857 2, 2, 0,
1858 doc: /* Return WINDOW's value for PARAMETER.
1859 WINDOW can be any window and defaults to the selected one. */)
1860 (Lisp_Object window, Lisp_Object parameter)
1862 Lisp_Object result;
1864 result = Fassq (parameter, decode_any_window (window)->window_parameters);
1865 return CDR_SAFE (result);
1868 DEFUN ("set-window-parameter", Fset_window_parameter,
1869 Sset_window_parameter, 3, 3, 0,
1870 doc: /* Set WINDOW's value of PARAMETER to VALUE.
1871 WINDOW can be any window and defaults to the selected one.
1872 Return VALUE. */)
1873 (Lisp_Object window, Lisp_Object parameter, Lisp_Object value)
1875 register struct window *w = decode_any_window (window);
1876 Lisp_Object old_alist_elt;
1878 old_alist_elt = Fassq (parameter, w->window_parameters);
1879 if (NILP (old_alist_elt))
1880 wset_window_parameters
1881 (w, Fcons (Fcons (parameter, value), w->window_parameters));
1882 else
1883 Fsetcdr (old_alist_elt, value);
1884 return value;
1887 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1888 0, 1, 0,
1889 doc: /* Return the display-table that WINDOW is using.
1890 WINDOW must be a live window and defaults to the selected one. */)
1891 (Lisp_Object window)
1893 return decode_live_window (window)->display_table;
1896 /* Get the display table for use on window W. This is either W's
1897 display table or W's buffer's display table. Ignore the specified
1898 tables if they are not valid; if no valid table is specified,
1899 return 0. */
1901 struct Lisp_Char_Table *
1902 window_display_table (struct window *w)
1904 struct Lisp_Char_Table *dp = NULL;
1906 if (DISP_TABLE_P (w->display_table))
1907 dp = XCHAR_TABLE (w->display_table);
1908 else if (BUFFERP (w->buffer))
1910 struct buffer *b = XBUFFER (w->buffer);
1912 if (DISP_TABLE_P (BVAR (b, display_table)))
1913 dp = XCHAR_TABLE (BVAR (b, display_table));
1914 else if (DISP_TABLE_P (Vstandard_display_table))
1915 dp = XCHAR_TABLE (Vstandard_display_table);
1918 return dp;
1921 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1922 doc: /* Set WINDOW's display-table to TABLE.
1923 WINDOW must be a live window and defaults to the selected one. */)
1924 (register Lisp_Object window, Lisp_Object table)
1926 wset_display_table (decode_live_window (window), table);
1927 return table;
1930 /* Record info on buffer window W is displaying
1931 when it is about to cease to display that buffer. */
1932 static void
1933 unshow_buffer (register struct window *w)
1935 Lisp_Object buf;
1936 struct buffer *b;
1938 buf = w->buffer;
1939 b = XBUFFER (buf);
1940 if (b != XMARKER (w->pointm)->buffer)
1941 emacs_abort ();
1943 #if 0
1944 if (w == XWINDOW (selected_window)
1945 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1946 /* Do this except when the selected window's buffer
1947 is being removed from some other window. */
1948 #endif
1949 /* last_window_start records the start position that this buffer
1950 had in the last window to be disconnected from it.
1951 Now that this statement is unconditional,
1952 it is possible for the buffer to be displayed in the
1953 selected window, while last_window_start reflects another
1954 window which was recently showing the same buffer.
1955 Some people might say that might be a good thing. Let's see. */
1956 b->last_window_start = marker_position (w->start);
1958 /* Point in the selected window's buffer
1959 is actually stored in that buffer, and the window's pointm isn't used.
1960 So don't clobber point in that buffer. */
1961 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1962 /* Don't clobber point in current buffer either (this could be
1963 useful in connection with bug#12208).
1964 && XBUFFER (buf) != current_buffer */
1965 /* This line helps to fix Horsley's testbug.el bug. */
1966 && !(WINDOWP (BVAR (b, last_selected_window))
1967 && w != XWINDOW (BVAR (b, last_selected_window))
1968 && EQ (buf, XWINDOW (BVAR (b, last_selected_window))->buffer)))
1969 temp_set_point_both (b,
1970 clip_to_bounds (BUF_BEGV (b),
1971 XMARKER (w->pointm)->charpos,
1972 BUF_ZV (b)),
1973 clip_to_bounds (BUF_BEGV_BYTE (b),
1974 marker_byte_position (w->pointm),
1975 BUF_ZV_BYTE (b)));
1977 if (WINDOWP (BVAR (b, last_selected_window))
1978 && w == XWINDOW (BVAR (b, last_selected_window)))
1979 bset_last_selected_window (b, Qnil);
1982 /* Put NEW into the window structure in place of OLD. SETFLAG zero
1983 means change window structure only. Otherwise store geometry and
1984 other settings as well. */
1985 static void
1986 replace_window (Lisp_Object old, Lisp_Object new, int setflag)
1988 register Lisp_Object tem;
1989 register struct window *o = XWINDOW (old), *n = XWINDOW (new);
1991 /* If OLD is its frame's root window, then NEW is the new
1992 root window for that frame. */
1993 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
1994 fset_root_window (XFRAME (o->frame), new);
1996 if (setflag)
1998 wset_left_col (n, o->left_col);
1999 wset_top_line (n, o->top_line);
2000 wset_total_cols (n, o->total_cols);
2001 wset_total_lines (n, o->total_lines);
2002 wset_normal_cols (n, o->normal_cols);
2003 wset_normal_cols (o, make_float (1.0));
2004 wset_normal_lines (n, o->normal_lines);
2005 wset_normal_lines (o, make_float (1.0));
2006 n->desired_matrix = n->current_matrix = 0;
2007 n->vscroll = 0;
2008 memset (&n->cursor, 0, sizeof (n->cursor));
2009 memset (&n->last_cursor, 0, sizeof (n->last_cursor));
2010 memset (&n->phys_cursor, 0, sizeof (n->phys_cursor));
2011 n->phys_cursor_type = -1;
2012 n->phys_cursor_width = -1;
2013 n->must_be_updated_p = 0;
2014 n->pseudo_window_p = 0;
2015 wset_window_end_vpos (n, make_number (0));
2016 wset_window_end_pos (n, make_number (0));
2017 wset_window_end_valid (n, Qnil);
2018 n->frozen_window_start_p = 0;
2021 tem = o->next;
2022 wset_next (n, tem);
2023 if (!NILP (tem))
2024 wset_prev (XWINDOW (tem), new);
2026 tem = o->prev;
2027 wset_prev (n, tem);
2028 if (!NILP (tem))
2029 wset_next (XWINDOW (tem), new);
2031 tem = o->parent;
2032 wset_parent (n, tem);
2033 if (!NILP (tem))
2035 if (EQ (XWINDOW (tem)->vchild, old))
2036 wset_vchild (XWINDOW (tem), new);
2037 if (EQ (XWINDOW (tem)->hchild, old))
2038 wset_hchild (XWINDOW (tem), new);
2042 /* If window WINDOW and its parent window are iso-combined, merge
2043 WINDOW's children into those of its parent window and mark WINDOW as
2044 deleted. */
2046 static void
2047 recombine_windows (Lisp_Object window)
2049 struct window *w, *p, *c;
2050 Lisp_Object parent, child;
2051 int horflag;
2053 w = XWINDOW (window);
2054 parent = w->parent;
2055 if (!NILP (parent) && NILP (w->combination_limit))
2057 p = XWINDOW (parent);
2058 if (((!NILP (p->vchild) && !NILP (w->vchild))
2059 || (!NILP (p->hchild) && !NILP (w->hchild))))
2060 /* WINDOW and PARENT are both either a vertical or a horizontal
2061 combination. */
2063 horflag = NILP (w->vchild);
2064 child = horflag ? w->hchild : w->vchild;
2065 c = XWINDOW (child);
2067 /* Splice WINDOW's children into its parent's children and
2068 assign new normal sizes. */
2069 if (NILP (w->prev))
2070 if (horflag)
2071 wset_hchild (p, child);
2072 else
2073 wset_vchild (p, child);
2074 else
2076 wset_prev (c, w->prev);
2077 wset_next (XWINDOW (w->prev), child);
2080 while (c)
2082 wset_parent (c, parent);
2084 if (horflag)
2085 wset_normal_cols (c,
2086 make_float (XFLOATINT (c->total_cols)
2087 / XFLOATINT (p->total_cols)));
2088 else
2089 wset_normal_lines (c,
2090 make_float (XFLOATINT (c->total_lines)
2091 / XFLOATINT (p->total_lines)));
2093 if (NILP (c->next))
2095 if (!NILP (w->next))
2097 wset_next (c, w->next);
2098 wset_prev (XWINDOW (c->next), child);
2101 c = 0;
2103 else
2105 child = c->next;
2106 c = XWINDOW (child);
2110 /* WINDOW can be deleted now. */
2111 wset_vchild (w, Qnil);
2112 wset_hchild (w, Qnil);
2117 /* If WINDOW can be deleted, delete it. */
2118 static void
2119 delete_deletable_window (Lisp_Object window)
2121 if (!NILP (call1 (Qwindow_deletable_p, window)))
2122 call1 (Qdelete_window, window);
2125 /***********************************************************************
2126 Window List
2127 ***********************************************************************/
2129 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
2130 pointer. This is a callback function for foreach_window, used in
2131 the window_list function. */
2133 static int
2134 add_window_to_list (struct window *w, void *user_data)
2136 Lisp_Object *list = (Lisp_Object *) user_data;
2137 Lisp_Object window;
2138 XSETWINDOW (window, w);
2139 *list = Fcons (window, *list);
2140 return 1;
2144 /* Return a list of all windows, for use by next_window. If
2145 Vwindow_list is a list, return that list. Otherwise, build a new
2146 list, cache it in Vwindow_list, and return that. */
2148 static Lisp_Object
2149 window_list (void)
2151 if (!CONSP (Vwindow_list))
2153 Lisp_Object tail;
2155 Vwindow_list = Qnil;
2156 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
2158 Lisp_Object args[2];
2160 /* We are visiting windows in canonical order, and add
2161 new windows at the front of args[1], which means we
2162 have to reverse this list at the end. */
2163 args[1] = Qnil;
2164 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
2165 args[0] = Vwindow_list;
2166 args[1] = Fnreverse (args[1]);
2167 Vwindow_list = Fnconc (2, args);
2171 return Vwindow_list;
2175 /* Value is non-zero if WINDOW satisfies the constraints given by
2176 OWINDOW, MINIBUF and ALL_FRAMES.
2178 MINIBUF t means WINDOW may be minibuffer windows.
2179 `lambda' means WINDOW may not be a minibuffer window.
2180 a window means a specific minibuffer window
2182 ALL_FRAMES t means search all frames,
2183 nil means search just current frame,
2184 `visible' means search just visible frames on the
2185 current terminal,
2186 0 means search visible and iconified frames on the
2187 current terminal,
2188 a window means search the frame that window belongs to,
2189 a frame means consider windows on that frame, only. */
2191 static int
2192 candidate_window_p (Lisp_Object window, Lisp_Object owindow, Lisp_Object minibuf, Lisp_Object all_frames)
2194 struct window *w = XWINDOW (window);
2195 struct frame *f = XFRAME (w->frame);
2196 int candidate_p = 1;
2198 if (!BUFFERP (w->buffer))
2199 candidate_p = 0;
2200 else if (MINI_WINDOW_P (w)
2201 && (EQ (minibuf, Qlambda)
2202 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
2204 /* If MINIBUF is `lambda' don't consider any mini-windows.
2205 If it is a window, consider only that one. */
2206 candidate_p = 0;
2208 else if (EQ (all_frames, Qt))
2209 candidate_p = 1;
2210 else if (NILP (all_frames))
2212 eassert (WINDOWP (owindow));
2213 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
2215 else if (EQ (all_frames, Qvisible))
2217 FRAME_SAMPLE_VISIBILITY (f);
2218 candidate_p = FRAME_VISIBLE_P (f)
2219 && (FRAME_TERMINAL (XFRAME (w->frame))
2220 == FRAME_TERMINAL (XFRAME (selected_frame)));
2223 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
2225 FRAME_SAMPLE_VISIBILITY (f);
2226 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
2227 #ifdef HAVE_X_WINDOWS
2228 /* Yuck!! If we've just created the frame and the
2229 window-manager requested the user to place it
2230 manually, the window may still not be considered
2231 `visible'. I'd argue it should be at least
2232 something like `iconified', but don't know how to do
2233 that yet. --Stef */
2234 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
2235 && !f->output_data.x->has_been_visible)
2236 #endif
2238 && (FRAME_TERMINAL (XFRAME (w->frame))
2239 == FRAME_TERMINAL (XFRAME (selected_frame)));
2241 else if (WINDOWP (all_frames))
2242 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
2243 || EQ (XWINDOW (all_frames)->frame, w->frame)
2244 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
2245 else if (FRAMEP (all_frames))
2246 candidate_p = EQ (all_frames, w->frame);
2248 return candidate_p;
2252 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
2253 Fwindow_list. See candidate_window_p for the meaning of WINDOW,
2254 MINIBUF, and ALL_FRAMES. */
2256 static void
2257 decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object *all_frames)
2259 if (NILP (*window))
2260 *window = selected_window;
2261 else
2262 CHECK_LIVE_WINDOW (*window);
2264 /* MINIBUF nil may or may not include minibuffers. Decide if it
2265 does. */
2266 if (NILP (*minibuf))
2267 *minibuf = minibuf_level ? minibuf_window : Qlambda;
2268 else if (!EQ (*minibuf, Qt))
2269 *minibuf = Qlambda;
2271 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
2272 => count none of them, or a specific minibuffer window (the
2273 active one) to count. */
2275 /* ALL_FRAMES nil doesn't specify which frames to include. */
2276 if (NILP (*all_frames))
2277 *all_frames
2278 = (!EQ (*minibuf, Qlambda)
2279 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
2280 : Qnil);
2281 else if (EQ (*all_frames, Qvisible))
2283 else if (EQ (*all_frames, make_number (0)))
2285 else if (FRAMEP (*all_frames))
2287 else if (!EQ (*all_frames, Qt))
2288 *all_frames = Qnil;
2292 /* Return the next or previous window of WINDOW in cyclic ordering
2293 of windows. NEXT_P non-zero means return the next window. See the
2294 documentation string of next-window for the meaning of MINIBUF and
2295 ALL_FRAMES. */
2297 static Lisp_Object
2298 next_window (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames, int next_p)
2300 decode_next_window_args (&window, &minibuf, &all_frames);
2302 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
2303 return the first window on the frame. */
2304 if (FRAMEP (all_frames)
2305 && !EQ (all_frames, XWINDOW (window)->frame))
2306 return Fframe_first_window (all_frames);
2308 if (next_p)
2310 Lisp_Object list;
2312 /* Find WINDOW in the list of all windows. */
2313 list = Fmemq (window, window_list ());
2315 /* Scan forward from WINDOW to the end of the window list. */
2316 if (CONSP (list))
2317 for (list = XCDR (list); CONSP (list); list = XCDR (list))
2318 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2319 break;
2321 /* Scan from the start of the window list up to WINDOW. */
2322 if (!CONSP (list))
2323 for (list = Vwindow_list;
2324 CONSP (list) && !EQ (XCAR (list), window);
2325 list = XCDR (list))
2326 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2327 break;
2329 if (CONSP (list))
2330 window = XCAR (list);
2332 else
2334 Lisp_Object candidate, list;
2336 /* Scan through the list of windows for candidates. If there are
2337 candidate windows in front of WINDOW, the last one of these
2338 is the one we want. If there are candidates following WINDOW
2339 in the list, again the last one of these is the one we want. */
2340 candidate = Qnil;
2341 for (list = window_list (); CONSP (list); list = XCDR (list))
2343 if (EQ (XCAR (list), window))
2345 if (WINDOWP (candidate))
2346 break;
2348 else if (candidate_window_p (XCAR (list), window, minibuf,
2349 all_frames))
2350 candidate = XCAR (list);
2353 if (WINDOWP (candidate))
2354 window = candidate;
2357 return window;
2361 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
2362 doc: /* Return live window after WINDOW in the cyclic ordering of windows.
2363 WINDOW must be a live window and defaults to the selected one. The
2364 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2365 consider.
2367 MINIBUF nil or omitted means consider the minibuffer window only if the
2368 minibuffer is active. MINIBUF t means consider the minibuffer window
2369 even if the minibuffer is not active. Any other value means do not
2370 consider the minibuffer window even if the minibuffer is active.
2372 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2373 plus the minibuffer window if specified by the MINIBUF argument. If the
2374 minibuffer counts, consider all windows on all frames that share that
2375 minibuffer too. The following non-nil values of ALL-FRAMES have special
2376 meanings:
2378 - t means consider all windows on all existing frames.
2380 - `visible' means consider all windows on all visible frames.
2382 - 0 (the number zero) means consider all windows on all visible and
2383 iconified frames.
2385 - A frame means consider all windows on that frame only.
2387 Anything else means consider all windows on WINDOW's frame and no
2388 others.
2390 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2391 `next-window' to iterate through the entire cycle of acceptable
2392 windows, eventually ending up back at the window you started with.
2393 `previous-window' traverses the same cycle, in the reverse order. */)
2394 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2396 return next_window (window, minibuf, all_frames, 1);
2400 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
2401 doc: /* Return live window before WINDOW in the cyclic ordering of windows.
2402 WINDOW must be a live window and defaults to the selected one. The
2403 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2404 consider.
2406 MINIBUF nil or omitted means consider the minibuffer window only if the
2407 minibuffer is active. MINIBUF t means consider the minibuffer window
2408 even if the minibuffer is not active. Any other value means do not
2409 consider the minibuffer window even if the minibuffer is active.
2411 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2412 plus the minibuffer window if specified by the MINIBUF argument. If the
2413 minibuffer counts, consider all windows on all frames that share that
2414 minibuffer too. The following non-nil values of ALL-FRAMES have special
2415 meanings:
2417 - t means consider all windows on all existing frames.
2419 - `visible' means consider all windows on all visible frames.
2421 - 0 (the number zero) means consider all windows on all visible and
2422 iconified frames.
2424 - A frame means consider all windows on that frame only.
2426 Anything else means consider all windows on WINDOW's frame and no
2427 others.
2429 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2430 use `previous-window' to iterate through the entire cycle of
2431 acceptable windows, eventually ending up back at the window you
2432 started with. `next-window' traverses the same cycle, in the
2433 reverse order. */)
2434 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2436 return next_window (window, minibuf, all_frames, 0);
2440 /* Return a list of windows in cyclic ordering. Arguments are like
2441 for `next-window'. */
2443 static Lisp_Object
2444 window_list_1 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2446 Lisp_Object tail, list, rest;
2448 decode_next_window_args (&window, &minibuf, &all_frames);
2449 list = Qnil;
2451 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2452 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2453 list = Fcons (XCAR (tail), list);
2455 /* Rotate the list to start with WINDOW. */
2456 list = Fnreverse (list);
2457 rest = Fmemq (window, list);
2458 if (!NILP (rest) && !EQ (rest, list))
2460 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2462 XSETCDR (tail, Qnil);
2463 list = nconc2 (rest, list);
2465 return list;
2469 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2470 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2471 FRAME nil or omitted means use the selected frame.
2472 WINDOW nil or omitted means use the window selected within FRAME.
2473 MINIBUF t means include the minibuffer window, even if it isn't active.
2474 MINIBUF nil or omitted means include the minibuffer window only
2475 if it's active.
2476 MINIBUF neither nil nor t means never include the minibuffer window. */)
2477 (Lisp_Object frame, Lisp_Object minibuf, Lisp_Object window)
2479 if (NILP (window))
2480 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2481 CHECK_WINDOW (window);
2482 if (NILP (frame))
2483 frame = selected_frame;
2485 if (!EQ (frame, XWINDOW (window)->frame))
2486 error ("Window is on a different frame");
2488 return window_list_1 (window, minibuf, frame);
2492 DEFUN ("window-list-1", Fwindow_list_1, Swindow_list_1, 0, 3, 0,
2493 doc: /* Return a list of all live windows.
2494 WINDOW specifies the first window to list and defaults to the selected
2495 window.
2497 Optional argument MINIBUF nil or omitted means consider the minibuffer
2498 window only if the minibuffer is active. MINIBUF t means consider the
2499 minibuffer window even if the minibuffer is not active. Any other value
2500 means do not consider the minibuffer window even if the minibuffer is
2501 active.
2503 Optional argument ALL-FRAMES nil or omitted means consider all windows
2504 on WINDOW's frame, plus the minibuffer window if specified by the
2505 MINIBUF argument. If the minibuffer counts, consider all windows on all
2506 frames that share that minibuffer too. The following non-nil values of
2507 ALL-FRAMES have special meanings:
2509 - t means consider all windows on all existing frames.
2511 - `visible' means consider all windows on all visible frames.
2513 - 0 (the number zero) means consider all windows on all visible and
2514 iconified frames.
2516 - A frame means consider all windows on that frame only.
2518 Anything else means consider all windows on WINDOW's frame and no
2519 others.
2521 If WINDOW is not on the list of windows returned, some other window will
2522 be listed first but no error is signaled. */)
2523 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2525 return window_list_1 (window, minibuf, all_frames);
2528 /* Look at all windows, performing an operation specified by TYPE
2529 with argument OBJ.
2530 If FRAMES is Qt, look at all frames;
2531 Qnil, look at just the selected frame;
2532 Qvisible, look at visible frames;
2533 a frame, just look at windows on that frame.
2534 If MINI is non-zero, perform the operation on minibuffer windows too. */
2536 enum window_loop
2538 WINDOW_LOOP_UNUSED,
2539 GET_BUFFER_WINDOW, /* Arg is buffer */
2540 REPLACE_BUFFER_IN_WINDOWS_SAFELY, /* Arg is buffer */
2541 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2542 CHECK_ALL_WINDOWS
2545 static Lisp_Object
2546 window_loop (enum window_loop type, Lisp_Object obj, int mini, Lisp_Object frames)
2548 Lisp_Object window, windows, best_window, frame_arg;
2549 int frame_best_window_flag = 0;
2550 struct frame *f;
2551 struct gcpro gcpro1;
2553 /* If we're only looping through windows on a particular frame,
2554 frame points to that frame. If we're looping through windows
2555 on all frames, frame is 0. */
2556 if (FRAMEP (frames))
2557 f = XFRAME (frames);
2558 else if (NILP (frames))
2559 f = SELECTED_FRAME ();
2560 else
2561 f = NULL;
2563 if (f)
2564 frame_arg = Qlambda;
2565 else if (EQ (frames, make_number (0)))
2566 frame_arg = frames;
2567 else if (EQ (frames, Qvisible))
2568 frame_arg = frames;
2569 else
2570 frame_arg = Qt;
2572 /* frame_arg is Qlambda to stick to one frame,
2573 Qvisible to consider all visible frames,
2574 or Qt otherwise. */
2576 /* Pick a window to start with. */
2577 if (WINDOWP (obj))
2578 window = obj;
2579 else if (f)
2580 window = FRAME_SELECTED_WINDOW (f);
2581 else
2582 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2584 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2585 GCPRO1 (windows);
2586 best_window = Qnil;
2588 for (; CONSP (windows); windows = XCDR (windows))
2590 struct window *w;
2592 window = XCAR (windows);
2593 w = XWINDOW (window);
2595 /* Note that we do not pay attention here to whether the frame
2596 is visible, since Fwindow_list skips non-visible frames if
2597 that is desired, under the control of frame_arg. */
2598 if (!MINI_WINDOW_P (w)
2599 /* For REPLACE_BUFFER_IN_WINDOWS_SAFELY, we must always
2600 consider all windows. */
2601 || type == REPLACE_BUFFER_IN_WINDOWS_SAFELY
2602 || (mini && minibuf_level > 0))
2603 switch (type)
2605 case GET_BUFFER_WINDOW:
2606 if (EQ (w->buffer, obj)
2607 /* Don't find any minibuffer window except the one that
2608 is currently in use. */
2609 && (MINI_WINDOW_P (w) ? EQ (window, minibuf_window) : 1))
2611 if (EQ (window, selected_window))
2612 /* Preferably return the selected window. */
2613 RETURN_UNGCPRO (window);
2614 else if (EQ (XWINDOW (window)->frame, selected_frame)
2615 && !frame_best_window_flag)
2616 /* Prefer windows on the current frame (but don't
2617 choose another one if we have one already). */
2619 best_window = window;
2620 frame_best_window_flag = 1;
2622 else if (NILP (best_window))
2623 best_window = window;
2625 break;
2627 case REPLACE_BUFFER_IN_WINDOWS_SAFELY:
2628 /* We could simply check whether the buffer shown by window
2629 is live, and show another buffer in case it isn't. */
2630 if (EQ (w->buffer, obj))
2632 /* Undedicate WINDOW. */
2633 wset_dedicated (w, Qnil);
2634 /* Make WINDOW show the buffer returned by
2635 other_buffer_safely, don't run any hooks. */
2636 set_window_buffer
2637 (window, other_buffer_safely (w->buffer), 0, 0);
2638 /* If WINDOW is the selected window, make its buffer
2639 current. But do so only if the window shows the
2640 current buffer (Bug#6454). */
2641 if (EQ (window, selected_window)
2642 && XBUFFER (w->buffer) == current_buffer)
2643 Fset_buffer (w->buffer);
2645 break;
2647 case REDISPLAY_BUFFER_WINDOWS:
2648 if (EQ (w->buffer, obj))
2650 mark_window_display_accurate (window, 0);
2651 w->update_mode_line = 1;
2652 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2653 ++update_mode_lines;
2654 best_window = window;
2656 break;
2658 /* Check for a window that has a killed buffer. */
2659 case CHECK_ALL_WINDOWS:
2660 if (! NILP (w->buffer)
2661 && !BUFFER_LIVE_P (XBUFFER (w->buffer)))
2662 emacs_abort ();
2663 break;
2665 case WINDOW_LOOP_UNUSED:
2666 break;
2670 UNGCPRO;
2671 return best_window;
2674 /* Used for debugging. Abort if any window has a dead buffer. */
2676 extern void check_all_windows (void) EXTERNALLY_VISIBLE;
2677 void
2678 check_all_windows (void)
2680 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2683 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 0, 2, 0,
2684 doc: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2685 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
2686 the current buffer.
2688 The optional argument ALL-FRAMES specifies the frames to consider:
2690 - t means consider all windows on all existing frames.
2692 - `visible' means consider all windows on all visible frames.
2694 - 0 (the number zero) means consider all windows on all visible
2695 and iconified frames.
2697 - A frame means consider all windows on that frame only.
2699 Any other value of ALL-FRAMES means consider all windows on the
2700 selected frame and no others. */)
2701 (Lisp_Object buffer_or_name, Lisp_Object all_frames)
2703 Lisp_Object buffer;
2705 if (NILP (buffer_or_name))
2706 buffer = Fcurrent_buffer ();
2707 else
2708 buffer = Fget_buffer (buffer_or_name);
2710 if (BUFFERP (buffer))
2711 return window_loop (GET_BUFFER_WINDOW, buffer, 1, all_frames);
2712 else
2713 return Qnil;
2716 static Lisp_Object
2717 resize_root_window (Lisp_Object window, Lisp_Object delta, Lisp_Object horizontal, Lisp_Object ignore)
2719 return call4 (Qwindow_resize_root_window, window, delta, horizontal, ignore);
2723 DEFUN ("delete-other-windows-internal", Fdelete_other_windows_internal,
2724 Sdelete_other_windows_internal, 0, 2, "",
2725 doc: /* Make WINDOW fill its frame.
2726 Only the frame WINDOW is on is affected. WINDOW must be a valid window
2727 and defaults to the selected one.
2729 Optional argument ROOT, if non-nil, must specify an internal window such
2730 that WINDOW is in its window subtree. If this is the case, replace ROOT
2731 by WINDOW and leave alone any windows not part of ROOT's subtree.
2733 When WINDOW is live try to reduce display jumps by keeping the text
2734 previously visible in WINDOW in the same place on the frame. Doing this
2735 depends on the value of (window-start WINDOW), so if calling this
2736 function in a program gives strange scrolling, make sure the
2737 window-start value is reasonable when this function is called. */)
2738 (Lisp_Object window, Lisp_Object root)
2740 struct window *w, *r, *s;
2741 struct frame *f;
2742 Lisp_Object sibling, pwindow, swindow IF_LINT (= Qnil), delta;
2743 ptrdiff_t startpos IF_LINT (= 0);
2744 int top IF_LINT (= 0), new_top, resize_failed;
2746 w = decode_valid_window (window);
2747 XSETWINDOW (window, w);
2748 f = XFRAME (w->frame);
2750 if (NILP (root))
2751 /* ROOT is the frame's root window. */
2753 root = FRAME_ROOT_WINDOW (f);
2754 r = XWINDOW (root);
2756 else
2757 /* ROOT must be an ancestor of WINDOW. */
2759 r = decode_valid_window (root);
2760 pwindow = XWINDOW (window)->parent;
2761 while (!NILP (pwindow))
2762 if (EQ (pwindow, root))
2763 break;
2764 else
2765 pwindow = XWINDOW (pwindow)->parent;
2766 if (!EQ (pwindow, root))
2767 error ("Specified root is not an ancestor of specified window");
2770 if (EQ (window, root))
2771 /* A noop. */
2772 return Qnil;
2773 /* I don't understand the "top > 0" part below. If we deal with a
2774 standalone minibuffer it would have been caught by the preceding
2775 test. */
2776 else if (MINI_WINDOW_P (w)) /* && top > 0) */
2777 error ("Can't expand minibuffer to full frame");
2779 if (!NILP (w->buffer))
2781 startpos = marker_position (w->start);
2782 top = WINDOW_TOP_EDGE_LINE (w)
2783 - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2784 /* Make sure WINDOW is the frame's selected window. */
2785 if (!EQ (window, FRAME_SELECTED_WINDOW (f)))
2787 if (EQ (selected_frame, w->frame))
2788 Fselect_window (window, Qnil);
2789 else
2790 fset_selected_window (f, window);
2793 else
2795 /* See if the frame's selected window is a part of the window
2796 subtree rooted at WINDOW, by finding all the selected window's
2797 parents and comparing each one with WINDOW. If it isn't we
2798 need a new selected window for this frame. */
2799 swindow = FRAME_SELECTED_WINDOW (f);
2800 while (1)
2802 pwindow = swindow;
2803 while (!NILP (pwindow) && !EQ (window, pwindow))
2804 pwindow = XWINDOW (pwindow)->parent;
2806 if (EQ (window, pwindow))
2807 /* If WINDOW is an ancestor of SWINDOW, then SWINDOW is ok
2808 as the new selected window. */
2809 break;
2810 else
2811 /* Else try the previous window of SWINDOW. */
2812 swindow = Fprevious_window (swindow, Qlambda, Qnil);
2815 if (!EQ (swindow, FRAME_SELECTED_WINDOW (f)))
2817 if (EQ (selected_frame, w->frame))
2818 Fselect_window (swindow, Qnil);
2819 else
2820 fset_selected_window (f, swindow);
2824 block_input ();
2825 if (!FRAME_INITIAL_P (f))
2827 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
2829 /* We are going to free the glyph matrices of WINDOW, and with
2830 that we might lose any information about glyph rows that have
2831 some of their glyphs highlighted in mouse face. (These rows
2832 are marked with a non-zero mouse_face_p flag.) If WINDOW
2833 indeed has some glyphs highlighted in mouse face, signal to
2834 frame's up-to-date hook that mouse highlight was overwritten,
2835 so that it will arrange for redisplaying the highlight. */
2836 if (EQ (hlinfo->mouse_face_window, window))
2838 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
2839 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
2840 hlinfo->mouse_face_window = Qnil;
2843 free_window_matrices (r);
2845 windows_or_buffers_changed++;
2846 Vwindow_list = Qnil;
2847 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
2848 resize_failed = 0;
2850 if (NILP (w->buffer))
2852 /* Resize child windows vertically. */
2853 XSETINT (delta, XINT (r->total_lines)
2854 - XINT (w->total_lines));
2855 wset_top_line (w, r->top_line);
2856 resize_root_window (window, delta, Qnil, Qnil);
2857 if (window_resize_check (w, 0))
2858 window_resize_apply (w, 0);
2859 else
2861 resize_root_window (window, delta, Qnil, Qt);
2862 if (window_resize_check (w, 0))
2863 window_resize_apply (w, 0);
2864 else
2865 resize_failed = 1;
2868 /* Resize child windows horizontally. */
2869 if (!resize_failed)
2871 wset_left_col (w, r->left_col);
2872 XSETINT (delta,
2873 XINT (r->total_cols) - XINT (w->total_cols));
2874 wset_left_col (w, r->left_col);
2875 resize_root_window (window, delta, Qt, Qnil);
2876 if (window_resize_check (w, 1))
2877 window_resize_apply (w, 1);
2878 else
2880 resize_root_window (window, delta, Qt, Qt);
2881 if (window_resize_check (w, 1))
2882 window_resize_apply (w, 1);
2883 else
2884 resize_failed = 1;
2888 if (resize_failed)
2889 /* Play safe, if we still can ... */
2891 window = swindow;
2892 w = XWINDOW (window);
2896 /* Cleanly unlink WINDOW from window-tree. */
2897 if (!NILP (w->prev))
2898 /* Get SIBLING above (on the left of) WINDOW. */
2900 sibling = w->prev;
2901 s = XWINDOW (sibling);
2902 wset_next (s, w->next);
2903 if (!NILP (s->next))
2904 wset_prev (XWINDOW (s->next), sibling);
2906 else
2907 /* Get SIBLING below (on the right of) WINDOW. */
2909 sibling = w->next;
2910 s = XWINDOW (sibling);
2911 wset_prev (s, Qnil);
2912 if (!NILP (XWINDOW (w->parent)->vchild))
2913 wset_vchild (XWINDOW (w->parent), sibling);
2914 else
2915 wset_hchild (XWINDOW (w->parent), sibling);
2918 /* Delete ROOT and all child windows of ROOT. */
2919 if (!NILP (r->vchild))
2921 delete_all_child_windows (r->vchild);
2922 wset_vchild (r, Qnil);
2924 else if (!NILP (r->hchild))
2926 delete_all_child_windows (r->hchild);
2927 wset_hchild (r, Qnil);
2930 replace_window (root, window, 1);
2932 /* This must become SWINDOW anyway ....... */
2933 if (!NILP (w->buffer) && !resize_failed)
2935 /* Try to minimize scrolling, by setting the window start to the
2936 point will cause the text at the old window start to be at the
2937 same place on the frame. But don't try to do this if the
2938 window start is outside the visible portion (as might happen
2939 when the display is not current, due to typeahead). */
2940 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2941 if (new_top != top
2942 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2943 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2945 struct position pos;
2946 struct buffer *obuf = current_buffer;
2948 Fset_buffer (w->buffer);
2949 /* This computation used to temporarily move point, but that
2950 can have unwanted side effects due to text properties. */
2951 pos = *vmotion (startpos, -top, w);
2953 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2954 wset_window_end_valid (w, Qnil);
2955 w->start_at_line_beg = (pos.bytepos == BEGV_BYTE
2956 || FETCH_BYTE (pos.bytepos - 1) == '\n');
2957 /* We need to do this, so that the window-scroll-functions
2958 get called. */
2959 w->optional_new_start = 1;
2961 set_buffer_internal (obuf);
2965 adjust_glyphs (f);
2966 unblock_input ();
2968 run_window_configuration_change_hook (f);
2970 return Qnil;
2974 void
2975 replace_buffer_in_windows (Lisp_Object buffer)
2977 call1 (Qreplace_buffer_in_windows, buffer);
2981 /* Safely replace BUFFER with some other buffer in all windows of all
2982 frames, even those on other keyboards. */
2984 void
2985 replace_buffer_in_windows_safely (Lisp_Object buffer)
2987 Lisp_Object tail, frame;
2989 /* A single call to window_loop won't do the job because it only
2990 considers frames on the current keyboard. So loop manually over
2991 frames, and handle each one. */
2992 FOR_EACH_FRAME (tail, frame)
2993 window_loop (REPLACE_BUFFER_IN_WINDOWS_SAFELY, buffer, 1, frame);
2996 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
2997 minimum allowable size. */
2999 void
3000 check_frame_size (FRAME_PTR frame, int *rows, int *cols)
3002 /* For height, we have to see:
3003 how many windows the frame has at minimum (one or two),
3004 and whether it has a menu bar or other special stuff at the top. */
3005 int min_height
3006 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
3007 ? MIN_SAFE_WINDOW_HEIGHT
3008 : 2 * MIN_SAFE_WINDOW_HEIGHT);
3010 if (FRAME_TOP_MARGIN (frame) > 0)
3011 min_height += FRAME_TOP_MARGIN (frame);
3013 if (*rows < min_height)
3014 *rows = min_height;
3015 if (*cols < MIN_SAFE_WINDOW_WIDTH)
3016 *cols = MIN_SAFE_WINDOW_WIDTH;
3019 /* Adjust the margins of window W if text area is too small.
3020 Return 1 if window width is ok after adjustment; 0 if window
3021 is still too narrow. */
3023 static int
3024 adjust_window_margins (struct window *w)
3026 int box_cols = (WINDOW_TOTAL_COLS (w)
3027 - WINDOW_FRINGE_COLS (w)
3028 - WINDOW_SCROLL_BAR_COLS (w));
3029 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
3030 + WINDOW_RIGHT_MARGIN_COLS (w));
3032 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
3033 return 1;
3035 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
3036 return 0;
3038 /* Window's text area is too narrow, but reducing the window
3039 margins will fix that. */
3040 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
3041 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
3043 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
3045 wset_left_margin_cols (w, make_number (margin_cols / 2));
3046 wset_right_margin_cols (w, make_number (margin_cols / 2));
3048 else
3049 wset_right_margin_cols (w, make_number (margin_cols));
3051 else
3052 wset_left_margin_cols (w, make_number (margin_cols));
3053 return 1;
3056 /* The following three routines are needed for running a window's
3057 configuration change hook. */
3058 static void
3059 run_funs (Lisp_Object funs)
3061 for (; CONSP (funs); funs = XCDR (funs))
3062 if (!EQ (XCAR (funs), Qt))
3063 call0 (XCAR (funs));
3066 static Lisp_Object
3067 select_window_norecord (Lisp_Object window)
3069 return WINDOW_LIVE_P (window)
3070 ? Fselect_window (window, Qt) : selected_window;
3073 static Lisp_Object
3074 select_frame_norecord (Lisp_Object frame)
3076 return FRAME_LIVE_P (XFRAME (frame))
3077 ? Fselect_frame (frame, Qt) : selected_frame;
3080 void
3081 run_window_configuration_change_hook (struct frame *f)
3083 ptrdiff_t count = SPECPDL_INDEX ();
3084 Lisp_Object frame, global_wcch
3085 = Fdefault_value (Qwindow_configuration_change_hook);
3086 XSETFRAME (frame, f);
3088 if (NILP (Vrun_hooks) || !NILP (inhibit_lisp_code))
3089 return;
3091 /* Use the right buffer. Matters when running the local hooks. */
3092 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3094 record_unwind_current_buffer ();
3095 Fset_buffer (Fwindow_buffer (Qnil));
3098 if (SELECTED_FRAME () != f)
3100 record_unwind_protect (select_frame_norecord, Fselected_frame ());
3101 select_frame_norecord (frame);
3104 /* Look for buffer-local values. */
3106 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3107 for (; CONSP (windows); windows = XCDR (windows))
3109 Lisp_Object window = XCAR (windows);
3110 Lisp_Object buffer = Fwindow_buffer (window);
3111 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3112 buffer)))
3114 ptrdiff_t inner_count = SPECPDL_INDEX ();
3115 record_unwind_protect (select_window_norecord, Fselected_window ());
3116 select_window_norecord (window);
3117 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3118 buffer));
3119 unbind_to (inner_count, Qnil);
3124 run_funs (global_wcch);
3125 unbind_to (count, Qnil);
3128 DEFUN ("run-window-configuration-change-hook", Frun_window_configuration_change_hook,
3129 Srun_window_configuration_change_hook, 1, 1, 0,
3130 doc: /* Run `window-configuration-change-hook' for FRAME. */)
3131 (Lisp_Object frame)
3133 CHECK_LIVE_FRAME (frame);
3134 run_window_configuration_change_hook (XFRAME (frame));
3135 return Qnil;
3138 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
3139 means it's allowed to run hooks. See make_frame for a case where
3140 it's not allowed. KEEP_MARGINS_P non-zero means that the current
3141 margins, fringes, and scroll-bar settings of the window are not
3142 reset from the buffer's local settings. */
3144 void
3145 set_window_buffer (Lisp_Object window, Lisp_Object buffer, int run_hooks_p, int keep_margins_p)
3147 struct window *w = XWINDOW (window);
3148 struct buffer *b = XBUFFER (buffer);
3149 ptrdiff_t count = SPECPDL_INDEX ();
3150 int samebuf = EQ (buffer, w->buffer);
3152 wset_buffer (w, buffer);
3154 if (EQ (window, selected_window))
3155 bset_last_selected_window (b, window);
3157 /* Let redisplay errors through. */
3158 b->display_error_modiff = 0;
3160 /* Update time stamps of buffer display. */
3161 if (INTEGERP (BVAR (b, display_count)))
3162 bset_display_count (b, make_number (XINT (BVAR (b, display_count)) + 1));
3163 bset_display_time (b, Fcurrent_time ());
3165 wset_window_end_pos (w, make_number (0));
3166 wset_window_end_vpos (w, make_number (0));
3167 memset (&w->last_cursor, 0, sizeof w->last_cursor);
3168 wset_window_end_valid (w, Qnil);
3169 if (!(keep_margins_p && samebuf))
3170 { /* If we're not actually changing the buffer, don't reset hscroll and
3171 vscroll. This case happens for example when called from
3172 change_frame_size_1, where we use a dummy call to
3173 Fset_window_buffer on the frame's selected window (and no other)
3174 just in order to run window-configuration-change-hook.
3175 Resetting hscroll and vscroll here is problematic for things like
3176 image-mode and doc-view-mode since it resets the image's position
3177 whenever we resize the frame. */
3178 w->hscroll = w->min_hscroll = 0;
3179 w->vscroll = 0;
3180 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3181 set_marker_restricted (w->start,
3182 make_number (b->last_window_start),
3183 buffer);
3184 w->start_at_line_beg = 0;
3185 w->force_start = 0;
3186 w->last_modified = 0;
3187 w->last_overlay_modified = 0;
3189 /* Maybe we could move this into the `if' but it's not obviously safe and
3190 I doubt it's worth the trouble. */
3191 windows_or_buffers_changed++;
3193 /* We must select BUFFER for running the window-scroll-functions. */
3194 /* We can't check ! NILP (Vwindow_scroll_functions) here
3195 because that might itself be a local variable. */
3196 if (window_initialized)
3198 record_unwind_current_buffer ();
3199 Fset_buffer (buffer);
3202 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3204 if (!keep_margins_p)
3206 /* Set left and right marginal area width etc. from buffer. */
3208 /* This may call adjust_window_margins three times, so
3209 temporarily disable window margins. */
3210 Lisp_Object save_left = w->left_margin_cols;
3211 Lisp_Object save_right = w->right_margin_cols;
3213 wset_left_margin_cols (w, Qnil);
3214 wset_right_margin_cols (w, Qnil);
3216 Fset_window_fringes (window,
3217 BVAR (b, left_fringe_width), BVAR (b, right_fringe_width),
3218 BVAR (b, fringes_outside_margins));
3220 Fset_window_scroll_bars (window,
3221 BVAR (b, scroll_bar_width),
3222 BVAR (b, vertical_scroll_bar_type), Qnil);
3224 wset_left_margin_cols (w, save_left);
3225 wset_right_margin_cols (w, save_right);
3227 Fset_window_margins (window,
3228 BVAR (b, left_margin_cols), BVAR (b, right_margin_cols));
3231 if (run_hooks_p)
3233 if (! NILP (Vwindow_scroll_functions))
3234 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3235 Fmarker_position (w->start));
3236 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3239 unbind_to (count, Qnil);
3242 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3243 doc: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3244 WINDOW must be a live window and defaults to the selected one.
3245 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3247 Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
3248 display margins, fringe widths, and scroll bar settings are preserved;
3249 the default is to reset these from the local settings for BUFFER-OR-NAME
3250 or the frame defaults. Return nil.
3252 This function throws an error when WINDOW is strongly dedicated to its
3253 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3254 already display BUFFER-OR-NAME.
3256 This function runs `window-scroll-functions' before running
3257 `window-configuration-change-hook'. */)
3258 (register Lisp_Object window, Lisp_Object buffer_or_name, Lisp_Object keep_margins)
3260 register Lisp_Object tem, buffer;
3261 register struct window *w = decode_live_window (window);
3263 XSETWINDOW (window, w);
3264 buffer = Fget_buffer (buffer_or_name);
3265 CHECK_BUFFER (buffer);
3266 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
3267 error ("Attempt to display deleted buffer");
3269 tem = w->buffer;
3270 if (NILP (tem))
3271 error ("Window is deleted");
3272 else if (!EQ (tem, Qt))
3273 /* w->buffer is t when the window is first being set up. */
3275 if (!EQ (tem, buffer))
3277 if (EQ (w->dedicated, Qt))
3278 /* WINDOW is strongly dedicated to its buffer, signal an
3279 error. */
3280 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem), name)));
3281 else
3282 /* WINDOW is weakly dedicated to its buffer, reset
3283 dedication. */
3284 wset_dedicated (w, Qnil);
3286 call1 (Qrecord_window_buffer, window);
3289 unshow_buffer (w);
3292 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3294 return Qnil;
3297 static Lisp_Object
3298 display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame)
3300 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3303 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3304 0, 1, 0,
3305 doc: /* Force all windows to be updated on next redisplay.
3306 If optional arg OBJECT is a window, force redisplay of that window only.
3307 If OBJECT is a buffer or buffer name, force redisplay of all windows
3308 displaying that buffer. */)
3309 (Lisp_Object object)
3311 if (NILP (object))
3313 windows_or_buffers_changed++;
3314 update_mode_lines++;
3315 return Qt;
3318 if (WINDOWP (object))
3320 struct window *w = XWINDOW (object);
3321 mark_window_display_accurate (object, 0);
3322 w->update_mode_line = 1;
3323 if (BUFFERP (w->buffer))
3324 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3325 ++update_mode_lines;
3326 return Qt;
3329 if (STRINGP (object))
3330 object = Fget_buffer (object);
3331 if (BUFFERP (object) && BUFFER_LIVE_P (XBUFFER (object)))
3333 /* Walk all windows looking for buffer, and force update
3334 of each of those windows. */
3336 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3337 return NILP (object) ? Qnil : Qt;
3340 /* If nothing suitable was found, just return.
3341 We could signal an error, but this feature will typically be used
3342 asynchronously in timers or process sentinels, so we don't. */
3343 return Qnil;
3346 /* Obsolete since 24.3. */
3347 void
3348 temp_output_buffer_show (register Lisp_Object buf)
3350 register struct buffer *old = current_buffer;
3351 register Lisp_Object window;
3352 register struct window *w;
3354 bset_directory (XBUFFER (buf), BVAR (current_buffer, directory));
3356 Fset_buffer (buf);
3357 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3358 BEGV = BEG;
3359 ZV = Z;
3360 SET_PT (BEG);
3361 set_buffer_internal (old);
3363 if (!NILP (Vtemp_buffer_show_function))
3364 call1 (Vtemp_buffer_show_function, buf);
3365 else
3367 window = display_buffer (buf, Qnil, Qnil);
3369 if (!EQ (XWINDOW (window)->frame, selected_frame))
3370 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3371 Vminibuf_scroll_window = window;
3372 w = XWINDOW (window);
3373 w->hscroll = 0;
3374 w->min_hscroll = 0;
3375 set_marker_restricted_both (w->start, buf, BEG, BEG);
3376 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3378 /* Run temp-buffer-show-hook, with the chosen window selected
3379 and its buffer current. */
3381 ptrdiff_t count = SPECPDL_INDEX ();
3382 Lisp_Object prev_window, prev_buffer;
3383 prev_window = selected_window;
3384 XSETBUFFER (prev_buffer, old);
3386 /* Select the window that was chosen, for running the hook.
3387 Note: Both Fselect_window and select_window_norecord may
3388 set-buffer to the buffer displayed in the window,
3389 so we need to save the current buffer. --stef */
3390 record_unwind_protect (Fset_buffer, prev_buffer);
3391 record_unwind_protect (select_window_norecord, prev_window);
3392 Fselect_window (window, Qt);
3393 Fset_buffer (w->buffer);
3394 Frun_hooks (1, &Qtemp_buffer_show_hook);
3395 unbind_to (count, Qnil);
3400 /* Make new window, have it replace WINDOW in window-tree, and make
3401 WINDOW its only vertical child (HORFLAG 1 means make WINDOW its only
3402 horizontal child). */
3403 static void
3404 make_parent_window (Lisp_Object window, int horflag)
3406 Lisp_Object parent;
3407 register struct window *o, *p;
3409 o = XWINDOW (window);
3410 p = allocate_window ();
3411 memcpy ((char *) p + sizeof (struct vectorlike_header),
3412 (char *) o + sizeof (struct vectorlike_header),
3413 word_size * VECSIZE (struct window));
3414 XSETWINDOW (parent, p);
3416 p->sequence_number = ++sequence_number;
3418 replace_window (window, parent, 1);
3420 wset_next (o, Qnil);
3421 wset_prev (o, Qnil);
3422 wset_parent (o, parent);
3424 wset_hchild (p, horflag ? window : Qnil);
3425 wset_vchild (p, horflag ? Qnil : window);
3426 wset_start (p, Qnil);
3427 wset_pointm (p, Qnil);
3428 wset_buffer (p, Qnil);
3429 wset_combination_limit (p, Qnil);
3430 wset_window_parameters (p, Qnil);
3433 /* Make new window from scratch. */
3434 Lisp_Object
3435 make_window (void)
3437 Lisp_Object window;
3438 register struct window *w;
3440 w = allocate_window ();
3441 /* Initialize Lisp data. Note that allocate_window initializes all
3442 Lisp data to nil, so do it only for slots which should not be nil. */
3443 wset_left_col (w, make_number (0));
3444 wset_top_line (w, make_number (0));
3445 wset_total_lines (w, make_number (0));
3446 wset_total_cols (w, make_number (0));
3447 wset_normal_lines (w, make_float (1.0));
3448 wset_normal_cols (w, make_float (1.0));
3449 wset_new_total (w, make_number (0));
3450 wset_new_normal (w, make_number (0));
3451 wset_start (w, Fmake_marker ());
3452 wset_pointm (w, Fmake_marker ());
3453 wset_vertical_scroll_bar_type (w, Qt);
3454 wset_window_end_pos (w, make_number (0));
3455 wset_window_end_vpos (w, make_number (0));
3456 /* These Lisp fields are marked specially so they're not set to nil by
3457 allocate_window. */
3458 wset_prev_buffers (w, Qnil);
3459 wset_next_buffers (w, Qnil);
3461 /* Initialize non-Lisp data. Note that allocate_window zeroes out all
3462 non-Lisp data, so do it only for slots which should not be zero. */
3463 w->nrows_scale_factor = w->ncols_scale_factor = 1;
3464 w->phys_cursor_type = -1;
3465 w->phys_cursor_width = -1;
3466 w->sequence_number = ++sequence_number;
3468 /* Reset window_list. */
3469 Vwindow_list = Qnil;
3470 /* Return window. */
3471 XSETWINDOW (window, w);
3472 return window;
3475 DEFUN ("set-window-new-total", Fset_window_new_total, Sset_window_new_total, 2, 3, 0,
3476 doc: /* Set new total size of WINDOW to SIZE.
3477 WINDOW must be a valid window and defaults to the selected one.
3478 Return SIZE.
3480 Optional argument ADD non-nil means add SIZE to the new total size of
3481 WINDOW and return the sum.
3483 Note: This function does not operate on any child windows of WINDOW. */)
3484 (Lisp_Object window, Lisp_Object size, Lisp_Object add)
3486 struct window *w = decode_valid_window (window);
3488 CHECK_NUMBER (size);
3489 if (NILP (add))
3490 wset_new_total (w, size);
3491 else
3492 wset_new_total (w, make_number (XINT (w->new_total) + XINT (size)));
3494 return w->new_total;
3497 DEFUN ("set-window-new-normal", Fset_window_new_normal, Sset_window_new_normal, 1, 2, 0,
3498 doc: /* Set new normal size of WINDOW to SIZE.
3499 WINDOW must be a valid window and defaults to the selected one.
3500 Return SIZE.
3502 Note: This function does not operate on any child windows of WINDOW. */)
3503 (Lisp_Object window, Lisp_Object size)
3505 wset_new_normal (decode_valid_window (window), size);
3506 return size;
3509 /* Return 1 if setting w->total_lines (w->total_cols if HORFLAG is
3510 non-zero) to w->new_total would result in correct heights (widths)
3511 for window W and recursively all child windows of W.
3513 Note: This function does not check any of `window-fixed-size-p',
3514 `window-min-height' or `window-min-width'. It does check that window
3515 sizes do not drop below one line (two columns). */
3516 static int
3517 window_resize_check (struct window *w, int horflag)
3519 struct window *c;
3521 if (!NILP (w->vchild))
3522 /* W is a vertical combination. */
3524 c = XWINDOW (w->vchild);
3525 if (horflag)
3526 /* All child windows of W must have the same width as W. */
3528 while (c)
3530 if ((XINT (c->new_total) != XINT (w->new_total))
3531 || !window_resize_check (c, horflag))
3532 return 0;
3533 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3535 return 1;
3537 else
3538 /* The sum of the heights of the child windows of W must equal
3539 W's height. */
3541 int sum_of_sizes = 0;
3542 while (c)
3544 if (!window_resize_check (c, horflag))
3545 return 0;
3546 sum_of_sizes = sum_of_sizes + XINT (c->new_total);
3547 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3549 return (sum_of_sizes == XINT (w->new_total));
3552 else if (!NILP (w->hchild))
3553 /* W is a horizontal combination. */
3555 c = XWINDOW (w->hchild);
3556 if (horflag)
3557 /* The sum of the widths of the child windows of W must equal W's
3558 width. */
3560 int sum_of_sizes = 0;
3561 while (c)
3563 if (!window_resize_check (c, horflag))
3564 return 0;
3565 sum_of_sizes = sum_of_sizes + XINT (c->new_total);
3566 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3568 return (sum_of_sizes == XINT (w->new_total));
3570 else
3571 /* All child windows of W must have the same height as W. */
3573 while (c)
3575 if ((XINT (c->new_total) != XINT (w->new_total))
3576 || !window_resize_check (c, horflag))
3577 return 0;
3578 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3580 return 1;
3583 else
3584 /* A leaf window. Make sure it's not too small. The following
3585 hardcodes the values of `window-safe-min-width' (2) and
3586 `window-safe-min-height' (1) which are defined in window.el. */
3587 return XINT (w->new_total) >= (horflag ? 2 : 1);
3590 /* Set w->total_lines (w->total_cols if HORIZONTAL is non-zero) to
3591 w->new_total for window W and recursively all child windows of W.
3592 Also calculate and assign the new vertical (horizontal) start
3593 positions of each of these windows.
3595 This function does not perform any error checks. Make sure you have
3596 run window_resize_check on W before applying this function. */
3597 static void
3598 window_resize_apply (struct window *w, int horflag)
3600 struct window *c;
3601 int pos;
3603 /* Note: Assigning new_normal requires that the new total size of the
3604 parent window has been set *before*. */
3605 if (horflag)
3607 wset_total_cols (w, w->new_total);
3608 if (NUMBERP (w->new_normal))
3609 wset_normal_cols (w, w->new_normal);
3611 pos = XINT (w->left_col);
3613 else
3615 wset_total_lines (w, w->new_total);
3616 if (NUMBERP (w->new_normal))
3617 wset_normal_lines (w, w->new_normal);
3619 pos = XINT (w->top_line);
3622 if (!NILP (w->vchild))
3623 /* W is a vertical combination. */
3625 c = XWINDOW (w->vchild);
3626 while (c)
3628 if (horflag)
3629 wset_left_col (c, make_number (pos));
3630 else
3631 wset_top_line (c, make_number (pos));
3632 window_resize_apply (c, horflag);
3633 if (!horflag)
3634 pos = pos + XINT (c->total_lines);
3635 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3638 else if (!NILP (w->hchild))
3639 /* W is a horizontal combination. */
3641 c = XWINDOW (w->hchild);
3642 while (c)
3644 if (horflag)
3645 wset_left_col (c, make_number (pos));
3646 else
3647 wset_top_line (c, make_number (pos));
3648 window_resize_apply (c, horflag);
3649 if (horflag)
3650 pos = pos + XINT (c->total_cols);
3651 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3655 /* Clear out some redisplay caches. */
3656 w->last_modified = 0;
3657 w->last_overlay_modified = 0;
3661 DEFUN ("window-resize-apply", Fwindow_resize_apply, Swindow_resize_apply, 1, 2, 0,
3662 doc: /* Apply requested size values for window-tree of FRAME.
3663 Optional argument HORIZONTAL omitted or nil means apply requested height
3664 values. HORIZONTAL non-nil means apply requested width values.
3666 This function checks whether the requested values sum up to a valid
3667 window layout, recursively assigns the new sizes of all child windows
3668 and calculates and assigns the new start positions of these windows.
3670 Note: This function does not check any of `window-fixed-size-p',
3671 `window-min-height' or `window-min-width'. All these checks have to
3672 be applied on the Elisp level. */)
3673 (Lisp_Object frame, Lisp_Object horizontal)
3675 struct frame *f;
3676 struct window *r;
3677 int horflag = !NILP (horizontal);
3679 if (NILP (frame))
3680 frame = selected_frame;
3681 CHECK_LIVE_FRAME (frame);
3683 f = XFRAME (frame);
3684 r = XWINDOW (FRAME_ROOT_WINDOW (f));
3686 if (!window_resize_check (r, horflag)
3687 || ! EQ (r->new_total,
3688 (horflag ? r->total_cols : r->total_lines)))
3689 return Qnil;
3691 block_input ();
3692 window_resize_apply (r, horflag);
3694 windows_or_buffers_changed++;
3695 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3697 adjust_glyphs (f);
3698 unblock_input ();
3700 run_window_configuration_change_hook (f);
3702 return Qt;
3706 /* Resize frame F's windows when number of lines of F is set to SIZE.
3707 HORFLAG 1 means resize windows when number of columns of F is set to
3708 SIZE.
3710 This function can delete all windows but the selected one in order to
3711 satisfy the request. The result will be meaningful if and only if
3712 F's windows have meaningful sizes when you call this. */
3713 void
3714 resize_frame_windows (struct frame *f, int size, int horflag)
3716 Lisp_Object root = f->root_window;
3717 struct window *r = XWINDOW (root);
3718 Lisp_Object mini = f->minibuffer_window;
3719 struct window *m;
3720 /* new_size is the new size of the frame's root window. */
3721 int new_size = (horflag
3722 ? size
3723 : (size
3724 - FRAME_TOP_MARGIN (f)
3725 - ((FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3726 ? 1 : 0)));
3728 wset_top_line (r, make_number (FRAME_TOP_MARGIN (f)));
3729 if (NILP (r->vchild) && NILP (r->hchild))
3730 /* For a leaf root window just set the size. */
3731 if (horflag)
3732 wset_total_cols (r, make_number (new_size));
3733 else
3734 wset_total_lines (r, make_number (new_size));
3735 else
3737 /* old_size is the old size of the frame's root window. */
3738 int old_size = XFASTINT (horflag ? r->total_cols
3739 : r->total_lines);
3740 Lisp_Object delta;
3742 XSETINT (delta, new_size - old_size);
3743 /* Try a "normal" resize first. */
3744 resize_root_window (root, delta, horflag ? Qt : Qnil, Qnil);
3745 if (window_resize_check (r, horflag)
3746 && new_size == XINT (r->new_total))
3747 window_resize_apply (r, horflag);
3748 else
3750 /* Try with "reasonable" minimum sizes next. */
3751 resize_root_window (root, delta, horflag ? Qt : Qnil, Qt);
3752 if (window_resize_check (r, horflag)
3753 && new_size == XINT (r->new_total))
3754 window_resize_apply (r, horflag);
3755 else
3757 /* Finally, try with "safe" minimum sizes. */
3758 resize_root_window (root, delta, horflag ? Qt : Qnil, Qsafe);
3759 if (window_resize_check (r, horflag)
3760 && new_size == XINT (r->new_total))
3761 window_resize_apply (r, horflag);
3762 else
3764 /* We lost. Delete all windows but the frame's
3765 selected one. */
3766 root = f->selected_window;
3767 Fdelete_other_windows_internal (root, Qnil);
3768 if (horflag)
3769 wset_total_cols (XWINDOW (root), make_number (new_size));
3770 else
3771 wset_total_lines (XWINDOW (root), make_number (new_size));
3777 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3779 m = XWINDOW (mini);
3780 if (horflag)
3781 wset_total_cols (m, make_number (size));
3782 else
3784 /* Are we sure we always want 1 line here? */
3785 wset_total_lines (m, make_number (1));
3786 wset_top_line
3787 (m, make_number (XINT (r->top_line) + XINT (r->total_lines)));
3791 windows_or_buffers_changed++;
3795 DEFUN ("split-window-internal", Fsplit_window_internal, Ssplit_window_internal, 4, 4, 0,
3796 doc: /* Split window OLD.
3797 Second argument TOTAL-SIZE specifies the number of lines or columns of the
3798 new window. In any case TOTAL-SIZE must be a positive integer.
3800 Third argument SIDE nil (or `below') specifies that the new window shall
3801 be located below WINDOW. SIDE `above' means the new window shall be
3802 located above WINDOW. In both cases TOTAL-SIZE specifies the number of
3803 lines of the new window including space reserved for the mode and/or
3804 header line.
3806 SIDE t (or `right') specifies that the new window shall be located on
3807 the right side of WINDOW. SIDE `left' means the new window shall be
3808 located on the left of WINDOW. In both cases TOTAL-SIZE specifies the
3809 number of columns of the new window including space reserved for fringes
3810 and the scrollbar or a divider column.
3812 Fourth argument NORMAL-SIZE specifies the normal size of the new window
3813 according to the SIDE argument.
3815 The new total and normal sizes of all involved windows must have been
3816 set correctly. See the code of `split-window' for how this is done. */)
3817 (Lisp_Object old, Lisp_Object total_size, Lisp_Object side, Lisp_Object normal_size)
3819 /* OLD (*o) is the window we have to split. (*p) is either OLD's
3820 parent window or an internal window we have to install as OLD's new
3821 parent. REFERENCE (*r) must denote a live window, or is set to OLD
3822 provided OLD is a leaf window, or to the frame's selected window.
3823 NEW (*n) is the new window created with some parameters taken from
3824 REFERENCE (*r). */
3825 register Lisp_Object new, frame, reference;
3826 register struct window *o, *p, *n, *r;
3827 struct frame *f;
3828 int horflag
3829 /* HORFLAG is 1 when we split side-by-side, 0 otherwise. */
3830 = EQ (side, Qt) || EQ (side, Qleft) || EQ (side, Qright);
3831 int combination_limit = 0;
3833 CHECK_WINDOW (old);
3834 o = XWINDOW (old);
3835 frame = WINDOW_FRAME (o);
3836 f = XFRAME (frame);
3838 CHECK_NUMBER (total_size);
3840 /* Set combination_limit to 1 if we have to make a new parent window.
3841 We do that if either `window-combination-limit' is t, or OLD has no
3842 parent, or OLD is ortho-combined. */
3843 combination_limit =
3844 EQ (Vwindow_combination_limit, Qt)
3845 || NILP (o->parent)
3846 || NILP (horflag
3847 ? (XWINDOW (o->parent)->hchild)
3848 : (XWINDOW (o->parent)->vchild));
3850 /* We need a live reference window to initialize some parameters. */
3851 if (WINDOW_LIVE_P (old))
3852 /* OLD is live, use it as reference window. */
3853 reference = old;
3854 else
3855 /* Use the frame's selected window as reference window. */
3856 reference = FRAME_SELECTED_WINDOW (f);
3857 r = XWINDOW (reference);
3859 /* The following bugs are caught by `split-window'. */
3860 if (MINI_WINDOW_P (o))
3861 error ("Attempt to split minibuffer window");
3862 else if (XINT (total_size) < (horflag ? 2 : 1))
3863 error ("Size of new window too small (after split)");
3864 else if (!combination_limit && !NILP (Vwindow_combination_resize))
3865 /* `window-combination-resize' non-nil means try to resize OLD's siblings
3866 proportionally. */
3868 p = XWINDOW (o->parent);
3869 /* Temporarily pretend we split the parent window. */
3870 wset_new_total
3871 (p, make_number (XINT (horflag ? p->total_cols : p->total_lines)
3872 - XINT (total_size)));
3873 if (!window_resize_check (p, horflag))
3874 error ("Window sizes don't fit");
3875 else
3876 /* Undo the temporary pretension. */
3877 wset_new_total (p, horflag ? p->total_cols : p->total_lines);
3879 else
3881 if (!window_resize_check (o, horflag))
3882 error ("Resizing old window failed");
3883 else if (XINT (total_size) + XINT (o->new_total)
3884 != XINT (horflag ? o->total_cols : o->total_lines))
3885 error ("Sum of sizes of old and new window don't fit");
3888 /* This is our point of no return. */
3889 if (combination_limit)
3891 /* Save the old value of o->normal_cols/lines. It gets corrupted
3892 by make_parent_window and we need it below for assigning it to
3893 p->new_normal. */
3894 Lisp_Object new_normal
3895 = horflag ? o->normal_cols : o->normal_lines;
3897 make_parent_window (old, horflag);
3898 p = XWINDOW (o->parent);
3899 if (EQ (Vwindow_combination_limit, Qt))
3900 /* Store t in the new parent's combination_limit slot to avoid
3901 that its children get merged into another window. */
3902 wset_combination_limit (p, Qt);
3903 /* These get applied below. */
3904 wset_new_total (p, horflag ? o->total_cols : o->total_lines);
3905 wset_new_normal (p, new_normal);
3907 else
3908 p = XWINDOW (o->parent);
3910 windows_or_buffers_changed++;
3911 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3912 new = make_window ();
3913 n = XWINDOW (new);
3914 wset_frame (n, frame);
3915 wset_parent (n, o->parent);
3916 wset_vchild (n, Qnil);
3917 wset_hchild (n, Qnil);
3919 if (EQ (side, Qabove) || EQ (side, Qleft))
3921 wset_prev (n, o->prev);
3922 if (NILP (n->prev))
3923 if (horflag)
3924 wset_hchild (p, new);
3925 else
3926 wset_vchild (p, new);
3927 else
3928 wset_next (XWINDOW (n->prev), new);
3929 wset_next (n, old);
3930 wset_prev (o, new);
3932 else
3934 wset_next (n, o->next);
3935 if (!NILP (n->next))
3936 wset_prev (XWINDOW (n->next), new);
3937 wset_prev (n, old);
3938 wset_next (o, new);
3941 wset_buffer (n, Qt);
3942 wset_window_end_valid (n, Qnil);
3943 memset (&n->last_cursor, 0, sizeof n->last_cursor);
3945 /* Get special geometry settings from reference window. */
3946 wset_left_margin_cols (n, r->left_margin_cols);
3947 wset_right_margin_cols (n, r->right_margin_cols);
3948 wset_left_fringe_width (n, r->left_fringe_width);
3949 wset_right_fringe_width (n, r->right_fringe_width);
3950 n->fringes_outside_margins = r->fringes_outside_margins;
3951 wset_scroll_bar_width (n, r->scroll_bar_width);
3952 wset_vertical_scroll_bar_type (n, r->vertical_scroll_bar_type);
3954 /* Directly assign orthogonal coordinates and sizes. */
3955 if (horflag)
3957 wset_top_line (n, o->top_line);
3958 wset_total_lines (n, o->total_lines);
3960 else
3962 wset_left_col (n, o->left_col);
3963 wset_total_cols (n, o->total_cols);
3966 /* Iso-coordinates and sizes are assigned by window_resize_apply,
3967 get them ready here. */
3968 wset_new_total (n, total_size);
3969 wset_new_normal (n, normal_size);
3971 block_input ();
3972 window_resize_apply (p, horflag);
3973 adjust_glyphs (f);
3974 /* Set buffer of NEW to buffer of reference window. Don't run
3975 any hooks. */
3976 set_window_buffer (new, r->buffer, 0, 1);
3977 unblock_input ();
3979 /* Maybe we should run the scroll functions in Elisp (which already
3980 runs the configuration change hook). */
3981 if (! NILP (Vwindow_scroll_functions))
3982 run_hook_with_args_2 (Qwindow_scroll_functions, new,
3983 Fmarker_position (n->start));
3984 /* Return NEW. */
3985 return new;
3989 DEFUN ("delete-window-internal", Fdelete_window_internal, Sdelete_window_internal, 1, 1, 0,
3990 doc: /* Remove WINDOW from its frame.
3991 WINDOW defaults to the selected window. Return nil.
3992 Signal an error when WINDOW is the only window on its frame. */)
3993 (register Lisp_Object window)
3995 register Lisp_Object parent, sibling, frame, root;
3996 struct window *w, *p, *s, *r;
3997 struct frame *f;
3998 int horflag;
3999 int before_sibling = 0;
4001 w = decode_any_window (window);
4002 XSETWINDOW (window, w);
4003 if (NILP (w->buffer)
4004 && NILP (w->hchild) && NILP (w->vchild))
4005 /* It's a no-op to delete an already deleted window. */
4006 return Qnil;
4008 parent = w->parent;
4009 if (NILP (parent))
4010 /* Never delete a minibuffer or frame root window. */
4011 error ("Attempt to delete minibuffer or sole ordinary window");
4012 else if (NILP (w->prev) && NILP (w->next))
4013 /* Rather bow out here, this case should be handled on the Elisp
4014 level. */
4015 error ("Attempt to delete sole window of parent");
4017 p = XWINDOW (parent);
4018 horflag = NILP (p->vchild);
4020 frame = WINDOW_FRAME (w);
4021 f = XFRAME (frame);
4023 root = FRAME_ROOT_WINDOW (f);
4024 r = XWINDOW (root);
4026 /* Unlink WINDOW from window tree. */
4027 if (NILP (w->prev))
4028 /* Get SIBLING below (on the right of) WINDOW. */
4030 /* before_sibling 1 means WINDOW is the first child of its
4031 parent and thus before the sibling. */
4032 before_sibling = 1;
4033 sibling = w->next;
4034 s = XWINDOW (sibling);
4035 wset_prev (s, Qnil);
4036 if (horflag)
4037 wset_hchild (p, sibling);
4038 else
4039 wset_vchild (p, sibling);
4041 else
4042 /* Get SIBLING above (on the left of) WINDOW. */
4044 sibling = w->prev;
4045 s = XWINDOW (sibling);
4046 wset_next (s, w->next);
4047 if (!NILP (s->next))
4048 wset_prev (XWINDOW (s->next), sibling);
4051 if (window_resize_check (r, horflag)
4052 && EQ (r->new_total,
4053 (horflag ? r->total_cols : r->total_lines)))
4054 /* We can delete WINDOW now. */
4057 /* Block input. */
4058 block_input ();
4059 window_resize_apply (p, horflag);
4061 /* If this window is referred to by the dpyinfo's mouse
4062 highlight, invalidate that slot to be safe (Bug#9904). */
4063 if (!FRAME_INITIAL_P (f))
4065 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
4067 if (EQ (hlinfo->mouse_face_window, window))
4068 hlinfo->mouse_face_window = Qnil;
4071 windows_or_buffers_changed++;
4072 Vwindow_list = Qnil;
4073 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4075 wset_next (w, Qnil); /* Don't delete w->next too. */
4076 free_window_matrices (w);
4078 if (!NILP (w->vchild))
4080 delete_all_child_windows (w->vchild);
4081 wset_vchild (w, Qnil);
4083 else if (!NILP (w->hchild))
4085 delete_all_child_windows (w->hchild);
4086 wset_hchild (w, Qnil);
4088 else if (!NILP (w->buffer))
4090 unshow_buffer (w);
4091 unchain_marker (XMARKER (w->pointm));
4092 unchain_marker (XMARKER (w->start));
4093 wset_buffer (w, Qnil);
4096 if (NILP (s->prev) && NILP (s->next))
4097 /* A matrjoshka where SIBLING has become the only child of
4098 PARENT. */
4100 /* Put SIBLING into PARENT's place. */
4101 replace_window (parent, sibling, 0);
4102 /* Have SIBLING inherit the following three slot values from
4103 PARENT (the combination_limit slot is not inherited). */
4104 wset_normal_cols (s, p->normal_cols);
4105 wset_normal_lines (s, p->normal_lines);
4106 /* Mark PARENT as deleted. */
4107 wset_vchild (p, Qnil);
4108 wset_hchild (p, Qnil);
4109 /* Try to merge SIBLING into its new parent. */
4110 recombine_windows (sibling);
4113 adjust_glyphs (f);
4115 if (!WINDOW_LIVE_P (FRAME_SELECTED_WINDOW (f)))
4116 /* We deleted the frame's selected window. */
4118 /* Use the frame's first window as fallback ... */
4119 Lisp_Object new_selected_window = Fframe_first_window (frame);
4120 /* ... but preferably use its most recently used window. */
4121 Lisp_Object mru_window;
4123 /* `get-mru-window' might fail for some reason so play it safe
4124 - promote the first window _without recording it_ first. */
4125 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4126 Fselect_window (new_selected_window, Qt);
4127 else
4128 fset_selected_window (f, new_selected_window);
4130 unblock_input ();
4132 /* Now look whether `get-mru-window' gets us something. */
4133 mru_window = call1 (Qget_mru_window, frame);
4134 if (WINDOW_LIVE_P (mru_window)
4135 && EQ (XWINDOW (mru_window)->frame, frame))
4136 new_selected_window = mru_window;
4138 /* If all ended up well, we now promote the mru window. */
4139 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4140 Fselect_window (new_selected_window, Qnil);
4141 else
4142 fset_selected_window (f, new_selected_window);
4144 else
4145 unblock_input ();
4147 /* Must be run by the caller:
4148 run_window_configuration_change_hook (f); */
4150 else
4151 /* We failed: Relink WINDOW into window tree. */
4153 if (before_sibling)
4155 wset_prev (s, window);
4156 if (horflag)
4157 wset_hchild (p, window);
4158 else
4159 wset_vchild (p, window);
4161 else
4163 wset_next (s, window);
4164 if (!NILP (w->next))
4165 wset_prev (XWINDOW (w->next), window);
4167 error ("Deletion failed");
4170 return Qnil;
4173 /***********************************************************************
4174 Resizing Mini-Windows
4175 ***********************************************************************/
4177 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we
4178 can. */
4179 void
4180 grow_mini_window (struct window *w, int delta)
4182 struct frame *f = XFRAME (w->frame);
4183 struct window *r;
4184 Lisp_Object root, value;
4186 eassert (MINI_WINDOW_P (w));
4187 eassert (delta >= 0);
4189 root = FRAME_ROOT_WINDOW (f);
4190 r = XWINDOW (root);
4191 value = call2 (Qwindow_resize_root_window_vertically,
4192 root, make_number (- delta));
4193 if (INTEGERP (value) && window_resize_check (r, 0))
4195 block_input ();
4196 window_resize_apply (r, 0);
4198 /* Grow the mini-window. */
4199 wset_top_line
4200 (w, make_number (XFASTINT (r->top_line) + XFASTINT (r->total_lines)));
4201 wset_total_lines
4202 (w, make_number (XFASTINT (w->total_lines) - XINT (value)));
4203 w->last_modified = 0;
4204 w->last_overlay_modified = 0;
4206 windows_or_buffers_changed++;
4207 adjust_glyphs (f);
4208 unblock_input ();
4213 /* Shrink mini-window W. */
4214 void
4215 shrink_mini_window (struct window *w)
4217 struct frame *f = XFRAME (w->frame);
4218 struct window *r;
4219 Lisp_Object root, value;
4220 EMACS_INT size;
4222 eassert (MINI_WINDOW_P (w));
4224 size = XINT (w->total_lines);
4225 if (size > 1)
4227 root = FRAME_ROOT_WINDOW (f);
4228 r = XWINDOW (root);
4229 value = call2 (Qwindow_resize_root_window_vertically,
4230 root, make_number (size - 1));
4231 if (INTEGERP (value) && window_resize_check (r, 0))
4233 block_input ();
4234 window_resize_apply (r, 0);
4236 /* Shrink the mini-window. */
4237 wset_top_line (w, make_number (XFASTINT (r->top_line)
4238 + XFASTINT (r->total_lines)));
4239 wset_total_lines (w, make_number (1));
4241 w->last_modified = 0;
4242 w->last_overlay_modified = 0;
4244 windows_or_buffers_changed++;
4245 adjust_glyphs (f);
4246 unblock_input ();
4248 /* If the above failed for whatever strange reason we must make a
4249 one window frame here. The same routine will be needed when
4250 shrinking the frame (and probably when making the initial
4251 *scratch* window). For the moment leave things as they are. */
4255 DEFUN ("resize-mini-window-internal", Fresize_mini_window_internal, Sresize_mini_window_internal, 1, 1, 0,
4256 doc: /* Resize minibuffer window WINDOW. */)
4257 (Lisp_Object window)
4259 struct window *w = XWINDOW (window);
4260 struct window *r;
4261 struct frame *f;
4262 int height;
4264 CHECK_WINDOW (window);
4265 f = XFRAME (w->frame);
4267 if (!EQ (FRAME_MINIBUF_WINDOW (XFRAME (w->frame)), window))
4268 error ("Not a valid minibuffer window");
4269 else if (FRAME_MINIBUF_ONLY_P (f))
4270 error ("Cannot resize a minibuffer-only frame");
4272 r = XWINDOW (FRAME_ROOT_WINDOW (f));
4273 height = XINT (r->total_lines) + XINT (w->total_lines);
4274 if (window_resize_check (r, 0)
4275 && XINT (w->new_total) > 0
4276 && height == XINT (r->new_total) + XINT (w->new_total))
4278 block_input ();
4279 window_resize_apply (r, 0);
4281 wset_total_lines (w, w->new_total);
4282 wset_top_line (w, make_number (XINT (r->top_line)
4283 + XINT (r->total_lines)));
4285 windows_or_buffers_changed++;
4286 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4287 adjust_glyphs (f);
4288 unblock_input ();
4290 run_window_configuration_change_hook (f);
4291 return Qt;
4293 else error ("Failed to resize minibuffer window");
4296 /* Mark window cursors off for all windows in the window tree rooted
4297 at W by setting their phys_cursor_on_p flag to zero. Called from
4298 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4299 the frame are cleared. */
4301 void
4302 mark_window_cursors_off (struct window *w)
4304 while (w)
4306 if (!NILP (w->hchild))
4307 mark_window_cursors_off (XWINDOW (w->hchild));
4308 else if (!NILP (w->vchild))
4309 mark_window_cursors_off (XWINDOW (w->vchild));
4310 else
4311 w->phys_cursor_on_p = 0;
4313 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4318 /* Return number of lines of text (not counting mode lines) in W. */
4321 window_internal_height (struct window *w)
4323 int ht = XFASTINT (w->total_lines);
4325 if (!MINI_WINDOW_P (w))
4327 if (!NILP (w->parent)
4328 || !NILP (w->vchild)
4329 || !NILP (w->hchild)
4330 || !NILP (w->next)
4331 || !NILP (w->prev)
4332 || WINDOW_WANTS_MODELINE_P (w))
4333 --ht;
4335 if (WINDOW_WANTS_HEADER_LINE_P (w))
4336 --ht;
4339 return ht;
4342 /************************************************************************
4343 Window Scrolling
4344 ***********************************************************************/
4346 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4347 N screen-fulls, which is defined as the height of the window minus
4348 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4349 instead. Negative values of N mean scroll down. NOERROR non-zero
4350 means don't signal an error if we try to move over BEGV or ZV,
4351 respectively. */
4353 static void
4354 window_scroll (Lisp_Object window, EMACS_INT n, int whole, int noerror)
4356 immediate_quit = 1;
4357 n = clip_to_bounds (INT_MIN, n, INT_MAX);
4359 /* If we must, use the pixel-based version which is much slower than
4360 the line-based one but can handle varying line heights. */
4361 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4362 window_scroll_pixel_based (window, n, whole, noerror);
4363 else
4364 window_scroll_line_based (window, n, whole, noerror);
4366 immediate_quit = 0;
4370 /* Implementation of window_scroll that works based on pixel line
4371 heights. See the comment of window_scroll for parameter
4372 descriptions. */
4374 static void
4375 window_scroll_pixel_based (Lisp_Object window, int n, int whole, int noerror)
4377 struct it it;
4378 struct window *w = XWINDOW (window);
4379 struct text_pos start;
4380 int this_scroll_margin;
4381 /* True if we fiddled the window vscroll field without really scrolling. */
4382 int vscrolled = 0;
4383 int x, y, rtop, rbot, rowh, vpos;
4384 void *itdata = NULL;
4386 SET_TEXT_POS_FROM_MARKER (start, w->start);
4387 /* Scrolling a minibuffer window via scroll bar when the echo area
4388 shows long text sometimes resets the minibuffer contents behind
4389 our backs. */
4390 if (CHARPOS (start) > ZV)
4391 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
4393 /* If PT is not visible in WINDOW, move back one half of
4394 the screen. Allow PT to be partially visible, otherwise
4395 something like (scroll-down 1) with PT in the line before
4396 the partially visible one would recenter. */
4398 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4400 itdata = bidi_shelve_cache ();
4401 /* Move backward half the height of the window. Performance note:
4402 vmotion used here is about 10% faster, but would give wrong
4403 results for variable height lines. */
4404 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4405 it.current_y = it.last_visible_y;
4406 move_it_vertically_backward (&it, window_box_height (w) / 2);
4408 /* The function move_iterator_vertically may move over more than
4409 the specified y-distance. If it->w is small, e.g. a
4410 mini-buffer window, we may end up in front of the window's
4411 display area. This is the case when Start displaying at the
4412 start of the line containing PT in this case. */
4413 if (it.current_y <= 0)
4415 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4416 move_it_vertically_backward (&it, 0);
4417 it.current_y = 0;
4420 start = it.current.pos;
4421 bidi_unshelve_cache (itdata, 0);
4423 else if (auto_window_vscroll_p)
4425 if (rtop || rbot) /* partially visible */
4427 int px;
4428 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4429 if (whole)
4430 dy = max ((window_box_height (w)
4431 - next_screen_context_lines * dy),
4432 dy);
4433 dy *= n;
4435 if (n < 0)
4437 /* Only vscroll backwards if already vscrolled forwards. */
4438 if (w->vscroll < 0 && rtop > 0)
4440 px = max (0, -w->vscroll - min (rtop, -dy));
4441 Fset_window_vscroll (window, make_number (px), Qt);
4442 return;
4445 if (n > 0)
4447 /* Do vscroll if already vscrolled or only display line. */
4448 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4450 px = max (0, -w->vscroll + min (rbot, dy));
4451 Fset_window_vscroll (window, make_number (px), Qt);
4452 return;
4455 /* Maybe modify window start instead of scrolling. */
4456 if (rbot > 0 || w->vscroll < 0)
4458 ptrdiff_t spos;
4460 Fset_window_vscroll (window, make_number (0), Qt);
4461 /* If there are other text lines above the current row,
4462 move window start to current row. Else to next row. */
4463 if (rbot > 0)
4464 spos = XINT (Fline_beginning_position (Qnil));
4465 else
4466 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4467 set_marker_restricted (w->start, make_number (spos),
4468 w->buffer);
4469 w->start_at_line_beg = 1;
4470 w->update_mode_line = 1;
4471 w->last_modified = 0;
4472 w->last_overlay_modified = 0;
4473 /* Set force_start so that redisplay_window will run the
4474 window-scroll-functions. */
4475 w->force_start = 1;
4476 return;
4480 /* Cancel previous vscroll. */
4481 Fset_window_vscroll (window, make_number (0), Qt);
4484 itdata = bidi_shelve_cache ();
4485 /* If scroll_preserve_screen_position is non-nil, we try to set
4486 point in the same window line as it is now, so get that line. */
4487 if (!NILP (Vscroll_preserve_screen_position))
4489 /* We preserve the goal pixel coordinate across consecutive
4490 calls to scroll-up, scroll-down and other commands that
4491 have the `scroll-command' property. This avoids the
4492 possibility of point becoming "stuck" on a tall line when
4493 scrolling by one line. */
4494 if (window_scroll_pixel_based_preserve_y < 0
4495 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4496 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4498 start_display (&it, w, start);
4499 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4500 window_scroll_pixel_based_preserve_y = it.current_y;
4501 window_scroll_pixel_based_preserve_x = it.current_x;
4504 else
4505 window_scroll_pixel_based_preserve_y
4506 = window_scroll_pixel_based_preserve_x = -1;
4508 /* Move iterator it from start the specified distance forward or
4509 backward. The result is the new window start. */
4510 start_display (&it, w, start);
4511 if (whole)
4513 ptrdiff_t start_pos = IT_CHARPOS (it);
4514 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4515 dy = max ((window_box_height (w)
4516 - next_screen_context_lines * dy),
4517 dy) * n;
4519 /* Note that move_it_vertically always moves the iterator to the
4520 start of a line. So, if the last line doesn't have a newline,
4521 we would end up at the start of the line ending at ZV. */
4522 if (dy <= 0)
4524 move_it_vertically_backward (&it, -dy);
4525 /* Ensure we actually do move, e.g. in case we are currently
4526 looking at an image that is taller that the window height. */
4527 while (start_pos == IT_CHARPOS (it)
4528 && start_pos > BEGV)
4529 move_it_by_lines (&it, -1);
4531 else if (dy > 0)
4533 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4534 MOVE_TO_POS | MOVE_TO_Y);
4535 /* Ensure we actually do move, e.g. in case we are currently
4536 looking at an image that is taller that the window height. */
4537 while (start_pos == IT_CHARPOS (it)
4538 && start_pos < ZV)
4539 move_it_by_lines (&it, 1);
4542 else
4543 move_it_by_lines (&it, n);
4545 /* We failed if we find ZV is already on the screen (scrolling up,
4546 means there's nothing past the end), or if we can't start any
4547 earlier (scrolling down, means there's nothing past the top). */
4548 if ((n > 0 && IT_CHARPOS (it) == ZV)
4549 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4551 if (IT_CHARPOS (it) == ZV)
4553 if (it.current_y < it.last_visible_y
4554 && (it.current_y + it.max_ascent + it.max_descent
4555 > it.last_visible_y))
4557 /* The last line was only partially visible, make it fully
4558 visible. */
4559 w->vscroll = (it.last_visible_y
4560 - it.current_y + it.max_ascent + it.max_descent);
4561 adjust_glyphs (it.f);
4563 else
4565 bidi_unshelve_cache (itdata, 0);
4566 if (noerror)
4567 return;
4568 else if (n < 0) /* could happen with empty buffers */
4569 xsignal0 (Qbeginning_of_buffer);
4570 else
4571 xsignal0 (Qend_of_buffer);
4574 else
4576 if (w->vscroll != 0)
4577 /* The first line was only partially visible, make it fully
4578 visible. */
4579 w->vscroll = 0;
4580 else
4582 bidi_unshelve_cache (itdata, 0);
4583 if (noerror)
4584 return;
4585 else
4586 xsignal0 (Qbeginning_of_buffer);
4590 /* If control gets here, then we vscrolled. */
4592 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4594 /* Don't try to change the window start below. */
4595 vscrolled = 1;
4598 if (! vscrolled)
4600 ptrdiff_t pos = IT_CHARPOS (it);
4601 ptrdiff_t bytepos;
4603 /* If in the middle of a multi-glyph character move forward to
4604 the next character. */
4605 if (in_display_vector_p (&it))
4607 ++pos;
4608 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4611 /* Set the window start, and set up the window for redisplay. */
4612 set_marker_restricted (w->start, make_number (pos),
4613 w->buffer);
4614 bytepos = XMARKER (w->start)->bytepos;
4615 w->start_at_line_beg = (pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n');
4616 w->update_mode_line = 1;
4617 w->last_modified = 0;
4618 w->last_overlay_modified = 0;
4619 /* Set force_start so that redisplay_window will run the
4620 window-scroll-functions. */
4621 w->force_start = 1;
4624 /* The rest of this function uses current_y in a nonstandard way,
4625 not including the height of the header line if any. */
4626 it.current_y = it.vpos = 0;
4628 /* Move PT out of scroll margins.
4629 This code wants current_y to be zero at the window start position
4630 even if there is a header line. */
4631 this_scroll_margin = max (0, scroll_margin);
4632 this_scroll_margin
4633 = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
4634 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
4636 if (n > 0)
4638 /* We moved the window start towards ZV, so PT may be now
4639 in the scroll margin at the top. */
4640 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4641 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
4642 && (NILP (Vscroll_preserve_screen_position)
4643 || EQ (Vscroll_preserve_screen_position, Qt)))
4644 /* We found PT at a legitimate height. Leave it alone. */
4646 else if (window_scroll_pixel_based_preserve_y >= 0)
4648 /* If we have a header line, take account of it.
4649 This is necessary because we set it.current_y to 0, above. */
4650 move_it_to (&it, -1,
4651 window_scroll_pixel_based_preserve_x,
4652 window_scroll_pixel_based_preserve_y
4653 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
4654 -1, MOVE_TO_Y | MOVE_TO_X);
4655 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4657 else
4659 while (it.current_y < this_scroll_margin)
4661 int prev = it.current_y;
4662 move_it_by_lines (&it, 1);
4663 if (prev == it.current_y)
4664 break;
4666 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4669 else if (n < 0)
4671 ptrdiff_t charpos, bytepos;
4672 int partial_p;
4674 /* Save our position, for the
4675 window_scroll_pixel_based_preserve_y case. */
4676 charpos = IT_CHARPOS (it);
4677 bytepos = IT_BYTEPOS (it);
4679 /* We moved the window start towards BEGV, so PT may be now
4680 in the scroll margin at the bottom. */
4681 move_it_to (&it, PT, -1,
4682 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
4683 - this_scroll_margin - 1),
4685 MOVE_TO_POS | MOVE_TO_Y);
4687 /* Save our position, in case it's correct. */
4688 charpos = IT_CHARPOS (it);
4689 bytepos = IT_BYTEPOS (it);
4691 /* See if point is on a partially visible line at the end. */
4692 if (it.what == IT_EOB)
4693 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
4694 else
4696 move_it_by_lines (&it, 1);
4697 partial_p = it.current_y > it.last_visible_y;
4700 if (charpos == PT && !partial_p
4701 && (NILP (Vscroll_preserve_screen_position)
4702 || EQ (Vscroll_preserve_screen_position, Qt)))
4703 /* We found PT before we found the display margin, so PT is ok. */
4705 else if (window_scroll_pixel_based_preserve_y >= 0)
4707 SET_TEXT_POS_FROM_MARKER (start, w->start);
4708 start_display (&it, w, start);
4709 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
4710 here because we called start_display again and did not
4711 alter it.current_y this time. */
4712 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
4713 window_scroll_pixel_based_preserve_y, -1,
4714 MOVE_TO_Y | MOVE_TO_X);
4715 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4717 else
4719 if (partial_p)
4720 /* The last line was only partially visible, so back up two
4721 lines to make sure we're on a fully visible line. */
4723 move_it_by_lines (&it, -2);
4724 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4726 else
4727 /* No, the position we saved is OK, so use it. */
4728 SET_PT_BOTH (charpos, bytepos);
4731 bidi_unshelve_cache (itdata, 0);
4735 /* Implementation of window_scroll that works based on screen lines.
4736 See the comment of window_scroll for parameter descriptions. */
4738 static void
4739 window_scroll_line_based (Lisp_Object window, int n, int whole, int noerror)
4741 register struct window *w = XWINDOW (window);
4742 /* Fvertical_motion enters redisplay, which can trigger
4743 fontification, which in turn can modify buffer text (e.g., if the
4744 fontification functions replace escape sequences with faces, as
4745 in `grep-mode-font-lock-keywords'). So we use a marker to record
4746 the old point position, to prevent crashes in SET_PT_BOTH. */
4747 Lisp_Object opoint_marker = Fpoint_marker ();
4748 register ptrdiff_t pos, pos_byte;
4749 register int ht = window_internal_height (w);
4750 register Lisp_Object tem;
4751 int lose;
4752 Lisp_Object bolp;
4753 ptrdiff_t startpos;
4754 Lisp_Object original_pos = Qnil;
4756 /* If scrolling screen-fulls, compute the number of lines to
4757 scroll from the window's height. */
4758 if (whole)
4759 n *= max (1, ht - next_screen_context_lines);
4761 startpos = marker_position (w->start);
4763 if (!NILP (Vscroll_preserve_screen_position))
4765 if (window_scroll_preserve_vpos <= 0
4766 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4767 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4769 struct position posit
4770 = *compute_motion (startpos, 0, 0, 0,
4771 PT, ht, 0,
4772 -1, w->hscroll,
4773 0, w);
4774 window_scroll_preserve_vpos = posit.vpos;
4775 window_scroll_preserve_hpos = posit.hpos + w->hscroll;
4778 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
4779 make_number (window_scroll_preserve_vpos));
4782 XSETFASTINT (tem, PT);
4783 tem = Fpos_visible_in_window_p (tem, window, Qnil);
4785 if (NILP (tem))
4787 Fvertical_motion (make_number (- (ht / 2)), window);
4788 startpos = PT;
4791 SET_PT (startpos);
4792 lose = n < 0 && PT == BEGV;
4793 Fvertical_motion (make_number (n), window);
4794 pos = PT;
4795 pos_byte = PT_BYTE;
4796 bolp = Fbolp ();
4797 SET_PT_BOTH (marker_position (opoint_marker),
4798 marker_byte_position (opoint_marker));
4800 if (lose)
4802 if (noerror)
4803 return;
4804 else
4805 xsignal0 (Qbeginning_of_buffer);
4808 if (pos < ZV)
4810 /* Don't use a scroll margin that is negative or too large. */
4811 int this_scroll_margin =
4812 max (0, min (scroll_margin, XINT (w->total_lines) / 4));
4814 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
4815 w->start_at_line_beg = !NILP (bolp);
4816 w->update_mode_line = 1;
4817 w->last_modified = 0;
4818 w->last_overlay_modified = 0;
4819 /* Set force_start so that redisplay_window will run
4820 the window-scroll-functions. */
4821 w->force_start = 1;
4823 if (!NILP (Vscroll_preserve_screen_position)
4824 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
4826 SET_PT_BOTH (pos, pos_byte);
4827 Fvertical_motion (original_pos, window);
4829 /* If we scrolled forward, put point enough lines down
4830 that it is outside the scroll margin. */
4831 else if (n > 0)
4833 int top_margin;
4835 if (this_scroll_margin > 0)
4837 SET_PT_BOTH (pos, pos_byte);
4838 Fvertical_motion (make_number (this_scroll_margin), window);
4839 top_margin = PT;
4841 else
4842 top_margin = pos;
4844 if (top_margin <= marker_position (opoint_marker))
4845 SET_PT_BOTH (marker_position (opoint_marker),
4846 marker_byte_position (opoint_marker));
4847 else if (!NILP (Vscroll_preserve_screen_position))
4849 SET_PT_BOTH (pos, pos_byte);
4850 Fvertical_motion (original_pos, window);
4852 else
4853 SET_PT (top_margin);
4855 else if (n < 0)
4857 int bottom_margin;
4859 /* If we scrolled backward, put point near the end of the window
4860 but not within the scroll margin. */
4861 SET_PT_BOTH (pos, pos_byte);
4862 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
4863 if (XFASTINT (tem) == ht - this_scroll_margin)
4864 bottom_margin = PT;
4865 else
4866 bottom_margin = PT + 1;
4868 if (bottom_margin > marker_position (opoint_marker))
4869 SET_PT_BOTH (marker_position (opoint_marker),
4870 marker_byte_position (opoint_marker));
4871 else
4873 if (!NILP (Vscroll_preserve_screen_position))
4875 SET_PT_BOTH (pos, pos_byte);
4876 Fvertical_motion (original_pos, window);
4878 else
4879 Fvertical_motion (make_number (-1), window);
4883 else
4885 if (noerror)
4886 return;
4887 else
4888 xsignal0 (Qend_of_buffer);
4893 /* Scroll selected_window up or down. If N is nil, scroll a
4894 screen-full which is defined as the height of the window minus
4895 next_screen_context_lines. If N is the symbol `-', scroll.
4896 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4897 up. This is the guts of Fscroll_up and Fscroll_down. */
4899 static void
4900 scroll_command (Lisp_Object n, int direction)
4902 ptrdiff_t count = SPECPDL_INDEX ();
4904 eassert (eabs (direction) == 1);
4906 /* If selected window's buffer isn't current, make it current for
4907 the moment. But don't screw up if window_scroll gets an error. */
4908 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
4910 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4911 Fset_buffer (XWINDOW (selected_window)->buffer);
4913 /* Make redisplay consider other windows than just selected_window. */
4914 ++windows_or_buffers_changed;
4917 if (NILP (n))
4918 window_scroll (selected_window, direction, 1, 0);
4919 else if (EQ (n, Qminus))
4920 window_scroll (selected_window, -direction, 1, 0);
4921 else
4923 n = Fprefix_numeric_value (n);
4924 window_scroll (selected_window, XINT (n) * direction, 0, 0);
4927 unbind_to (count, Qnil);
4930 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
4931 doc: /* Scroll text of selected window upward ARG lines.
4932 If ARG is omitted or nil, scroll upward by a near full screen.
4933 A near full screen is `next-screen-context-lines' less than a full screen.
4934 Negative ARG means scroll downward.
4935 If ARG is the atom `-', scroll downward by nearly full screen.
4936 When calling from a program, supply as argument a number, nil, or `-'. */)
4937 (Lisp_Object arg)
4939 scroll_command (arg, 1);
4940 return Qnil;
4943 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
4944 doc: /* Scroll text of selected window down ARG lines.
4945 If ARG is omitted or nil, scroll down by a near full screen.
4946 A near full screen is `next-screen-context-lines' less than a full screen.
4947 Negative ARG means scroll upward.
4948 If ARG is the atom `-', scroll upward by nearly full screen.
4949 When calling from a program, supply as argument a number, nil, or `-'. */)
4950 (Lisp_Object arg)
4952 scroll_command (arg, -1);
4953 return Qnil;
4956 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
4957 doc: /* Return the other window for \"other window scroll\" commands.
4958 If `other-window-scroll-buffer' is non-nil, a window
4959 showing that buffer is used.
4960 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4961 specifies the window. This takes precedence over
4962 `other-window-scroll-buffer'. */)
4963 (void)
4965 Lisp_Object window;
4967 if (MINI_WINDOW_P (XWINDOW (selected_window))
4968 && !NILP (Vminibuf_scroll_window))
4969 window = Vminibuf_scroll_window;
4970 /* If buffer is specified, scroll that buffer. */
4971 else if (!NILP (Vother_window_scroll_buffer))
4973 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
4974 if (NILP (window))
4975 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
4977 else
4979 /* Nothing specified; look for a neighboring window on the same
4980 frame. */
4981 window = Fnext_window (selected_window, Qnil, Qnil);
4983 if (EQ (window, selected_window))
4984 /* That didn't get us anywhere; look for a window on another
4985 visible frame. */
4987 window = Fnext_window (window, Qnil, Qt);
4988 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
4989 && ! EQ (window, selected_window));
4992 CHECK_LIVE_WINDOW (window);
4994 if (EQ (window, selected_window))
4995 error ("There is no other window");
4997 return window;
5000 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
5001 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5002 A near full screen is `next-screen-context-lines' less than a full screen.
5003 The next window is the one below the current one; or the one at the top
5004 if the current one is at the bottom. Negative ARG means scroll downward.
5005 If ARG is the atom `-', scroll downward by nearly full screen.
5006 When calling from a program, supply as argument a number, nil, or `-'.
5008 If `other-window-scroll-buffer' is non-nil, scroll the window
5009 showing that buffer, popping the buffer up if necessary.
5010 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5011 specifies the window to scroll. This takes precedence over
5012 `other-window-scroll-buffer'. */)
5013 (Lisp_Object arg)
5015 Lisp_Object window;
5016 struct window *w;
5017 ptrdiff_t count = SPECPDL_INDEX ();
5019 window = Fother_window_for_scrolling ();
5020 w = XWINDOW (window);
5022 /* Don't screw up if window_scroll gets an error. */
5023 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5024 ++windows_or_buffers_changed;
5026 Fset_buffer (w->buffer);
5027 SET_PT (marker_position (w->pointm));
5029 if (NILP (arg))
5030 window_scroll (window, 1, 1, 1);
5031 else if (EQ (arg, Qminus))
5032 window_scroll (window, -1, 1, 1);
5033 else
5035 if (CONSP (arg))
5036 arg = XCAR (arg);
5037 CHECK_NUMBER (arg);
5038 window_scroll (window, XINT (arg), 0, 1);
5041 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5042 unbind_to (count, Qnil);
5044 return Qnil;
5047 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5048 doc: /* Scroll selected window display ARG columns left.
5049 Default for ARG is window width minus 2.
5050 Value is the total amount of leftward horizontal scrolling in
5051 effect after the change.
5052 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5053 lower bound for automatic scrolling, i.e. automatic scrolling
5054 will not scroll a window to a column less than the value returned
5055 by this function. This happens in an interactive call. */)
5056 (register Lisp_Object arg, Lisp_Object set_minimum)
5058 struct window *w = XWINDOW (selected_window);
5059 EMACS_INT requested_arg = (NILP (arg)
5060 ? window_body_cols (w) - 2
5061 : XINT (Fprefix_numeric_value (arg)));
5062 Lisp_Object result = set_window_hscroll (w, w->hscroll + requested_arg);
5064 if (!NILP (set_minimum))
5065 w->min_hscroll = w->hscroll;
5067 return result;
5070 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5071 doc: /* Scroll selected window display ARG columns right.
5072 Default for ARG is window width minus 2.
5073 Value is the total amount of leftward horizontal scrolling in
5074 effect after the change.
5075 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5076 lower bound for automatic scrolling, i.e. automatic scrolling
5077 will not scroll a window to a column less than the value returned
5078 by this function. This happens in an interactive call. */)
5079 (register Lisp_Object arg, Lisp_Object set_minimum)
5081 struct window *w = XWINDOW (selected_window);
5082 EMACS_INT requested_arg = (NILP (arg)
5083 ? window_body_cols (w) - 2
5084 : XINT (Fprefix_numeric_value (arg)));
5085 Lisp_Object result = set_window_hscroll (w, w->hscroll - requested_arg);
5087 if (!NILP (set_minimum))
5088 w->min_hscroll = w->hscroll;
5090 return result;
5093 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5094 doc: /* Return the window which was selected when entering the minibuffer.
5095 Returns nil, if selected window is not a minibuffer window. */)
5096 (void)
5098 if (minibuf_level > 0
5099 && MINI_WINDOW_P (XWINDOW (selected_window))
5100 && WINDOW_LIVE_P (minibuf_selected_window))
5101 return minibuf_selected_window;
5103 return Qnil;
5106 /* Value is the number of lines actually displayed in window W,
5107 as opposed to its height. */
5109 static int
5110 displayed_window_lines (struct window *w)
5112 struct it it;
5113 struct text_pos start;
5114 int height = window_box_height (w);
5115 struct buffer *old_buffer;
5116 int bottom_y;
5117 void *itdata = NULL;
5119 if (XBUFFER (w->buffer) != current_buffer)
5121 old_buffer = current_buffer;
5122 set_buffer_internal (XBUFFER (w->buffer));
5124 else
5125 old_buffer = NULL;
5127 /* In case W->start is out of the accessible range, do something
5128 reasonable. This happens in Info mode when Info-scroll-down
5129 calls (recenter -1) while W->start is 1. */
5130 if (XMARKER (w->start)->charpos < BEGV)
5131 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
5132 else if (XMARKER (w->start)->charpos > ZV)
5133 SET_TEXT_POS (start, ZV, ZV_BYTE);
5134 else
5135 SET_TEXT_POS_FROM_MARKER (start, w->start);
5137 itdata = bidi_shelve_cache ();
5138 start_display (&it, w, start);
5139 move_it_vertically (&it, height);
5140 bottom_y = line_bottom_y (&it);
5141 bidi_unshelve_cache (itdata, 0);
5143 /* rms: On a non-window display,
5144 the value of it.vpos at the bottom of the screen
5145 seems to be 1 larger than window_box_height (w).
5146 This kludge fixes a bug whereby (move-to-window-line -1)
5147 when ZV is on the last screen line
5148 moves to the previous screen line instead of the last one. */
5149 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5150 height++;
5152 /* Add in empty lines at the bottom of the window. */
5153 if (bottom_y < height)
5155 int uy = FRAME_LINE_HEIGHT (it.f);
5156 it.vpos += (height - bottom_y + uy - 1) / uy;
5159 if (old_buffer)
5160 set_buffer_internal (old_buffer);
5162 return it.vpos;
5166 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5167 doc: /* Center point in selected window and maybe redisplay frame.
5168 With prefix argument ARG, recenter putting point on screen line ARG
5169 relative to the selected window. If ARG is negative, it counts up from the
5170 bottom of the window. (ARG should be less than the height of the window.)
5172 If ARG is omitted or nil, then recenter with point on the middle line of
5173 the selected window; if the variable `recenter-redisplay' is non-nil,
5174 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5175 is set to `grow-only', this resets the tool-bar's height to the minimum
5176 height needed); if `recenter-redisplay' has the special value `tty',
5177 then only tty frames are redrawn.
5179 Just C-u as prefix means put point in the center of the window
5180 and redisplay normally--don't erase and redraw the frame. */)
5181 (register Lisp_Object arg)
5183 struct window *w = XWINDOW (selected_window);
5184 struct buffer *buf = XBUFFER (w->buffer);
5185 struct buffer *obuf = current_buffer;
5186 int center_p = 0;
5187 ptrdiff_t charpos, bytepos;
5188 EMACS_INT iarg IF_LINT (= 0);
5189 int this_scroll_margin;
5191 /* If redisplay is suppressed due to an error, try again. */
5192 obuf->display_error_modiff = 0;
5194 if (NILP (arg))
5196 if (!NILP (Vrecenter_redisplay)
5197 && (!EQ (Vrecenter_redisplay, Qtty)
5198 || !NILP (Ftty_type (selected_frame))))
5200 ptrdiff_t i;
5202 /* Invalidate pixel data calculated for all compositions. */
5203 for (i = 0; i < n_compositions; i++)
5204 composition_table[i]->font = NULL;
5206 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5208 Fredraw_frame (WINDOW_FRAME (w));
5209 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5212 center_p = 1;
5214 else if (CONSP (arg)) /* Just C-u. */
5215 center_p = 1;
5216 else
5218 arg = Fprefix_numeric_value (arg);
5219 CHECK_NUMBER (arg);
5220 iarg = XINT (arg);
5223 set_buffer_internal (buf);
5225 /* Do this after making BUF current
5226 in case scroll_margin is buffer-local. */
5227 this_scroll_margin =
5228 max (0, min (scroll_margin, XFASTINT (w->total_lines) / 4));
5230 /* Handle centering on a graphical frame specially. Such frames can
5231 have variable-height lines and centering point on the basis of
5232 line counts would lead to strange effects. */
5233 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5235 if (center_p)
5237 struct it it;
5238 struct text_pos pt;
5239 void *itdata = bidi_shelve_cache ();
5241 SET_TEXT_POS (pt, PT, PT_BYTE);
5242 start_display (&it, w, pt);
5243 move_it_vertically_backward (&it, window_box_height (w) / 2);
5244 charpos = IT_CHARPOS (it);
5245 bytepos = IT_BYTEPOS (it);
5246 bidi_unshelve_cache (itdata, 0);
5248 else if (iarg < 0)
5250 struct it it;
5251 struct text_pos pt;
5252 ptrdiff_t nlines = min (PTRDIFF_MAX, -iarg);
5253 int extra_line_spacing;
5254 int h = window_box_height (w);
5255 void *itdata = bidi_shelve_cache ();
5257 iarg = - max (-iarg, this_scroll_margin);
5259 SET_TEXT_POS (pt, PT, PT_BYTE);
5260 start_display (&it, w, pt);
5262 /* Be sure we have the exact height of the full line containing PT. */
5263 move_it_by_lines (&it, 0);
5265 /* The amount of pixels we have to move back is the window
5266 height minus what's displayed in the line containing PT,
5267 and the lines below. */
5268 it.current_y = 0;
5269 it.vpos = 0;
5270 move_it_by_lines (&it, nlines);
5272 if (it.vpos == nlines)
5273 h -= it.current_y;
5274 else
5276 /* Last line has no newline */
5277 h -= line_bottom_y (&it);
5278 it.vpos++;
5281 /* Don't reserve space for extra line spacing of last line. */
5282 extra_line_spacing = it.max_extra_line_spacing;
5284 /* If we can't move down NLINES lines because we hit
5285 the end of the buffer, count in some empty lines. */
5286 if (it.vpos < nlines)
5288 nlines -= it.vpos;
5289 extra_line_spacing = it.extra_line_spacing;
5290 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5292 if (h <= 0)
5294 bidi_unshelve_cache (itdata, 0);
5295 return Qnil;
5298 /* Now find the new top line (starting position) of the window. */
5299 start_display (&it, w, pt);
5300 it.current_y = 0;
5301 move_it_vertically_backward (&it, h);
5303 /* If extra line spacing is present, we may move too far
5304 back. This causes the last line to be only partially
5305 visible (which triggers redisplay to recenter that line
5306 in the middle), so move forward.
5307 But ignore extra line spacing on last line, as it is not
5308 considered to be part of the visible height of the line.
5310 h += extra_line_spacing;
5311 while (-it.current_y > h)
5312 move_it_by_lines (&it, 1);
5314 charpos = IT_CHARPOS (it);
5315 bytepos = IT_BYTEPOS (it);
5317 bidi_unshelve_cache (itdata, 0);
5319 else
5321 struct position pos;
5323 iarg = max (iarg, this_scroll_margin);
5325 pos = *vmotion (PT, -iarg, w);
5326 charpos = pos.bufpos;
5327 bytepos = pos.bytepos;
5330 else
5332 struct position pos;
5333 int ht = window_internal_height (w);
5335 if (center_p)
5336 iarg = ht / 2;
5337 else if (iarg < 0)
5338 iarg += ht;
5340 /* Don't let it get into the margin at either top or bottom. */
5341 iarg = max (iarg, this_scroll_margin);
5342 iarg = min (iarg, ht - this_scroll_margin - 1);
5344 pos = *vmotion (PT, - iarg, w);
5345 charpos = pos.bufpos;
5346 bytepos = pos.bytepos;
5349 /* Set the new window start. */
5350 set_marker_both (w->start, w->buffer, charpos, bytepos);
5351 wset_window_end_valid (w, Qnil);
5353 w->optional_new_start = 1;
5355 w->start_at_line_beg = (bytepos == BEGV_BYTE ||
5356 FETCH_BYTE (bytepos - 1) == '\n');
5358 set_buffer_internal (obuf);
5359 return Qnil;
5362 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5363 0, 1, 0,
5364 doc: /* Return the height in lines of the text display area of WINDOW.
5365 WINDOW must be a live window and defaults to the selected one.
5367 The returned height does not include the mode line, any header line,
5368 nor any partial-height lines at the bottom of the text area. */)
5369 (Lisp_Object window)
5371 struct window *w = decode_live_window (window);
5372 int pixel_height = window_box_height (w);
5373 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5374 return make_number (line_height);
5379 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5380 1, 1, "P",
5381 doc: /* Position point relative to window.
5382 ARG nil means position point at center of window.
5383 Else, ARG specifies vertical position within the window;
5384 zero means top of window, negative means relative to bottom of window. */)
5385 (Lisp_Object arg)
5387 struct window *w = XWINDOW (selected_window);
5388 int lines, start;
5389 Lisp_Object window;
5390 #if 0
5391 int this_scroll_margin;
5392 #endif
5394 if (!(BUFFERP (w->buffer)
5395 && XBUFFER (w->buffer) == current_buffer))
5396 /* This test is needed to make sure PT/PT_BYTE make sense in w->buffer
5397 when passed below to set_marker_both. */
5398 error ("move-to-window-line called from unrelated buffer");
5400 window = selected_window;
5401 start = marker_position (w->start);
5402 if (start < BEGV || start > ZV)
5404 int height = window_internal_height (w);
5405 Fvertical_motion (make_number (- (height / 2)), window);
5406 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
5407 w->start_at_line_beg = !NILP (Fbolp ());
5408 w->force_start = 1;
5410 else
5411 Fgoto_char (w->start);
5413 lines = displayed_window_lines (w);
5415 #if 0
5416 this_scroll_margin = max (0, min (scroll_margin, lines / 4));
5417 #endif
5419 if (NILP (arg))
5420 XSETFASTINT (arg, lines / 2);
5421 else
5423 EMACS_INT iarg = XINT (Fprefix_numeric_value (arg));
5425 if (iarg < 0)
5426 iarg = iarg + lines;
5428 #if 0 /* This code would prevent move-to-window-line from moving point
5429 to a place inside the scroll margins (which would cause the
5430 next redisplay to scroll). I wrote this code, but then concluded
5431 it is probably better not to install it. However, it is here
5432 inside #if 0 so as not to lose it. -- rms. */
5434 /* Don't let it get into the margin at either top or bottom. */
5435 iarg = max (iarg, this_scroll_margin);
5436 iarg = min (iarg, lines - this_scroll_margin - 1);
5437 #endif
5439 arg = make_number (iarg);
5442 /* Skip past a partially visible first line. */
5443 if (w->vscroll)
5444 XSETINT (arg, XINT (arg) + 1);
5446 return Fvertical_motion (arg, window);
5451 /***********************************************************************
5452 Window Configuration
5453 ***********************************************************************/
5455 struct save_window_data
5457 struct vectorlike_header header;
5458 Lisp_Object selected_frame;
5459 Lisp_Object current_window;
5460 Lisp_Object current_buffer;
5461 Lisp_Object minibuf_scroll_window;
5462 Lisp_Object minibuf_selected_window;
5463 Lisp_Object root_window;
5464 Lisp_Object focus_frame;
5465 /* A vector, each of whose elements is a struct saved_window
5466 for one window. */
5467 Lisp_Object saved_windows;
5469 /* All fields above are traced by the GC.
5470 From `fame-cols' down, the fields are ignored by the GC. */
5472 int frame_cols, frame_lines, frame_menu_bar_lines;
5473 int frame_tool_bar_lines;
5476 /* This is saved as a Lisp_Vector */
5477 struct saved_window
5479 struct vectorlike_header header;
5481 Lisp_Object window, buffer, start, pointm, mark;
5482 Lisp_Object left_col, top_line, total_cols, total_lines;
5483 Lisp_Object normal_cols, normal_lines;
5484 Lisp_Object hscroll, min_hscroll;
5485 Lisp_Object parent, prev;
5486 Lisp_Object start_at_line_beg;
5487 Lisp_Object display_table;
5488 Lisp_Object left_margin_cols, right_margin_cols;
5489 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5490 Lisp_Object scroll_bar_width, vertical_scroll_bar_type, dedicated;
5491 Lisp_Object combination_limit, window_parameters;
5494 #define SAVED_WINDOW_N(swv,n) \
5495 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5497 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5498 doc: /* Return t if OBJECT is a window-configuration object. */)
5499 (Lisp_Object object)
5501 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
5504 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5505 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5506 (Lisp_Object config)
5508 register struct save_window_data *data;
5509 struct Lisp_Vector *saved_windows;
5511 CHECK_WINDOW_CONFIGURATION (config);
5513 data = (struct save_window_data *) XVECTOR (config);
5514 saved_windows = XVECTOR (data->saved_windows);
5515 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5518 DEFUN ("set-window-configuration", Fset_window_configuration,
5519 Sset_window_configuration, 1, 1, 0,
5520 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5521 CONFIGURATION must be a value previously returned
5522 by `current-window-configuration' (which see).
5523 If CONFIGURATION was made from a frame that is now deleted,
5524 only frame-independent values can be restored. In this case,
5525 the return value is nil. Otherwise the value is t. */)
5526 (Lisp_Object configuration)
5528 register struct save_window_data *data;
5529 struct Lisp_Vector *saved_windows;
5530 Lisp_Object new_current_buffer;
5531 Lisp_Object frame;
5532 FRAME_PTR f;
5533 ptrdiff_t old_point = -1;
5535 CHECK_WINDOW_CONFIGURATION (configuration);
5537 data = (struct save_window_data *) XVECTOR (configuration);
5538 saved_windows = XVECTOR (data->saved_windows);
5540 new_current_buffer = data->current_buffer;
5541 if (!BUFFER_LIVE_P (XBUFFER (new_current_buffer)))
5542 new_current_buffer = Qnil;
5543 else
5545 if (XBUFFER (new_current_buffer) == current_buffer)
5546 /* The code further down "preserves point" by saving here PT in
5547 old_point and then setting it later back into PT. When the
5548 current-selected-window and the final-selected-window both show
5549 the current buffer, this suffers from the problem that the
5550 current PT is the window-point of the current-selected-window,
5551 while the final PT is the point of the final-selected-window, so
5552 this copy from one PT to the other would end up moving the
5553 window-point of the final-selected-window to the window-point of
5554 the current-selected-window. So we have to be careful which
5555 point of the current-buffer we copy into old_point. */
5556 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5557 && WINDOWP (selected_window)
5558 && EQ (XWINDOW (selected_window)->buffer, new_current_buffer)
5559 && !EQ (selected_window, data->current_window))
5560 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5561 else
5562 old_point = PT;
5563 else
5564 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5565 point in new_current_buffer as of the last time this buffer was
5566 used. This can be non-deterministic since it can be changed by
5567 things like jit-lock by mere temporary selection of some random
5568 window that happens to show this buffer.
5569 So if possible we want this arbitrary choice of "which point" to
5570 be the one from the to-be-selected-window so as to prevent this
5571 window's cursor from being copied from another window. */
5572 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5573 /* If current_window = selected_window, its point is in BUF_PT. */
5574 && !EQ (selected_window, data->current_window))
5575 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5576 else
5577 old_point = BUF_PT (XBUFFER (new_current_buffer));
5580 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5581 f = XFRAME (frame);
5583 /* If f is a dead frame, don't bother rebuilding its window tree.
5584 However, there is other stuff we should still try to do below. */
5585 if (FRAME_LIVE_P (f))
5587 Lisp_Object window;
5588 Lisp_Object dead_windows = Qnil;
5589 register Lisp_Object tem, par, pers;
5590 register struct window *w;
5591 register struct saved_window *p;
5592 struct window *root_window;
5593 struct window **leaf_windows;
5594 int n_leaf_windows;
5595 ptrdiff_t k;
5596 int i, n;
5598 /* If the frame has been resized since this window configuration was
5599 made, we change the frame to the size specified in the
5600 configuration, restore the configuration, and then resize it
5601 back. We keep track of the prevailing height in these variables. */
5602 int previous_frame_lines = FRAME_LINES (f);
5603 int previous_frame_cols = FRAME_COLS (f);
5604 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5605 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5607 /* Don't do this within the main loop below: This may call Lisp
5608 code and is thus potentially unsafe while input is blocked. */
5609 for (k = 0; k < saved_windows->header.size; k++)
5611 p = SAVED_WINDOW_N (saved_windows, k);
5612 window = p->window;
5613 w = XWINDOW (window);
5614 if (!NILP (w->buffer)
5615 && !EQ (w->buffer, p->buffer)
5616 && BUFFER_LIVE_P (XBUFFER (p->buffer)))
5617 /* If a window we restore gets another buffer, record the
5618 window's old buffer. */
5619 call1 (Qrecord_window_buffer, window);
5622 /* The mouse highlighting code could get screwed up
5623 if it runs during this. */
5624 block_input ();
5626 if (data->frame_lines != previous_frame_lines
5627 || data->frame_cols != previous_frame_cols)
5628 change_frame_size (f, data->frame_lines,
5629 data->frame_cols, 0, 0, 0);
5630 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5631 if (data->frame_menu_bar_lines
5632 != previous_frame_menu_bar_lines)
5633 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
5634 make_number (0));
5635 #ifdef HAVE_WINDOW_SYSTEM
5636 if (data->frame_tool_bar_lines
5637 != previous_frame_tool_bar_lines)
5638 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
5639 make_number (0));
5640 #endif
5641 #endif
5643 /* "Swap out" point from the selected window's buffer
5644 into the window itself. (Normally the pointm of the selected
5645 window holds garbage.) We do this now, before
5646 restoring the window contents, and prevent it from
5647 being done later on when we select a new window. */
5648 if (! NILP (XWINDOW (selected_window)->buffer))
5650 w = XWINDOW (selected_window);
5651 set_marker_both (w->pointm,
5652 w->buffer,
5653 BUF_PT (XBUFFER (w->buffer)),
5654 BUF_PT_BYTE (XBUFFER (w->buffer)));
5657 windows_or_buffers_changed++;
5658 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
5660 /* Problem: Freeing all matrices and later allocating them again
5661 is a serious redisplay flickering problem. What we would
5662 really like to do is to free only those matrices not reused
5663 below. */
5664 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
5665 leaf_windows = alloca (count_windows (root_window)
5666 * sizeof *leaf_windows);
5667 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
5669 /* Kludge Alert!
5670 Mark all windows now on frame as "deleted".
5671 Restoring the new configuration "undeletes" any that are in it.
5673 Save their current buffers in their height fields, since we may
5674 need it later, if a buffer saved in the configuration is now
5675 dead. */
5676 delete_all_child_windows (FRAME_ROOT_WINDOW (f));
5678 for (k = 0; k < saved_windows->header.size; k++)
5680 p = SAVED_WINDOW_N (saved_windows, k);
5681 window = p->window;
5682 w = XWINDOW (window);
5683 wset_next (w, Qnil);
5685 if (!NILP (p->parent))
5686 wset_parent
5687 (w, SAVED_WINDOW_N (saved_windows, XFASTINT (p->parent))->window);
5688 else
5689 wset_parent (w, Qnil);
5691 if (!NILP (p->prev))
5693 wset_prev
5694 (w, SAVED_WINDOW_N (saved_windows, XFASTINT (p->prev))->window);
5695 wset_next (XWINDOW (w->prev), p->window);
5697 else
5699 wset_prev (w, Qnil);
5700 if (!NILP (w->parent))
5702 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
5704 wset_vchild (XWINDOW (w->parent), p->window);
5705 wset_hchild (XWINDOW (w->parent), Qnil);
5707 else
5709 wset_hchild (XWINDOW (w->parent), p->window);
5710 wset_vchild (XWINDOW (w->parent), Qnil);
5715 /* If we squirreled away the buffer in the window's height,
5716 restore it now. */
5717 if (BUFFERP (w->total_lines))
5718 wset_buffer (w, w->total_lines);
5719 wset_left_col (w, p->left_col);
5720 wset_top_line (w, p->top_line);
5721 wset_total_cols (w, p->total_cols);
5722 wset_total_lines (w, p->total_lines);
5723 wset_normal_cols (w, p->normal_cols);
5724 wset_normal_lines (w, p->normal_lines);
5725 w->hscroll = XFASTINT (p->hscroll);
5726 w->min_hscroll = XFASTINT (p->min_hscroll);
5727 wset_display_table (w, p->display_table);
5728 wset_left_margin_cols (w, p->left_margin_cols);
5729 wset_right_margin_cols (w, p->right_margin_cols);
5730 wset_left_fringe_width (w, p->left_fringe_width);
5731 wset_right_fringe_width (w, p->right_fringe_width);
5732 w->fringes_outside_margins = !NILP (p->fringes_outside_margins);
5733 wset_scroll_bar_width (w, p->scroll_bar_width);
5734 wset_vertical_scroll_bar_type (w, p->vertical_scroll_bar_type);
5735 wset_dedicated (w, p->dedicated);
5736 wset_combination_limit (w, p->combination_limit);
5737 /* Restore any window parameters that have been saved.
5738 Parameters that have not been saved are left alone. */
5739 for (tem = p->window_parameters; CONSP (tem); tem = XCDR (tem))
5741 pers = XCAR (tem);
5742 if (CONSP (pers))
5744 if (NILP (XCDR (pers)))
5746 par = Fassq (XCAR (pers), w->window_parameters);
5747 if (CONSP (par) && !NILP (XCDR (par)))
5748 /* Reset a parameter to nil if and only if it
5749 has a non-nil association. Don't make new
5750 associations. */
5751 Fsetcdr (par, Qnil);
5753 else
5754 /* Always restore a non-nil value. */
5755 Fset_window_parameter (window, XCAR (pers), XCDR (pers));
5759 w->last_modified = 0;
5760 w->last_overlay_modified = 0;
5762 /* Reinstall the saved buffer and pointers into it. */
5763 if (NILP (p->buffer))
5764 /* An internal window. */
5765 wset_buffer (w, p->buffer);
5766 else if (BUFFER_LIVE_P (XBUFFER (p->buffer)))
5767 /* If saved buffer is alive, install it. */
5769 wset_buffer (w, p->buffer);
5770 w->start_at_line_beg = !NILP (p->start_at_line_beg);
5771 set_marker_restricted (w->start, p->start, w->buffer);
5772 set_marker_restricted (w->pointm, p->pointm,
5773 w->buffer);
5774 Fset_marker (BVAR (XBUFFER (w->buffer), mark),
5775 p->mark, w->buffer);
5777 /* As documented in Fcurrent_window_configuration, don't
5778 restore the location of point in the buffer which was
5779 current when the window configuration was recorded. */
5780 if (!EQ (p->buffer, new_current_buffer)
5781 && XBUFFER (p->buffer) == current_buffer)
5782 Fgoto_char (w->pointm);
5784 else if (!NILP (w->buffer)
5785 && BUFFER_LIVE_P (XBUFFER (w->buffer)))
5786 /* Keep window's old buffer; make sure the markers are
5787 real. */
5789 /* Set window markers at start of visible range. */
5790 if (XMARKER (w->start)->buffer == 0)
5791 set_marker_restricted (w->start, make_number (0),
5792 w->buffer);
5793 if (XMARKER (w->pointm)->buffer == 0)
5794 set_marker_restricted_both
5795 (w->pointm, w->buffer,
5796 BUF_PT (XBUFFER (w->buffer)),
5797 BUF_PT_BYTE (XBUFFER (w->buffer)));
5798 w->start_at_line_beg = 1;
5800 else
5801 /* Window has no live buffer, get one. */
5803 /* Get the buffer via other_buffer_safely in order to
5804 avoid showing an unimportant buffer and, if necessary, to
5805 recreate *scratch* in the course (part of Juanma's bs-show
5806 scenario from March 2011). */
5807 wset_buffer (w, other_buffer_safely (Fcurrent_buffer ()));
5808 /* This will set the markers to beginning of visible
5809 range. */
5810 set_marker_restricted (w->start,
5811 make_number (0), w->buffer);
5812 set_marker_restricted (w->pointm,
5813 make_number (0), w->buffer);
5814 w->start_at_line_beg = 1;
5815 if (!NILP (w->dedicated))
5816 /* Record this window as dead. */
5817 dead_windows = Fcons (window, dead_windows);
5818 /* Make sure window is no more dedicated. */
5819 wset_dedicated (w, Qnil);
5823 fset_root_window (f, data->root_window);
5824 /* Arrange *not* to restore point in the buffer that was
5825 current when the window configuration was saved. */
5826 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
5827 set_marker_restricted (XWINDOW (data->current_window)->pointm,
5828 make_number (old_point),
5829 XWINDOW (data->current_window)->buffer);
5831 /* In the following call to `select-window', prevent "swapping out
5832 point" in the old selected window using the buffer that has
5833 been restored into it. We already swapped out that point from
5834 that window's old buffer. */
5835 select_window (data->current_window, Qnil, 1);
5836 BVAR (XBUFFER (XWINDOW (selected_window)->buffer), last_selected_window)
5837 = selected_window;
5839 if (NILP (data->focus_frame)
5840 || (FRAMEP (data->focus_frame)
5841 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
5842 Fredirect_frame_focus (frame, data->focus_frame);
5844 /* Set the screen height to the value it had before this function. */
5845 if (previous_frame_lines != FRAME_LINES (f)
5846 || previous_frame_cols != FRAME_COLS (f))
5847 change_frame_size (f, previous_frame_lines, previous_frame_cols,
5848 0, 0, 0);
5849 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5850 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
5851 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
5852 make_number (0));
5853 #ifdef HAVE_WINDOW_SYSTEM
5854 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
5855 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
5856 make_number (0));
5857 #endif
5858 #endif
5860 /* Now, free glyph matrices in windows that were not reused. */
5861 for (i = n = 0; i < n_leaf_windows; ++i)
5863 if (NILP (leaf_windows[i]->buffer))
5865 /* Assert it's not reused as a combination. */
5866 eassert (NILP (leaf_windows[i]->hchild)
5867 && NILP (leaf_windows[i]->vchild));
5868 free_window_matrices (leaf_windows[i]);
5870 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
5871 ++n;
5874 adjust_glyphs (f);
5875 unblock_input ();
5877 /* Scan dead buffer windows. */
5878 for (; CONSP (dead_windows); dead_windows = XCDR (dead_windows))
5880 window = XCAR (dead_windows);
5881 if (WINDOW_LIVE_P (window) && !EQ (window, FRAME_ROOT_WINDOW (f)))
5882 delete_deletable_window (window);
5885 /* Fselect_window will have made f the selected frame, so we
5886 reselect the proper frame here. Fhandle_switch_frame will change the
5887 selected window too, but that doesn't make the call to
5888 Fselect_window above totally superfluous; it still sets f's
5889 selected window. */
5890 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
5891 do_switch_frame (data->selected_frame, 0, 0, Qnil);
5893 run_window_configuration_change_hook (f);
5896 if (!NILP (new_current_buffer))
5898 Fset_buffer (new_current_buffer);
5899 /* If the new current buffer doesn't appear in the selected
5900 window, go to its old point (see bug#12208). */
5901 if (!EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
5902 Fgoto_char (make_number (old_point));
5905 Vminibuf_scroll_window = data->minibuf_scroll_window;
5906 minibuf_selected_window = data->minibuf_selected_window;
5908 return (FRAME_LIVE_P (f) ? Qt : Qnil);
5912 /* Recursively delete all child windows reachable via the next, vchild,
5913 and hchild slots of WINDOW. */
5914 void
5915 delete_all_child_windows (Lisp_Object window)
5917 register struct window *w;
5919 w = XWINDOW (window);
5921 if (!NILP (w->next))
5922 /* Delete WINDOW's siblings (we traverse postorderly). */
5923 delete_all_child_windows (w->next);
5925 /* See Fset_window_configuration for excuse. */
5926 wset_total_lines (w, w->buffer);
5928 if (!NILP (w->vchild))
5930 delete_all_child_windows (w->vchild);
5931 wset_vchild (w, Qnil);
5933 else if (!NILP (w->hchild))
5935 delete_all_child_windows (w->hchild);
5936 wset_hchild (w, Qnil);
5938 else if (!NILP (w->buffer))
5940 unshow_buffer (w);
5941 unchain_marker (XMARKER (w->pointm));
5942 unchain_marker (XMARKER (w->start));
5943 wset_buffer (w, Qnil);
5946 Vwindow_list = Qnil;
5949 static int
5950 count_windows (register struct window *window)
5952 register int count = 1;
5953 if (!NILP (window->next))
5954 count += count_windows (XWINDOW (window->next));
5955 if (!NILP (window->vchild))
5956 count += count_windows (XWINDOW (window->vchild));
5957 if (!NILP (window->hchild))
5958 count += count_windows (XWINDOW (window->hchild));
5959 return count;
5963 /* Fill vector FLAT with leaf windows under W, starting at index I.
5964 Value is last index + 1. */
5965 static int
5966 get_leaf_windows (struct window *w, struct window **flat, int i)
5968 while (w)
5970 if (!NILP (w->hchild))
5971 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
5972 else if (!NILP (w->vchild))
5973 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
5974 else
5975 flat[i++] = w;
5977 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5980 return i;
5984 /* Return a pointer to the glyph W's physical cursor is on. Value is
5985 null if W's current matrix is invalid, so that no meaningful glyph
5986 can be returned. */
5987 struct glyph *
5988 get_phys_cursor_glyph (struct window *w)
5990 struct glyph_row *row;
5991 struct glyph *glyph;
5992 int hpos = w->phys_cursor.hpos;
5994 if (!(w->phys_cursor.vpos >= 0
5995 && w->phys_cursor.vpos < w->current_matrix->nrows))
5996 return NULL;
5998 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
5999 if (!row->enabled_p)
6000 return NULL;
6002 if (w->hscroll)
6004 /* When the window is hscrolled, cursor hpos can legitimately be
6005 out of bounds, but we draw the cursor at the corresponding
6006 window margin in that case. */
6007 if (!row->reversed_p && hpos < 0)
6008 hpos = 0;
6009 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
6010 hpos = row->used[TEXT_AREA] - 1;
6013 if (row->used[TEXT_AREA] > hpos
6014 && 0 <= hpos)
6015 glyph = row->glyphs[TEXT_AREA] + hpos;
6016 else
6017 glyph = NULL;
6019 return glyph;
6023 static int
6024 save_window_save (Lisp_Object window, struct Lisp_Vector *vector, int i)
6026 register struct saved_window *p;
6027 register struct window *w;
6028 register Lisp_Object tem, pers, par;
6030 for (;!NILP (window); window = w->next)
6032 p = SAVED_WINDOW_N (vector, i);
6033 w = XWINDOW (window);
6035 wset_temslot (w, make_number (i)); i++;
6036 p->window = window;
6037 p->buffer = w->buffer;
6038 p->left_col = w->left_col;
6039 p->top_line = w->top_line;
6040 p->total_cols = w->total_cols;
6041 p->total_lines = w->total_lines;
6042 p->normal_cols = w->normal_cols;
6043 p->normal_lines = w->normal_lines;
6044 XSETFASTINT (p->hscroll, w->hscroll);
6045 XSETFASTINT (p->min_hscroll, w->min_hscroll);
6046 p->display_table = w->display_table;
6047 p->left_margin_cols = w->left_margin_cols;
6048 p->right_margin_cols = w->right_margin_cols;
6049 p->left_fringe_width = w->left_fringe_width;
6050 p->right_fringe_width = w->right_fringe_width;
6051 p->fringes_outside_margins = w->fringes_outside_margins ? Qt : Qnil;
6052 p->scroll_bar_width = w->scroll_bar_width;
6053 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
6054 p->dedicated = w->dedicated;
6055 p->combination_limit = w->combination_limit;
6056 p->window_parameters = Qnil;
6058 if (!NILP (Vwindow_persistent_parameters))
6060 /* Run cycle detection on Vwindow_persistent_parameters. */
6061 Lisp_Object tortoise, hare;
6063 hare = tortoise = Vwindow_persistent_parameters;
6064 while (CONSP (hare))
6066 hare = XCDR (hare);
6067 if (!CONSP (hare))
6068 break;
6070 hare = XCDR (hare);
6071 tortoise = XCDR (tortoise);
6073 if (EQ (hare, tortoise))
6074 /* Reset Vwindow_persistent_parameters to Qnil. */
6076 Vwindow_persistent_parameters = Qnil;
6077 break;
6081 for (tem = Vwindow_persistent_parameters; CONSP (tem);
6082 tem = XCDR (tem))
6084 pers = XCAR (tem);
6085 /* Save values for persistent window parameters. */
6086 if (CONSP (pers) && !NILP (XCDR (pers)))
6088 par = Fassq (XCAR (pers), w->window_parameters);
6089 if (NILP (par))
6090 /* If the window has no value for the parameter,
6091 make one. */
6092 p->window_parameters = Fcons (Fcons (XCAR (pers), Qnil),
6093 p->window_parameters);
6094 else
6095 /* If the window has a value for the parameter,
6096 save it. */
6097 p->window_parameters = Fcons (Fcons (XCAR (par),
6098 XCDR (par)),
6099 p->window_parameters);
6104 if (!NILP (w->buffer))
6106 /* Save w's value of point in the window configuration. If w
6107 is the selected window, then get the value of point from
6108 the buffer; pointm is garbage in the selected window. */
6109 if (EQ (window, selected_window))
6110 p->pointm = build_marker (XBUFFER (w->buffer),
6111 BUF_PT (XBUFFER (w->buffer)),
6112 BUF_PT_BYTE (XBUFFER (w->buffer)));
6113 else
6114 p->pointm = Fcopy_marker (w->pointm, Qnil);
6115 XMARKER (p->pointm)->insertion_type
6116 = !NILP (Vwindow_point_insertion_type);
6118 p->start = Fcopy_marker (w->start, Qnil);
6119 p->start_at_line_beg = w->start_at_line_beg ? Qt : Qnil;
6121 tem = BVAR (XBUFFER (w->buffer), mark);
6122 p->mark = Fcopy_marker (tem, Qnil);
6124 else
6126 p->pointm = Qnil;
6127 p->start = Qnil;
6128 p->mark = Qnil;
6129 p->start_at_line_beg = Qnil;
6132 if (NILP (w->parent))
6133 p->parent = Qnil;
6134 else
6135 p->parent = XWINDOW (w->parent)->temslot;
6137 if (NILP (w->prev))
6138 p->prev = Qnil;
6139 else
6140 p->prev = XWINDOW (w->prev)->temslot;
6142 if (!NILP (w->vchild))
6143 i = save_window_save (w->vchild, vector, i);
6144 if (!NILP (w->hchild))
6145 i = save_window_save (w->hchild, vector, i);
6148 return i;
6151 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
6152 Scurrent_window_configuration, 0, 1, 0,
6153 doc: /* Return an object representing the current window configuration of FRAME.
6154 If FRAME is nil or omitted, use the selected frame.
6155 This describes the number of windows, their sizes and current buffers,
6156 and for each displayed buffer, where display starts, and the positions of
6157 point and mark. An exception is made for point in the current buffer:
6158 its value is -not- saved.
6159 This also records the currently selected frame, and FRAME's focus
6160 redirection (see `redirect-frame-focus'). The variable
6161 `window-persistent-parameters' specifies which window parameters are
6162 saved by this function. */)
6163 (Lisp_Object frame)
6165 register Lisp_Object tem;
6166 register int n_windows;
6167 register struct save_window_data *data;
6168 register int i;
6169 FRAME_PTR f;
6171 if (NILP (frame))
6172 frame = selected_frame;
6173 CHECK_LIVE_FRAME (frame);
6174 f = XFRAME (frame);
6176 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6177 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6178 PVEC_WINDOW_CONFIGURATION);
6180 data->frame_cols = FRAME_COLS (f);
6181 data->frame_lines = FRAME_LINES (f);
6182 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6183 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6184 data->selected_frame = selected_frame;
6185 data->current_window = FRAME_SELECTED_WINDOW (f);
6186 XSETBUFFER (data->current_buffer, current_buffer);
6187 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6188 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6189 data->root_window = FRAME_ROOT_WINDOW (f);
6190 data->focus_frame = FRAME_FOCUS_FRAME (f);
6191 tem = Fmake_vector (make_number (n_windows), Qnil);
6192 data->saved_windows = tem;
6193 for (i = 0; i < n_windows; i++)
6194 ASET (tem, i,
6195 Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil));
6196 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6197 XSETWINDOW_CONFIGURATION (tem, data);
6198 return (tem);
6201 /***********************************************************************
6202 Marginal Areas
6203 ***********************************************************************/
6205 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6206 2, 3, 0,
6207 doc: /* Set width of marginal areas of window WINDOW.
6208 WINDOW must be a live window and defaults to the selected one.
6210 Second arg LEFT-WIDTH specifies the number of character cells to
6211 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6212 does the same for the right marginal area. A nil width parameter
6213 means no margin. */)
6214 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width)
6216 struct window *w = decode_live_window (window);
6218 /* Translate negative or zero widths to nil.
6219 Margins that are too wide have to be checked elsewhere. */
6221 if (!NILP (left_width))
6223 CHECK_NUMBER (left_width);
6224 if (XINT (left_width) <= 0)
6225 left_width = Qnil;
6228 if (!NILP (right_width))
6230 CHECK_NUMBER (right_width);
6231 if (XINT (right_width) <= 0)
6232 right_width = Qnil;
6235 if (!EQ (w->left_margin_cols, left_width)
6236 || !EQ (w->right_margin_cols, right_width))
6238 wset_left_margin_cols (w, left_width);
6239 wset_right_margin_cols (w, right_width);
6241 adjust_window_margins (w);
6243 ++windows_or_buffers_changed;
6244 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6247 return Qnil;
6251 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6252 0, 1, 0,
6253 doc: /* Get width of marginal areas of window WINDOW.
6254 WINDOW must be a live window and defaults to the selected one.
6256 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6257 If a marginal area does not exist, its width will be returned
6258 as nil. */)
6259 (Lisp_Object window)
6261 struct window *w = decode_live_window (window);
6262 return Fcons (w->left_margin_cols, w->right_margin_cols);
6267 /***********************************************************************
6268 Fringes
6269 ***********************************************************************/
6271 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6272 2, 4, 0,
6273 doc: /* Set the fringe widths of window WINDOW.
6274 WINDOW must be a live window and defaults to the selected one.
6276 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6277 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6278 fringe width. If a fringe width arg is nil, that means to use the
6279 frame's default fringe width. Default fringe widths can be set with
6280 the command `set-fringe-style'.
6281 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6282 outside of the display margins. By default, fringes are drawn between
6283 display marginal areas and the text area. */)
6284 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width, Lisp_Object outside_margins)
6286 struct window *w = decode_live_window (window);
6287 int outside = !NILP (outside_margins);
6289 if (!NILP (left_width))
6290 CHECK_NATNUM (left_width);
6291 if (!NILP (right_width))
6292 CHECK_NATNUM (right_width);
6294 /* Do nothing on a tty. */
6295 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6296 && (!EQ (w->left_fringe_width, left_width)
6297 || !EQ (w->right_fringe_width, right_width)
6298 || w->fringes_outside_margins != outside))
6300 wset_left_fringe_width (w, left_width);
6301 wset_right_fringe_width (w, right_width);
6302 w->fringes_outside_margins = outside;
6304 adjust_window_margins (w);
6306 clear_glyph_matrix (w->current_matrix);
6307 wset_window_end_valid (w, Qnil);
6309 ++windows_or_buffers_changed;
6310 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6313 return Qnil;
6317 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6318 0, 1, 0,
6319 doc: /* Get width of fringes of window WINDOW.
6320 WINDOW must be a live window and defaults to the selected one.
6322 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6323 (Lisp_Object window)
6325 struct window *w = decode_live_window (window);
6327 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6328 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6329 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6330 ? Qt : Qnil), Qnil)));
6335 /***********************************************************************
6336 Scroll bars
6337 ***********************************************************************/
6339 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars,
6340 Sset_window_scroll_bars, 2, 4, 0,
6341 doc: /* Set width and type of scroll bars of window WINDOW.
6342 WINDOW must be a live window and defaults to the selected one.
6344 Second parameter WIDTH specifies the pixel width for the scroll bar;
6345 this is automatically adjusted to a multiple of the frame column width.
6346 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6347 bar: left, right, or nil.
6348 If WIDTH is nil, use the frame's scroll-bar width.
6349 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6350 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6351 (Lisp_Object window, Lisp_Object width, Lisp_Object vertical_type, Lisp_Object horizontal_type)
6353 struct window *w = decode_live_window (window);
6355 if (!NILP (width))
6357 CHECK_RANGED_INTEGER (width, 0, INT_MAX);
6359 if (XINT (width) == 0)
6360 vertical_type = Qnil;
6363 if (!(NILP (vertical_type)
6364 || EQ (vertical_type, Qleft)
6365 || EQ (vertical_type, Qright)
6366 || EQ (vertical_type, Qt)))
6367 error ("Invalid type of vertical scroll bar");
6369 if (!EQ (w->scroll_bar_width, width)
6370 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6372 wset_scroll_bar_width (w, width);
6373 wset_vertical_scroll_bar_type (w, vertical_type);
6375 adjust_window_margins (w);
6377 clear_glyph_matrix (w->current_matrix);
6378 wset_window_end_valid (w, Qnil);
6380 ++windows_or_buffers_changed;
6381 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6384 return Qnil;
6388 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6389 0, 1, 0,
6390 doc: /* Get width and type of scroll bars of window WINDOW.
6391 WINDOW must be a live window and defaults to the selected one.
6393 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6394 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6395 value. */)
6396 (Lisp_Object window)
6398 struct window *w = decode_live_window (window);
6399 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6400 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6401 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6402 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
6403 Fcons (w->vertical_scroll_bar_type,
6404 Fcons (Qnil, Qnil))));
6409 /***********************************************************************
6410 Smooth scrolling
6411 ***********************************************************************/
6413 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6414 doc: /* Return the amount by which WINDOW is scrolled vertically.
6415 If WINDOW is omitted or nil, it defaults to the selected window.
6416 Normally, value is a multiple of the canonical character height of WINDOW;
6417 optional second arg PIXELS-P means value is measured in pixels. */)
6418 (Lisp_Object window, Lisp_Object pixels_p)
6420 Lisp_Object result;
6421 struct window *w = decode_live_window (window);
6422 struct frame *f = XFRAME (w->frame);
6424 if (FRAME_WINDOW_P (f))
6425 result = (NILP (pixels_p)
6426 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
6427 : make_number (-w->vscroll));
6428 else
6429 result = make_number (0);
6430 return result;
6434 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
6435 2, 3, 0,
6436 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6437 WINDOW nil means use the selected window. Normally, VSCROLL is a
6438 non-negative multiple of the canonical character height of WINDOW;
6439 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6440 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6441 corresponds to an integral number of pixels. The return value is the
6442 result of this rounding.
6443 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6444 (Lisp_Object window, Lisp_Object vscroll, Lisp_Object pixels_p)
6446 struct window *w = decode_live_window (window);
6447 struct frame *f = XFRAME (w->frame);
6449 CHECK_NUMBER_OR_FLOAT (vscroll);
6451 if (FRAME_WINDOW_P (f))
6453 int old_dy = w->vscroll;
6455 w->vscroll = - (NILP (pixels_p)
6456 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6457 : XFLOATINT (vscroll));
6458 w->vscroll = min (w->vscroll, 0);
6460 if (w->vscroll != old_dy)
6462 /* Adjust glyph matrix of the frame if the virtual display
6463 area becomes larger than before. */
6464 if (w->vscroll < 0 && w->vscroll < old_dy)
6465 adjust_glyphs (f);
6467 /* Prevent redisplay shortcuts. */
6468 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
6472 return Fwindow_vscroll (window, pixels_p);
6476 /* Call FN for all leaf windows on frame F. FN is called with the
6477 first argument being a pointer to the leaf window, and with
6478 additional argument USER_DATA. Stops when FN returns 0. */
6480 static void
6481 foreach_window (struct frame *f, int (*fn) (struct window *, void *),
6482 void *user_data)
6484 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6485 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6486 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6490 /* Helper function for foreach_window. Call FN for all leaf windows
6491 reachable from W. FN is called with the first argument being a
6492 pointer to the leaf window, and with additional argument USER_DATA.
6493 Stop when FN returns 0. Value is 0 if stopped by FN. */
6495 static int
6496 foreach_window_1 (struct window *w, int (*fn) (struct window *, void *), void *user_data)
6498 int cont;
6500 for (cont = 1; w && cont;)
6502 if (!NILP (w->hchild))
6503 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6504 else if (!NILP (w->vchild))
6505 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6506 else
6507 cont = fn (w, user_data);
6509 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6512 return cont;
6516 /* Freeze or unfreeze the window start of W unless it is a
6517 mini-window or the selected window. FREEZE_P non-null means freeze
6518 the window start. */
6520 static int
6521 freeze_window_start (struct window *w, void *freeze_p)
6523 if (MINI_WINDOW_P (w)
6524 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6525 && (w == XWINDOW (selected_window)
6526 || (MINI_WINDOW_P (XWINDOW (selected_window))
6527 && ! NILP (Vminibuf_scroll_window)
6528 && w == XWINDOW (Vminibuf_scroll_window)))))
6529 freeze_p = NULL;
6531 w->frozen_window_start_p = freeze_p != NULL;
6532 return 1;
6536 /* Freeze or unfreeze the window starts of all leaf windows on frame
6537 F, except the selected window and a mini-window. FREEZE_P non-zero
6538 means freeze the window start. */
6540 void
6541 freeze_window_starts (struct frame *f, int freeze_p)
6543 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6547 /***********************************************************************
6548 Initialization
6549 ***********************************************************************/
6551 /* Return 1 if window configurations CONFIGURATION1 and CONFIGURATION2
6552 describe the same state of affairs. This is used by Fequal.
6554 IGNORE_POSITIONS means ignore non-matching scroll positions
6555 and the like.
6557 This ignores a couple of things like the dedication status of
6558 window, combination_limit and the like. This might have to be
6559 fixed. */
6561 bool
6562 compare_window_configurations (Lisp_Object configuration1,
6563 Lisp_Object configuration2,
6564 bool ignore_positions)
6566 register struct save_window_data *d1, *d2;
6567 struct Lisp_Vector *sws1, *sws2;
6568 ptrdiff_t i;
6570 CHECK_WINDOW_CONFIGURATION (configuration1);
6571 CHECK_WINDOW_CONFIGURATION (configuration2);
6573 d1 = (struct save_window_data *) XVECTOR (configuration1);
6574 d2 = (struct save_window_data *) XVECTOR (configuration2);
6575 sws1 = XVECTOR (d1->saved_windows);
6576 sws2 = XVECTOR (d2->saved_windows);
6578 /* Frame settings must match. */
6579 if (d1->frame_cols != d2->frame_cols
6580 || d1->frame_lines != d2->frame_lines
6581 || d1->frame_menu_bar_lines != d2->frame_menu_bar_lines
6582 || !EQ (d1->selected_frame, d2->selected_frame)
6583 || !EQ (d1->current_buffer, d2->current_buffer)
6584 || (!ignore_positions
6585 && (!EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window)
6586 || !EQ (d1->minibuf_selected_window, d2->minibuf_selected_window)))
6587 || !EQ (d1->focus_frame, d2->focus_frame)
6588 /* Verify that the two configurations have the same number of windows. */
6589 || sws1->header.size != sws2->header.size)
6590 return 0;
6592 for (i = 0; i < sws1->header.size; i++)
6594 struct saved_window *sw1, *sw2;
6596 sw1 = SAVED_WINDOW_N (sws1, i);
6597 sw2 = SAVED_WINDOW_N (sws2, i);
6599 if (
6600 /* The "current" windows in the two configurations must
6601 correspond to each other. */
6602 EQ (d1->current_window, sw1->window)
6603 != EQ (d2->current_window, sw2->window)
6604 /* Windows' buffers must match. */
6605 || !EQ (sw1->buffer, sw2->buffer)
6606 || !EQ (sw1->left_col, sw2->left_col)
6607 || !EQ (sw1->top_line, sw2->top_line)
6608 || !EQ (sw1->total_cols, sw2->total_cols)
6609 || !EQ (sw1->total_lines, sw2->total_lines)
6610 || !EQ (sw1->display_table, sw2->display_table)
6611 /* The next two disjuncts check the window structure for
6612 equality. */
6613 || !EQ (sw1->parent, sw2->parent)
6614 || !EQ (sw1->prev, sw2->prev)
6615 || (!ignore_positions
6616 && (!EQ (sw1->hscroll, sw2->hscroll)
6617 || !EQ (sw1->min_hscroll, sw2->min_hscroll)
6618 || !EQ (sw1->start_at_line_beg, sw2->start_at_line_beg)
6619 || NILP (Fequal (sw1->start, sw2->start))
6620 || NILP (Fequal (sw1->pointm, sw2->pointm))
6621 || NILP (Fequal (sw1->mark, sw2->mark))))
6622 || !EQ (sw1->left_margin_cols, sw2->left_margin_cols)
6623 || !EQ (sw1->right_margin_cols, sw2->right_margin_cols)
6624 || !EQ (sw1->left_fringe_width, sw2->left_fringe_width)
6625 || !EQ (sw1->right_fringe_width, sw2->right_fringe_width)
6626 || !EQ (sw1->fringes_outside_margins, sw2->fringes_outside_margins)
6627 || !EQ (sw1->scroll_bar_width, sw2->scroll_bar_width)
6628 || !EQ (sw1->vertical_scroll_bar_type, sw2->vertical_scroll_bar_type))
6629 return 0;
6632 return 1;
6635 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
6636 Scompare_window_configurations, 2, 2, 0,
6637 doc: /* Compare two window configurations as regards the structure of windows.
6638 This function ignores details such as the values of point and mark
6639 and scrolling positions. */)
6640 (Lisp_Object x, Lisp_Object y)
6642 if (compare_window_configurations (x, y, 1))
6643 return Qt;
6644 return Qnil;
6647 void
6648 init_window_once (void)
6650 struct frame *f = make_initial_frame ();
6651 XSETFRAME (selected_frame, f);
6652 Vterminal_frame = selected_frame;
6653 minibuf_window = f->minibuffer_window;
6654 selected_window = f->selected_window;
6655 last_nonminibuf_frame = f;
6657 window_initialized = 1;
6660 void
6661 init_window (void)
6663 Vwindow_list = Qnil;
6666 void
6667 syms_of_window (void)
6669 DEFSYM (Qscroll_up, "scroll-up");
6670 DEFSYM (Qscroll_down, "scroll-down");
6671 DEFSYM (Qscroll_command, "scroll-command");
6673 Fput (Qscroll_up, Qscroll_command, Qt);
6674 Fput (Qscroll_down, Qscroll_command, Qt);
6676 DEFSYM (Qwindow_configuration_change_hook, "window-configuration-change-hook");
6677 DEFSYM (Qwindowp, "windowp");
6678 DEFSYM (Qwindow_configuration_p, "window-configuration-p");
6679 DEFSYM (Qwindow_live_p, "window-live-p");
6680 DEFSYM (Qwindow_valid_p, "window-valid-p");
6681 DEFSYM (Qwindow_deletable_p, "window-deletable-p");
6682 DEFSYM (Qdelete_window, "delete-window");
6683 DEFSYM (Qwindow_resize_root_window, "window--resize-root-window");
6684 DEFSYM (Qwindow_resize_root_window_vertically, "window--resize-root-window-vertically");
6685 DEFSYM (Qsafe, "safe");
6686 DEFSYM (Qdisplay_buffer, "display-buffer");
6687 DEFSYM (Qreplace_buffer_in_windows, "replace-buffer-in-windows");
6688 DEFSYM (Qrecord_window_buffer, "record-window-buffer");
6689 DEFSYM (Qget_mru_window, "get-mru-window");
6690 DEFSYM (Qwindow_size, "window-size");
6691 DEFSYM (Qtemp_buffer_show_hook, "temp-buffer-show-hook");
6692 DEFSYM (Qabove, "above");
6693 DEFSYM (Qbelow, "below");
6694 DEFSYM (Qclone_of, "clone-of");
6696 staticpro (&Vwindow_list);
6698 minibuf_selected_window = Qnil;
6699 staticpro (&minibuf_selected_window);
6701 window_scroll_pixel_based_preserve_x = -1;
6702 window_scroll_pixel_based_preserve_y = -1;
6703 window_scroll_preserve_hpos = -1;
6704 window_scroll_preserve_vpos = -1;
6706 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function,
6707 doc: /* Non-nil means call as function to display a help buffer.
6708 The function is called with one argument, the buffer to be displayed.
6709 Used by `with-output-to-temp-buffer'.
6710 If this function is used, then it must do the entire job of showing
6711 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
6712 Vtemp_buffer_show_function = Qnil;
6714 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window,
6715 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
6716 Vminibuf_scroll_window = Qnil;
6718 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows,
6719 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
6720 If the minibuffer is active, the `minibuffer-scroll-window' mode line
6721 is displayed in the `mode-line' face. */);
6722 mode_line_in_non_selected_windows = 1;
6724 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer,
6725 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
6726 Vother_window_scroll_buffer = Qnil;
6728 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p,
6729 doc: /* Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
6730 auto_window_vscroll_p = 1;
6732 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines,
6733 doc: /* Number of lines of continuity when scrolling by screenfuls. */);
6734 next_screen_context_lines = 2;
6736 DEFVAR_LISP ("scroll-preserve-screen-position",
6737 Vscroll_preserve_screen_position,
6738 doc: /* Controls if scroll commands move point to keep its screen position unchanged.
6739 A value of nil means point does not keep its screen position except
6740 at the scroll margin or window boundary respectively.
6741 A value of t means point keeps its screen position if the scroll
6742 command moved it vertically out of the window, e.g. when scrolling
6743 by full screens.
6744 Any other value means point always keeps its screen position.
6745 Scroll commands should have the `scroll-command' property
6746 on their symbols to be controlled by this variable. */);
6747 Vscroll_preserve_screen_position = Qnil;
6749 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type,
6750 doc: /* Type of marker to use for `window-point'. */);
6751 Vwindow_point_insertion_type = Qnil;
6753 DEFVAR_LISP ("window-configuration-change-hook",
6754 Vwindow_configuration_change_hook,
6755 doc: /* Functions to call when window configuration changes.
6756 The buffer-local part is run once per window, with the relevant window
6757 selected; while the global part is run only once for the modified frame,
6758 with the relevant frame selected. */);
6759 Vwindow_configuration_change_hook = Qnil;
6761 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay,
6762 doc: /* Non-nil means `recenter' redraws entire frame.
6763 If this option is non-nil, then the `recenter' command with a nil
6764 argument will redraw the entire frame; the special value `tty' causes
6765 the frame to be redrawn only if it is a tty frame. */);
6766 Vrecenter_redisplay = Qtty;
6768 DEFVAR_LISP ("window-combination-resize", Vwindow_combination_resize,
6769 doc: /* If t, resize window combinations proportionally.
6770 If this variable is nil, splitting a window gets the entire screen space
6771 for displaying the new window from the window to split. Deleting and
6772 resizing a window preferably resizes one adjacent window only.
6774 If this variable is t, splitting a window tries to get the space
6775 proportionally from all windows in the same combination. This also
6776 allows to split a window that is otherwise too small or of fixed size.
6777 Resizing and deleting a window proportionally resize all windows in the
6778 same combination.
6780 Other values are reserved for future use.
6782 This variable takes no effect if `window-combination-limit' is non-nil. */);
6783 Vwindow_combination_resize = Qnil;
6785 DEFVAR_LISP ("window-combination-limit", Vwindow_combination_limit,
6786 doc: /* If non-nil, splitting a window makes a new parent window.
6787 The following values are recognized:
6789 nil means splitting a window will create a new parent window only if the
6790 window has no parent window or the window shall become part of a
6791 combination orthogonal to the one it is part of.
6793 `window-size' means that splitting a window for displaying a buffer
6794 makes a new parent window provided `display-buffer' is supposed to
6795 explicitly set the window's size due to the presence of a
6796 `window-height' or `window-width' entry in the alist used by
6797 `display-buffer'. Otherwise, this value is handled like nil.
6799 `temp-buffer' means that splitting a window for displaying a temporary
6800 buffer always makes a new parent window. Otherwise, this value is
6801 handled like nil.
6803 `display-buffer' means that splitting a window for displaying a buffer
6804 always makes a new parent window. Since temporary buffers are
6805 displayed by the function `display-buffer', this value is stronger
6806 than `temp-buffer'. Splitting a window for other purpose makes a
6807 new parent window only if needed.
6809 t means that splitting a window always creates a new parent window. If
6810 all splits behave this way, each frame's window tree is a binary
6811 tree and every window but the frame's root window has exactly one
6812 sibling.
6814 Other values are reserved for future use. */);
6815 Vwindow_combination_limit = Qwindow_size;
6817 DEFVAR_LISP ("window-persistent-parameters", Vwindow_persistent_parameters,
6818 doc: /* Alist of persistent window parameters.
6819 This alist specifies which window parameters shall get saved by
6820 `current-window-configuration' and `window-state-get' and subsequently
6821 restored to their previous values by `set-window-configuration' and
6822 `window-state-put'.
6824 The car of each entry of this alist is the symbol specifying the
6825 parameter. The cdr is one of the following:
6827 nil means the parameter is neither saved by `window-state-get' nor by
6828 `current-window-configuration'.
6830 t means the parameter is saved by `current-window-configuration' and,
6831 provided its WRITABLE argument is nil, by `window-state-get'.
6833 The symbol `writable' means the parameter is saved unconditionally by
6834 both `current-window-configuration' and `window-state-get'. Do not use
6835 this value for parameters without read syntax (like windows or frames).
6837 Parameters not saved by `current-window-configuration' or
6838 `window-state-get' are left alone by `set-window-configuration'
6839 respectively are not installed by `window-state-put'. */);
6840 Vwindow_persistent_parameters = list1 (Fcons (Qclone_of, Qt));
6842 defsubr (&Sselected_window);
6843 defsubr (&Sminibuffer_window);
6844 defsubr (&Swindow_minibuffer_p);
6845 defsubr (&Swindowp);
6846 defsubr (&Swindow_valid_p);
6847 defsubr (&Swindow_live_p);
6848 defsubr (&Swindow_frame);
6849 defsubr (&Sframe_root_window);
6850 defsubr (&Sframe_first_window);
6851 defsubr (&Sframe_selected_window);
6852 defsubr (&Sset_frame_selected_window);
6853 defsubr (&Spos_visible_in_window_p);
6854 defsubr (&Swindow_line_height);
6855 defsubr (&Swindow_buffer);
6856 defsubr (&Swindow_parent);
6857 defsubr (&Swindow_top_child);
6858 defsubr (&Swindow_left_child);
6859 defsubr (&Swindow_next_sibling);
6860 defsubr (&Swindow_prev_sibling);
6861 defsubr (&Swindow_combination_limit);
6862 defsubr (&Sset_window_combination_limit);
6863 defsubr (&Swindow_use_time);
6864 defsubr (&Swindow_top_line);
6865 defsubr (&Swindow_left_column);
6866 defsubr (&Swindow_total_height);
6867 defsubr (&Swindow_total_width);
6868 defsubr (&Swindow_normal_size);
6869 defsubr (&Swindow_new_total);
6870 defsubr (&Swindow_new_normal);
6871 defsubr (&Sset_window_new_total);
6872 defsubr (&Sset_window_new_normal);
6873 defsubr (&Swindow_resize_apply);
6874 defsubr (&Swindow_body_height);
6875 defsubr (&Swindow_body_width);
6876 defsubr (&Swindow_hscroll);
6877 defsubr (&Sset_window_hscroll);
6878 defsubr (&Swindow_redisplay_end_trigger);
6879 defsubr (&Sset_window_redisplay_end_trigger);
6880 defsubr (&Swindow_edges);
6881 defsubr (&Swindow_pixel_edges);
6882 defsubr (&Swindow_absolute_pixel_edges);
6883 defsubr (&Swindow_inside_edges);
6884 defsubr (&Swindow_inside_pixel_edges);
6885 defsubr (&Swindow_inside_absolute_pixel_edges);
6886 defsubr (&Scoordinates_in_window_p);
6887 defsubr (&Swindow_at);
6888 defsubr (&Swindow_point);
6889 defsubr (&Swindow_start);
6890 defsubr (&Swindow_end);
6891 defsubr (&Sset_window_point);
6892 defsubr (&Sset_window_start);
6893 defsubr (&Swindow_dedicated_p);
6894 defsubr (&Sset_window_dedicated_p);
6895 defsubr (&Swindow_display_table);
6896 defsubr (&Sset_window_display_table);
6897 defsubr (&Snext_window);
6898 defsubr (&Sprevious_window);
6899 defsubr (&Sget_buffer_window);
6900 defsubr (&Sdelete_other_windows_internal);
6901 defsubr (&Sdelete_window_internal);
6902 defsubr (&Sresize_mini_window_internal);
6903 defsubr (&Sset_window_buffer);
6904 defsubr (&Srun_window_configuration_change_hook);
6905 defsubr (&Sselect_window);
6906 defsubr (&Sforce_window_update);
6907 defsubr (&Ssplit_window_internal);
6908 defsubr (&Sscroll_up);
6909 defsubr (&Sscroll_down);
6910 defsubr (&Sscroll_left);
6911 defsubr (&Sscroll_right);
6912 defsubr (&Sother_window_for_scrolling);
6913 defsubr (&Sscroll_other_window);
6914 defsubr (&Sminibuffer_selected_window);
6915 defsubr (&Srecenter);
6916 defsubr (&Swindow_text_height);
6917 defsubr (&Smove_to_window_line);
6918 defsubr (&Swindow_configuration_p);
6919 defsubr (&Swindow_configuration_frame);
6920 defsubr (&Sset_window_configuration);
6921 defsubr (&Scurrent_window_configuration);
6922 defsubr (&Sset_window_margins);
6923 defsubr (&Swindow_margins);
6924 defsubr (&Sset_window_fringes);
6925 defsubr (&Swindow_fringes);
6926 defsubr (&Sset_window_scroll_bars);
6927 defsubr (&Swindow_scroll_bars);
6928 defsubr (&Swindow_vscroll);
6929 defsubr (&Sset_window_vscroll);
6930 defsubr (&Scompare_window_configurations);
6931 defsubr (&Swindow_list);
6932 defsubr (&Swindow_list_1);
6933 defsubr (&Swindow_prev_buffers);
6934 defsubr (&Sset_window_prev_buffers);
6935 defsubr (&Swindow_next_buffers);
6936 defsubr (&Sset_window_next_buffers);
6937 defsubr (&Swindow_parameters);
6938 defsubr (&Swindow_parameter);
6939 defsubr (&Sset_window_parameter);
6942 void
6943 keys_of_window (void)
6945 initial_define_key (control_x_map, '<', "scroll-left");
6946 initial_define_key (control_x_map, '>', "scroll-right");
6948 initial_define_key (global_map, Ctl ('V'), "scroll-up-command");
6949 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
6950 initial_define_key (meta_map, 'v', "scroll-down-command");