window.c 219 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
/* Window creation, deletion and examination for GNU Emacs.
   Does not include redisplay.
3 4
   Copyright (C) 1985-1987, 1993-1998, 2000-2013 Free Software
   Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

21
#include <config.h>
Paul Eggert's avatar
Paul Eggert committed
22 23 24

#define WINDOW_INLINE EXTERN_INLINE

25 26
#include <stdio.h>

Jim Blandy's avatar
Jim Blandy committed
27
#include "lisp.h"
28
#include "character.h"
Jim Blandy's avatar
Jim Blandy committed
29
#include "buffer.h"
30
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
31
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
32
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
33 34 35 36 37
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
38
#include "dispextern.h"
39 40
#include "blockinput.h"
#include "intervals.h"
41
#include "termhooks.h"		/* For FRAME_TERMINAL.  */
42

43
#ifdef HAVE_X_WINDOWS
Andreas Schwab's avatar
Andreas Schwab committed
44
#include "xterm.h"
45
#endif	/* HAVE_X_WINDOWS */
Daniel Colascione's avatar
Daniel Colascione committed
46
#ifdef HAVE_NTGUI
Andrew Innes's avatar
Andrew Innes committed
47 48
#include "w32term.h"
#endif
49 50 51
#ifdef MSDOS
#include "msdos.h"
#endif
52 53 54
#ifdef HAVE_NS
#include "nsterm.h"
#endif
55

Paul Eggert's avatar
Paul Eggert committed
56 57
Lisp_Object Qwindowp, Qwindow_live_p;
static Lisp_Object Qwindow_valid_p;
58 59
static Lisp_Object Qwindow_configuration_p;
static Lisp_Object Qrecord_window_buffer;
60
static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
Martin Rudalics's avatar
Martin Rudalics committed
61
static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
62
static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
63
static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
64
static Lisp_Object Qsafe, Qabove, Qbelow, Qwindow_size, Qclone_of;
Martin Rudalics's avatar
Martin Rudalics committed
65

66 67 68
static int displayed_window_lines (struct window *);
static int count_windows (struct window *);
static int get_leaf_windows (struct window *, struct window **, int);
69 70 71
static void window_scroll (Lisp_Object, EMACS_INT, bool, int);
static void window_scroll_pixel_based (Lisp_Object, int, bool, int);
static void window_scroll_line_based (Lisp_Object, int, bool, int);
72 73 74 75 76 77
static Lisp_Object window_list (void);
static int add_window_to_list (struct window *, void *);
static Lisp_Object next_window (Lisp_Object, Lisp_Object,
                                Lisp_Object, int);
static void decode_next_window_args (Lisp_Object *, Lisp_Object *,
                                     Lisp_Object *);
Andreas Schwab's avatar
Andreas Schwab committed
78
static void foreach_window (struct frame *,
79
				 int (* fn) (struct window *, void *),
Andreas Schwab's avatar
Andreas Schwab committed
80
                            void *);
81 82 83 84
static int foreach_window_1 (struct window *,
                             int (* fn) (struct window *, void *),
                             void *);
static Lisp_Object window_list_1 (Lisp_Object, Lisp_Object, Lisp_Object);
85 86
static int window_resize_check (struct window *, bool);
static void window_resize_apply (struct window *, bool);
Glenn Morris's avatar
Glenn Morris committed
87
static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
88
static void select_window_1 (Lisp_Object, bool);
89

Jim Blandy's avatar
Jim Blandy committed
90 91 92 93 94 95
/* This is the window in which the terminal's cursor should
   be left when nothing is being done with it.  This must
   always be a leaf window, and its buffer is selected by
   the top level editing loop at the end of each command.

   This value is always the same as
Jim Blandy's avatar
Jim Blandy committed
96
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
97 98
Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
99 100 101 102 103
/* A list of all windows for use by next_window and Fwindow_list.
   Functions creating or deleting windows should invalidate this cache
   by setting it to nil.  */
Lisp_Object Vwindow_list;

104 105 106
/* The mini-buffer window of the selected frame.
   Note that you cannot test for mini-bufferness of an arbitrary window
   by comparing against this; but you can test for mini-bufferness of
Jim Blandy's avatar
Jim Blandy committed
107 108 109
   the selected window.  */
Lisp_Object minibuf_window;

110 111
/* Non-nil means it is the window whose mode line should be
   shown as the selected window when the minibuffer is selected.  */
112
Lisp_Object minibuf_selected_window;
113

114
/* Hook run at end of temp_output_buffer_show.  */
115
static Lisp_Object Qtemp_buffer_show_hook;
116

117 118 119
/* Nonzero after init_window_once has finished.  */
static int window_initialized;

120
/* Hook to run when window config changes.  */
121
static Lisp_Object Qwindow_configuration_change_hook;
122

123
/* Used by the function window_scroll_pixel_based */
124
static int window_scroll_pixel_based_preserve_x;
125
static int window_scroll_pixel_based_preserve_y;
126

127
/* Same for window_scroll_line_based.  */
128 129
static EMACS_INT window_scroll_preserve_hpos;
static EMACS_INT window_scroll_preserve_vpos;
130

131 132 133 134 135 136
static void
CHECK_WINDOW_CONFIGURATION (Lisp_Object x)
{
  CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x);
}

Paul Eggert's avatar
Paul Eggert committed
137
/* These setters are used only in this file, so they can be private.  */
138
static void
Paul Eggert's avatar
Paul Eggert committed
139 140 141 142
wset_combination_limit (struct window *w, Lisp_Object val)
{
  w->combination_limit = val;
}
143
static void
Paul Eggert's avatar
Paul Eggert committed
144 145 146 147
wset_dedicated (struct window *w, Lisp_Object val)
{
  w->dedicated = val;
}
148
static void
Paul Eggert's avatar
Paul Eggert committed
149 150 151 152
wset_display_table (struct window *w, Lisp_Object val)
{
  w->display_table = val;
}
153
static void
Paul Eggert's avatar
Paul Eggert committed
154 155 156 157
wset_new_normal (struct window *w, Lisp_Object val)
{
  w->new_normal = val;
}
158
static void
Paul Eggert's avatar
Paul Eggert committed
159 160 161 162
wset_new_total (struct window *w, Lisp_Object val)
{
  w->new_total = val;
}
163
static void
Paul Eggert's avatar
Paul Eggert committed
164 165 166 167
wset_normal_cols (struct window *w, Lisp_Object val)
{
  w->normal_cols = val;
}
168
static void
Paul Eggert's avatar
Paul Eggert committed
169 170 171 172
wset_normal_lines (struct window *w, Lisp_Object val)
{
  w->normal_lines = val;
}
173
static void
Paul Eggert's avatar
Paul Eggert committed
174 175 176 177
wset_parent (struct window *w, Lisp_Object val)
{
  w->parent = val;
}
178
static void
Paul Eggert's avatar
Paul Eggert committed
179 180 181 182
wset_pointm (struct window *w, Lisp_Object val)
{
  w->pointm = val;
}
183
static void
Paul Eggert's avatar
Paul Eggert committed
184 185 186 187
wset_start (struct window *w, Lisp_Object val)
{
  w->start = val;
}
188
static void
Paul Eggert's avatar
Paul Eggert committed
189 190 191 192
wset_temslot (struct window *w, Lisp_Object val)
{
  w->temslot = val;
}
193
static void
Paul Eggert's avatar
Paul Eggert committed
194 195 196 197
wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
{
  w->vertical_scroll_bar_type = val;
}
198
static void
Paul Eggert's avatar
Paul Eggert committed
199 200 201 202
wset_window_parameters (struct window *w, Lisp_Object val)
{
  w->window_parameters = val;
}
203 204 205 206 207 208 209 210 211 212 213 214
static void
wset_combination (struct window *w, bool horflag, Lisp_Object val)
{
  /* Since leaf windows never becomes non-leaf, there should
     be no buffer and markers in start and pointm fields of W.  */
  eassert (!BUFFERP (w->contents) && NILP (w->start) && NILP (w->pointm));
  w->contents = val;
  /* When an internal window is deleted and VAL is nil, HORFLAG
     is meaningless.  */
  if (!NILP (val))
    w->horizontal = horflag;
}
Paul Eggert's avatar
Paul Eggert committed
215

216 217 218 219 220 221 222 223 224 225 226
/* Nonzero if leaf window W doesn't reflect the actual state
   of displayed buffer due to its text or overlays change.  */

bool
window_outdated (struct window *w)
{
  struct buffer *b = XBUFFER (w->contents);
  return (w->last_modified < BUF_MODIFF (b)
	  || w->last_overlay_modified < BUF_OVERLAY_MODIFF (b));
}

227 228
struct window *
decode_live_window (register Lisp_Object window)
229 230 231
{
  if (NILP (window))
    return XWINDOW (selected_window);
232

233 234 235 236
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

237
struct window *
238 239
decode_any_window (register Lisp_Object window)
{
240 241
  struct window *w;

242 243 244 245
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
246 247
  w = XWINDOW (window);
  return w;
248
}
249

Paul Eggert's avatar
Paul Eggert committed
250
static struct window *
251 252 253 254 255 256 257 258 259 260 261 262
decode_valid_window (register Lisp_Object window)
{
  struct window *w;

  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_VALID_WINDOW (window);
  w = XWINDOW (window);
  return w;
}

Dmitry Antipov's avatar
Dmitry Antipov committed
263 264 265 266 267 268 269
/* Called when W's buffer slot is changed.  ARG -1 means that W is about to
   cease its buffer, and 1 means that W is about to set up the new one.  */

static void
adjust_window_count (struct window *w, int arg)
{
  eassert (eabs (arg) == 1);
270
  if (BUFFERP (w->contents))
Dmitry Antipov's avatar
Dmitry Antipov committed
271
    {
272
      struct buffer *b = XBUFFER (w->contents);
Paul Eggert's avatar
Paul Eggert committed
273

Dmitry Antipov's avatar
Dmitry Antipov committed
274 275 276 277
      if (b->base_buffer)
	b = b->base_buffer;
      b->window_count += arg;
      eassert (b->window_count >= 0);
278
      /* These should be recalculated by redisplay code.  */
279
      w->window_end_valid = 0;
280
      w->base_line_pos = 0;
Dmitry Antipov's avatar
Dmitry Antipov committed
281 282 283 284 285 286 287 288 289 290
    }
}

/* Set W's buffer slot to VAL and recompute number
   of windows showing VAL if it is a buffer.  */

void
wset_buffer (struct window *w, Lisp_Object val)
{
  adjust_window_count (w, -1);
291 292 293 294 295
  if (BUFFERP (val))
    /* Make sure that we do not assign the buffer
       to an internal window.  */
    eassert (MARKERP (w->start) && MARKERP (w->pointm));
  w->contents = val;
Dmitry Antipov's avatar
Dmitry Antipov committed
296 297 298
  adjust_window_count (w, 1);
}

Jim Blandy's avatar
Jim Blandy committed
299
DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
300
       doc: /* Return t if OBJECT is a window and nil otherwise.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
301
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
302
{
303
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
304 305
}

306 307 308 309 310 311 312 313 314
DEFUN ("window-valid-p", Fwindow_valid_p, Swindow_valid_p, 1, 1, 0,
       doc: /* Return t if OBJECT is a valid window and nil otherwise.
A valid window is either a window that displays a buffer or an internal
window.  Deleted windows are not live.  */)
  (Lisp_Object object)
{
  return WINDOW_VALID_P (object) ? Qt : Qnil;
}

315
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
316
       doc: /* Return t if OBJECT is a live window and nil otherwise.
317 318
A live window is a window that displays a buffer.
Internal windows and deleted windows are not live.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
319
  (Lisp_Object object)
320
{
321
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
322
}
323 324

/* Frames and windows.  */
325
DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 0, 1, 0,
326
       doc: /* Return the frame that window WINDOW is on.
327
WINDOW must be a valid window and defaults to the selected one.  */)
328 329
  (Lisp_Object window)
{
330
  return decode_valid_window (window)->frame;
331 332 333
}

DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
334 335
       doc: /* Return the root window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
336 337
With a frame argument, return that frame's root window.
With a window argument, return the root window of that window's frame.  */)
338 339 340 341 342
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
343
    window = SELECTED_FRAME ()->root_window;
344 345
  else if (WINDOW_VALID_P (frame_or_window))
      window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
346 347 348
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
349
      window = XFRAME (frame_or_window)->root_window;
350 351 352 353 354 355
    }

  return window;
}

DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
356 357
       doc: /* Return the minibuffer window for frame FRAME.
If FRAME is omitted or nil, it defaults to the selected frame.  */)
358 359
  (Lisp_Object frame)
{
360
  return FRAME_MINIBUF_WINDOW (decode_live_frame (frame));
361 362 363 364 365
}

DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
       Swindow_minibuffer_p, 0, 1, 0,
       doc: /* Return non-nil if WINDOW is a minibuffer window.
366
WINDOW must be a valid window and defaults to the selected one.  */)
367 368
  (Lisp_Object window)
{
369
  return MINI_WINDOW_P (decode_valid_window (window)) ? Qt : Qnil;
370 371 372 373
}

/* Don't move this to window.el - this must be a safe routine.  */
DEFUN ("frame-first-window", Fframe_first_window, Sframe_first_window, 0, 1, 0,
374 375
       doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
376 377
Else if FRAME-OR-WINDOW denotes a valid window, return the first window
of that window's frame.  If FRAME-OR-WINDOW denotes a live frame, return
378 379 380 381 382 383
the first window of that frame.  */)
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
384
    window = SELECTED_FRAME ()->root_window;
385
  else if (WINDOW_VALID_P (frame_or_window))
386
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
387 388 389
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
390
      window = XFRAME (frame_or_window)->root_window;
391 392
    }

393 394
  while (WINDOWP (XWINDOW (window)->contents))
    window = XWINDOW (window)->contents;
395 396 397 398 399 400

  return window;
}

DEFUN ("frame-selected-window", Fframe_selected_window,
       Sframe_selected_window, 0, 1, 0,
401 402
       doc: /* Return the selected window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
403 404 405
Else if FRAME-OR-WINDOW denotes a valid window, return the selected
window of that window's frame.  If FRAME-OR-WINDOW denotes a live frame,
return the selected window of that frame.  */)
406 407 408 409 410
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
411
    window = SELECTED_FRAME ()->selected_window;
412
  else if (WINDOW_VALID_P (frame_or_window))
413
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
414 415 416
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
417
      window = XFRAME (frame_or_window)->selected_window;
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
    }

  return window;
}

DEFUN ("set-frame-selected-window", Fset_frame_selected_window,
       Sset_frame_selected_window, 2, 3, 0,
       doc: /* Set selected window of FRAME to WINDOW.
FRAME must be a live frame and defaults to the selected one.  If FRAME
is the selected frame, this makes WINDOW the selected window.  Optional
argument NORECORD non-nil means to neither change the order of recently
selected windows nor the buffer list.  WINDOW must denote a live window.
Return WINDOW.  */)
  (Lisp_Object frame, Lisp_Object window, Lisp_Object norecord)
{
  if (NILP (frame))
    frame = selected_frame;

  CHECK_LIVE_FRAME (frame);
  CHECK_LIVE_WINDOW (window);

  if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
    error ("In `set-frame-selected-window', WINDOW is not on FRAME");

  if (EQ (frame, selected_frame))
    return Fselect_window (window, norecord);
  else
445 446 447 448
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
449 450 451 452 453 454 455 456 457 458 459
}

DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
       doc: /* Return the selected window.
The selected window is the window in which the standard cursor for
selected windows appears and to which many commands apply.  */)
  (void)
{
  return selected_window;
}

460 461
int window_select_count;

462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
/* If select_window is called with inhibit_point_swap non-zero it will
   not store point of the old selected window's buffer back into that
   window's pointm slot.  This is needed by Fset_window_configuration to
   avoid that the display routine is called with selected_window set to
   Qnil causing a subsequent crash.  */
static Lisp_Object
select_window (Lisp_Object window, Lisp_Object norecord, int inhibit_point_swap)
{
  register struct window *w;
  struct frame *sf;

  CHECK_LIVE_WINDOW (window);

  w = XWINDOW (window);

477
  /* Make the selected window's buffer current.  */
478
  Fset_buffer (w->contents);
479

480
  if (EQ (window, selected_window) && !inhibit_point_swap)
481 482 483 484
    /* `switch-to-buffer' uses (select-window (selected-window)) as a "clever"
       way to call record_buffer from Elisp, so it's important that we call
       record_buffer before returning here.  */
    goto record_and_return;
485 486 487 488

  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
    {
489
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
490 491 492 493 494 495 496 497 498 499
      /* Use this rather than Fhandle_switch_frame
	 so that FRAME_FOCUS_FRAME is moved appropriately as we
	 move around in the state where a minibuffer in a separate
	 frame is active.  */
      Fselect_frame (WINDOW_FRAME (w), norecord);
      /* Fselect_frame called us back so we've done all the work already.  */
      eassert (EQ (window, selected_window));
      return window;
    }
  else
500
    fset_selected_window (sf, window);
501

502
  select_window_1 (window, inhibit_point_swap);
503 504
  bset_last_selected_window (XBUFFER (w->contents), window);
  windows_or_buffers_changed++;
505

506
 record_and_return:
507 508 509 510 511 512 513 514 515
  /* record_buffer can run QUIT, so make sure it is run only after we have
     re-established the invariant between selected_window and selected_frame,
     otherwise the temporary broken invariant might "escape" (bug#14161).  */
  if (NILP (norecord))
    {
      w->use_time = ++window_select_count;
      record_buffer (w->contents);
    }

516 517 518 519
  return window;
}

/* Select window with a minimum of fuss, i.e. don't record the change anywhere
Paul Eggert's avatar
Paul Eggert committed
520
   (not even for redisplay's benefit), and assume that the window's frame is
521
   already selected.  */
522
static void
523 524
select_window_1 (Lisp_Object window, bool inhibit_point_swap)
{
525 526 527
  /* Store the old selected window's buffer's point in pointm of the old
     selected window.  It belongs to that window, and when the window is
     not selected, must be in the window.  */
528 529
  if (!inhibit_point_swap)
    {
530
      struct window *ow = XWINDOW (selected_window);
531 532 533 534
      if (BUFFERP (ow->contents))
	set_marker_both (ow->pointm, ow->contents,
			 BUF_PT (XBUFFER (ow->contents)),
			 BUF_PT_BYTE (XBUFFER (ow->contents)));
535 536 537 538 539 540 541 542 543 544
    }

  selected_window = window;

  /* Go to the point recorded in the window.
     This is important when the buffer is in more
     than one window.  It also matters when
     redisplay_window has altered point after scrolling,
     because it makes the change only in the window.  */
  {
545
    register ptrdiff_t new_point = marker_position (XWINDOW (window)->pointm);
546 547 548 549 550 551 552 553 554 555
    if (new_point < BEGV)
      SET_PT (BEGV);
    else if (new_point > ZV)
      SET_PT (ZV);
    else
      SET_PT (new_point);
  }
}

DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
556 557 558 559 560
       doc: /* Select WINDOW which must be a live window.
Also make WINDOW's frame the selected frame and WINDOW that frame's
selected window.  In addition, make WINDOW's buffer current and set that
buffer's value of `point' to the value of WINDOW's `window-point'.
Return WINDOW.
561 562 563 564

Optional second arg NORECORD non-nil means do not put this buffer at the
front of the buffer list and do not make this window the most recently
selected one.
565

566 567 568 569 570 571 572
Note that the main editor command loop sets the current buffer to the
buffer of the selected window before each command.  */)
  (register Lisp_Object window, Lisp_Object norecord)
{
  return select_window (window, norecord, 0);
}

573
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
574 575 576
       doc: /* Return the buffer displayed in window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
Return nil for an internal window or a deleted window.  */)
577 578
  (Lisp_Object window)
{
579 580
  struct window *w = decode_any_window (window);
  return WINDOW_LEAF_P (w) ? w->contents : Qnil;
581 582 583
}

DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
584
       doc: /* Return the parent window of window WINDOW.
585
WINDOW must be a valid window and defaults to the selected one.
586
Return nil for a window with no parent (e.g. a root window).  */)
587 588
  (Lisp_Object window)
{
589
  return decode_valid_window (window)->parent;
590 591
}

592
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
593
       doc: /* Return the topmost child window of window WINDOW.
594
WINDOW must be a valid window and defaults to the selected one.
595 596 597
Return nil if WINDOW is a live window (live windows have no children).
Return nil if WINDOW is an internal window whose children form a
horizontal combination.  */)
598 599
  (Lisp_Object window)
{
600 601
  struct window *w = decode_valid_window (window);
  return WINDOW_VERTICAL_COMBINATION_P (w) ? w->contents : Qnil;
602 603
}

604
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
605
       doc: /* Return the leftmost child window of window WINDOW.
606
WINDOW must be a valid window and defaults to the selected one.
607 608 609
Return nil if WINDOW is a live window (live windows have no children).
Return nil if WINDOW is an internal window whose children form a
vertical combination.  */)
610 611
  (Lisp_Object window)
{
612 613
  struct window *w = decode_valid_window (window);
  return WINDOW_HORIZONTAL_COMBINATION_P (w) ? w->contents : Qnil;
614 615
}

616
DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
617
       doc: /* Return the next sibling window of window WINDOW.
618
WINDOW must be a valid window and defaults to the selected one.
619
Return nil if WINDOW has no next sibling.  */)
620 621
  (Lisp_Object window)
{
622
  return decode_valid_window (window)->next;
623 624
}

625
DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
626
       doc: /* Return the previous sibling window of window WINDOW.
627
WINDOW must be a valid window and defaults to the selected one.
628
Return nil if WINDOW has no previous sibling.  */)
629 630
  (Lisp_Object window)
{
631
  return decode_valid_window (window)->prev;
632
}
Gerd Moellmann's avatar
Gerd Moellmann committed
633

634
DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
635
       doc: /* Return combination limit of window WINDOW.
636
WINDOW must be a valid window used in horizontal or vertical combination.
637
If the return value is nil, child windows of WINDOW can be recombined with
638
WINDOW's siblings.  A return value of t means that child windows of
639
WINDOW are never \(re-)combined with WINDOW's siblings.  */)
640
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
641
{
642 643
  struct window *w;

644
  CHECK_VALID_WINDOW (window);
645
  w = XWINDOW (window);
646
  if (WINDOW_LEAF_P (w))
647
    error ("Combination limit is meaningful for internal windows only");
648
  return w->combination_limit;
Jim Blandy's avatar
Jim Blandy committed
649
}
650

651
DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
652
       doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
653
WINDOW must be a valid window used in horizontal or vertical combination.
654 655 656
If LIMIT is nil, child windows of WINDOW can be recombined with WINDOW's
siblings.  LIMIT t means that child windows of WINDOW are never
\(re-)combined with WINDOW's siblings.  Other values are reserved for
657
future use.  */)
658
  (Lisp_Object window, Lisp_Object limit)
659
{
660 661 662 663
  struct window *w;

  CHECK_VALID_WINDOW (window);
  w = XWINDOW (window);
664
  if (WINDOW_LEAF_P (w))
665 666
    error ("Combination limit is meaningful for internal windows only");
  wset_combination_limit (w, limit);
Paul Eggert's avatar
Paul Eggert committed
667
  return limit;
668
}
669

670
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
671
       doc: /* Return the use time of window WINDOW.
672
WINDOW must be a live window and defaults to the selected one.
673 674 675
The window with the highest use time is the most recently selected
one.  The window with the lowest use time is the least recently
selected one.  */)
676 677
  (Lisp_Object window)
{
678
  return make_number (decode_live_window (window)->use_time);
679
}
680

681 682
DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
       doc: /* Return the total height, in lines, of window WINDOW.
683
WINDOW must be a valid window and defaults to the selected one.
684

685 686 687
The return value includes the mode line and header line, if any.
If WINDOW is an internal window, the total height is the height
of the screen areas spanned by its children.
688

689 690 691
On a graphical display, this total height is reported as an
integer multiple of the default character height.  */)
  (Lisp_Object window)
692
{
693
  return make_number (decode_valid_window (window)->total_lines);
694
}
695

696 697
DEFUN ("window-total-width", Fwindow_total_width, Swindow_total_width, 0, 1, 0,
       doc: /* Return the total width, in columns, of window WINDOW.
698
WINDOW must be a valid window and defaults to the selected one.
699

700 701 702
The return value includes any vertical dividers or scroll bars
belonging to WINDOW.  If WINDOW is an internal window, the total width
is the width of the screen areas spanned by its children.
703

704 705
On a graphical display, this total width is reported as an
integer multiple of the default character width.  */)
706 707
  (Lisp_Object window)
{
708
  return make_number (decode_valid_window (window)->total_cols);
709
}
710

711
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
712
       doc: /* Return the new total size of window WINDOW.
713
WINDOW must be a valid window and defaults to the selected one.  */)
714 715
  (Lisp_Object window)
{
716
  return decode_valid_window (window)->new_total;
717 718 719
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
720
       doc: /* Return the normal height of window WINDOW.
721
WINDOW must be a valid window and defaults to the selected one.
722
If HORIZONTAL is non-nil, return the normal width of WINDOW.  */)
723 724
  (Lisp_Object window, Lisp_Object horizontal)
{
725
  struct window *w = decode_valid_window (window);
726 727

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
728 729 730
}

DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
731
       doc: /* Return new normal size of window WINDOW.
732
WINDOW must be a valid window and defaults to the selected one.  */)
733 734
  (Lisp_Object window)
{
735
  return decode_valid_window (window)->new_normal;
736 737
}

738
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
739
       doc: /* Return left column of window WINDOW.
740 741 742 743
This is the distance, in columns, between the left edge of WINDOW and
the left edge of the frame's window area.  For instance, the return
value is 0 if there is no window to the left of WINDOW.

744
WINDOW must be a valid window and defaults to the selected one.  */)
745 746
  (Lisp_Object window)
{
747
  return make_number (decode_valid_window (window)->left_col);
748 749 750
}

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
751
       doc: /* Return top line of window WINDOW.
752 753 754 755
This is the distance, in lines, between the top of WINDOW and the top
of the frame's window area.  For instance, the return value is 0 if
there is no window above WINDOW.

756
WINDOW must be a valid window and defaults to the selected one.  */)
757 758
  (Lisp_Object window)
{
759
  return make_number (decode_valid_window (window)->top_line);
760 761 762 763 764
}

/* Return the number of lines of W's body.  Don't count any mode or
   header line of W.  */

765
static int
766 767
window_body_lines (struct window *w)
{
768
  int height = w->total_lines;
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789

  if (!MINI_WINDOW_P (w))
    {
      if (WINDOW_WANTS_MODELINE_P (w))
	--height;
      if (WINDOW_WANTS_HEADER_LINE_P (w))
	--height;
    }

  return height;
}

/* Return the number of columns of W's body.  Don't count columns
   occupied by the scroll bar or the vertical bar separating W from its
   right sibling.  On window-systems don't count fringes or display
   margins either.  */

int
window_body_cols (struct window *w)
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
790
  int width = w->total_cols;
791 792 793 794 795 796 797 798 799 800

  if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
    /* Scroll bars occupy a few columns.  */
    width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
  else if (!FRAME_WINDOW_P (f)
	   && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
    /* The column of `|' characters separating side-by-side windows
       occupies one column only.  */
    width -= 1;

801 802 803
  /* Display margins cannot be used for normal text.  */
  width -= WINDOW_LEFT_MARGIN_COLS (w) + WINDOW_RIGHT_MARGIN_COLS (w);

804
  if (FRAME_WINDOW_P (f))
805 806
    /* On window-systems, fringes cannot be used for normal text.  */
    width -= WINDOW_FRINGE_COLS (w);
807 808 809 810

  return width;
}

811 812
DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 1, 0,
       doc: /* Return the height, in lines, of WINDOW's text area.
813
WINDOW must be a live window and defaults to the selected one.
814

815 816 817 818 819 820
The returned height does not include the mode line or header line.
On a graphical display, the height is expressed as an integer multiple
of the default character height.  If a line at the bottom of the text
area is only partially visible, that counts as a whole line; to
exclude partially-visible lines, use `window-text-height'.  */)
  (Lisp_Object window)
821
{
822
  return make_number (window_body_lines (decode_live_window (window)));
823
}
824

825 826
DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 1, 0,
       doc: /* Return the width, in columns, of WINDOW's text area.
827
WINDOW must be a live window and defaults to the selected one.
828 829 830 831 832 833

The return value does not include any vertical dividers, fringe or
marginal areas, or scroll bars.  On a graphical display, the width is
expressed as an integer multiple of the default character width.  */)
  (Lisp_Object window)
{
834
  return make_number (window_body_cols (decode_live_window (window)));
835
}
836

Jim Blandy's avatar
Jim Blandy committed
837
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
838
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
839
WINDOW must be a live window and defaults to the selected one.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
840
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
841
{
842
  return make_number (decode_live_window (window)->hscroll);
Jim Blandy's avatar
Jim Blandy committed
843 844
}

845 846 847 848 849
/* Set W's horizontal scroll amount to HSCROLL clipped to a reasonable
   range, returning the new amount as a fixnum.  */
static Lisp_Object
set_window_hscroll (struct window *w, EMACS_INT hscroll)
{
850 851 852 853 854 855 856 857
  /* Horizontal scrolling has problems with large scroll amounts.
     It's too slow with long lines, and even with small lines the
     display can be messed up.  For now, though, impose only the limits
     required by the internal representation: horizontal scrolling must
     fit in fixnum (since it's visible to Elisp) and into ptrdiff_t
     (since it's stored in a ptrdiff_t).  */
  ptrdiff_t hscroll_max = min (MOST_POSITIVE_FIXNUM, PTRDIFF_MAX);
  ptrdiff_t new_hscroll = clip_to_bounds (0, hscroll, hscroll_max);
858 859 860

  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (w->hscroll != new_hscroll)
861
    XBUFFER (w->contents)->prevent_redisplay_optimizations_p = 1;
862 863 864 865 866

  w->hscroll = new_hscroll;
  return make_number (new_hscroll);
}

Jim Blandy's avatar
Jim Blandy committed
867
DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
868
       doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
869
WINDOW must be a live window and defaults to the selected one.
870 871
Clip the number to a reasonable value if out of range.
Return the new number.  NCOL should be zero or positive.
872 873

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
874
window so that the location of point moves off-window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
875
  (Lisp_Object window, Lisp_Object ncol)
Jim Blandy's avatar
Jim Blandy committed
876
{
877
  CHECK_NUMBER (ncol);
878
  return set_window_hscroll (decode_live_window (window), XINT (ncol));
Jim Blandy's avatar
Jim Blandy committed
879 880
}

881 882
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
883
       doc: /* Return WINDOW's redisplay end trigger value.
884
WINDOW must be a live window and defaults to the selected one.
885
See `set-window-redisplay-end-trigger' for more information.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
886
  (Lisp_Object window)
887
{
888
  return decode_live_window (window)->redisplay_end_trigger;
889 890 891 892
}

DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
       Sset_window_redisplay_end_trigger, 2, 2, 0,
893
       doc: /* Set WINDOW's redisplay end trigger value to VALUE.
894 895 896 897 898 899
WINDOW must be a live window and defaults to the selected one.  VALUE
should be a buffer position (typically a marker) or nil.  If it is a
buffer position, then if redisplay in WINDOW reaches a position beyond
VALUE, the functions in `redisplay-end-trigger-functions' are called
with two arguments: WINDOW, and the end trigger value.  Afterwards the
end-trigger value is reset to nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
900
  (register Lisp_Object window, Lisp_Object value)
901
{
Paul Eggert's avatar
Paul Eggert committed
902 903
  wset_redisplay_end_trigger (decode_live_window (window), value);
  return value;
904 905
}

Jim Blandy's avatar
Jim Blandy committed
906
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
907
       doc: /* Return a list of the edge coordinates of WINDOW.
908 909 910 911 912 913 914 915 916 917 918
WINDOW must be a valid window and defaults to the selected one.

The returned list has the form (LEFT TOP RIGHT BOTTOM).  TOP and BOTTOM
count by lines, and LEFT and RIGHT count by columns, all relative to 0,
0 at top left corner of frame.

RIGHT is one more than the rightmost column occupied by WINDOW.  BOTTOM
is one more than the bottommost row occupied by WINDOW.  The edges
include the space used by WINDOW's scroll bar, display margins, fringes,
header line, and/or mode line.  For the edges of just the text area, use
`window-inside-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
919
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
920
{
921
  register struct window *w = decode_valid_window (window);
Jim Blandy's avatar
Jim Blandy committed
922

923 924
  return list4i (WINDOW_LEFT_EDGE_COL (w), WINDOW_TOP_EDGE_LINE (w),
		 WINDOW_RIGHT_EDGE_COL (w), WINDOW_BOTTOM_EDGE_LINE (w));
Jim Blandy's avatar
Jim Blandy committed
925 926
}

927 928
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
929 930 931 932
WINDOW must be a valid window and defaults to the selected one.

The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
0, 0 at the top left corner of the frame.
933 934 935 936 937 938

RIGHT is one more than the rightmost x position occupied by WINDOW.
BOTTOM is one more than the bottommost y position occupied by WINDOW.
The pixel edges include the space used by WINDOW's scroll bar, display
margins, fringes, header line, and/or mode line.  For the pixel edges
of just the text area, use `window-inside-pixel-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
939
  (Lisp_Object window)
940
{
941
  register struct window *w = decode_valid_window (window);
942

943 944
  return