Amend to fontify /regexp/s in actions correctly.
[emacs.git] / src / window.c
bloba0ebe4b448423a932324cc5b49e9f8e35c6ee7c2
1 /* Window creation, deletion and examination for GNU Emacs.
2 Does not include redisplay.
3 Copyright (C) 1985-1987, 1993-1998, 2000-2013 Free Software
4 Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
23 #define WINDOW_INLINE EXTERN_INLINE
25 #include <stdio.h>
27 #include "lisp.h"
28 #include "character.h"
29 #include "buffer.h"
30 #include "keyboard.h"
31 #include "keymap.h"
32 #include "frame.h"
33 #include "window.h"
34 #include "commands.h"
35 #include "indent.h"
36 #include "termchar.h"
37 #include "disptab.h"
38 #include "dispextern.h"
39 #include "blockinput.h"
40 #include "intervals.h"
41 #include "termhooks.h" /* For FRAME_TERMINAL. */
43 #ifdef HAVE_X_WINDOWS
44 #include "xterm.h"
45 #endif /* HAVE_X_WINDOWS */
46 #ifdef HAVE_NTGUI
47 #include "w32term.h"
48 #endif
49 #ifdef MSDOS
50 #include "msdos.h"
51 #endif
52 #ifdef HAVE_NS
53 #include "nsterm.h"
54 #endif
56 Lisp_Object Qwindowp, Qwindow_live_p;
57 static Lisp_Object Qwindow_valid_p;
58 static Lisp_Object Qwindow_configuration_p, Qrecord_window_buffer;
59 static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
60 static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
61 static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
62 static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
63 static Lisp_Object Qsafe, Qabove, Qbelow, Qwindow_size, Qclone_of;
65 static int displayed_window_lines (struct window *);
66 static int count_windows (struct window *);
67 static int get_leaf_windows (struct window *, struct window **, int);
68 static void window_scroll (Lisp_Object, EMACS_INT, int, int);
69 static void window_scroll_pixel_based (Lisp_Object, int, int, int);
70 static void window_scroll_line_based (Lisp_Object, int, int, int);
71 static int freeze_window_start (struct window *, void *);
72 static Lisp_Object window_list (void);
73 static int add_window_to_list (struct window *, void *);
74 static int candidate_window_p (Lisp_Object, Lisp_Object, Lisp_Object,
75 Lisp_Object);
76 static Lisp_Object next_window (Lisp_Object, Lisp_Object,
77 Lisp_Object, int);
78 static void decode_next_window_args (Lisp_Object *, Lisp_Object *,
79 Lisp_Object *);
80 static void foreach_window (struct frame *,
81 int (* fn) (struct window *, void *),
82 void *);
83 static int foreach_window_1 (struct window *,
84 int (* fn) (struct window *, void *),
85 void *);
86 static Lisp_Object window_list_1 (Lisp_Object, Lisp_Object, Lisp_Object);
87 static int window_resize_check (struct window *, int);
88 static void window_resize_apply (struct window *, int);
89 static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
90 static void select_window_1 (Lisp_Object, bool);
92 /* This is the window in which the terminal's cursor should
93 be left when nothing is being done with it. This must
94 always be a leaf window, and its buffer is selected by
95 the top level editing loop at the end of each command.
97 This value is always the same as
98 FRAME_SELECTED_WINDOW (selected_frame). */
99 Lisp_Object selected_window;
101 /* A list of all windows for use by next_window and Fwindow_list.
102 Functions creating or deleting windows should invalidate this cache
103 by setting it to nil. */
104 Lisp_Object Vwindow_list;
106 /* The mini-buffer window of the selected frame.
107 Note that you cannot test for mini-bufferness of an arbitrary window
108 by comparing against this; but you can test for mini-bufferness of
109 the selected window. */
110 Lisp_Object minibuf_window;
112 /* Non-nil means it is the window whose mode line should be
113 shown as the selected window when the minibuffer is selected. */
114 Lisp_Object minibuf_selected_window;
116 /* Hook run at end of temp_output_buffer_show. */
117 static Lisp_Object Qtemp_buffer_show_hook;
119 /* Incremented for each window created. */
120 static int sequence_number;
122 /* Nonzero after init_window_once has finished. */
123 static int window_initialized;
125 /* Hook to run when window config changes. */
126 static Lisp_Object Qwindow_configuration_change_hook;
128 /* Used by the function window_scroll_pixel_based */
129 static int window_scroll_pixel_based_preserve_x;
130 static int window_scroll_pixel_based_preserve_y;
132 /* Same for window_scroll_line_based. */
133 static EMACS_INT window_scroll_preserve_hpos;
134 static EMACS_INT window_scroll_preserve_vpos;
136 /* These setters are used only in this file, so they can be private. */
137 static void
138 wset_combination_limit (struct window *w, Lisp_Object val)
140 w->combination_limit = val;
142 static void
143 wset_dedicated (struct window *w, Lisp_Object val)
145 w->dedicated = val;
147 static void
148 wset_display_table (struct window *w, Lisp_Object val)
150 w->display_table = val;
152 static void
153 wset_hchild (struct window *w, Lisp_Object val)
155 w->hchild = val;
157 static void
158 wset_left_fringe_width (struct window *w, Lisp_Object val)
160 w->left_fringe_width = val;
162 static void
163 wset_left_margin_cols (struct window *w, Lisp_Object val)
165 w->left_margin_cols = val;
167 static void
168 wset_new_normal (struct window *w, Lisp_Object val)
170 w->new_normal = val;
172 static void
173 wset_new_total (struct window *w, Lisp_Object val)
175 w->new_total = val;
177 static void
178 wset_normal_cols (struct window *w, Lisp_Object val)
180 w->normal_cols = val;
182 static void
183 wset_normal_lines (struct window *w, Lisp_Object val)
185 w->normal_lines = val;
187 static void
188 wset_parent (struct window *w, Lisp_Object val)
190 w->parent = val;
192 static void
193 wset_pointm (struct window *w, Lisp_Object val)
195 w->pointm = val;
197 static void
198 wset_right_fringe_width (struct window *w, Lisp_Object val)
200 w->right_fringe_width = val;
202 static void
203 wset_right_margin_cols (struct window *w, Lisp_Object val)
205 w->right_margin_cols = val;
207 static void
208 wset_scroll_bar_width (struct window *w, Lisp_Object val)
210 w->scroll_bar_width = val;
212 static void
213 wset_start (struct window *w, Lisp_Object val)
215 w->start = val;
217 static void
218 wset_temslot (struct window *w, Lisp_Object val)
220 w->temslot = val;
222 static void
223 wset_vchild (struct window *w, Lisp_Object val)
225 w->vchild = val;
227 static void
228 wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
230 w->vertical_scroll_bar_type = val;
232 static void
233 wset_window_parameters (struct window *w, Lisp_Object val)
235 w->window_parameters = val;
238 struct window *
239 decode_live_window (register Lisp_Object window)
241 if (NILP (window))
242 return XWINDOW (selected_window);
244 CHECK_LIVE_WINDOW (window);
245 return XWINDOW (window);
248 struct window *
249 decode_any_window (register Lisp_Object window)
251 struct window *w;
253 if (NILP (window))
254 return XWINDOW (selected_window);
256 CHECK_WINDOW (window);
257 w = XWINDOW (window);
258 return w;
261 static struct window *
262 decode_valid_window (register Lisp_Object window)
264 struct window *w;
266 if (NILP (window))
267 return XWINDOW (selected_window);
269 CHECK_VALID_WINDOW (window);
270 w = XWINDOW (window);
271 return w;
274 /* Called when W's buffer slot is changed. ARG -1 means that W is about to
275 cease its buffer, and 1 means that W is about to set up the new one. */
277 static void
278 adjust_window_count (struct window *w, int arg)
280 eassert (eabs (arg) == 1);
281 if (BUFFERP (w->buffer))
283 struct buffer *b = XBUFFER (w->buffer);
285 if (b->base_buffer)
286 b = b->base_buffer;
287 b->window_count += arg;
288 eassert (b->window_count >= 0);
289 /* Catch redisplay's attention. */
290 w->window_end_valid = 0;
294 /* Set W's buffer slot to VAL and recompute number
295 of windows showing VAL if it is a buffer. */
297 void
298 wset_buffer (struct window *w, Lisp_Object val)
300 adjust_window_count (w, -1);
301 w->buffer = val;
302 adjust_window_count (w, 1);
305 /* Build a frequently used 4-integer (X Y W H) list. */
307 static Lisp_Object
308 list4i (EMACS_INT x, EMACS_INT y, EMACS_INT w, EMACS_INT h)
310 return list4 (make_number (x), make_number (y),
311 make_number (w), make_number (h));
314 DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
315 doc: /* Return t if OBJECT is a window and nil otherwise. */)
316 (Lisp_Object object)
318 return WINDOWP (object) ? Qt : Qnil;
321 DEFUN ("window-valid-p", Fwindow_valid_p, Swindow_valid_p, 1, 1, 0,
322 doc: /* Return t if OBJECT is a valid window and nil otherwise.
323 A valid window is either a window that displays a buffer or an internal
324 window. Deleted windows are not live. */)
325 (Lisp_Object object)
327 return WINDOW_VALID_P (object) ? Qt : Qnil;
330 DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
331 doc: /* Return t if OBJECT is a live window and nil otherwise.
332 A live window is a window that displays a buffer.
333 Internal windows and deleted windows are not live. */)
334 (Lisp_Object object)
336 return WINDOW_LIVE_P (object) ? Qt : Qnil;
339 /* Frames and windows. */
340 DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 0, 1, 0,
341 doc: /* Return the frame that window WINDOW is on.
342 WINDOW must be a valid window and defaults to the selected one. */)
343 (Lisp_Object window)
345 return decode_valid_window (window)->frame;
348 DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
349 doc: /* Return the root window of FRAME-OR-WINDOW.
350 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
351 With a frame argument, return that frame's root window.
352 With a window argument, return the root window of that window's frame. */)
353 (Lisp_Object frame_or_window)
355 Lisp_Object window;
357 if (NILP (frame_or_window))
358 window = SELECTED_FRAME ()->root_window;
359 else if (WINDOW_VALID_P (frame_or_window))
360 window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
361 else
363 CHECK_LIVE_FRAME (frame_or_window);
364 window = XFRAME (frame_or_window)->root_window;
367 return window;
370 DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
371 doc: /* Return the minibuffer window for frame FRAME.
372 If FRAME is omitted or nil, it defaults to the selected frame. */)
373 (Lisp_Object frame)
375 return FRAME_MINIBUF_WINDOW (decode_live_frame (frame));
378 DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
379 Swindow_minibuffer_p, 0, 1, 0,
380 doc: /* Return non-nil if WINDOW is a minibuffer window.
381 WINDOW must be a valid window and defaults to the selected one. */)
382 (Lisp_Object window)
384 return MINI_WINDOW_P (decode_valid_window (window)) ? Qt : Qnil;
387 /* Don't move this to window.el - this must be a safe routine. */
388 DEFUN ("frame-first-window", Fframe_first_window, Sframe_first_window, 0, 1, 0,
389 doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
390 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
391 Else if FRAME-OR-WINDOW denotes a valid window, return the first window
392 of that window's frame. If FRAME-OR-WINDOW denotes a live frame, return
393 the first window of that frame. */)
394 (Lisp_Object frame_or_window)
396 Lisp_Object window;
398 if (NILP (frame_or_window))
399 window = SELECTED_FRAME ()->root_window;
400 else if (WINDOW_VALID_P (frame_or_window))
401 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
402 else
404 CHECK_LIVE_FRAME (frame_or_window);
405 window = XFRAME (frame_or_window)->root_window;
408 while (NILP (XWINDOW (window)->buffer))
410 if (! NILP (XWINDOW (window)->hchild))
411 window = XWINDOW (window)->hchild;
412 else if (! NILP (XWINDOW (window)->vchild))
413 window = XWINDOW (window)->vchild;
414 else
415 emacs_abort ();
418 return window;
421 DEFUN ("frame-selected-window", Fframe_selected_window,
422 Sframe_selected_window, 0, 1, 0,
423 doc: /* Return the selected window of FRAME-OR-WINDOW.
424 If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
425 Else if FRAME-OR-WINDOW denotes a valid window, return the selected
426 window of that window's frame. If FRAME-OR-WINDOW denotes a live frame,
427 return the selected window of that frame. */)
428 (Lisp_Object frame_or_window)
430 Lisp_Object window;
432 if (NILP (frame_or_window))
433 window = SELECTED_FRAME ()->selected_window;
434 else if (WINDOW_VALID_P (frame_or_window))
435 window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
436 else
438 CHECK_LIVE_FRAME (frame_or_window);
439 window = XFRAME (frame_or_window)->selected_window;
442 return window;
445 DEFUN ("set-frame-selected-window", Fset_frame_selected_window,
446 Sset_frame_selected_window, 2, 3, 0,
447 doc: /* Set selected window of FRAME to WINDOW.
448 FRAME must be a live frame and defaults to the selected one. If FRAME
449 is the selected frame, this makes WINDOW the selected window. Optional
450 argument NORECORD non-nil means to neither change the order of recently
451 selected windows nor the buffer list. WINDOW must denote a live window.
452 Return WINDOW. */)
453 (Lisp_Object frame, Lisp_Object window, Lisp_Object norecord)
455 if (NILP (frame))
456 frame = selected_frame;
458 CHECK_LIVE_FRAME (frame);
459 CHECK_LIVE_WINDOW (window);
461 if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
462 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
464 if (EQ (frame, selected_frame))
465 return Fselect_window (window, norecord);
466 else
468 fset_selected_window (XFRAME (frame), window);
469 return window;
473 DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
474 doc: /* Return the selected window.
475 The selected window is the window in which the standard cursor for
476 selected windows appears and to which many commands apply. */)
477 (void)
479 return selected_window;
482 int window_select_count;
484 /* If select_window is called with inhibit_point_swap non-zero it will
485 not store point of the old selected window's buffer back into that
486 window's pointm slot. This is needed by Fset_window_configuration to
487 avoid that the display routine is called with selected_window set to
488 Qnil causing a subsequent crash. */
489 static Lisp_Object
490 select_window (Lisp_Object window, Lisp_Object norecord, int inhibit_point_swap)
492 register struct window *w;
493 struct frame *sf;
495 CHECK_LIVE_WINDOW (window);
497 w = XWINDOW (window);
498 w->frozen_window_start_p = 0;
500 if (NILP (norecord))
502 w->use_time = ++window_select_count;
503 record_buffer (w->buffer);
506 /* Make the selected window's buffer current. */
507 Fset_buffer (w->buffer);
509 if (EQ (window, selected_window) && !inhibit_point_swap)
510 return window;
512 sf = SELECTED_FRAME ();
513 if (XFRAME (WINDOW_FRAME (w)) != sf)
515 fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
516 /* Use this rather than Fhandle_switch_frame
517 so that FRAME_FOCUS_FRAME is moved appropriately as we
518 move around in the state where a minibuffer in a separate
519 frame is active. */
520 Fselect_frame (WINDOW_FRAME (w), norecord);
521 /* Fselect_frame called us back so we've done all the work already. */
522 eassert (EQ (window, selected_window));
523 return window;
525 else
526 fset_selected_window (sf, window);
528 select_window_1 (window, inhibit_point_swap);
530 bset_last_selected_window (XBUFFER (w->buffer), window);
531 windows_or_buffers_changed++;
532 return window;
535 /* Select window with a minimum of fuss, i.e. don't record the change anywhere
536 (not even for redisplay's benefit), and assume that the window's frame is
537 already selected. */
538 static void
539 select_window_1 (Lisp_Object window, bool inhibit_point_swap)
541 /* Store the old selected window's buffer's point in pointm of the old
542 selected window. It belongs to that window, and when the window is
543 not selected, must be in the window. */
544 if (!inhibit_point_swap)
546 struct window *ow = XWINDOW (selected_window);
547 if (! NILP (ow->buffer))
548 set_marker_both (ow->pointm, ow->buffer,
549 BUF_PT (XBUFFER (ow->buffer)),
550 BUF_PT_BYTE (XBUFFER (ow->buffer)));
553 selected_window = window;
555 /* Go to the point recorded in the window.
556 This is important when the buffer is in more
557 than one window. It also matters when
558 redisplay_window has altered point after scrolling,
559 because it makes the change only in the window. */
561 register ptrdiff_t new_point = marker_position (XWINDOW (window)->pointm);
562 if (new_point < BEGV)
563 SET_PT (BEGV);
564 else if (new_point > ZV)
565 SET_PT (ZV);
566 else
567 SET_PT (new_point);
571 DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
572 doc: /* Select WINDOW which must be a live window.
573 Also make WINDOW's frame the selected frame and WINDOW that frame's
574 selected window. In addition, make WINDOW's buffer current and set that
575 buffer's value of `point' to the value of WINDOW's `window-point'.
576 Return WINDOW.
578 Optional second arg NORECORD non-nil means do not put this buffer at the
579 front of the buffer list and do not make this window the most recently
580 selected one.
582 Note that the main editor command loop sets the current buffer to the
583 buffer of the selected window before each command. */)
584 (register Lisp_Object window, Lisp_Object norecord)
586 return select_window (window, norecord, 0);
589 DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
590 doc: /* Return the buffer displayed in window WINDOW.
591 If WINDOW is omitted or nil, it defaults to the selected window.
592 Return nil for an internal window or a deleted window. */)
593 (Lisp_Object window)
595 return decode_any_window (window)->buffer;
598 DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
599 doc: /* Return the parent window of window WINDOW.
600 WINDOW must be a valid window and defaults to the selected one.
601 Return nil for a window with no parent (e.g. a root window). */)
602 (Lisp_Object window)
604 return decode_valid_window (window)->parent;
607 DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
608 doc: /* Return the topmost child window of window WINDOW.
609 WINDOW must be a valid window and defaults to the selected one.
610 Return nil if WINDOW is a live window (live windows have no children).
611 Return nil if WINDOW is an internal window whose children form a
612 horizontal combination. */)
613 (Lisp_Object window)
615 return decode_valid_window (window)->vchild;
618 DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
619 doc: /* Return the leftmost child window of window WINDOW.
620 WINDOW must be a valid window and defaults to the selected one.
621 Return nil if WINDOW is a live window (live windows have no children).
622 Return nil if WINDOW is an internal window whose children form a
623 vertical combination. */)
624 (Lisp_Object window)
626 return decode_valid_window (window)->hchild;
629 DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
630 doc: /* Return the next sibling window of window WINDOW.
631 WINDOW must be a valid window and defaults to the selected one.
632 Return nil if WINDOW has no next sibling. */)
633 (Lisp_Object window)
635 return decode_valid_window (window)->next;
638 DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
639 doc: /* Return the previous sibling window of window WINDOW.
640 WINDOW must be a valid window and defaults to the selected one.
641 Return nil if WINDOW has no previous sibling. */)
642 (Lisp_Object window)
644 return decode_valid_window (window)->prev;
647 DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
648 doc: /* Return combination limit of window WINDOW.
649 If the return value is nil, child windows of WINDOW can be recombined with
650 WINDOW's siblings. A return value of t means that child windows of
651 WINDOW are never \(re-)combined with WINDOW's siblings.
653 WINDOW must be a valid window. The return value is meaningful for
654 internal windows only. */)
655 (Lisp_Object window)
657 CHECK_VALID_WINDOW (window);
658 return XWINDOW (window)->combination_limit;
661 DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
662 doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
663 If LIMIT is nil, child windows of WINDOW can be recombined with WINDOW's
664 siblings. LIMIT t means that child windows of WINDOW are never
665 \(re-)combined with WINDOW's siblings. Other values are reserved for
666 future use.
668 WINDOW must be a valid window. Setting the combination limit is
669 meaningful for internal windows only. */)
670 (Lisp_Object window, Lisp_Object limit)
672 wset_combination_limit (decode_valid_window (window), limit);
673 return limit;
676 DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
677 doc: /* Return the use time of window WINDOW.
678 WINDOW must be a live window and defaults to the selected one.
679 The window with the highest use time is the most recently selected
680 one. The window with the lowest use time is the least recently
681 selected one. */)
682 (Lisp_Object window)
684 return make_number (decode_live_window (window)->use_time);
687 DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
688 doc: /* Return the total height, in lines, of window WINDOW.
689 WINDOW must be a valid window and defaults to the selected one.
691 The return value includes the mode line and header line, if any.
692 If WINDOW is an internal window, the total height is the height
693 of the screen areas spanned by its children.
695 On a graphical display, this total height is reported as an
696 integer multiple of the default character height. */)
697 (Lisp_Object window)
699 return decode_valid_window (window)->total_lines;
702 DEFUN ("window-total-width", Fwindow_total_width, Swindow_total_width, 0, 1, 0,
703 doc: /* Return the total width, in columns, of window WINDOW.
704 WINDOW must be a valid window and defaults to the selected one.
706 The return value includes any vertical dividers or scroll bars
707 belonging to WINDOW. If WINDOW is an internal window, the total width
708 is the width of the screen areas spanned by its children.
710 On a graphical display, this total width is reported as an
711 integer multiple of the default character width. */)
712 (Lisp_Object window)
714 return decode_valid_window (window)->total_cols;
717 DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
718 doc: /* Return the new total size of window WINDOW.
719 WINDOW must be a valid window and defaults to the selected one. */)
720 (Lisp_Object window)
722 return decode_valid_window (window)->new_total;
725 DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
726 doc: /* Return the normal height of window WINDOW.
727 WINDOW must be a valid window and defaults to the selected one.
728 If HORIZONTAL is non-nil, return the normal width of WINDOW. */)
729 (Lisp_Object window, Lisp_Object horizontal)
731 struct window *w = decode_valid_window (window);
733 return NILP (horizontal) ? w->normal_lines : w->normal_cols;
736 DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
737 doc: /* Return new normal size of window WINDOW.
738 WINDOW must be a valid window and defaults to the selected one. */)
739 (Lisp_Object window)
741 return decode_valid_window (window)->new_normal;
744 DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
745 doc: /* Return left column of window WINDOW.
746 This is the distance, in columns, between the left edge of WINDOW and
747 the left edge of the frame's window area. For instance, the return
748 value is 0 if there is no window to the left of WINDOW.
750 WINDOW must be a valid window and defaults to the selected one. */)
751 (Lisp_Object window)
753 return decode_valid_window (window)->left_col;
756 DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
757 doc: /* Return top line of window WINDOW.
758 This is the distance, in lines, between the top of WINDOW and the top
759 of the frame's window area. For instance, the return value is 0 if
760 there is no window above WINDOW.
762 WINDOW must be a valid window and defaults to the selected one. */)
763 (Lisp_Object window)
765 return decode_valid_window (window)->top_line;
768 /* Return the number of lines of W's body. Don't count any mode or
769 header line of W. */
771 static int
772 window_body_lines (struct window *w)
774 int height = XFASTINT (w->total_lines);
776 if (!MINI_WINDOW_P (w))
778 if (WINDOW_WANTS_MODELINE_P (w))
779 --height;
780 if (WINDOW_WANTS_HEADER_LINE_P (w))
781 --height;
784 return height;
787 /* Return the number of columns of W's body. Don't count columns
788 occupied by the scroll bar or the vertical bar separating W from its
789 right sibling. On window-systems don't count fringes or display
790 margins either. */
793 window_body_cols (struct window *w)
795 struct frame *f = XFRAME (WINDOW_FRAME (w));
796 int width = XINT (w->total_cols);
798 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
799 /* Scroll bars occupy a few columns. */
800 width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
801 else if (!FRAME_WINDOW_P (f)
802 && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
803 /* The column of `|' characters separating side-by-side windows
804 occupies one column only. */
805 width -= 1;
807 /* Display margins cannot be used for normal text. */
808 width -= WINDOW_LEFT_MARGIN_COLS (w) + WINDOW_RIGHT_MARGIN_COLS (w);
810 if (FRAME_WINDOW_P (f))
811 /* On window-systems, fringes cannot be used for normal text. */
812 width -= WINDOW_FRINGE_COLS (w);
814 return width;
817 DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 1, 0,
818 doc: /* Return the height, in lines, of WINDOW's text area.
819 WINDOW must be a live window and defaults to the selected one.
821 The returned height does not include the mode line or header line.
822 On a graphical display, the height is expressed as an integer multiple
823 of the default character height. If a line at the bottom of the text
824 area is only partially visible, that counts as a whole line; to
825 exclude partially-visible lines, use `window-text-height'. */)
826 (Lisp_Object window)
828 return make_number (window_body_lines (decode_live_window (window)));
831 DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 1, 0,
832 doc: /* Return the width, in columns, of WINDOW's text area.
833 WINDOW must be a live window and defaults to the selected one.
835 The return value does not include any vertical dividers, fringe or
836 marginal areas, or scroll bars. On a graphical display, the width is
837 expressed as an integer multiple of the default character width. */)
838 (Lisp_Object window)
840 return make_number (window_body_cols (decode_live_window (window)));
843 DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
844 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
845 WINDOW must be a live window and defaults to the selected one. */)
846 (Lisp_Object window)
848 return make_number (decode_live_window (window)->hscroll);
851 /* Set W's horizontal scroll amount to HSCROLL clipped to a reasonable
852 range, returning the new amount as a fixnum. */
853 static Lisp_Object
854 set_window_hscroll (struct window *w, EMACS_INT hscroll)
856 /* Horizontal scrolling has problems with large scroll amounts.
857 It's too slow with long lines, and even with small lines the
858 display can be messed up. For now, though, impose only the limits
859 required by the internal representation: horizontal scrolling must
860 fit in fixnum (since it's visible to Elisp) and into ptrdiff_t
861 (since it's stored in a ptrdiff_t). */
862 ptrdiff_t hscroll_max = min (MOST_POSITIVE_FIXNUM, PTRDIFF_MAX);
863 ptrdiff_t new_hscroll = clip_to_bounds (0, hscroll, hscroll_max);
865 /* Prevent redisplay shortcuts when changing the hscroll. */
866 if (w->hscroll != new_hscroll)
867 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
869 w->hscroll = new_hscroll;
870 return make_number (new_hscroll);
873 DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
874 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
875 WINDOW must be a live window and defaults to the selected one.
876 Clip the number to a reasonable value if out of range.
877 Return the new number. NCOL should be zero or positive.
879 Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
880 window so that the location of point moves off-window. */)
881 (Lisp_Object window, Lisp_Object ncol)
883 CHECK_NUMBER (ncol);
884 return set_window_hscroll (decode_live_window (window), XINT (ncol));
887 DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
888 Swindow_redisplay_end_trigger, 0, 1, 0,
889 doc: /* Return WINDOW's redisplay end trigger value.
890 WINDOW must be a live window and defaults to the selected one.
891 See `set-window-redisplay-end-trigger' for more information. */)
892 (Lisp_Object window)
894 return decode_live_window (window)->redisplay_end_trigger;
897 DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
898 Sset_window_redisplay_end_trigger, 2, 2, 0,
899 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
900 WINDOW must be a live window and defaults to the selected one. VALUE
901 should be a buffer position (typically a marker) or nil. If it is a
902 buffer position, then if redisplay in WINDOW reaches a position beyond
903 VALUE, the functions in `redisplay-end-trigger-functions' are called
904 with two arguments: WINDOW, and the end trigger value. Afterwards the
905 end-trigger value is reset to nil. */)
906 (register Lisp_Object window, Lisp_Object value)
908 wset_redisplay_end_trigger (decode_live_window (window), value);
909 return value;
912 DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
913 doc: /* Return a list of the edge coordinates of WINDOW.
914 WINDOW must be a valid window and defaults to the selected one.
916 The returned list has the form (LEFT TOP RIGHT BOTTOM). TOP and BOTTOM
917 count by lines, and LEFT and RIGHT count by columns, all relative to 0,
918 0 at top left corner of frame.
920 RIGHT is one more than the rightmost column occupied by WINDOW. BOTTOM
921 is one more than the bottommost row occupied by WINDOW. The edges
922 include the space used by WINDOW's scroll bar, display margins, fringes,
923 header line, and/or mode line. For the edges of just the text area, use
924 `window-inside-edges'. */)
925 (Lisp_Object window)
927 register struct window *w = decode_valid_window (window);
929 return list4i (WINDOW_LEFT_EDGE_COL (w), WINDOW_TOP_EDGE_LINE (w),
930 WINDOW_RIGHT_EDGE_COL (w), WINDOW_BOTTOM_EDGE_LINE (w));
933 DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
934 doc: /* Return a list of the edge pixel coordinates of WINDOW.
935 WINDOW must be a valid window and defaults to the selected one.
937 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
938 0, 0 at the top left corner of the frame.
940 RIGHT is one more than the rightmost x position occupied by WINDOW.
941 BOTTOM is one more than the bottommost y position occupied by WINDOW.
942 The pixel edges include the space used by WINDOW's scroll bar, display
943 margins, fringes, header line, and/or mode line. For the pixel edges
944 of just the text area, use `window-inside-pixel-edges'. */)
945 (Lisp_Object window)
947 register struct window *w = decode_valid_window (window);
949 return list4i (WINDOW_LEFT_EDGE_X (w), WINDOW_TOP_EDGE_Y (w),
950 WINDOW_RIGHT_EDGE_X (w), WINDOW_BOTTOM_EDGE_Y (w));
953 static void
954 calc_absolute_offset (struct window *w, int *add_x, int *add_y)
956 struct frame *f = XFRAME (w->frame);
957 *add_y = f->top_pos;
958 #ifdef FRAME_MENUBAR_HEIGHT
959 *add_y += FRAME_MENUBAR_HEIGHT (f);
960 #endif
961 #ifdef FRAME_TOOLBAR_TOP_HEIGHT
962 *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
963 #elif FRAME_TOOLBAR_HEIGHT
964 *add_y += FRAME_TOOLBAR_HEIGHT (f);
965 #endif
966 #ifdef FRAME_NS_TITLEBAR_HEIGHT
967 *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
968 #endif
969 *add_x = f->left_pos;
970 #ifdef FRAME_TOOLBAR_LEFT_WIDTH
971 *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
972 #endif
975 DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
976 Swindow_absolute_pixel_edges, 0, 1, 0,
977 doc: /* Return a list of the edge pixel coordinates of WINDOW.
978 WINDOW must be a valid window and defaults to the selected one.
980 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
981 0, 0 at the top left corner of the display.
983 RIGHT is one more than the rightmost x position occupied by WINDOW.
984 BOTTOM is one more than the bottommost y position occupied by WINDOW.
985 The pixel edges include the space used by WINDOW's scroll bar, display
986 margins, fringes, header line, and/or mode line. For the pixel edges
987 of just the text area, use `window-inside-absolute-pixel-edges'. */)
988 (Lisp_Object window)
990 register struct window *w = decode_valid_window (window);
991 int add_x, add_y;
993 calc_absolute_offset (w, &add_x, &add_y);
995 return list4i (WINDOW_LEFT_EDGE_X (w) + add_x,
996 WINDOW_TOP_EDGE_Y (w) + add_y,
997 WINDOW_RIGHT_EDGE_X (w) + add_x,
998 WINDOW_BOTTOM_EDGE_Y (w) + add_y);
1001 DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
1002 doc: /* Return a list of the edge coordinates of WINDOW.
1003 WINDOW must be a live window and defaults to the selected one.
1005 The returned list has the form (LEFT TOP RIGHT BOTTOM). TOP and BOTTOM
1006 count by lines, and LEFT and RIGHT count by columns, all relative to 0,
1007 0 at top left corner of frame.
1009 RIGHT is one more than the rightmost column of WINDOW's text area.
1010 BOTTOM is one more than the bottommost row of WINDOW's text area. The
1011 inside edges do not include the space used by the WINDOW's scroll bar,
1012 display margins, fringes, header line, and/or mode line. */)
1013 (Lisp_Object window)
1015 register struct window *w = decode_live_window (window);
1017 return list4i ((WINDOW_BOX_LEFT_EDGE_COL (w)
1018 + WINDOW_LEFT_MARGIN_COLS (w)
1019 + WINDOW_LEFT_FRINGE_COLS (w)),
1020 (WINDOW_TOP_EDGE_LINE (w)
1021 + WINDOW_HEADER_LINE_LINES (w)),
1022 (WINDOW_BOX_RIGHT_EDGE_COL (w)
1023 - WINDOW_RIGHT_MARGIN_COLS (w)
1024 - WINDOW_RIGHT_FRINGE_COLS (w)),
1025 (WINDOW_BOTTOM_EDGE_LINE (w)
1026 - WINDOW_MODE_LINE_LINES (w)));
1029 DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_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);
1044 return list4i ((WINDOW_BOX_LEFT_EDGE_X (w)
1045 + WINDOW_LEFT_MARGIN_WIDTH (w)
1046 + WINDOW_LEFT_FRINGE_WIDTH (w)),
1047 (WINDOW_TOP_EDGE_Y (w)
1048 + WINDOW_HEADER_LINE_HEIGHT (w)),
1049 (WINDOW_BOX_RIGHT_EDGE_X (w)
1050 - WINDOW_RIGHT_MARGIN_WIDTH (w)
1051 - WINDOW_RIGHT_FRINGE_WIDTH (w)),
1052 (WINDOW_BOTTOM_EDGE_Y (w)
1053 - WINDOW_MODE_LINE_HEIGHT (w)));
1056 DEFUN ("window-inside-absolute-pixel-edges",
1057 Fwindow_inside_absolute_pixel_edges,
1058 Swindow_inside_absolute_pixel_edges, 0, 1, 0,
1059 doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
1060 WINDOW must be a live window and defaults to the selected one.
1062 The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
1063 (0,0) at the top left corner of the frame's window area.
1065 RIGHT is one more than the rightmost x position of WINDOW's text area.
1066 BOTTOM is one more than the bottommost y position of WINDOW's text area.
1067 The inside edges do not include the space used by WINDOW's scroll bar,
1068 display margins, fringes, header line, and/or mode line. */)
1069 (Lisp_Object window)
1071 register struct window *w = decode_live_window (window);
1072 int add_x, add_y;
1074 calc_absolute_offset (w, &add_x, &add_y);
1076 return list4i ((WINDOW_BOX_LEFT_EDGE_X (w)
1077 + WINDOW_LEFT_MARGIN_WIDTH (w)
1078 + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
1079 (WINDOW_TOP_EDGE_Y (w)
1080 + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
1081 (WINDOW_BOX_RIGHT_EDGE_X (w)
1082 - WINDOW_RIGHT_MARGIN_WIDTH (w)
1083 - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
1084 (WINDOW_BOTTOM_EDGE_Y (w)
1085 - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
1088 /* Test if the character at column X, row Y is within window W.
1089 If it is not, return ON_NOTHING;
1090 if it is in the window's text area, return ON_TEXT;
1091 if it is on the window's modeline, return ON_MODE_LINE;
1092 if it is on the border between the window and its right sibling,
1093 return ON_VERTICAL_BORDER.
1094 if it is on a scroll bar, return ON_SCROLL_BAR.
1095 if it is on the window's top line, return ON_HEADER_LINE;
1096 if it is in left or right fringe of the window,
1097 return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
1098 if it is in the marginal area to the left/right of the window,
1099 return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
1101 X and Y are frame relative pixel coordinates. */
1103 static enum window_part
1104 coordinates_in_window (register struct window *w, int x, int y)
1106 struct frame *f = XFRAME (WINDOW_FRAME (w));
1107 enum window_part part;
1108 int ux = FRAME_COLUMN_WIDTH (f);
1109 int left_x = WINDOW_LEFT_EDGE_X (w);
1110 int right_x = WINDOW_RIGHT_EDGE_X (w);
1111 int top_y = WINDOW_TOP_EDGE_Y (w);
1112 int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
1113 /* The width of the area where the vertical line can be dragged.
1114 (Between mode lines for instance. */
1115 int grabbable_width = ux;
1116 int lmargin_width, rmargin_width, text_left, text_right;
1118 /* Outside any interesting row or column? */
1119 if (y < top_y || y >= bottom_y || x < left_x || x >= right_x)
1120 return ON_NOTHING;
1122 /* On the mode line or header line? */
1123 if ((WINDOW_WANTS_MODELINE_P (w)
1124 && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
1125 && (part = ON_MODE_LINE))
1126 || (WINDOW_WANTS_HEADER_LINE_P (w)
1127 && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
1128 && (part = ON_HEADER_LINE)))
1130 /* If it's under/over the scroll bar portion of the mode/header
1131 line, say it's on the vertical line. That's to be able to
1132 resize windows horizontally in case we're using toolkit scroll
1133 bars. Note: If scrollbars are on the left, the window that
1134 must be eventually resized is that on the left of WINDOW. */
1135 if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
1136 && !WINDOW_LEFTMOST_P (w)
1137 && eabs (x - left_x) < grabbable_width)
1138 || (!WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
1139 && !WINDOW_RIGHTMOST_P (w)
1140 && eabs (x - right_x) < grabbable_width))
1141 return ON_VERTICAL_BORDER;
1142 else
1143 return part;
1146 /* In what's below, we subtract 1 when computing right_x because we
1147 want the rightmost pixel, which is given by left_pixel+width-1. */
1148 if (w->pseudo_window_p)
1150 left_x = 0;
1151 right_x = WINDOW_TOTAL_WIDTH (w) - 1;
1153 else
1155 left_x = WINDOW_BOX_LEFT_EDGE_X (w);
1156 right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
1159 /* Outside any interesting column? */
1160 if (x < left_x || x > right_x)
1161 return ON_SCROLL_BAR;
1163 lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
1164 rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
1166 text_left = window_box_left (w, TEXT_AREA);
1167 text_right = text_left + window_box_width (w, TEXT_AREA);
1169 if (FRAME_WINDOW_P (f))
1171 if (!w->pseudo_window_p
1172 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
1173 && !WINDOW_RIGHTMOST_P (w)
1174 && (eabs (x - right_x) < grabbable_width))
1175 return ON_VERTICAL_BORDER;
1177 /* Need to say "x > right_x" rather than >=, since on character
1178 terminals, the vertical line's x coordinate is right_x. */
1179 else if (!w->pseudo_window_p
1180 && !WINDOW_RIGHTMOST_P (w)
1181 && x > right_x - ux)
1182 return ON_VERTICAL_BORDER;
1184 if (x < text_left)
1186 if (lmargin_width > 0
1187 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1188 ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
1189 : (x < left_x + lmargin_width)))
1190 return ON_LEFT_MARGIN;
1192 return ON_LEFT_FRINGE;
1195 if (x >= text_right)
1197 if (rmargin_width > 0
1198 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1199 ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
1200 : (x >= right_x - rmargin_width)))
1201 return ON_RIGHT_MARGIN;
1203 return ON_RIGHT_FRINGE;
1206 /* Everything special ruled out - must be on text area */
1207 return ON_TEXT;
1210 /* Take X is the frame-relative pixel x-coordinate, and return the
1211 x-coordinate relative to part PART of window W. */
1213 window_relative_x_coord (struct window *w, enum window_part part, int x)
1215 int left_x = (w->pseudo_window_p) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w);
1217 switch (part)
1219 case ON_TEXT:
1220 return x - window_box_left (w, TEXT_AREA);
1222 case ON_LEFT_FRINGE:
1223 return x - left_x;
1225 case ON_RIGHT_FRINGE:
1226 return x - left_x - WINDOW_LEFT_FRINGE_WIDTH (w);
1228 case ON_LEFT_MARGIN:
1229 return (x - left_x
1230 - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1231 ? WINDOW_LEFT_FRINGE_WIDTH (w) : 0));
1233 case ON_RIGHT_MARGIN:
1234 return (x + 1
1235 - ((w->pseudo_window_p)
1236 ? WINDOW_TOTAL_WIDTH (w)
1237 : WINDOW_BOX_RIGHT_EDGE_X (w))
1238 + window_box_width (w, RIGHT_MARGIN_AREA)
1239 + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1240 ? WINDOW_RIGHT_FRINGE_WIDTH (w) : 0));
1243 /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER: */
1244 return 0;
1248 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
1249 Scoordinates_in_window_p, 2, 2, 0,
1250 doc: /* Return non-nil if COORDINATES are in WINDOW.
1251 WINDOW must be a live window and defaults to the selected one.
1252 COORDINATES is a cons of the form (X . Y), X and Y being distances
1253 measured in characters from the upper-left corner of the frame.
1254 \(0 . 0) denotes the character in the upper left corner of the
1255 frame.
1256 If COORDINATES are in the text portion of WINDOW,
1257 the coordinates relative to the window are returned.
1258 If they are in the mode line of WINDOW, `mode-line' is returned.
1259 If they are in the top mode line of WINDOW, `header-line' is returned.
1260 If they are in the left fringe of WINDOW, `left-fringe' is returned.
1261 If they are in the right fringe of WINDOW, `right-fringe' is returned.
1262 If they are on the border between WINDOW and its right sibling,
1263 `vertical-line' is returned.
1264 If they are in the windows's left or right marginal areas, `left-margin'\n\
1265 or `right-margin' is returned. */)
1266 (register Lisp_Object coordinates, Lisp_Object window)
1268 struct window *w;
1269 struct frame *f;
1270 int x, y;
1271 Lisp_Object lx, ly;
1273 w = decode_live_window (window);
1274 f = XFRAME (w->frame);
1275 CHECK_CONS (coordinates);
1276 lx = Fcar (coordinates);
1277 ly = Fcdr (coordinates);
1278 CHECK_NUMBER_OR_FLOAT (lx);
1279 CHECK_NUMBER_OR_FLOAT (ly);
1280 x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
1281 y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
1283 switch (coordinates_in_window (w, x, y))
1285 case ON_NOTHING:
1286 return Qnil;
1288 case ON_TEXT:
1289 /* Convert X and Y to window relative pixel coordinates, and
1290 return the canonical char units. */
1291 x -= window_box_left (w, TEXT_AREA);
1292 y -= WINDOW_TOP_EDGE_Y (w);
1293 return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
1294 FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
1296 case ON_MODE_LINE:
1297 return Qmode_line;
1299 case ON_VERTICAL_BORDER:
1300 return Qvertical_line;
1302 case ON_HEADER_LINE:
1303 return Qheader_line;
1305 case ON_LEFT_FRINGE:
1306 return Qleft_fringe;
1308 case ON_RIGHT_FRINGE:
1309 return Qright_fringe;
1311 case ON_LEFT_MARGIN:
1312 return Qleft_margin;
1314 case ON_RIGHT_MARGIN:
1315 return Qright_margin;
1317 case ON_SCROLL_BAR:
1318 /* Historically we are supposed to return nil in this case. */
1319 return Qnil;
1321 default:
1322 emacs_abort ();
1327 /* Callback for foreach_window, used in window_from_coordinates.
1328 Check if window W contains coordinates specified by USER_DATA which
1329 is actually a pointer to a struct check_window_data CW.
1331 Check if window W contains coordinates *CW->x and *CW->y. If it
1332 does, return W in *CW->window, as Lisp_Object, and return in
1333 *CW->part the part of the window under coordinates *X,*Y. Return
1334 zero from this function to stop iterating over windows. */
1336 struct check_window_data
1338 Lisp_Object *window;
1339 int x, y;
1340 enum window_part *part;
1343 static int
1344 check_window_containing (struct window *w, void *user_data)
1346 struct check_window_data *cw = (struct check_window_data *) user_data;
1347 enum window_part found;
1348 int continue_p = 1;
1350 found = coordinates_in_window (w, cw->x, cw->y);
1351 if (found != ON_NOTHING)
1353 *cw->part = found;
1354 XSETWINDOW (*cw->window, w);
1355 continue_p = 0;
1358 return continue_p;
1362 /* Find the window containing frame-relative pixel position X/Y and
1363 return it as a Lisp_Object.
1365 If X, Y is on one of the window's special `window_part' elements,
1366 set *PART to the id of that element.
1368 If there is no window under X, Y return nil and leave *PART
1369 unmodified. TOOL_BAR_P non-zero means detect tool-bar windows.
1371 This function was previously implemented with a loop cycling over
1372 windows with Fnext_window, and starting with the frame's selected
1373 window. It turned out that this doesn't work with an
1374 implementation of next_window using Vwindow_list, because
1375 FRAME_SELECTED_WINDOW (F) is not always contained in the window
1376 tree of F when this function is called asynchronously from
1377 note_mouse_highlight. The original loop didn't terminate in this
1378 case. */
1380 Lisp_Object
1381 window_from_coordinates (struct frame *f, int x, int y,
1382 enum window_part *part, int tool_bar_p)
1384 Lisp_Object window;
1385 struct check_window_data cw;
1386 enum window_part dummy;
1388 if (part == 0)
1389 part = &dummy;
1391 window = Qnil;
1392 cw.window = &window, cw.x = x, cw.y = y; cw.part = part;
1393 foreach_window (f, check_window_containing, &cw);
1395 /* If not found above, see if it's in the tool bar window, if a tool
1396 bar exists. */
1397 if (NILP (window)
1398 && tool_bar_p
1399 && WINDOWP (f->tool_bar_window)
1400 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1401 && (coordinates_in_window (XWINDOW (f->tool_bar_window), x, y)
1402 != ON_NOTHING))
1404 *part = ON_TEXT;
1405 window = f->tool_bar_window;
1408 return window;
1411 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1412 doc: /* Return window containing coordinates X and Y on FRAME.
1413 FRAME must be a live frame and defaults to the selected one.
1414 The top left corner of the frame is considered to be row 0,
1415 column 0. */)
1416 (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
1418 struct frame *f = decode_live_frame (frame);
1420 /* Check that arguments are integers or floats. */
1421 CHECK_NUMBER_OR_FLOAT (x);
1422 CHECK_NUMBER_OR_FLOAT (y);
1424 return window_from_coordinates (f,
1425 (FRAME_PIXEL_X_FROM_CANON_X (f, x)
1426 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1427 (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
1428 + FRAME_INTERNAL_BORDER_WIDTH (f)),
1429 0, 0);
1432 DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1433 doc: /* Return current value of point in WINDOW.
1434 WINDOW must be a live window and defaults to the selected one.
1436 For a nonselected window, this is the value point would have if that
1437 window were selected.
1439 Note that, when WINDOW is selected, the value returned is the same as
1440 that returned by `point' for WINDOW's buffer. It would be more strictly
1441 correct to return the top-level value of `point', outside of any
1442 `save-excursion' forms. But that is hard to define. */)
1443 (Lisp_Object window)
1445 register struct window *w = decode_live_window (window);
1447 if (w == XWINDOW (selected_window))
1448 return make_number (BUF_PT (XBUFFER (w->buffer)));
1449 else
1450 return Fmarker_position (w->pointm);
1453 DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1454 doc: /* Return position at which display currently starts in WINDOW.
1455 WINDOW must be a live window and defaults to the selected one.
1456 This is updated by redisplay or by calling `set-window-start'. */)
1457 (Lisp_Object window)
1459 return Fmarker_position (decode_live_window (window)->start);
1462 /* This is text temporarily removed from the doc string below.
1464 This function returns nil if the position is not currently known.
1465 That happens when redisplay is preempted and doesn't finish.
1466 If in that case you want to compute where the end of the window would
1467 have been if redisplay had finished, do this:
1468 (save-excursion
1469 (goto-char (window-start window))
1470 (vertical-motion (1- (window-height window)) window)
1471 (point))") */
1473 DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1474 doc: /* Return position at which display currently ends in WINDOW.
1475 WINDOW must be a live window and defaults to the selected one.
1476 This is updated by redisplay, when it runs to completion.
1477 Simply changing the buffer text or setting `window-start'
1478 does not update this value.
1479 Return nil if there is no recorded value. (This can happen if the
1480 last redisplay of WINDOW was preempted, and did not finish.)
1481 If UPDATE is non-nil, compute the up-to-date position
1482 if it isn't already recorded. */)
1483 (Lisp_Object window, Lisp_Object update)
1485 Lisp_Object value;
1486 struct window *w = decode_live_window (window);
1487 Lisp_Object buf;
1488 struct buffer *b;
1490 buf = w->buffer;
1491 CHECK_BUFFER (buf);
1492 b = XBUFFER (buf);
1494 if (! NILP (update)
1495 && (windows_or_buffers_changed || !w->window_end_valid)
1496 && !noninteractive)
1498 struct text_pos startp;
1499 ptrdiff_t charpos = marker_position (w->start);
1500 struct it it;
1501 struct buffer *old_buffer = NULL;
1502 void *itdata = NULL;
1504 /* Cannot use Fvertical_motion because that function doesn't
1505 cope with variable-height lines. */
1506 if (b != current_buffer)
1508 old_buffer = current_buffer;
1509 set_buffer_internal (b);
1512 /* In case W->start is out of the range, use something
1513 reasonable. This situation occurred when loading a file with
1514 `-l' containing a call to `rmail' with subsequent other
1515 commands. At the end, W->start happened to be BEG, while
1516 rmail had already narrowed the buffer. */
1517 if (charpos < BEGV)
1518 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1519 else if (charpos > ZV)
1520 SET_TEXT_POS (startp, ZV, ZV_BYTE);
1521 else
1522 SET_TEXT_POS_FROM_MARKER (startp, w->start);
1524 itdata = bidi_shelve_cache ();
1525 start_display (&it, w, startp);
1526 move_it_vertically (&it, window_box_height (w));
1527 if (it.current_y < it.last_visible_y)
1528 move_it_past_eol (&it);
1529 value = make_number (IT_CHARPOS (it));
1530 bidi_unshelve_cache (itdata, 0);
1532 if (old_buffer)
1533 set_buffer_internal (old_buffer);
1535 else
1536 XSETINT (value, BUF_Z (b) - XFASTINT (w->window_end_pos));
1538 return value;
1541 DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
1542 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.
1543 WINDOW must be a live window and defaults to the selected one.
1544 Return POS. */)
1545 (Lisp_Object window, Lisp_Object pos)
1547 register struct window *w = decode_live_window (window);
1549 CHECK_NUMBER_COERCE_MARKER (pos);
1551 if (w == XWINDOW (selected_window))
1553 if (XBUFFER (w->buffer) == current_buffer)
1554 Fgoto_char (pos);
1555 else
1557 struct buffer *old_buffer = current_buffer;
1559 set_buffer_internal (XBUFFER (w->buffer));
1560 Fgoto_char (pos);
1561 set_buffer_internal (old_buffer);
1564 else
1566 set_marker_restricted (w->pointm, pos, w->buffer);
1567 /* We have to make sure that redisplay updates the window to show
1568 the new value of point. */
1569 ++windows_or_buffers_changed;
1572 return pos;
1575 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
1576 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
1577 WINDOW must be a live window and defaults to the selected one. Return
1578 POS. Optional third arg NOFORCE non-nil inhibits next redisplay from
1579 overriding motion of point in order to display at this exact start. */)
1580 (Lisp_Object window, Lisp_Object pos, Lisp_Object noforce)
1582 register struct window *w = decode_live_window (window);
1584 CHECK_NUMBER_COERCE_MARKER (pos);
1585 set_marker_restricted (w->start, pos, w->buffer);
1586 /* this is not right, but much easier than doing what is right. */
1587 w->start_at_line_beg = 0;
1588 if (NILP (noforce))
1589 w->force_start = 1;
1590 w->update_mode_line = 1;
1591 w->last_modified = 0;
1592 w->last_overlay_modified = 0;
1593 if (!EQ (window, selected_window))
1594 windows_or_buffers_changed++;
1596 return pos;
1599 DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
1600 Spos_visible_in_window_p, 0, 3, 0,
1601 doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
1602 WINDOW must be a live window and defaults to the selected one.
1604 Return nil if that position is scrolled vertically out of view. If a
1605 character is only partially visible, nil is returned, unless the
1606 optional argument PARTIALLY is non-nil. If POS is only out of view
1607 because of horizontal scrolling, return non-nil. If POS is t, it
1608 specifies the position of the last visible glyph in WINDOW. POS
1609 defaults to point in WINDOW; WINDOW defaults to the selected window.
1611 If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
1612 return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
1613 where X and Y are the pixel coordinates relative to the top left corner
1614 of the window. The remaining elements are omitted if the character after
1615 POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
1616 off-window at the top and bottom of the row, ROWH is the height of the
1617 display row, and VPOS is the row number (0-based) containing POS. */)
1618 (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
1620 register struct window *w;
1621 register EMACS_INT posint;
1622 register struct buffer *buf;
1623 struct text_pos top;
1624 Lisp_Object in_window = Qnil;
1625 int rtop, rbot, rowh, vpos, fully_p = 1;
1626 int x, y;
1628 w = decode_live_window (window);
1629 buf = XBUFFER (w->buffer);
1630 SET_TEXT_POS_FROM_MARKER (top, w->start);
1632 if (EQ (pos, Qt))
1633 posint = -1;
1634 else if (!NILP (pos))
1636 CHECK_NUMBER_COERCE_MARKER (pos);
1637 posint = XINT (pos);
1639 else if (w == XWINDOW (selected_window))
1640 posint = PT;
1641 else
1642 posint = marker_position (w->pointm);
1644 /* If position is above window start or outside buffer boundaries,
1645 or if window start is out of range, position is not visible. */
1646 if ((EQ (pos, Qt)
1647 || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
1648 && CHARPOS (top) >= BUF_BEGV (buf)
1649 && CHARPOS (top) <= BUF_ZV (buf)
1650 && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
1651 && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
1652 in_window = Qt;
1654 if (!NILP (in_window) && !NILP (partially))
1656 Lisp_Object part = Qnil;
1657 if (!fully_p)
1658 part = list4i (rtop, rbot, rowh, vpos);
1659 in_window = Fcons (make_number (x),
1660 Fcons (make_number (y), part));
1663 return in_window;
1666 DEFUN ("window-line-height", Fwindow_line_height,
1667 Swindow_line_height, 0, 2, 0,
1668 doc: /* Return height in pixels of text line LINE in window WINDOW.
1669 WINDOW must be a live window and defaults to the selected one.
1671 Return height of current line if LINE is omitted or nil. Return height of
1672 header or mode line if LINE is `header-line' or `mode-line'.
1673 Otherwise, LINE is a text line number starting from 0. A negative number
1674 counts from the end of the window.
1676 Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
1677 in pixels of the visible part of the line, VPOS and YPOS are the
1678 vertical position in lines and pixels of the line, relative to the top
1679 of the first text line, and OFFBOT is the number of off-window pixels at
1680 the bottom of the text line. If there are off-window pixels at the top
1681 of the (first) text line, YPOS is negative.
1683 Return nil if window display is not up-to-date. In that case, use
1684 `pos-visible-in-window-p' to obtain the information. */)
1685 (Lisp_Object line, Lisp_Object window)
1687 register struct window *w;
1688 register struct buffer *b;
1689 struct glyph_row *row, *end_row;
1690 int max_y, crop, i;
1691 EMACS_INT n;
1693 w = decode_live_window (window);
1695 if (noninteractive || w->pseudo_window_p)
1696 return Qnil;
1698 CHECK_BUFFER (w->buffer);
1699 b = XBUFFER (w->buffer);
1701 /* Fail if current matrix is not up-to-date. */
1702 if (!w->window_end_valid
1703 || current_buffer->clip_changed
1704 || current_buffer->prevent_redisplay_optimizations_p
1705 || w->last_modified < BUF_MODIFF (b)
1706 || w->last_overlay_modified < BUF_OVERLAY_MODIFF (b))
1707 return Qnil;
1709 if (NILP (line))
1711 i = w->cursor.vpos;
1712 if (i < 0 || i >= w->current_matrix->nrows
1713 || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
1714 return Qnil;
1715 max_y = window_text_bottom_y (w);
1716 goto found_row;
1719 if (EQ (line, Qheader_line))
1721 if (!WINDOW_WANTS_HEADER_LINE_P (w))
1722 return Qnil;
1723 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
1724 return row->enabled_p ? list4i (row->height, 0, 0, 0) : Qnil;
1727 if (EQ (line, Qmode_line))
1729 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
1730 return (row->enabled_p ?
1731 list4i (row->height,
1732 0, /* not accurate */
1733 (WINDOW_HEADER_LINE_HEIGHT (w)
1734 + window_text_bottom_y (w)),
1736 : Qnil);
1739 CHECK_NUMBER (line);
1740 n = XINT (line);
1742 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
1743 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
1744 max_y = window_text_bottom_y (w);
1745 i = 0;
1747 while ((n < 0 || i < n)
1748 && row <= end_row && row->enabled_p
1749 && row->y + row->height < max_y)
1750 row++, i++;
1752 if (row > end_row || !row->enabled_p)
1753 return Qnil;
1755 if (++n < 0)
1757 if (-n > i)
1758 return Qnil;
1759 row += n;
1760 i += n;
1763 found_row:
1764 crop = max (0, (row->y + row->height) - max_y);
1765 return list4i (row->height + min (0, row->y) - crop, i, row->y, crop);
1768 DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
1769 0, 1, 0,
1770 doc: /* Return non-nil when WINDOW is dedicated to its buffer.
1771 More precisely, return the value assigned by the last call of
1772 `set-window-dedicated-p' for WINDOW. Return nil if that function was
1773 never called with WINDOW as its argument, or the value set by that
1774 function was internally reset since its last call. WINDOW must be a
1775 live window and defaults to the selected one.
1777 When a window is dedicated to its buffer, `display-buffer' will refrain
1778 from displaying another buffer in it. `get-lru-window' and
1779 `get-largest-window' treat dedicated windows specially.
1780 `delete-windows-on', `replace-buffer-in-windows', `quit-window' and
1781 `kill-buffer' can delete a dedicated window and the containing frame.
1783 Functions like `set-window-buffer' may change the buffer displayed by a
1784 window, unless that window is "strongly" dedicated to its buffer, that
1785 is the value returned by `window-dedicated-p' is t. */)
1786 (Lisp_Object window)
1788 return decode_live_window (window)->dedicated;
1791 DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1792 Sset_window_dedicated_p, 2, 2, 0,
1793 doc: /* Mark WINDOW as dedicated according to FLAG.
1794 WINDOW must be a live window and defaults to the selected one. FLAG
1795 non-nil means mark WINDOW as dedicated to its buffer. FLAG nil means
1796 mark WINDOW as non-dedicated. Return FLAG.
1798 When a window is dedicated to its buffer, `display-buffer' will refrain
1799 from displaying another buffer in it. `get-lru-window' and
1800 `get-largest-window' treat dedicated windows specially.
1801 `delete-windows-on', `replace-buffer-in-windows', `quit-window',
1802 `quit-restore-window' and `kill-buffer' can delete a dedicated window
1803 and the containing frame.
1805 As a special case, if FLAG is t, mark WINDOW as "strongly" dedicated to
1806 its buffer. Functions like `set-window-buffer' may change the buffer
1807 displayed by a window, unless that window is strongly dedicated to its
1808 buffer. If and when `set-window-buffer' displays another buffer in a
1809 window, it also makes sure that the window is no more dedicated. */)
1810 (Lisp_Object window, Lisp_Object flag)
1812 wset_dedicated (decode_live_window (window), flag);
1813 return flag;
1816 DEFUN ("window-prev-buffers", Fwindow_prev_buffers, Swindow_prev_buffers,
1817 0, 1, 0,
1818 doc: /* Return buffers previously shown in WINDOW.
1819 WINDOW must be a live window and defaults to the selected one.
1821 The return value is a list of elements (BUFFER WINDOW-START POS),
1822 where BUFFER is a buffer, WINDOW-START is the start position of the
1823 window for that buffer, and POS is a window-specific point value. */)
1824 (Lisp_Object window)
1826 return decode_live_window (window)->prev_buffers;
1829 DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers,
1830 Sset_window_prev_buffers, 2, 2, 0,
1831 doc: /* Set WINDOW's previous buffers to PREV-BUFFERS.
1832 WINDOW must be a live window and defaults to the selected one.
1834 PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
1835 where BUFFER is a buffer, WINDOW-START is the start position of the
1836 window for that buffer, and POS is a window-specific point value. */)
1837 (Lisp_Object window, Lisp_Object prev_buffers)
1839 wset_prev_buffers (decode_live_window (window), prev_buffers);
1840 return prev_buffers;
1843 DEFUN ("window-next-buffers", Fwindow_next_buffers, Swindow_next_buffers,
1844 0, 1, 0,
1845 doc: /* Return list of buffers recently re-shown in WINDOW.
1846 WINDOW must be a live window and defaults to the selected one. */)
1847 (Lisp_Object window)
1849 return decode_live_window (window)->next_buffers;
1852 DEFUN ("set-window-next-buffers", Fset_window_next_buffers,
1853 Sset_window_next_buffers, 2, 2, 0,
1854 doc: /* Set WINDOW's next buffers to NEXT-BUFFERS.
1855 WINDOW must be a live window and defaults to the selected one.
1856 NEXT-BUFFERS should be a list of buffers. */)
1857 (Lisp_Object window, Lisp_Object next_buffers)
1859 wset_next_buffers (decode_live_window (window), next_buffers);
1860 return next_buffers;
1863 DEFUN ("window-parameters", Fwindow_parameters, Swindow_parameters,
1864 0, 1, 0,
1865 doc: /* Return the parameters of WINDOW and their values.
1866 WINDOW must be a valid window and defaults to the selected one. The
1867 return value is a list of elements of the form (PARAMETER . VALUE). */)
1868 (Lisp_Object window)
1870 return Fcopy_alist (decode_valid_window (window)->window_parameters);
1873 DEFUN ("window-parameter", Fwindow_parameter, Swindow_parameter,
1874 2, 2, 0,
1875 doc: /* Return WINDOW's value for PARAMETER.
1876 WINDOW can be any window and defaults to the selected one. */)
1877 (Lisp_Object window, Lisp_Object parameter)
1879 Lisp_Object result;
1881 result = Fassq (parameter, decode_any_window (window)->window_parameters);
1882 return CDR_SAFE (result);
1885 DEFUN ("set-window-parameter", Fset_window_parameter,
1886 Sset_window_parameter, 3, 3, 0,
1887 doc: /* Set WINDOW's value of PARAMETER to VALUE.
1888 WINDOW can be any window and defaults to the selected one.
1889 Return VALUE. */)
1890 (Lisp_Object window, Lisp_Object parameter, Lisp_Object value)
1892 register struct window *w = decode_any_window (window);
1893 Lisp_Object old_alist_elt;
1895 old_alist_elt = Fassq (parameter, w->window_parameters);
1896 if (NILP (old_alist_elt))
1897 wset_window_parameters
1898 (w, Fcons (Fcons (parameter, value), w->window_parameters));
1899 else
1900 Fsetcdr (old_alist_elt, value);
1901 return value;
1904 DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1905 0, 1, 0,
1906 doc: /* Return the display-table that WINDOW is using.
1907 WINDOW must be a live window and defaults to the selected one. */)
1908 (Lisp_Object window)
1910 return decode_live_window (window)->display_table;
1913 /* Get the display table for use on window W. This is either W's
1914 display table or W's buffer's display table. Ignore the specified
1915 tables if they are not valid; if no valid table is specified,
1916 return 0. */
1918 struct Lisp_Char_Table *
1919 window_display_table (struct window *w)
1921 struct Lisp_Char_Table *dp = NULL;
1923 if (DISP_TABLE_P (w->display_table))
1924 dp = XCHAR_TABLE (w->display_table);
1925 else if (BUFFERP (w->buffer))
1927 struct buffer *b = XBUFFER (w->buffer);
1929 if (DISP_TABLE_P (BVAR (b, display_table)))
1930 dp = XCHAR_TABLE (BVAR (b, display_table));
1931 else if (DISP_TABLE_P (Vstandard_display_table))
1932 dp = XCHAR_TABLE (Vstandard_display_table);
1935 return dp;
1938 DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1939 doc: /* Set WINDOW's display-table to TABLE.
1940 WINDOW must be a live window and defaults to the selected one. */)
1941 (register Lisp_Object window, Lisp_Object table)
1943 wset_display_table (decode_live_window (window), table);
1944 return table;
1947 /* Record info on buffer window W is displaying
1948 when it is about to cease to display that buffer. */
1949 static void
1950 unshow_buffer (register struct window *w)
1952 Lisp_Object buf;
1953 struct buffer *b;
1955 buf = w->buffer;
1956 b = XBUFFER (buf);
1957 if (b != XMARKER (w->pointm)->buffer)
1958 emacs_abort ();
1960 #if 0
1961 if (w == XWINDOW (selected_window)
1962 || ! EQ (buf, XWINDOW (selected_window)->buffer))
1963 /* Do this except when the selected window's buffer
1964 is being removed from some other window. */
1965 #endif
1966 /* last_window_start records the start position that this buffer
1967 had in the last window to be disconnected from it.
1968 Now that this statement is unconditional,
1969 it is possible for the buffer to be displayed in the
1970 selected window, while last_window_start reflects another
1971 window which was recently showing the same buffer.
1972 Some people might say that might be a good thing. Let's see. */
1973 b->last_window_start = marker_position (w->start);
1975 /* Point in the selected window's buffer
1976 is actually stored in that buffer, and the window's pointm isn't used.
1977 So don't clobber point in that buffer. */
1978 if (! EQ (buf, XWINDOW (selected_window)->buffer)
1979 /* Don't clobber point in current buffer either (this could be
1980 useful in connection with bug#12208).
1981 && XBUFFER (buf) != current_buffer */
1982 /* This line helps to fix Horsley's testbug.el bug. */
1983 && !(WINDOWP (BVAR (b, last_selected_window))
1984 && w != XWINDOW (BVAR (b, last_selected_window))
1985 && EQ (buf, XWINDOW (BVAR (b, last_selected_window))->buffer)))
1986 temp_set_point_both (b,
1987 clip_to_bounds (BUF_BEGV (b),
1988 marker_position (w->pointm),
1989 BUF_ZV (b)),
1990 clip_to_bounds (BUF_BEGV_BYTE (b),
1991 marker_byte_position (w->pointm),
1992 BUF_ZV_BYTE (b)));
1994 if (WINDOWP (BVAR (b, last_selected_window))
1995 && w == XWINDOW (BVAR (b, last_selected_window)))
1996 bset_last_selected_window (b, Qnil);
1999 /* Put NEW into the window structure in place of OLD. SETFLAG zero
2000 means change window structure only. Otherwise store geometry and
2001 other settings as well. */
2002 static void
2003 replace_window (Lisp_Object old, Lisp_Object new, int setflag)
2005 register Lisp_Object tem;
2006 register struct window *o = XWINDOW (old), *n = XWINDOW (new);
2008 /* If OLD is its frame's root window, then NEW is the new
2009 root window for that frame. */
2010 if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
2011 fset_root_window (XFRAME (o->frame), new);
2013 if (setflag)
2015 wset_left_col (n, o->left_col);
2016 wset_top_line (n, o->top_line);
2017 wset_total_cols (n, o->total_cols);
2018 wset_total_lines (n, o->total_lines);
2019 wset_normal_cols (n, o->normal_cols);
2020 wset_normal_cols (o, make_float (1.0));
2021 wset_normal_lines (n, o->normal_lines);
2022 wset_normal_lines (o, make_float (1.0));
2023 n->desired_matrix = n->current_matrix = 0;
2024 n->vscroll = 0;
2025 memset (&n->cursor, 0, sizeof (n->cursor));
2026 memset (&n->last_cursor, 0, sizeof (n->last_cursor));
2027 memset (&n->phys_cursor, 0, sizeof (n->phys_cursor));
2028 n->phys_cursor_type = -1;
2029 n->phys_cursor_width = -1;
2030 n->must_be_updated_p = 0;
2031 n->pseudo_window_p = 0;
2032 wset_window_end_vpos (n, make_number (0));
2033 wset_window_end_pos (n, make_number (0));
2034 n->window_end_valid = 0;
2035 n->frozen_window_start_p = 0;
2038 tem = o->next;
2039 wset_next (n, tem);
2040 if (!NILP (tem))
2041 wset_prev (XWINDOW (tem), new);
2043 tem = o->prev;
2044 wset_prev (n, tem);
2045 if (!NILP (tem))
2046 wset_next (XWINDOW (tem), new);
2048 tem = o->parent;
2049 wset_parent (n, tem);
2050 if (!NILP (tem))
2052 if (EQ (XWINDOW (tem)->vchild, old))
2053 wset_vchild (XWINDOW (tem), new);
2054 if (EQ (XWINDOW (tem)->hchild, old))
2055 wset_hchild (XWINDOW (tem), new);
2059 /* If window WINDOW and its parent window are iso-combined, merge
2060 WINDOW's children into those of its parent window and mark WINDOW as
2061 deleted. */
2063 static void
2064 recombine_windows (Lisp_Object window)
2066 struct window *w, *p, *c;
2067 Lisp_Object parent, child;
2068 int horflag;
2070 w = XWINDOW (window);
2071 parent = w->parent;
2072 if (!NILP (parent) && NILP (w->combination_limit))
2074 p = XWINDOW (parent);
2075 if (((!NILP (p->vchild) && !NILP (w->vchild))
2076 || (!NILP (p->hchild) && !NILP (w->hchild))))
2077 /* WINDOW and PARENT are both either a vertical or a horizontal
2078 combination. */
2080 horflag = NILP (w->vchild);
2081 child = horflag ? w->hchild : w->vchild;
2082 c = XWINDOW (child);
2084 /* Splice WINDOW's children into its parent's children and
2085 assign new normal sizes. */
2086 if (NILP (w->prev))
2087 if (horflag)
2088 wset_hchild (p, child);
2089 else
2090 wset_vchild (p, child);
2091 else
2093 wset_prev (c, w->prev);
2094 wset_next (XWINDOW (w->prev), child);
2097 while (c)
2099 wset_parent (c, parent);
2101 if (horflag)
2102 wset_normal_cols (c,
2103 make_float (XFLOATINT (c->total_cols)
2104 / XFLOATINT (p->total_cols)));
2105 else
2106 wset_normal_lines (c,
2107 make_float (XFLOATINT (c->total_lines)
2108 / XFLOATINT (p->total_lines)));
2110 if (NILP (c->next))
2112 if (!NILP (w->next))
2114 wset_next (c, w->next);
2115 wset_prev (XWINDOW (c->next), child);
2118 c = 0;
2120 else
2122 child = c->next;
2123 c = XWINDOW (child);
2127 /* WINDOW can be deleted now. */
2128 wset_vchild (w, Qnil);
2129 wset_hchild (w, Qnil);
2134 /* If WINDOW can be deleted, delete it. */
2135 static void
2136 delete_deletable_window (Lisp_Object window)
2138 if (!NILP (call1 (Qwindow_deletable_p, window)))
2139 call1 (Qdelete_window, window);
2142 /***********************************************************************
2143 Window List
2144 ***********************************************************************/
2146 /* Add window W to *USER_DATA. USER_DATA is actually a Lisp_Object
2147 pointer. This is a callback function for foreach_window, used in
2148 the window_list function. */
2150 static int
2151 add_window_to_list (struct window *w, void *user_data)
2153 Lisp_Object *list = (Lisp_Object *) user_data;
2154 Lisp_Object window;
2155 XSETWINDOW (window, w);
2156 *list = Fcons (window, *list);
2157 return 1;
2161 /* Return a list of all windows, for use by next_window. If
2162 Vwindow_list is a list, return that list. Otherwise, build a new
2163 list, cache it in Vwindow_list, and return that. */
2165 static Lisp_Object
2166 window_list (void)
2168 if (!CONSP (Vwindow_list))
2170 Lisp_Object tail, frame;
2172 Vwindow_list = Qnil;
2173 FOR_EACH_FRAME (tail, frame)
2175 Lisp_Object args[2];
2177 /* We are visiting windows in canonical order, and add
2178 new windows at the front of args[1], which means we
2179 have to reverse this list at the end. */
2180 args[1] = Qnil;
2181 foreach_window (XFRAME (frame), add_window_to_list, &args[1]);
2182 args[0] = Vwindow_list;
2183 args[1] = Fnreverse (args[1]);
2184 Vwindow_list = Fnconc (2, args);
2188 return Vwindow_list;
2192 /* Value is non-zero if WINDOW satisfies the constraints given by
2193 OWINDOW, MINIBUF and ALL_FRAMES.
2195 MINIBUF t means WINDOW may be minibuffer windows.
2196 `lambda' means WINDOW may not be a minibuffer window.
2197 a window means a specific minibuffer window
2199 ALL_FRAMES t means search all frames,
2200 nil means search just current frame,
2201 `visible' means search just visible frames on the
2202 current terminal,
2203 0 means search visible and iconified frames on the
2204 current terminal,
2205 a window means search the frame that window belongs to,
2206 a frame means consider windows on that frame, only. */
2208 static int
2209 candidate_window_p (Lisp_Object window, Lisp_Object owindow, Lisp_Object minibuf, Lisp_Object all_frames)
2211 struct window *w = XWINDOW (window);
2212 struct frame *f = XFRAME (w->frame);
2213 int candidate_p = 1;
2215 if (!BUFFERP (w->buffer))
2216 candidate_p = 0;
2217 else if (MINI_WINDOW_P (w)
2218 && (EQ (minibuf, Qlambda)
2219 || (WINDOWP (minibuf) && !EQ (minibuf, window))))
2221 /* If MINIBUF is `lambda' don't consider any mini-windows.
2222 If it is a window, consider only that one. */
2223 candidate_p = 0;
2225 else if (EQ (all_frames, Qt))
2226 candidate_p = 1;
2227 else if (NILP (all_frames))
2229 eassert (WINDOWP (owindow));
2230 candidate_p = EQ (w->frame, XWINDOW (owindow)->frame);
2232 else if (EQ (all_frames, Qvisible))
2234 candidate_p = FRAME_VISIBLE_P (f)
2235 && (FRAME_TERMINAL (XFRAME (w->frame))
2236 == FRAME_TERMINAL (XFRAME (selected_frame)));
2239 else if (INTEGERP (all_frames) && XINT (all_frames) == 0)
2241 candidate_p = (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f)
2242 #ifdef HAVE_X_WINDOWS
2243 /* Yuck!! If we've just created the frame and the
2244 window-manager requested the user to place it
2245 manually, the window may still not be considered
2246 `visible'. I'd argue it should be at least
2247 something like `iconified', but don't know how to do
2248 that yet. --Stef */
2249 || (FRAME_X_P (f) && f->output_data.x->asked_for_visible
2250 && !f->output_data.x->has_been_visible)
2251 #endif
2253 && (FRAME_TERMINAL (XFRAME (w->frame))
2254 == FRAME_TERMINAL (XFRAME (selected_frame)));
2256 else if (WINDOWP (all_frames))
2257 candidate_p = (EQ (FRAME_MINIBUF_WINDOW (f), all_frames)
2258 || EQ (XWINDOW (all_frames)->frame, w->frame)
2259 || EQ (XWINDOW (all_frames)->frame, FRAME_FOCUS_FRAME (f)));
2260 else if (FRAMEP (all_frames))
2261 candidate_p = EQ (all_frames, w->frame);
2263 return candidate_p;
2267 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
2268 Fwindow_list. See candidate_window_p for the meaning of WINDOW,
2269 MINIBUF, and ALL_FRAMES. */
2271 static void
2272 decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object *all_frames)
2274 struct window *w = decode_live_window (*window);
2276 XSETWINDOW (*window, w);
2277 /* MINIBUF nil may or may not include minibuffers. Decide if it
2278 does. */
2279 if (NILP (*minibuf))
2280 *minibuf = minibuf_level ? minibuf_window : Qlambda;
2281 else if (!EQ (*minibuf, Qt))
2282 *minibuf = Qlambda;
2284 /* Now *MINIBUF can be t => count all minibuffer windows, `lambda'
2285 => count none of them, or a specific minibuffer window (the
2286 active one) to count. */
2288 /* ALL_FRAMES nil doesn't specify which frames to include. */
2289 if (NILP (*all_frames))
2290 *all_frames
2291 = (!EQ (*minibuf, Qlambda)
2292 ? FRAME_MINIBUF_WINDOW (XFRAME (w->frame))
2293 : Qnil);
2294 else if (EQ (*all_frames, Qvisible))
2296 else if (EQ (*all_frames, make_number (0)))
2298 else if (FRAMEP (*all_frames))
2300 else if (!EQ (*all_frames, Qt))
2301 *all_frames = Qnil;
2305 /* Return the next or previous window of WINDOW in cyclic ordering
2306 of windows. NEXT_P non-zero means return the next window. See the
2307 documentation string of next-window for the meaning of MINIBUF and
2308 ALL_FRAMES. */
2310 static Lisp_Object
2311 next_window (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames, int next_p)
2313 decode_next_window_args (&window, &minibuf, &all_frames);
2315 /* If ALL_FRAMES is a frame, and WINDOW isn't on that frame, just
2316 return the first window on the frame. */
2317 if (FRAMEP (all_frames)
2318 && !EQ (all_frames, XWINDOW (window)->frame))
2319 return Fframe_first_window (all_frames);
2321 if (next_p)
2323 Lisp_Object list;
2325 /* Find WINDOW in the list of all windows. */
2326 list = Fmemq (window, window_list ());
2328 /* Scan forward from WINDOW to the end of the window list. */
2329 if (CONSP (list))
2330 for (list = XCDR (list); CONSP (list); list = XCDR (list))
2331 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2332 break;
2334 /* Scan from the start of the window list up to WINDOW. */
2335 if (!CONSP (list))
2336 for (list = Vwindow_list;
2337 CONSP (list) && !EQ (XCAR (list), window);
2338 list = XCDR (list))
2339 if (candidate_window_p (XCAR (list), window, minibuf, all_frames))
2340 break;
2342 if (CONSP (list))
2343 window = XCAR (list);
2345 else
2347 Lisp_Object candidate, list;
2349 /* Scan through the list of windows for candidates. If there are
2350 candidate windows in front of WINDOW, the last one of these
2351 is the one we want. If there are candidates following WINDOW
2352 in the list, again the last one of these is the one we want. */
2353 candidate = Qnil;
2354 for (list = window_list (); CONSP (list); list = XCDR (list))
2356 if (EQ (XCAR (list), window))
2358 if (WINDOWP (candidate))
2359 break;
2361 else if (candidate_window_p (XCAR (list), window, minibuf,
2362 all_frames))
2363 candidate = XCAR (list);
2366 if (WINDOWP (candidate))
2367 window = candidate;
2370 return window;
2374 DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
2375 doc: /* Return live window after WINDOW in the cyclic ordering of windows.
2376 WINDOW must be a live window and defaults to the selected one. The
2377 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2378 consider.
2380 MINIBUF nil or omitted means consider the minibuffer window only if the
2381 minibuffer is active. MINIBUF t means consider the minibuffer window
2382 even if the minibuffer is not active. Any other value means do not
2383 consider the minibuffer window even if the minibuffer is active.
2385 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2386 plus the minibuffer window if specified by the MINIBUF argument. If the
2387 minibuffer counts, consider all windows on all frames that share that
2388 minibuffer too. The following non-nil values of ALL-FRAMES have special
2389 meanings:
2391 - t means consider all windows on all existing frames.
2393 - `visible' means consider all windows on all visible frames.
2395 - 0 (the number zero) means consider all windows on all visible and
2396 iconified frames.
2398 - A frame means consider all windows on that frame only.
2400 Anything else means consider all windows on WINDOW's frame and no
2401 others.
2403 If you use consistent values for MINIBUF and ALL-FRAMES, you can use
2404 `next-window' to iterate through the entire cycle of acceptable
2405 windows, eventually ending up back at the window you started with.
2406 `previous-window' traverses the same cycle, in the reverse order. */)
2407 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2409 return next_window (window, minibuf, all_frames, 1);
2413 DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
2414 doc: /* Return live window before WINDOW in the cyclic ordering of windows.
2415 WINDOW must be a live window and defaults to the selected one. The
2416 optional arguments MINIBUF and ALL-FRAMES specify the set of windows to
2417 consider.
2419 MINIBUF nil or omitted means consider the minibuffer window only if the
2420 minibuffer is active. MINIBUF t means consider the minibuffer window
2421 even if the minibuffer is not active. Any other value means do not
2422 consider the minibuffer window even if the minibuffer is active.
2424 ALL-FRAMES nil or omitted means consider all windows on WINDOW's frame,
2425 plus the minibuffer window if specified by the MINIBUF argument. If the
2426 minibuffer counts, consider all windows on all frames that share that
2427 minibuffer too. The following non-nil values of ALL-FRAMES have special
2428 meanings:
2430 - t means consider all windows on all existing frames.
2432 - `visible' means consider all windows on all visible frames.
2434 - 0 (the number zero) means consider all windows on all visible and
2435 iconified frames.
2437 - A frame means consider all windows on that frame only.
2439 Anything else means consider all windows on WINDOW's frame and no
2440 others.
2442 If you use consistent values for MINIBUF and ALL-FRAMES, you can
2443 use `previous-window' to iterate through the entire cycle of
2444 acceptable windows, eventually ending up back at the window you
2445 started with. `next-window' traverses the same cycle, in the
2446 reverse order. */)
2447 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2449 return next_window (window, minibuf, all_frames, 0);
2453 /* Return a list of windows in cyclic ordering. Arguments are like
2454 for `next-window'. */
2456 static Lisp_Object
2457 window_list_1 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2459 Lisp_Object tail, list, rest;
2461 decode_next_window_args (&window, &minibuf, &all_frames);
2462 list = Qnil;
2464 for (tail = window_list (); CONSP (tail); tail = XCDR (tail))
2465 if (candidate_window_p (XCAR (tail), window, minibuf, all_frames))
2466 list = Fcons (XCAR (tail), list);
2468 /* Rotate the list to start with WINDOW. */
2469 list = Fnreverse (list);
2470 rest = Fmemq (window, list);
2471 if (!NILP (rest) && !EQ (rest, list))
2473 for (tail = list; !EQ (XCDR (tail), rest); tail = XCDR (tail))
2475 XSETCDR (tail, Qnil);
2476 list = nconc2 (rest, list);
2478 return list;
2482 DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
2483 doc: /* Return a list of windows on FRAME, starting with WINDOW.
2484 FRAME nil or omitted means use the selected frame.
2485 WINDOW nil or omitted means use the window selected within FRAME.
2486 MINIBUF t means include the minibuffer window, even if it isn't active.
2487 MINIBUF nil or omitted means include the minibuffer window only
2488 if it's active.
2489 MINIBUF neither nil nor t means never include the minibuffer window. */)
2490 (Lisp_Object frame, Lisp_Object minibuf, Lisp_Object window)
2492 if (NILP (window))
2493 window = FRAMEP (frame) ? XFRAME (frame)->selected_window : selected_window;
2494 CHECK_WINDOW (window);
2495 if (NILP (frame))
2496 frame = selected_frame;
2498 if (!EQ (frame, XWINDOW (window)->frame))
2499 error ("Window is on a different frame");
2501 return window_list_1 (window, minibuf, frame);
2505 DEFUN ("window-list-1", Fwindow_list_1, Swindow_list_1, 0, 3, 0,
2506 doc: /* Return a list of all live windows.
2507 WINDOW specifies the first window to list and defaults to the selected
2508 window.
2510 Optional argument MINIBUF nil or omitted means consider the minibuffer
2511 window only if the minibuffer is active. MINIBUF t means consider the
2512 minibuffer window even if the minibuffer is not active. Any other value
2513 means do not consider the minibuffer window even if the minibuffer is
2514 active.
2516 Optional argument ALL-FRAMES nil or omitted means consider all windows
2517 on WINDOW's frame, plus the minibuffer window if specified by the
2518 MINIBUF argument. If the minibuffer counts, consider all windows on all
2519 frames that share that minibuffer too. The following non-nil values of
2520 ALL-FRAMES have special meanings:
2522 - t means consider all windows on all existing frames.
2524 - `visible' means consider all windows on all visible frames.
2526 - 0 (the number zero) means consider all windows on all visible and
2527 iconified frames.
2529 - A frame means consider all windows on that frame only.
2531 Anything else means consider all windows on WINDOW's frame and no
2532 others.
2534 If WINDOW is not on the list of windows returned, some other window will
2535 be listed first but no error is signaled. */)
2536 (Lisp_Object window, Lisp_Object minibuf, Lisp_Object all_frames)
2538 return window_list_1 (window, minibuf, all_frames);
2541 /* Look at all windows, performing an operation specified by TYPE
2542 with argument OBJ.
2543 If FRAMES is Qt, look at all frames;
2544 Qnil, look at just the selected frame;
2545 Qvisible, look at visible frames;
2546 a frame, just look at windows on that frame.
2547 If MINI is non-zero, perform the operation on minibuffer windows too. */
2549 enum window_loop
2551 WINDOW_LOOP_UNUSED,
2552 GET_BUFFER_WINDOW, /* Arg is buffer */
2553 REPLACE_BUFFER_IN_WINDOWS_SAFELY, /* Arg is buffer */
2554 REDISPLAY_BUFFER_WINDOWS, /* Arg is buffer */
2555 CHECK_ALL_WINDOWS
2558 static Lisp_Object
2559 window_loop (enum window_loop type, Lisp_Object obj, int mini, Lisp_Object frames)
2561 Lisp_Object window, windows, best_window, frame_arg;
2562 int frame_best_window_flag = 0;
2563 struct frame *f;
2564 struct gcpro gcpro1;
2566 /* If we're only looping through windows on a particular frame,
2567 frame points to that frame. If we're looping through windows
2568 on all frames, frame is 0. */
2569 if (FRAMEP (frames))
2570 f = XFRAME (frames);
2571 else if (NILP (frames))
2572 f = SELECTED_FRAME ();
2573 else
2574 f = NULL;
2576 if (f)
2577 frame_arg = Qlambda;
2578 else if (EQ (frames, make_number (0)))
2579 frame_arg = frames;
2580 else if (EQ (frames, Qvisible))
2581 frame_arg = frames;
2582 else
2583 frame_arg = Qt;
2585 /* frame_arg is Qlambda to stick to one frame,
2586 Qvisible to consider all visible frames,
2587 or Qt otherwise. */
2589 /* Pick a window to start with. */
2590 if (WINDOWP (obj))
2591 window = obj;
2592 else if (f)
2593 window = FRAME_SELECTED_WINDOW (f);
2594 else
2595 window = FRAME_SELECTED_WINDOW (SELECTED_FRAME ());
2597 windows = window_list_1 (window, mini ? Qt : Qnil, frame_arg);
2598 GCPRO1 (windows);
2599 best_window = Qnil;
2601 for (; CONSP (windows); windows = XCDR (windows))
2603 struct window *w;
2605 window = XCAR (windows);
2606 w = XWINDOW (window);
2608 /* Note that we do not pay attention here to whether the frame
2609 is visible, since Fwindow_list skips non-visible frames if
2610 that is desired, under the control of frame_arg. */
2611 if (!MINI_WINDOW_P (w)
2612 /* For REPLACE_BUFFER_IN_WINDOWS_SAFELY, we must always
2613 consider all windows. */
2614 || type == REPLACE_BUFFER_IN_WINDOWS_SAFELY
2615 || (mini && minibuf_level > 0))
2616 switch (type)
2618 case GET_BUFFER_WINDOW:
2619 if (EQ (w->buffer, obj)
2620 /* Don't find any minibuffer window except the one that
2621 is currently in use. */
2622 && (MINI_WINDOW_P (w) ? EQ (window, minibuf_window) : 1))
2624 if (EQ (window, selected_window))
2625 /* Preferably return the selected window. */
2626 RETURN_UNGCPRO (window);
2627 else if (EQ (XWINDOW (window)->frame, selected_frame)
2628 && !frame_best_window_flag)
2629 /* Prefer windows on the current frame (but don't
2630 choose another one if we have one already). */
2632 best_window = window;
2633 frame_best_window_flag = 1;
2635 else if (NILP (best_window))
2636 best_window = window;
2638 break;
2640 case REPLACE_BUFFER_IN_WINDOWS_SAFELY:
2641 /* We could simply check whether the buffer shown by window
2642 is live, and show another buffer in case it isn't. */
2643 if (EQ (w->buffer, obj))
2645 /* Undedicate WINDOW. */
2646 wset_dedicated (w, Qnil);
2647 /* Make WINDOW show the buffer returned by
2648 other_buffer_safely, don't run any hooks. */
2649 set_window_buffer
2650 (window, other_buffer_safely (w->buffer), 0, 0);
2651 /* If WINDOW is the selected window, make its buffer
2652 current. But do so only if the window shows the
2653 current buffer (Bug#6454). */
2654 if (EQ (window, selected_window)
2655 && XBUFFER (w->buffer) == current_buffer)
2656 Fset_buffer (w->buffer);
2658 break;
2660 case REDISPLAY_BUFFER_WINDOWS:
2661 if (EQ (w->buffer, obj))
2663 mark_window_display_accurate (window, 0);
2664 w->update_mode_line = 1;
2665 XBUFFER (obj)->prevent_redisplay_optimizations_p = 1;
2666 ++update_mode_lines;
2667 best_window = window;
2669 break;
2671 /* Check for a window that has a killed buffer. */
2672 case CHECK_ALL_WINDOWS:
2673 if (! NILP (w->buffer)
2674 && !BUFFER_LIVE_P (XBUFFER (w->buffer)))
2675 emacs_abort ();
2676 break;
2678 case WINDOW_LOOP_UNUSED:
2679 break;
2683 UNGCPRO;
2684 return best_window;
2687 /* Used for debugging. Abort if any window has a dead buffer. */
2689 extern void check_all_windows (void) EXTERNALLY_VISIBLE;
2690 void
2691 check_all_windows (void)
2693 window_loop (CHECK_ALL_WINDOWS, Qnil, 1, Qt);
2696 DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 0, 2, 0,
2697 doc: /* Return a window currently displaying BUFFER-OR-NAME, or nil if none.
2698 BUFFER-OR-NAME may be a buffer or a buffer name and defaults to
2699 the current buffer.
2701 The optional argument ALL-FRAMES specifies the frames to consider:
2703 - t means consider all windows on all existing frames.
2705 - `visible' means consider all windows on all visible frames.
2707 - 0 (the number zero) means consider all windows on all visible
2708 and iconified frames.
2710 - A frame means consider all windows on that frame only.
2712 Any other value of ALL-FRAMES means consider all windows on the
2713 selected frame and no others. */)
2714 (Lisp_Object buffer_or_name, Lisp_Object all_frames)
2716 Lisp_Object buffer;
2718 if (NILP (buffer_or_name))
2719 buffer = Fcurrent_buffer ();
2720 else
2721 buffer = Fget_buffer (buffer_or_name);
2723 if (BUFFERP (buffer))
2724 return window_loop (GET_BUFFER_WINDOW, buffer, 1, all_frames);
2725 else
2726 return Qnil;
2729 static Lisp_Object
2730 resize_root_window (Lisp_Object window, Lisp_Object delta, Lisp_Object horizontal, Lisp_Object ignore)
2732 return call4 (Qwindow_resize_root_window, window, delta, horizontal, ignore);
2736 DEFUN ("delete-other-windows-internal", Fdelete_other_windows_internal,
2737 Sdelete_other_windows_internal, 0, 2, "",
2738 doc: /* Make WINDOW fill its frame.
2739 Only the frame WINDOW is on is affected. WINDOW must be a valid window
2740 and defaults to the selected one.
2742 Optional argument ROOT, if non-nil, must specify an internal window such
2743 that WINDOW is in its window subtree. If this is the case, replace ROOT
2744 by WINDOW and leave alone any windows not part of ROOT's subtree.
2746 When WINDOW is live try to reduce display jumps by keeping the text
2747 previously visible in WINDOW in the same place on the frame. Doing this
2748 depends on the value of (window-start WINDOW), so if calling this
2749 function in a program gives strange scrolling, make sure the
2750 window-start value is reasonable when this function is called. */)
2751 (Lisp_Object window, Lisp_Object root)
2753 struct window *w, *r, *s;
2754 struct frame *f;
2755 Lisp_Object sibling, pwindow, swindow IF_LINT (= Qnil), delta;
2756 ptrdiff_t startpos IF_LINT (= 0);
2757 int top IF_LINT (= 0), new_top, resize_failed;
2759 w = decode_valid_window (window);
2760 XSETWINDOW (window, w);
2761 f = XFRAME (w->frame);
2763 if (NILP (root))
2764 /* ROOT is the frame's root window. */
2766 root = FRAME_ROOT_WINDOW (f);
2767 r = XWINDOW (root);
2769 else
2770 /* ROOT must be an ancestor of WINDOW. */
2772 r = decode_valid_window (root);
2773 pwindow = XWINDOW (window)->parent;
2774 while (!NILP (pwindow))
2775 if (EQ (pwindow, root))
2776 break;
2777 else
2778 pwindow = XWINDOW (pwindow)->parent;
2779 if (!EQ (pwindow, root))
2780 error ("Specified root is not an ancestor of specified window");
2783 if (EQ (window, root))
2784 /* A noop. */
2785 return Qnil;
2786 /* I don't understand the "top > 0" part below. If we deal with a
2787 standalone minibuffer it would have been caught by the preceding
2788 test. */
2789 else if (MINI_WINDOW_P (w)) /* && top > 0) */
2790 error ("Can't expand minibuffer to full frame");
2792 if (!NILP (w->buffer))
2794 startpos = marker_position (w->start);
2795 top = WINDOW_TOP_EDGE_LINE (w)
2796 - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2797 /* Make sure WINDOW is the frame's selected window. */
2798 if (!EQ (window, FRAME_SELECTED_WINDOW (f)))
2800 if (EQ (selected_frame, w->frame))
2801 Fselect_window (window, Qnil);
2802 else
2803 fset_selected_window (f, window);
2806 else
2808 /* See if the frame's selected window is a part of the window
2809 subtree rooted at WINDOW, by finding all the selected window's
2810 parents and comparing each one with WINDOW. If it isn't we
2811 need a new selected window for this frame. */
2812 swindow = FRAME_SELECTED_WINDOW (f);
2813 while (1)
2815 pwindow = swindow;
2816 while (!NILP (pwindow) && !EQ (window, pwindow))
2817 pwindow = XWINDOW (pwindow)->parent;
2819 if (EQ (window, pwindow))
2820 /* If WINDOW is an ancestor of SWINDOW, then SWINDOW is ok
2821 as the new selected window. */
2822 break;
2823 else
2824 /* Else try the previous window of SWINDOW. */
2825 swindow = Fprevious_window (swindow, Qlambda, Qnil);
2828 if (!EQ (swindow, FRAME_SELECTED_WINDOW (f)))
2830 if (EQ (selected_frame, w->frame))
2831 Fselect_window (swindow, Qnil);
2832 else
2833 fset_selected_window (f, swindow);
2837 block_input ();
2838 if (!FRAME_INITIAL_P (f))
2840 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
2842 /* We are going to free the glyph matrices of WINDOW, and with
2843 that we might lose any information about glyph rows that have
2844 some of their glyphs highlighted in mouse face. (These rows
2845 are marked with a non-zero mouse_face_p flag.) If WINDOW
2846 indeed has some glyphs highlighted in mouse face, signal to
2847 frame's up-to-date hook that mouse highlight was overwritten,
2848 so that it will arrange for redisplaying the highlight. */
2849 if (EQ (hlinfo->mouse_face_window, window))
2851 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
2852 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
2853 hlinfo->mouse_face_window = Qnil;
2856 free_window_matrices (r);
2858 windows_or_buffers_changed++;
2859 Vwindow_list = Qnil;
2860 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
2861 resize_failed = 0;
2863 if (NILP (w->buffer))
2865 /* Resize child windows vertically. */
2866 XSETINT (delta, XINT (r->total_lines)
2867 - XINT (w->total_lines));
2868 wset_top_line (w, r->top_line);
2869 resize_root_window (window, delta, Qnil, Qnil);
2870 if (window_resize_check (w, 0))
2871 window_resize_apply (w, 0);
2872 else
2874 resize_root_window (window, delta, Qnil, Qt);
2875 if (window_resize_check (w, 0))
2876 window_resize_apply (w, 0);
2877 else
2878 resize_failed = 1;
2881 /* Resize child windows horizontally. */
2882 if (!resize_failed)
2884 wset_left_col (w, r->left_col);
2885 XSETINT (delta,
2886 XINT (r->total_cols) - XINT (w->total_cols));
2887 wset_left_col (w, r->left_col);
2888 resize_root_window (window, delta, Qt, Qnil);
2889 if (window_resize_check (w, 1))
2890 window_resize_apply (w, 1);
2891 else
2893 resize_root_window (window, delta, Qt, Qt);
2894 if (window_resize_check (w, 1))
2895 window_resize_apply (w, 1);
2896 else
2897 resize_failed = 1;
2901 if (resize_failed)
2902 /* Play safe, if we still can ... */
2904 window = swindow;
2905 w = XWINDOW (window);
2909 /* Cleanly unlink WINDOW from window-tree. */
2910 if (!NILP (w->prev))
2911 /* Get SIBLING above (on the left of) WINDOW. */
2913 sibling = w->prev;
2914 s = XWINDOW (sibling);
2915 wset_next (s, w->next);
2916 if (!NILP (s->next))
2917 wset_prev (XWINDOW (s->next), sibling);
2919 else
2920 /* Get SIBLING below (on the right of) WINDOW. */
2922 sibling = w->next;
2923 s = XWINDOW (sibling);
2924 wset_prev (s, Qnil);
2925 if (!NILP (XWINDOW (w->parent)->vchild))
2926 wset_vchild (XWINDOW (w->parent), sibling);
2927 else
2928 wset_hchild (XWINDOW (w->parent), sibling);
2931 /* Delete ROOT and all child windows of ROOT. */
2932 if (!NILP (r->vchild))
2934 delete_all_child_windows (r->vchild);
2935 wset_vchild (r, Qnil);
2937 else if (!NILP (r->hchild))
2939 delete_all_child_windows (r->hchild);
2940 wset_hchild (r, Qnil);
2943 replace_window (root, window, 1);
2945 /* This must become SWINDOW anyway ....... */
2946 if (!NILP (w->buffer) && !resize_failed)
2948 /* Try to minimize scrolling, by setting the window start to the
2949 point will cause the text at the old window start to be at the
2950 same place on the frame. But don't try to do this if the
2951 window start is outside the visible portion (as might happen
2952 when the display is not current, due to typeahead). */
2953 new_top = WINDOW_TOP_EDGE_LINE (w) - FRAME_TOP_MARGIN (XFRAME (WINDOW_FRAME (w)));
2954 if (new_top != top
2955 && startpos >= BUF_BEGV (XBUFFER (w->buffer))
2956 && startpos <= BUF_ZV (XBUFFER (w->buffer)))
2958 struct position pos;
2959 struct buffer *obuf = current_buffer;
2961 Fset_buffer (w->buffer);
2962 /* This computation used to temporarily move point, but that
2963 can have unwanted side effects due to text properties. */
2964 pos = *vmotion (startpos, -top, w);
2966 set_marker_both (w->start, w->buffer, pos.bufpos, pos.bytepos);
2967 w->window_end_valid = 0;
2968 w->start_at_line_beg = (pos.bytepos == BEGV_BYTE
2969 || FETCH_BYTE (pos.bytepos - 1) == '\n');
2970 /* We need to do this, so that the window-scroll-functions
2971 get called. */
2972 w->optional_new_start = 1;
2974 set_buffer_internal (obuf);
2978 adjust_glyphs (f);
2979 unblock_input ();
2981 run_window_configuration_change_hook (f);
2983 return Qnil;
2987 void
2988 replace_buffer_in_windows (Lisp_Object buffer)
2990 call1 (Qreplace_buffer_in_windows, buffer);
2993 /* If BUFFER is shown in a window, safely replace it with some other
2994 buffer in all windows of all frames, even those on other keyboards. */
2996 void
2997 replace_buffer_in_windows_safely (Lisp_Object buffer)
2999 if (buffer_window_count (XBUFFER (buffer)))
3001 Lisp_Object tail, frame;
3003 /* A single call to window_loop won't do the job because it only
3004 considers frames on the current keyboard. So loop manually over
3005 frames, and handle each one. */
3006 FOR_EACH_FRAME (tail, frame)
3007 window_loop (REPLACE_BUFFER_IN_WINDOWS_SAFELY, buffer, 1, frame);
3011 /* If *ROWS or *COLS are too small a size for FRAME, set them to the
3012 minimum allowable size. */
3014 void
3015 check_frame_size (FRAME_PTR frame, int *rows, int *cols)
3017 /* For height, we have to see:
3018 how many windows the frame has at minimum (one or two),
3019 and whether it has a menu bar or other special stuff at the top. */
3020 int min_height
3021 = ((FRAME_MINIBUF_ONLY_P (frame) || ! FRAME_HAS_MINIBUF_P (frame))
3022 ? MIN_SAFE_WINDOW_HEIGHT
3023 : 2 * MIN_SAFE_WINDOW_HEIGHT);
3025 if (FRAME_TOP_MARGIN (frame) > 0)
3026 min_height += FRAME_TOP_MARGIN (frame);
3028 if (*rows < min_height)
3029 *rows = min_height;
3030 if (*cols < MIN_SAFE_WINDOW_WIDTH)
3031 *cols = MIN_SAFE_WINDOW_WIDTH;
3034 /* Adjust the margins of window W if text area is too small.
3035 Return 1 if window width is ok after adjustment; 0 if window
3036 is still too narrow. */
3038 static int
3039 adjust_window_margins (struct window *w)
3041 int box_cols = (WINDOW_TOTAL_COLS (w)
3042 - WINDOW_FRINGE_COLS (w)
3043 - WINDOW_SCROLL_BAR_COLS (w));
3044 int margin_cols = (WINDOW_LEFT_MARGIN_COLS (w)
3045 + WINDOW_RIGHT_MARGIN_COLS (w));
3047 if (box_cols - margin_cols >= MIN_SAFE_WINDOW_WIDTH)
3048 return 1;
3050 if (margin_cols < 0 || box_cols < MIN_SAFE_WINDOW_WIDTH)
3051 return 0;
3053 /* Window's text area is too narrow, but reducing the window
3054 margins will fix that. */
3055 margin_cols = box_cols - MIN_SAFE_WINDOW_WIDTH;
3056 if (WINDOW_RIGHT_MARGIN_COLS (w) > 0)
3058 if (WINDOW_LEFT_MARGIN_COLS (w) > 0)
3060 wset_left_margin_cols (w, make_number (margin_cols / 2));
3061 wset_right_margin_cols (w, make_number (margin_cols / 2));
3063 else
3064 wset_right_margin_cols (w, make_number (margin_cols));
3066 else
3067 wset_left_margin_cols (w, make_number (margin_cols));
3068 return 1;
3071 /* The following three routines are needed for running a window's
3072 configuration change hook. */
3073 static void
3074 run_funs (Lisp_Object funs)
3076 for (; CONSP (funs); funs = XCDR (funs))
3077 if (!EQ (XCAR (funs), Qt))
3078 call0 (XCAR (funs));
3081 static Lisp_Object
3082 select_window_norecord (Lisp_Object window)
3084 return WINDOW_LIVE_P (window)
3085 ? Fselect_window (window, Qt) : selected_window;
3088 static Lisp_Object
3089 select_frame_norecord (Lisp_Object frame)
3091 return FRAME_LIVE_P (XFRAME (frame))
3092 ? Fselect_frame (frame, Qt) : selected_frame;
3095 void
3096 run_window_configuration_change_hook (struct frame *f)
3098 ptrdiff_t count = SPECPDL_INDEX ();
3099 Lisp_Object frame, global_wcch
3100 = Fdefault_value (Qwindow_configuration_change_hook);
3101 XSETFRAME (frame, f);
3103 if (NILP (Vrun_hooks) || !NILP (inhibit_lisp_code))
3104 return;
3106 /* Use the right buffer. Matters when running the local hooks. */
3107 if (current_buffer != XBUFFER (Fwindow_buffer (Qnil)))
3109 record_unwind_current_buffer ();
3110 Fset_buffer (Fwindow_buffer (Qnil));
3113 if (SELECTED_FRAME () != f)
3115 record_unwind_protect (select_frame_norecord, Fselected_frame ());
3116 select_frame_norecord (frame);
3119 /* Look for buffer-local values. */
3121 Lisp_Object windows = Fwindow_list (frame, Qlambda, Qnil);
3122 for (; CONSP (windows); windows = XCDR (windows))
3124 Lisp_Object window = XCAR (windows);
3125 Lisp_Object buffer = Fwindow_buffer (window);
3126 if (!NILP (Flocal_variable_p (Qwindow_configuration_change_hook,
3127 buffer)))
3129 ptrdiff_t inner_count = SPECPDL_INDEX ();
3130 record_unwind_protect (select_window_norecord, Fselected_window ());
3131 select_window_norecord (window);
3132 run_funs (Fbuffer_local_value (Qwindow_configuration_change_hook,
3133 buffer));
3134 unbind_to (inner_count, Qnil);
3139 run_funs (global_wcch);
3140 unbind_to (count, Qnil);
3143 DEFUN ("run-window-configuration-change-hook", Frun_window_configuration_change_hook,
3144 Srun_window_configuration_change_hook, 0, 1, 0,
3145 doc: /* Run `window-configuration-change-hook' for FRAME.
3146 If FRAME is omitted or nil, it defaults to the selected frame. */)
3147 (Lisp_Object frame)
3149 run_window_configuration_change_hook (decode_live_frame (frame));
3150 return Qnil;
3153 /* Make WINDOW display BUFFER as its contents. RUN_HOOKS_P non-zero
3154 means it's allowed to run hooks. See make_frame for a case where
3155 it's not allowed. KEEP_MARGINS_P non-zero means that the current
3156 margins, fringes, and scroll-bar settings of the window are not
3157 reset from the buffer's local settings. */
3159 void
3160 set_window_buffer (Lisp_Object window, Lisp_Object buffer, int run_hooks_p, int keep_margins_p)
3162 struct window *w = XWINDOW (window);
3163 struct buffer *b = XBUFFER (buffer);
3164 ptrdiff_t count = SPECPDL_INDEX ();
3165 int samebuf = EQ (buffer, w->buffer);
3167 wset_buffer (w, buffer);
3169 if (EQ (window, selected_window))
3170 bset_last_selected_window (b, window);
3172 /* Let redisplay errors through. */
3173 b->display_error_modiff = 0;
3175 /* Update time stamps of buffer display. */
3176 if (INTEGERP (BVAR (b, display_count)))
3177 bset_display_count (b, make_number (XINT (BVAR (b, display_count)) + 1));
3178 bset_display_time (b, Fcurrent_time ());
3180 wset_window_end_pos (w, make_number (0));
3181 wset_window_end_vpos (w, make_number (0));
3182 memset (&w->last_cursor, 0, sizeof w->last_cursor);
3184 if (!(keep_margins_p && samebuf))
3185 { /* If we're not actually changing the buffer, don't reset hscroll and
3186 vscroll. This case happens for example when called from
3187 change_frame_size_1, where we use a dummy call to
3188 Fset_window_buffer on the frame's selected window (and no other)
3189 just in order to run window-configuration-change-hook.
3190 Resetting hscroll and vscroll here is problematic for things like
3191 image-mode and doc-view-mode since it resets the image's position
3192 whenever we resize the frame. */
3193 w->hscroll = w->min_hscroll = 0;
3194 w->vscroll = 0;
3195 set_marker_both (w->pointm, buffer, BUF_PT (b), BUF_PT_BYTE (b));
3196 set_marker_restricted (w->start,
3197 make_number (b->last_window_start),
3198 buffer);
3199 w->start_at_line_beg = 0;
3200 w->force_start = 0;
3201 w->last_modified = 0;
3202 w->last_overlay_modified = 0;
3204 /* Maybe we could move this into the `if' but it's not obviously safe and
3205 I doubt it's worth the trouble. */
3206 windows_or_buffers_changed++;
3208 /* We must select BUFFER for running the window-scroll-functions. */
3209 /* We can't check ! NILP (Vwindow_scroll_functions) here
3210 because that might itself be a local variable. */
3211 if (window_initialized)
3213 record_unwind_current_buffer ();
3214 Fset_buffer (buffer);
3217 XMARKER (w->pointm)->insertion_type = !NILP (Vwindow_point_insertion_type);
3219 if (!keep_margins_p)
3221 /* Set left and right marginal area width etc. from buffer. */
3223 /* This may call adjust_window_margins three times, so
3224 temporarily disable window margins. */
3225 Lisp_Object save_left = w->left_margin_cols;
3226 Lisp_Object save_right = w->right_margin_cols;
3228 wset_left_margin_cols (w, Qnil);
3229 wset_right_margin_cols (w, Qnil);
3231 Fset_window_fringes (window,
3232 BVAR (b, left_fringe_width), BVAR (b, right_fringe_width),
3233 BVAR (b, fringes_outside_margins));
3235 Fset_window_scroll_bars (window,
3236 BVAR (b, scroll_bar_width),
3237 BVAR (b, vertical_scroll_bar_type), Qnil);
3239 wset_left_margin_cols (w, save_left);
3240 wset_right_margin_cols (w, save_right);
3242 Fset_window_margins (window,
3243 BVAR (b, left_margin_cols), BVAR (b, right_margin_cols));
3246 if (run_hooks_p)
3248 if (! NILP (Vwindow_scroll_functions))
3249 run_hook_with_args_2 (Qwindow_scroll_functions, window,
3250 Fmarker_position (w->start));
3251 run_window_configuration_change_hook (XFRAME (WINDOW_FRAME (w)));
3254 unbind_to (count, Qnil);
3257 DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 3, 0,
3258 doc: /* Make WINDOW display BUFFER-OR-NAME as its contents.
3259 WINDOW must be a live window and defaults to the selected one.
3260 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
3262 Optional third argument KEEP-MARGINS non-nil means that WINDOW's current
3263 display margins, fringe widths, and scroll bar settings are preserved;
3264 the default is to reset these from the local settings for BUFFER-OR-NAME
3265 or the frame defaults. Return nil.
3267 This function throws an error when WINDOW is strongly dedicated to its
3268 buffer (that is `window-dedicated-p' returns t for WINDOW) and does not
3269 already display BUFFER-OR-NAME.
3271 This function runs `window-scroll-functions' before running
3272 `window-configuration-change-hook'. */)
3273 (register Lisp_Object window, Lisp_Object buffer_or_name, Lisp_Object keep_margins)
3275 register Lisp_Object tem, buffer;
3276 register struct window *w = decode_live_window (window);
3278 XSETWINDOW (window, w);
3279 buffer = Fget_buffer (buffer_or_name);
3280 CHECK_BUFFER (buffer);
3281 if (!BUFFER_LIVE_P (XBUFFER (buffer)))
3282 error ("Attempt to display deleted buffer");
3284 tem = w->buffer;
3285 if (NILP (tem))
3286 error ("Window is deleted");
3287 else
3289 if (!EQ (tem, buffer))
3291 if (EQ (w->dedicated, Qt))
3292 /* WINDOW is strongly dedicated to its buffer, signal an
3293 error. */
3294 error ("Window is dedicated to `%s'", SDATA (BVAR (XBUFFER (tem), name)));
3295 else
3296 /* WINDOW is weakly dedicated to its buffer, reset
3297 dedication. */
3298 wset_dedicated (w, Qnil);
3300 call1 (Qrecord_window_buffer, window);
3303 unshow_buffer (w);
3306 set_window_buffer (window, buffer, 1, !NILP (keep_margins));
3308 return Qnil;
3311 static Lisp_Object
3312 display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame)
3314 return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame);
3317 DEFUN ("force-window-update", Fforce_window_update, Sforce_window_update,
3318 0, 1, 0,
3319 doc: /* Force all windows to be updated on next redisplay.
3320 If optional arg OBJECT is a window, force redisplay of that window only.
3321 If OBJECT is a buffer or buffer name, force redisplay of all windows
3322 displaying that buffer. */)
3323 (Lisp_Object object)
3325 if (NILP (object))
3327 windows_or_buffers_changed++;
3328 update_mode_lines++;
3329 return Qt;
3332 if (WINDOWP (object))
3334 struct window *w = XWINDOW (object);
3335 mark_window_display_accurate (object, 0);
3336 w->update_mode_line = 1;
3337 if (BUFFERP (w->buffer))
3338 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
3339 ++update_mode_lines;
3340 return Qt;
3343 if (STRINGP (object))
3344 object = Fget_buffer (object);
3345 if (BUFFERP (object) && BUFFER_LIVE_P (XBUFFER (object))
3346 && buffer_window_count (XBUFFER (object)))
3348 /* If buffer is live and shown in at least one window, find
3349 all windows showing this buffer and force update of them. */
3350 object = window_loop (REDISPLAY_BUFFER_WINDOWS, object, 0, Qvisible);
3351 return NILP (object) ? Qnil : Qt;
3354 /* If nothing suitable was found, just return.
3355 We could signal an error, but this feature will typically be used
3356 asynchronously in timers or process sentinels, so we don't. */
3357 return Qnil;
3360 /* Obsolete since 24.3. */
3361 void
3362 temp_output_buffer_show (register Lisp_Object buf)
3364 register struct buffer *old = current_buffer;
3365 register Lisp_Object window;
3366 register struct window *w;
3368 bset_directory (XBUFFER (buf), BVAR (current_buffer, directory));
3370 Fset_buffer (buf);
3371 BUF_SAVE_MODIFF (XBUFFER (buf)) = MODIFF;
3372 BEGV = BEG;
3373 ZV = Z;
3374 SET_PT (BEG);
3375 set_buffer_internal (old);
3377 if (!NILP (Vtemp_buffer_show_function))
3378 call1 (Vtemp_buffer_show_function, buf);
3379 else
3381 window = display_buffer (buf, Qnil, Qnil);
3383 if (!EQ (XWINDOW (window)->frame, selected_frame))
3384 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window)));
3385 Vminibuf_scroll_window = window;
3386 w = XWINDOW (window);
3387 w->hscroll = 0;
3388 w->min_hscroll = 0;
3389 set_marker_restricted_both (w->start, buf, BEG, BEG);
3390 set_marker_restricted_both (w->pointm, buf, BEG, BEG);
3392 /* Run temp-buffer-show-hook, with the chosen window selected
3393 and its buffer current. */
3395 ptrdiff_t count = SPECPDL_INDEX ();
3396 Lisp_Object prev_window, prev_buffer;
3397 prev_window = selected_window;
3398 XSETBUFFER (prev_buffer, old);
3400 /* Select the window that was chosen, for running the hook.
3401 Note: Both Fselect_window and select_window_norecord may
3402 set-buffer to the buffer displayed in the window,
3403 so we need to save the current buffer. --stef */
3404 record_unwind_protect (Fset_buffer, prev_buffer);
3405 record_unwind_protect (select_window_norecord, prev_window);
3406 Fselect_window (window, Qt);
3407 Fset_buffer (w->buffer);
3408 Frun_hooks (1, &Qtemp_buffer_show_hook);
3409 unbind_to (count, Qnil);
3414 /* Make new window, have it replace WINDOW in window-tree, and make
3415 WINDOW its only vertical child (HORFLAG 1 means make WINDOW its only
3416 horizontal child). */
3417 static void
3418 make_parent_window (Lisp_Object window, int horflag)
3420 Lisp_Object parent;
3421 register struct window *o, *p;
3423 o = XWINDOW (window);
3424 p = allocate_window ();
3425 memcpy ((char *) p + sizeof (struct vectorlike_header),
3426 (char *) o + sizeof (struct vectorlike_header),
3427 word_size * VECSIZE (struct window));
3428 /* P's buffer slot may change from nil to a buffer. */
3429 adjust_window_count (p, 1);
3430 XSETWINDOW (parent, p);
3432 p->sequence_number = ++sequence_number;
3434 replace_window (window, parent, 1);
3436 wset_next (o, Qnil);
3437 wset_prev (o, Qnil);
3438 wset_parent (o, parent);
3440 wset_hchild (p, horflag ? window : Qnil);
3441 wset_vchild (p, horflag ? Qnil : window);
3442 wset_start (p, Qnil);
3443 wset_pointm (p, Qnil);
3444 wset_buffer (p, Qnil);
3445 wset_combination_limit (p, Qnil);
3446 wset_window_parameters (p, Qnil);
3449 /* Make new window from scratch. */
3450 Lisp_Object
3451 make_window (void)
3453 Lisp_Object window;
3454 register struct window *w;
3456 w = allocate_window ();
3457 /* Initialize Lisp data. Note that allocate_window initializes all
3458 Lisp data to nil, so do it only for slots which should not be nil. */
3459 wset_left_col (w, make_number (0));
3460 wset_top_line (w, make_number (0));
3461 wset_total_lines (w, make_number (0));
3462 wset_total_cols (w, make_number (0));
3463 wset_normal_lines (w, make_float (1.0));
3464 wset_normal_cols (w, make_float (1.0));
3465 wset_new_total (w, make_number (0));
3466 wset_new_normal (w, make_number (0));
3467 wset_start (w, Fmake_marker ());
3468 wset_pointm (w, Fmake_marker ());
3469 wset_vertical_scroll_bar_type (w, Qt);
3470 wset_window_end_pos (w, make_number (0));
3471 wset_window_end_vpos (w, make_number (0));
3472 /* These Lisp fields are marked specially so they're not set to nil by
3473 allocate_window. */
3474 wset_prev_buffers (w, Qnil);
3475 wset_next_buffers (w, Qnil);
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, 0, 2, 0,
3678 doc: /* Apply requested size values for window-tree of FRAME.
3679 If FRAME is omitted or nil, it defaults to the selected frame.
3681 Optional argument HORIZONTAL omitted or nil means apply requested
3682 height values. HORIZONTAL non-nil means apply requested width values.
3684 This function checks whether the requested values sum up to a valid
3685 window layout, recursively assigns the new sizes of all child windows
3686 and calculates and assigns the new start positions of these windows.
3688 Note: This function does not check any of `window-fixed-size-p',
3689 `window-min-height' or `window-min-width'. All these checks have to
3690 be applied on the Elisp level. */)
3691 (Lisp_Object frame, Lisp_Object horizontal)
3693 struct frame *f = decode_live_frame (frame);
3694 struct window *r = XWINDOW (FRAME_ROOT_WINDOW (f));
3695 int horflag = !NILP (horizontal);
3697 if (!window_resize_check (r, horflag)
3698 || ! EQ (r->new_total,
3699 (horflag ? r->total_cols : r->total_lines)))
3700 return Qnil;
3702 block_input ();
3703 window_resize_apply (r, horflag);
3705 windows_or_buffers_changed++;
3706 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3708 adjust_glyphs (f);
3709 unblock_input ();
3711 run_window_configuration_change_hook (f);
3713 return Qt;
3717 /* Resize frame F's windows when number of lines of F is set to SIZE.
3718 HORFLAG 1 means resize windows when number of columns of F is set to
3719 SIZE.
3721 This function can delete all windows but the selected one in order to
3722 satisfy the request. The result will be meaningful if and only if
3723 F's windows have meaningful sizes when you call this. */
3724 void
3725 resize_frame_windows (struct frame *f, int size, int horflag)
3727 Lisp_Object root = f->root_window;
3728 struct window *r = XWINDOW (root);
3729 Lisp_Object mini = f->minibuffer_window;
3730 struct window *m;
3731 /* new_size is the new size of the frame's root window. */
3732 int new_size = (horflag
3733 ? size
3734 : (size
3735 - FRAME_TOP_MARGIN (f)
3736 - ((FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3737 ? 1 : 0)));
3739 wset_top_line (r, make_number (FRAME_TOP_MARGIN (f)));
3740 if (NILP (r->vchild) && NILP (r->hchild))
3741 /* For a leaf root window just set the size. */
3742 if (horflag)
3743 wset_total_cols (r, make_number (new_size));
3744 else
3745 wset_total_lines (r, make_number (new_size));
3746 else
3748 /* old_size is the old size of the frame's root window. */
3749 int old_size = XFASTINT (horflag ? r->total_cols
3750 : r->total_lines);
3751 Lisp_Object delta;
3753 XSETINT (delta, new_size - old_size);
3754 /* Try a "normal" resize first. */
3755 resize_root_window (root, delta, horflag ? Qt : Qnil, Qnil);
3756 if (window_resize_check (r, horflag)
3757 && new_size == XINT (r->new_total))
3758 window_resize_apply (r, horflag);
3759 else
3761 /* Try with "reasonable" minimum sizes next. */
3762 resize_root_window (root, delta, horflag ? Qt : Qnil, Qt);
3763 if (window_resize_check (r, horflag)
3764 && new_size == XINT (r->new_total))
3765 window_resize_apply (r, horflag);
3766 else
3768 /* Finally, try with "safe" minimum sizes. */
3769 resize_root_window (root, delta, horflag ? Qt : Qnil, Qsafe);
3770 if (window_resize_check (r, horflag)
3771 && new_size == XINT (r->new_total))
3772 window_resize_apply (r, horflag);
3773 else
3775 /* We lost. Delete all windows but the frame's
3776 selected one. */
3777 root = f->selected_window;
3778 Fdelete_other_windows_internal (root, Qnil);
3779 if (horflag)
3780 wset_total_cols (XWINDOW (root), make_number (new_size));
3781 else
3782 wset_total_lines (XWINDOW (root), make_number (new_size));
3788 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
3790 m = XWINDOW (mini);
3791 if (horflag)
3792 wset_total_cols (m, make_number (size));
3793 else
3795 /* Are we sure we always want 1 line here? */
3796 wset_total_lines (m, make_number (1));
3797 wset_top_line
3798 (m, make_number (XINT (r->top_line) + XINT (r->total_lines)));
3802 windows_or_buffers_changed++;
3806 DEFUN ("split-window-internal", Fsplit_window_internal, Ssplit_window_internal, 4, 4, 0,
3807 doc: /* Split window OLD.
3808 Second argument TOTAL-SIZE specifies the number of lines or columns of the
3809 new window. In any case TOTAL-SIZE must be a positive integer.
3811 Third argument SIDE nil (or `below') specifies that the new window shall
3812 be located below WINDOW. SIDE `above' means the new window shall be
3813 located above WINDOW. In both cases TOTAL-SIZE specifies the number of
3814 lines of the new window including space reserved for the mode and/or
3815 header line.
3817 SIDE t (or `right') specifies that the new window shall be located on
3818 the right side of WINDOW. SIDE `left' means the new window shall be
3819 located on the left of WINDOW. In both cases TOTAL-SIZE specifies the
3820 number of columns of the new window including space reserved for fringes
3821 and the scrollbar or a divider column.
3823 Fourth argument NORMAL-SIZE specifies the normal size of the new window
3824 according to the SIDE argument.
3826 The new total and normal sizes of all involved windows must have been
3827 set correctly. See the code of `split-window' for how this is done. */)
3828 (Lisp_Object old, Lisp_Object total_size, Lisp_Object side, Lisp_Object normal_size)
3830 /* OLD (*o) is the window we have to split. (*p) is either OLD's
3831 parent window or an internal window we have to install as OLD's new
3832 parent. REFERENCE (*r) must denote a live window, or is set to OLD
3833 provided OLD is a leaf window, or to the frame's selected window.
3834 NEW (*n) is the new window created with some parameters taken from
3835 REFERENCE (*r). */
3836 register Lisp_Object new, frame, reference;
3837 register struct window *o, *p, *n, *r;
3838 struct frame *f;
3839 int horflag
3840 /* HORFLAG is 1 when we split side-by-side, 0 otherwise. */
3841 = EQ (side, Qt) || EQ (side, Qleft) || EQ (side, Qright);
3842 int combination_limit = 0;
3844 CHECK_WINDOW (old);
3845 o = XWINDOW (old);
3846 frame = WINDOW_FRAME (o);
3847 f = XFRAME (frame);
3849 CHECK_NUMBER (total_size);
3851 /* Set combination_limit to 1 if we have to make a new parent window.
3852 We do that if either `window-combination-limit' is t, or OLD has no
3853 parent, or OLD is ortho-combined. */
3854 combination_limit =
3855 EQ (Vwindow_combination_limit, Qt)
3856 || NILP (o->parent)
3857 || NILP (horflag
3858 ? (XWINDOW (o->parent)->hchild)
3859 : (XWINDOW (o->parent)->vchild));
3861 /* We need a live reference window to initialize some parameters. */
3862 if (WINDOW_LIVE_P (old))
3863 /* OLD is live, use it as reference window. */
3864 reference = old;
3865 else
3866 /* Use the frame's selected window as reference window. */
3867 reference = FRAME_SELECTED_WINDOW (f);
3868 r = XWINDOW (reference);
3870 /* The following bugs are caught by `split-window'. */
3871 if (MINI_WINDOW_P (o))
3872 error ("Attempt to split minibuffer window");
3873 else if (XINT (total_size) < (horflag ? 2 : 1))
3874 error ("Size of new window too small (after split)");
3875 else if (!combination_limit && !NILP (Vwindow_combination_resize))
3876 /* `window-combination-resize' non-nil means try to resize OLD's siblings
3877 proportionally. */
3879 p = XWINDOW (o->parent);
3880 /* Temporarily pretend we split the parent window. */
3881 wset_new_total
3882 (p, make_number (XINT (horflag ? p->total_cols : p->total_lines)
3883 - XINT (total_size)));
3884 if (!window_resize_check (p, horflag))
3885 error ("Window sizes don't fit");
3886 else
3887 /* Undo the temporary pretension. */
3888 wset_new_total (p, horflag ? p->total_cols : p->total_lines);
3890 else
3892 if (!window_resize_check (o, horflag))
3893 error ("Resizing old window failed");
3894 else if (XINT (total_size) + XINT (o->new_total)
3895 != XINT (horflag ? o->total_cols : o->total_lines))
3896 error ("Sum of sizes of old and new window don't fit");
3899 /* This is our point of no return. */
3900 if (combination_limit)
3902 /* Save the old value of o->normal_cols/lines. It gets corrupted
3903 by make_parent_window and we need it below for assigning it to
3904 p->new_normal. */
3905 Lisp_Object new_normal
3906 = horflag ? o->normal_cols : o->normal_lines;
3908 make_parent_window (old, horflag);
3909 p = XWINDOW (o->parent);
3910 if (EQ (Vwindow_combination_limit, Qt))
3911 /* Store t in the new parent's combination_limit slot to avoid
3912 that its children get merged into another window. */
3913 wset_combination_limit (p, Qt);
3914 /* These get applied below. */
3915 wset_new_total (p, horflag ? o->total_cols : o->total_lines);
3916 wset_new_normal (p, new_normal);
3918 else
3919 p = XWINDOW (o->parent);
3921 windows_or_buffers_changed++;
3922 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
3923 new = make_window ();
3924 n = XWINDOW (new);
3925 wset_frame (n, frame);
3926 wset_parent (n, o->parent);
3927 wset_vchild (n, Qnil);
3928 wset_hchild (n, Qnil);
3930 if (EQ (side, Qabove) || EQ (side, Qleft))
3932 wset_prev (n, o->prev);
3933 if (NILP (n->prev))
3934 if (horflag)
3935 wset_hchild (p, new);
3936 else
3937 wset_vchild (p, new);
3938 else
3939 wset_next (XWINDOW (n->prev), new);
3940 wset_next (n, old);
3941 wset_prev (o, new);
3943 else
3945 wset_next (n, o->next);
3946 if (!NILP (n->next))
3947 wset_prev (XWINDOW (n->next), new);
3948 wset_prev (n, old);
3949 wset_next (o, new);
3952 n->window_end_valid = 0;
3953 memset (&n->last_cursor, 0, sizeof n->last_cursor);
3955 /* Get special geometry settings from reference window. */
3956 wset_left_margin_cols (n, r->left_margin_cols);
3957 wset_right_margin_cols (n, r->right_margin_cols);
3958 wset_left_fringe_width (n, r->left_fringe_width);
3959 wset_right_fringe_width (n, r->right_fringe_width);
3960 n->fringes_outside_margins = r->fringes_outside_margins;
3961 wset_scroll_bar_width (n, r->scroll_bar_width);
3962 wset_vertical_scroll_bar_type (n, r->vertical_scroll_bar_type);
3964 /* Directly assign orthogonal coordinates and sizes. */
3965 if (horflag)
3967 wset_top_line (n, o->top_line);
3968 wset_total_lines (n, o->total_lines);
3970 else
3972 wset_left_col (n, o->left_col);
3973 wset_total_cols (n, o->total_cols);
3976 /* Iso-coordinates and sizes are assigned by window_resize_apply,
3977 get them ready here. */
3978 wset_new_total (n, total_size);
3979 wset_new_normal (n, normal_size);
3981 block_input ();
3982 window_resize_apply (p, horflag);
3983 adjust_glyphs (f);
3984 /* Set buffer of NEW to buffer of reference window. Don't run
3985 any hooks. */
3986 set_window_buffer (new, r->buffer, 0, 1);
3987 unblock_input ();
3989 /* Maybe we should run the scroll functions in Elisp (which already
3990 runs the configuration change hook). */
3991 if (! NILP (Vwindow_scroll_functions))
3992 run_hook_with_args_2 (Qwindow_scroll_functions, new,
3993 Fmarker_position (n->start));
3994 /* Return NEW. */
3995 return new;
3999 DEFUN ("delete-window-internal", Fdelete_window_internal, Sdelete_window_internal, 1, 1, 0,
4000 doc: /* Remove WINDOW from its frame.
4001 WINDOW defaults to the selected window. Return nil.
4002 Signal an error when WINDOW is the only window on its frame. */)
4003 (register Lisp_Object window)
4005 register Lisp_Object parent, sibling, frame, root;
4006 struct window *w, *p, *s, *r;
4007 struct frame *f;
4008 int horflag;
4009 int before_sibling = 0;
4011 w = decode_any_window (window);
4012 XSETWINDOW (window, w);
4013 if (NILP (w->buffer)
4014 && NILP (w->hchild) && NILP (w->vchild))
4015 /* It's a no-op to delete an already deleted window. */
4016 return Qnil;
4018 parent = w->parent;
4019 if (NILP (parent))
4020 /* Never delete a minibuffer or frame root window. */
4021 error ("Attempt to delete minibuffer or sole ordinary window");
4022 else if (NILP (w->prev) && NILP (w->next))
4023 /* Rather bow out here, this case should be handled on the Elisp
4024 level. */
4025 error ("Attempt to delete sole window of parent");
4027 p = XWINDOW (parent);
4028 horflag = NILP (p->vchild);
4030 frame = WINDOW_FRAME (w);
4031 f = XFRAME (frame);
4033 root = FRAME_ROOT_WINDOW (f);
4034 r = XWINDOW (root);
4036 /* Unlink WINDOW from window tree. */
4037 if (NILP (w->prev))
4038 /* Get SIBLING below (on the right of) WINDOW. */
4040 /* before_sibling 1 means WINDOW is the first child of its
4041 parent and thus before the sibling. */
4042 before_sibling = 1;
4043 sibling = w->next;
4044 s = XWINDOW (sibling);
4045 wset_prev (s, Qnil);
4046 if (horflag)
4047 wset_hchild (p, sibling);
4048 else
4049 wset_vchild (p, sibling);
4051 else
4052 /* Get SIBLING above (on the left of) WINDOW. */
4054 sibling = w->prev;
4055 s = XWINDOW (sibling);
4056 wset_next (s, w->next);
4057 if (!NILP (s->next))
4058 wset_prev (XWINDOW (s->next), sibling);
4061 if (window_resize_check (r, horflag)
4062 && EQ (r->new_total,
4063 (horflag ? r->total_cols : r->total_lines)))
4064 /* We can delete WINDOW now. */
4067 /* Block input. */
4068 block_input ();
4069 window_resize_apply (p, horflag);
4071 /* If this window is referred to by the dpyinfo's mouse
4072 highlight, invalidate that slot to be safe (Bug#9904). */
4073 if (!FRAME_INITIAL_P (f))
4075 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
4077 if (EQ (hlinfo->mouse_face_window, window))
4078 hlinfo->mouse_face_window = Qnil;
4081 windows_or_buffers_changed++;
4082 Vwindow_list = Qnil;
4083 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4085 wset_next (w, Qnil); /* Don't delete w->next too. */
4086 free_window_matrices (w);
4088 if (!NILP (w->vchild))
4090 delete_all_child_windows (w->vchild);
4091 wset_vchild (w, Qnil);
4093 else if (!NILP (w->hchild))
4095 delete_all_child_windows (w->hchild);
4096 wset_hchild (w, Qnil);
4098 else if (!NILP (w->buffer))
4100 unshow_buffer (w);
4101 unchain_marker (XMARKER (w->pointm));
4102 unchain_marker (XMARKER (w->start));
4103 wset_buffer (w, Qnil);
4106 if (NILP (s->prev) && NILP (s->next))
4107 /* A matrjoshka where SIBLING has become the only child of
4108 PARENT. */
4110 /* Put SIBLING into PARENT's place. */
4111 replace_window (parent, sibling, 0);
4112 /* Have SIBLING inherit the following three slot values from
4113 PARENT (the combination_limit slot is not inherited). */
4114 wset_normal_cols (s, p->normal_cols);
4115 wset_normal_lines (s, p->normal_lines);
4116 /* Mark PARENT as deleted. */
4117 wset_vchild (p, Qnil);
4118 wset_hchild (p, Qnil);
4119 /* Try to merge SIBLING into its new parent. */
4120 recombine_windows (sibling);
4123 adjust_glyphs (f);
4125 if (!WINDOW_LIVE_P (FRAME_SELECTED_WINDOW (f)))
4126 /* We deleted the frame's selected window. */
4128 /* Use the frame's first window as fallback ... */
4129 Lisp_Object new_selected_window = Fframe_first_window (frame);
4130 /* ... but preferably use its most recently used window. */
4131 Lisp_Object mru_window;
4133 /* `get-mru-window' might fail for some reason so play it safe
4134 - promote the first window _without recording it_ first. */
4135 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4136 Fselect_window (new_selected_window, Qt);
4137 else
4138 fset_selected_window (f, new_selected_window);
4140 unblock_input ();
4142 /* Now look whether `get-mru-window' gets us something. */
4143 mru_window = call1 (Qget_mru_window, frame);
4144 if (WINDOW_LIVE_P (mru_window)
4145 && EQ (XWINDOW (mru_window)->frame, frame))
4146 new_selected_window = mru_window;
4148 /* If all ended up well, we now promote the mru window. */
4149 if (EQ (FRAME_SELECTED_WINDOW (f), selected_window))
4150 Fselect_window (new_selected_window, Qnil);
4151 else
4152 fset_selected_window (f, new_selected_window);
4154 else
4155 unblock_input ();
4157 /* Must be run by the caller:
4158 run_window_configuration_change_hook (f); */
4160 else
4161 /* We failed: Relink WINDOW into window tree. */
4163 if (before_sibling)
4165 wset_prev (s, window);
4166 if (horflag)
4167 wset_hchild (p, window);
4168 else
4169 wset_vchild (p, window);
4171 else
4173 wset_next (s, window);
4174 if (!NILP (w->next))
4175 wset_prev (XWINDOW (w->next), window);
4177 error ("Deletion failed");
4180 return Qnil;
4183 /***********************************************************************
4184 Resizing Mini-Windows
4185 ***********************************************************************/
4187 /* Grow mini-window W by DELTA lines, DELTA >= 0, or as much as we
4188 can. */
4189 void
4190 grow_mini_window (struct window *w, int delta)
4192 struct frame *f = XFRAME (w->frame);
4193 struct window *r;
4194 Lisp_Object root, value;
4196 eassert (MINI_WINDOW_P (w));
4197 eassert (delta >= 0);
4199 root = FRAME_ROOT_WINDOW (f);
4200 r = XWINDOW (root);
4201 value = call2 (Qwindow_resize_root_window_vertically,
4202 root, make_number (- delta));
4203 if (INTEGERP (value) && window_resize_check (r, 0))
4205 block_input ();
4206 window_resize_apply (r, 0);
4208 /* Grow the mini-window. */
4209 wset_top_line
4210 (w, make_number (XFASTINT (r->top_line) + XFASTINT (r->total_lines)));
4211 wset_total_lines
4212 (w, make_number (XFASTINT (w->total_lines) - XINT (value)));
4213 w->last_modified = 0;
4214 w->last_overlay_modified = 0;
4216 windows_or_buffers_changed++;
4217 adjust_glyphs (f);
4218 unblock_input ();
4223 /* Shrink mini-window W. */
4224 void
4225 shrink_mini_window (struct window *w)
4227 struct frame *f = XFRAME (w->frame);
4228 struct window *r;
4229 Lisp_Object root, value;
4230 EMACS_INT size;
4232 eassert (MINI_WINDOW_P (w));
4234 size = XINT (w->total_lines);
4235 if (size > 1)
4237 root = FRAME_ROOT_WINDOW (f);
4238 r = XWINDOW (root);
4239 value = call2 (Qwindow_resize_root_window_vertically,
4240 root, make_number (size - 1));
4241 if (INTEGERP (value) && window_resize_check (r, 0))
4243 block_input ();
4244 window_resize_apply (r, 0);
4246 /* Shrink the mini-window. */
4247 wset_top_line (w, make_number (XFASTINT (r->top_line)
4248 + XFASTINT (r->total_lines)));
4249 wset_total_lines (w, make_number (1));
4251 w->last_modified = 0;
4252 w->last_overlay_modified = 0;
4254 windows_or_buffers_changed++;
4255 adjust_glyphs (f);
4256 unblock_input ();
4258 /* If the above failed for whatever strange reason we must make a
4259 one window frame here. The same routine will be needed when
4260 shrinking the frame (and probably when making the initial
4261 *scratch* window). For the moment leave things as they are. */
4265 DEFUN ("resize-mini-window-internal", Fresize_mini_window_internal, Sresize_mini_window_internal, 1, 1, 0,
4266 doc: /* Resize minibuffer window WINDOW. */)
4267 (Lisp_Object window)
4269 struct window *w = XWINDOW (window);
4270 struct window *r;
4271 struct frame *f;
4272 int height;
4274 CHECK_WINDOW (window);
4275 f = XFRAME (w->frame);
4277 if (!EQ (FRAME_MINIBUF_WINDOW (XFRAME (w->frame)), window))
4278 error ("Not a valid minibuffer window");
4279 else if (FRAME_MINIBUF_ONLY_P (f))
4280 error ("Cannot resize a minibuffer-only frame");
4282 r = XWINDOW (FRAME_ROOT_WINDOW (f));
4283 height = XINT (r->total_lines) + XINT (w->total_lines);
4284 if (window_resize_check (r, 0)
4285 && XINT (w->new_total) > 0
4286 && height == XINT (r->new_total) + XINT (w->new_total))
4288 block_input ();
4289 window_resize_apply (r, 0);
4291 wset_total_lines (w, w->new_total);
4292 wset_top_line (w, make_number (XINT (r->top_line)
4293 + XINT (r->total_lines)));
4295 windows_or_buffers_changed++;
4296 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
4297 adjust_glyphs (f);
4298 unblock_input ();
4300 run_window_configuration_change_hook (f);
4301 return Qt;
4303 else error ("Failed to resize minibuffer window");
4306 /* Mark window cursors off for all windows in the window tree rooted
4307 at W by setting their phys_cursor_on_p flag to zero. Called from
4308 xterm.c, e.g. when a frame is cleared and thereby all cursors on
4309 the frame are cleared. */
4311 void
4312 mark_window_cursors_off (struct window *w)
4314 while (w)
4316 if (!NILP (w->hchild))
4317 mark_window_cursors_off (XWINDOW (w->hchild));
4318 else if (!NILP (w->vchild))
4319 mark_window_cursors_off (XWINDOW (w->vchild));
4320 else
4321 w->phys_cursor_on_p = 0;
4323 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4328 /* Return number of lines of text (not counting mode lines) in W. */
4331 window_internal_height (struct window *w)
4333 int ht = XFASTINT (w->total_lines);
4335 if (!MINI_WINDOW_P (w))
4337 if (!NILP (w->parent)
4338 || !NILP (w->vchild)
4339 || !NILP (w->hchild)
4340 || !NILP (w->next)
4341 || !NILP (w->prev)
4342 || WINDOW_WANTS_MODELINE_P (w))
4343 --ht;
4345 if (WINDOW_WANTS_HEADER_LINE_P (w))
4346 --ht;
4349 return ht;
4352 /************************************************************************
4353 Window Scrolling
4354 ***********************************************************************/
4356 /* Scroll contents of window WINDOW up. If WHOLE is non-zero, scroll
4357 N screen-fulls, which is defined as the height of the window minus
4358 next_screen_context_lines. If WHOLE is zero, scroll up N lines
4359 instead. Negative values of N mean scroll down. NOERROR non-zero
4360 means don't signal an error if we try to move over BEGV or ZV,
4361 respectively. */
4363 static void
4364 window_scroll (Lisp_Object window, EMACS_INT n, int whole, int noerror)
4366 immediate_quit = 1;
4367 n = clip_to_bounds (INT_MIN, n, INT_MAX);
4369 /* If we must, use the pixel-based version which is much slower than
4370 the line-based one but can handle varying line heights. */
4371 if (FRAME_WINDOW_P (XFRAME (XWINDOW (window)->frame)))
4372 window_scroll_pixel_based (window, n, whole, noerror);
4373 else
4374 window_scroll_line_based (window, n, whole, noerror);
4376 immediate_quit = 0;
4380 /* Implementation of window_scroll that works based on pixel line
4381 heights. See the comment of window_scroll for parameter
4382 descriptions. */
4384 static void
4385 window_scroll_pixel_based (Lisp_Object window, int n, int whole, int noerror)
4387 struct it it;
4388 struct window *w = XWINDOW (window);
4389 struct text_pos start;
4390 int this_scroll_margin;
4391 /* True if we fiddled the window vscroll field without really scrolling. */
4392 int vscrolled = 0;
4393 int x, y, rtop, rbot, rowh, vpos;
4394 void *itdata = NULL;
4396 SET_TEXT_POS_FROM_MARKER (start, w->start);
4397 /* Scrolling a minibuffer window via scroll bar when the echo area
4398 shows long text sometimes resets the minibuffer contents behind
4399 our backs. */
4400 if (CHARPOS (start) > ZV)
4401 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
4403 /* If PT is not visible in WINDOW, move back one half of
4404 the screen. Allow PT to be partially visible, otherwise
4405 something like (scroll-down 1) with PT in the line before
4406 the partially visible one would recenter. */
4408 if (!pos_visible_p (w, PT, &x, &y, &rtop, &rbot, &rowh, &vpos))
4410 itdata = bidi_shelve_cache ();
4411 /* Move backward half the height of the window. Performance note:
4412 vmotion used here is about 10% faster, but would give wrong
4413 results for variable height lines. */
4414 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4415 it.current_y = it.last_visible_y;
4416 move_it_vertically_backward (&it, window_box_height (w) / 2);
4418 /* The function move_iterator_vertically may move over more than
4419 the specified y-distance. If it->w is small, e.g. a
4420 mini-buffer window, we may end up in front of the window's
4421 display area. This is the case when Start displaying at the
4422 start of the line containing PT in this case. */
4423 if (it.current_y <= 0)
4425 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
4426 move_it_vertically_backward (&it, 0);
4427 it.current_y = 0;
4430 start = it.current.pos;
4431 bidi_unshelve_cache (itdata, 0);
4433 else if (auto_window_vscroll_p)
4435 if (rtop || rbot) /* partially visible */
4437 int px;
4438 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4439 if (whole)
4440 dy = max ((window_box_height (w)
4441 - next_screen_context_lines * dy),
4442 dy);
4443 dy *= n;
4445 if (n < 0)
4447 /* Only vscroll backwards if already vscrolled forwards. */
4448 if (w->vscroll < 0 && rtop > 0)
4450 px = max (0, -w->vscroll - min (rtop, -dy));
4451 Fset_window_vscroll (window, make_number (px), Qt);
4452 return;
4455 if (n > 0)
4457 /* Do vscroll if already vscrolled or only display line. */
4458 if (rbot > 0 && (w->vscroll < 0 || vpos == 0))
4460 px = max (0, -w->vscroll + min (rbot, dy));
4461 Fset_window_vscroll (window, make_number (px), Qt);
4462 return;
4465 /* Maybe modify window start instead of scrolling. */
4466 if (rbot > 0 || w->vscroll < 0)
4468 ptrdiff_t spos;
4470 Fset_window_vscroll (window, make_number (0), Qt);
4471 /* If there are other text lines above the current row,
4472 move window start to current row. Else to next row. */
4473 if (rbot > 0)
4474 spos = XINT (Fline_beginning_position (Qnil));
4475 else
4476 spos = min (XINT (Fline_end_position (Qnil)) + 1, ZV);
4477 set_marker_restricted (w->start, make_number (spos),
4478 w->buffer);
4479 w->start_at_line_beg = 1;
4480 w->update_mode_line = 1;
4481 w->last_modified = 0;
4482 w->last_overlay_modified = 0;
4483 /* Set force_start so that redisplay_window will run the
4484 window-scroll-functions. */
4485 w->force_start = 1;
4486 return;
4490 /* Cancel previous vscroll. */
4491 Fset_window_vscroll (window, make_number (0), Qt);
4494 itdata = bidi_shelve_cache ();
4495 /* If scroll_preserve_screen_position is non-nil, we try to set
4496 point in the same window line as it is now, so get that line. */
4497 if (!NILP (Vscroll_preserve_screen_position))
4499 /* We preserve the goal pixel coordinate across consecutive
4500 calls to scroll-up, scroll-down and other commands that
4501 have the `scroll-command' property. This avoids the
4502 possibility of point becoming "stuck" on a tall line when
4503 scrolling by one line. */
4504 if (window_scroll_pixel_based_preserve_y < 0
4505 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4506 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4508 start_display (&it, w, start);
4509 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4510 window_scroll_pixel_based_preserve_y = it.current_y;
4511 window_scroll_pixel_based_preserve_x = it.current_x;
4514 else
4515 window_scroll_pixel_based_preserve_y
4516 = window_scroll_pixel_based_preserve_x = -1;
4518 /* Move iterator it from start the specified distance forward or
4519 backward. The result is the new window start. */
4520 start_display (&it, w, start);
4521 if (whole)
4523 ptrdiff_t start_pos = IT_CHARPOS (it);
4524 int dy = WINDOW_FRAME_LINE_HEIGHT (w);
4525 dy = max ((window_box_height (w)
4526 - next_screen_context_lines * dy),
4527 dy) * n;
4529 /* Note that move_it_vertically always moves the iterator to the
4530 start of a line. So, if the last line doesn't have a newline,
4531 we would end up at the start of the line ending at ZV. */
4532 if (dy <= 0)
4534 move_it_vertically_backward (&it, -dy);
4535 /* Ensure we actually do move, e.g. in case we are currently
4536 looking at an image that is taller that the window height. */
4537 while (start_pos == IT_CHARPOS (it)
4538 && start_pos > BEGV)
4539 move_it_by_lines (&it, -1);
4541 else if (dy > 0)
4543 move_it_to (&it, ZV, -1, it.current_y + dy, -1,
4544 MOVE_TO_POS | MOVE_TO_Y);
4545 /* Ensure we actually do move, e.g. in case we are currently
4546 looking at an image that is taller that the window height. */
4547 while (start_pos == IT_CHARPOS (it)
4548 && start_pos < ZV)
4549 move_it_by_lines (&it, 1);
4552 else
4553 move_it_by_lines (&it, n);
4555 /* We failed if we find ZV is already on the screen (scrolling up,
4556 means there's nothing past the end), or if we can't start any
4557 earlier (scrolling down, means there's nothing past the top). */
4558 if ((n > 0 && IT_CHARPOS (it) == ZV)
4559 || (n < 0 && IT_CHARPOS (it) == CHARPOS (start)))
4561 if (IT_CHARPOS (it) == ZV)
4563 if (it.current_y < it.last_visible_y
4564 && (it.current_y + it.max_ascent + it.max_descent
4565 > it.last_visible_y))
4567 /* The last line was only partially visible, make it fully
4568 visible. */
4569 w->vscroll = (it.last_visible_y
4570 - it.current_y + it.max_ascent + it.max_descent);
4571 adjust_glyphs (it.f);
4573 else
4575 bidi_unshelve_cache (itdata, 0);
4576 if (noerror)
4577 return;
4578 else if (n < 0) /* could happen with empty buffers */
4579 xsignal0 (Qbeginning_of_buffer);
4580 else
4581 xsignal0 (Qend_of_buffer);
4584 else
4586 if (w->vscroll != 0)
4587 /* The first line was only partially visible, make it fully
4588 visible. */
4589 w->vscroll = 0;
4590 else
4592 bidi_unshelve_cache (itdata, 0);
4593 if (noerror)
4594 return;
4595 else
4596 xsignal0 (Qbeginning_of_buffer);
4600 /* If control gets here, then we vscrolled. */
4602 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
4604 /* Don't try to change the window start below. */
4605 vscrolled = 1;
4608 if (! vscrolled)
4610 ptrdiff_t pos = IT_CHARPOS (it);
4611 ptrdiff_t bytepos;
4613 /* If in the middle of a multi-glyph character move forward to
4614 the next character. */
4615 if (in_display_vector_p (&it))
4617 ++pos;
4618 move_it_to (&it, pos, -1, -1, -1, MOVE_TO_POS);
4621 /* Set the window start, and set up the window for redisplay. */
4622 set_marker_restricted (w->start, make_number (pos),
4623 w->buffer);
4624 bytepos = marker_byte_position (w->start);
4625 w->start_at_line_beg = (pos == BEGV || FETCH_BYTE (bytepos - 1) == '\n');
4626 w->update_mode_line = 1;
4627 w->last_modified = 0;
4628 w->last_overlay_modified = 0;
4629 /* Set force_start so that redisplay_window will run the
4630 window-scroll-functions. */
4631 w->force_start = 1;
4634 /* The rest of this function uses current_y in a nonstandard way,
4635 not including the height of the header line if any. */
4636 it.current_y = it.vpos = 0;
4638 /* Move PT out of scroll margins.
4639 This code wants current_y to be zero at the window start position
4640 even if there is a header line. */
4641 this_scroll_margin = max (0, scroll_margin);
4642 this_scroll_margin
4643 = min (this_scroll_margin, XFASTINT (w->total_lines) / 4);
4644 this_scroll_margin *= FRAME_LINE_HEIGHT (it.f);
4646 if (n > 0)
4648 /* We moved the window start towards ZV, so PT may be now
4649 in the scroll margin at the top. */
4650 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
4651 if (IT_CHARPOS (it) == PT && it.current_y >= this_scroll_margin
4652 && (NILP (Vscroll_preserve_screen_position)
4653 || EQ (Vscroll_preserve_screen_position, Qt)))
4654 /* We found PT at a legitimate height. Leave it alone. */
4656 else if (window_scroll_pixel_based_preserve_y >= 0)
4658 /* If we have a header line, take account of it.
4659 This is necessary because we set it.current_y to 0, above. */
4660 move_it_to (&it, -1,
4661 window_scroll_pixel_based_preserve_x,
4662 window_scroll_pixel_based_preserve_y
4663 - (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0 ),
4664 -1, MOVE_TO_Y | MOVE_TO_X);
4665 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4667 else
4669 while (it.current_y < this_scroll_margin)
4671 int prev = it.current_y;
4672 move_it_by_lines (&it, 1);
4673 if (prev == it.current_y)
4674 break;
4676 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4679 else if (n < 0)
4681 ptrdiff_t charpos, bytepos;
4682 int partial_p;
4684 /* Save our position, for the
4685 window_scroll_pixel_based_preserve_y case. */
4686 charpos = IT_CHARPOS (it);
4687 bytepos = IT_BYTEPOS (it);
4689 /* We moved the window start towards BEGV, so PT may be now
4690 in the scroll margin at the bottom. */
4691 move_it_to (&it, PT, -1,
4692 (it.last_visible_y - CURRENT_HEADER_LINE_HEIGHT (w)
4693 - this_scroll_margin - 1),
4695 MOVE_TO_POS | MOVE_TO_Y);
4697 /* Save our position, in case it's correct. */
4698 charpos = IT_CHARPOS (it);
4699 bytepos = IT_BYTEPOS (it);
4701 /* See if point is on a partially visible line at the end. */
4702 if (it.what == IT_EOB)
4703 partial_p = it.current_y + it.ascent + it.descent > it.last_visible_y;
4704 else
4706 move_it_by_lines (&it, 1);
4707 partial_p = it.current_y > it.last_visible_y;
4710 if (charpos == PT && !partial_p
4711 && (NILP (Vscroll_preserve_screen_position)
4712 || EQ (Vscroll_preserve_screen_position, Qt)))
4713 /* We found PT before we found the display margin, so PT is ok. */
4715 else if (window_scroll_pixel_based_preserve_y >= 0)
4717 SET_TEXT_POS_FROM_MARKER (start, w->start);
4718 start_display (&it, w, start);
4719 /* It would be wrong to subtract CURRENT_HEADER_LINE_HEIGHT
4720 here because we called start_display again and did not
4721 alter it.current_y this time. */
4722 move_it_to (&it, -1, window_scroll_pixel_based_preserve_x,
4723 window_scroll_pixel_based_preserve_y, -1,
4724 MOVE_TO_Y | MOVE_TO_X);
4725 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4727 else
4729 if (partial_p)
4730 /* The last line was only partially visible, so back up two
4731 lines to make sure we're on a fully visible line. */
4733 move_it_by_lines (&it, -2);
4734 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
4736 else
4737 /* No, the position we saved is OK, so use it. */
4738 SET_PT_BOTH (charpos, bytepos);
4741 bidi_unshelve_cache (itdata, 0);
4745 /* Implementation of window_scroll that works based on screen lines.
4746 See the comment of window_scroll for parameter descriptions. */
4748 static void
4749 window_scroll_line_based (Lisp_Object window, int n, int whole, int noerror)
4751 register struct window *w = XWINDOW (window);
4752 /* Fvertical_motion enters redisplay, which can trigger
4753 fontification, which in turn can modify buffer text (e.g., if the
4754 fontification functions replace escape sequences with faces, as
4755 in `grep-mode-font-lock-keywords'). So we use a marker to record
4756 the old point position, to prevent crashes in SET_PT_BOTH. */
4757 Lisp_Object opoint_marker = Fpoint_marker ();
4758 register ptrdiff_t pos, pos_byte;
4759 register int ht = window_internal_height (w);
4760 register Lisp_Object tem;
4761 int lose;
4762 Lisp_Object bolp;
4763 ptrdiff_t startpos;
4764 Lisp_Object original_pos = Qnil;
4766 /* If scrolling screen-fulls, compute the number of lines to
4767 scroll from the window's height. */
4768 if (whole)
4769 n *= max (1, ht - next_screen_context_lines);
4771 startpos = marker_position (w->start);
4773 if (!NILP (Vscroll_preserve_screen_position))
4775 if (window_scroll_preserve_vpos <= 0
4776 || !SYMBOLP (KVAR (current_kboard, Vlast_command))
4777 || NILP (Fget (KVAR (current_kboard, Vlast_command), Qscroll_command)))
4779 struct position posit
4780 = *compute_motion (startpos, 0, 0, 0,
4781 PT, ht, 0,
4782 -1, w->hscroll,
4783 0, w);
4784 window_scroll_preserve_vpos = posit.vpos;
4785 window_scroll_preserve_hpos = posit.hpos + w->hscroll;
4788 original_pos = Fcons (make_number (window_scroll_preserve_hpos),
4789 make_number (window_scroll_preserve_vpos));
4792 XSETFASTINT (tem, PT);
4793 tem = Fpos_visible_in_window_p (tem, window, Qnil);
4795 if (NILP (tem))
4797 Fvertical_motion (make_number (- (ht / 2)), window);
4798 startpos = PT;
4801 SET_PT (startpos);
4802 lose = n < 0 && PT == BEGV;
4803 Fvertical_motion (make_number (n), window);
4804 pos = PT;
4805 pos_byte = PT_BYTE;
4806 bolp = Fbolp ();
4807 SET_PT_BOTH (marker_position (opoint_marker),
4808 marker_byte_position (opoint_marker));
4810 if (lose)
4812 if (noerror)
4813 return;
4814 else
4815 xsignal0 (Qbeginning_of_buffer);
4818 if (pos < ZV)
4820 /* Don't use a scroll margin that is negative or too large. */
4821 int this_scroll_margin =
4822 max (0, min (scroll_margin, XINT (w->total_lines) / 4));
4824 set_marker_restricted_both (w->start, w->buffer, pos, pos_byte);
4825 w->start_at_line_beg = !NILP (bolp);
4826 w->update_mode_line = 1;
4827 w->last_modified = 0;
4828 w->last_overlay_modified = 0;
4829 /* Set force_start so that redisplay_window will run
4830 the window-scroll-functions. */
4831 w->force_start = 1;
4833 if (!NILP (Vscroll_preserve_screen_position)
4834 && (whole || !EQ (Vscroll_preserve_screen_position, Qt)))
4836 SET_PT_BOTH (pos, pos_byte);
4837 Fvertical_motion (original_pos, window);
4839 /* If we scrolled forward, put point enough lines down
4840 that it is outside the scroll margin. */
4841 else if (n > 0)
4843 int top_margin;
4845 if (this_scroll_margin > 0)
4847 SET_PT_BOTH (pos, pos_byte);
4848 Fvertical_motion (make_number (this_scroll_margin), window);
4849 top_margin = PT;
4851 else
4852 top_margin = pos;
4854 if (top_margin <= marker_position (opoint_marker))
4855 SET_PT_BOTH (marker_position (opoint_marker),
4856 marker_byte_position (opoint_marker));
4857 else if (!NILP (Vscroll_preserve_screen_position))
4859 SET_PT_BOTH (pos, pos_byte);
4860 Fvertical_motion (original_pos, window);
4862 else
4863 SET_PT (top_margin);
4865 else if (n < 0)
4867 int bottom_margin;
4869 /* If we scrolled backward, put point near the end of the window
4870 but not within the scroll margin. */
4871 SET_PT_BOTH (pos, pos_byte);
4872 tem = Fvertical_motion (make_number (ht - this_scroll_margin), window);
4873 if (XFASTINT (tem) == ht - this_scroll_margin)
4874 bottom_margin = PT;
4875 else
4876 bottom_margin = PT + 1;
4878 if (bottom_margin > marker_position (opoint_marker))
4879 SET_PT_BOTH (marker_position (opoint_marker),
4880 marker_byte_position (opoint_marker));
4881 else
4883 if (!NILP (Vscroll_preserve_screen_position))
4885 SET_PT_BOTH (pos, pos_byte);
4886 Fvertical_motion (original_pos, window);
4888 else
4889 Fvertical_motion (make_number (-1), window);
4893 else
4895 if (noerror)
4896 return;
4897 else
4898 xsignal0 (Qend_of_buffer);
4903 /* Scroll selected_window up or down. If N is nil, scroll a
4904 screen-full which is defined as the height of the window minus
4905 next_screen_context_lines. If N is the symbol `-', scroll.
4906 DIRECTION may be 1 meaning to scroll down, or -1 meaning to scroll
4907 up. This is the guts of Fscroll_up and Fscroll_down. */
4909 static void
4910 scroll_command (Lisp_Object n, int direction)
4912 ptrdiff_t count = SPECPDL_INDEX ();
4914 eassert (eabs (direction) == 1);
4916 /* If selected window's buffer isn't current, make it current for
4917 the moment. But don't screw up if window_scroll gets an error. */
4918 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
4920 record_unwind_protect (save_excursion_restore, save_excursion_save ());
4921 Fset_buffer (XWINDOW (selected_window)->buffer);
4923 /* Make redisplay consider other windows than just selected_window. */
4924 ++windows_or_buffers_changed;
4927 if (NILP (n))
4928 window_scroll (selected_window, direction, 1, 0);
4929 else if (EQ (n, Qminus))
4930 window_scroll (selected_window, -direction, 1, 0);
4931 else
4933 n = Fprefix_numeric_value (n);
4934 window_scroll (selected_window, XINT (n) * direction, 0, 0);
4937 unbind_to (count, Qnil);
4940 DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "^P",
4941 doc: /* Scroll text of selected window upward ARG lines.
4942 If ARG is omitted or nil, scroll upward by a near full screen.
4943 A near full screen is `next-screen-context-lines' less than a full screen.
4944 Negative ARG means scroll downward.
4945 If ARG is the atom `-', scroll downward by nearly full screen.
4946 When calling from a program, supply as argument a number, nil, or `-'. */)
4947 (Lisp_Object arg)
4949 scroll_command (arg, 1);
4950 return Qnil;
4953 DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "^P",
4954 doc: /* Scroll text of selected window down ARG lines.
4955 If ARG is omitted or nil, scroll down by a near full screen.
4956 A near full screen is `next-screen-context-lines' less than a full screen.
4957 Negative ARG means scroll upward.
4958 If ARG is the atom `-', scroll upward by nearly full screen.
4959 When calling from a program, supply as argument a number, nil, or `-'. */)
4960 (Lisp_Object arg)
4962 scroll_command (arg, -1);
4963 return Qnil;
4966 DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
4967 doc: /* Return the other window for \"other window scroll\" commands.
4968 If `other-window-scroll-buffer' is non-nil, a window
4969 showing that buffer is used.
4970 If in the minibuffer, `minibuffer-scroll-window' if non-nil
4971 specifies the window. This takes precedence over
4972 `other-window-scroll-buffer'. */)
4973 (void)
4975 Lisp_Object window;
4977 if (MINI_WINDOW_P (XWINDOW (selected_window))
4978 && !NILP (Vminibuf_scroll_window))
4979 window = Vminibuf_scroll_window;
4980 /* If buffer is specified, scroll that buffer. */
4981 else if (!NILP (Vother_window_scroll_buffer))
4983 window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil);
4984 if (NILP (window))
4985 window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil);
4987 else
4989 /* Nothing specified; look for a neighboring window on the same
4990 frame. */
4991 window = Fnext_window (selected_window, Qnil, Qnil);
4993 if (EQ (window, selected_window))
4994 /* That didn't get us anywhere; look for a window on another
4995 visible frame. */
4997 window = Fnext_window (window, Qnil, Qt);
4998 while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window))))
4999 && ! EQ (window, selected_window));
5002 CHECK_LIVE_WINDOW (window);
5004 if (EQ (window, selected_window))
5005 error ("There is no other window");
5007 return window;
5010 DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
5011 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5012 A near full screen is `next-screen-context-lines' less than a full screen.
5013 The next window is the one below the current one; or the one at the top
5014 if the current one is at the bottom. Negative ARG means scroll downward.
5015 If ARG is the atom `-', scroll downward by nearly full screen.
5016 When calling from a program, supply as argument a number, nil, or `-'.
5018 If `other-window-scroll-buffer' is non-nil, scroll the window
5019 showing that buffer, popping the buffer up if necessary.
5020 If in the minibuffer, `minibuffer-scroll-window' if non-nil
5021 specifies the window to scroll. This takes precedence over
5022 `other-window-scroll-buffer'. */)
5023 (Lisp_Object arg)
5025 Lisp_Object window;
5026 struct window *w;
5027 ptrdiff_t count = SPECPDL_INDEX ();
5029 window = Fother_window_for_scrolling ();
5030 w = XWINDOW (window);
5032 /* Don't screw up if window_scroll gets an error. */
5033 record_unwind_protect (save_excursion_restore, save_excursion_save ());
5034 ++windows_or_buffers_changed;
5036 Fset_buffer (w->buffer);
5037 SET_PT (marker_position (w->pointm));
5039 if (NILP (arg))
5040 window_scroll (window, 1, 1, 1);
5041 else if (EQ (arg, Qminus))
5042 window_scroll (window, -1, 1, 1);
5043 else
5045 if (CONSP (arg))
5046 arg = XCAR (arg);
5047 CHECK_NUMBER (arg);
5048 window_scroll (window, XINT (arg), 0, 1);
5051 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
5052 unbind_to (count, Qnil);
5054 return Qnil;
5057 DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 2, "^P\np",
5058 doc: /* Scroll selected window display ARG columns left.
5059 Default for ARG is window width minus 2.
5060 Value is the total amount of leftward horizontal scrolling in
5061 effect after the change.
5062 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5063 lower bound for automatic scrolling, i.e. automatic scrolling
5064 will not scroll a window to a column less than the value returned
5065 by this function. This happens in an interactive call. */)
5066 (register Lisp_Object arg, Lisp_Object set_minimum)
5068 struct window *w = XWINDOW (selected_window);
5069 EMACS_INT requested_arg = (NILP (arg)
5070 ? window_body_cols (w) - 2
5071 : XINT (Fprefix_numeric_value (arg)));
5072 Lisp_Object result = set_window_hscroll (w, w->hscroll + requested_arg);
5074 if (!NILP (set_minimum))
5075 w->min_hscroll = w->hscroll;
5077 return result;
5080 DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 2, "^P\np",
5081 doc: /* Scroll selected window display ARG columns right.
5082 Default for ARG is window width minus 2.
5083 Value is the total amount of leftward horizontal scrolling in
5084 effect after the change.
5085 If SET-MINIMUM is non-nil, the new scroll amount becomes the
5086 lower bound for automatic scrolling, i.e. automatic scrolling
5087 will not scroll a window to a column less than the value returned
5088 by this function. This happens in an interactive call. */)
5089 (register Lisp_Object arg, Lisp_Object set_minimum)
5091 struct window *w = XWINDOW (selected_window);
5092 EMACS_INT requested_arg = (NILP (arg)
5093 ? window_body_cols (w) - 2
5094 : XINT (Fprefix_numeric_value (arg)));
5095 Lisp_Object result = set_window_hscroll (w, w->hscroll - requested_arg);
5097 if (!NILP (set_minimum))
5098 w->min_hscroll = w->hscroll;
5100 return result;
5103 DEFUN ("minibuffer-selected-window", Fminibuffer_selected_window, Sminibuffer_selected_window, 0, 0, 0,
5104 doc: /* Return the window which was selected when entering the minibuffer.
5105 Returns nil, if selected window is not a minibuffer window. */)
5106 (void)
5108 if (minibuf_level > 0
5109 && MINI_WINDOW_P (XWINDOW (selected_window))
5110 && WINDOW_LIVE_P (minibuf_selected_window))
5111 return minibuf_selected_window;
5113 return Qnil;
5116 /* Value is the number of lines actually displayed in window W,
5117 as opposed to its height. */
5119 static int
5120 displayed_window_lines (struct window *w)
5122 struct it it;
5123 struct text_pos start;
5124 ptrdiff_t charpos = marker_position (w->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 (charpos < BEGV)
5142 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
5143 else if (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 = clip_to_bounds (this_scroll_margin, iarg,
5353 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 w->window_end_valid = 0;
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 (!BUFFER_LIVE_P (XBUFFER (new_current_buffer)))
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 = marker_position (XWINDOW (data->current_window)->pointm);
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 = marker_position (XWINDOW (data->current_window)->pointm);
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 && BUFFER_LIVE_P (XBUFFER (p->buffer)))
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 (BUFFER_LIVE_P (XBUFFER (p->buffer)))
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 && BUFFER_LIVE_P (XBUFFER (w->buffer)))
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 struct frame *f = decode_live_frame (frame);
6182 n_windows = count_windows (XWINDOW (FRAME_ROOT_WINDOW (f)));
6183 data = ALLOCATE_PSEUDOVECTOR (struct save_window_data, frame_cols,
6184 PVEC_WINDOW_CONFIGURATION);
6186 data->frame_cols = FRAME_COLS (f);
6187 data->frame_lines = FRAME_LINES (f);
6188 data->frame_menu_bar_lines = FRAME_MENU_BAR_LINES (f);
6189 data->frame_tool_bar_lines = FRAME_TOOL_BAR_LINES (f);
6190 data->selected_frame = selected_frame;
6191 data->current_window = FRAME_SELECTED_WINDOW (f);
6192 XSETBUFFER (data->current_buffer, current_buffer);
6193 data->minibuf_scroll_window = minibuf_level > 0 ? Vminibuf_scroll_window : Qnil;
6194 data->minibuf_selected_window = minibuf_level > 0 ? minibuf_selected_window : Qnil;
6195 data->root_window = FRAME_ROOT_WINDOW (f);
6196 data->focus_frame = FRAME_FOCUS_FRAME (f);
6197 tem = Fmake_vector (make_number (n_windows), Qnil);
6198 data->saved_windows = tem;
6199 for (i = 0; i < n_windows; i++)
6200 ASET (tem, i,
6201 Fmake_vector (make_number (VECSIZE (struct saved_window)), Qnil));
6202 save_window_save (FRAME_ROOT_WINDOW (f), XVECTOR (tem), 0);
6203 XSETWINDOW_CONFIGURATION (tem, data);
6204 return (tem);
6207 /***********************************************************************
6208 Marginal Areas
6209 ***********************************************************************/
6211 DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
6212 2, 3, 0,
6213 doc: /* Set width of marginal areas of window WINDOW.
6214 WINDOW must be a live window and defaults to the selected one.
6216 Second arg LEFT-WIDTH specifies the number of character cells to
6217 reserve for the left marginal area. Optional third arg RIGHT-WIDTH
6218 does the same for the right marginal area. A nil width parameter
6219 means no margin. */)
6220 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width)
6222 struct window *w = decode_live_window (window);
6224 /* Translate negative or zero widths to nil.
6225 Margins that are too wide have to be checked elsewhere. */
6227 if (!NILP (left_width))
6229 CHECK_NUMBER (left_width);
6230 if (XINT (left_width) <= 0)
6231 left_width = Qnil;
6234 if (!NILP (right_width))
6236 CHECK_NUMBER (right_width);
6237 if (XINT (right_width) <= 0)
6238 right_width = Qnil;
6241 if (!EQ (w->left_margin_cols, left_width)
6242 || !EQ (w->right_margin_cols, right_width))
6244 wset_left_margin_cols (w, left_width);
6245 wset_right_margin_cols (w, right_width);
6247 adjust_window_margins (w);
6249 ++windows_or_buffers_changed;
6250 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6253 return Qnil;
6257 DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
6258 0, 1, 0,
6259 doc: /* Get width of marginal areas of window WINDOW.
6260 WINDOW must be a live window and defaults to the selected one.
6262 Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
6263 If a marginal area does not exist, its width will be returned
6264 as nil. */)
6265 (Lisp_Object window)
6267 struct window *w = decode_live_window (window);
6268 return Fcons (w->left_margin_cols, w->right_margin_cols);
6273 /***********************************************************************
6274 Fringes
6275 ***********************************************************************/
6277 DEFUN ("set-window-fringes", Fset_window_fringes, Sset_window_fringes,
6278 2, 4, 0,
6279 doc: /* Set the fringe widths of window WINDOW.
6280 WINDOW must be a live window and defaults to the selected one.
6282 Second arg LEFT-WIDTH specifies the number of pixels to reserve for
6283 the left fringe. Optional third arg RIGHT-WIDTH specifies the right
6284 fringe width. If a fringe width arg is nil, that means to use the
6285 frame's default fringe width. Default fringe widths can be set with
6286 the command `set-fringe-style'.
6287 If optional fourth arg OUTSIDE-MARGINS is non-nil, draw the fringes
6288 outside of the display margins. By default, fringes are drawn between
6289 display marginal areas and the text area. */)
6290 (Lisp_Object window, Lisp_Object left_width, Lisp_Object right_width, Lisp_Object outside_margins)
6292 struct window *w = decode_live_window (window);
6293 int outside = !NILP (outside_margins);
6295 if (!NILP (left_width))
6296 CHECK_NATNUM (left_width);
6297 if (!NILP (right_width))
6298 CHECK_NATNUM (right_width);
6300 /* Do nothing on a tty. */
6301 if (FRAME_WINDOW_P (WINDOW_XFRAME (w))
6302 && (!EQ (w->left_fringe_width, left_width)
6303 || !EQ (w->right_fringe_width, right_width)
6304 || w->fringes_outside_margins != outside))
6306 wset_left_fringe_width (w, left_width);
6307 wset_right_fringe_width (w, right_width);
6308 w->fringes_outside_margins = outside;
6310 adjust_window_margins (w);
6312 clear_glyph_matrix (w->current_matrix);
6313 w->window_end_valid = 0;
6315 ++windows_or_buffers_changed;
6316 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6319 return Qnil;
6323 DEFUN ("window-fringes", Fwindow_fringes, Swindow_fringes,
6324 0, 1, 0,
6325 doc: /* Get width of fringes of window WINDOW.
6326 WINDOW must be a live window and defaults to the selected one.
6328 Value is a list of the form (LEFT-WIDTH RIGHT-WIDTH OUTSIDE-MARGINS). */)
6329 (Lisp_Object window)
6331 struct window *w = decode_live_window (window);
6333 return list3 (make_number (WINDOW_LEFT_FRINGE_WIDTH (w)),
6334 make_number (WINDOW_RIGHT_FRINGE_WIDTH (w)),
6335 WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w) ? Qt : Qnil);
6340 /***********************************************************************
6341 Scroll bars
6342 ***********************************************************************/
6344 DEFUN ("set-window-scroll-bars", Fset_window_scroll_bars,
6345 Sset_window_scroll_bars, 2, 4, 0,
6346 doc: /* Set width and type of scroll bars of window WINDOW.
6347 WINDOW must be a live window and defaults to the selected one.
6349 Second parameter WIDTH specifies the pixel width for the scroll bar;
6350 this is automatically adjusted to a multiple of the frame column width.
6351 Third parameter VERTICAL-TYPE specifies the type of the vertical scroll
6352 bar: left, right, or nil.
6353 If WIDTH is nil, use the frame's scroll-bar width.
6354 If VERTICAL-TYPE is t, use the frame's scroll-bar type.
6355 Fourth parameter HORIZONTAL-TYPE is currently unused. */)
6356 (Lisp_Object window, Lisp_Object width, Lisp_Object vertical_type, Lisp_Object horizontal_type)
6358 struct window *w = decode_live_window (window);
6360 if (!NILP (width))
6362 CHECK_RANGED_INTEGER (width, 0, INT_MAX);
6364 if (XINT (width) == 0)
6365 vertical_type = Qnil;
6368 if (!(NILP (vertical_type)
6369 || EQ (vertical_type, Qleft)
6370 || EQ (vertical_type, Qright)
6371 || EQ (vertical_type, Qt)))
6372 error ("Invalid type of vertical scroll bar");
6374 if (!EQ (w->scroll_bar_width, width)
6375 || !EQ (w->vertical_scroll_bar_type, vertical_type))
6377 wset_scroll_bar_width (w, width);
6378 wset_vertical_scroll_bar_type (w, vertical_type);
6380 adjust_window_margins (w);
6382 clear_glyph_matrix (w->current_matrix);
6383 w->window_end_valid = 0;
6385 ++windows_or_buffers_changed;
6386 adjust_glyphs (XFRAME (WINDOW_FRAME (w)));
6389 return Qnil;
6393 DEFUN ("window-scroll-bars", Fwindow_scroll_bars, Swindow_scroll_bars,
6394 0, 1, 0,
6395 doc: /* Get width and type of scroll bars of window WINDOW.
6396 WINDOW must be a live window and defaults to the selected one.
6398 Value is a list of the form (WIDTH COLS VERTICAL-TYPE HORIZONTAL-TYPE).
6399 If WIDTH is nil or TYPE is t, the window is using the frame's corresponding
6400 value. */)
6401 (Lisp_Object window)
6403 struct window *w = decode_live_window (window);
6405 return list4 (make_number ((WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6406 ? WINDOW_CONFIG_SCROLL_BAR_WIDTH (w)
6407 : WINDOW_SCROLL_BAR_AREA_WIDTH (w))),
6408 make_number (WINDOW_SCROLL_BAR_COLS (w)),
6409 w->vertical_scroll_bar_type, Qnil);
6414 /***********************************************************************
6415 Smooth scrolling
6416 ***********************************************************************/
6418 DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
6419 doc: /* Return the amount by which WINDOW is scrolled vertically.
6420 If WINDOW is omitted or nil, it defaults to the selected window.
6421 Normally, value is a multiple of the canonical character height of WINDOW;
6422 optional second arg PIXELS-P means value is measured in pixels. */)
6423 (Lisp_Object window, Lisp_Object pixels_p)
6425 Lisp_Object result;
6426 struct window *w = decode_live_window (window);
6427 struct frame *f = XFRAME (w->frame);
6429 if (FRAME_WINDOW_P (f))
6430 result = (NILP (pixels_p)
6431 ? FRAME_CANON_Y_FROM_PIXEL_Y (f, -w->vscroll)
6432 : make_number (-w->vscroll));
6433 else
6434 result = make_number (0);
6435 return result;
6439 DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
6440 2, 3, 0,
6441 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
6442 WINDOW nil means use the selected window. Normally, VSCROLL is a
6443 non-negative multiple of the canonical character height of WINDOW;
6444 optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.
6445 If PIXELS-P is nil, VSCROLL may have to be rounded so that it
6446 corresponds to an integral number of pixels. The return value is the
6447 result of this rounding.
6448 If PIXELS-P is non-nil, the return value is VSCROLL. */)
6449 (Lisp_Object window, Lisp_Object vscroll, Lisp_Object pixels_p)
6451 struct window *w = decode_live_window (window);
6452 struct frame *f = XFRAME (w->frame);
6454 CHECK_NUMBER_OR_FLOAT (vscroll);
6456 if (FRAME_WINDOW_P (f))
6458 int old_dy = w->vscroll;
6460 w->vscroll = - (NILP (pixels_p)
6461 ? FRAME_LINE_HEIGHT (f) * XFLOATINT (vscroll)
6462 : XFLOATINT (vscroll));
6463 w->vscroll = min (w->vscroll, 0);
6465 if (w->vscroll != old_dy)
6467 /* Adjust glyph matrix of the frame if the virtual display
6468 area becomes larger than before. */
6469 if (w->vscroll < 0 && w->vscroll < old_dy)
6470 adjust_glyphs (f);
6472 /* Prevent redisplay shortcuts. */
6473 XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
6477 return Fwindow_vscroll (window, pixels_p);
6481 /* Call FN for all leaf windows on frame F. FN is called with the
6482 first argument being a pointer to the leaf window, and with
6483 additional argument USER_DATA. Stops when FN returns 0. */
6485 static void
6486 foreach_window (struct frame *f, int (*fn) (struct window *, void *),
6487 void *user_data)
6489 /* delete_frame may set FRAME_ROOT_WINDOW (f) to Qnil. */
6490 if (WINDOWP (FRAME_ROOT_WINDOW (f)))
6491 foreach_window_1 (XWINDOW (FRAME_ROOT_WINDOW (f)), fn, user_data);
6495 /* Helper function for foreach_window. Call FN for all leaf windows
6496 reachable from W. FN is called with the first argument being a
6497 pointer to the leaf window, and with additional argument USER_DATA.
6498 Stop when FN returns 0. Value is 0 if stopped by FN. */
6500 static int
6501 foreach_window_1 (struct window *w, int (*fn) (struct window *, void *), void *user_data)
6503 int cont;
6505 for (cont = 1; w && cont;)
6507 if (!NILP (w->hchild))
6508 cont = foreach_window_1 (XWINDOW (w->hchild), fn, user_data);
6509 else if (!NILP (w->vchild))
6510 cont = foreach_window_1 (XWINDOW (w->vchild), fn, user_data);
6511 else
6512 cont = fn (w, user_data);
6514 w = NILP (w->next) ? 0 : XWINDOW (w->next);
6517 return cont;
6521 /* Freeze or unfreeze the window start of W unless it is a
6522 mini-window or the selected window. FREEZE_P non-null means freeze
6523 the window start. */
6525 static int
6526 freeze_window_start (struct window *w, void *freeze_p)
6528 if (MINI_WINDOW_P (w)
6529 || (WINDOWP (selected_window) /* Can be nil in corner cases. */
6530 && (w == XWINDOW (selected_window)
6531 || (MINI_WINDOW_P (XWINDOW (selected_window))
6532 && ! NILP (Vminibuf_scroll_window)
6533 && w == XWINDOW (Vminibuf_scroll_window)))))
6534 freeze_p = NULL;
6536 w->frozen_window_start_p = freeze_p != NULL;
6537 return 1;
6541 /* Freeze or unfreeze the window starts of all leaf windows on frame
6542 F, except the selected window and a mini-window. FREEZE_P non-zero
6543 means freeze the window start. */
6545 void
6546 freeze_window_starts (struct frame *f, int freeze_p)
6548 foreach_window (f, freeze_window_start, (void *) (freeze_p ? f : 0));
6552 /***********************************************************************
6553 Initialization
6554 ***********************************************************************/
6556 /* Return 1 if window configurations CONFIGURATION1 and CONFIGURATION2
6557 describe the same state of affairs. This is used by Fequal.
6559 IGNORE_POSITIONS means ignore non-matching scroll positions
6560 and the like.
6562 This ignores a couple of things like the dedication status of
6563 window, combination_limit and the like. This might have to be
6564 fixed. */
6566 bool
6567 compare_window_configurations (Lisp_Object configuration1,
6568 Lisp_Object configuration2,
6569 bool ignore_positions)
6571 register struct save_window_data *d1, *d2;
6572 struct Lisp_Vector *sws1, *sws2;
6573 ptrdiff_t i;
6575 CHECK_WINDOW_CONFIGURATION (configuration1);
6576 CHECK_WINDOW_CONFIGURATION (configuration2);
6578 d1 = (struct save_window_data *) XVECTOR (configuration1);
6579 d2 = (struct save_window_data *) XVECTOR (configuration2);
6580 sws1 = XVECTOR (d1->saved_windows);
6581 sws2 = XVECTOR (d2->saved_windows);
6583 /* Frame settings must match. */
6584 if (d1->frame_cols != d2->frame_cols
6585 || d1->frame_lines != d2->frame_lines
6586 || d1->frame_menu_bar_lines != d2->frame_menu_bar_lines
6587 || !EQ (d1->selected_frame, d2->selected_frame)
6588 || !EQ (d1->current_buffer, d2->current_buffer)
6589 || (!ignore_positions
6590 && (!EQ (d1->minibuf_scroll_window, d2->minibuf_scroll_window)
6591 || !EQ (d1->minibuf_selected_window, d2->minibuf_selected_window)))
6592 || !EQ (d1->focus_frame, d2->focus_frame)
6593 /* Verify that the two configurations have the same number of windows. */
6594 || sws1->header.size != sws2->header.size)
6595 return 0;
6597 for (i = 0; i < sws1->header.size; i++)
6599 struct saved_window *sw1, *sw2;
6601 sw1 = SAVED_WINDOW_N (sws1, i);
6602 sw2 = SAVED_WINDOW_N (sws2, i);
6604 if (
6605 /* The "current" windows in the two configurations must
6606 correspond to each other. */
6607 EQ (d1->current_window, sw1->window)
6608 != EQ (d2->current_window, sw2->window)
6609 /* Windows' buffers must match. */
6610 || !EQ (sw1->buffer, sw2->buffer)
6611 || !EQ (sw1->left_col, sw2->left_col)
6612 || !EQ (sw1->top_line, sw2->top_line)
6613 || !EQ (sw1->total_cols, sw2->total_cols)
6614 || !EQ (sw1->total_lines, sw2->total_lines)
6615 || !EQ (sw1->display_table, sw2->display_table)
6616 /* The next two disjuncts check the window structure for
6617 equality. */
6618 || !EQ (sw1->parent, sw2->parent)
6619 || !EQ (sw1->prev, sw2->prev)
6620 || (!ignore_positions
6621 && (!EQ (sw1->hscroll, sw2->hscroll)
6622 || !EQ (sw1->min_hscroll, sw2->min_hscroll)
6623 || !EQ (sw1->start_at_line_beg, sw2->start_at_line_beg)
6624 || NILP (Fequal (sw1->start, sw2->start))
6625 || NILP (Fequal (sw1->pointm, sw2->pointm))
6626 || NILP (Fequal (sw1->mark, sw2->mark))))
6627 || !EQ (sw1->left_margin_cols, sw2->left_margin_cols)
6628 || !EQ (sw1->right_margin_cols, sw2->right_margin_cols)
6629 || !EQ (sw1->left_fringe_width, sw2->left_fringe_width)
6630 || !EQ (sw1->right_fringe_width, sw2->right_fringe_width)
6631 || !EQ (sw1->fringes_outside_margins, sw2->fringes_outside_margins)
6632 || !EQ (sw1->scroll_bar_width, sw2->scroll_bar_width)
6633 || !EQ (sw1->vertical_scroll_bar_type, sw2->vertical_scroll_bar_type))
6634 return 0;
6637 return 1;
6640 DEFUN ("compare-window-configurations", Fcompare_window_configurations,
6641 Scompare_window_configurations, 2, 2, 0,
6642 doc: /* Compare two window configurations as regards the structure of windows.
6643 This function ignores details such as the values of point and mark
6644 and scrolling positions. */)
6645 (Lisp_Object x, Lisp_Object y)
6647 if (compare_window_configurations (x, y, 1))
6648 return Qt;
6649 return Qnil;
6652 void
6653 init_window_once (void)
6655 struct frame *f = make_initial_frame ();
6656 XSETFRAME (selected_frame, f);
6657 Vterminal_frame = selected_frame;
6658 minibuf_window = f->minibuffer_window;
6659 selected_window = f->selected_window;
6660 last_nonminibuf_frame = f;
6662 window_initialized = 1;
6665 void
6666 init_window (void)
6668 Vwindow_list = Qnil;
6671 void
6672 syms_of_window (void)
6674 DEFSYM (Qscroll_up, "scroll-up");
6675 DEFSYM (Qscroll_down, "scroll-down");
6676 DEFSYM (Qscroll_command, "scroll-command");
6678 Fput (Qscroll_up, Qscroll_command, Qt);
6679 Fput (Qscroll_down, Qscroll_command, Qt);
6681 DEFSYM (Qwindow_configuration_change_hook, "window-configuration-change-hook");
6682 DEFSYM (Qwindowp, "windowp");
6683 DEFSYM (Qwindow_configuration_p, "window-configuration-p");
6684 DEFSYM (Qwindow_live_p, "window-live-p");
6685 DEFSYM (Qwindow_valid_p, "window-valid-p");
6686 DEFSYM (Qwindow_deletable_p, "window-deletable-p");
6687 DEFSYM (Qdelete_window, "delete-window");
6688 DEFSYM (Qwindow_resize_root_window, "window--resize-root-window");
6689 DEFSYM (Qwindow_resize_root_window_vertically, "window--resize-root-window-vertically");
6690 DEFSYM (Qsafe, "safe");
6691 DEFSYM (Qdisplay_buffer, "display-buffer");
6692 DEFSYM (Qreplace_buffer_in_windows, "replace-buffer-in-windows");
6693 DEFSYM (Qrecord_window_buffer, "record-window-buffer");
6694 DEFSYM (Qget_mru_window, "get-mru-window");
6695 DEFSYM (Qwindow_size, "window-size");
6696 DEFSYM (Qtemp_buffer_show_hook, "temp-buffer-show-hook");
6697 DEFSYM (Qabove, "above");
6698 DEFSYM (Qbelow, "below");
6699 DEFSYM (Qclone_of, "clone-of");
6701 staticpro (&Vwindow_list);
6703 minibuf_selected_window = Qnil;
6704 staticpro (&minibuf_selected_window);
6706 window_scroll_pixel_based_preserve_x = -1;
6707 window_scroll_pixel_based_preserve_y = -1;
6708 window_scroll_preserve_hpos = -1;
6709 window_scroll_preserve_vpos = -1;
6711 DEFVAR_LISP ("temp-buffer-show-function", Vtemp_buffer_show_function,
6712 doc: /* Non-nil means call as function to display a help buffer.
6713 The function is called with one argument, the buffer to be displayed.
6714 Used by `with-output-to-temp-buffer'.
6715 If this function is used, then it must do the entire job of showing
6716 the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
6717 Vtemp_buffer_show_function = Qnil;
6719 DEFVAR_LISP ("minibuffer-scroll-window", Vminibuf_scroll_window,
6720 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
6721 Vminibuf_scroll_window = Qnil;
6723 DEFVAR_BOOL ("mode-line-in-non-selected-windows", mode_line_in_non_selected_windows,
6724 doc: /* Non-nil means to use `mode-line-inactive' face in non-selected windows.
6725 If the minibuffer is active, the `minibuffer-scroll-window' mode line
6726 is displayed in the `mode-line' face. */);
6727 mode_line_in_non_selected_windows = 1;
6729 DEFVAR_LISP ("other-window-scroll-buffer", Vother_window_scroll_buffer,
6730 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
6731 Vother_window_scroll_buffer = Qnil;
6733 DEFVAR_BOOL ("auto-window-vscroll", auto_window_vscroll_p,
6734 doc: /* Non-nil means to automatically adjust `window-vscroll' to view tall lines. */);
6735 auto_window_vscroll_p = 1;
6737 DEFVAR_INT ("next-screen-context-lines", next_screen_context_lines,
6738 doc: /* Number of lines of continuity when scrolling by screenfuls. */);
6739 next_screen_context_lines = 2;
6741 DEFVAR_LISP ("scroll-preserve-screen-position",
6742 Vscroll_preserve_screen_position,
6743 doc: /* Controls if scroll commands move point to keep its screen position unchanged.
6744 A value of nil means point does not keep its screen position except
6745 at the scroll margin or window boundary respectively.
6746 A value of t means point keeps its screen position if the scroll
6747 command moved it vertically out of the window, e.g. when scrolling
6748 by full screens.
6749 Any other value means point always keeps its screen position.
6750 Scroll commands should have the `scroll-command' property
6751 on their symbols to be controlled by this variable. */);
6752 Vscroll_preserve_screen_position = Qnil;
6754 DEFVAR_LISP ("window-point-insertion-type", Vwindow_point_insertion_type,
6755 doc: /* Type of marker to use for `window-point'. */);
6756 Vwindow_point_insertion_type = Qnil;
6758 DEFVAR_LISP ("window-configuration-change-hook",
6759 Vwindow_configuration_change_hook,
6760 doc: /* Functions to call when window configuration changes.
6761 The buffer-local part is run once per window, with the relevant window
6762 selected; while the global part is run only once for the modified frame,
6763 with the relevant frame selected. */);
6764 Vwindow_configuration_change_hook = Qnil;
6766 DEFVAR_LISP ("recenter-redisplay", Vrecenter_redisplay,
6767 doc: /* Non-nil means `recenter' redraws entire frame.
6768 If this option is non-nil, then the `recenter' command with a nil
6769 argument will redraw the entire frame; the special value `tty' causes
6770 the frame to be redrawn only if it is a tty frame. */);
6771 Vrecenter_redisplay = Qtty;
6773 DEFVAR_LISP ("window-combination-resize", Vwindow_combination_resize,
6774 doc: /* If t, resize window combinations proportionally.
6775 If this variable is nil, splitting a window gets the entire screen space
6776 for displaying the new window from the window to split. Deleting and
6777 resizing a window preferably resizes one adjacent window only.
6779 If this variable is t, splitting a window tries to get the space
6780 proportionally from all windows in the same combination. This also
6781 allows to split a window that is otherwise too small or of fixed size.
6782 Resizing and deleting a window proportionally resize all windows in the
6783 same combination.
6785 Other values are reserved for future use.
6787 This variable takes no effect if the variable `window-combination-limit' is
6788 non-nil. */);
6789 Vwindow_combination_resize = Qnil;
6791 DEFVAR_LISP ("window-combination-limit", Vwindow_combination_limit,
6792 doc: /* If non-nil, splitting a window makes a new parent window.
6793 The following values are recognized:
6795 nil means splitting a window will create a new parent window only if the
6796 window has no parent window or the window shall become part of a
6797 combination orthogonal to the one it is part of.
6799 `window-size' means that splitting a window for displaying a buffer
6800 makes a new parent window provided `display-buffer' is supposed to
6801 explicitly set the window's size due to the presence of a
6802 `window-height' or `window-width' entry in the alist used by
6803 `display-buffer'. Otherwise, this value is handled like nil.
6805 `temp-buffer' means that splitting a window for displaying a temporary
6806 buffer always makes a new parent window. Otherwise, this value is
6807 handled like nil.
6809 `display-buffer' means that splitting a window for displaying a buffer
6810 always makes a new parent window. Since temporary buffers are
6811 displayed by the function `display-buffer', this value is stronger
6812 than `temp-buffer'. Splitting a window for other purpose makes a
6813 new parent window only if needed.
6815 t means that splitting a window always creates a new parent window. If
6816 all splits behave this way, each frame's window tree is a binary
6817 tree and every window but the frame's root window has exactly one
6818 sibling.
6820 Other values are reserved for future use. */);
6821 Vwindow_combination_limit = Qwindow_size;
6823 DEFVAR_LISP ("window-persistent-parameters", Vwindow_persistent_parameters,
6824 doc: /* Alist of persistent window parameters.
6825 This alist specifies which window parameters shall get saved by
6826 `current-window-configuration' and `window-state-get' and subsequently
6827 restored to their previous values by `set-window-configuration' and
6828 `window-state-put'.
6830 The car of each entry of this alist is the symbol specifying the
6831 parameter. The cdr is one of the following:
6833 nil means the parameter is neither saved by `window-state-get' nor by
6834 `current-window-configuration'.
6836 t means the parameter is saved by `current-window-configuration' and,
6837 provided its WRITABLE argument is nil, by `window-state-get'.
6839 The symbol `writable' means the parameter is saved unconditionally by
6840 both `current-window-configuration' and `window-state-get'. Do not use
6841 this value for parameters without read syntax (like windows or frames).
6843 Parameters not saved by `current-window-configuration' or
6844 `window-state-get' are left alone by `set-window-configuration'
6845 respectively are not installed by `window-state-put'. */);
6846 Vwindow_persistent_parameters = list1 (Fcons (Qclone_of, Qt));
6848 defsubr (&Sselected_window);
6849 defsubr (&Sminibuffer_window);
6850 defsubr (&Swindow_minibuffer_p);
6851 defsubr (&Swindowp);
6852 defsubr (&Swindow_valid_p);
6853 defsubr (&Swindow_live_p);
6854 defsubr (&Swindow_frame);
6855 defsubr (&Sframe_root_window);
6856 defsubr (&Sframe_first_window);
6857 defsubr (&Sframe_selected_window);
6858 defsubr (&Sset_frame_selected_window);
6859 defsubr (&Spos_visible_in_window_p);
6860 defsubr (&Swindow_line_height);
6861 defsubr (&Swindow_buffer);
6862 defsubr (&Swindow_parent);
6863 defsubr (&Swindow_top_child);
6864 defsubr (&Swindow_left_child);
6865 defsubr (&Swindow_next_sibling);
6866 defsubr (&Swindow_prev_sibling);
6867 defsubr (&Swindow_combination_limit);
6868 defsubr (&Sset_window_combination_limit);
6869 defsubr (&Swindow_use_time);
6870 defsubr (&Swindow_top_line);
6871 defsubr (&Swindow_left_column);
6872 defsubr (&Swindow_total_height);
6873 defsubr (&Swindow_total_width);
6874 defsubr (&Swindow_normal_size);
6875 defsubr (&Swindow_new_total);
6876 defsubr (&Swindow_new_normal);
6877 defsubr (&Sset_window_new_total);
6878 defsubr (&Sset_window_new_normal);
6879 defsubr (&Swindow_resize_apply);
6880 defsubr (&Swindow_body_height);
6881 defsubr (&Swindow_body_width);
6882 defsubr (&Swindow_hscroll);
6883 defsubr (&Sset_window_hscroll);
6884 defsubr (&Swindow_redisplay_end_trigger);
6885 defsubr (&Sset_window_redisplay_end_trigger);
6886 defsubr (&Swindow_edges);
6887 defsubr (&Swindow_pixel_edges);
6888 defsubr (&Swindow_absolute_pixel_edges);
6889 defsubr (&Swindow_inside_edges);
6890 defsubr (&Swindow_inside_pixel_edges);
6891 defsubr (&Swindow_inside_absolute_pixel_edges);
6892 defsubr (&Scoordinates_in_window_p);
6893 defsubr (&Swindow_at);
6894 defsubr (&Swindow_point);
6895 defsubr (&Swindow_start);
6896 defsubr (&Swindow_end);
6897 defsubr (&Sset_window_point);
6898 defsubr (&Sset_window_start);
6899 defsubr (&Swindow_dedicated_p);
6900 defsubr (&Sset_window_dedicated_p);
6901 defsubr (&Swindow_display_table);
6902 defsubr (&Sset_window_display_table);
6903 defsubr (&Snext_window);
6904 defsubr (&Sprevious_window);
6905 defsubr (&Sget_buffer_window);
6906 defsubr (&Sdelete_other_windows_internal);
6907 defsubr (&Sdelete_window_internal);
6908 defsubr (&Sresize_mini_window_internal);
6909 defsubr (&Sset_window_buffer);
6910 defsubr (&Srun_window_configuration_change_hook);
6911 defsubr (&Sselect_window);
6912 defsubr (&Sforce_window_update);
6913 defsubr (&Ssplit_window_internal);
6914 defsubr (&Sscroll_up);
6915 defsubr (&Sscroll_down);
6916 defsubr (&Sscroll_left);
6917 defsubr (&Sscroll_right);
6918 defsubr (&Sother_window_for_scrolling);
6919 defsubr (&Sscroll_other_window);
6920 defsubr (&Sminibuffer_selected_window);
6921 defsubr (&Srecenter);
6922 defsubr (&Swindow_text_height);
6923 defsubr (&Smove_to_window_line);
6924 defsubr (&Swindow_configuration_p);
6925 defsubr (&Swindow_configuration_frame);
6926 defsubr (&Sset_window_configuration);
6927 defsubr (&Scurrent_window_configuration);
6928 defsubr (&Sset_window_margins);
6929 defsubr (&Swindow_margins);
6930 defsubr (&Sset_window_fringes);
6931 defsubr (&Swindow_fringes);
6932 defsubr (&Sset_window_scroll_bars);
6933 defsubr (&Swindow_scroll_bars);
6934 defsubr (&Swindow_vscroll);
6935 defsubr (&Sset_window_vscroll);
6936 defsubr (&Scompare_window_configurations);
6937 defsubr (&Swindow_list);
6938 defsubr (&Swindow_list_1);
6939 defsubr (&Swindow_prev_buffers);
6940 defsubr (&Sset_window_prev_buffers);
6941 defsubr (&Swindow_next_buffers);
6942 defsubr (&Sset_window_next_buffers);
6943 defsubr (&Swindow_parameters);
6944 defsubr (&Swindow_parameter);
6945 defsubr (&Sset_window_parameter);
6948 void
6949 keys_of_window (void)
6951 initial_define_key (control_x_map, '<', "scroll-left");
6952 initial_define_key (control_x_map, '>', "scroll-right");
6954 initial_define_key (global_map, Ctl ('V'), "scroll-up-command");
6955 initial_define_key (meta_map, Ctl ('V'), "scroll-other-window");
6956 initial_define_key (meta_map, 'v', "scroll-down-command");