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