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