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