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"
Paul Eggert's avatar
Paul Eggert committed
30
#include "menu.h"
Jim Blandy's avatar
Jim Blandy committed
31
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
32 33 34 35 36
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
37
#include "dispextern.h"
38 39
#include "blockinput.h"
#include "intervals.h"
40
#include "termhooks.h"		/* For FRAME_TERMINAL.  */
41 42 43
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
44 45 46
#ifdef MSDOS
#include "msdos.h"
#endif
47

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

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

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

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

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

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

117
/* Hook run at end of temp_output_buffer_show.  */
118
static Lisp_Object Qtemp_buffer_show_hook;
119

120 121 122
/* Incremented for each window created.  */
static int sequence_number;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return window;
}

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

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

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

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

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

  return window;
}

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

  if (NILP (frame_or_window))
414
    window = SELECTED_FRAME ()->selected_window;
415
  else if (WINDOW_VALID_P (frame_or_window))
416
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
417 418 419
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
420
      window = XFRAME (frame_or_window)->selected_window;
421 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
    }

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

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

463 464
int window_select_count;

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

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

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

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

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

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

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

527 528 529 530
  return window;
}

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

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

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

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

569 570 571 572 573 574 575 576 577 578 579
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.  */)
580 581 582 583 584
  (register Lisp_Object window, Lisp_Object norecord)
{
  return select_window (window, norecord, 0);
}

585
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
586 587 588
       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.  */)
589 590
  (Lisp_Object window)
{
591 592
  struct window *w = decode_any_window (window);
  return WINDOW_LEAF_P (w) ? w->contents : Qnil;
593 594 595
}

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

604
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
605
       doc: /* Return the topmost 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
horizontal combination.  */)
610 611
  (Lisp_Object window)
{
612 613
  struct window *w = decode_valid_window (window);
  return WINDOW_VERTICAL_COMBINATION_P (w) ? w->contents : Qnil;
614 615
}

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

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

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

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

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

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

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

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

710 711 712
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.  */)
713 714 715 716 717
  (Lisp_Object window)
{
  return make_number (decode_valid_window (window)->pixel_height);
}

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

722 723 724
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.
725

726 727 728 729 730 731 732 733 734 735 736 737 738
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)
739
{
740 741 742 743 744 745 746 747 748 749 750 751
  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));
    }
752
}
753

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

758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
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)
776
{
777 778 779 780 781 782 783 784 785 786 787 788
  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));
    }
789
}
790

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

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

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

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

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

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

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

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

866 867 868
/* 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. */
869
static int
870
window_body_height (struct window *w, bool pixelwise)
871
{
872
  int height = (w->pixel_height
873
		- WINDOW_HEADER_LINE_HEIGHT (w)
874 875
		- WINDOW_MODE_LINE_HEIGHT (w)
		- WINDOW_BOTTOM_DIVIDER_WIDTH (w));
876

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

884 885 886 887 888
/* 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.  */
889
int
890
window_body_width (struct window *w, bool pixelwise)
891 892 893
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));

894 895 896 897 898 899 900 901 902
  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))
903 904 905 906 907
		- WINDOW_MARGINS_WIDTH (w)
		- (FRAME_WINDOW_P (f)
		   ? WINDOW_FRINGES_WIDTH (w)
		   : 0));

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

DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 2, 0,
916 917 918 919 920 921 922 923 924 925
       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.  */)
926 927 928 929
  (Lisp_Object window, Lisp_Object pixelwise)
{
  return make_number (window_body_height (decode_live_window (window),
					  NILP (pixelwise) ? 0 : 1));
930 931
}

932
DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 2, 0,
933 934 935 936 937 938 939 940 941 942
       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.  */)
943 944 945 946 947 948 949 950
  (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,
951
       doc: /* Return the height in pixels of WINDOW's mode-line.
952
WINDOW must be a live window and defaults to the selected one.  */)
953
  (Lisp_Object window)
954
{
955
  return (make_number (WINDOW_MODE_LINE_HEIGHT (decode_live_window (window))));
956
}
957

958 959
DEFUN ("window-header-line-height", Fwindow_header_line_height,
       Swindow_header_line_height, 0, 1, 0,
960
       doc: /* Return the height in pixels of WINDOW's header-line.
961 962 963 964 965
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))));
}
966

967 968
DEFUN ("window-right-divider-width", Fwindow_right_divider_width,
       Swindow_right_divider_width, 0, 1, 0,
969
       doc: /* Return the width in pixels of WINDOW's right divider.
970
WINDOW must be a live window and defaults to the selected one.  */)
971 972
  (Lisp_Object window)
{
973 974 975 976 977
  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,
978
       doc: /* Return the width in pixels of WINDOW's bottom divider.
979 980 981 982
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))));
983
}
984

985 986 987 988 989 990 991 992 993
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
994
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
995
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.