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