window.c 220 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
#include <stdio.h>

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

Paul Eggert's avatar
Paul Eggert committed
47 48
Lisp_Object Qwindowp, Qwindow_live_p;
static Lisp_Object Qwindow_valid_p;
49 50
static Lisp_Object Qwindow_configuration_p;
static Lisp_Object Qrecord_window_buffer;
51
static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
Martin Rudalics's avatar
Martin Rudalics committed
52
static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
53
static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
54
static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
55
static Lisp_Object Qsafe, Qabove, Qbelow, Qwindow_size, Qclone_of;
Martin Rudalics's avatar
Martin Rudalics committed
56

57 58 59
static int displayed_window_lines (struct window *);
static int count_windows (struct window *);
static int get_leaf_windows (struct window *, struct window **, int);
60 61 62
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);
63 64 65 66 67
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
68
static void foreach_window (struct frame *,
69
				 int (* fn) (struct window *, void *),
Andreas Schwab's avatar
Andreas Schwab committed
70
                            void *);
71 72 73 74
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);
75 76
static int window_resize_check (struct window *, bool);
static void window_resize_apply (struct window *, bool);
Glenn Morris's avatar
Glenn Morris committed
77
static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
78
static void select_window_1 (Lisp_Object, bool);
79

80 81 82 83 84 85 86 87
static struct window *set_window_fringes (struct window *, Lisp_Object,
					  Lisp_Object, Lisp_Object);
static struct window *set_window_margins (struct window *, Lisp_Object,
					  Lisp_Object);
static struct window *set_window_scroll_bars (struct window *, Lisp_Object,
					      Lisp_Object, Lisp_Object);
static void apply_window_adjustment (struct window *);

Jim Blandy's avatar
Jim Blandy committed
88 89 90 91 92 93
/* 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
94
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
95 96
Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
97 98 99 100 101
/* 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;

102 103 104
/* 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
105 106 107
   the selected window.  */
Lisp_Object minibuf_window;

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

112
/* Hook run at end of temp_output_buffer_show.  */
113
static Lisp_Object Qtemp_buffer_show_hook;
114

115 116 117
/* Nonzero after init_window_once has finished.  */
static int window_initialized;

118
/* Hook to run when window config changes.  */
119
static Lisp_Object Qwindow_configuration_change_hook;
120

121
/* Used by the function window_scroll_pixel_based */
122
static int window_scroll_pixel_based_preserve_x;
123
static int window_scroll_pixel_based_preserve_y;
124

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

Paul Eggert's avatar
Paul Eggert committed
135
/* These setters are used only in this file, so they can be private.  */
136
static void
Paul Eggert's avatar
Paul Eggert committed
137 138 139 140
wset_combination_limit (struct window *w, Lisp_Object val)
{
  w->combination_limit = val;
}
141
static void
Paul Eggert's avatar
Paul Eggert committed
142 143 144 145
wset_dedicated (struct window *w, Lisp_Object val)
{
  w->dedicated = val;
}
146
static void
Paul Eggert's avatar
Paul Eggert committed
147 148 149 150
wset_display_table (struct window *w, Lisp_Object val)
{
  w->display_table = val;
}
151
static void
Paul Eggert's avatar
Paul Eggert committed
152 153 154 155
wset_new_normal (struct window *w, Lisp_Object val)
{
  w->new_normal = val;
}
156
static void
Paul Eggert's avatar
Paul Eggert committed
157 158 159 160
wset_new_total (struct window *w, Lisp_Object val)
{
  w->new_total = val;
}
161
static void
Paul Eggert's avatar
Paul Eggert committed
162 163 164 165
wset_normal_cols (struct window *w, Lisp_Object val)
{
  w->normal_cols = val;
}
166
static void
Paul Eggert's avatar
Paul Eggert committed
167 168 169 170
wset_normal_lines (struct window *w, Lisp_Object val)
{
  w->normal_lines = val;
}
171
static void
Paul Eggert's avatar
Paul Eggert committed
172 173 174 175
wset_parent (struct window *w, Lisp_Object val)
{
  w->parent = val;
}
176
static void
Paul Eggert's avatar
Paul Eggert committed
177 178 179 180
wset_pointm (struct window *w, Lisp_Object val)
{
  w->pointm = val;
}
181
static void
Paul Eggert's avatar
Paul Eggert committed
182 183 184 185
wset_start (struct window *w, Lisp_Object val)
{
  w->start = val;
}
186
static void
Paul Eggert's avatar
Paul Eggert committed
187 188 189 190
wset_temslot (struct window *w, Lisp_Object val)
{
  w->temslot = val;
}
191
static void
Paul Eggert's avatar
Paul Eggert committed
192 193 194 195
wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
{
  w->vertical_scroll_bar_type = val;
}
196
static void
Paul Eggert's avatar
Paul Eggert committed
197 198 199 200
wset_window_parameters (struct window *w, Lisp_Object val)
{
  w->window_parameters = val;
}
201 202 203 204 205 206 207 208 209 210 211 212
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
213

214 215 216 217 218 219 220 221 222 223 224
/* 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));
}

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

231 232 233 234
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

235
struct window *
236 237
decode_any_window (register Lisp_Object window)
{
238 239
  struct window *w;

240 241 242 243
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
244 245
  w = XWINDOW (window);
  return w;
246
}
247

Paul Eggert's avatar
Paul Eggert committed
248
static struct window *
249 250 251 252 253 254 255 256 257 258 259 260
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
261 262 263 264 265 266 267
/* 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);
268
  if (BUFFERP (w->contents))
Dmitry Antipov's avatar
Dmitry Antipov committed
269
    {
270
      struct buffer *b = XBUFFER (w->contents);
Paul Eggert's avatar
Paul Eggert committed
271

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

/* 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);
289 290 291 292 293
  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
294 295 296
  adjust_window_count (w, 1);
}

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

304 305 306 307 308 309 310 311 312
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;
}

313
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
314
       doc: /* Return t if OBJECT is a live window and nil otherwise.
315 316
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
317
  (Lisp_Object object)
318
{
319
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
320
}
321 322

/* Frames and windows.  */
323
DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 0, 1, 0,
324
       doc: /* Return the frame that window WINDOW is on.
325
WINDOW must be a valid window and defaults to the selected one.  */)
326 327
  (Lisp_Object window)
{
328
  return decode_valid_window (window)->frame;
329 330 331
}

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

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

  return window;
}

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

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

/* 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,
372 373
       doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
374 375
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
376 377 378 379 380 381
the first window of that frame.  */)
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

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

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

  return window;
}

DEFUN ("frame-selected-window", Fframe_selected_window,
       Sframe_selected_window, 0, 1, 0,
399 400
       doc: /* Return the selected window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
401 402 403
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.  */)
404 405 406 407 408
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
409
    window = SELECTED_FRAME ()->selected_window;
410
  else if (WINDOW_VALID_P (frame_or_window))
411
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
412 413 414
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
415
      window = XFRAME (frame_or_window)->selected_window;
416 417 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
    }

  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
443 444 445 446
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
447 448 449 450 451 452 453 454 455 456 457
}

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;
}

458 459
int window_select_count;

460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
/* 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);

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

478
  if (EQ (window, selected_window) && !inhibit_point_swap)
479 480 481 482
    /* `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;
483

484 485 486 487 488 489
  if (NILP (norecord))
    /* Mark the window for redisplay since the selected-window has a different
       mode-line.  */
    wset_redisplay (XWINDOW (selected_window));
  else
    redisplay_other_windows ();
490 491 492
  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
    {
493
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
494 495 496 497 498 499 500 501 502 503
      /* 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
504
    fset_selected_window (sf, window);
505

506
  select_window_1 (window, inhibit_point_swap);
507
  bset_last_selected_window (XBUFFER (w->contents), window);
508 509
  if (NILP (norecord))
    wset_redisplay (w);
510

511
 record_and_return:
512 513 514 515 516 517 518 519 520
  /* 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);
    }

521 522 523 524
  return window;
}

/* Select window with a minimum of fuss, i.e. don't record the change anywhere
Paul Eggert's avatar
Paul Eggert committed
525
   (not even for redisplay's benefit), and assume that the window's frame is
526
   already selected.  */
527
static void
528 529
select_window_1 (Lisp_Object window, bool inhibit_point_swap)
{
530 531 532
  /* 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.  */
533 534
  if (!inhibit_point_swap)
    {
535
      struct window *ow = XWINDOW (selected_window);
536 537 538 539
      if (BUFFERP (ow->contents))
	set_marker_both (ow->pointm, ow->contents,
			 BUF_PT (XBUFFER (ow->contents)),
			 BUF_PT_BYTE (XBUFFER (ow->contents)));
540 541 542 543 544 545 546 547 548
    }

  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.  */
549
  set_point_from_marker (XWINDOW (window)->pointm);
550 551 552
}

DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
553 554 555 556 557
       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.
558 559 560 561

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.
562

563 564 565 566 567 568 569
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);
}

570
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
571 572 573
       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.  */)
574 575
  (Lisp_Object window)
{
576 577
  struct window *w = decode_any_window (window);
  return WINDOW_LEAF_P (w) ? w->contents : Qnil;
578 579 580
}

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

589
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
590
       doc: /* Return the topmost child window of window WINDOW.
591
WINDOW must be a valid window and defaults to the selected one.
592 593 594
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.  */)
595 596
  (Lisp_Object window)
{
597 598
  struct window *w = decode_valid_window (window);
  return WINDOW_VERTICAL_COMBINATION_P (w) ? w->contents : Qnil;
599 600
}

601
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
602
       doc: /* Return the leftmost child window of window WINDOW.
603
WINDOW must be a valid window and defaults to the selected one.
604 605 606
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.  */)
607 608
  (Lisp_Object window)
{
609 610
  struct window *w = decode_valid_window (window);
  return WINDOW_HORIZONTAL_COMBINATION_P (w) ? w->contents : Qnil;
611 612
}

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

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

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

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

648
DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
649
       doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
650
WINDOW must be a valid window used in horizontal or vertical combination.
651 652 653
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
654
future use.  */)
655
  (Lisp_Object window, Lisp_Object limit)
656
{
657 658 659 660
  struct window *w;

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

667
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
668
       doc: /* Return the use time of window WINDOW.
669
WINDOW must be a live window and defaults to the selected one.
670 671 672
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.  */)
673 674
  (Lisp_Object window)
{
675
  return make_number (decode_live_window (window)->use_time);
676
}
677

678 679
DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
       doc: /* Return the total height, in lines, of window WINDOW.
680
WINDOW must be a valid window and defaults to the selected one.
681

682 683 684
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.
685

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

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

697 698 699
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.
700

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

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

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

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
725 726 727
}

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

735
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
736
       doc: /* Return left column of window WINDOW.
737 738 739 740
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.

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

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
748
       doc: /* Return top line of window WINDOW.
749 750 751 752
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.

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

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

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

  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));
787
  int width = w->total_cols;
788 789 790 791 792 793 794 795 796 797

  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;

798 799 800
  /* Display margins cannot be used for normal text.  */
  width -= WINDOW_LEFT_MARGIN_COLS (w) + WINDOW_RIGHT_MARGIN_COLS (w);

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

  return width;
}

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

812 813 814 815 816 817
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)
818
{
819
  return make_number (window_body_lines (decode_live_window (window)));
820
}
821

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

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)
{
831
  return make_number (window_body_cols (decode_live_window (window)));
832
}
833

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

842 843 844 845 846
/* 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)
{
847 848 849 850 851 852 853 854
  /* 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);
855 856 857

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

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

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

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

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

DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
       Sset_window_redisplay_end_trigger, 2, 2, 0,
890
       doc: /* Set WINDOW's redisplay end trigger value to VALUE.
891 892 893 894 895 896
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
897
  (register Lisp_Object window, Lisp_Object value)
898
{
Paul Eggert's avatar
Paul Eggert committed
899 900
  wset_redisplay_end_trigger (decode_live_window (window), value);
  return value;
901 902
}

Jim Blandy's avatar
Jim Blandy committed
903
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
904
       doc: /* Return a list of the edge coordinates of WINDOW.
905 906 907 908 909 910 911 912 913 914 915
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
916
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
917
{
918
  register struct window *w = decode_valid_window (window);
Jim Blandy's avatar
Jim Blandy committed
919

920 921
  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
922 923
}

924 925
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
926 927 928 929
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.
930 931 932 933 934 935

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
936
  (Lisp_Object window)
937
{
938
  register struct window *w = decode_valid_window (window);
939

940 941
  return list4i (WINDOW_LEFT_EDGE_X (w), WINDOW_TOP_EDGE_Y (w),
		 WINDOW_RIGHT_EDGE_X (w), WINDOW_BOTTOM_EDGE_Y (w));
942 943
}