window.c 242 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;
58
static Lisp_Object Qwindow_point_insertion_type;
Martin Rudalics's avatar
Martin Rudalics committed
59

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return window;
}

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

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

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

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

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

  return window;
}

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

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

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

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

465 466
int window_select_count;

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

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

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

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

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

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

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

529 530 531 532
  return window;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

724 725 726
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.
727

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

987 988 989 990 991 992 993 994 995
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
996
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,