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