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