In Fset_window_configuration install revison of reverted fix.
[emacs.git] / src / window.c
blob38124cb13a90e7580d71a89b73f378545d5f5987
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>
26 #include <setjmp.h>
28 #include "lisp.h"
29 #include "character.h"
30 #include "buffer.h"
31 #include "keyboard.h"
32 #include "keymap.h"
33 #include "frame.h"
34 #include "window.h"
35 #include "commands.h"
36 #include "indent.h"
37 #include "termchar.h"
38 #include "disptab.h"
39 #include "dispextern.h"
40 #include "blockinput.h"
41 #include "intervals.h"
42 #include "termhooks.h" /* For FRAME_TERMINAL. */
44 #ifdef HAVE_X_WINDOWS
45 #include "xterm.h"
46 #endif /* HAVE_X_WINDOWS */
47 #ifdef WINDOWSNT
48 #include "w32term.h"
49 #endif
50 #ifdef MSDOS
51 #include "msdos.h"
52 #endif
53 #ifdef HAVE_NS
54 #include "nsterm.h"
55 #endif
57 Lisp_Object Qwindowp, Qwindow_live_p;
58 static Lisp_Object Qwindow_valid_p;
59 static Lisp_Object Qwindow_configuration_p, Qrecord_window_buffer;
60 static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
61 static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
62 static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
63 static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
64 static Lisp_Object Qsafe, Qabove, Qbelow;
65 static Lisp_Object Qclone_of;
67 static int displayed_window_lines (struct window *);
68 static int count_windows (struct window *);
69 static int get_leaf_windows (struct window *, struct window **, int);
70 static void window_scroll (Lisp_Object, EMACS_INT, int, int);
71 static void window_scroll_pixel_based (Lisp_Object, int, int, int);
72 static void window_scroll_line_based (Lisp_Object, int, int, int);
73 static int freeze_window_start (struct window *, void *);
74 static Lisp_Object window_list (void);
75 static int add_window_to_list (struct window *, void *);
76 static int candidate_window_p (Lisp_Object, Lisp_Object, Lisp_Object,
77 Lisp_Object);
78 static Lisp_Object next_window (Lisp_Object, Lisp_Object,
79 Lisp_Object, int);
80 static void decode_next_window_args (Lisp_Object *, Lisp_Object *,
81 Lisp_Object *);
82 static void foreach_window (struct frame *,
83 int (* fn) (struct window *, void *),
84 void *);
85 static int foreach_window_1 (struct window *,
86 int (* fn) (struct window *, void *),
87 void *);
88 static Lisp_Object window_list_1 (Lisp_Object, Lisp_Object, Lisp_Object);
89 static int window_resize_check (struct window *, int);
90 static void window_resize_apply (struct window *, int);
91 static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
93 /* This is the window in which the terminal's cursor should
94 be left when nothing is being done with it. This must
95 always be a leaf window, and its buffer is selected by
96 the top level editing loop at the end of each command.
98 This value is always the same as
99 FRAME_SELECTED_WINDOW (selected_frame). */
100 Lisp_Object selected_window;
102 /* A list of all windows for use by next_window and Fwindow_list.
103 Functions creating or deleting windows should invalidate this cache
104 by setting it to nil. */
105 Lisp_Object Vwindow_list;
107 /* The mini-buffer window of the selected frame.
108 Note that you cannot test for mini-bufferness of an arbitrary window
109 by comparing against this; but you can test for mini-bufferness of
110 the selected window. */
111 Lisp_Object minibuf_window;
113 /* Non-nil means it is the window whose mode line should be
114 shown as the selected window when the minibuffer is selected. */
115 Lisp_Object minibuf_selected_window;
117 /* Hook run at end of temp_output_buffer_show. */
118 static Lisp_Object Qtemp_buffer_show_hook;
120 /* Incremented for each window created. */
121 static int sequence_number;
123 /* Nonzero after init_window_once has finished. */
124 static int window_initialized;
126 /* Hook to run when window config changes. */
127 static Lisp_Object Qwindow_configuration_change_hook;
129 /* Used by the function window_scroll_pixel_based */
130 static int window_scroll_pixel_based_preserve_x;
131 static int window_scroll_pixel_based_preserve_y;
133 /* Same for window_scroll_line_based. */
134 static EMACS_INT window_scroll_preserve_hpos;
135 static EMACS_INT window_scroll_preserve_vpos;
137 /* These setters are used only in this file, so they can be private. */
138 static inline void
139 wset_combination_limit (struct window *w, Lisp_Object val)
141 w->combination_limit = val;
143 static inline void
144 wset_dedicated (struct window *w, Lisp_Object val)
146 w->dedicated = val;
148 static inline void
149 wset_display_table (struct window *w, Lisp_Object val)
151 w->display_table = val;
153 static inline void
154 wset_hchild (struct window *w, Lisp_Object val)
156 w->hchild = val;
158 static inline void
159 wset_left_fringe_width (struct window *w, Lisp_Object val)
161 w->left_fringe_width = val;
163 static inline void
164 wset_left_margin_cols (struct window *w, Lisp_Object val)
166 w->left_margin_cols = val;
168 static inline void
169 wset_new_normal (struct window *w, Lisp_Object val)
171 w->new_normal = val;
173 static inline void
174 wset_new_total (struct window *w, Lisp_Object val)
176 w->new_total = val;
178 static inline void
179 wset_next_buffers (struct window *w, Lisp_Object val)
181 w->next_buffers = val;
183 static inline void
184 wset_normal_cols (struct window *w, Lisp_Object val)
186 w->normal_cols = val;
188 static inline void
189 wset_normal_lines (struct window *w, Lisp_Object val)
191 w->normal_lines = val;
193 static inline void
194 wset_parent (struct window *w, Lisp_Object val)
196 w->parent = val;
198 static inline void
199 wset_pointm (struct window *w, Lisp_Object val)
201 w->pointm = val;
203 static inline void
204 wset_prev_buffers (struct window *w, Lisp_Object val)
206 w->prev_buffers = val;
208 static inline void
209 wset_right_fringe_width (struct window *w, Lisp_Object val)
211 w->right_fringe_width = val;
213 static inline void
214 wset_right_margin_cols (struct window *w, Lisp_Object val)
216 w->right_margin_cols = val;
218 static inline void
219 wset_scroll_bar_width (struct window *w, Lisp_Object val)
221 w->scroll_bar_width = val;
223 static inline void
224 wset_start (struct window *w, Lisp_Object val)
226 w->start = val;
228 static inline void
229 wset_temslot (struct window *w, Lisp_Object val)
231 w->temslot = val;
233 static inline void
234 wset_vchild (struct window *w, Lisp_Object val)
236 w->vchild = val;
238 static inline void
239 wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
241 w->vertical_scroll_bar_type = val;
243 static inline void
244 wset_window_parameters (struct window *w, Lisp_Object val)
246 w->window_parameters = val;
249 struct window *
250 decode_live_window (register Lisp_Object window)
252 if (NILP (window))
253 return XWINDOW (selected_window);
255 CHECK_LIVE_WINDOW (window);
256 return XWINDOW (window);
259 static struct window *
260 decode_any_window (register Lisp_Object window)
262 struct window *w;
264 if (NILP (window))
265 return XWINDOW (selected_window);
267 CHECK_WINDOW (window);
268 w = XWINDOW (window);
269 return w;
272 static struct window *
273 decode_valid_window (register Lisp_Object window)
275 struct window *w;
277 if (NILP (window))
278 return XWINDOW (selected_window);
280 CHECK_VALID_WINDOW (window);
281 w = XWINDOW (window);
282 return w;
285 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
286 doc: /* Return t if OBJECT is a window and nil otherwise. */)
287 (Lisp_Object object)
289 return WINDOWP (object) ? Qt : Qnil;
292 DEFUN ("window-valid-p", Fwindow_valid_p, Swindow_valid_p, 1, 1, 0,
293 doc: /* Return t if OBJECT is a valid window and nil otherwise.
294 A valid window is either a window that displays a buffer or an internal
295 window. Deleted windows are not live. */)
296 (Lisp_Object object)
298 return WINDOW_VALID_P (object) ? Qt : Qnil;
301 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
302 doc: /* Return t if OBJECT is a live window and nil otherwise.
303 A live window is a window that displays a buffer.
304 Internal windows and deleted windows are not live. */)
305 (Lisp_Object object)
307 return WINDOW_LIVE_P (object) ? Qt : Qnil;
310 /* Frames and windows. */
311 DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 1, 1, 0,
312 doc: /* Return the frame that window WINDOW is on.
313 WINDOW must be a valid window and defaults to the selected one. */)
314 (Lisp_Object window)
316 return decode_valid_window (window)->frame;
319 DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
320 doc: /* Return the root window of FRAME-OR-WINDOW.
321 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
322 With a frame argument, return that frame's root window.
323 With a window argument, return the root window of that window's frame. */)
324 (Lisp_Object frame_or_window)
326 Lisp_Object window;
328 if (NILP (frame_or_window))
329 window = SELECTED_FRAME ()->root_window;
330 else if (WINDOW_VALID_P (frame_or_window))
331 window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
332 else
334 CHECK_LIVE_FRAME (frame_or_window);
335 window = XFRAME (frame_or_window)->root_window;
338 return window;
341 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
342 doc: /* Return the minibuffer window for frame FRAME.
343 If FRAME is omitted or nil, it defaults to the selected frame. */)
344 (Lisp_Object frame)
346 if (NILP (frame))
347 frame = selected_frame;
348 CHECK_LIVE_FRAME (frame);
349 return FRAME_MINIBUF_WINDOW (XFRAME (frame));
352 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
353 Swindow_minibuffer_p, 0, 1, 0,
354 doc: /* Return non-nil if WINDOW is a minibuffer window.
355 WINDOW must be a valid window and defaults to the selected one. */)
356 (Lisp_Object window)
358 return MINI_WINDOW_P (decode_valid_window (window)) ? Qt : Qnil;
361 /* Don't move this to window.el - this must be a safe routine. */
362 DEFUN ("frame-first-window", Fframe_first_window, Sframe_first_window, 0, 1, 0,
363 doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
364 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
365 Else if FRAME-OR-WINDOW denotes a valid window, return the first window
366 of that window's frame. If FRAME-OR-WINDOW denotes a live frame, return
367 the first window of that frame. */)
368 (Lisp_Object frame_or_window)
370 Lisp_Object window;
372 if (NILP (frame_or_window))
373 window = SELECTED_FRAME ()->root_window;
374 else if (WINDOW_VALID_P (frame_or_window))
375 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
376 else
378 CHECK_LIVE_FRAME (frame_or_window);
379 window = XFRAME (frame_or_window)->root_window;
382 while (NILP (XWINDOW (window)->buffer))
384 if (! NILP (XWINDOW (window)->hchild))
385 window = XWINDOW (window)->hchild;
386 else if (! NILP (XWINDOW (window)->vchild))
387 window = XWINDOW (window)->vchild;
388 else
389 abort ();
392 return window;
395 DEFUN ("frame-selected-window", Fframe_selected_window,
396 Sframe_selected_window, 0, 1, 0,
397 doc: /* Return the selected window of FRAME-OR-WINDOW.
398 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
399 Else if FRAME-OR-WINDOW denotes a valid window, return the selected
400 window of that window's frame. If FRAME-OR-WINDOW denotes a live frame,
401 return the selected window of that frame. */)
402 (Lisp_Object frame_or_window)
404 Lisp_Object window;
406 if (NILP (frame_or_window))
407 window = SELECTED_FRAME ()->selected_window;
408 else if (WINDOW_VALID_P (frame_or_window))
409 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
410 else
412 CHECK_LIVE_FRAME (frame_or_window);
413 window = XFRAME (frame_or_window)->selected_window;
416 return window;
419 DEFUN ("set-frame-selected-window", Fset_frame_selected_window,
420 Sset_frame_selected_window, 2, 3, 0,
421 doc: /* Set selected window of FRAME to WINDOW.
422 FRAME must be a live frame and defaults to the selected one. If FRAME
423 is the selected frame, this makes WINDOW the selected window. Optional
424 argument NORECORD non-nil means to neither change the order of recently
425 selected windows nor the buffer list. WINDOW must denote a live window.
426 Return WINDOW. */)
427 (Lisp_Object frame, Lisp_Object window, Lisp_Object norecord)
429 if (NILP (frame))
430 frame = selected_frame;
432 CHECK_LIVE_FRAME (frame);
433 CHECK_LIVE_WINDOW (window);
435 if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
436 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
438 if (EQ (frame, selected_frame))
439 return Fselect_window (window, norecord);
440 else
442 fset_selected_window (XFRAME (frame), window);
443 return window;
447 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
448 doc: /* Return the selected window.
449 The selected window is the window in which the standard cursor for
450 selected windows appears and to which many commands apply. */)
451 (void)
453 return selected_window;
456 int window_select_count;
458 /* If select_window is called with inhibit_point_swap non-zero it will
459 not store point of the old selected window's buffer back into that
460 window's pointm slot. This is needed by Fset_window_configuration to
461 avoid that the display routine is called with selected_window set to
462 Qnil causing a subsequent crash. */
463 static Lisp_Object
464 select_window (Lisp_Object window, Lisp_Object norecord, int inhibit_point_swap)
466 register struct window *w;
467 register struct window *ow;
468 struct frame *sf;
470 CHECK_LIVE_WINDOW (window);
472 w = XWINDOW (window);
473 w->frozen_window_start_p = 0;
475 if (NILP (norecord))
477 w->use_time = ++window_select_count;
478 record_buffer (w->buffer);
481 /* Make the selected window's buffer current. */
482 Fset_buffer (w->buffer);
484 if (EQ (window, selected_window) && !inhibit_point_swap)
485 return window;
487 sf = SELECTED_FRAME ();
488 if (XFRAME (WINDOW_FRAME (w)) != sf)
490 fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
491 /* Use this rather than Fhandle_switch_frame
492 so that FRAME_FOCUS_FRAME is moved appropriately as we
493 move around in the state where a minibuffer in a separate
494 frame is active. */
495 Fselect_frame (WINDOW_FRAME (w), norecord);
496 /* Fselect_frame called us back so we've done all the work already. */
497 eassert (EQ (window, selected_window));
498 return window;
500 else
501 fset_selected_window (sf, window);
503 /* Store the old selected window's buffer's point in pointm of the old
504 selected window. It belongs to that window, and when the window is
505 not selected, must be in the window. */
506 if (!inhibit_point_swap)
508 ow = XWINDOW (selected_window);
509 if (! NILP (ow->buffer))
510 set_marker_both (ow->pointm, ow->buffer,
511 BUF_PT (XBUFFER (ow->buffer)),
512 BUF_PT_BYTE (XBUFFER (ow->buffer)));
515 selected_window = window;
516 bset_last_selected_window (XBUFFER (w->buffer), window);
518 /* Go to the point recorded in the window.
519 This is important when the buffer is in more
520 than one window. It also matters when
521 redisplay_window has altered point after scrolling,
522 because it makes the change only in the window. */
524 register ptrdiff_t new_point = marker_position (w->pointm);
525 if (new_point < BEGV)
526 SET_PT (BEGV);
527 else if (new_point > ZV)
528 SET_PT (ZV);
529 else
530 SET_PT (new_point);
533 windows_or_buffers_changed++;
534 return window;
537 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
538 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
539 Also make WINDOW's buffer current and make WINDOW the frame's selected
540 window. Return WINDOW.
542 Optional second arg NORECORD non-nil means do not put this buffer at the
543 front of the buffer list and do not make this window the most recently
544 selected one.
546 Note that the main editor command loop sets the current buffer to the
547 buffer of the selected window before each command. */)
548 (register Lisp_Object window, Lisp_Object norecord)
550 return select_window (window, norecord, 0);
553 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
554 doc: /* Return the buffer displayed in window WINDOW.
555 If WINDOW is omitted or nil, it defaults to the selected window.
556 Return nil for an internal window or a deleted window. */)
557 (Lisp_Object window)
559 return decode_any_window (window)->buffer;
562 DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
563 doc: /* Return the parent window of window WINDOW.
564 WINDOW must be a valid window and defaults to the selected one.
565 Return nil for a window with no parent (e.g. a root window). */)
566 (Lisp_Object window)
568 return decode_valid_window (window)->parent;
571 DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 1, 1, 0,
572 doc: /* Return the topmost 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 horizontal combination. */)
577 (Lisp_Object window)
579 CHECK_WINDOW (window);
580 return decode_valid_window (window)->vchild;
583 DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 1, 1, 0,
584 doc: /* Return the leftmost child window of window WINDOW.
585 WINDOW must be a valid window and defaults to the selected one.
586 Return nil if WINDOW is a live window (live windows have no children).
587 Return nil if WINDOW is an internal window whose children form a
588 vertical combination. */)
589 (Lisp_Object window)
591 CHECK_WINDOW (window);
592 return decode_valid_window (window)->hchild;
595 DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
596 doc: /* Return the next sibling window of window WINDOW.
597 WINDOW must be a valid window and defaults to the selected one.
598 Return nil if WINDOW has no next sibling. */)
599 (Lisp_Object window)
601 return decode_valid_window (window)->next;
604 DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
605 doc: /* Return the previous sibling window of window WINDOW.
606 WINDOW must be a valid window and defaults to the selected one.
607 Return nil if WINDOW has no previous sibling. */)
608 (Lisp_Object window)
610 return decode_valid_window (window)->prev;
613 DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
614 doc: /* Return combination limit of window WINDOW.
615 WINDOW must be a valid window and defaults to the selected one.
616 If the return value is nil, child windows of WINDOW can be recombined with
617 WINDOW's siblings. A return value of t means that child windows of
618 WINDOW are never \(re-)combined with WINDOW's siblings. */)
619 (Lisp_Object window)
621 return decode_valid_window (window)->combination_limit;
624 DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
625 doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
626 WINDOW must be a valid window and defaults to the selected one.
627 If LIMIT is nil, child windows of WINDOW can be recombined with
628 WINDOW's siblings. LIMIT t means that child windows of WINDOW are
629 never \(re-)combined with WINDOW's siblings. Other values are reserved
630 for future use. */)
631 (Lisp_Object window, Lisp_Object limit)
633 wset_combination_limit (decode_valid_window (window), limit);
634 return limit;
637 DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
638 doc: /* Return the use time of window WINDOW.
639 WINDOW must be a live window and defaults to the selected one.
640 The window with the highest use time is the most recently selected
641 one. The window with the lowest use time is the least recently
642 selected one. */)
643 (Lisp_Object window)
645 return make_number (decode_live_window (window)->use_time);
648 DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
649 doc: /* Return the total height, in lines, of window WINDOW.
650 WINDOW must be a valid window and defaults to the selected one.
652 The return value includes the mode line and header line, if any.
653 If WINDOW is an internal window, the total height is the height
654 of the screen areas spanned by its children.
656 On a graphical display, this total height is reported as an
657 integer multiple of the default character height. */)
658 (Lisp_Object window)
660 return decode_valid_window (window)->total_lines;
663 DEFUN ("window-total-width", Fwindow_total_width, Swindow_total_width, 0, 1, 0,
664 doc: /* Return the total width, in columns, of window WINDOW.
665 WINDOW must be a valid window and defaults to the selected one.
667 The return value includes any vertical dividers or scroll bars
668 belonging to WINDOW. If WINDOW is an internal window, the total width
669 is the width of the screen areas spanned by its children.
671 On a graphical display, this total width is reported as an
672 integer multiple of the default character width. */)
673 (Lisp_Object window)
675 return decode_valid_window (window)->total_cols;
678 DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
679 doc: /* Return the new total size of window WINDOW.
680 WINDOW must be a valid window and defaults to the selected one. */)
681 (Lisp_Object window)
683 return decode_valid_window (window)->new_total;
686 DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
687 doc: /* Return the normal height of window WINDOW.
688 WINDOW must be a valid window and defaults to the selected one.
689 If HORIZONTAL is non-nil, return the normal width of WINDOW. */)
690 (Lisp_Object window, Lisp_Object horizontal)
692 struct window *w = decode_valid_window (window);
694 return NILP (horizontal) ? w->normal_lines : w->normal_cols;
697 DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
698 doc: /* Return new normal size of window WINDOW.
699 WINDOW must be a valid window and defaults to the selected one. */)
700 (Lisp_Object window)
702 return decode_valid_window (window)->new_normal;
705 DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
706 doc: /* Return left column of window WINDOW.
707 This is the distance, in columns, between the left edge of WINDOW and
708 the left edge of the frame's window area. For instance, the return
709 value is 0 if there is no window to the left of WINDOW.
711 WINDOW must be a valid window and defaults to the selected one. */)
712 (Lisp_Object window)
714 return decode_valid_window (window)->left_col;
717 DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
718 doc: /* Return top line of window WINDOW.
719 This is the distance, in lines, between the top of WINDOW and the top
720 of the frame's window area. For instance, the return value is 0 if
721 there is no window above WINDOW.
723 WINDOW must be a valid window and defaults to the selected one. */)
724 (Lisp_Object window)
726 return decode_valid_window (window)->top_line;
729 /* Return the number of lines of W's body. Don't count any mode or
730 header line of W. */
732 static int
733 window_body_lines (struct window *w)
735 int height = XFASTINT (w->total_lines);
737 if (!MINI_WINDOW_P (w))
739 if (WINDOW_WANTS_MODELINE_P (w))
740 --height;
741 if (WINDOW_WANTS_HEADER_LINE_P (w))
742 --height;
745 return height;
748 /* Return the number of columns of W's body. Don't count columns
749 occupied by the scroll bar or the vertical bar separating W from its
750 right sibling. On window-systems don't count fringes or display
751 margins either. */
754 window_body_cols (struct window *w)
756 struct frame *f = XFRAME (WINDOW_FRAME (w));
757 int width = XINT (w->total_cols);
759 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
760 /* Scroll bars occupy a few columns. */
761 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
762 else if (!FRAME_WINDOW_P (f)
763 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
764 /* The column of `|' characters separating side-by-side windows
765 occupies one column only. */
766 width -= 1;
768 if (FRAME_WINDOW_P (f))
769 /* On window-systems, fringes and display margins cannot be
770 used for normal text. */
771 width -= (WINDOW_FRINGE_COLS (w)
772 + WINDOW_LEFT_MARGIN_COLS (w)
773 + WINDOW_RIGHT_MARGIN_COLS (w));
775 return width;
778 DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 1, 0,
779 doc: /* Return the height, in lines, of WINDOW's text area.
780 WINDOW must be a live window and defaults to the selected one.
782 The returned height does not include the mode line or header line.
783 On a graphical display, the height is expressed as an integer multiple
784 of the default character height. If a line at the bottom of the text
785 area is only partially visible, that counts as a whole line; to
786 exclude partially-visible lines, use `window-text-height'. */)
787 (Lisp_Object window)
789 struct window *w = decode_live_window (window);
790 return make_number (window_body_lines (w));
793 DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 1, 0,
794 doc: /* Return the width, in columns, of WINDOW's text area.
795 WINDOW must be a live window and defaults to the selected one.
797 The return value does not include any vertical dividers, fringe or
798 marginal areas, or scroll bars. On a graphical display, the width is
799 expressed as an integer multiple of the default character width. */)
800 (Lisp_Object window)
802 struct window *w = decode_live_window (window);
803 return make_number (window_body_cols (w));
806 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
807 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
808 WINDOW must be a live window and defaults to the selected one. */)
809 (Lisp_Object window)
811 return make_number (decode_live_window (window)->hscroll);
814 /* Set W's horizontal scroll amount to HSCROLL clipped to a reasonable
815 range, returning the new amount as a fixnum. */
816 static Lisp_Object
817 set_window_hscroll (struct window *w, EMACS_INT hscroll)
819 /* Horizontal scrolling has problems with large scroll amounts.
820 It's too slow with long lines, and even with small lines the
821 display can be messed up. For now, though, impose only the limits
822 required by the internal representation: horizontal scrolling must
823 fit in fixnum (since it's visible to Elisp) and into ptrdiff_t
824 (since it's stored in a ptrdiff_t). */
825 ptrdiff_t hscroll_max = min (MOST_POSITIVE_FIXNUM, PTRDIFF_MAX);
826 ptrdiff_t new_hscroll = clip_to_bounds (0, hscroll, hscroll_max);
828 /* Prevent redisplay shortcuts when changing the hscroll. */
829 if (w->hscroll != new_hscroll)
830 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
832 w->hscroll = new_hscroll;
833 return make_number (new_hscroll);
836 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
837 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
838 WINDOW must be a live window and defaults to the selected one.
839 Clip the number to a reasonable value if out of range.
840 Return the new number. NCOL should be zero or positive.
842 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
843 window so that the location of point moves off-window. */)
844 (Lisp_Object window, Lisp_Object ncol)
846 struct window *w = decode_live_window (window);
848 CHECK_NUMBER (ncol);
849 return set_window_hscroll (w, XINT (ncol));
852 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
853 Swindow_redisplay_end_trigger, 0, 1, 0,
854 doc: /* Return WINDOW's redisplay end trigger value.
855 WINDOW must be a live window and defaults to the selected one.
856 See `set-window-redisplay-end-trigger' for more information. */)
857 (Lisp_Object window)
859 return decode_live_window (window)->redisplay_end_trigger;
862 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
863 Sset_window_redisplay_end_trigger, 2, 2, 0,
864 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
865 WINDOW must be a live window and defaults to the selected one. VALUE
866 should be a buffer position (typically a marker) or nil. If it is a
867 buffer position, then if redisplay in WINDOW reaches a position beyond
868 VALUE, the functions in `redisplay-end-trigger-functions' are called
869 with two arguments: WINDOW, and the end trigger value. Afterwards the
870 end-trigger value is reset to nil. */)
871 (register Lisp_Object window, Lisp_Object value)
873 wset_redisplay_end_trigger (decode_live_window (window), value);
874 return value;
877 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
878 doc: /* Return a list of the edge coordinates of WINDOW.
879 WINDOW must be a valid window and defaults to the selected one.
881 The returned list has the form (LEFT TOP RIGHT BOTTOM). TOP and BOTTOM
882 count by lines, and LEFT and RIGHT count by columns, all relative to 0,
883 0 at top left corner of frame.
885 RIGHT is one more than the rightmost column occupied by WINDOW. BOTTOM
886 is one more than the bottommost row occupied by WINDOW. The edges
887 include the space used by WINDOW's scroll bar, display margins, fringes,
888 header line, and/or mode line. For the edges of just the text area, use
889 `window-inside-edges'. */)
890 (Lisp_Object window)
892 register struct window *w = decode_valid_window (window);
894 return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
895 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
896 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
897 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
898 Qnil))));
901 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
902 doc: /* Return a list of the edge pixel coordinates of WINDOW.
903 WINDOW must be a valid window and defaults to the selected one.
905 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
906 0, 0 at the top left corner of the frame.
908 RIGHT is one more than the rightmost x position occupied by WINDOW.
909 BOTTOM is one more than the bottommost y position occupied by WINDOW.
910 The pixel edges include the space used by WINDOW's scroll bar, display
911 margins, fringes, header line, and/or mode line. For the pixel edges
912 of just the text area, use `window-inside-pixel-edges'. */)
913 (Lisp_Object window)
915 register struct window *w = decode_valid_window (window);
917 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
918 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
919 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
920 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
921 Qnil))));
924 static void
925 calc_absolute_offset (struct window *w, int *add_x, int *add_y)
927 struct frame *f = XFRAME (w->frame);
928 *add_y = f->top_pos;
929 #ifdef FRAME_MENUBAR_HEIGHT
930 *add_y += FRAME_MENUBAR_HEIGHT (f);
931 #endif
932 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
933 *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
934 #elif FRAME_TOOLBAR_HEIGHT
935 *add_y += FRAME_TOOLBAR_HEIGHT (f);
936 #endif
937 #ifdef FRAME_NS_TITLEBAR_HEIGHT
938 *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
939 #endif
940 *add_x = f->left_pos;
941 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
942 *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
943 #endif
946 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
947 Swindow_absolute_pixel_edges, 0, 1, 0,
948 doc: /* Return a list of the edge pixel coordinates of WINDOW.
949 WINDOW must be a valid window and defaults to the selected one.
951 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
952 0, 0 at the top left corner of the display.
954 RIGHT is one more than the rightmost x position occupied by WINDOW.
955 BOTTOM is one more than the bottommost y position occupied by WINDOW.
956 The pixel edges include the space used by WINDOW's scroll bar, display
957 margins, fringes, header line, and/or mode line. For the pixel edges
958 of just the text area, use `window-inside-absolute-pixel-edges'. */)
959 (Lisp_Object window)
961 register struct window *w = decode_valid_window (window);
962 int add_x, add_y;
963 calc_absolute_offset (w, &add_x, &add_y);
965 return Fcons (make_number (WINDOW_LEFT_EDGE_X (w) + add_x),
966 Fcons (make_number (WINDOW_TOP_EDGE_Y (w) + add_y),
967 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w) + add_x),
968 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w) + add_y),
969 Qnil))));
972 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
973 doc: /* Return a list of the edge coordinates of WINDOW.
974 WINDOW must be a live window and defaults to the selected one.
976 The returned list has the form (LEFT TOP RIGHT BOTTOM). TOP and BOTTOM
977 count by lines, and LEFT and RIGHT count by columns, all relative to 0,
978 0 at top left corner of frame.
980 RIGHT is one more than the rightmost column of WINDOW's text area.
981 BOTTOM is one more than the bottommost row of WINDOW's text area. The
982 inside edges do not include the space used by the WINDOW's scroll bar,
983 display margins, fringes, header line, and/or mode line. */)
984 (Lisp_Object window)
986 register struct window *w = decode_live_window (window);
988 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
989 + WINDOW_LEFT_MARGIN_COLS (w)
990 + WINDOW_LEFT_FRINGE_COLS (w)),
991 make_number (WINDOW_TOP_EDGE_LINE (w)
992 + WINDOW_HEADER_LINE_LINES (w)),
993 make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
994 - WINDOW_RIGHT_MARGIN_COLS (w)
995 - WINDOW_RIGHT_FRINGE_COLS (w)),
996 make_number (WINDOW_BOTTOM_EDGE_LINE (w)
997 - WINDOW_MODE_LINE_LINES (w)));
1000 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
1001 doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
1002 WINDOW must be a live window and defaults to the selected one.
1004 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
1005 (0,0) at the top left corner of the frame's window area.
1007 RIGHT is one more than the rightmost x position of WINDOW's text area.
1008 BOTTOM is one more than the bottommost y position of WINDOW's text area.
1009 The inside edges do not include the space used by WINDOW's scroll bar,
1010 display margins, fringes, header line, and/or mode line. */)
1011 (Lisp_Object window)
1013 register struct window *w = decode_live_window (window);
1015 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
1016 + WINDOW_LEFT_MARGIN_WIDTH (w)
1017 + WINDOW_LEFT_FRINGE_WIDTH (w)),
1018 make_number (WINDOW_TOP_EDGE_Y (w)
1019 + WINDOW_HEADER_LINE_HEIGHT (w)),
1020 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
1021 - WINDOW_RIGHT_MARGIN_WIDTH (w)
1022 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
1023 make_number (WINDOW_BOTTOM_EDGE_Y (w)
1024 - WINDOW_MODE_LINE_HEIGHT (w)));
1027 DEFUN ("window-inside-absolute-pixel-edges",
1028 Fwindow_inside_absolute_pixel_edges,
1029 Swindow_inside_absolute_pixel_edges, 0, 1, 0,
1030 doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
1031 WINDOW must be a live window and defaults to the selected one.
1033 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
1034 (0,0) at the top left corner of the frame's window area.
1036 RIGHT is one more than the rightmost x position of WINDOW's text area.
1037 BOTTOM is one more than the bottommost y position of WINDOW's text area.
1038 The inside edges do not include the space used by WINDOW's scroll bar,
1039 display margins, fringes, header line, and/or mode line. */)
1040 (Lisp_Object window)
1042 register struct window *w = decode_live_window (window);
1043 int add_x, add_y;
1044 calc_absolute_offset (w, &add_x, &add_y);
1046 return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
1047 + WINDOW_LEFT_MARGIN_WIDTH (w)
1048 + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
1049 make_number (WINDOW_TOP_EDGE_Y (w)
1050 + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
1051 make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
1052 - WINDOW_RIGHT_MARGIN_WIDTH (w)
1053 - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
1054 make_number (WINDOW_BOTTOM_EDGE_Y (w)
1055 - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
1058 /* Test if the character at column X, row Y is within window W.
1059 If it is not, return ON_NOTHING;
1060 if it is in the window's text area, return ON_TEXT;
1061 if it is on the window's modeline, return ON_MODE_LINE;
1062 if it is on the border between the window and its right sibling,
1063 return ON_VERTICAL_BORDER.
1064 if it is on a scroll bar, return ON_SCROLL_BAR.
1065 if it is on the window's top line, return ON_HEADER_LINE;
1066 if it is in left or right fringe of the window,
1067 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
1068 if it is in the marginal area to the left/right of the window,
1069 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
1071 X and Y are frame relative pixel coordinates. */
1073 static enum window_part
1074 coordinates_in_window (register struct window *w, int x, int y)
1076 struct frame *f = XFRAME (WINDOW_FRAME (w));
1077 enum window_part part;
1078 int ux = FRAME_COLUMN_WIDTH (f);
1079 int left_x = WINDOW_LEFT_EDGE_X (w);
1080 int right_x = WINDOW_RIGHT_EDGE_X (w);
1081 int top_y = WINDOW_TOP_EDGE_Y (w);
1082 int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
1083 /* The width of the area where the vertical line can be dragged.
1084 (Between mode lines for instance. */
1085 int grabbable_width = ux;
1086 int lmargin_width, rmargin_width, text_left, text_right;
1088 /* Outside any interesting row or column? */
1089 if (y < top_y || y >= bottom_y || x < left_x || x >= right_x)
1090 return ON_NOTHING;
1092 /* On the mode line or header line? */
1093 if ((WINDOW_WANTS_MODELINE_P (w)
1094 && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
1095 && (part = ON_MODE_LINE))
1096 || (WINDOW_WANTS_HEADER_LINE_P (w)
1097 && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
1098 && (part = ON_HEADER_LINE)))
1100 /* If it's under/over the scroll bar portion of the mode/header
1101 line, say it's on the vertical line. That's to be able to
1102 resize windows horizontally in case we're using toolkit scroll
1103 bars. Note: If scrollbars are on the left, the window that
1104 must be eventually resized is that on the left of WINDOW. */
1105 if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
1106 && !WINDOW_LEFTMOST_P (w)
1107 && eabs (x - left_x) < grabbable_width)
1108 || (!WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
1109 && !WINDOW_RIGHTMOST_P (w)
1110 && eabs (x - right_x) < grabbable_width))
1111 return ON_VERTICAL_BORDER;
1112 else
1113 return part;
1116 /* In what's below, we subtract 1 when computing right_x because we
1117 want the rightmost pixel, which is given by left_pixel+width-1. */
1118 if (w->pseudo_window_p)
1120 left_x = 0;
1121 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
1123 else
1125 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
1126 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
1129 /* Outside any interesting column? */
1130 if (x < left_x || x > right_x)
1131 return ON_SCROLL_BAR;
1133 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
1134 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
1136 text_left = window_box_left (w, TEXT_AREA);
1137 text_right = text_left + window_box_width (w, TEXT_AREA);
1139 if (FRAME_WINDOW_P (f))
1141 if (!w->pseudo_window_p
1142 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
1143 && !WINDOW_RIGHTMOST_P (w)
1144 && (eabs (x - right_x) < grabbable_width))
1145 return ON_VERTICAL_BORDER;
1147 /* Need to say "x > right_x" rather than >=, since on character
1148 terminals, the vertical line's x coordinate is right_x. */
1149 else if (!w->pseudo_window_p
1150 && !WINDOW_RIGHTMOST_P (w)
1151 && x > right_x - ux)
1152 return ON_VERTICAL_BORDER;
1154 if (x < text_left)
1156 if (lmargin_width > 0
1157 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1158 ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
1159 : (x < left_x + lmargin_width)))
1160 return ON_LEFT_MARGIN;
1162 return ON_LEFT_FRINGE;
1165 if (x >= text_right)
1167 if (rmargin_width > 0
1168 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1169 ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
1170 : (x >= right_x - rmargin_width)))
1171 return ON_RIGHT_MARGIN;
1173 return ON_RIGHT_FRINGE;
1176 /* Everything special ruled out - must be on text area */
1177 return ON_TEXT;
1180 /* Take X is the frame-relative pixel x-coordinate, and return the
1181 x-coordinate relative to part PART of window W. */
1183 window_relative_x_coord (struct window *w, enum window_part part, int x)
1185 int left_x = (w->pseudo_window_p) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w);
1187 switch (part)
1189 case ON_TEXT:
1190 return x - window_box_left (w, TEXT_AREA);
1192 case ON_LEFT_FRINGE:
1193 return x - left_x;
1195 case ON_RIGHT_FRINGE:
1196 return x - left_x - WINDOW_LEFT_FRINGE_WIDTH (w);
1198 case ON_LEFT_MARGIN:
1199 return (x - left_x
1200 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1201 ? WINDOW_LEFT_FRINGE_WIDTH (w) : 0));
1203 case ON_RIGHT_MARGIN:
1204 return (x + 1
1205 - ((w->pseudo_window_p)
1206 ? WINDOW_TOTAL_WIDTH (w)
1207 : WINDOW_BOX_RIGHT_EDGE_X (w))
1208 + window_box_width (w, RIGHT_MARGIN_AREA)
1209 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1210 ? WINDOW_RIGHT_FRINGE_WIDTH (w) : 0));
1213 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
1214 return 0;
1218 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
1219 Scoordinates_in_window_p, 2, 2, 0,
1220 doc: /* Return non-nil if COORDINATES are in WINDOW.
1221 WINDOW must be a live window and defaults to the selected one.
1222 COORDINATES is a cons of the form (X . Y), X and Y being distances
1223 measured in characters from the upper-left corner of the frame.
1224 \(0 . 0) denotes the character in the upper left corner of the
1225 frame.
1226 If COORDINATES are in the text portion of WINDOW,
1227 the coordinates relative to the window are returned.
1228 If they are in the mode line of WINDOW, `mode-line' is returned.
1229 If they are in the top mode line of WINDOW, `header-line' is returned.
1230 If they are in the left fringe of WINDOW, `left-fringe' is returned.
1231 If they are in the right fringe of WINDOW, `right-fringe' is returned.
1232 If they are on the border between WINDOW and its right sibling,
1233 `vertical-line' is returned.
1234 If they are in the windows's left or right marginal areas, `left-margin'\n\
1235 or `right-margin' is returned. */)
1236 (register Lisp_Object coordinates, Lisp_Object window)
1238 struct window *w;
1239 struct frame *f;
1240 int x, y;
1241 Lisp_Object lx, ly;
1243 w = decode_live_window (window);
1244 f = XFRAME (w->frame);
1245 CHECK_CONS (coordinates);
1246 lx = Fcar (coordinates);
1247 ly = Fcdr (coordinates);
1248 CHECK_NUMBER_OR_FLOAT (lx);
1249 CHECK_NUMBER_OR_FLOAT (ly);
1250 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
1251 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
1253 switch (coordinates_in_window (w, x, y))
1255 case ON_NOTHING:
1256 return Qnil;
1258 case ON_TEXT:
1259 /* Convert X and Y to window relative pixel coordinates, and
1260 return the canonical char units. */
1261 x -= window_box_left (w, TEXT_AREA);
1262 y -= WINDOW_TOP_EDGE_Y (w);
1263 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
1264 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
1266 case ON_MODE_LINE:
1267 return Qmode_line;
1269 case ON_VERTICAL_BORDER:
1270 return Qvertical_line;
1272 case ON_HEADER_LINE:
1273 return Qheader_line;
1275 case ON_LEFT_FRINGE:
1276 return Qleft_fringe;
1278 case ON_RIGHT_FRINGE:
1279 return Qright_fringe;
1281 case ON_LEFT_MARGIN:
1282 return Qleft_margin;
1284 case ON_RIGHT_MARGIN:
1285 return Qright_margin;
1287 case ON_SCROLL_BAR:
1288 /* Historically we are supposed to return nil in this case. */
1289 return Qnil;
1291 default:
1292 abort ();
1297 /* Callback for foreach_window, used in window_from_coordinates.
1298 Check if window W contains coordinates specified by USER_DATA which
1299 is actually a pointer to a struct check_window_data CW.
1301 Check if window W contains coordinates *CW->x and *CW->y. If it
1302 does, return W in *CW->window, as Lisp_Object, and return in
1303 *CW->part the part of the window under coordinates *X,*Y. Return
1304 zero from this function to stop iterating over windows. */
1306 struct check_window_data
1308 Lisp_Object *window;
1309 int x, y;
1310 enum window_part *part;
1313 static int
1314 check_window_containing (struct window *w, void *user_data)
1316 struct check_window_data *cw = (struct check_window_data *) user_data;
1317 enum window_part found;
1318 int continue_p = 1;
1320 found = coordinates_in_window (w, cw->x, cw->y);
1321 if (found != ON_NOTHING)
1323 *cw->part = found;
1324 XSETWINDOW (*cw->window, w);
1325 continue_p = 0;
1328 return continue_p;
1332 /* Find the window containing frame-relative pixel position X/Y and
1333 return it as a Lisp_Object.
1335 If X, Y is on one of the window's special `window_part' elements,
1336 set *PART to the id of that element.
1338 If there is no window under X, Y return nil and leave *PART
1339 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1341 This function was previously implemented with a loop cycling over
1342 windows with Fnext_window, and starting with the frame's selected
1343 window. It turned out that this doesn't work with an
1344 implementation of next_window using Vwindow_list, because
1345 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1346 tree of F when this function is called asynchronously from
1347 note_mouse_highlight. The original loop didn't terminate in this
1348 case. */
1350 Lisp_Object
1351 window_from_coordinates (struct frame *f, int x, int y,
1352 enum window_part *part, int tool_bar_p)
1354 Lisp_Object window;
1355 struct check_window_data cw;
1356 enum window_part dummy;
1358 if (part == 0)
1359 part = &dummy;
1361 window = Qnil;
1362 cw.window = &window, cw.x = x, cw.y = y; cw.part = part;
1363 foreach_window (f, check_window_containing, &cw);
1365 /* If not found above, see if it's in the tool bar window, if a tool
1366 bar exists. */
1367 if (NILP (window)
1368 && tool_bar_p
1369 && WINDOWP (f->tool_bar_window)
1370 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1371 && (coordinates_in_window (XWINDOW (f->tool_bar_window), x, y)
1372 != ON_NOTHING))
1374 *part = ON_TEXT;
1375 window = f->tool_bar_window;
1378 return window;
1381 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1382 doc: /* Return window containing coordinates X and Y on FRAME.
1383 FRAME must be a live frame and defaults to the selected one.
1384 The top left corner of the frame is considered to be row 0,
1385 column 0. */)
1386 (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
1388 struct frame *f;
1390 if (NILP (frame))
1391 frame = selected_frame;
1392 CHECK_LIVE_FRAME (frame);
1393 f = XFRAME (frame);
1395 /* Check that arguments are integers or floats. */
1396 CHECK_NUMBER_OR_FLOAT (x);
1397 CHECK_NUMBER_OR_FLOAT (y);
1399 return window_from_coordinates (f,
1400 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1401 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1402 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1403 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1404 0, 0);
1407 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1408 doc: /* Return current value of point in WINDOW.
1409 WINDOW must be a live window and defaults to the selected one.
1411 For a nonselected window, this is the value point would have if that
1412 window were selected.
1414 Note that, when WINDOW is selected, the value returned is the same as
1415 that returned by `point' for WINDOW's buffer. It would be more strictly
1416 correct to return the `top-level' value of `point', outside of any
1417 `save-excursion' forms. But that is hard to define. */)
1418 (Lisp_Object window)
1420 register struct window *w = decode_live_window (window);
1422 if (w == XWINDOW (selected_window))
1423 return make_number (BUF_PT (XBUFFER (w->buffer)));
1424 else
1425 return Fmarker_position (w->pointm);
1428 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1429 doc: /* Return position at which display currently starts in WINDOW.
1430 WINDOW must be a live window and defaults to the selected one.
1431 This is updated by redisplay or by calling `set-window-start'. */)
1432 (Lisp_Object window)
1434 return Fmarker_position (decode_live_window (window)->start);
1437 /* This is text temporarily removed from the doc string below.
1439 This function returns nil if the position is not currently known.
1440 That happens when redisplay is preempted and doesn't finish.
1441 If in that case you want to compute where the end of the window would
1442 have been if redisplay had finished, do this:
1443 (save-excursion
1444 (goto-char (window-start window))
1445 (vertical-motion (1- (window-height window)) window)
1446 (point))") */
1448 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1449 doc: /* Return position at which display currently ends in WINDOW.
1450 WINDOW must be a live window and defaults to the selected one.
1451 This is updated by redisplay, when it runs to completion.
1452 Simply changing the buffer text or setting `window-start'
1453 does not update this value.
1454 Return nil if there is no recorded value. (This can happen if the
1455 last redisplay of WINDOW was preempted, and did not finish.)
1456 If UPDATE is non-nil, compute the up-to-date position
1457 if it isn't already recorded. */)
1458 (Lisp_Object window, Lisp_Object update)
1460 Lisp_Object value;
1461 struct window *w = decode_live_window (window);
1462 Lisp_Object buf;
1463 struct buffer *b;
1465 buf = w->buffer;
1466 CHECK_BUFFER (buf);
1467 b = XBUFFER (buf);
1469 #if 0 /* This change broke some things. We should make it later. */
1470 /* If we don't know the end position, return nil.
1471 The user can compute it with vertical-motion if he wants to.
1472 It would be nicer to do it automatically,
1473 but that's so slow that it would probably bother people. */
1474 if (NILP (w->window_end_valid))
1475 return Qnil;
1476 #endif
1478 if (! NILP (update)
1479 && ! (! NILP (w->window_end_valid)
1480 && w->last_modified >= BUF_MODIFF (b)
1481 && w->last_overlay_modified >= BUF_OVERLAY_MODIFF (b))
1482 && !noninteractive)
1484 struct text_pos startp;
1485 struct it it;
1486 struct buffer *old_buffer = NULL;
1487 void *itdata = NULL;
1489 /* Cannot use Fvertical_motion because that function doesn't
1490 cope with variable-height lines. */
1491 if (b != current_buffer)
1493 old_buffer = current_buffer;
1494 set_buffer_internal (b);
1497 /* In case W->start is out of the range, use something
1498 reasonable. This situation occurred when loading a file with
1499 `-l' containing a call to `rmail' with subsequent other
1500 commands. At the end, W->start happened to be BEG, while
1501 rmail had already narrowed the buffer. */
1502 if (XMARKER (w->start)->charpos < BEGV)
1503 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1504 else if (XMARKER (w->start)->charpos > ZV)
1505 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1506 else
1507 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1509 itdata = bidi_shelve_cache ();
1510 start_display (&it, w, startp);
1511 move_it_vertically (&it, window_box_height (w));
1512 if (it.current_y < it.last_visible_y)
1513 move_it_past_eol (&it);
1514 value = make_number (IT_CHARPOS (it));
1515 bidi_unshelve_cache (itdata, 0);
1517 if (old_buffer)
1518 set_buffer_internal (old_buffer);
1520 else
1521 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1523 return value;
1526 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1527 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1528 WINDOW must be a live window and defaults to the selected one.
1529 Return POS. */)
1530 (Lisp_Object window, Lisp_Object pos)
1532 register struct window *w = decode_live_window (window);
1534 CHECK_NUMBER_COERCE_MARKER (pos);
1536 if (w == XWINDOW (selected_window))
1538 if (XBUFFER (w->buffer) == current_buffer)
1539 Fgoto_char (pos);
1540 else
1542 struct buffer *old_buffer = current_buffer;
1544 set_buffer_internal (XBUFFER (w->buffer));
1545 Fgoto_char (pos);
1546 set_buffer_internal (old_buffer);
1549 else
1551 set_marker_restricted (w->pointm, pos, w->buffer);
1552 /* We have to make sure that redisplay updates the window to show
1553 the new value of point. */
1554 ++windows_or_buffers_changed;
1557 return pos;
1560 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1561 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1562 WINDOW must be a live window and defaults to the selected one. Return
1563 POS. Optional third arg NOFORCE non-nil inhibits next redisplay from
1564 overriding motion of point in order to display at this exact start. */)
1565 (Lisp_Object window, Lisp_Object pos, Lisp_Object noforce)
1567 register struct window *w = decode_live_window (window);
1569 CHECK_NUMBER_COERCE_MARKER (pos);
1570 set_marker_restricted (w->start, pos, w->buffer);
1571 /* this is not right, but much easier than doing what is right. */
1572 w->start_at_line_beg = 0;
1573 if (NILP (noforce))
1574 w->force_start = 1;
1575 w->update_mode_line = 1;
1576 w->last_modified = 0;
1577 w->last_overlay_modified = 0;
1578 if (!EQ (window, selected_window))
1579 windows_or_buffers_changed++;
1581 return pos;
1584 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
1585 Spos_visible_in_window_p, 0, 3, 0,
1586 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
1587 WINDOW must be a live window and defaults to the selected one.
1589 Return nil if that position is scrolled vertically out of view. If a
1590 character is only partially visible, nil is returned, unless the
1591 optional argument PARTIALLY is non-nil. If POS is only out of view
1592 because of horizontal scrolling, return non-nil. If POS is t, it
1593 specifies the position of the last visible glyph in WINDOW. POS
1594 defaults to point in WINDOW; WINDOW defaults to the selected window.
1596 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
1597 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
1598 where X and Y are the pixel coordinates relative to the top left corner
1599 of the window. The remaining elements are omitted if the character after
1600 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
1601 off-window at the top and bottom of the row, ROWH is the height of the
1602 display row, and VPOS is the row number (0-based) containing POS. */)
1603 (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
1605 register struct window *w;
1606 register EMACS_INT posint;
1607 register struct buffer *buf;
1608 struct text_pos top;
1609 Lisp_Object in_window = Qnil;
1610 int rtop, rbot, rowh, vpos, fully_p = 1;
1611 int x, y;
1613 w = decode_live_window (window);
1614 buf = XBUFFER (w->buffer);
1615 SET_TEXT_POS_FROM_MARKER (top, w->start);
1617 if (EQ (pos, Qt))
1618 posint = -1;
1619 else if (!NILP (pos))
1621 CHECK_NUMBER_COERCE_MARKER (pos);
1622 posint = XINT (pos);
1624 else if (w == XWINDOW (selected_window))
1625 posint = PT;
1626 else
1627 posint = XMARKER (w->pointm)->charpos;
1629 /* If position is above window start or outside buffer boundaries,
1630 or if window start is out of range, position is not visible. */
1631 if ((EQ (pos, Qt)
1632 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
1633 && CHARPOS (top) >= BUF_BEGV (buf)
1634 && CHARPOS (top) <= BUF_ZV (buf)
1635 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
1636 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
1637 in_window = Qt;
1639 if (!NILP (in_window) && !NILP (partially))
1641 Lisp_Object part = Qnil;
1642 if (!fully_p)
1643 part = list4 (make_number (rtop), make_number (rbot),
1644 make_number (rowh), make_number (vpos));
1645 in_window = Fcons (make_number (x),
1646 Fcons (make_number (y), part));
1649 return in_window;
1652 DEFUN ("window-line-height", Fwindow_line_height,
1653 Swindow_line_height, 0, 2, 0,
1654 doc: /* Return height in pixels of text line LINE in window WINDOW.
1655 WINDOW must be a live window and defaults to the selected one.
1657 Return height of current line if LINE is omitted or nil. Return height of
1658 header or mode line if LINE is `header-line' or `mode-line'.
1659 Otherwise, LINE is a text line number starting from 0. A negative number
1660 counts from the end of the window.
1662 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
1663 in pixels of the visible part of the line, VPOS and YPOS are the
1664 vertical position in lines and pixels of the line, relative to the top
1665 of the first text line, and OFFBOT is the number of off-window pixels at
1666 the bottom of the text line. If there are off-window pixels at the top
1667 of the (first) text line, YPOS is negative.
1669 Return nil if window display is not up-to-date. In that case, use
1670 `pos-visible-in-window-p' to obtain the information. */)
1671 (Lisp_Object line, Lisp_Object window)
1673 register struct window *w;
1674 register struct buffer *b;
1675 struct glyph_row *row, *end_row;
1676 int max_y, crop, i;
1677 EMACS_INT n;
1679 w = decode_live_window (window);
1681 if (noninteractive || w->pseudo_window_p)
1682 return Qnil;
1684 CHECK_BUFFER (w->buffer);
1685 b = XBUFFER (w->buffer);
1687 /* Fail if current matrix is not up-to-date. */
1688 if (NILP (w->window_end_valid)
1689 || current_buffer->clip_changed
1690 || current_buffer->prevent_redisplay_optimizations_p
1691 || w->last_modified < BUF_MODIFF (b)
1692 || w->last_overlay_modified < BUF_OVERLAY_MODIFF (b))
1693 return Qnil;
1695 if (NILP (line))
1697 i = w->cursor.vpos;
1698 if (i < 0 || i >= w->current_matrix->nrows
1699 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
1700 return Qnil;
1701 max_y = window_text_bottom_y (w);
1702 goto found_row;
1705 if (EQ (line, Qheader_line))
1707 if (!WINDOW_WANTS_HEADER_LINE_P (w))
1708 return Qnil;
1709 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
1710 if (!row->enabled_p)
1711 return Qnil;
1712 return list4 (make_number (row->height),
1713 make_number (0), make_number (0),
1714 make_number (0));
1717 if (EQ (line, Qmode_line))
1719 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
1720 if (!row->enabled_p)
1721 return Qnil;
1722 return list4 (make_number (row->height),
1723 make_number (0), /* not accurate */
1724 make_number (WINDOW_HEADER_LINE_HEIGHT (w)
1725 + window_text_bottom_y (w)),
1726 make_number (0));
1729 CHECK_NUMBER (line);
1730 n = XINT (line);
1732 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
1733 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
1734 max_y = window_text_bottom_y (w);
1735 i = 0;
1737 while ((n < 0 || i < n)
1738 && row <= end_row && row->enabled_p
1739 && row->y + row->height < max_y)
1740 row++, i++;
1742 if (row > end_row || !row->enabled_p)
1743 return Qnil;
1745 if (++n < 0)
1747 if (-n > i)
1748 return Qnil;
1749 row += n;
1750 i += n;
1753 found_row:
1754 crop = max (0, (row->y + row->height) - max_y);
1755 return list4 (make_number (row->height + min (0, row->y) - crop),
1756 make_number (i),
1757 make_number (row->y),
1758 make_number (crop));
1761 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1762 0, 1, 0,
1763 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1764 More precisely, return the value assigned by the last call of
1765 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1766 never called with WINDOW as its argument, or the value set by that
1767 function was internally reset since its last call. WINDOW must be a
1768 live window and defaults to the selected one.
1770 When a window is dedicated to its buffer, `display-buffer' will refrain
1771 from displaying another buffer in it. `get-lru-window' and
1772 `get-largest-window' treat dedicated windows specially.
1773 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1774 `kill-buffer' can delete a dedicated window and the containing frame.
1776 Functions like `set-window-buffer' may change the buffer displayed by a
1777 window, unless that window is "strongly" dedicated to its buffer, that
1778 is the value returned by `window-dedicated-p' is t. */)
1779 (Lisp_Object window)
1781 return decode_live_window (window)->dedicated;
1784 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1785 Sset_window_dedicated_p, 2, 2, 0,
1786 doc: /* Mark WINDOW as dedicated according to FLAG.
1787 WINDOW must be a live window and defaults to the selected one. FLAG
1788 non-nil means mark WINDOW as dedicated to its buffer. FLAG nil means
1789 mark WINDOW as non-dedicated. Return FLAG.
1791 When a window is dedicated to its buffer, `display-buffer' will refrain
1792 from displaying another buffer in it. `get-lru-window' and
1793 `get-largest-window' treat dedicated windows specially.
1794 `delete-windows-on', `replace-buffer-in-windows', `quit-window',
1795 `quit-restore-window' and `kill-buffer' can delete a dedicated window
1796 and the containing frame.
1798 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1799 its buffer. Functions like `set-window-buffer' may change the buffer
1800 displayed by a window, unless that window is strongly dedicated to its
1801 buffer. If and when `set-window-buffer' displays another buffer in a
1802 window, it also makes sure that the window is no more dedicated. */)
1803 (Lisp_Object window, Lisp_Object flag)
1805 wset_dedicated (decode_live_window (window), flag);
1806 return flag;
1809 DEFUN ("window-prev-buffers", Fwindow_prev_buffers, Swindow_prev_buffers,
1810 0, 1, 0,
1811 doc: /* Return buffers previously shown in WINDOW.
1812 WINDOW must be a live window and defaults to the selected one.
1814 The return value is a list of elements (BUFFER WINDOW-START POS),
1815 where BUFFER is a buffer, WINDOW-START is the start position of the
1816 window for that buffer, and POS is a window-specific point value. */)
1817 (Lisp_Object window)
1819 return decode_live_window (window)->prev_buffers;
1822 DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers,
1823 Sset_window_prev_buffers, 2, 2, 0,
1824 doc: /* Set WINDOW's previous buffers to PREV-BUFFERS.
1825 WINDOW must be a live window and defaults to the selected one.
1827 PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
1828 where BUFFER is a buffer, WINDOW-START is the start position of the
1829 window for that buffer, and POS is a window-specific point value. */)
1830 (Lisp_Object window, Lisp_Object prev_buffers)
1832 wset_prev_buffers (decode_live_window (window), prev_buffers);
1833 return prev_buffers;
1836 DEFUN ("window-next-buffers", Fwindow_next_buffers, Swindow_next_buffers,
1837 0, 1, 0,
1838 doc: /* Return list of buffers recently re-shown in WINDOW.
1839 WINDOW must be a live window and defaults to the selected one. */)
1840 (Lisp_Object window)
1842 return decode_live_window (window)->next_buffers;
1845 DEFUN ("set-window-next-buffers", Fset_window_next_buffers,
1846 Sset_window_next_buffers, 2, 2, 0,
1847 doc: /* Set WINDOW's next buffers to NEXT-BUFFERS.
1848 WINDOW must be a live window and defaults to the selected one.
1849 NEXT-BUFFERS should be a list of buffers. */)
1850 (Lisp_Object window, Lisp_Object next_buffers)
1852 wset_next_buffers (decode_live_window (window), next_buffers);
1853 return next_buffers;
1856 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1857 0, 1, 0,
1858 doc: /* Return the parameters of WINDOW and their values.
1859 WINDOW must be a valid window and defaults to the selected one. The
1860 return value is a list of elements of the form (PARAMETER . VALUE). */)
1861 (Lisp_Object window)
1863 return Fcopy_alist (decode_valid_window (window)->window_parameters);
1866 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1867 2, 2, 0,
1868 doc: /* Return WINDOW's value for PARAMETER.
1869 WINDOW must be a valid window and defaults to the selected one. */)
1870 (Lisp_Object window, Lisp_Object parameter)
1872 Lisp_Object result;
1874 result = Fassq (parameter, decode_valid_window (window)->window_parameters);
1875 return CDR_SAFE (result);
1878 DEFUN ("set-window-parameter", Fset_window_parameter,
1879 Sset_window_parameter, 3, 3, 0,
1880 doc: /* Set WINDOW's value of PARAMETER to VALUE.
1881 WINDOW must be a valid window and defaults to the selected one.
1882 Return VALUE. */)
1883 (Lisp_Object window, Lisp_Object parameter, Lisp_Object value)
1885 register struct window *w = decode_valid_window (window);
1886 Lisp_Object old_alist_elt;
1888 old_alist_elt = Fassq (parameter, w->window_parameters);
1889 if (NILP (old_alist_elt))
1890 wset_window_parameters
1891 (w, Fcons (Fcons (parameter, value), w->window_parameters));
1892 else
1893 Fsetcdr (old_alist_elt, value);
1894 return value;
1897 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1898 0, 1, 0,
1899 doc: /* Return the display-table that WINDOW is using.
1900 WINDOW must be a live window and defaults to the selected one. */)
1901 (Lisp_Object window)
1903 return decode_live_window (window)->display_table;
1906 /* Get the display table for use on window W. This is either W's
1907 display table or W's buffer's display table. Ignore the specified
1908 tables if they are not valid; if no valid table is specified,
1909 return 0. */
1911 struct Lisp_Char_Table *
1912 window_display_table (struct window *w)
1914 struct Lisp_Char_Table *dp = NULL;
1916 if (DISP_TABLE_P (w->display_table))
1917 dp = XCHAR_TABLE (w->display_table);
1918 else if (BUFFERP (w->buffer))
1920 struct buffer *b = XBUFFER (w->buffer);
1922 if (DISP_TABLE_P (BVAR (b, display_table)))
1923 dp = XCHAR_TABLE (BVAR (b, display_table));
1924 else if (DISP_TABLE_P (Vstandard_display_table))
1925 dp = XCHAR_TABLE (Vstandard_display_table);
1928 return dp;
1931 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1932 doc: /* Set WINDOW's display-table to TABLE.
1933 WINDOW must be a live window and defaults to the selected one. */)
1934 (register Lisp_Object window, Lisp_Object table)
1936 wset_display_table (decode_live_window (window), table);
1937 return table;
1940 /* Record info on buffer window W is displaying
1941 when it is about to cease to display that buffer. */
1942 static void
1943 unshow_buffer (register struct window *w)
1945 Lisp_Object buf;
1946 struct buffer *b;
1948 buf = w->buffer;
1949 b = XBUFFER (buf);
1950 if (b != XMARKER (w->pointm)->buffer)
1951 abort ();
1953 #if 0
1954 if (w == XWINDOW (selected_window)
1955 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1956 /* Do this except when the selected window's buffer
1957 is being removed from some other window. */
1958 #endif
1959 /* last_window_start records the start position that this buffer
1960 had in the last window to be disconnected from it.
1961 Now that this statement is unconditional,
1962 it is possible for the buffer to be displayed in the
1963 selected window, while last_window_start reflects another
1964 window which was recently showing the same buffer.
1965 Some people might say that might be a good thing. Let's see. */
1966 b->last_window_start = marker_position (w->start);
1968 /* Point in the selected window's buffer
1969 is actually stored in that buffer, and the window's pointm isn't used.
1970 So don't clobber point in that buffer. */
1971 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1972 /* Don't clobber point in current buffer either (this could be
1973 useful in connection with bug#12208).
1974 && XBUFFER (buf) != current_buffer */
1975 /* This line helps to fix Horsley's testbug.el bug. */
1976 && !(WINDOWP (BVAR (b, last_selected_window))
1977 && w != XWINDOW (BVAR (b, last_selected_window))
1978 && EQ (buf, XWINDOW (BVAR (b, last_selected_window))->buffer)))
1979 temp_set_point_both (b,
1980 clip_to_bounds (BUF_BEGV (b),
1981 XMARKER (w->pointm)->charpos,
1982 BUF_ZV (b)),
1983 clip_to_bounds (BUF_BEGV_BYTE (b),
1984 marker_byte_position (w->pointm),
1985 BUF_ZV_BYTE (b)));
1987 if (WINDOWP (BVAR (b, last_selected_window))
1988 && w == XWINDOW (BVAR (b, last_selected_window)))
1989 bset_last_selected_window (b, Qnil);
1992 /* Put NEW into the window structure in place of OLD. SETFLAG zero
1993 means change window structure only. Otherwise store geometry and
1994 other settings as well. */
1995 static void
1996 replace_window (Lisp_Object old, Lisp_Object new, int setflag)
1998 register Lisp_Object tem;
1999 register struct window *o = XWINDOW (old), *n = XWINDOW (new);
2001 /* If OLD is its frame's root window, then NEW is the new
2002 root window for that frame. */
2003 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
2004 fset_root_window (XFRAME (o->frame), new);
2006 if (setflag)
2008 wset_left_col (n, o->left_col);
2009 wset_top_line (n, o->top_line);
2010 wset_total_cols (n, o->total_cols);
2011 wset_total_lines (n, o->total_lines);
2012 wset_normal_cols (n, o->normal_cols);
2013 wset_normal_cols (o, make_float (1.0));
2014 wset_normal_lines (n, o->normal_lines);
2015 wset_normal_lines (o, make_float (1.0));
2016 n->desired_matrix = n->current_matrix = 0;
2017 n->vscroll = 0;
2018 memset (&n->cursor, 0, sizeof (n->cursor));
2019 memset (&n->last_cursor, 0, sizeof (n->last_cursor));
2020 memset (&n->phys_cursor, 0, sizeof (n->phys_cursor));
2021 n->phys_cursor_type = -1;
2022 n->phys_cursor_width = -1;
2023 n->must_be_updated_p = 0;
2024 n->pseudo_window_p = 0;
2025 wset_window_end_vpos (n, make_number (0));
2026 wset_window_end_pos (n, make_number (0));
2027 wset_window_end_valid (n, Qnil);
2028 n->frozen_window_start_p = 0;
2031 tem = o->next;
2032 wset_next (n, tem);
2033 if (!NILP (tem))
2034 wset_prev (XWINDOW (tem), new);
2036 tem = o->prev;
2037 wset_prev (n, tem);
2038 if (!NILP (tem))
2039 wset_next (XWINDOW (tem), new);
2041 tem = o->parent;
2042 wset_parent (n, tem);
2043 if (!NILP (tem))
2045 if (EQ (XWINDOW (tem)->vchild, old))
2046 wset_vchild (XWINDOW (tem), new);
2047 if (EQ (XWINDOW (tem)->hchild, old))
2048 wset_hchild (XWINDOW (tem), new);
2052 /* If window WINDOW and its parent window are iso-combined, merge
2053 WINDOW's children into those of its parent window and mark WINDOW as
2054 deleted. */
2056 static void
2057 recombine_windows (Lisp_Object window)
2059 struct window *w, *p, *c;
2060 Lisp_Object parent, child;
2061 int horflag;
2063 w = XWINDOW (window);
2064 parent = w->parent;
2065 if (!NILP (parent) && NILP (w->combination_limit))
2067 p = XWINDOW (parent);
2068 if (((!NILP (p->vchild) && !NILP (w->vchild))
2069 || (!NILP (p->hchild) && !NILP (w->hchild))))
2070 /* WINDOW and PARENT are both either a vertical or a horizontal
2071 combination. */
2073 horflag = NILP (w->vchild);
2074 child = horflag ? w->hchild : w->vchild;
2075 c = XWINDOW (child);
2077 /* Splice WINDOW's children into its parent's children and
2078 assign new normal sizes. */
2079 if (NILP (w->prev))
2080 if (horflag)
2081 wset_hchild (p, child);
2082 else
2083 wset_vchild (p, child);
2084 else
2086 wset_prev (c, w->prev);
2087 wset_next (XWINDOW (w->prev), child);
2090 while (c)
2092 wset_parent (c, parent);
2094 if (horflag)
2095 wset_normal_cols (c,
2096 make_float (XFLOATINT (c->total_cols)
2097 / XFLOATINT (p->total_cols)));
2098 else
2099 wset_normal_lines (c,
2100 make_float (XFLOATINT (c->total_lines)
2101 / XFLOATINT (p->total_lines)));
2103 if (NILP (c->next))
2105 if (!NILP (w->next))
2107 wset_next (c, w->next);
2108 wset_prev (XWINDOW (c->next), child);
2111 c = 0;
2113 else
2115 child = c->next;
2116 c = XWINDOW (child);
2120 /* WINDOW can be deleted now. */
2121 wset_vchild (w, Qnil);
2122 wset_hchild (w, Qnil);
2127 /* If WINDOW can be deleted, delete it. */
2128 static void
2129 delete_deletable_window (Lisp_Object window)
2131 if (!NILP (call1 (Qwindow_deletable_p, window)))
2132 call1 (Qdelete_window, window);
2135 /***********************************************************************
2136 Window List
2137 ***********************************************************************/
2139 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
2140 pointer. This is a callback function for foreach_window, used in
2141 the window_list function. */
2143 static int
2144 add_window_to_list (struct window *w, void *user_data)
2146 Lisp_Object *list = (Lisp_Object *) user_data;
2147 Lisp_Object window;
2148 XSETWINDOW (window, w);
2149 *list = Fcons (window, *list);
2150 return 1;
2154 /* Return a list of all windows, for use by next_window. If
2155 Vwindow_list is a list, return that list. Otherwise, build a new
2156 list, cache it in Vwindow_list, and return that. */
2158 static Lisp_Object
2159 window_list (void)
2161 if (!CONSP (Vwindow_list))
2163 Lisp_Object tail;
2165 Vwindow_list = Qnil;
2166 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
2168 Lisp_Object args[2];
2170 /* We are visiting windows in canonical order, and add
2171 new windows at the front of args[1], which means we
2172 have to reverse this list at the end. */
2173 args[1] = Qnil;
2174 foreach_window (XFRAME (XCAR (tail)), add_window_to_list, &args[1]);
2175 args[0] = Vwindow_list;
2176 args[1] = Fnreverse (args[1]);
2177 Vwindow_list = Fnconc (2, args);
2181 return Vwindow_list;
2185 /* Value is non-zero if WINDOW satisfies the constraints given by
2186 OWINDOW, MINIBUF and ALL_FRAMES.
2188 MINIBUF t means WINDOW may be minibuffer windows.
2189 `lambda' means WINDOW may not be a minibuffer window.
2190 a window means a specific minibuffer window
2192 ALL_FRAMES t means search all frames,
2193 nil means search just current frame,
2194 `visible' means search just visible frames on the
2195 current terminal,
2196 0 means search visible and iconified frames on the
2197 current terminal,
2198 a window means search the frame that window belongs to,
2199 a frame means consider windows on that frame, only. */
2201 static int
2202 candidate_window_p (Lisp_Object window, Lisp_Object owindow, Lisp_Object minibuf, Lisp_Object all_frames)
2204 struct window *w = XWINDOW (window);
2205 struct frame *f = XFRAME (w->frame);
2206 int candidate_p = 1;
2208 if (!BUFFERP (w->buffer))
2209 candidate_p = 0;
2210 else if (MINI_WINDOW_P (w)
2211 && (EQ (minibuf, Qlambda)
2212 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
2214 /* If MINIBUF is `lambda' don't consider any mini-windows.
2215 If it is a window, consider only that one. */
2216 candidate_p = 0;
2218 else if (EQ (all_frames, Qt))
2219 candidate_p = 1;
2220 else if (NILP (all_frames))
2222 eassert (WINDOWP (owindow));
2223 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
2225 else if (EQ (all_frames, Qvisible))
2227 FRAME_SAMPLE_VISIBILITY (f);
2228 candidate_p = FRAME_VISIBLE_P (f)
2229 && (FRAME_TERMINAL (XFRAME (w->frame))
2230 == FRAME_TERMINAL (XFRAME (selected_frame)));
2233 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
2235 FRAME_SAMPLE_VISIBILITY (f);
2236 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
2237 #ifdef HAVE_X_WINDOWS
2238 /* Yuck!! If we've just created the frame and the
2239 window-manager requested the user to place it
2240 manually, the window may still not be considered
2241 `visible'. I'd argue it should be at least
2242 something like `iconified', but don't know how to do
2243 that yet. --Stef */
2244 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
2245 && !f->output_data.x->has_been_visible)
2246 #endif
2248 && (FRAME_TERMINAL (XFRAME (w->frame))
2249 == FRAME_TERMINAL (XFRAME (selected_frame)));
2251 else if (WINDOWP (all_frames))
2252 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
2253 || EQ (XWINDOW (all_frames)->frame, w->frame)
2254 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
2255 else if (FRAMEP (all_frames))
2256 candidate_p = EQ (all_frames, w->frame);
2258 return candidate_p;
2262 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
2263 Fwindow_list. See candidate_window_p for the meaning of WINDOW,
2264 MINIBUF, and ALL_FRAMES. */
2266 static void
2267 decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object *all_frames)
2269 if (NILP (*window))
2270 *window = selected_window;
2271 else
2272 CHECK_LIVE_WINDOW (*window);
2274 /* MINIBUF nil may or may not include minibuffers. Decide if it
2275 does. */
2276 if (NILP (*minibuf))
2277 *minibuf = minibuf_level ? minibuf_window : Qlambda;
2278 else if (!EQ (*minibuf, Qt))
2279 *minibuf = Qlambda;
2281 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
2282 => count none of them, or a specific minibuffer window (the
2283 active one) to count. */
2285 /* ALL_FRAMES nil doesn't specify which frames to include. */
2286 if (NILP (*all_frames))
2287 *all_frames
2288 = (!EQ (*minibuf, Qlambda)
2289 ? FRAME_MINIBUF_WINDOW (XFRAME (XWINDOW (*window)->frame))
2290 : Qnil);
2291 else if (EQ (*all_frames, Qvisible))
2293 else if (EQ (*all_frames, make_number (0)))
2295 else if (FRAMEP (*all_frames))
2297 else if (!EQ (*all_frames, Qt))
2298 *all_frames = Qnil;
2302 /* Return the next or previous window of WINDOW in cyclic ordering
2303 of windows. NEXT_P non-zero means return the next window. See the
2304 documentation string of next-window for the meaning of MINIBUF and
2305 ALL_FRAMES. */
2307 static Lisp_Object
2308 next_window (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames, int next_p)
2310 decode_next_window_args (&window, &minibuf, &all_frames);
2312 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
2313 return the first window on the frame. */
2314 if (FRAMEP (all_frames)
2315 && !EQ (all_frames, XWINDOW (window)->frame))
2316 return Fframe_first_window (all_frames);
2318 if (next_p)
2320 Lisp_Object list;
2322 /* Find WINDOW in the list of all windows. */
2323 list = Fmemq (window, window_list ());
2325 /* Scan forward from WINDOW to the end of the window list. */
2326 if (CONSP (list))
2327 for (list = XCDR (list); CONSP (list); list = XCDR (list))
2328 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2329 break;
2331 /* Scan from the start of the window list up to WINDOW. */
2332 if (!CONSP (list))
2333 for (list = Vwindow_list;
2334 CONSP (list) && !EQ (XCAR (list), window);
2335 list = XCDR (list))
2336 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2337 break;
2339 if (CONSP (list))
2340 window = XCAR (list);
2342 else
2344 Lisp_Object candidate, list;
2346 /* Scan through the list of windows for candidates. If there are
2347 candidate windows in front of WINDOW, the last one of these
2348 is the one we want. If there are candidates following WINDOW
2349 in the list, again the last one of these is the one we want. */
2350 candidate = Qnil;
2351 for (list = window_list (); CONSP (list); list = XCDR (list))
2353 if (EQ (XCAR (list), window))
2355 if (WINDOWP (candidate))
2356 break;
2358 else if (candidate_window_p (XCAR (list), window, minibuf,
2359 all_frames))
2360 candidate = XCAR (list);
2363 if (WINDOWP (candidate))
2364 window = candidate;
2367 return window;
2371 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
2372 doc: /* Return live window after WINDOW in the cyclic ordering of windows.
2373 WINDOW must be a live window and defaults to the selected one. The
2374 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2375 consider.
2377 MINIBUF nil or omitted means consider the minibuffer window only if the
2378 minibuffer is active. MINIBUF t means consider the minibuffer window
2379 even if the minibuffer is not active. Any other value means do not
2380 consider the minibuffer window even if the minibuffer is active.
2382 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2383 plus the minibuffer window if specified by the MINIBUF argument. If the
2384 minibuffer counts, consider all windows on all frames that share that
2385 minibuffer too. The following non-nil values of ALL-FRAMES have special
2386 meanings:
2388 - t means consider all windows on all existing frames.
2390 - `visible' means consider all windows on all visible frames.
2392 - 0 (the number zero) means consider all windows on all visible and
2393 iconified frames.
2395 - A frame means consider all windows on that frame only.
2397 Anything else means consider all windows on WINDOW's frame and no
2398 others.
2400 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2401 `next-window' to iterate through the entire cycle of acceptable
2402 windows, eventually ending up back at the window you started with.
2403 `previous-window' traverses the same cycle, in the reverse order. */)
2404 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2406 return next_window (window, minibuf, all_frames, 1);
2410 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
2411 doc: /* Return live window before WINDOW in the cyclic ordering of windows.
2412 WINDOW must be a live window and defaults to the selected one. The
2413 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2414 consider.
2416 MINIBUF nil or omitted means consider the minibuffer window only if the
2417 minibuffer is active. MINIBUF t means consider the minibuffer window
2418 even if the minibuffer is not active. Any other value means do not
2419 consider the minibuffer window even if the minibuffer is active.
2421 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2422 plus the minibuffer window if specified by the MINIBUF argument. If the
2423 minibuffer counts, consider all windows on all frames that share that
2424 minibuffer too. The following non-nil values of ALL-FRAMES have special
2425 meanings:
2427 - t means consider all windows on all existing frames.
2429 - `visible' means consider all windows on all visible frames.
2431 - 0 (the number zero) means consider all windows on all visible and
2432 iconified frames.
2434 - A frame means consider all windows on that frame only.
2436 Anything else means consider all windows on WINDOW's frame and no
2437 others.
2439 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2440 use `previous-window' to iterate through the entire cycle of
2441 acceptable windows, eventually ending up back at the window you
2442 started with. `next-window' traverses the same cycle, in the
2443 reverse order. */)
2444 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2446 return next_window (window, minibuf, all_frames, 0);
2450 /* Return a list of windows in cyclic ordering. Arguments are like
2451 for `next-window'. */
2453 static Lisp_Object
2454 window_list_1 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2456 Lisp_Object tail, list, rest;
2458 decode_next_window_args (&window, &minibuf, &all_frames);
2459 list = Qnil;
2461 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2462 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2463 list = Fcons (XCAR (tail), list);
2465 /* Rotate the list to start with WINDOW. */
2466 list = Fnreverse (list);
2467 rest = Fmemq (window, list);
2468 if (!NILP (rest) && !EQ (rest, list))
2470 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2472 XSETCDR (tail, Qnil);
2473 list = nconc2 (rest, list);
2475 return list;
2479 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2480 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2481 FRAME nil or omitted means use the selected frame.
2482 WINDOW nil or omitted means use the window selected within FRAME.
2483 MINIBUF t means include the minibuffer window, even if it isn't active.
2484 MINIBUF nil or omitted means include the minibuffer window only
2485 if it's active.
2486 MINIBUF neither nil nor t means never include the minibuffer window. */)
2487 (Lisp_Object frame, Lisp_Object minibuf, Lisp_Object window)
2489 if (NILP (window))
2490 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2491 CHECK_WINDOW (window);
2492 if (NILP (frame))
2493 frame = selected_frame;
2495 if (!EQ (frame, XWINDOW (window)->frame))
2496 error ("Window is on a different frame");
2498 return window_list_1 (window, minibuf, frame);
2502 DEFUN ("window-list-1", Fwindow_list_1, Swindow_list_1, 0, 3, 0,
2503 doc: /* Return a list of all live windows.
2504 WINDOW specifies the first window to list and defaults to the selected
2505 window.
2507 Optional argument MINIBUF nil or omitted means consider the minibuffer
2508 window only if the minibuffer is active. MINIBUF t means consider the
2509 minibuffer window even if the minibuffer is not active. Any other value
2510 means do not consider the minibuffer window even if the minibuffer is
2511 active.
2513 Optional argument ALL-FRAMES nil or omitted means consider all windows
2514 on WINDOW's frame, plus the minibuffer window if specified by the
2515 MINIBUF argument. If the minibuffer counts, consider all windows on all
2516 frames that share that minibuffer too. The following non-nil values of
2517 ALL-FRAMES have special meanings:
2519 - t means consider all windows on all existing frames.
2521 - `visible' means consider all windows on all visible frames.
2523 - 0 (the number zero) means consider all windows on all visible and
2524 iconified frames.
2526 - A frame means consider all windows on that frame only.
2528 Anything else means consider all windows on WINDOW's frame and no
2529 others.
2531 If WINDOW is not on the list of windows returned, some other window will
2532 be listed first but no error is signaled. */)
2533 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2535 return window_list_1 (window, minibuf, all_frames);
2538 /* Look at all windows, performing an operation specified by TYPE
2539 with argument OBJ.
2540 If FRAMES is Qt, look at all frames;
2541 Qnil, look at just the selected frame;
2542 Qvisible, look at visible frames;
2543 a frame, just look at windows on that frame.
2544 If MINI is non-zero, perform the operation on minibuffer windows too. */
2546 enum window_loop
2548 WINDOW_LOOP_UNUSED,
2549 GET_BUFFER_WINDOW, /* Arg is buffer */
2550 REPLACE_BUFFER_IN_WINDOWS_SAFELY, /* Arg is buffer */
2551 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2552 CHECK_ALL_WINDOWS
2555 static Lisp_Object
2556 window_loop (enum window_loop type, Lisp_Object obj, int mini, Lisp_Object frames)
2558 Lisp_Object window, windows, best_window, frame_arg;
2559 int frame_best_window_flag = 0;
2560 struct frame *f;
2561 struct gcpro gcpro1;
2563 /* If we're only looping through windows on a particular frame,
2564 frame points to that frame. If we're looping through windows
2565 on all frames, frame is 0. */
2566 if (FRAMEP (frames))
2567 f = XFRAME (frames);
2568 else if (NILP (frames))
2569 f = SELECTED_FRAME ();
2570 else
2571 f = NULL;
2573 if (f)
2574 frame_arg = Qlambda;
2575 else if (EQ (frames, make_number (0)))
2576 frame_arg = frames;
2577 else if (EQ (frames, Qvisible))
2578 frame_arg = frames;
2579 else
2580 frame_arg = Qt;
2582 /* frame_arg is Qlambda to stick to one frame,
2583 Qvisible to consider all visible frames,
2584 or Qt otherwise. */
2586 /* Pick a window to start with. */
2587 if (WINDOWP (obj))
2588 window = obj;
2589 else if (f)
2590 window = FRAME_SELECTED_WINDOW (f);
2591 else
2592 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2594 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2595 GCPRO1 (windows);
2596 best_window = Qnil;
2598 for (; CONSP (windows); windows = XCDR (windows))
2600 struct window *w;
2602 window = XCAR (windows);
2603 w = XWINDOW (window);
2605 /* Note that we do not pay attention here to whether the frame
2606 is visible, since Fwindow_list skips non-visible frames if
2607 that is desired, under the control of frame_arg. */
2608 if (!MINI_WINDOW_P (w)
2609 /* For REPLACE_BUFFER_IN_WINDOWS_SAFELY, we must always
2610 consider all windows. */
2611 || type == REPLACE_BUFFER_IN_WINDOWS_SAFELY
2612 || (mini && minibuf_level > 0))
2613 switch (type)
2615 case GET_BUFFER_WINDOW:
2616 if (EQ (w->buffer, obj)
2617 /* Don't find any minibuffer window except the one that
2618 is currently in use. */
2619 && (MINI_WINDOW_P (w) ? EQ (window, minibuf_window) : 1))
2621 if (EQ (window, selected_window))
2622 /* Preferably return the selected window. */
2623 RETURN_UNGCPRO (window);
2624 else if (EQ (XWINDOW (window)->frame, selected_frame)
2625 && !frame_best_window_flag)
2626 /* Prefer windows on the current frame (but don't
2627 choose another one if we have one already). */
2629 best_window = window;
2630 frame_best_window_flag = 1;
2632 else if (NILP (best_window))
2633 best_window = window;
2635 break;
2637 case REPLACE_BUFFER_IN_WINDOWS_SAFELY:
2638 /* We could simply check whether the buffer shown by window
2639 is live, and show another buffer in case it isn't. */
2640 if (EQ (w->buffer, obj))
2642 /* Undedicate WINDOW. */
2643 wset_dedicated (w, Qnil);
2644 /* Make WINDOW show the buffer returned by
2645 other_buffer_safely, don't run any hooks. */
2646 set_window_buffer
2647 (window, other_buffer_safely (w->buffer), 0, 0);
2648 /* If WINDOW is the selected window, make its buffer
2649 current. But do so only if the window shows the
2650 current buffer (Bug#6454). */
2651 if (EQ (window, selected_window)
2652 && XBUFFER (w->buffer) == current_buffer)
2653 Fset_buffer (w->buffer);
2655 break;
2657 case REDISPLAY_BUFFER_WINDOWS:
2658 if (EQ (w->buffer, obj))
2660 mark_window_display_accurate (window, 0);
2661 w->update_mode_line = 1;
2662 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2663 ++update_mode_lines;
2664 best_window = window;
2666 break;
2668 /* Check for a window that has a killed buffer. */
2669 case CHECK_ALL_WINDOWS:
2670 if (! NILP (w->buffer)
2671 && NILP (BVAR (XBUFFER (w->buffer), name)))
2672 abort ();
2673 break;
2675 case WINDOW_LOOP_UNUSED:
2676 break;
2680 UNGCPRO;
2681 return best_window;
2684 /* Used for debugging. Abort if any window has a dead buffer. */
2686 extern void check_all_windows (void) EXTERNALLY_VISIBLE;
2687 void
2688 check_all_windows (void)
2690 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2693 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 0, 2, 0,
2694 doc: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2695 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
2696 the current buffer.
2698 The optional argument ALL-FRAMES specifies the frames to consider:
2700 - t means consider all windows on all existing frames.
2702 - `visible' means consider all windows on all visible frames.
2704 - 0 (the number zero) means consider all windows on all visible
2705 and iconified frames.
2707 - A frame means consider all windows on that frame only.
2709 Any other value of ALL-FRAMES means consider all windows on the
2710 selected frame and no others. */)
2711 (Lisp_Object buffer_or_name, Lisp_Object all_frames)
2713 Lisp_Object buffer;
2715 if (NILP (buffer_or_name))
2716 buffer = Fcurrent_buffer ();
2717 else
2718 buffer = Fget_buffer (buffer_or_name);
2720 if (BUFFERP (buffer))
2721 return window_loop (GET_BUFFER_WINDOW, buffer, 1, all_frames);
2722 else
2723 return Qnil;
2726 static Lisp_Object
2727 resize_root_window (Lisp_Object window, Lisp_Object delta, Lisp_Object horizontal, Lisp_Object ignore)
2729 return call4 (Qwindow_resize_root_window, window, delta, horizontal, ignore);
2733 DEFUN ("delete-other-windows-internal", Fdelete_other_windows_internal,
2734 Sdelete_other_windows_internal, 0, 2, "",
2735 doc: /* Make WINDOW fill its frame.
2736 Only the frame WINDOW is on is affected. WINDOW must be a valid window
2737 and defaults to the selected one.
2739 Optional argument ROOT, if non-nil, must specify an internal window such
2740 that WINDOW is in its window subtree. If this is the case, replace ROOT
2741 by WINDOW and leave alone any windows not part of ROOT's subtree.
2743 When WINDOW is live try to reduce display jumps by keeping the text
2744 previously visible in WINDOW in the same place on the frame. Doing this
2745 depends on the value of (window-start WINDOW), so if calling this
2746 function in a program gives strange scrolling, make sure the
2747 window-start value is reasonable when this function is called. */)
2748 (Lisp_Object window, Lisp_Object root)
2750 struct window *w, *r, *s;
2751 struct frame *f;
2752 Lisp_Object sibling, pwindow, swindow IF_LINT (= Qnil), delta;
2753 ptrdiff_t startpos IF_LINT (= 0);
2754 int top IF_LINT (= 0), new_top, resize_failed;
2756 w = decode_valid_window (window);
2757 XSETWINDOW (window, w);
2758 f = XFRAME (w->frame);
2760 if (NILP (root))
2761 /* ROOT is the frame's root window. */
2763 root = FRAME_ROOT_WINDOW (f);
2764 r = XWINDOW (root);
2766 else
2767 /* ROOT must be an ancestor of WINDOW. */
2769 r = decode_valid_window (root);
2770 pwindow = XWINDOW (window)->parent;
2771 while (!NILP (pwindow))
2772 if (EQ (pwindow, root))
2773 break;
2774 else
2775 pwindow = XWINDOW (pwindow)->parent;
2776 if (!EQ (pwindow, root))
2777 error ("Specified root is not an ancestor of specified window");
2780 if (EQ (window, root))
2781 /* A noop. */
2782 return Qnil;
2783 /* I don't understand the "top > 0" part below. If we deal with a
2784 standalone minibuffer it would have been caught by the preceding
2785 test. */
2786 else if (MINI_WINDOW_P (w)) /* && top > 0) */
2787 error ("Can't expand minibuffer to full frame");
2789 if (!NILP (w->buffer))
2791 startpos = marker_position (w->start);
2792 top = WINDOW_TOP_EDGE_LINE (w)
2793 - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2794 /* Make sure WINDOW is the frame's selected window. */
2795 if (!EQ (window, FRAME_SELECTED_WINDOW (f)))
2797 if (EQ (selected_frame, w->frame))
2798 Fselect_window (window, Qnil);
2799 else
2800 fset_selected_window (f, window);
2803 else
2805 /* See if the frame's selected window is a part of the window
2806 subtree rooted at WINDOW, by finding all the selected window's
2807 parents and comparing each one with WINDOW. If it isn't we
2808 need a new selected window for this frame. */
2809 swindow = FRAME_SELECTED_WINDOW (f);
2810 while (1)
2812 pwindow = swindow;
2813 while (!NILP (pwindow) && !EQ (window, pwindow))
2814 pwindow = XWINDOW (pwindow)->parent;
2816 if (EQ (window, pwindow))
2817 /* If WINDOW is an ancestor of SWINDOW, then SWINDOW is ok
2818 as the new selected window. */
2819 break;
2820 else
2821 /* Else try the previous window of SWINDOW. */
2822 swindow = Fprevious_window (swindow, Qlambda, Qnil);
2825 if (!EQ (swindow, FRAME_SELECTED_WINDOW (f)))
2827 if (EQ (selected_frame, w->frame))
2828 Fselect_window (swindow, Qnil);
2829 else
2830 fset_selected_window (f, swindow);
2834 BLOCK_INPUT;
2835 if (!FRAME_INITIAL_P (f))
2837 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
2839 /* We are going to free the glyph matrices of WINDOW, and with
2840 that we might lose any information about glyph rows that have
2841 some of their glyphs highlighted in mouse face. (These rows
2842 are marked with a non-zero mouse_face_p flag.) If WINDOW
2843 indeed has some glyphs highlighted in mouse face, signal to
2844 frame's up-to-date hook that mouse highlight was overwritten,
2845 so that it will arrange for redisplaying the highlight. */
2846 if (EQ (hlinfo->mouse_face_window, window))
2848 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
2849 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
2850 hlinfo->mouse_face_window = Qnil;
2853 free_window_matrices (r);
2855 windows_or_buffers_changed++;
2856 Vwindow_list = Qnil;
2857 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
2858 resize_failed = 0;
2860 if (NILP (w->buffer))
2862 /* Resize child windows vertically. */
2863 XSETINT (delta, XINT (r->total_lines)
2864 - XINT (w->total_lines));
2865 wset_top_line (w, r->top_line);
2866 resize_root_window (window, delta, Qnil, Qnil);
2867 if (window_resize_check (w, 0))
2868 window_resize_apply (w, 0);
2869 else
2871 resize_root_window (window, delta, Qnil, Qt);
2872 if (window_resize_check (w, 0))
2873 window_resize_apply (w, 0);
2874 else
2875 resize_failed = 1;
2878 /* Resize child windows horizontally. */
2879 if (!resize_failed)
2881 wset_left_col (w, r->left_col);
2882 XSETINT (delta,
2883 XINT (r->total_cols) - XINT (w->total_cols));
2884 wset_left_col (w, r->left_col);
2885 resize_root_window (window, delta, Qt, Qnil);
2886 if (window_resize_check (w, 1))
2887 window_resize_apply (w, 1);
2888 else
2890 resize_root_window (window, delta, Qt, Qt);
2891 if (window_resize_check (w, 1))
2892 window_resize_apply (w, 1);
2893 else
2894 resize_failed = 1;
2898 if (resize_failed)
2899 /* Play safe, if we still can ... */
2901 window = swindow;
2902 w = XWINDOW (window);
2906 /* Cleanly unlink WINDOW from window-tree. */
2907 if (!NILP (w->prev))
2908 /* Get SIBLING above (on the left of) WINDOW. */
2910 sibling = w->prev;
2911 s = XWINDOW (sibling);
2912 wset_next (s, w->next);
2913 if (!NILP (s->next))
2914 wset_prev (XWINDOW (s->next), sibling);
2916 else
2917 /* Get SIBLING below (on the right of) WINDOW. */
2919 sibling = w->next;
2920 s = XWINDOW (sibling);
2921 wset_prev (s, Qnil);
2922 if (!NILP (XWINDOW (w->parent)->vchild))
2923 wset_vchild (XWINDOW (w->parent), sibling);
2924 else
2925 wset_hchild (XWINDOW (w->parent), sibling);
2928 /* Delete ROOT and all child windows of ROOT. */
2929 if (!NILP (r->vchild))
2931 delete_all_child_windows (r->vchild);
2932 wset_vchild (r, Qnil);
2934 else if (!NILP (r->hchild))
2936 delete_all_child_windows (r->hchild);
2937 wset_hchild (r, Qnil);
2940 replace_window (root, window, 1);
2942 /* This must become SWINDOW anyway ....... */
2943 if (!NILP (w->buffer) && !resize_failed)
2945 /* Try to minimize scrolling, by setting the window start to the
2946 point will cause the text at the old window start to be at the
2947 same place on the frame. But don't try to do this if the
2948 window start is outside the visible portion (as might happen
2949 when the display is not current, due to typeahead). */
2950 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2951 if (new_top != top
2952 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2953 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2955 struct position pos;
2956 struct buffer *obuf = current_buffer;
2958 Fset_buffer (w->buffer);
2959 /* This computation used to temporarily move point, but that
2960 can have unwanted side effects due to text properties. */
2961 pos = *vmotion (startpos, -top, w);
2963 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2964 wset_window_end_valid (w, Qnil);
2965 w->start_at_line_beg = (pos.bytepos == BEGV_BYTE
2966 || FETCH_BYTE (pos.bytepos - 1) == '\n');
2967 /* We need to do this, so that the window-scroll-functions
2968 get called. */
2969 w->optional_new_start = 1;
2971 set_buffer_internal (obuf);
2975 adjust_glyphs (f);
2976 UNBLOCK_INPUT;
2978 run_window_configuration_change_hook (f);
2980 return Qnil;
2984 void
2985 replace_buffer_in_windows (Lisp_Object buffer)
2987 call1 (Qreplace_buffer_in_windows, buffer);
2991 /* Safely replace BUFFER with some other buffer in all windows of all
2992 frames, even those on other keyboards. */
2994 void
2995 replace_buffer_in_windows_safely (Lisp_Object buffer)
2997 Lisp_Object tail, frame;
2999 /* A single call to window_loop won't do the job because it only
3000 considers frames on the current keyboard. So loop manually over
3001 frames, and handle each one. */
3002 FOR_EACH_FRAME (tail, frame)
3003 window_loop (REPLACE_BUFFER_IN_WINDOWS_SAFELY, buffer, 1, frame);
3006 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
3007 minimum allowable size. */
3009 void
3010 check_frame_size (FRAME_PTR frame, int *rows, int *cols)
3012 /* For height, we have to see:
3013 how many windows the frame has at minimum (one or two),
3014 and whether it has a menu bar or other special stuff at the top. */
3015 int min_height
3016 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
3017 ? MIN_SAFE_WINDOW_HEIGHT
3018 : 2 * MIN_SAFE_WINDOW_HEIGHT);
3020 if (FRAME_TOP_MARGIN (frame) > 0)
3021 min_height += FRAME_TOP_MARGIN (frame);
3023 if (*rows < min_height)
3024 *rows = min_height;
3025 if (*cols < MIN_SAFE_WINDOW_WIDTH)
3026 *cols = MIN_SAFE_WINDOW_WIDTH;
3029 /* Adjust the margins of window W if text area is too small.
3030 Return 1 if window width is ok after adjustment; 0 if window
3031 is still too narrow. */
3033 static int
3034 adjust_window_margins (struct window *w)
3036 int box_cols = (WINDOW_TOTAL_COLS (w)
3037 - WINDOW_FRINGE_COLS (w)
3038 - WINDOW_SCROLL_BAR_COLS (w));
3039 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
3040 + WINDOW_RIGHT_MARGIN_COLS (w));
3042 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
3043 return 1;
3045 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
3046 return 0;
3048 /* Window's text area is too narrow, but reducing the window
3049 margins will fix that. */
3050 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
3051 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
3053 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
3055 wset_left_margin_cols (w, make_number (margin_cols / 2));
3056 wset_right_margin_cols (w, make_number (margin_cols / 2));
3058 else
3059 wset_right_margin_cols (w, make_number (margin_cols));
3061 else
3062 wset_left_margin_cols (w, make_number (margin_cols));
3063 return 1;
3066 /* The following three routines are needed for running a window's
3067 configuration change hook. */
3068 static void
3069 run_funs (Lisp_Object funs)
3071 for (; CONSP (funs); funs = XCDR (funs))
3072 if (!EQ (XCAR (funs), Qt))
3073 call0 (XCAR (funs));
3076 static Lisp_Object
3077 select_window_norecord (Lisp_Object window)
3079 return WINDOW_LIVE_P (window)
3080 ? Fselect_window (window, Qt) : selected_window;
3083 static Lisp_Object
3084 select_frame_norecord (Lisp_Object frame)
3086 return FRAME_LIVE_P (XFRAME (frame))
3087 ? Fselect_frame (frame, Qt) : selected_frame;
3090 void
3091 run_window_configuration_change_hook (struct frame *f)
3093 ptrdiff_t count = SPECPDL_INDEX ();
3094 Lisp_Object frame, global_wcch
3095 = Fdefault_value (Qwindow_configuration_change_hook);
3096 XSETFRAME (frame, f);
3098 if (NILP (Vrun_hooks) || !NILP (inhibit_lisp_code))
3099 return;
3101 /* Use the right buffer. Matters when running the local hooks. */
3102 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3104 record_unwind_current_buffer ();
3105 Fset_buffer (Fwindow_buffer (Qnil));
3108 if (SELECTED_FRAME () != f)
3110 record_unwind_protect (select_frame_norecord, Fselected_frame ());
3111 select_frame_norecord (frame);
3114 /* Look for buffer-local values. */
3116 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3117 for (; CONSP (windows); windows = XCDR (windows))
3119 Lisp_Object window = XCAR (windows);
3120 Lisp_Object buffer = Fwindow_buffer (window);
3121 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3122 buffer)))
3124 ptrdiff_t inner_count = SPECPDL_INDEX ();
3125 record_unwind_protect (select_window_norecord, Fselected_window ());
3126 select_window_norecord (window);
3127 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3128 buffer));
3129 unbind_to (inner_count, Qnil);
3134 run_funs (global_wcch);
3135 unbind_to (count, Qnil);
3138 DEFUN ("run-window-configuration-change-hook", Frun_window_configuration_change_hook,
3139 Srun_window_configuration_change_hook, 1, 1, 0,
3140 doc: /* Run `window-configuration-change-hook' for FRAME. */)
3141 (Lisp_Object frame)
3143 CHECK_LIVE_FRAME (frame);
3144 run_window_configuration_change_hook (XFRAME (frame));
3145 return Qnil;
3148 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
3149 means it's allowed to run hooks. See make_frame for a case where
3150 it's not allowed. KEEP_MARGINS_P non-zero means that the current
3151 margins, fringes, and scroll-bar settings of the window are not
3152 reset from the buffer's local settings. */
3154 void
3155 set_window_buffer (Lisp_Object window, Lisp_Object buffer, int run_hooks_p, int keep_margins_p)
3157 struct window *w = XWINDOW (window);
3158 struct buffer *b = XBUFFER (buffer);
3159 ptrdiff_t count = SPECPDL_INDEX ();
3160 int samebuf = EQ (buffer, w->buffer);
3162 wset_buffer (w, buffer);
3164 if (EQ (window, selected_window))
3165 bset_last_selected_window (b, window);
3167 /* Let redisplay errors through. */
3168 b->display_error_modiff = 0;
3170 /* Update time stamps of buffer display. */
3171 if (INTEGERP (BVAR (b, display_count)))
3172 bset_display_count (b, make_number (XINT (BVAR (b, display_count)) + 1));
3173 bset_display_time (b, Fcurrent_time ());
3175 wset_window_end_pos (w, make_number (0));
3176 wset_window_end_vpos (w, make_number (0));
3177 memset (&w->last_cursor, 0, sizeof w->last_cursor);
3178 wset_window_end_valid (w, Qnil);
3179 if (!(keep_margins_p && samebuf))
3180 { /* If we're not actually changing the buffer, don't reset hscroll and
3181 vscroll. This case happens for example when called from
3182 change_frame_size_1, where we use a dummy call to
3183 Fset_window_buffer on the frame's selected window (and no other)
3184 just in order to run window-configuration-change-hook.
3185 Resetting hscroll and vscroll here is problematic for things like
3186 image-mode and doc-view-mode since it resets the image's position
3187 whenever we resize the frame. */
3188 w->hscroll = w->min_hscroll = 0;
3189 w->vscroll = 0;
3190 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3191 set_marker_restricted (w->start,
3192 make_number (b->last_window_start),
3193 buffer);
3194 w->start_at_line_beg = 0;
3195 w->force_start = 0;
3196 w->last_modified = 0;
3197 w->last_overlay_modified = 0;
3199 /* Maybe we could move this into the `if' but it's not obviously safe and
3200 I doubt it's worth the trouble. */
3201 windows_or_buffers_changed++;
3203 /* We must select BUFFER for running the window-scroll-functions. */
3204 /* We can't check ! NILP (Vwindow_scroll_functions) here
3205 because that might itself be a local variable. */
3206 if (window_initialized)
3208 record_unwind_current_buffer ();
3209 Fset_buffer (buffer);
3212 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3214 if (!keep_margins_p)
3216 /* Set left and right marginal area width etc. from buffer. */
3218 /* This may call adjust_window_margins three times, so
3219 temporarily disable window margins. */
3220 Lisp_Object save_left = w->left_margin_cols;
3221 Lisp_Object save_right = w->right_margin_cols;
3223 wset_left_margin_cols (w, Qnil);
3224 wset_right_margin_cols (w, Qnil);
3226 Fset_window_fringes (window,
3227 BVAR (b, left_fringe_width), BVAR (b, right_fringe_width),
3228 BVAR (b, fringes_outside_margins));
3230 Fset_window_scroll_bars (window,
3231 BVAR (b, scroll_bar_width),
3232 BVAR (b, vertical_scroll_bar_type), Qnil);
3234 wset_left_margin_cols (w, save_left);
3235 wset_right_margin_cols (w, save_right);
3237 Fset_window_margins (window,
3238 BVAR (b, left_margin_cols), BVAR (b, right_margin_cols));
3241 if (run_hooks_p)
3243 if (! NILP (Vwindow_scroll_functions))
3244 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3245 Fmarker_position (w->start));
3246 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3249 unbind_to (count, Qnil);
3252 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3253 doc: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3254 WINDOW must be a live window and defaults to the selected one.
3255 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3257 Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
3258 display margins, fringe widths, and scroll bar settings are preserved;
3259 the default is to reset these from the local settings for BUFFER-OR-NAME
3260 or the frame defaults. Return nil.
3262 This function throws an error when WINDOW is strongly dedicated to its
3263 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3264 already display BUFFER-OR-NAME.
3266 This function runs `window-scroll-functions' before running
3267 `window-configuration-change-hook'. */)
3268 (register Lisp_Object window, Lisp_Object buffer_or_name, Lisp_Object keep_margins)
3270 register Lisp_Object tem, buffer;
3271 register struct window *w = decode_live_window (window);
3273 XSETWINDOW (window, w);
3274 buffer = Fget_buffer (buffer_or_name);
3275 CHECK_BUFFER (buffer);
3276 if (NILP (BVAR (XBUFFER (buffer), name)))
3277 error ("Attempt to display deleted buffer");
3279 tem = w->buffer;
3280 if (NILP (tem))
3281 error ("Window is deleted");
3282 else if (!EQ (tem, Qt))
3283 /* w->buffer is t when the window is first being set up. */
3285 if (!EQ (tem, buffer))
3287 if (EQ (w->dedicated, Qt))
3288 /* WINDOW is strongly dedicated to its buffer, signal an
3289 error. */
3290 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem), name)));
3291 else
3292 /* WINDOW is weakly dedicated to its buffer, reset
3293 dedication. */
3294 wset_dedicated (w, Qnil);
3296 call1 (Qrecord_window_buffer, window);
3299 unshow_buffer (w);
3302 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3304 return Qnil;
3307 static Lisp_Object
3308 display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame)
3310 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3313 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3314 0, 1, 0,
3315 doc: /* Force all windows to be updated on next redisplay.
3316 If optional arg OBJECT is a window, force redisplay of that window only.
3317 If OBJECT is a buffer or buffer name, force redisplay of all windows
3318 displaying that buffer. */)
3319 (Lisp_Object object)
3321 if (NILP (object))
3323 windows_or_buffers_changed++;
3324 update_mode_lines++;
3325 return Qt;
3328 if (WINDOWP (object))
3330 struct window *w = XWINDOW (object);
3331 mark_window_display_accurate (object, 0);
3332 w->update_mode_line = 1;
3333 if (BUFFERP (w->buffer))
3334 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3335 ++update_mode_lines;
3336 return Qt;
3339 if (STRINGP (object))
3340 object = Fget_buffer (object);
3341 if (BUFFERP (object) && !NILP (BVAR (XBUFFER (object), name)))
3343 /* Walk all windows looking for buffer, and force update
3344 of each of those windows. */
3346 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3347 return NILP (object) ? Qnil : Qt;
3350 /* If nothing suitable was found, just return.
3351 We could signal an error, but this feature will typically be used
3352 asynchronously in timers or process sentinels, so we don't. */
3353 return Qnil;
3357 void
3358 temp_output_buffer_show (register Lisp_Object buf)
3360 register struct buffer *old = current_buffer;
3361 register Lisp_Object window;
3362 register struct window *w;
3364 bset_directory (XBUFFER (buf), BVAR (current_buffer, directory));
3366 Fset_buffer (buf);
3367 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3368 BEGV = BEG;
3369 ZV = Z;
3370 SET_PT (BEG);
3371 set_buffer_internal (old);
3373 if (!NILP (Vtemp_buffer_show_function))
3374 call1 (Vtemp_buffer_show_function, buf);
3375 else
3377 window = display_buffer (buf, Qnil, Qnil);
3379 if (!EQ (XWINDOW (window)->frame, selected_frame))
3380 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3381 Vminibuf_scroll_window = window;
3382 w = XWINDOW (window);
3383 w->hscroll = 0;
3384 w->min_hscroll = 0;
3385 set_marker_restricted_both (w->start, buf, BEG, BEG);
3386 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3388 /* Run temp-buffer-show-hook, with the chosen window selected
3389 and its buffer current. */
3391 ptrdiff_t count = SPECPDL_INDEX ();
3392 Lisp_Object prev_window, prev_buffer;
3393 prev_window = selected_window;
3394 XSETBUFFER (prev_buffer, old);
3396 /* Select the window that was chosen, for running the hook.
3397 Note: Both Fselect_window and select_window_norecord may
3398 set-buffer to the buffer displayed in the window,
3399 so we need to save the current buffer. --stef */
3400 record_unwind_protect (Fset_buffer, prev_buffer);
3401 record_unwind_protect (select_window_norecord, prev_window);
3402 Fselect_window (window, Qt);
3403 Fset_buffer (w->buffer);
3404 Frun_hooks (1, &Qtemp_buffer_show_hook);
3405 unbind_to (count, Qnil);
3410 DEFUN ("internal-temp-output-buffer-show",
3411 Ftemp_output_buffer_show, Stemp_output_buffer_show,
3412 1, 1, 0,
3413 doc: /* Internal function for `with-output-to-temp-buffer'. */)
3414 (Lisp_Object buf)
3416 temp_output_buffer_show (buf);
3417 return Qnil;
3420 /* Make new window, have it replace WINDOW in window-tree, and make
3421 WINDOW its only vertical child (HORFLAG 1 means make WINDOW its only
3422 horizontal child). */
3423 static void
3424 make_parent_window (Lisp_Object window, int horflag)
3426 Lisp_Object parent;
3427 register struct window *o, *p;
3429 o = XWINDOW (window);
3430 p = allocate_window ();
3431 memcpy ((char *) p + sizeof (struct vectorlike_header),
3432 (char *) o + sizeof (struct vectorlike_header),
3433 word_size * VECSIZE (struct window));
3434 XSETWINDOW (parent, p);
3436 p->sequence_number = ++sequence_number;
3438 replace_window (window, parent, 1);
3440 wset_next (o, Qnil);
3441 wset_prev (o, Qnil);
3442 wset_parent (o, parent);
3444 wset_hchild (p, horflag ? window : Qnil);
3445 wset_vchild (p, horflag ? Qnil : window);
3446 wset_start (p, Qnil);
3447 wset_pointm (p, Qnil);
3448 wset_buffer (p, Qnil);
3449 wset_combination_limit (p, Qnil);
3450 wset_window_parameters (p, Qnil);
3453 /* Make new window from scratch. */
3454 Lisp_Object
3455 make_window (void)
3457 Lisp_Object window;
3458 register struct window *w;
3460 w = allocate_window ();
3461 /* Initialize Lisp data. Note that allocate_window initializes all
3462 Lisp data to nil, so do it only for slots which should not be nil. */
3463 wset_left_col (w, make_number (0));
3464 wset_top_line (w, make_number (0));
3465 wset_total_lines (w, make_number (0));
3466 wset_total_cols (w, make_number (0));
3467 wset_normal_lines (w, make_float (1.0));
3468 wset_normal_cols (w, make_float (1.0));
3469 wset_new_total (w, make_number (0));
3470 wset_new_normal (w, make_number (0));
3471 wset_start (w, Fmake_marker ());
3472 wset_pointm (w, Fmake_marker ());
3473 wset_vertical_scroll_bar_type (w, Qt);
3474 wset_window_end_pos (w, make_number (0));
3475 wset_window_end_vpos (w, make_number (0));
3477 /* Initialize non-Lisp data. Note that allocate_window zeroes out all
3478 non-Lisp data, so do it only for slots which should not be zero. */
3479 w->nrows_scale_factor = w->ncols_scale_factor = 1;
3480 w->phys_cursor_type = -1;
3481 w->phys_cursor_width = -1;
3482 w->sequence_number = ++sequence_number;
3484 /* Reset window_list. */
3485 Vwindow_list = Qnil;
3486 /* Return window. */
3487 XSETWINDOW (window, w);
3488 return window;
3491 DEFUN ("set-window-new-total", Fset_window_new_total, Sset_window_new_total, 2, 3, 0,
3492 doc: /* Set new total size of WINDOW to SIZE.
3493 WINDOW must be a valid window and defaults to the selected one.
3494 Return SIZE.
3496 Optional argument ADD non-nil means add SIZE to the new total size of
3497 WINDOW and return the sum.
3499 Note: This function does not operate on any child windows of WINDOW. */)
3500 (Lisp_Object window, Lisp_Object size, Lisp_Object add)
3502 struct window *w = decode_valid_window (window);
3504 CHECK_NUMBER (size);
3505 if (NILP (add))
3506 wset_new_total (w, size);
3507 else
3508 wset_new_total (w, make_number (XINT (w->new_total) + XINT (size)));
3510 return w->new_total;
3513 DEFUN ("set-window-new-normal", Fset_window_new_normal, Sset_window_new_normal, 1, 2, 0,
3514 doc: /* Set new normal size of WINDOW to SIZE.
3515 WINDOW must be a valid window and defaults to the selected one.
3516 Return SIZE.
3518 Note: This function does not operate on any child windows of WINDOW. */)
3519 (Lisp_Object window, Lisp_Object size)
3521 wset_new_normal (decode_valid_window (window), size);
3522 return size;
3525 /* Return 1 if setting w->total_lines (w->total_cols if HORFLAG is
3526 non-zero) to w->new_total would result in correct heights (widths)
3527 for window W and recursively all child windows of W.
3529 Note: This function does not check any of `window-fixed-size-p',
3530 `window-min-height' or `window-min-width'. It does check that window
3531 sizes do not drop below one line (two columns). */
3532 static int
3533 window_resize_check (struct window *w, int horflag)
3535 struct window *c;
3537 if (!NILP (w->vchild))
3538 /* W is a vertical combination. */
3540 c = XWINDOW (w->vchild);
3541 if (horflag)
3542 /* All child windows of W must have the same width as W. */
3544 while (c)
3546 if ((XINT (c->new_total) != XINT (w->new_total))
3547 || !window_resize_check (c, horflag))
3548 return 0;
3549 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3551 return 1;
3553 else
3554 /* The sum of the heights of the child windows of W must equal
3555 W's height. */
3557 int sum_of_sizes = 0;
3558 while (c)
3560 if (!window_resize_check (c, horflag))
3561 return 0;
3562 sum_of_sizes = sum_of_sizes + XINT (c->new_total);
3563 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3565 return (sum_of_sizes == XINT (w->new_total));
3568 else if (!NILP (w->hchild))
3569 /* W is a horizontal combination. */
3571 c = XWINDOW (w->hchild);
3572 if (horflag)
3573 /* The sum of the widths of the child windows of W must equal W's
3574 width. */
3576 int sum_of_sizes = 0;
3577 while (c)
3579 if (!window_resize_check (c, horflag))
3580 return 0;
3581 sum_of_sizes = sum_of_sizes + XINT (c->new_total);
3582 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3584 return (sum_of_sizes == XINT (w->new_total));
3586 else
3587 /* All child windows of W must have the same height as W. */
3589 while (c)
3591 if ((XINT (c->new_total) != XINT (w->new_total))
3592 || !window_resize_check (c, horflag))
3593 return 0;
3594 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3596 return 1;
3599 else
3600 /* A leaf window. Make sure it's not too small. The following
3601 hardcodes the values of `window-safe-min-width' (2) and
3602 `window-safe-min-height' (1) which are defined in window.el. */
3603 return XINT (w->new_total) >= (horflag ? 2 : 1);
3606 /* Set w->total_lines (w->total_cols if HORIZONTAL is non-zero) to
3607 w->new_total for window W and recursively all child windows of W.
3608 Also calculate and assign the new vertical (horizontal) start
3609 positions of each of these windows.
3611 This function does not perform any error checks. Make sure you have
3612 run window_resize_check on W before applying this function. */
3613 static void
3614 window_resize_apply (struct window *w, int horflag)
3616 struct window *c;
3617 int pos;
3619 /* Note: Assigning new_normal requires that the new total size of the
3620 parent window has been set *before*. */
3621 if (horflag)
3623 wset_total_cols (w, w->new_total);
3624 if (NUMBERP (w->new_normal))
3625 wset_normal_cols (w, w->new_normal);
3627 pos = XINT (w->left_col);
3629 else
3631 wset_total_lines (w, w->new_total);
3632 if (NUMBERP (w->new_normal))
3633 wset_normal_lines (w, w->new_normal);
3635 pos = XINT (w->top_line);
3638 if (!NILP (w->vchild))
3639 /* W is a vertical combination. */
3641 c = XWINDOW (w->vchild);
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_lines);
3651 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3654 else if (!NILP (w->hchild))
3655 /* W is a horizontal combination. */
3657 c = XWINDOW (w->hchild);
3658 while (c)
3660 if (horflag)
3661 wset_left_col (c, make_number (pos));
3662 else
3663 wset_top_line (c, make_number (pos));
3664 window_resize_apply (c, horflag);
3665 if (horflag)
3666 pos = pos + XINT (c->total_cols);
3667 c = NILP (c->next) ? 0 : XWINDOW (c->next);
3671 /* Clear out some redisplay caches. */
3672 w->last_modified = 0;
3673 w->last_overlay_modified = 0;
3677 DEFUN ("window-resize-apply", Fwindow_resize_apply, Swindow_resize_apply, 1, 2, 0,
3678 doc: /* Apply requested size values for window-tree of FRAME.
3679 Optional argument HORIZONTAL omitted or nil means apply requested height
3680 values. HORIZONTAL non-nil means apply requested width values.
3682 This function checks whether the requested values sum up to a valid
3683 window layout, recursively assigns the new sizes of all child windows
3684 and calculates and assigns the new start positions of these windows.
3686 Note: This function does not check any of `window-fixed-size-p',
3687 `window-min-height' or `window-min-width'. All these checks have to
3688 be applied on the Elisp level. */)
3689 (Lisp_Object frame, Lisp_Object horizontal)
3691 struct frame *f;
3692 struct window *r;
3693 int horflag = !NILP (horizontal);
3695 if (NILP (frame))
3696 frame = selected_frame;
3697 CHECK_LIVE_FRAME (frame);
3699 f = XFRAME (frame);
3700 r = XWINDOW (FRAME_ROOT_WINDOW (f));
3702 if (!window_resize_check (r, horflag)
3703 || ! EQ (r->new_total,
3704 (horflag ? r->total_cols : r->total_lines)))
3705 return Qnil;
3707 BLOCK_INPUT;
3708 window_resize_apply (r, horflag);
3710 windows_or_buffers_changed++;
3711 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3713 adjust_glyphs (f);
3714 UNBLOCK_INPUT;
3716 run_window_configuration_change_hook (f);
3718 return Qt;
3722 /* Resize frame F's windows when number of lines of F is set to SIZE.
3723 HORFLAG 1 means resize windows when number of columns of F is set to
3724 SIZE.
3726 This function can delete all windows but the selected one in order to
3727 satisfy the request. The result will be meaningful if and only if
3728 F's windows have meaningful sizes when you call this. */
3729 void
3730 resize_frame_windows (struct frame *f, int size, int horflag)
3732 Lisp_Object root = f->root_window;
3733 struct window *r = XWINDOW (root);
3734 Lisp_Object mini = f->minibuffer_window;
3735 struct window *m;
3736 /* new_size is the new size of the frame's root window. */
3737 int new_size = (horflag
3738 ? size
3739 : (size
3740 - FRAME_TOP_MARGIN (f)
3741 - ((FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3742 ? 1 : 0)));
3744 wset_top_line (r, make_number (FRAME_TOP_MARGIN (f)));
3745 if (NILP (r->vchild) && NILP (r->hchild))
3746 /* For a leaf root window just set the size. */
3747 if (horflag)
3748 wset_total_cols (r, make_number (new_size));
3749 else
3750 wset_total_lines (r, make_number (new_size));
3751 else
3753 /* old_size is the old size of the frame's root window. */
3754 int old_size = XFASTINT (horflag ? r->total_cols
3755 : r->total_lines);
3756 Lisp_Object delta;
3758 XSETINT (delta, new_size - old_size);
3759 /* Try a "normal" resize first. */
3760 resize_root_window (root, delta, horflag ? Qt : Qnil, Qnil);
3761 if (window_resize_check (r, horflag)
3762 && new_size == XINT (r->new_total))
3763 window_resize_apply (r, horflag);
3764 else
3766 /* Try with "reasonable" minimum sizes next. */
3767 resize_root_window (root, delta, horflag ? Qt : Qnil, Qt);
3768 if (window_resize_check (r, horflag)
3769 && new_size == XINT (r->new_total))
3770 window_resize_apply (r, horflag);
3771 else
3773 /* Finally, try with "safe" minimum sizes. */
3774 resize_root_window (root, delta, horflag ? Qt : Qnil, Qsafe);
3775 if (window_resize_check (r, horflag)
3776 && new_size == XINT (r->new_total))
3777 window_resize_apply (r, horflag);
3778 else
3780 /* We lost. Delete all windows but the frame's
3781 selected one. */
3782 root = f->selected_window;
3783 Fdelete_other_windows_internal (root, Qnil);
3784 if (horflag)
3785 wset_total_cols (XWINDOW (root), make_number (new_size));
3786 else
3787 wset_total_lines (XWINDOW (root), make_number (new_size));
3793 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3795 m = XWINDOW (mini);
3796 if (horflag)
3797 wset_total_cols (m, make_number (size));
3798 else
3800 /* Are we sure we always want 1 line here? */
3801 wset_total_lines (m, make_number (1));
3802 wset_top_line
3803 (m, make_number (XINT (r->top_line) + XINT (r->total_lines)));
3809 DEFUN ("split-window-internal", Fsplit_window_internal, Ssplit_window_internal, 4, 4, 0,
3810 doc: /* Split window OLD.
3811 Second argument TOTAL-SIZE specifies the number of lines or columns of the
3812 new window. In any case TOTAL-SIZE must be a positive integer.
3814 Third argument SIDE nil (or `below') specifies that the new window shall
3815 be located below WINDOW. SIDE `above' means the new window shall be
3816 located above WINDOW. In both cases TOTAL-SIZE specifies the number of
3817 lines of the new window including space reserved for the mode and/or
3818 header line.
3820 SIDE t (or `right') specifies that the new window shall be located on
3821 the right side of WINDOW. SIDE `left' means the new window shall be
3822 located on the left of WINDOW. In both cases TOTAL-SIZE specifies the
3823 number of columns of the new window including space reserved for fringes
3824 and the scrollbar or a divider column.
3826 Fourth argument NORMAL-SIZE specifies the normal size of the new window
3827 according to the SIDE argument.
3829 The new total and normal sizes of all involved windows must have been
3830 set correctly. See the code of `split-window' for how this is done. */)
3831 (Lisp_Object old, Lisp_Object total_size, Lisp_Object side, Lisp_Object normal_size)
3833 /* OLD (*o) is the window we have to split. (*p) is either OLD's
3834 parent window or an internal window we have to install as OLD's new
3835 parent. REFERENCE (*r) must denote a live window, or is set to OLD
3836 provided OLD is a leaf window, or to the frame's selected window.
3837 NEW (*n) is the new window created with some parameters taken from
3838 REFERENCE (*r). */
3839 register Lisp_Object new, frame, reference;
3840 register struct window *o, *p, *n, *r;
3841 struct frame *f;
3842 int horflag
3843 /* HORFLAG is 1 when we split side-by-side, 0 otherwise. */
3844 = EQ (side, Qt) || EQ (side, Qleft) || EQ (side, Qright);
3845 int combination_limit = 0;
3847 CHECK_WINDOW (old);
3848 o = XWINDOW (old);
3849 frame = WINDOW_FRAME (o);
3850 f = XFRAME (frame);
3852 CHECK_NUMBER (total_size);
3854 /* Set combination_limit to 1 if we have to make a new parent window.
3855 We do that if either `window-combination-limit' is t, or OLD has no
3856 parent, or OLD is ortho-combined. */
3857 combination_limit =
3858 !NILP (Vwindow_combination_limit)
3859 || NILP (o->parent)
3860 || NILP (horflag
3861 ? (XWINDOW (o->parent)->hchild)
3862 : (XWINDOW (o->parent)->vchild));
3864 /* We need a live reference window to initialize some parameters. */
3865 if (WINDOW_LIVE_P (old))
3866 /* OLD is live, use it as reference window. */
3867 reference = old;
3868 else
3869 /* Use the frame's selected window as reference window. */
3870 reference = FRAME_SELECTED_WINDOW (f);
3871 r = XWINDOW (reference);
3873 /* The following bugs are caught by `split-window'. */
3874 if (MINI_WINDOW_P (o))
3875 error ("Attempt to split minibuffer window");
3876 else if (XINT (total_size) < (horflag ? 2 : 1))
3877 error ("Size of new window too small (after split)");
3878 else if (!combination_limit && !NILP (Vwindow_combination_resize))
3879 /* `window-combination-resize' non-nil means try to resize OLD's siblings
3880 proportionally. */
3882 p = XWINDOW (o->parent);
3883 /* Temporarily pretend we split the parent window. */
3884 wset_new_total
3885 (p, make_number (XINT (horflag ? p->total_cols : p->total_lines)
3886 - XINT (total_size)));
3887 if (!window_resize_check (p, horflag))
3888 error ("Window sizes don't fit");
3889 else
3890 /* Undo the temporary pretension. */
3891 wset_new_total (p, horflag ? p->total_cols : p->total_lines);
3893 else
3895 if (!window_resize_check (o, horflag))
3896 error ("Resizing old window failed");
3897 else if (XINT (total_size) + XINT (o->new_total)
3898 != XINT (horflag ? o->total_cols : o->total_lines))
3899 error ("Sum of sizes of old and new window don't fit");
3902 /* This is our point of no return. */
3903 if (combination_limit)
3905 /* Save the old value of o->normal_cols/lines. It gets corrupted
3906 by make_parent_window and we need it below for assigning it to
3907 p->new_normal. */
3908 Lisp_Object new_normal
3909 = horflag ? o->normal_cols : o->normal_lines;
3911 make_parent_window (old, horflag);
3912 p = XWINDOW (o->parent);
3913 /* Store value of `window-combination-limit' in new parent's
3914 combination_limit slot. */
3915 wset_combination_limit (p, Vwindow_combination_limit);
3916 /* These get applied below. */
3917 wset_new_total (p, horflag ? o->total_cols : o->total_lines);
3918 wset_new_normal (p, new_normal);
3920 else
3921 p = XWINDOW (o->parent);
3923 windows_or_buffers_changed++;
3924 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3925 new = make_window ();
3926 n = XWINDOW (new);
3927 wset_frame (n, frame);
3928 wset_parent (n, o->parent);
3929 wset_vchild (n, Qnil);
3930 wset_hchild (n, Qnil);
3932 if (EQ (side, Qabove) || EQ (side, Qleft))
3934 wset_prev (n, o->prev);
3935 if (NILP (n->prev))
3936 if (horflag)
3937 wset_hchild (p, new);
3938 else
3939 wset_vchild (p, new);
3940 else
3941 wset_next (XWINDOW (n->prev), new);
3942 wset_next (n, old);
3943 wset_prev (o, new);
3945 else
3947 wset_next (n, o->next);
3948 if (!NILP (n->next))
3949 wset_prev (XWINDOW (n->next), new);
3950 wset_prev (n, old);
3951 wset_next (o, new);
3954 wset_buffer (n, Qt);
3955 wset_window_end_valid (n, Qnil);
3956 memset (&n->last_cursor, 0, sizeof n->last_cursor);
3958 /* Get special geometry settings from reference window. */
3959 wset_left_margin_cols (n, r->left_margin_cols);
3960 wset_right_margin_cols (n, r->right_margin_cols);
3961 wset_left_fringe_width (n, r->left_fringe_width);
3962 wset_right_fringe_width (n, r->right_fringe_width);
3963 n->fringes_outside_margins = r->fringes_outside_margins;
3964 wset_scroll_bar_width (n, r->scroll_bar_width);
3965 wset_vertical_scroll_bar_type (n, r->vertical_scroll_bar_type);
3967 /* Directly assign orthogonal coordinates and sizes. */
3968 if (horflag)
3970 wset_top_line (n, o->top_line);
3971 wset_total_lines (n, o->total_lines);
3973 else
3975 wset_left_col (n, o->left_col);
3976 wset_total_cols (n, o->total_cols);
3979 /* Iso-coordinates and sizes are assigned by window_resize_apply,
3980 get them ready here. */
3981 wset_new_total (n, total_size);
3982 wset_new_normal (n, normal_size);
3984 BLOCK_INPUT;
3985 window_resize_apply (p, horflag);
3986 adjust_glyphs (f);
3987 /* Set buffer of NEW to buffer of reference window. Don't run
3988 any hooks. */
3989 set_window_buffer (new, r->buffer, 0, 1);
3990 UNBLOCK_INPUT;
3992 /* Maybe we should run the scroll functions in Elisp (which already
3993 runs the configuration change hook). */
3994 if (! NILP (Vwindow_scroll_functions))
3995 run_hook_with_args_2 (Qwindow_scroll_functions, new,
3996 Fmarker_position (n->start));
3997 /* Return NEW. */
3998 return new;
4002 DEFUN ("delete-window-internal", Fdelete_window_internal, Sdelete_window_internal, 1, 1, 0,
4003 doc: /* Remove WINDOW from its frame.
4004 WINDOW defaults to the selected window. Return nil.
4005 Signal an error when WINDOW is the only window on its frame. */)
4006 (register Lisp_Object window)
4008 register Lisp_Object parent, sibling, frame, root;
4009 struct window *w, *p, *s, *r;
4010 struct frame *f;
4011 int horflag;
4012 int before_sibling = 0;
4014 w = decode_any_window (window);
4015 XSETWINDOW (window, w);
4016 if (NILP (w->buffer)
4017 && NILP (w->hchild) && NILP (w->vchild))
4018 /* It's a no-op to delete an already deleted window. */
4019 return Qnil;
4021 parent = w->parent;
4022 if (NILP (parent))
4023 /* Never delete a minibuffer or frame root window. */
4024 error ("Attempt to delete minibuffer or sole ordinary window");
4025 else if (NILP (w->prev) && NILP (w->next))
4026 /* Rather bow out here, this case should be handled on the Elisp
4027 level. */
4028 error ("Attempt to delete sole window of parent");
4030 p = XWINDOW (parent);
4031 horflag = NILP (p->vchild);
4033 frame = WINDOW_FRAME (w);
4034 f = XFRAME (frame);
4036 root = FRAME_ROOT_WINDOW (f);
4037 r = XWINDOW (root);
4039 /* Unlink WINDOW from window tree. */
4040 if (NILP (w->prev))
4041 /* Get SIBLING below (on the right of) WINDOW. */
4043 /* before_sibling 1 means WINDOW is the first child of its
4044 parent and thus before the sibling. */
4045 before_sibling = 1;
4046 sibling = w->next;
4047 s = XWINDOW (sibling);
4048 wset_prev (s, Qnil);
4049 if (horflag)
4050 wset_hchild (p, sibling);
4051 else
4052 wset_vchild (p, sibling);
4054 else
4055 /* Get SIBLING above (on the left of) WINDOW. */
4057 sibling = w->prev;
4058 s = XWINDOW (sibling);
4059 wset_next (s, w->next);
4060 if (!NILP (s->next))
4061 wset_prev (XWINDOW (s->next), sibling);
4064 if (window_resize_check (r, horflag)
4065 && EQ (r->new_total,
4066 (horflag ? r->total_cols : r->total_lines)))
4067 /* We can delete WINDOW now. */
4070 /* Block input. */
4071 BLOCK_INPUT;
4072 window_resize_apply (p, horflag);
4074 /* If this window is referred to by the dpyinfo's mouse
4075 highlight, invalidate that slot to be safe (Bug#9904). */
4076 if (!FRAME_INITIAL_P (f))
4078 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
4080 if (EQ (hlinfo->mouse_face_window, window))
4081 hlinfo->mouse_face_window = Qnil;
4084 windows_or_buffers_changed++;
4085 Vwindow_list = Qnil;
4086 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4088 wset_next (w, Qnil); /* Don't delete w->next too. */
4089 free_window_matrices (w);
4091 if (!NILP (w->vchild))
4093 delete_all_child_windows (w->vchild);
4094 wset_vchild (w, Qnil);
4096 else if (!NILP (w->hchild))
4098 delete_all_child_windows (w->hchild);
4099 wset_hchild (w, Qnil);
4101 else if (!NILP (w->buffer))
4103 unshow_buffer (w);
4104 unchain_marker (XMARKER (w->pointm));
4105 unchain_marker (XMARKER (w->start));
4106 wset_buffer (w, Qnil);
4109 if (NILP (s->prev) && NILP (s->next))
4110 /* A matrjoshka where SIBLING has become the only child of
4111 PARENT. */
4113 /* Put SIBLING into PARENT's place. */
4114 replace_window (parent, sibling, 0);
4115 /* Have SIBLING inherit the following three slot values from
4116 PARENT (the combination_limit slot is not inherited). */
4117 wset_normal_cols (s, p->normal_cols);
4118 wset_normal_lines (s, p->normal_lines);
4119 /* Mark PARENT as deleted. */
4120 wset_vchild (p, Qnil);
4121 wset_hchild (p, Qnil);
4122 /* Try to merge SIBLING into its new parent. */
4123 recombine_windows (sibling);
4126 adjust_glyphs (f);
4128 if (!WINDOW_LIVE_P (FRAME_SELECTED_WINDOW (f)))
4129 /* We deleted the frame's selected window. */
4131 /* Use the frame's first window as fallback ... */
4132 Lisp_Object new_selected_window = Fframe_first_window (frame);
4133 /* ... but preferably use its most recently used window. */
4134 Lisp_Object mru_window;
4136 /* `get-mru-window' might fail for some reason so play it safe
4137 - promote the first window _without recording it_ first. */
4138 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4139 Fselect_window (new_selected_window, Qt);
4140 else
4141 fset_selected_window (f, new_selected_window);
4143 UNBLOCK_INPUT;
4145 /* Now look whether `get-mru-window' gets us something. */
4146 mru_window = call1 (Qget_mru_window, frame);
4147 if (WINDOW_LIVE_P (mru_window)
4148 && EQ (XWINDOW (mru_window)->frame, frame))
4149 new_selected_window = mru_window;
4151 /* If all ended up well, we now promote the mru window. */
4152 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4153 Fselect_window (new_selected_window, Qnil);
4154 else
4155 fset_selected_window (f, new_selected_window);
4157 else
4158 UNBLOCK_INPUT;
4160 /* Must be run by the caller:
4161 run_window_configuration_change_hook (f); */
4163 else
4164 /* We failed: Relink WINDOW into window tree. */
4166 if (before_sibling)
4168 wset_prev (s, window);
4169 if (horflag)
4170 wset_hchild (p, window);
4171 else
4172 wset_vchild (p, window);
4174 else
4176 wset_next (s, window);
4177 if (!NILP (w->next))
4178 wset_prev (XWINDOW (w->next), window);
4180 error ("Deletion failed");
4183 return Qnil;
4186 /***********************************************************************
4187 Resizing Mini-Windows
4188 ***********************************************************************/
4190 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we
4191 can. */
4192 void
4193 grow_mini_window (struct window *w, int delta)
4195 struct frame *f = XFRAME (w->frame);
4196 struct window *r;
4197 Lisp_Object root, value;
4199 eassert (MINI_WINDOW_P (w));
4200 eassert (delta >= 0);
4202 root = FRAME_ROOT_WINDOW (f);
4203 r = XWINDOW (root);
4204 value = call2 (Qwindow_resize_root_window_vertically,
4205 root, make_number (- delta));
4206 if (INTEGERP (value) && window_resize_check (r, 0))
4208 BLOCK_INPUT;
4209 window_resize_apply (r, 0);
4211 /* Grow the mini-window. */
4212 wset_top_line
4213 (w, make_number (XFASTINT (r->top_line) + XFASTINT (r->total_lines)));
4214 wset_total_lines
4215 (w, make_number (XFASTINT (w->total_lines) - XINT (value)));
4216 w->last_modified = 0;
4217 w->last_overlay_modified = 0;
4219 adjust_glyphs (f);
4220 UNBLOCK_INPUT;
4225 /* Shrink mini-window W. */
4226 void
4227 shrink_mini_window (struct window *w)
4229 struct frame *f = XFRAME (w->frame);
4230 struct window *r;
4231 Lisp_Object root, value;
4232 EMACS_INT size;
4234 eassert (MINI_WINDOW_P (w));
4236 size = XINT (w->total_lines);
4237 if (size > 1)
4239 root = FRAME_ROOT_WINDOW (f);
4240 r = XWINDOW (root);
4241 value = call2 (Qwindow_resize_root_window_vertically,
4242 root, make_number (size - 1));
4243 if (INTEGERP (value) && window_resize_check (r, 0))
4245 BLOCK_INPUT;
4246 window_resize_apply (r, 0);
4248 /* Shrink the mini-window. */
4249 wset_top_line (w, make_number (XFASTINT (r->top_line)
4250 + XFASTINT (r->total_lines)));
4251 wset_total_lines (w, make_number (1));
4253 w->last_modified = 0;
4254 w->last_overlay_modified = 0;
4256 adjust_glyphs (f);
4257 UNBLOCK_INPUT;
4259 /* If the above failed for whatever strange reason we must make a
4260 one window frame here. The same routine will be needed when
4261 shrinking the frame (and probably when making the initial
4262 *scratch* window). For the moment leave things as they are. */
4266 DEFUN ("resize-mini-window-internal", Fresize_mini_window_internal, Sresize_mini_window_internal, 1, 1, 0,
4267 doc: /* Resize minibuffer window WINDOW. */)
4268 (Lisp_Object window)
4270 struct window *w = XWINDOW (window);
4271 struct window *r;
4272 struct frame *f;
4273 int height;
4275 CHECK_WINDOW (window);
4276 f = XFRAME (w->frame);
4278 if (!EQ (FRAME_MINIBUF_WINDOW (XFRAME (w->frame)), window))
4279 error ("Not a valid minibuffer window");
4280 else if (FRAME_MINIBUF_ONLY_P (f))
4281 error ("Cannot resize a minibuffer-only frame");
4283 r = XWINDOW (FRAME_ROOT_WINDOW (f));
4284 height = XINT (r->total_lines) + XINT (w->total_lines);
4285 if (window_resize_check (r, 0)
4286 && XINT (w->new_total) > 0
4287 && height == XINT (r->new_total) + XINT (w->new_total))
4289 BLOCK_INPUT;
4290 window_resize_apply (r, 0);
4292 wset_total_lines (w, w->new_total);
4293 wset_top_line (w, make_number (XINT (r->top_line)
4294 + XINT (r->total_lines)));
4296 windows_or_buffers_changed++;
4297 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4298 adjust_glyphs (f);
4299 UNBLOCK_INPUT;
4301 run_window_configuration_change_hook (f);
4302 return Qt;
4304 else error ("Failed to resize minibuffer window");
4307 /* Mark window cursors off for all windows in the window tree rooted
4308 at W by setting their phys_cursor_on_p flag to zero. Called from
4309 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4310 the frame are cleared. */
4312 void
4313 mark_window_cursors_off (struct window *w)
4315 while (w)
4317 if (!NILP (w->hchild))
4318 mark_window_cursors_off (XWINDOW (w->hchild));
4319 else if (!NILP (w->vchild))
4320 mark_window_cursors_off (XWINDOW (w->vchild));
4321 else
4322 w->phys_cursor_on_p = 0;
4324 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4329 /* Return number of lines of text (not counting mode lines) in W. */
4332 window_internal_height (struct window *w)
4334 int ht = XFASTINT (w->total_lines);
4336 if (!MINI_WINDOW_P (w))
4338 if (!NILP (w->parent)
4339 || !NILP (w->vchild)
4340 || !NILP (w->hchild)
4341 || !NILP (w->next)
4342 || !NILP (w->prev)
4343 || WINDOW_WANTS_MODELINE_P (w))
4344 --ht;
4346 if (WINDOW_WANTS_HEADER_LINE_P (w))
4347 --ht;
4350 return ht;
4353 /************************************************************************
4354 Window Scrolling
4355 ***********************************************************************/
4357 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4358 N screen-fulls, which is defined as the height of the window minus
4359 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4360 instead. Negative values of N mean scroll down. NOERROR non-zero
4361 means don't signal an error if we try to move over BEGV or ZV,
4362 respectively. */
4364 static void
4365 window_scroll (Lisp_Object window, EMACS_INT n, int whole, int noerror)
4367 immediate_quit = 1;
4368 n = clip_to_bounds (INT_MIN, n, INT_MAX);
4370 /* If we must, use the pixel-based version which is much slower than
4371 the line-based one but can handle varying line heights. */
4372 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4373 window_scroll_pixel_based (window, n, whole, noerror);
4374 else
4375 window_scroll_line_based (window, n, whole, noerror);
4377 immediate_quit = 0;
4381 /* Implementation of window_scroll that works based on pixel line
4382 heights. See the comment of window_scroll for parameter
4383 descriptions. */
4385 static void
4386 window_scroll_pixel_based (Lisp_Object window, int n, int whole, int noerror)
4388 struct it it;
4389 struct window *w = XWINDOW (window);
4390 struct text_pos start;
4391 int this_scroll_margin;
4392 /* True if we fiddled the window vscroll field without really scrolling. */
4393 int vscrolled = 0;
4394 int x, y, rtop, rbot, rowh, vpos;
4395 void *itdata = NULL;
4397 SET_TEXT_POS_FROM_MARKER (start, w->start);
4398 /* Scrolling a minibuffer window via scroll bar when the echo area
4399 shows long text sometimes resets the minibuffer contents behind
4400 our backs. */
4401 if (CHARPOS (start) > ZV)
4402 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
4404 /* If PT is not visible in WINDOW, move back one half of
4405 the screen. Allow PT to be partially visible, otherwise
4406 something like (scroll-down 1) with PT in the line before
4407 the partially visible one would recenter. */
4409 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4411 itdata = bidi_shelve_cache ();
4412 /* Move backward half the height of the window. Performance note:
4413 vmotion used here is about 10% faster, but would give wrong
4414 results for variable height lines. */
4415 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4416 it.current_y = it.last_visible_y;
4417 move_it_vertically_backward (&it, window_box_height (w) / 2);
4419 /* The function move_iterator_vertically may move over more than
4420 the specified y-distance. If it->w is small, e.g. a
4421 mini-buffer window, we may end up in front of the window's
4422 display area. This is the case when Start displaying at the
4423 start of the line containing PT in this case. */
4424 if (it.current_y <= 0)
4426 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4427 move_it_vertically_backward (&it, 0);
4428 it.current_y = 0;
4431 start = it.current.pos;
4432 bidi_unshelve_cache (itdata, 0);
4434 else if (auto_window_vscroll_p)
4436 if (rtop || rbot) /* partially visible */
4438 int px;
4439 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4440 if (whole)
4441 dy = max ((window_box_height (w)
4442 - next_screen_context_lines * dy),
4443 dy);
4444 dy *= n;
4446 if (n < 0)
4448 /* Only vscroll backwards if already vscrolled forwards. */
4449 if (w->vscroll < 0 && rtop > 0)
4451 px = max (0, -w->vscroll - min (rtop, -dy));
4452 Fset_window_vscroll (window, make_number (px), Qt);
4453 return;
4456 if (n > 0)
4458 /* Do vscroll if already vscrolled or only display line. */
4459 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4461 px = max (0, -w->vscroll + min (rbot, dy));
4462 Fset_window_vscroll (window, make_number (px), Qt);
4463 return;
4466 /* Maybe modify window start instead of scrolling. */
4467 if (rbot > 0 || w->vscroll < 0)
4469 ptrdiff_t spos;
4471 Fset_window_vscroll (window, make_number (0), Qt);
4472 /* If there are other text lines above the current row,
4473 move window start to current row. Else to next row. */
4474 if (rbot > 0)
4475 spos = XINT (Fline_beginning_position (Qnil));
4476 else
4477 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4478 set_marker_restricted (w->start, make_number (spos),
4479 w->buffer);
4480 w->start_at_line_beg = 1;
4481 w->update_mode_line = 1;
4482 w->last_modified = 0;
4483 w->last_overlay_modified = 0;
4484 /* Set force_start so that redisplay_window will run the
4485 window-scroll-functions. */
4486 w->force_start = 1;
4487 return;
4491 /* Cancel previous vscroll. */
4492 Fset_window_vscroll (window, make_number (0), Qt);
4495 itdata = bidi_shelve_cache ();
4496 /* If scroll_preserve_screen_position is non-nil, we try to set
4497 point in the same window line as it is now, so get that line. */
4498 if (!NILP (Vscroll_preserve_screen_position))
4500 /* We preserve the goal pixel coordinate across consecutive
4501 calls to scroll-up, scroll-down and other commands that
4502 have the `scroll-command' property. This avoids the
4503 possibility of point becoming "stuck" on a tall line when
4504 scrolling by one line. */
4505 if (window_scroll_pixel_based_preserve_y < 0
4506 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4507 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4509 start_display (&it, w, start);
4510 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4511 window_scroll_pixel_based_preserve_y = it.current_y;
4512 window_scroll_pixel_based_preserve_x = it.current_x;
4515 else
4516 window_scroll_pixel_based_preserve_y
4517 = window_scroll_pixel_based_preserve_x = -1;
4519 /* Move iterator it from start the specified distance forward or
4520 backward. The result is the new window start. */
4521 start_display (&it, w, start);
4522 if (whole)
4524 ptrdiff_t start_pos = IT_CHARPOS (it);
4525 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4526 dy = max ((window_box_height (w)
4527 - next_screen_context_lines * dy),
4528 dy) * n;
4530 /* Note that move_it_vertically always moves the iterator to the
4531 start of a line. So, if the last line doesn't have a newline,
4532 we would end up at the start of the line ending at ZV. */
4533 if (dy <= 0)
4535 move_it_vertically_backward (&it, -dy);
4536 /* Ensure we actually do move, e.g. in case we are currently
4537 looking at an image that is taller that the window height. */
4538 while (start_pos == IT_CHARPOS (it)
4539 && start_pos > BEGV)
4540 move_it_by_lines (&it, -1);
4542 else if (dy > 0)
4544 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4545 MOVE_TO_POS | MOVE_TO_Y);
4546 /* Ensure we actually do move, e.g. in case we are currently
4547 looking at an image that is taller that the window height. */
4548 while (start_pos == IT_CHARPOS (it)
4549 && start_pos < ZV)
4550 move_it_by_lines (&it, 1);
4553 else
4554 move_it_by_lines (&it, n);
4556 /* We failed if we find ZV is already on the screen (scrolling up,
4557 means there's nothing past the end), or if we can't start any
4558 earlier (scrolling down, means there's nothing past the top). */
4559 if ((n > 0 && IT_CHARPOS (it) == ZV)
4560 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4562 if (IT_CHARPOS (it) == ZV)
4564 if (it.current_y < it.last_visible_y
4565 && (it.current_y + it.max_ascent + it.max_descent
4566 > it.last_visible_y))
4568 /* The last line was only partially visible, make it fully
4569 visible. */
4570 w->vscroll = (it.last_visible_y
4571 - it.current_y + it.max_ascent + it.max_descent);
4572 adjust_glyphs (it.f);
4574 else
4576 bidi_unshelve_cache (itdata, 0);
4577 if (noerror)
4578 return;
4579 else if (n < 0) /* could happen with empty buffers */
4580 xsignal0 (Qbeginning_of_buffer);
4581 else
4582 xsignal0 (Qend_of_buffer);
4585 else
4587 if (w->vscroll != 0)
4588 /* The first line was only partially visible, make it fully
4589 visible. */
4590 w->vscroll = 0;
4591 else
4593 bidi_unshelve_cache (itdata, 0);
4594 if (noerror)
4595 return;
4596 else
4597 xsignal0 (Qbeginning_of_buffer);
4601 /* If control gets here, then we vscrolled. */
4603 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4605 /* Don't try to change the window start below. */
4606 vscrolled = 1;
4609 if (! vscrolled)
4611 ptrdiff_t pos = IT_CHARPOS (it);
4612 ptrdiff_t bytepos;
4614 /* If in the middle of a multi-glyph character move forward to
4615 the next character. */
4616 if (in_display_vector_p (&it))
4618 ++pos;
4619 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4622 /* Set the window start, and set up the window for redisplay. */
4623 set_marker_restricted (w->start, make_number (pos),
4624 w->buffer);
4625 bytepos = XMARKER (w->start)->bytepos;
4626 w->start_at_line_beg = (pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n');
4627 w->update_mode_line = 1;
4628 w->last_modified = 0;
4629 w->last_overlay_modified = 0;
4630 /* Set force_start so that redisplay_window will run the
4631 window-scroll-functions. */
4632 w->force_start = 1;
4635 /* The rest of this function uses current_y in a nonstandard way,
4636 not including the height of the header line if any. */
4637 it.current_y = it.vpos = 0;
4639 /* Move PT out of scroll margins.
4640 This code wants current_y to be zero at the window start position
4641 even if there is a header line. */
4642 this_scroll_margin = max (0, scroll_margin);
4643 this_scroll_margin
4644 = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
4645 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
4647 if (n > 0)
4649 /* We moved the window start towards ZV, so PT may be now
4650 in the scroll margin at the top. */
4651 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4652 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
4653 && (NILP (Vscroll_preserve_screen_position)
4654 || EQ (Vscroll_preserve_screen_position, Qt)))
4655 /* We found PT at a legitimate height. Leave it alone. */
4657 else if (window_scroll_pixel_based_preserve_y >= 0)
4659 /* If we have a header line, take account of it.
4660 This is necessary because we set it.current_y to 0, above. */
4661 move_it_to (&it, -1,
4662 window_scroll_pixel_based_preserve_x,
4663 window_scroll_pixel_based_preserve_y
4664 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
4665 -1, MOVE_TO_Y | MOVE_TO_X);
4666 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4668 else
4670 while (it.current_y < this_scroll_margin)
4672 int prev = it.current_y;
4673 move_it_by_lines (&it, 1);
4674 if (prev == it.current_y)
4675 break;
4677 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4680 else if (n < 0)
4682 ptrdiff_t charpos, bytepos;
4683 int partial_p;
4685 /* Save our position, for the
4686 window_scroll_pixel_based_preserve_y case. */
4687 charpos = IT_CHARPOS (it);
4688 bytepos = IT_BYTEPOS (it);
4690 /* We moved the window start towards BEGV, so PT may be now
4691 in the scroll margin at the bottom. */
4692 move_it_to (&it, PT, -1,
4693 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
4694 - this_scroll_margin - 1),
4696 MOVE_TO_POS | MOVE_TO_Y);
4698 /* Save our position, in case it's correct. */
4699 charpos = IT_CHARPOS (it);
4700 bytepos = IT_BYTEPOS (it);
4702 /* See if point is on a partially visible line at the end. */
4703 if (it.what == IT_EOB)
4704 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
4705 else
4707 move_it_by_lines (&it, 1);
4708 partial_p = it.current_y > it.last_visible_y;
4711 if (charpos == PT && !partial_p
4712 && (NILP (Vscroll_preserve_screen_position)
4713 || EQ (Vscroll_preserve_screen_position, Qt)))
4714 /* We found PT before we found the display margin, so PT is ok. */
4716 else if (window_scroll_pixel_based_preserve_y >= 0)
4718 SET_TEXT_POS_FROM_MARKER (start, w->start);
4719 start_display (&it, w, start);
4720 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
4721 here because we called start_display again and did not
4722 alter it.current_y this time. */
4723 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
4724 window_scroll_pixel_based_preserve_y, -1,
4725 MOVE_TO_Y | MOVE_TO_X);
4726 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4728 else
4730 if (partial_p)
4731 /* The last line was only partially visible, so back up two
4732 lines to make sure we're on a fully visible line. */
4734 move_it_by_lines (&it, -2);
4735 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4737 else
4738 /* No, the position we saved is OK, so use it. */
4739 SET_PT_BOTH (charpos, bytepos);
4742 bidi_unshelve_cache (itdata, 0);
4746 /* Implementation of window_scroll that works based on screen lines.
4747 See the comment of window_scroll for parameter descriptions. */
4749 static void
4750 window_scroll_line_based (Lisp_Object window, int n, int whole, int noerror)
4752 register struct window *w = XWINDOW (window);
4753 /* Fvertical_motion enters redisplay, which can trigger
4754 fontification, which in turn can modify buffer text (e.g., if the
4755 fontification functions replace escape sequences with faces, as
4756 in `grep-mode-font-lock-keywords'). So we use a marker to record
4757 the old point position, to prevent crashes in SET_PT_BOTH. */
4758 Lisp_Object opoint_marker = Fpoint_marker ();
4759 register ptrdiff_t pos, pos_byte;
4760 register int ht = window_internal_height (w);
4761 register Lisp_Object tem;
4762 int lose;
4763 Lisp_Object bolp;
4764 ptrdiff_t startpos;
4765 Lisp_Object original_pos = Qnil;
4767 /* If scrolling screen-fulls, compute the number of lines to
4768 scroll from the window's height. */
4769 if (whole)
4770 n *= max (1, ht - next_screen_context_lines);
4772 startpos = marker_position (w->start);
4774 if (!NILP (Vscroll_preserve_screen_position))
4776 if (window_scroll_preserve_vpos <= 0
4777 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4778 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4780 struct position posit
4781 = *compute_motion (startpos, 0, 0, 0,
4782 PT, ht, 0,
4783 -1, w->hscroll,
4784 0, w);
4785 window_scroll_preserve_vpos = posit.vpos;
4786 window_scroll_preserve_hpos = posit.hpos + w->hscroll;
4789 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
4790 make_number (window_scroll_preserve_vpos));
4793 XSETFASTINT (tem, PT);
4794 tem = Fpos_visible_in_window_p (tem, window, Qnil);
4796 if (NILP (tem))
4798 Fvertical_motion (make_number (- (ht / 2)), window);
4799 startpos = PT;
4802 SET_PT (startpos);
4803 lose = n < 0 && PT == BEGV;
4804 Fvertical_motion (make_number (n), window);
4805 pos = PT;
4806 pos_byte = PT_BYTE;
4807 bolp = Fbolp ();
4808 SET_PT_BOTH (marker_position (opoint_marker),
4809 marker_byte_position (opoint_marker));
4811 if (lose)
4813 if (noerror)
4814 return;
4815 else
4816 xsignal0 (Qbeginning_of_buffer);
4819 if (pos < ZV)
4821 /* Don't use a scroll margin that is negative or too large. */
4822 int this_scroll_margin =
4823 max (0, min (scroll_margin, XINT (w->total_lines) / 4));
4825 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
4826 w->start_at_line_beg = !NILP (bolp);
4827 w->update_mode_line = 1;
4828 w->last_modified = 0;
4829 w->last_overlay_modified = 0;
4830 /* Set force_start so that redisplay_window will run
4831 the window-scroll-functions. */
4832 w->force_start = 1;
4834 if (!NILP (Vscroll_preserve_screen_position)
4835 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
4837 SET_PT_BOTH (pos, pos_byte);
4838 Fvertical_motion (original_pos, window);
4840 /* If we scrolled forward, put point enough lines down
4841 that it is outside the scroll margin. */
4842 else if (n > 0)
4844 int top_margin;
4846 if (this_scroll_margin > 0)
4848 SET_PT_BOTH (pos, pos_byte);
4849 Fvertical_motion (make_number (this_scroll_margin), window);
4850 top_margin = PT;
4852 else
4853 top_margin = pos;
4855 if (top_margin <= marker_position (opoint_marker))
4856 SET_PT_BOTH (marker_position (opoint_marker),
4857 marker_byte_position (opoint_marker));
4858 else if (!NILP (Vscroll_preserve_screen_position))
4860 SET_PT_BOTH (pos, pos_byte);
4861 Fvertical_motion (original_pos, window);
4863 else
4864 SET_PT (top_margin);
4866 else if (n < 0)
4868 int bottom_margin;
4870 /* If we scrolled backward, put point near the end of the window
4871 but not within the scroll margin. */
4872 SET_PT_BOTH (pos, pos_byte);
4873 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
4874 if (XFASTINT (tem) == ht - this_scroll_margin)
4875 bottom_margin = PT;
4876 else
4877 bottom_margin = PT + 1;
4879 if (bottom_margin > marker_position (opoint_marker))
4880 SET_PT_BOTH (marker_position (opoint_marker),
4881 marker_byte_position (opoint_marker));
4882 else
4884 if (!NILP (Vscroll_preserve_screen_position))
4886 SET_PT_BOTH (pos, pos_byte);
4887 Fvertical_motion (original_pos, window);
4889 else
4890 Fvertical_motion (make_number (-1), window);
4894 else
4896 if (noerror)
4897 return;
4898 else
4899 xsignal0 (Qend_of_buffer);
4904 /* Scroll selected_window up or down. If N is nil, scroll a
4905 screen-full which is defined as the height of the window minus
4906 next_screen_context_lines. If N is the symbol `-', scroll.
4907 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4908 up. This is the guts of Fscroll_up and Fscroll_down. */
4910 static void
4911 scroll_command (Lisp_Object n, int direction)
4913 ptrdiff_t count = SPECPDL_INDEX ();
4915 eassert (eabs (direction) == 1);
4917 /* If selected window's buffer isn't current, make it current for
4918 the moment. But don't screw up if window_scroll gets an error. */
4919 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
4921 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4922 Fset_buffer (XWINDOW (selected_window)->buffer);
4924 /* Make redisplay consider other windows than just selected_window. */
4925 ++windows_or_buffers_changed;
4928 if (NILP (n))
4929 window_scroll (selected_window, direction, 1, 0);
4930 else if (EQ (n, Qminus))
4931 window_scroll (selected_window, -direction, 1, 0);
4932 else
4934 n = Fprefix_numeric_value (n);
4935 window_scroll (selected_window, XINT (n) * direction, 0, 0);
4938 unbind_to (count, Qnil);
4941 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
4942 doc: /* Scroll text of selected window upward ARG lines.
4943 If ARG is omitted or nil, scroll upward by a near full screen.
4944 A near full screen is `next-screen-context-lines' less than a full screen.
4945 Negative ARG means scroll downward.
4946 If ARG is the atom `-', scroll downward by nearly full screen.
4947 When calling from a program, supply as argument a number, nil, or `-'. */)
4948 (Lisp_Object arg)
4950 scroll_command (arg, 1);
4951 return Qnil;
4954 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
4955 doc: /* Scroll text of selected window down ARG lines.
4956 If ARG is omitted or nil, scroll down by a near full screen.
4957 A near full screen is `next-screen-context-lines' less than a full screen.
4958 Negative ARG means scroll upward.
4959 If ARG is the atom `-', scroll upward by nearly full screen.
4960 When calling from a program, supply as argument a number, nil, or `-'. */)
4961 (Lisp_Object arg)
4963 scroll_command (arg, -1);
4964 return Qnil;
4967 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
4968 doc: /* Return the other window for \"other window scroll\" commands.
4969 If `other-window-scroll-buffer' is non-nil, a window
4970 showing that buffer is used.
4971 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4972 specifies the window. This takes precedence over
4973 `other-window-scroll-buffer'. */)
4974 (void)
4976 Lisp_Object window;
4978 if (MINI_WINDOW_P (XWINDOW (selected_window))
4979 && !NILP (Vminibuf_scroll_window))
4980 window = Vminibuf_scroll_window;
4981 /* If buffer is specified, scroll that buffer. */
4982 else if (!NILP (Vother_window_scroll_buffer))
4984 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
4985 if (NILP (window))
4986 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
4988 else
4990 /* Nothing specified; look for a neighboring window on the same
4991 frame. */
4992 window = Fnext_window (selected_window, Qnil, Qnil);
4994 if (EQ (window, selected_window))
4995 /* That didn't get us anywhere; look for a window on another
4996 visible frame. */
4998 window = Fnext_window (window, Qnil, Qt);
4999 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
5000 && ! EQ (window, selected_window));
5003 CHECK_LIVE_WINDOW (window);
5005 if (EQ (window, selected_window))
5006 error ("There is no other window");
5008 return window;
5011 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
5012 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5013 A near full screen is `next-screen-context-lines' less than a full screen.
5014 The next window is the one below the current one; or the one at the top
5015 if the current one is at the bottom. Negative ARG means scroll downward.
5016 If ARG is the atom `-', scroll downward by nearly full screen.
5017 When calling from a program, supply as argument a number, nil, or `-'.
5019 If `other-window-scroll-buffer' is non-nil, scroll the window
5020 showing that buffer, popping the buffer up if necessary.
5021 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5022 specifies the window to scroll. This takes precedence over
5023 `other-window-scroll-buffer'. */)
5024 (Lisp_Object arg)
5026 Lisp_Object window;
5027 struct window *w;
5028 ptrdiff_t count = SPECPDL_INDEX ();
5030 window = Fother_window_for_scrolling ();
5031 w = XWINDOW (window);
5033 /* Don't screw up if window_scroll gets an error. */
5034 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5035 ++windows_or_buffers_changed;
5037 Fset_buffer (w->buffer);
5038 SET_PT (marker_position (w->pointm));
5040 if (NILP (arg))
5041 window_scroll (window, 1, 1, 1);
5042 else if (EQ (arg, Qminus))
5043 window_scroll (window, -1, 1, 1);
5044 else
5046 if (CONSP (arg))
5047 arg = XCAR (arg);
5048 CHECK_NUMBER (arg);
5049 window_scroll (window, XINT (arg), 0, 1);
5052 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5053 unbind_to (count, Qnil);
5055 return Qnil;
5058 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5059 doc: /* Scroll selected window display ARG columns left.
5060 Default for ARG is window width minus 2.
5061 Value is the total amount of leftward horizontal scrolling in
5062 effect after the change.
5063 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5064 lower bound for automatic scrolling, i.e. automatic scrolling
5065 will not scroll a window to a column less than the value returned
5066 by this function. This happens in an interactive call. */)
5067 (register Lisp_Object arg, Lisp_Object set_minimum)
5069 struct window *w = XWINDOW (selected_window);
5070 EMACS_INT requested_arg = (NILP (arg)
5071 ? window_body_cols (w) - 2
5072 : XINT (Fprefix_numeric_value (arg)));
5073 Lisp_Object result = set_window_hscroll (w, w->hscroll + requested_arg);
5075 if (!NILP (set_minimum))
5076 w->min_hscroll = w->hscroll;
5078 return result;
5081 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5082 doc: /* Scroll selected window display ARG columns right.
5083 Default for ARG is window width minus 2.
5084 Value is the total amount of leftward horizontal scrolling in
5085 effect after the change.
5086 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5087 lower bound for automatic scrolling, i.e. automatic scrolling
5088 will not scroll a window to a column less than the value returned
5089 by this function. This happens in an interactive call. */)
5090 (register Lisp_Object arg, Lisp_Object set_minimum)
5092 struct window *w = XWINDOW (selected_window);
5093 EMACS_INT requested_arg = (NILP (arg)
5094 ? window_body_cols (w) - 2
5095 : XINT (Fprefix_numeric_value (arg)));
5096 Lisp_Object result = set_window_hscroll (w, w->hscroll - requested_arg);
5098 if (!NILP (set_minimum))
5099 w->min_hscroll = w->hscroll;
5101 return result;
5104 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5105 doc: /* Return the window which was selected when entering the minibuffer.
5106 Returns nil, if selected window is not a minibuffer window. */)
5107 (void)
5109 if (minibuf_level > 0
5110 && MINI_WINDOW_P (XWINDOW (selected_window))
5111 && WINDOW_LIVE_P (minibuf_selected_window))
5112 return minibuf_selected_window;
5114 return Qnil;
5117 /* Value is the number of lines actually displayed in window W,
5118 as opposed to its height. */
5120 static int
5121 displayed_window_lines (struct window *w)
5123 struct it it;
5124 struct text_pos start;
5125 int height = window_box_height (w);
5126 struct buffer *old_buffer;
5127 int bottom_y;
5128 void *itdata = NULL;
5130 if (XBUFFER (w->buffer) != current_buffer)
5132 old_buffer = current_buffer;
5133 set_buffer_internal (XBUFFER (w->buffer));
5135 else
5136 old_buffer = NULL;
5138 /* In case W->start is out of the accessible range, do something
5139 reasonable. This happens in Info mode when Info-scroll-down
5140 calls (recenter -1) while W->start is 1. */
5141 if (XMARKER (w->start)->charpos < BEGV)
5142 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
5143 else if (XMARKER (w->start)->charpos > ZV)
5144 SET_TEXT_POS (start, ZV, ZV_BYTE);
5145 else
5146 SET_TEXT_POS_FROM_MARKER (start, w->start);
5148 itdata = bidi_shelve_cache ();
5149 start_display (&it, w, start);
5150 move_it_vertically (&it, height);
5151 bottom_y = line_bottom_y (&it);
5152 bidi_unshelve_cache (itdata, 0);
5154 /* rms: On a non-window display,
5155 the value of it.vpos at the bottom of the screen
5156 seems to be 1 larger than window_box_height (w).
5157 This kludge fixes a bug whereby (move-to-window-line -1)
5158 when ZV is on the last screen line
5159 moves to the previous screen line instead of the last one. */
5160 if (! FRAME_WINDOW_P (XFRAME (w->frame)))
5161 height++;
5163 /* Add in empty lines at the bottom of the window. */
5164 if (bottom_y < height)
5166 int uy = FRAME_LINE_HEIGHT (it.f);
5167 it.vpos += (height - bottom_y + uy - 1) / uy;
5170 if (old_buffer)
5171 set_buffer_internal (old_buffer);
5173 return it.vpos;
5177 DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
5178 doc: /* Center point in selected window and maybe redisplay frame.
5179 With prefix argument ARG, recenter putting point on screen line ARG
5180 relative to the selected window. If ARG is negative, it counts up from the
5181 bottom of the window. (ARG should be less than the height of the window.)
5183 If ARG is omitted or nil, then recenter with point on the middle line of
5184 the selected window; if the variable `recenter-redisplay' is non-nil,
5185 also erase the entire frame and redraw it (when `auto-resize-tool-bars'
5186 is set to `grow-only', this resets the tool-bar's height to the minimum
5187 height needed); if `recenter-redisplay' has the special value `tty',
5188 then only tty frames are redrawn.
5190 Just C-u as prefix means put point in the center of the window
5191 and redisplay normally--don't erase and redraw the frame. */)
5192 (register Lisp_Object arg)
5194 struct window *w = XWINDOW (selected_window);
5195 struct buffer *buf = XBUFFER (w->buffer);
5196 struct buffer *obuf = current_buffer;
5197 int center_p = 0;
5198 ptrdiff_t charpos, bytepos;
5199 EMACS_INT iarg IF_LINT (= 0);
5200 int this_scroll_margin;
5202 /* If redisplay is suppressed due to an error, try again. */
5203 obuf->display_error_modiff = 0;
5205 if (NILP (arg))
5207 if (!NILP (Vrecenter_redisplay)
5208 && (!EQ (Vrecenter_redisplay, Qtty)
5209 || !NILP (Ftty_type (selected_frame))))
5211 ptrdiff_t i;
5213 /* Invalidate pixel data calculated for all compositions. */
5214 for (i = 0; i < n_compositions; i++)
5215 composition_table[i]->font = NULL;
5217 WINDOW_XFRAME (w)->minimize_tool_bar_window_p = 1;
5219 Fredraw_frame (WINDOW_FRAME (w));
5220 SET_FRAME_GARBAGED (WINDOW_XFRAME (w));
5223 center_p = 1;
5225 else if (CONSP (arg)) /* Just C-u. */
5226 center_p = 1;
5227 else
5229 arg = Fprefix_numeric_value (arg);
5230 CHECK_NUMBER (arg);
5231 iarg = XINT (arg);
5234 set_buffer_internal (buf);
5236 /* Do this after making BUF current
5237 in case scroll_margin is buffer-local. */
5238 this_scroll_margin =
5239 max (0, min (scroll_margin, XFASTINT (w->total_lines) / 4));
5241 /* Handle centering on a graphical frame specially. Such frames can
5242 have variable-height lines and centering point on the basis of
5243 line counts would lead to strange effects. */
5244 if (FRAME_WINDOW_P (XFRAME (w->frame)))
5246 if (center_p)
5248 struct it it;
5249 struct text_pos pt;
5250 void *itdata = bidi_shelve_cache ();
5252 SET_TEXT_POS (pt, PT, PT_BYTE);
5253 start_display (&it, w, pt);
5254 move_it_vertically_backward (&it, window_box_height (w) / 2);
5255 charpos = IT_CHARPOS (it);
5256 bytepos = IT_BYTEPOS (it);
5257 bidi_unshelve_cache (itdata, 0);
5259 else if (iarg < 0)
5261 struct it it;
5262 struct text_pos pt;
5263 ptrdiff_t nlines = min (PTRDIFF_MAX, -iarg);
5264 int extra_line_spacing;
5265 int h = window_box_height (w);
5266 void *itdata = bidi_shelve_cache ();
5268 iarg = - max (-iarg, this_scroll_margin);
5270 SET_TEXT_POS (pt, PT, PT_BYTE);
5271 start_display (&it, w, pt);
5273 /* Be sure we have the exact height of the full line containing PT. */
5274 move_it_by_lines (&it, 0);
5276 /* The amount of pixels we have to move back is the window
5277 height minus what's displayed in the line containing PT,
5278 and the lines below. */
5279 it.current_y = 0;
5280 it.vpos = 0;
5281 move_it_by_lines (&it, nlines);
5283 if (it.vpos == nlines)
5284 h -= it.current_y;
5285 else
5287 /* Last line has no newline */
5288 h -= line_bottom_y (&it);
5289 it.vpos++;
5292 /* Don't reserve space for extra line spacing of last line. */
5293 extra_line_spacing = it.max_extra_line_spacing;
5295 /* If we can't move down NLINES lines because we hit
5296 the end of the buffer, count in some empty lines. */
5297 if (it.vpos < nlines)
5299 nlines -= it.vpos;
5300 extra_line_spacing = it.extra_line_spacing;
5301 h -= nlines * (FRAME_LINE_HEIGHT (it.f) + extra_line_spacing);
5303 if (h <= 0)
5305 bidi_unshelve_cache (itdata, 0);
5306 return Qnil;
5309 /* Now find the new top line (starting position) of the window. */
5310 start_display (&it, w, pt);
5311 it.current_y = 0;
5312 move_it_vertically_backward (&it, h);
5314 /* If extra line spacing is present, we may move too far
5315 back. This causes the last line to be only partially
5316 visible (which triggers redisplay to recenter that line
5317 in the middle), so move forward.
5318 But ignore extra line spacing on last line, as it is not
5319 considered to be part of the visible height of the line.
5321 h += extra_line_spacing;
5322 while (-it.current_y > h)
5323 move_it_by_lines (&it, 1);
5325 charpos = IT_CHARPOS (it);
5326 bytepos = IT_BYTEPOS (it);
5328 bidi_unshelve_cache (itdata, 0);
5330 else
5332 struct position pos;
5334 iarg = max (iarg, this_scroll_margin);
5336 pos = *vmotion (PT, -iarg, w);
5337 charpos = pos.bufpos;
5338 bytepos = pos.bytepos;
5341 else
5343 struct position pos;
5344 int ht = window_internal_height (w);
5346 if (center_p)
5347 iarg = ht / 2;
5348 else if (iarg < 0)
5349 iarg += ht;
5351 /* Don't let it get into the margin at either top or bottom. */
5352 iarg = max (iarg, this_scroll_margin);
5353 iarg = min (iarg, ht - this_scroll_margin - 1);
5355 pos = *vmotion (PT, - iarg, w);
5356 charpos = pos.bufpos;
5357 bytepos = pos.bytepos;
5360 /* Set the new window start. */
5361 set_marker_both (w->start, w->buffer, charpos, bytepos);
5362 wset_window_end_valid (w, Qnil);
5364 w->optional_new_start = 1;
5366 w->start_at_line_beg = (bytepos == BEGV_BYTE ||
5367 FETCH_BYTE (bytepos - 1) == '\n');
5369 set_buffer_internal (obuf);
5370 return Qnil;
5373 DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5374 0, 1, 0,
5375 doc: /* Return the height in lines of the text display area of WINDOW.
5376 WINDOW must be a live window and defaults to the selected one.
5378 The returned height does not include the mode line, any header line,
5379 nor any partial-height lines at the bottom of the text area. */)
5380 (Lisp_Object window)
5382 struct window *w = decode_live_window (window);
5383 int pixel_height = window_box_height (w);
5384 int line_height = pixel_height / FRAME_LINE_HEIGHT (XFRAME (w->frame));
5385 return make_number (line_height);
5390 DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
5391 1, 1, "P",
5392 doc: /* Position point relative to window.
5393 ARG nil means position point at center of window.
5394 Else, ARG specifies vertical position within the window;
5395 zero means top of window, negative means relative to bottom of window. */)
5396 (Lisp_Object arg)
5398 struct window *w = XWINDOW (selected_window);
5399 int lines, start;
5400 Lisp_Object window;
5401 #if 0
5402 int this_scroll_margin;
5403 #endif
5405 if (!(BUFFERP (w->buffer)
5406 && XBUFFER (w->buffer) == current_buffer))
5407 /* This test is needed to make sure PT/PT_BYTE make sense in w->buffer
5408 when passed below to set_marker_both. */
5409 error ("move-to-window-line called from unrelated buffer");
5411 window = selected_window;
5412 start = marker_position (w->start);
5413 if (start < BEGV || start > ZV)
5415 int height = window_internal_height (w);
5416 Fvertical_motion (make_number (- (height / 2)), window);
5417 set_marker_both (w->start, w->buffer, PT, PT_BYTE);
5418 w->start_at_line_beg = !NILP (Fbolp ());
5419 w->force_start = 1;
5421 else
5422 Fgoto_char (w->start);
5424 lines = displayed_window_lines (w);
5426 #if 0
5427 this_scroll_margin = max (0, min (scroll_margin, lines / 4));
5428 #endif
5430 if (NILP (arg))
5431 XSETFASTINT (arg, lines / 2);
5432 else
5434 EMACS_INT iarg = XINT (Fprefix_numeric_value (arg));
5436 if (iarg < 0)
5437 iarg = iarg + lines;
5439 #if 0 /* This code would prevent move-to-window-line from moving point
5440 to a place inside the scroll margins (which would cause the
5441 next redisplay to scroll). I wrote this code, but then concluded
5442 it is probably better not to install it. However, it is here
5443 inside #if 0 so as not to lose it. -- rms. */
5445 /* Don't let it get into the margin at either top or bottom. */
5446 iarg = max (iarg, this_scroll_margin);
5447 iarg = min (iarg, lines - this_scroll_margin - 1);
5448 #endif
5450 arg = make_number (iarg);
5453 /* Skip past a partially visible first line. */
5454 if (w->vscroll)
5455 XSETINT (arg, XINT (arg) + 1);
5457 return Fvertical_motion (arg, window);
5462 /***********************************************************************
5463 Window Configuration
5464 ***********************************************************************/
5466 struct save_window_data
5468 struct vectorlike_header header;
5469 Lisp_Object selected_frame;
5470 Lisp_Object current_window;
5471 Lisp_Object current_buffer;
5472 Lisp_Object minibuf_scroll_window;
5473 Lisp_Object minibuf_selected_window;
5474 Lisp_Object root_window;
5475 Lisp_Object focus_frame;
5476 /* A vector, each of whose elements is a struct saved_window
5477 for one window. */
5478 Lisp_Object saved_windows;
5480 /* All fields above are traced by the GC.
5481 From `fame-cols' down, the fields are ignored by the GC. */
5483 int frame_cols, frame_lines, frame_menu_bar_lines;
5484 int frame_tool_bar_lines;
5487 /* This is saved as a Lisp_Vector */
5488 struct saved_window
5490 struct vectorlike_header header;
5492 Lisp_Object window, buffer, start, pointm, mark;
5493 Lisp_Object left_col, top_line, total_cols, total_lines;
5494 Lisp_Object normal_cols, normal_lines;
5495 Lisp_Object hscroll, min_hscroll;
5496 Lisp_Object parent, prev;
5497 Lisp_Object start_at_line_beg;
5498 Lisp_Object display_table;
5499 Lisp_Object left_margin_cols, right_margin_cols;
5500 Lisp_Object left_fringe_width, right_fringe_width, fringes_outside_margins;
5501 Lisp_Object scroll_bar_width, vertical_scroll_bar_type, dedicated;
5502 Lisp_Object combination_limit, window_parameters;
5505 #define SAVED_WINDOW_N(swv,n) \
5506 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
5508 DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
5509 doc: /* Return t if OBJECT is a window-configuration object. */)
5510 (Lisp_Object object)
5512 return WINDOW_CONFIGURATIONP (object) ? Qt : Qnil;
5515 DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
5516 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
5517 (Lisp_Object config)
5519 register struct save_window_data *data;
5520 struct Lisp_Vector *saved_windows;
5522 CHECK_WINDOW_CONFIGURATION (config);
5524 data = (struct save_window_data *) XVECTOR (config);
5525 saved_windows = XVECTOR (data->saved_windows);
5526 return XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5529 DEFUN ("set-window-configuration", Fset_window_configuration,
5530 Sset_window_configuration, 1, 1, 0,
5531 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
5532 CONFIGURATION must be a value previously returned
5533 by `current-window-configuration' (which see).
5534 If CONFIGURATION was made from a frame that is now deleted,
5535 only frame-independent values can be restored. In this case,
5536 the return value is nil. Otherwise the value is t. */)
5537 (Lisp_Object configuration)
5539 register struct save_window_data *data;
5540 struct Lisp_Vector *saved_windows;
5541 Lisp_Object new_current_buffer;
5542 Lisp_Object frame;
5543 FRAME_PTR f;
5544 ptrdiff_t old_point = -1;
5546 CHECK_WINDOW_CONFIGURATION (configuration);
5548 data = (struct save_window_data *) XVECTOR (configuration);
5549 saved_windows = XVECTOR (data->saved_windows);
5551 new_current_buffer = data->current_buffer;
5552 if (NILP (BVAR (XBUFFER (new_current_buffer), name)))
5553 new_current_buffer = Qnil;
5554 else
5556 if (XBUFFER (new_current_buffer) == current_buffer)
5557 /* The code further down "preserves point" by saving here PT in
5558 old_point and then setting it later back into PT. When the
5559 current-selected-window and the final-selected-window both show
5560 the current buffer, this suffers from the problem that the
5561 current PT is the window-point of the current-selected-window,
5562 while the final PT is the point of the final-selected-window, so
5563 this copy from one PT to the other would end up moving the
5564 window-point of the final-selected-window to the window-point of
5565 the current-selected-window. So we have to be careful which
5566 point of the current-buffer we copy into old_point. */
5567 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5568 && WINDOWP (selected_window)
5569 && EQ (XWINDOW (selected_window)->buffer, new_current_buffer)
5570 && !EQ (selected_window, data->current_window))
5571 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5572 else
5573 old_point = PT;
5574 else
5575 /* BUF_PT (XBUFFER (new_current_buffer)) gives us the position of
5576 point in new_current_buffer as of the last time this buffer was
5577 used. This can be non-deterministic since it can be changed by
5578 things like jit-lock by mere temporary selection of some random
5579 window that happens to show this buffer.
5580 So if possible we want this arbitrary choice of "which point" to
5581 be the one from the to-be-selected-window so as to prevent this
5582 window's cursor from being copied from another window. */
5583 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer)
5584 /* If current_window = selected_window, its point is in BUF_PT. */
5585 && !EQ (selected_window, data->current_window))
5586 old_point = XMARKER (XWINDOW (data->current_window)->pointm)->charpos;
5587 else
5588 old_point = BUF_PT (XBUFFER (new_current_buffer));
5591 frame = XWINDOW (SAVED_WINDOW_N (saved_windows, 0)->window)->frame;
5592 f = XFRAME (frame);
5594 /* If f is a dead frame, don't bother rebuilding its window tree.
5595 However, there is other stuff we should still try to do below. */
5596 if (FRAME_LIVE_P (f))
5598 Lisp_Object window;
5599 Lisp_Object dead_windows = Qnil;
5600 register Lisp_Object tem, par, pers;
5601 register struct window *w;
5602 register struct saved_window *p;
5603 struct window *root_window;
5604 struct window **leaf_windows;
5605 int n_leaf_windows;
5606 ptrdiff_t k;
5607 int i, n;
5609 /* If the frame has been resized since this window configuration was
5610 made, we change the frame to the size specified in the
5611 configuration, restore the configuration, and then resize it
5612 back. We keep track of the prevailing height in these variables. */
5613 int previous_frame_lines = FRAME_LINES (f);
5614 int previous_frame_cols = FRAME_COLS (f);
5615 int previous_frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
5616 int previous_frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
5618 /* Don't do this within the main loop below: This may call Lisp
5619 code and is thus potentially unsafe while input is blocked. */
5620 for (k = 0; k < saved_windows->header.size; k++)
5622 p = SAVED_WINDOW_N (saved_windows, k);
5623 window = p->window;
5624 w = XWINDOW (window);
5625 if (!NILP (w->buffer)
5626 && !EQ (w->buffer, p->buffer)
5627 && !NILP (BVAR (XBUFFER (p->buffer), name)))
5628 /* If a window we restore gets another buffer, record the
5629 window's old buffer. */
5630 call1 (Qrecord_window_buffer, window);
5633 /* The mouse highlighting code could get screwed up
5634 if it runs during this. */
5635 BLOCK_INPUT;
5637 if (data->frame_lines != previous_frame_lines
5638 || data->frame_cols != previous_frame_cols)
5639 change_frame_size (f, data->frame_lines,
5640 data->frame_cols, 0, 0, 0);
5641 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5642 if (data->frame_menu_bar_lines
5643 != previous_frame_menu_bar_lines)
5644 x_set_menu_bar_lines (f, make_number (data->frame_menu_bar_lines),
5645 make_number (0));
5646 #ifdef HAVE_WINDOW_SYSTEM
5647 if (data->frame_tool_bar_lines
5648 != previous_frame_tool_bar_lines)
5649 x_set_tool_bar_lines (f, make_number (data->frame_tool_bar_lines),
5650 make_number (0));
5651 #endif
5652 #endif
5654 /* "Swap out" point from the selected window's buffer
5655 into the window itself. (Normally the pointm of the selected
5656 window holds garbage.) We do this now, before
5657 restoring the window contents, and prevent it from
5658 being done later on when we select a new window. */
5659 if (! NILP (XWINDOW (selected_window)->buffer))
5661 w = XWINDOW (selected_window);
5662 set_marker_both (w->pointm,
5663 w->buffer,
5664 BUF_PT (XBUFFER (w->buffer)),
5665 BUF_PT_BYTE (XBUFFER (w->buffer)));
5668 windows_or_buffers_changed++;
5669 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
5671 /* Problem: Freeing all matrices and later allocating them again
5672 is a serious redisplay flickering problem. What we would
5673 really like to do is to free only those matrices not reused
5674 below. */
5675 root_window = XWINDOW (FRAME_ROOT_WINDOW (f));
5676 leaf_windows = alloca (count_windows (root_window)
5677 * sizeof *leaf_windows);
5678 n_leaf_windows = get_leaf_windows (root_window, leaf_windows, 0);
5680 /* Kludge Alert!
5681 Mark all windows now on frame as "deleted".
5682 Restoring the new configuration "undeletes" any that are in it.
5684 Save their current buffers in their height fields, since we may
5685 need it later, if a buffer saved in the configuration is now
5686 dead. */
5687 delete_all_child_windows (FRAME_ROOT_WINDOW (f));
5689 for (k = 0; k < saved_windows->header.size; k++)
5691 p = SAVED_WINDOW_N (saved_windows, k);
5692 window = p->window;
5693 w = XWINDOW (window);
5694 wset_next (w, Qnil);
5696 if (!NILP (p->parent))
5697 wset_parent
5698 (w, SAVED_WINDOW_N (saved_windows, XFASTINT (p->parent))->window);
5699 else
5700 wset_parent (w, Qnil);
5702 if (!NILP (p->prev))
5704 wset_prev
5705 (w, SAVED_WINDOW_N (saved_windows, XFASTINT (p->prev))->window);
5706 wset_next (XWINDOW (w->prev), p->window);
5708 else
5710 wset_prev (w, Qnil);
5711 if (!NILP (w->parent))
5713 if (EQ (p->total_cols, XWINDOW (w->parent)->total_cols))
5715 wset_vchild (XWINDOW (w->parent), p->window);
5716 wset_hchild (XWINDOW (w->parent), Qnil);
5718 else
5720 wset_hchild (XWINDOW (w->parent), p->window);
5721 wset_vchild (XWINDOW (w->parent), Qnil);
5726 /* If we squirreled away the buffer in the window's height,
5727 restore it now. */
5728 if (BUFFERP (w->total_lines))
5729 wset_buffer (w, w->total_lines);
5730 wset_left_col (w, p->left_col);
5731 wset_top_line (w, p->top_line);
5732 wset_total_cols (w, p->total_cols);
5733 wset_total_lines (w, p->total_lines);
5734 wset_normal_cols (w, p->normal_cols);
5735 wset_normal_lines (w, p->normal_lines);
5736 w->hscroll = XFASTINT (p->hscroll);
5737 w->min_hscroll = XFASTINT (p->min_hscroll);
5738 wset_display_table (w, p->display_table);
5739 wset_left_margin_cols (w, p->left_margin_cols);
5740 wset_right_margin_cols (w, p->right_margin_cols);
5741 wset_left_fringe_width (w, p->left_fringe_width);
5742 wset_right_fringe_width (w, p->right_fringe_width);
5743 w->fringes_outside_margins = !NILP (p->fringes_outside_margins);
5744 wset_scroll_bar_width (w, p->scroll_bar_width);
5745 wset_vertical_scroll_bar_type (w, p->vertical_scroll_bar_type);
5746 wset_dedicated (w, p->dedicated);
5747 wset_combination_limit (w, p->combination_limit);
5748 /* Restore any window parameters that have been saved.
5749 Parameters that have not been saved are left alone. */
5750 for (tem = p->window_parameters; CONSP (tem); tem = XCDR (tem))
5752 pers = XCAR (tem);
5753 if (CONSP (pers))
5755 if (NILP (XCDR (pers)))
5757 par = Fassq (XCAR (pers), w->window_parameters);
5758 if (CONSP (par) && !NILP (XCDR (par)))
5759 /* Reset a parameter to nil if and only if it
5760 has a non-nil association. Don't make new
5761 associations. */
5762 Fsetcdr (par, Qnil);
5764 else
5765 /* Always restore a non-nil value. */
5766 Fset_window_parameter (window, XCAR (pers), XCDR (pers));
5770 w->last_modified = 0;
5771 w->last_overlay_modified = 0;
5773 /* Reinstall the saved buffer and pointers into it. */
5774 if (NILP (p->buffer))
5775 /* An internal window. */
5776 wset_buffer (w, p->buffer);
5777 else if (!NILP (BVAR (XBUFFER (p->buffer), name)))
5778 /* If saved buffer is alive, install it. */
5780 wset_buffer (w, p->buffer);
5781 w->start_at_line_beg = !NILP (p->start_at_line_beg);
5782 set_marker_restricted (w->start, p->start, w->buffer);
5783 set_marker_restricted (w->pointm, p->pointm,
5784 w->buffer);
5785 Fset_marker (BVAR (XBUFFER (w->buffer), mark),
5786 p->mark, w->buffer);
5788 /* As documented in Fcurrent_window_configuration, don't
5789 restore the location of point in the buffer which was
5790 current when the window configuration was recorded. */
5791 if (!EQ (p->buffer, new_current_buffer)
5792 && XBUFFER (p->buffer) == current_buffer)
5793 Fgoto_char (w->pointm);
5795 else if (!NILP (w->buffer)
5796 && !NILP (BVAR (XBUFFER (w->buffer), name)))
5797 /* Keep window's old buffer; make sure the markers are
5798 real. */
5800 /* Set window markers at start of visible range. */
5801 if (XMARKER (w->start)->buffer == 0)
5802 set_marker_restricted (w->start, make_number (0),
5803 w->buffer);
5804 if (XMARKER (w->pointm)->buffer == 0)
5805 set_marker_restricted_both
5806 (w->pointm, w->buffer,
5807 BUF_PT (XBUFFER (w->buffer)),
5808 BUF_PT_BYTE (XBUFFER (w->buffer)));
5809 w->start_at_line_beg = 1;
5811 else
5812 /* Window has no live buffer, get one. */
5814 /* Get the buffer via other_buffer_safely in order to
5815 avoid showing an unimportant buffer and, if necessary, to
5816 recreate *scratch* in the course (part of Juanma's bs-show
5817 scenario from March 2011). */
5818 wset_buffer (w, other_buffer_safely (Fcurrent_buffer ()));
5819 /* This will set the markers to beginning of visible
5820 range. */
5821 set_marker_restricted (w->start,
5822 make_number (0), w->buffer);
5823 set_marker_restricted (w->pointm,
5824 make_number (0), w->buffer);
5825 w->start_at_line_beg = 1;
5826 if (!NILP (w->dedicated))
5827 /* Record this window as dead. */
5828 dead_windows = Fcons (window, dead_windows);
5829 /* Make sure window is no more dedicated. */
5830 wset_dedicated (w, Qnil);
5834 fset_root_window (f, data->root_window);
5835 /* Arrange *not* to restore point in the buffer that was
5836 current when the window configuration was saved. */
5837 if (EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
5838 set_marker_restricted (XWINDOW (data->current_window)->pointm,
5839 make_number (old_point),
5840 XWINDOW (data->current_window)->buffer);
5842 /* In the following call to `select-window', prevent "swapping out
5843 point" in the old selected window using the buffer that has
5844 been restored into it. We already swapped out that point from
5845 that window's old buffer. */
5846 select_window (data->current_window, Qnil, 1);
5847 BVAR (XBUFFER (XWINDOW (selected_window)->buffer), last_selected_window)
5848 = selected_window;
5850 if (NILP (data->focus_frame)
5851 || (FRAMEP (data->focus_frame)
5852 && FRAME_LIVE_P (XFRAME (data->focus_frame))))
5853 Fredirect_frame_focus (frame, data->focus_frame);
5855 /* Set the screen height to the value it had before this function. */
5856 if (previous_frame_lines != FRAME_LINES (f)
5857 || previous_frame_cols != FRAME_COLS (f))
5858 change_frame_size (f, previous_frame_lines, previous_frame_cols,
5859 0, 0, 0);
5860 #if defined (HAVE_WINDOW_SYSTEM) || defined (MSDOS)
5861 if (previous_frame_menu_bar_lines != FRAME_MENU_BAR_LINES (f))
5862 x_set_menu_bar_lines (f, make_number (previous_frame_menu_bar_lines),
5863 make_number (0));
5864 #ifdef HAVE_WINDOW_SYSTEM
5865 if (previous_frame_tool_bar_lines != FRAME_TOOL_BAR_LINES (f))
5866 x_set_tool_bar_lines (f, make_number (previous_frame_tool_bar_lines),
5867 make_number (0));
5868 #endif
5869 #endif
5871 /* Now, free glyph matrices in windows that were not reused. */
5872 for (i = n = 0; i < n_leaf_windows; ++i)
5874 if (NILP (leaf_windows[i]->buffer))
5876 /* Assert it's not reused as a combination. */
5877 eassert (NILP (leaf_windows[i]->hchild)
5878 && NILP (leaf_windows[i]->vchild));
5879 free_window_matrices (leaf_windows[i]);
5881 else if (EQ (leaf_windows[i]->buffer, new_current_buffer))
5882 ++n;
5885 adjust_glyphs (f);
5886 UNBLOCK_INPUT;
5888 /* Scan dead buffer windows. */
5889 for (; CONSP (dead_windows); dead_windows = XCDR (dead_windows))
5891 window = XCAR (dead_windows);
5892 if (WINDOW_LIVE_P (window) && !EQ (window, FRAME_ROOT_WINDOW (f)))
5893 delete_deletable_window (window);
5896 /* Fselect_window will have made f the selected frame, so we
5897 reselect the proper frame here. Fhandle_switch_frame will change the
5898 selected window too, but that doesn't make the call to
5899 Fselect_window above totally superfluous; it still sets f's
5900 selected window. */
5901 if (FRAME_LIVE_P (XFRAME (data->selected_frame)))
5902 do_switch_frame (data->selected_frame, 0, 0, Qnil);
5904 run_window_configuration_change_hook (f);
5907 if (!NILP (new_current_buffer))
5909 Fset_buffer (new_current_buffer);
5910 /* If the new current buffer doesn't appear in the selected
5911 window, go to its old point (see bug#12208). */
5912 if (!EQ (XWINDOW (data->current_window)->buffer, new_current_buffer))
5913 Fgoto_char (make_number (old_point));
5916 Vminibuf_scroll_window = data->minibuf_scroll_window;
5917 minibuf_selected_window = data->minibuf_selected_window;
5919 return (FRAME_LIVE_P (f) ? Qt : Qnil);
5923 /* Recursively delete all child windows reachable via the next, vchild,
5924 and hchild slots of WINDOW. */
5925 void
5926 delete_all_child_windows (Lisp_Object window)
5928 register struct window *w;
5930 w = XWINDOW (window);
5932 if (!NILP (w->next))
5933 /* Delete WINDOW's siblings (we traverse postorderly). */
5934 delete_all_child_windows (w->next);
5936 /* See Fset_window_configuration for excuse. */
5937 wset_total_lines (w, w->buffer);
5939 if (!NILP (w->vchild))
5941 delete_all_child_windows (w->vchild);
5942 wset_vchild (w, Qnil);
5944 else if (!NILP (w->hchild))
5946 delete_all_child_windows (w->hchild);
5947 wset_hchild (w, Qnil);
5949 else if (!NILP (w->buffer))
5951 unshow_buffer (w);
5952 unchain_marker (XMARKER (w->pointm));
5953 unchain_marker (XMARKER (w->start));
5954 wset_buffer (w, Qnil);
5957 Vwindow_list = Qnil;
5960 static int
5961 count_windows (register struct window *window)
5963 register int count = 1;
5964 if (!NILP (window->next))
5965 count += count_windows (XWINDOW (window->next));
5966 if (!NILP (window->vchild))
5967 count += count_windows (XWINDOW (window->vchild));
5968 if (!NILP (window->hchild))
5969 count += count_windows (XWINDOW (window->hchild));
5970 return count;
5974 /* Fill vector FLAT with leaf windows under W, starting at index I.
5975 Value is last index + 1. */
5976 static int
5977 get_leaf_windows (struct window *w, struct window **flat, int i)
5979 while (w)
5981 if (!NILP (w->hchild))
5982 i = get_leaf_windows (XWINDOW (w->hchild), flat, i);
5983 else if (!NILP (w->vchild))
5984 i = get_leaf_windows (XWINDOW (w->vchild), flat, i);
5985 else
5986 flat[i++] = w;
5988 w = NILP (w->next) ? 0 : XWINDOW (w->next);
5991 return i;
5995 /* Return a pointer to the glyph W's physical cursor is on. Value is
5996 null if W's current matrix is invalid, so that no meaningful glyph
5997 can be returned. */
5998 struct glyph *
5999 get_phys_cursor_glyph (struct window *w)
6001 struct glyph_row *row;
6002 struct glyph *glyph;
6003 int hpos = w->phys_cursor.hpos;
6005 if (!(w->phys_cursor.vpos >= 0
6006 && w->phys_cursor.vpos < w->current_matrix->nrows))
6007 return NULL;
6009 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
6010 if (!row->enabled_p)
6011 return NULL;
6013 if (w->hscroll)
6015 /* When the window is hscrolled, cursor hpos can legitimately be
6016 out of bounds, but we draw the cursor at the corresponding
6017 window margin in that case. */
6018 if (!row->reversed_p && hpos < 0)
6019 hpos = 0;
6020 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
6021 hpos = row->used[TEXT_AREA] - 1;
6024 if (row->used[TEXT_AREA] > hpos
6025 && 0 <= hpos)
6026 glyph = row->glyphs[TEXT_AREA] + hpos;
6027 else
6028 glyph = NULL;
6030 return glyph;
6034 static int
6035 save_window_save (Lisp_Object window, struct Lisp_Vector *vector, int i)
6037 register struct saved_window *p;
6038 register struct window *w;
6039 register Lisp_Object tem, pers, par;
6041 for (;!NILP (window); window = w->next)
6043 p = SAVED_WINDOW_N (vector, i);
6044 w = XWINDOW (window);
6046 wset_temslot (w, make_number (i)); i++;
6047 p->window = window;
6048 p->buffer = w->buffer;
6049 p->left_col = w->left_col;
6050 p->top_line = w->top_line;
6051 p->total_cols = w->total_cols;
6052 p->total_lines = w->total_lines;
6053 p->normal_cols = w->normal_cols;
6054 p->normal_lines = w->normal_lines;
6055 XSETFASTINT (p->hscroll, w->hscroll);
6056 XSETFASTINT (p->min_hscroll, w->min_hscroll);
6057 p->display_table = w->display_table;
6058 p->left_margin_cols = w->left_margin_cols;
6059 p->right_margin_cols = w->right_margin_cols;
6060 p->left_fringe_width = w->left_fringe_width;
6061 p->right_fringe_width = w->right_fringe_width;
6062 p->fringes_outside_margins = w->fringes_outside_margins ? Qt : Qnil;
6063 p->scroll_bar_width = w->scroll_bar_width;
6064 p->vertical_scroll_bar_type = w->vertical_scroll_bar_type;
6065 p->dedicated = w->dedicated;
6066 p->combination_limit = w->combination_limit;
6067 p->window_parameters = Qnil;
6069 if (!NILP (Vwindow_persistent_parameters))
6071 /* Run cycle detection on Vwindow_persistent_parameters. */
6072 Lisp_Object tortoise, hare;
6074 hare = tortoise = Vwindow_persistent_parameters;
6075 while (CONSP (hare))
6077 hare = XCDR (hare);
6078 if (!CONSP (hare))
6079 break;
6081 hare = XCDR (hare);
6082 tortoise = XCDR (tortoise);
6084 if (EQ (hare, tortoise))
6085 /* Reset Vwindow_persistent_parameters to Qnil. */
6087 Vwindow_persistent_parameters = Qnil;
6088 break;
6092 for (tem = Vwindow_persistent_parameters; CONSP (tem);
6093 tem = XCDR (tem))
6095 pers = XCAR (tem);
6096 /* Save values for persistent window parameters. */
6097 if (CONSP (pers) && !NILP (XCDR (pers)))
6099 par = Fassq (XCAR (pers), w->window_parameters);
6100 if (NILP (par))
6101 /* If the window has no value for the parameter,
6102 make one. */
6103 p->window_parameters = Fcons (Fcons (XCAR (pers), Qnil),
6104 p->window_parameters);
6105 else
6106 /* If the window has a value for the parameter,
6107 save it. */
6108 p->window_parameters = Fcons (Fcons (XCAR (par),
6109 XCDR (par)),
6110 p->window_parameters);
6115 if (!NILP (w->buffer))
6117 /* Save w's value of point in the window configuration. If w
6118 is the selected window, then get the value of point from
6119 the buffer; pointm is garbage in the selected window. */
6120 if (EQ (window, selected_window))
6121 p->pointm = build_marker (XBUFFER (w->buffer),
6122 BUF_PT (XBUFFER (w->buffer)),
6123 BUF_PT_BYTE (XBUFFER (w->buffer)));
6124 else
6125 p->pointm = Fcopy_marker (w->pointm, Qnil);
6126 XMARKER (p->pointm)->insertion_type
6127 = !NILP (Vwindow_point_insertion_type);
6129 p->start = Fcopy_marker (w->start, Qnil);
6130 p->start_at_line_beg = w->start_at_line_beg ? Qt : Qnil;
6132 tem = BVAR (XBUFFER (w->buffer), mark);
6133 p->mark = Fcopy_marker (tem, Qnil);
6135 else
6137 p->pointm = Qnil;
6138 p->start = Qnil;
6139 p->mark = Qnil;
6140 p->start_at_line_beg = Qnil;
6143 if (NILP (w->parent))
6144 p->parent = Qnil;
6145 else
6146 p->parent = XWINDOW (w->parent)->temslot;
6148 if (NILP (w->prev))
6149 p->prev = Qnil;
6150 else
6151 p->prev = XWINDOW (w->prev)->temslot;
6153 if (!NILP (w->vchild))
6154 i = save_window_save (w->vchild, vector, i);
6155 if (!NILP (w->hchild))
6156 i = save_window_save (w->hchild, vector, i);
6159 return i;
6162 DEFUN ("current-window-configuration", Fcurrent_window_configuration,
6163 Scurrent_window_configuration, 0, 1, 0,
6164 doc: /* Return an object representing the current window configuration of FRAME.
6165 If FRAME is nil or omitted, use the selected frame.
6166 This describes the number of windows, their sizes and current buffers,
6167 and for each displayed buffer, where display starts, and the positions of
6168 point and mark. An exception is made for point in the current buffer:
6169 its value is -not- saved.
6170 This also records the currently selected frame, and FRAME's focus
6171 redirection (see `redirect-frame-focus'). The variable
6172 `window-persistent-parameters' specifies which window parameters are
6173 saved by this function. */)
6174 (Lisp_Object frame)
6176 register Lisp_Object tem;
6177 register int n_windows;
6178 register struct save_window_data *data;
6179 register int i;
6180 FRAME_PTR f;
6182 if (NILP (frame))
6183 frame = selected_frame;
6184 CHECK_LIVE_FRAME (frame);
6185 f = XFRAME (frame);
6187 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6188 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6189 PVEC_WINDOW_CONFIGURATION);
6191 data->frame_cols = FRAME_COLS (f);
6192 data->frame_lines = FRAME_LINES (f);
6193 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6194 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6195 data->selected_frame = selected_frame;
6196 data->current_window = FRAME_SELECTED_WINDOW (f);
6197 XSETBUFFER (data->current_buffer, current_buffer);
6198 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6199 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6200 data->root_window = FRAME_ROOT_WINDOW (f);
6201 data->focus_frame = FRAME_FOCUS_FRAME (f);
6202 tem = Fmake_vector (make_number (n_windows), Qnil);
6203 data->saved_windows = tem;
6204 for (i = 0; i < n_windows; i++)
6205 ASET (tem, i,
6206 Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil));
6207 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6208 XSETWINDOW_CONFIGURATION (tem, data);
6209 return (tem);
6212 /***********************************************************************
6213 Marginal Areas
6214 ***********************************************************************/
6216 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6217 2, 3, 0,
6218 doc: /* Set width of marginal areas of window WINDOW.
6219 WINDOW must be a live window and defaults to the selected one.
6221 Second arg LEFT-WIDTH specifies the number of character cells to
6222 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6223 does the same for the right marginal area. A nil width parameter
6224 means no margin. */)
6225 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width)
6227 struct window *w = decode_live_window (window);
6229 /* Translate negative or zero widths to nil.
6230 Margins that are too wide have to be checked elsewhere. */
6232 if (!NILP (left_width))
6234 CHECK_NUMBER (left_width);
6235 if (XINT (left_width) <= 0)
6236 left_width = Qnil;
6239 if (!NILP (right_width))
6241 CHECK_NUMBER (right_width);
6242 if (XINT (right_width) <= 0)
6243 right_width = Qnil;
6246 if (!EQ (w->left_margin_cols, left_width)
6247 || !EQ (w->right_margin_cols, right_width))
6249 wset_left_margin_cols (w, left_width);
6250 wset_right_margin_cols (w, right_width);
6252 adjust_window_margins (w);
6254 ++windows_or_buffers_changed;
6255 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6258 return Qnil;
6262 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6263 0, 1, 0,
6264 doc: /* Get width of marginal areas of window WINDOW.
6265 WINDOW must be a live window and defaults to the selected one.
6267 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6268 If a marginal area does not exist, its width will be returned
6269 as nil. */)
6270 (Lisp_Object window)
6272 struct window *w = decode_live_window (window);
6273 return Fcons (w->left_margin_cols, w->right_margin_cols);
6278 /***********************************************************************
6279 Fringes
6280 ***********************************************************************/
6282 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6283 2, 4, 0,
6284 doc: /* Set the fringe widths of window WINDOW.
6285 WINDOW must be a live window and defaults to the selected one.
6287 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6288 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6289 fringe width. If a fringe width arg is nil, that means to use the
6290 frame's default fringe width. Default fringe widths can be set with
6291 the command `set-fringe-style'.
6292 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6293 outside of the display margins. By default, fringes are drawn between
6294 display marginal areas and the text area. */)
6295 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width, Lisp_Object outside_margins)
6297 struct window *w = decode_live_window (window);
6298 int outside = !NILP (outside_margins);
6300 if (!NILP (left_width))
6301 CHECK_NATNUM (left_width);
6302 if (!NILP (right_width))
6303 CHECK_NATNUM (right_width);
6305 /* Do nothing on a tty. */
6306 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6307 && (!EQ (w->left_fringe_width, left_width)
6308 || !EQ (w->right_fringe_width, right_width)
6309 || w->fringes_outside_margins != outside))
6311 wset_left_fringe_width (w, left_width);
6312 wset_right_fringe_width (w, right_width);
6313 w->fringes_outside_margins = outside;
6315 adjust_window_margins (w);
6317 clear_glyph_matrix (w->current_matrix);
6318 wset_window_end_valid (w, Qnil);
6320 ++windows_or_buffers_changed;
6321 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6324 return Qnil;
6328 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6329 0, 1, 0,
6330 doc: /* Get width of fringes of window WINDOW.
6331 WINDOW must be a live window and defaults to the selected one.
6333 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6334 (Lisp_Object window)
6336 struct window *w = decode_live_window (window);
6338 return Fcons (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6339 Fcons (make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6340 Fcons ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6341 ? Qt : Qnil), Qnil)));
6346 /***********************************************************************
6347 Scroll bars
6348 ***********************************************************************/
6350 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars,
6351 Sset_window_scroll_bars, 2, 4, 0,
6352 doc: /* Set width and type of scroll bars of window WINDOW.
6353 WINDOW must be a live window and defaults to the selected one.
6355 Second parameter WIDTH specifies the pixel width for the scroll bar;
6356 this is automatically adjusted to a multiple of the frame column width.
6357 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6358 bar: left, right, or nil.
6359 If WIDTH is nil, use the frame's scroll-bar width.
6360 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6361 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6362 (Lisp_Object window, Lisp_Object width, Lisp_Object vertical_type, Lisp_Object horizontal_type)
6364 struct window *w = decode_live_window (window);
6366 if (!NILP (width))
6368 CHECK_RANGED_INTEGER (width, 0, INT_MAX);
6370 if (XINT (width) == 0)
6371 vertical_type = Qnil;
6374 if (!(NILP (vertical_type)
6375 || EQ (vertical_type, Qleft)
6376 || EQ (vertical_type, Qright)
6377 || EQ (vertical_type, Qt)))
6378 error ("Invalid type of vertical scroll bar");
6380 if (!EQ (w->scroll_bar_width, width)
6381 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6383 wset_scroll_bar_width (w, width);
6384 wset_vertical_scroll_bar_type (w, vertical_type);
6386 adjust_window_margins (w);
6388 clear_glyph_matrix (w->current_matrix);
6389 wset_window_end_valid (w, Qnil);
6391 ++windows_or_buffers_changed;
6392 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6395 return Qnil;
6399 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6400 0, 1, 0,
6401 doc: /* Get width and type of scroll bars of window WINDOW.
6402 WINDOW must be a live window and defaults to the selected one.
6404 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6405 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6406 value. */)
6407 (Lisp_Object window)
6409 struct window *w = decode_live_window (window);
6410 return Fcons (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6411 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6412 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6413 Fcons (make_number (WINDOW_SCROLL_BAR_COLS (w)),
6414 Fcons (w->vertical_scroll_bar_type,
6415 Fcons (Qnil, Qnil))));
6420 /***********************************************************************
6421 Smooth scrolling
6422 ***********************************************************************/
6424 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6425 doc: /* Return the amount by which WINDOW is scrolled vertically.
6426 If WINDOW is omitted or nil, it defaults to the selected window.
6427 Normally, value is a multiple of the canonical character height of WINDOW;
6428 optional second arg PIXELS-P means value is measured in pixels. */)
6429 (Lisp_Object window, Lisp_Object pixels_p)
6431 Lisp_Object result;
6432 struct frame *f;
6433 struct window *w;
6435 if (NILP (window))
6436 window = selected_window;
6437 else
6438 CHECK_WINDOW (window);
6439 w = XWINDOW (window);
6440 f = XFRAME (w->frame);
6442 if (FRAME_WINDOW_P (f))
6443 result = (NILP (pixels_p)
6444 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
6445 : make_number (-w->vscroll));
6446 else
6447 result = make_number (0);
6448 return result;
6452 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
6453 2, 3, 0,
6454 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6455 WINDOW nil means use the selected window. Normally, VSCROLL is a
6456 non-negative multiple of the canonical character height of WINDOW;
6457 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6458 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6459 corresponds to an integral number of pixels. The return value is the
6460 result of this rounding.
6461 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6462 (Lisp_Object window, Lisp_Object vscroll, Lisp_Object pixels_p)
6464 struct window *w;
6465 struct frame *f;
6467 if (NILP (window))
6468 window = selected_window;
6469 else
6470 CHECK_WINDOW (window);
6471 CHECK_NUMBER_OR_FLOAT (vscroll);
6473 w = XWINDOW (window);
6474 f = XFRAME (w->frame);
6476 if (FRAME_WINDOW_P (f))
6478 int old_dy = w->vscroll;
6480 w->vscroll = - (NILP (pixels_p)
6481 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6482 : XFLOATINT (vscroll));
6483 w->vscroll = min (w->vscroll, 0);
6485 if (w->vscroll != old_dy)
6487 /* Adjust glyph matrix of the frame if the virtual display
6488 area becomes larger than before. */
6489 if (w->vscroll < 0 && w->vscroll < old_dy)
6490 adjust_glyphs (f);
6492 /* Prevent redisplay shortcuts. */
6493 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
6497 return Fwindow_vscroll (window, pixels_p);
6501 /* Call FN for all leaf windows on frame F. FN is called with the
6502 first argument being a pointer to the leaf window, and with
6503 additional argument USER_DATA. Stops when FN returns 0. */
6505 static void
6506 foreach_window (struct frame *f, int (*fn) (struct window *, void *),
6507 void *user_data)
6509 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6510 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6511 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6515 /* Helper function for foreach_window. Call FN for all leaf windows
6516 reachable from W. FN is called with the first argument being a
6517 pointer to the leaf window, and with additional argument USER_DATA.
6518 Stop when FN returns 0. Value is 0 if stopped by FN. */
6520 static int
6521 foreach_window_1 (struct window *w, int (*fn) (struct window *, void *), void *user_data)
6523 int cont;
6525 for (cont = 1; w && cont;)
6527 if (!NILP (w->hchild))
6528 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6529 else if (!NILP (w->vchild))
6530 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6531 else
6532 cont = fn (w, user_data);
6534 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6537 return cont;
6541 /* Freeze or unfreeze the window start of W unless it is a
6542 mini-window or the selected window. FREEZE_P non-null means freeze
6543 the window start. */
6545 static int
6546 freeze_window_start (struct window *w, void *freeze_p)
6548 if (MINI_WINDOW_P (w)
6549 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6550 && (w == XWINDOW (selected_window)
6551 || (MINI_WINDOW_P (XWINDOW (selected_window))
6552 && ! NILP (Vminibuf_scroll_window)
6553 && w == XWINDOW (Vminibuf_scroll_window)))))
6554 freeze_p = NULL;
6556 w->frozen_window_start_p = freeze_p != NULL;
6557 return 1;
6561 /* Freeze or unfreeze the window starts of all leaf windows on frame
6562 F, except the selected window and a mini-window. FREEZE_P non-zero
6563 means freeze the window start. */
6565 void
6566 freeze_window_starts (struct frame *f, int freeze_p)
6568 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6572 /***********************************************************************
6573 Initialization
6574 ***********************************************************************/
6576 /* Return 1 if window configurations CONFIGURATION1 and CONFIGURATION2
6577 describe the same state of affairs. This is used by Fequal.
6579 ignore_positions non-zero means ignore non-matching scroll positions
6580 and the like.
6582 This ignores a couple of things like the dedication status of
6583 window, combination_limit and the like. This might have to be
6584 fixed. */
6587 compare_window_configurations (Lisp_Object configuration1, Lisp_Object configuration2, int ignore_positions)
6589 register struct save_window_data *d1, *d2;
6590 struct Lisp_Vector *sws1, *sws2;
6591 ptrdiff_t i;
6593 CHECK_WINDOW_CONFIGURATION (configuration1);
6594 CHECK_WINDOW_CONFIGURATION (configuration2);
6596 d1 = (struct save_window_data *) XVECTOR (configuration1);
6597 d2 = (struct save_window_data *) XVECTOR (configuration2);
6598 sws1 = XVECTOR (d1->saved_windows);
6599 sws2 = XVECTOR (d2->saved_windows);
6601 /* Frame settings must match. */
6602 if (d1->frame_cols != d2->frame_cols
6603 || d1->frame_lines != d2->frame_lines
6604 || d1->frame_menu_bar_lines != d2->frame_menu_bar_lines
6605 || !EQ (d1->selected_frame, d2->selected_frame)
6606 || !EQ (d1->current_buffer, d2->current_buffer)
6607 || (!ignore_positions
6608 && (!EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window)
6609 || !EQ (d1->minibuf_selected_window, d2->minibuf_selected_window)))
6610 || !EQ (d1->focus_frame, d2->focus_frame)
6611 /* Verify that the two configurations have the same number of windows. */
6612 || sws1->header.size != sws2->header.size)
6613 return 0;
6615 for (i = 0; i < sws1->header.size; i++)
6617 struct saved_window *sw1, *sw2;
6619 sw1 = SAVED_WINDOW_N (sws1, i);
6620 sw2 = SAVED_WINDOW_N (sws2, i);
6622 if (
6623 /* The "current" windows in the two configurations must
6624 correspond to each other. */
6625 EQ (d1->current_window, sw1->window)
6626 != EQ (d2->current_window, sw2->window)
6627 /* Windows' buffers must match. */
6628 || !EQ (sw1->buffer, sw2->buffer)
6629 || !EQ (sw1->left_col, sw2->left_col)
6630 || !EQ (sw1->top_line, sw2->top_line)
6631 || !EQ (sw1->total_cols, sw2->total_cols)
6632 || !EQ (sw1->total_lines, sw2->total_lines)
6633 || !EQ (sw1->display_table, sw2->display_table)
6634 /* The next two disjuncts check the window structure for
6635 equality. */
6636 || !EQ (sw1->parent, sw2->parent)
6637 || !EQ (sw1->prev, sw2->prev)
6638 || (!ignore_positions
6639 && (!EQ (sw1->hscroll, sw2->hscroll)
6640 || !EQ (sw1->min_hscroll, sw2->min_hscroll)
6641 || !EQ (sw1->start_at_line_beg, sw2->start_at_line_beg)
6642 || NILP (Fequal (sw1->start, sw2->start))
6643 || NILP (Fequal (sw1->pointm, sw2->pointm))
6644 || NILP (Fequal (sw1->mark, sw2->mark))))
6645 || !EQ (sw1->left_margin_cols, sw2->left_margin_cols)
6646 || !EQ (sw1->right_margin_cols, sw2->right_margin_cols)
6647 || !EQ (sw1->left_fringe_width, sw2->left_fringe_width)
6648 || !EQ (sw1->right_fringe_width, sw2->right_fringe_width)
6649 || !EQ (sw1->fringes_outside_margins, sw2->fringes_outside_margins)
6650 || !EQ (sw1->scroll_bar_width, sw2->scroll_bar_width)
6651 || !EQ (sw1->vertical_scroll_bar_type, sw2->vertical_scroll_bar_type))
6652 return 0;
6655 return 1;
6658 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
6659 Scompare_window_configurations, 2, 2, 0,
6660 doc: /* Compare two window configurations as regards the structure of windows.
6661 This function ignores details such as the values of point and mark
6662 and scrolling positions. */)
6663 (Lisp_Object x, Lisp_Object y)
6665 if (compare_window_configurations (x, y, 1))
6666 return Qt;
6667 return Qnil;
6670 void
6671 init_window_once (void)
6673 struct frame *f = make_initial_frame ();
6674 XSETFRAME (selected_frame, f);
6675 Vterminal_frame = selected_frame;
6676 minibuf_window = f->minibuffer_window;
6677 selected_window = f->selected_window;
6678 last_nonminibuf_frame = f;
6680 window_initialized = 1;
6683 void
6684 init_window (void)
6686 Vwindow_list = Qnil;
6689 void
6690 syms_of_window (void)
6692 DEFSYM (Qscroll_up, "scroll-up");
6693 DEFSYM (Qscroll_down, "scroll-down");
6694 DEFSYM (Qscroll_command, "scroll-command");
6696 Fput (Qscroll_up, Qscroll_command, Qt);
6697 Fput (Qscroll_down, Qscroll_command, Qt);
6699 DEFSYM (Qwindow_configuration_change_hook, "window-configuration-change-hook");
6700 DEFSYM (Qwindowp, "windowp");
6701 DEFSYM (Qwindow_configuration_p, "window-configuration-p");
6702 DEFSYM (Qwindow_live_p, "window-live-p");
6703 DEFSYM (Qwindow_valid_p, "window-valid-p");
6704 DEFSYM (Qwindow_deletable_p, "window-deletable-p");
6705 DEFSYM (Qdelete_window, "delete-window");
6706 DEFSYM (Qwindow_resize_root_window, "window--resize-root-window");
6707 DEFSYM (Qwindow_resize_root_window_vertically, "window--resize-root-window-vertically");
6708 DEFSYM (Qsafe, "safe");
6709 DEFSYM (Qdisplay_buffer, "display-buffer");
6710 DEFSYM (Qreplace_buffer_in_windows, "replace-buffer-in-windows");
6711 DEFSYM (Qrecord_window_buffer, "record-window-buffer");
6712 DEFSYM (Qget_mru_window, "get-mru-window");
6713 DEFSYM (Qtemp_buffer_show_hook, "temp-buffer-show-hook");
6714 DEFSYM (Qabove, "above");
6715 DEFSYM (Qbelow, "below");
6716 DEFSYM (Qclone_of, "clone-of");
6718 staticpro (&Vwindow_list);
6720 minibuf_selected_window = Qnil;
6721 staticpro (&minibuf_selected_window);
6723 window_scroll_pixel_based_preserve_x = -1;
6724 window_scroll_pixel_based_preserve_y = -1;
6725 window_scroll_preserve_hpos = -1;
6726 window_scroll_preserve_vpos = -1;
6728 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function,
6729 doc: /* Non-nil means call as function to display a help buffer.
6730 The function is called with one argument, the buffer to be displayed.
6731 Used by `with-output-to-temp-buffer'.
6732 If this function is used, then it must do the entire job of showing
6733 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
6734 Vtemp_buffer_show_function = Qnil;
6736 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window,
6737 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
6738 Vminibuf_scroll_window = Qnil;
6740 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows,
6741 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
6742 If the minibuffer is active, the `minibuffer-scroll-window' mode line
6743 is displayed in the `mode-line' face. */);
6744 mode_line_in_non_selected_windows = 1;
6746 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer,
6747 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
6748 Vother_window_scroll_buffer = Qnil;
6750 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p,
6751 doc: /* Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
6752 auto_window_vscroll_p = 1;
6754 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines,
6755 doc: /* Number of lines of continuity when scrolling by screenfuls. */);
6756 next_screen_context_lines = 2;
6758 DEFVAR_LISP ("scroll-preserve-screen-position",
6759 Vscroll_preserve_screen_position,
6760 doc: /* Controls if scroll commands move point to keep its screen position unchanged.
6761 A value of nil means point does not keep its screen position except
6762 at the scroll margin or window boundary respectively.
6763 A value of t means point keeps its screen position if the scroll
6764 command moved it vertically out of the window, e.g. when scrolling
6765 by full screens.
6766 Any other value means point always keeps its screen position.
6767 Scroll commands should have the `scroll-command' property
6768 on their symbols to be controlled by this variable. */);
6769 Vscroll_preserve_screen_position = Qnil;
6771 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type,
6772 doc: /* Type of marker to use for `window-point'. */);
6773 Vwindow_point_insertion_type = Qnil;
6775 DEFVAR_LISP ("window-configuration-change-hook",
6776 Vwindow_configuration_change_hook,
6777 doc: /* Functions to call when window configuration changes.
6778 The buffer-local part is run once per window, with the relevant window
6779 selected; while the global part is run only once for the modified frame,
6780 with the relevant frame selected. */);
6781 Vwindow_configuration_change_hook = Qnil;
6783 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay,
6784 doc: /* Non-nil means `recenter' redraws entire frame.
6785 If this option is non-nil, then the `recenter' command with a nil
6786 argument will redraw the entire frame; the special value `tty' causes
6787 the frame to be redrawn only if it is a tty frame. */);
6788 Vrecenter_redisplay = Qtty;
6790 DEFVAR_LISP ("window-combination-resize", Vwindow_combination_resize,
6791 doc: /* If t, resize window combinations proportionally.
6792 If this variable is nil, splitting a window gets the entire screen space
6793 for displaying the new window from the window to split. Deleting and
6794 resizing a window preferably resizes one adjacent window only.
6796 If this variable is t, splitting a window tries to get the space
6797 proportionally from all windows in the same combination. This also
6798 allows to split a window that is otherwise too small or of fixed size.
6799 Resizing and deleting a window proportionally resize all windows in the
6800 same combination.
6802 Other values are reserved for future use.
6804 This variable takes no effect if `window-combination-limit' is non-nil. */);
6805 Vwindow_combination_resize = Qnil;
6807 DEFVAR_LISP ("window-combination-limit", Vwindow_combination_limit,
6808 doc: /* If t, splitting a window makes a new parent window.
6809 If this variable is nil, splitting a window will create a new parent
6810 window only if the window has no parent window or the window shall
6811 become a combination orthogonal to the one it is part of.
6813 If this variable is t, splitting a window always creates a new parent
6814 window. If all splits behave this way, each frame's window tree is a
6815 binary tree and every window but the frame's root window has exactly one
6816 sibling.
6818 Other values are reserved for future use.
6820 The value of this variable is also assigned to the combination limit of
6821 the new parent window. The combination limit of a window can be
6822 retrieved via the function `window-combination-limit' and altered by the
6823 function `set-window-combination-limit'. */);
6824 Vwindow_combination_limit = Qnil;
6826 DEFVAR_LISP ("window-persistent-parameters", Vwindow_persistent_parameters,
6827 doc: /* Alist of persistent window parameters.
6828 This alist specifies which window parameters shall get saved by
6829 `current-window-configuration' and `window-state-get' and subsequently
6830 restored to their previous values by `set-window-configuration' and
6831 `window-state-put'.
6833 The car of each entry of this alist is the symbol specifying the
6834 parameter. The cdr is one of the following:
6836 nil means the parameter is neither saved by `window-state-get' nor by
6837 `current-window-configuration'.
6839 t means the parameter is saved by `current-window-configuration' and,
6840 provided its WRITABLE argument is nil, by `window-state-get'.
6842 The symbol `writable' means the parameter is saved unconditionally by
6843 both `current-window-configuration' and `window-state-get'. Do not use
6844 this value for parameters without read syntax (like windows or frames).
6846 Parameters not saved by `current-window-configuration' or
6847 `window-state-get' are left alone by `set-window-configuration'
6848 respectively are not installed by `window-state-put'. */);
6849 Vwindow_persistent_parameters = list1 (Fcons (Qclone_of, Qt));
6851 defsubr (&Sselected_window);
6852 defsubr (&Sminibuffer_window);
6853 defsubr (&Swindow_minibuffer_p);
6854 defsubr (&Swindowp);
6855 defsubr (&Swindow_valid_p);
6856 defsubr (&Swindow_live_p);
6857 defsubr (&Swindow_frame);
6858 defsubr (&Sframe_root_window);
6859 defsubr (&Sframe_first_window);
6860 defsubr (&Sframe_selected_window);
6861 defsubr (&Sset_frame_selected_window);
6862 defsubr (&Spos_visible_in_window_p);
6863 defsubr (&Swindow_line_height);
6864 defsubr (&Swindow_buffer);
6865 defsubr (&Swindow_parent);
6866 defsubr (&Swindow_top_child);
6867 defsubr (&Swindow_left_child);
6868 defsubr (&Swindow_next_sibling);
6869 defsubr (&Swindow_prev_sibling);
6870 defsubr (&Swindow_combination_limit);
6871 defsubr (&Sset_window_combination_limit);
6872 defsubr (&Swindow_use_time);
6873 defsubr (&Swindow_top_line);
6874 defsubr (&Swindow_left_column);
6875 defsubr (&Swindow_total_height);
6876 defsubr (&Swindow_total_width);
6877 defsubr (&Swindow_normal_size);
6878 defsubr (&Swindow_new_total);
6879 defsubr (&Swindow_new_normal);
6880 defsubr (&Sset_window_new_total);
6881 defsubr (&Sset_window_new_normal);
6882 defsubr (&Swindow_resize_apply);
6883 defsubr (&Swindow_body_height);
6884 defsubr (&Swindow_body_width);
6885 defsubr (&Swindow_hscroll);
6886 defsubr (&Sset_window_hscroll);
6887 defsubr (&Swindow_redisplay_end_trigger);
6888 defsubr (&Sset_window_redisplay_end_trigger);
6889 defsubr (&Swindow_edges);
6890 defsubr (&Swindow_pixel_edges);
6891 defsubr (&Swindow_absolute_pixel_edges);
6892 defsubr (&Swindow_inside_edges);
6893 defsubr (&Swindow_inside_pixel_edges);
6894 defsubr (&Swindow_inside_absolute_pixel_edges);
6895 defsubr (&Scoordinates_in_window_p);
6896 defsubr (&Swindow_at);
6897 defsubr (&Swindow_point);
6898 defsubr (&Swindow_start);
6899 defsubr (&Swindow_end);
6900 defsubr (&Sset_window_point);
6901 defsubr (&Sset_window_start);
6902 defsubr (&Swindow_dedicated_p);
6903 defsubr (&Sset_window_dedicated_p);
6904 defsubr (&Swindow_display_table);
6905 defsubr (&Sset_window_display_table);
6906 defsubr (&Snext_window);
6907 defsubr (&Sprevious_window);
6908 defsubr (&Sget_buffer_window);
6909 defsubr (&Sdelete_other_windows_internal);
6910 defsubr (&Sdelete_window_internal);
6911 defsubr (&Sresize_mini_window_internal);
6912 defsubr (&Sset_window_buffer);
6913 defsubr (&Srun_window_configuration_change_hook);
6914 defsubr (&Sselect_window);
6915 defsubr (&Sforce_window_update);
6916 defsubr (&Stemp_output_buffer_show);
6917 defsubr (&Ssplit_window_internal);
6918 defsubr (&Sscroll_up);
6919 defsubr (&Sscroll_down);
6920 defsubr (&Sscroll_left);
6921 defsubr (&Sscroll_right);
6922 defsubr (&Sother_window_for_scrolling);
6923 defsubr (&Sscroll_other_window);
6924 defsubr (&Sminibuffer_selected_window);
6925 defsubr (&Srecenter);
6926 defsubr (&Swindow_text_height);
6927 defsubr (&Smove_to_window_line);
6928 defsubr (&Swindow_configuration_p);
6929 defsubr (&Swindow_configuration_frame);
6930 defsubr (&Sset_window_configuration);
6931 defsubr (&Scurrent_window_configuration);
6932 defsubr (&Sset_window_margins);
6933 defsubr (&Swindow_margins);
6934 defsubr (&Sset_window_fringes);
6935 defsubr (&Swindow_fringes);
6936 defsubr (&Sset_window_scroll_bars);
6937 defsubr (&Swindow_scroll_bars);
6938 defsubr (&Swindow_vscroll);
6939 defsubr (&Sset_window_vscroll);
6940 defsubr (&Scompare_window_configurations);
6941 defsubr (&Swindow_list);
6942 defsubr (&Swindow_list_1);
6943 defsubr (&Swindow_prev_buffers);
6944 defsubr (&Sset_window_prev_buffers);
6945 defsubr (&Swindow_next_buffers);
6946 defsubr (&Sset_window_next_buffers);
6947 defsubr (&Swindow_parameters);
6948 defsubr (&Swindow_parameter);
6949 defsubr (&Sset_window_parameter);
6952 void
6953 keys_of_window (void)
6955 initial_define_key (control_x_map, '<', "scroll-left");
6956 initial_define_key (control_x_map, '>', "scroll-right");
6958 initial_define_key (global_map, Ctl ('V'), "scroll-up-command");
6959 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
6960 initial_define_key (meta_map, 'v', "scroll-down-command");