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