window.c 241 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
   Copyright (C) 1985-1987, 1993-1998, 2000-2014 Free Software
4
   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 Qwindow_pixel_to_total;
55
static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
56
static Lisp_Object Qsafe, Qabove, Qbelow, Qwindow_size, Qclone_of;
57
static Lisp_Object Qfloor, Qceiling;
Martin Rudalics's avatar
Martin Rudalics committed
58

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
100 101 102 103 104
/* 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;

105 106 107
/* 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
108 109 110
   the selected window.  */
Lisp_Object minibuf_window;

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

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

118 119 120
/* Incremented for each window created.  */
static int sequence_number;

121 122 123
/* Nonzero after init_window_once has finished.  */
static int window_initialized;

124
/* Hook to run when window config changes.  */
125
static Lisp_Object Qwindow_configuration_change_hook;
126

127
/* Used by the function window_scroll_pixel_based */
128
static int window_scroll_pixel_based_preserve_x;
129
static int window_scroll_pixel_based_preserve_y;
130

131
/* Same for window_scroll_line_based.  */
132 133
static EMACS_INT window_scroll_preserve_hpos;
static EMACS_INT window_scroll_preserve_vpos;
134

135 136 137 138 139 140
static void
CHECK_WINDOW_CONFIGURATION (Lisp_Object x)
{
  CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x);
}

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

220 221 222 223 224 225 226 227 228 229 230
/* 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));
}

231 232
struct window *
decode_live_window (register Lisp_Object window)
233 234 235
{
  if (NILP (window))
    return XWINDOW (selected_window);
236

237 238 239 240
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

241
struct window *
242 243
decode_any_window (register Lisp_Object window)
{
244 245
  struct window *w;

246 247 248 249
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
250 251
  w = XWINDOW (window);
  return w;
252
}
253

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

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

/* 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);
295 296 297 298 299
  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
300 301 302
  adjust_window_count (w, 1);
}

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

310 311 312 313 314 315 316 317 318
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;
}

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

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

  if (NILP (frame_or_window))
347
    window = SELECTED_FRAME ()->root_window;
348 349
  else if (WINDOW_VALID_P (frame_or_window))
      window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
350 351 352
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
353
      window = XFRAME (frame_or_window)->root_window;
354 355 356 357 358 359
    }

  return window;
}

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

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

/* 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,
378 379
       doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
380 381
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
382 383 384 385 386 387
the first window of that frame.  */)
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
388
    window = SELECTED_FRAME ()->root_window;
389
  else if (WINDOW_VALID_P (frame_or_window))
390
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
391 392 393
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
394
      window = XFRAME (frame_or_window)->root_window;
395 396
    }

397 398
  while (WINDOWP (XWINDOW (window)->contents))
    window = XWINDOW (window)->contents;
399 400 401 402 403 404

  return window;
}

DEFUN ("frame-selected-window", Fframe_selected_window,
       Sframe_selected_window, 0, 1, 0,
405 406
       doc: /* Return the selected window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
407 408 409
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.  */)
410 411 412 413 414
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

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

  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
449 450 451 452
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
453 454 455 456 457 458 459 460 461 462 463
}

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

464 465
int window_select_count;

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
/* 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);

481
  /* Make the selected window's buffer current.  */
482
  Fset_buffer (w->contents);
483

484
  if (EQ (window, selected_window) && !inhibit_point_swap)
485 486 487 488
    /* `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;
489

490
  if (NILP (norecord))
491 492 493 494 495
    { /* Mark the window for redisplay since the selected-window has
	 a different mode-line.  */
      wset_redisplay (XWINDOW (selected_window));
      wset_redisplay (w);
    }
496 497
  else
    redisplay_other_windows ();
498

499 500 501
  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
    {
502
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
503 504 505 506 507 508 509 510 511 512
      /* 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
513
    fset_selected_window (sf, window);
514

515
  select_window_1 (window, inhibit_point_swap);
516
  bset_last_selected_window (XBUFFER (w->contents), window);
517

518
 record_and_return:
519 520 521 522 523 524 525 526 527
  /* 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);
    }

528 529 530 531
  return window;
}

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

  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.  */
556
  set_point_from_marker (XWINDOW (window)->pointm);
557 558 559
}

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

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

570 571 572 573 574 575 576 577 578 579 580
Run `buffer-list-update-hook' unless NORECORD is non-nil.  Note that
applications and internal routines often select a window temporarily for
various purposes; mostly, to simplify coding.  As a rule, such
selections should be not recorded and therefore will not pollute
`buffer-list-update-hook'.  Selections that "really count" are those
causing a visible change in the next redisplay of WINDOW's frame and
should be always recorded.  So if you think of running a function each
time a window gets selected put it on `buffer-list-update-hook'.

Also note that the main editor command loop sets the current buffer to
the buffer of the selected window before each command.  */)
581 582 583 584 585
  (register Lisp_Object window, Lisp_Object norecord)
{
  return select_window (window, norecord, 0);
}

586
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
587 588 589
       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.  */)
590 591
  (Lisp_Object window)
{
592 593
  struct window *w = decode_any_window (window);
  return WINDOW_LEAF_P (w) ? w->contents : Qnil;
594 595 596
}

DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
597
       doc: /* Return the parent window of window WINDOW.
598
WINDOW must be a valid window and defaults to the selected one.
599
Return nil for a window with no parent (e.g. a root window).  */)
600 601
  (Lisp_Object window)
{
602
  return decode_valid_window (window)->parent;
603 604
}

605
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
606
       doc: /* Return the topmost child window of window WINDOW.
607
WINDOW must be a valid window and defaults to the selected one.
608 609 610
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.  */)
611 612
  (Lisp_Object window)
{
613 614
  struct window *w = decode_valid_window (window);
  return WINDOW_VERTICAL_COMBINATION_P (w) ? w->contents : Qnil;
615 616
}

617
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
618
       doc: /* Return the leftmost child window of window WINDOW.
619
WINDOW must be a valid window and defaults to the selected one.
620 621 622
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.  */)
623 624
  (Lisp_Object window)
{
625 626
  struct window *w = decode_valid_window (window);
  return WINDOW_HORIZONTAL_COMBINATION_P (w) ? w->contents : Qnil;
627 628
}

629
DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
630
       doc: /* Return the next sibling window of window WINDOW.
631
WINDOW must be a valid window and defaults to the selected one.
632
Return nil if WINDOW has no next sibling.  */)
633 634
  (Lisp_Object window)
{
635
  return decode_valid_window (window)->next;
636 637
}

638
DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
639
       doc: /* Return the previous sibling window of window WINDOW.
640
WINDOW must be a valid window and defaults to the selected one.
641
Return nil if WINDOW has no previous sibling.  */)
642 643
  (Lisp_Object window)
{
644
  return decode_valid_window (window)->prev;
645
}
Gerd Moellmann's avatar
Gerd Moellmann committed
646

647
DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
648
       doc: /* Return combination limit of window WINDOW.
649
WINDOW must be a valid window used in horizontal or vertical combination.
650
If the return value is nil, child windows of WINDOW can be recombined with
651
WINDOW's siblings.  A return value of t means that child windows of
652
WINDOW are never \(re-)combined with WINDOW's siblings.  */)
653
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
654
{
655 656
  struct window *w;

657
  CHECK_VALID_WINDOW (window);
658
  w = XWINDOW (window);
659
  if (WINDOW_LEAF_P (w))
660
    error ("Combination limit is meaningful for internal windows only");
661
  return w->combination_limit;
Jim Blandy's avatar
Jim Blandy committed
662
}
663

664
DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
665
       doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
666
WINDOW must be a valid window used in horizontal or vertical combination.
667 668 669
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
670
future use.  */)
671
  (Lisp_Object window, Lisp_Object limit)
672
{
673 674 675 676
  struct window *w;

  CHECK_VALID_WINDOW (window);
  w = XWINDOW (window);
677
  if (WINDOW_LEAF_P (w))
678 679
    error ("Combination limit is meaningful for internal windows only");
  wset_combination_limit (w, limit);
Paul Eggert's avatar
Paul Eggert committed
680
  return limit;
681
}
682

683
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
684
       doc: /* Return the use time of window WINDOW.
685
WINDOW must be a live window and defaults to the selected one.
686 687 688
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.  */)
689 690
  (Lisp_Object window)
{
691
  return make_number (decode_live_window (window)->use_time);
692
}
693

694
DEFUN ("window-pixel-width", Fwindow_pixel_width, Swindow_pixel_width, 0, 1, 0,
695
       doc: /* Return the width of window WINDOW in pixels.
696 697 698 699 700 701 702 703 704 705 706 707
WINDOW must be a valid window and defaults to the selected one.

The return value includes the fringes and margins of WINDOW as well as
any vertical dividers or scroll bars belonging to WINDOW.  If WINDOW is
an internal window, its pixel width is the width of the screen areas
spanned by its children.  */)
     (Lisp_Object window)
{
  return make_number (decode_valid_window (window)->pixel_width);
}

DEFUN ("window-pixel-height", Fwindow_pixel_height, Swindow_pixel_height, 0, 1, 0,
708
       doc: /* Return the height of window WINDOW in pixels.
709 710
WINDOW must be a valid window and defaults to the selected one.

711 712 713
The return value includes the mode line and header line and the bottom
divider, if any.  If WINDOW is an internal window, its pixel height is
the height of the screen areas spanned by its children.  */)
714 715 716 717 718
  (Lisp_Object window)
{
  return make_number (decode_valid_window (window)->pixel_height);
}

719 720
DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 2, 0,
       doc: /* Return the height of window WINDOW in lines.
721
WINDOW must be a valid window and defaults to the selected one.
722

723 724 725
The return value includes the heights of WINDOW's mode and header line
and its bottom divider, if any.  If WINDOW is an internal window, the
total height is the height of the screen areas spanned by its children.
726

727 728 729 730 731 732 733 734 735 736 737 738 739
If WINDOW's pixel height is not an integral multiple of its frame's
character height, the number of lines occupied by WINDOW is rounded
internally.  This is done in a way such that, if WINDOW is a parent
window, the sum of the total heights of all its children internally
equals the total height of WINDOW.

If the optional argument ROUND is `ceiling', return the smallest integer
larger than WINDOW's pixel height divided by the character height of
WINDOW's frame.  ROUND `floor' means to return the largest integer
smaller than WINDOW's pixel height divided by the character height of
WINDOW's frame.  Any other value of ROUND means to return the internal
total height of WINDOW.  */)
  (Lisp_Object window, Lisp_Object round)
740
{
741 742 743 744 745 746 747 748 749 750 751 752
  struct window *w = decode_valid_window (window);

  if (! EQ (round, Qfloor) && ! EQ (round, Qceiling))
    return make_number (w->total_lines);
  else
    {
      int unit = FRAME_LINE_HEIGHT (WINDOW_XFRAME (w));

      return make_number (EQ (round, Qceiling)
			  ? ((w->pixel_height + unit - 1) /unit)
			  : (w->pixel_height / unit));
    }
753
}
754

755 756
DEFUN ("window-total-width", Fwindow_total_width, Swindow_total_width, 0, 2, 0,
       doc: /* Return the total width of window WINDOW in columns.
757
WINDOW must be a valid window and defaults to the selected one.
758

759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
The return value includes the widths of WINDOW's fringes, margins,
scroll bars and its right divider, if any.  If WINDOW is an internal
window, the total width is the width of the screen areas spanned by its
children.

If WINDOW's pixel width is not an integral multiple of its frame's
character width, the number of lines occupied by WINDOW is rounded
internally.  This is done in a way such that, if WINDOW is a parent
window, the sum of the total widths of all its children internally
equals the total width of WINDOW.

If the optional argument ROUND is `ceiling', return the smallest integer
larger than WINDOW's pixel width divided by the character width of
WINDOW's frame.  ROUND `floor' means to return the largest integer
smaller than WINDOW's pixel width divided by the character width of
WINDOW's frame.  Any other value of ROUND means to return the internal
total width of WINDOW.  */)
  (Lisp_Object window, Lisp_Object round)
777
{
778 779 780 781 782 783 784 785 786 787 788 789
  struct window *w = decode_valid_window (window);

  if (! EQ (round, Qfloor) && ! EQ (round, Qceiling))
    return make_number (w->total_cols);
  else
    {
      int unit = FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w));

      return make_number (EQ (round, Qceiling)
			  ? ((w->pixel_width + unit - 1) /unit)
			  : (w->pixel_width / unit));
    }
790
}
791

792
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
793
       doc: /* Return the new total size of window WINDOW.
794
WINDOW must be a valid window and defaults to the selected one.  */)
795 796
  (Lisp_Object window)
{
797
  return decode_valid_window (window)->new_total;
798 799 800
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
801
       doc: /* Return the normal height of window WINDOW.
802
WINDOW must be a valid window and defaults to the selected one.
803
If HORIZONTAL is non-nil, return the normal width of WINDOW.  */)
804 805
  (Lisp_Object window, Lisp_Object horizontal)
{
806
  struct window *w = decode_valid_window (window);
807 808

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
809 810 811
}

DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
812
       doc: /* Return new normal size of window WINDOW.
813
WINDOW must be a valid window and defaults to the selected one.  */)
814 815
  (Lisp_Object window)
{
816
  return decode_valid_window (window)->new_normal;
817 818
}

819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
DEFUN ("window-new-pixel", Fwindow_new_pixel, Swindow_new_pixel, 0, 1, 0,
       doc: /* Return new pixel size of window WINDOW.
WINDOW must be a valid window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return decode_valid_window (window)->new_pixel;
}

DEFUN ("window-pixel-left", Fwindow_pixel_left, Swindow_pixel_left, 0, 1, 0,
       doc: /* Return left pixel edge of window WINDOW.
WINDOW must be a valid window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return make_number (decode_valid_window (window)->pixel_left);
}

DEFUN ("window-pixel-top", Fwindow_pixel_top, Swindow_pixel_top, 0, 1, 0,
       doc: /* Return top pixel edge of window WINDOW.
WINDOW must be a valid window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return make_number (decode_valid_window (window)->pixel_top);
}

843
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
844
       doc: /* Return left column of window WINDOW.
845 846 847 848
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.

849
WINDOW must be a valid window and defaults to the selected one.  */)
850 851
  (Lisp_Object window)
{
852
  return make_number (decode_valid_window (window)->left_col);
853 854 855
}

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
856
       doc: /* Return top line of window WINDOW.
857 858 859 860
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.

861
WINDOW must be a valid window and defaults to the selected one.  */)
862 863
  (Lisp_Object window)
{
864
  return make_number (decode_valid_window (window)->top_line);
865 866
}

867 868 869
/* Return the number of lines/pixels of W's body.  Don't count any mode
   or header line or horizontal divider of W.  Rounds down to nearest
   integer when not working pixelwise. */
870
static int
871
window_body_height (struct window *w, bool pixelwise)
872
{
873
  int height = (w->pixel_height
874
		- WINDOW_HEADER_LINE_HEIGHT (w)
875 876
		- WINDOW_MODE_LINE_HEIGHT (w)
		- WINDOW_BOTTOM_DIVIDER_WIDTH (w));
877

Martin Rudalics's avatar
Martin Rudalics committed
878 879 880 881 882
  /* Don't return a negative value.  */
  return max (pixelwise
	      ? height
	      : height / FRAME_LINE_HEIGHT (WINDOW_XFRAME (w)),
	      0);
883 884
}

885 886 887 888 889
/* Return the number of columns/pixels of W's body.  Don't count columns
   occupied by the scroll bar or the divider/vertical bar separating W
   from its right sibling or margins.  On window-systems don't count
   fringes either.  Round down to nearest integer when not working
   pixelwise.  */
890
int
891
window_body_width (struct window *w, bool pixelwise)
892 893 894
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));

895 896 897 898 899 900 901 902 903
  int width = (w->pixel_width
	       - WINDOW_RIGHT_DIVIDER_WIDTH (w)
	       - (WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
		  ? WINDOW_SCROLL_BAR_AREA_WIDTH (w)
		  : ((!FRAME_WINDOW_P (f)
		      && !WINDOW_RIGHTMOST_P (w)
		      && !WINDOW_RIGHT_DIVIDER_WIDTH (w))
		     /* A vertical bar is either 1 or 0.  */
		     ? 1 : 0))
904 905 906 907 908
		- WINDOW_MARGINS_WIDTH (w)
		- (FRAME_WINDOW_P (f)
		   ? WINDOW_FRINGES_WIDTH (w)
		   : 0));

Martin Rudalics's avatar
Martin Rudalics committed
909 910 911 912 913
  /* Don't return a negative value.  */
  return max (pixelwise
	      ? width
	      : width / FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w)),
	      0);
914 915 916
}

DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 2, 0,
917 918 919 920 921 922 923 924 925 926
       doc: /* Return the height of WINDOW's text area.
WINDOW must be a live window and defaults to the selected one.  Optional
argument PIXELWISE non-nil means return the height of WINDOW's text area
in pixels.  The return value does not include the mode line or header
line or any horizontal divider.

If PIXELWISE is nil, return the largest integer smaller than WINDOW's
pixel height divided by the character height of WINDOW's frame.  This
means that if a line at the bottom of the text area is only partially
visible, that line is not counted.  */)
927 928 929 930
  (Lisp_Object window, Lisp_Object pixelwise)
{
  return make_number (window_body_height (decode_live_window (window),
					  NILP (pixelwise) ? 0 : 1));
931 932
}

933
DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 2, 0,
934 935 936 937 938 939 940 941 942 943
       doc: /* Return the width of WINDOW's text area.
WINDOW must be a live window and defaults to the selected one.  Optional
argument PIXELWISE non-nil means return the width in pixels.  The return
value does not include any vertical dividers, fringes or marginal areas,
or scroll bars.

If PIXELWISE is nil, return the largest integer smaller than WINDOW's
pixel width divided by the character width of WINDOW's frame.  This
means that if a column at the right of the text area is only partially
visible, that column is not counted.  */)
944 945 946 947 948 949 950 951
  (Lisp_Object window, Lisp_Object pixelwise)
{
  return make_number (window_body_width (decode_live_window (window),
					 NILP (pixelwise) ? 0 : 1));
}

DEFUN ("window-mode-line-height", Fwindow_mode_line_height,
       Swindow_mode_line_height, 0, 1, 0,
952
       doc: /* Return the height in pixels of WINDOW's mode-line.
953
WINDOW must be a live window and defaults to the selected one.  */)
954
  (Lisp_Object window)
955
{
956
  return (make_number (WINDOW_MODE_LINE_HEIGHT (decode_live_window (window))));
957
}
958

959 960
DEFUN ("window-header-line-height", Fwindow_header_line_height,
       Swindow_header_line_height, 0, 1, 0,
961
       doc: /* Return the height in pixels of WINDOW's header-line.
962 963 964 965 966
WINDOW must be a live window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return (make_number (WINDOW_HEADER_LINE_HEIGHT (decode_live_window (window))));
}
967

968 969
DEFUN ("window-right-divider-width", Fwindow_right_divider_width,
       Swindow_right_divider_width, 0, 1, 0,
970
       doc: /* Return the width in pixels of WINDOW's right divider.
971
WINDOW must be a live window and defaults to the selected one.  */)
972 973
  (Lisp_Object window)
{
974 975 976 977 978
  return (make_number (WINDOW_RIGHT_DIVIDER_WIDTH (decode_live_window (window))));
}

DEFUN ("window-bottom-divider-width", Fwindow_bottom_divider_width,
       Swindow_bottom_divider_width, 0, 1, 0,
979
       doc: /* Return the width in pixels of WINDOW's bottom divider.
980 981 982 983
WINDOW must be a live window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return (make_number (WINDOW_BOTTOM_DIVIDER_WIDTH (decode_live_window (window))));
984
}
985

986 987 988 989 990 991 992 993 994
DEFUN ("window-scroll-bar-width", Fwindow_scroll_bar_width,
       Swindow_scroll_bar_width, 0, 1, 0,
       doc: /* Return the width in pixels of WINDOW's vertical scrollbar.
WINDOW must be a live window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return (make_number (WINDOW_SCROLL_BAR_AREA_WIDTH (decode_live_window (window))));
}

Jim Blandy's avatar
Jim Blandy committed
995
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
996
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.