window.c 240 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
/* Window creation, deletion and examination for GNU Emacs.
   Does not include redisplay.
Paul Eggert's avatar
Paul Eggert committed
3
   Copyright (C) 1985-1987, 1993-1998, 2000-2015 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.  */
Joakim Verona's avatar
Joakim Verona committed
41 42 43
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
44 45 46
#ifdef MSDOS
#include "msdos.h"
#endif
47

48 49 50
static ptrdiff_t count_windows (struct window *);
static ptrdiff_t get_leaf_windows (struct window *, struct window **,
				   ptrdiff_t);
Paul Eggert's avatar
Paul Eggert committed
51 52
static void window_scroll_pixel_based (Lisp_Object, int, bool, bool);
static void window_scroll_line_based (Lisp_Object, int, bool, bool);
Andreas Schwab's avatar
Andreas Schwab committed
53
static void foreach_window (struct frame *,
Paul Eggert's avatar
Paul Eggert committed
54
			    bool (* fn) (struct window *, void *),
Andreas Schwab's avatar
Andreas Schwab committed
55
                            void *);
Paul Eggert's avatar
Paul Eggert committed
56 57 58 59
static bool foreach_window_1 (struct window *,
			      bool (* fn) (struct window *, void *),
			      void *);
static bool window_resize_check (struct window *, bool);
60
static void window_resize_apply (struct window *, bool);
61
static void select_window_1 (Lisp_Object, bool);
62

63 64 65 66 67
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,
Paul Eggert's avatar
Paul Eggert committed
68 69
					      Lisp_Object, Lisp_Object,
					      Lisp_Object);
70 71
static void apply_window_adjustment (struct window *);

Jim Blandy's avatar
Jim Blandy committed
72 73 74 75 76 77
/* 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
78
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
79 80
Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
81 82 83 84 85
/* 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;

86 87 88
/* 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
89 90 91
   the selected window.  */
Lisp_Object minibuf_window;

92 93
/* Non-nil means it is the window whose mode line should be
   shown as the selected window when the minibuffer is selected.  */
94
Lisp_Object minibuf_selected_window;
95

96
/* Incremented for each window created.  */
97
static EMACS_INT sequence_number;
98

99
/* Used by the function window_scroll_pixel_based.  */
100
static int window_scroll_pixel_based_preserve_x;
101
static int window_scroll_pixel_based_preserve_y;
102

103
/* Same for window_scroll_line_based.  */
104 105
static EMACS_INT window_scroll_preserve_hpos;
static EMACS_INT window_scroll_preserve_vpos;
106

107 108 109 110 111 112
static void
CHECK_WINDOW_CONFIGURATION (Lisp_Object x)
{
  CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x);
}

Paul Eggert's avatar
Paul Eggert committed
113
/* These setters are used only in this file, so they can be private.  */
114
static void
Paul Eggert's avatar
Paul Eggert committed
115 116 117 118
wset_combination_limit (struct window *w, Lisp_Object val)
{
  w->combination_limit = val;
}
119

120
static void
Paul Eggert's avatar
Paul Eggert committed
121 122 123 124
wset_dedicated (struct window *w, Lisp_Object val)
{
  w->dedicated = val;
}
125

126
static void
Paul Eggert's avatar
Paul Eggert committed
127 128 129 130
wset_display_table (struct window *w, Lisp_Object val)
{
  w->display_table = val;
}
131

132
static void
Paul Eggert's avatar
Paul Eggert committed
133 134 135 136
wset_new_normal (struct window *w, Lisp_Object val)
{
  w->new_normal = val;
}
137

138
static void
Paul Eggert's avatar
Paul Eggert committed
139 140 141 142
wset_new_total (struct window *w, Lisp_Object val)
{
  w->new_total = val;
}
143

144
static void
Paul Eggert's avatar
Paul Eggert committed
145 146 147 148
wset_normal_cols (struct window *w, Lisp_Object val)
{
  w->normal_cols = val;
}
149

150
static void
Paul Eggert's avatar
Paul Eggert committed
151 152 153 154
wset_normal_lines (struct window *w, Lisp_Object val)
{
  w->normal_lines = val;
}
155

156
static void
Paul Eggert's avatar
Paul Eggert committed
157 158 159 160
wset_parent (struct window *w, Lisp_Object val)
{
  w->parent = val;
}
161

162
static void
Paul Eggert's avatar
Paul Eggert committed
163 164 165 166
wset_pointm (struct window *w, Lisp_Object val)
{
  w->pointm = val;
}
167 168 169 170 171 172 173

static void
wset_old_pointm (struct window *w, Lisp_Object val)
{
  w->old_pointm = val;
}

174
static void
Paul Eggert's avatar
Paul Eggert committed
175 176 177 178
wset_start (struct window *w, Lisp_Object val)
{
  w->start = val;
}
179

180
static void
Paul Eggert's avatar
Paul Eggert committed
181 182 183 184
wset_temslot (struct window *w, Lisp_Object val)
{
  w->temslot = val;
}
185

186
static void
Paul Eggert's avatar
Paul Eggert committed
187 188 189 190
wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
{
  w->vertical_scroll_bar_type = val;
}
191

192
static void
Paul Eggert's avatar
Paul Eggert committed
193 194 195 196
wset_window_parameters (struct window *w, Lisp_Object val)
{
  w->window_parameters = val;
}
197

198 199 200 201 202 203 204 205 206 207 208 209
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
210

Paul Eggert's avatar
Paul Eggert committed
211
/* True if leaf window W doesn't reflect the actual state
212 213 214 215 216 217 218 219 220 221
   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));
}

222 223
struct window *
decode_live_window (register Lisp_Object window)
224 225 226
{
  if (NILP (window))
    return XWINDOW (selected_window);
227

228 229 230 231
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

232
struct window *
233 234
decode_any_window (register Lisp_Object window)
{
235 236
  struct window *w;

237 238 239 240
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
241 242
  w = XWINDOW (window);
  return w;
243
}
244

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

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

/* 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);
286 287 288 289 290
  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
291 292 293
  adjust_window_count (w, 1);
}

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

301 302 303
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
304
window.  Windows that have been deleted are not valid.  */)
305 306 307 308 309
  (Lisp_Object object)
{
  return WINDOW_VALID_P (object) ? Qt : Qnil;
}

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

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

  if (NILP (frame_or_window))
338
    window = SELECTED_FRAME ()->root_window;
339 340
  else if (WINDOW_VALID_P (frame_or_window))
      window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
341 342 343
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
344
      window = XFRAME (frame_or_window)->root_window;
345 346 347
    }

  return window;
Jim Blandy's avatar
Jim Blandy committed
348 349
}

350
DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
351 352
       doc: /* Return the minibuffer window for frame FRAME.
If FRAME is omitted or nil, it defaults to the selected frame.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
353
  (Lisp_Object frame)
Jim Blandy's avatar
Jim Blandy committed
354
{
355
  return FRAME_MINIBUF_WINDOW (decode_live_frame (frame));
Jim Blandy's avatar
Jim Blandy committed
356 357
}

358 359
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
       Swindow_minibuffer_p, 0, 1, 0,
360
       doc: /* Return non-nil if WINDOW is a minibuffer window.
361
WINDOW must be a valid window and defaults to the selected one.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
362
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
363
{
364
  return MINI_WINDOW_P (decode_valid_window (window)) ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
365 366
}

367 368
/* 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,
369 370
       doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
371 372
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
373 374
the first window of that frame.  */)
  (Lisp_Object frame_or_window)
Jim Blandy's avatar
Jim Blandy committed
375
{
376
  Lisp_Object window;
Jim Blandy's avatar
Jim Blandy committed
377

378
  if (NILP (frame_or_window))
379
    window = SELECTED_FRAME ()->root_window;
380
  else if (WINDOW_VALID_P (frame_or_window))
381
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
382 383 384
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
385
      window = XFRAME (frame_or_window)->root_window;
386
    }
Miles Bader's avatar
Miles Bader committed
387

388 389
  while (WINDOWP (XWINDOW (window)->contents))
    window = XWINDOW (window)->contents;
Jim Blandy's avatar
Jim Blandy committed
390

391 392
  return window;
}
393

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

  if (NILP (frame_or_window))
406
    window = SELECTED_FRAME ()->selected_window;
407
  else if (WINDOW_VALID_P (frame_or_window))
408
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
409
  else
410
    {
411
      CHECK_LIVE_FRAME (frame_or_window);
412
      window = XFRAME (frame_or_window)->selected_window;
413 414
    }

415
  return window;
Jim Blandy's avatar
Jim Blandy committed
416
}
417

418 419 420 421 422 423 424 425 426 427 428 429
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;
430

431 432
  CHECK_LIVE_FRAME (frame);
  CHECK_LIVE_WINDOW (window);
433

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

437 438 439
  if (EQ (frame, selected_frame))
    return Fselect_window (window, norecord);
  else
440 441 442 443
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
444 445 446 447 448 449 450
}

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)
451
{
452 453
  return selected_window;
}
454

455
EMACS_INT window_select_count;
456

Paul Eggert's avatar
Paul Eggert committed
457
/* If select_window is called with inhibit_point_swap true it will
458 459 460 461 462
   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
Paul Eggert's avatar
Paul Eggert committed
463 464
select_window (Lisp_Object window, Lisp_Object norecord,
	       bool inhibit_point_swap)
465
{
Paul Eggert's avatar
Paul Eggert committed
466
  struct window *w;
467
  struct frame *sf;
468

469
  CHECK_LIVE_WINDOW (window);
470

471
  w = XWINDOW (window);
472

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

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

482
  if (NILP (norecord))
483 484 485 486 487
    { /* Mark the window for redisplay since the selected-window has
	 a different mode-line.  */
      wset_redisplay (XWINDOW (selected_window));
      wset_redisplay (w);
    }
488 489
  else
    redisplay_other_windows ();
490

491 492
  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
493
    {
494
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
495 496 497 498 499 500 501 502
      /* 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;
503
    }
504
  else
505
    fset_selected_window (sf, window);
506

507
  select_window_1 (window, inhibit_point_swap);
508
  bset_last_selected_window (XBUFFER (w->contents), window);
509

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

520 521 522 523
  return window;
}

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

541
  selected_window = window;
542

543 544 545 546 547
  /* 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.  */
Joakim Verona's avatar
Joakim Verona committed
548
  set_point_from_marker (XWINDOW (window)->pointm);
549 550
}

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

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

562 563 564 565 566 567 568 569 570 571 572
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.  */)
Paul Eggert's avatar
Paul Eggert committed
573
  (Lisp_Object window, Lisp_Object norecord)
574
{
Paul Eggert's avatar
Paul Eggert committed
575
  return select_window (window, norecord, false);
576
}
Jim Blandy's avatar
Jim Blandy committed
577

578
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
579 580 581
       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.  */)
582 583
  (Lisp_Object window)
{
584 585
  struct window *w = decode_any_window (window);
  return WINDOW_LEAF_P (w) ? w->contents : Qnil;
Jim Blandy's avatar
Jim Blandy committed
586 587
}

588
DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
589
       doc: /* Return the parent window of window WINDOW.
590
WINDOW must be a valid window and defaults to the selected one.
591
Return nil for a window with no parent (e.g. a root window).  */)
592
  (Lisp_Object window)
Kenichi Handa's avatar
Kenichi Handa committed
593
{
594
  return decode_valid_window (window)->parent;
595
}
Kenichi Handa's avatar
Kenichi Handa committed
596

597
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
598
       doc: /* Return the topmost child window of window WINDOW.
599
WINDOW must be a valid window and defaults to the selected one.
600 601 602
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.  */)
603 604
  (Lisp_Object window)
{
605 606
  struct window *w = decode_valid_window (window);
  return WINDOW_VERTICAL_COMBINATION_P (w) ? w->contents : Qnil;
Kenichi Handa's avatar
Kenichi Handa committed
607 608
}

609
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
610
       doc: /* Return the leftmost child window of window WINDOW.
611
WINDOW must be a valid window and defaults to the selected one.
612 613 614
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
615
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
616
{
617 618
  struct window *w = decode_valid_window (window);
  return WINDOW_HORIZONTAL_COMBINATION_P (w) ? w->contents : Qnil;
Jim Blandy's avatar
Jim Blandy committed
619 620
}

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

630
DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
631
       doc: /* Return the previous 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 previous sibling.  */)
634 635
  (Lisp_Object window)
{
636
  return decode_valid_window (window)->prev;
637
}
Gerd Moellmann's avatar
Gerd Moellmann committed
638

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

649
  CHECK_VALID_WINDOW (window);
650
  w = XWINDOW (window);
651
  if (WINDOW_LEAF_P (w))
652
    error ("Combination limit is meaningful for internal windows only");
653
  return w->combination_limit;
Jim Blandy's avatar
Jim Blandy committed
654 655
}

656
DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
657
       doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
658
WINDOW must be a valid window used in horizontal or vertical combination.
659 660 661
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
662
future use.  */)
663
  (Lisp_Object window, Lisp_Object limit)
664
{
665 666 667 668
  struct window *w;

  CHECK_VALID_WINDOW (window);
  w = XWINDOW (window);
669
  if (WINDOW_LEAF_P (w))
670 671
    error ("Combination limit is meaningful for internal windows only");
  wset_combination_limit (w, limit);
Paul Eggert's avatar
Paul Eggert committed
672
  return limit;
673
}
674

675
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
676
       doc: /* Return the use time of window WINDOW.
677
WINDOW must be a live window and defaults to the selected one.
678 679 680
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.  */)
681 682
  (Lisp_Object window)
{
683
  return make_number (decode_live_window (window)->use_time);
684
}
685

686
DEFUN ("window-pixel-width", Fwindow_pixel_width, Swindow_pixel_width, 0, 1, 0,
687
       doc: /* Return the width of window WINDOW in pixels.
688
WINDOW must be a valid window and defaults to the selected one.
689

690 691 692 693 694 695 696 697
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);
}
698

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

703 704 705
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.  */)
706
  (Lisp_Object window)
707
{
708
  return make_number (decode_valid_window (window)->pixel_height);
709 710
}

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

715 716 717
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.
718

719 720 721 722 723 724 725 726 727 728 729 730 731
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)
732
{
733 734 735 736 737 738 739 740 741 742 743 744
  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));
    }
745
}
746

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

751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
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)
769
{
770 771 772 773 774 775 776 777 778 779 780 781
  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));
    }
782
}
783

784
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
785
       doc: /* Return the new total size of window WINDOW.
786 787
WINDOW must be a valid window and defaults to the selected one.

788 789 790 791
The new total size of WINDOW is the value set by the last call of
`set-window-new-total' for WINDOW.  If it is valid, it will be shortly
installed as WINDOW's total height (see `window-total-height') or total
width (see `window-total-width').  */)
792 793
  (Lisp_Object window)
{
794
  return decode_valid_window (window)->new_total;
795 796 797
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
798
       doc: /* Return the normal height of window WINDOW.
799
WINDOW must be a valid window and defaults to the selected one.
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
If HORIZONTAL is non-nil, return the normal width of WINDOW.

The normal height of a frame's root window or a window that is
horizontally combined (a window that has a left or right sibling) is
1.0.  The normal height of a window that is vertically combined (has a
sibling above or below) is the fraction of the window's height with
respect to its parent.  The sum of the normal heights of all windows in a
vertical combination equals 1.0.

Similarly, the normal width of a frame's root window or a window that is
vertically combined equals 1.0.  The normal width of a window that is
horizontally combined is the fraction of the window's width with respect
to its parent.  The sum of the normal widths of all windows in a
horizontal combination equals 1.0.

The normal sizes of windows are used to restore the proportional sizes
of windows after they have been shrunk to their minimum sizes; for
example when a frame is temporarily made very small and afterwards gets
re-enlarged to its previous size.  */)
819 820
  (Lisp_Object window, Lisp_Object horizontal)
{
821
  struct window *w = decode_valid_window (window);
822 823

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
824 825 826
}

DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
827
       doc: /* Return new normal size of window WINDOW.
828 829
WINDOW must be a valid window and defaults to the selected one.

830 831 832
The new normal size of WINDOW is the value set by the last call of
`set-window-new-normal' for WINDOW.  If valid, it will be shortly
installed as WINDOW's normal size (see `window-normal-size').  */)
833 834
  (Lisp_Object window)
{
835
  return decode_valid_window (window)->new_normal;
836 837
}

838 839
DEFUN ("window-new-pixel", Fwindow_new_pixel, Swindow_new_pixel, 0, 1, 0,
       doc: /* Return new pixel size of window WINDOW.
840 841 842
WINDOW must be a valid window and defaults to the selected one.

The new pixel size of WINDOW is the value set by the last call of
843 844 845
`set-window-new-pixel' for WINDOW.  If it is valid, it will be shortly
installed as WINDOW's pixel height (see `window-pixel-height') or pixel
width (see `window-pixel-width').  */)
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
  (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);
}

867
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
868
       doc: /* Return left column of window WINDOW.
869 870 871 872
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.

873
WINDOW must be a valid window and defaults to the selected one.  */)
874 875
  (Lisp_Object window)
{
876
  return make_number (decode_valid_window (window)->left_col);
877 878 879
}

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
880
       doc: /* Return top line of window WINDOW.
881 882 883 884
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.

885
WINDOW must be a valid window and defaults to the selected one.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
886
  (Lisp_Object window)
887
{
888
  return make_number (decode_valid_window (window)->top_line);
889 890
}

891 892 893
/* 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. */
894
static int
895
window_body_height (struct window *w, bool pixelwise)
896
{
897
  int height = (w->pixel_height
898
		- WINDOW_HEADER_LINE_HEIGHT (w)
899 900 901
		- (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w)
		   ? WINDOW_SCROLL_BAR_AREA_HEIGHT (w)
		   : 0)
902 903
		- WINDOW_MODE_LINE_HEIGHT (w)
		- WINDOW_BOTTOM_DIVIDER_WIDTH (w));
904

Martin Rudalics's avatar
Martin Rudalics committed
905 906 907 908 909
  /* Don't return a negative value.  */
  return max (pixelwise
	      ? height
	      : height / FRAME_LINE_HEIGHT (WINDOW_XFRAME (w)),
	      0);
910 911
}

912 913 914 915 916
/* 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.  */
917
int
918
window_body_width (struct window *w, bool pixelwise)
919 920 921
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));

922 923 924 925
  int width = (w->pixel_width
	       - WINDOW_RIGHT_DIVIDER_WIDTH (w)
	       - (WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
		  ? WINDOW_SCROLL_BAR_AREA_WIDTH (w)
Paul Eggert's avatar
Paul Eggert committed
926 927 928 929
		  : (/* A vertical bar is either 1 or 0.  */
		     !FRAME_WINDOW_P (f)
		     && !WINDOW_RIGHTMOST_P (w)
		     && !WINDOW_RIGHT_DIVIDER_WIDTH (w)))
930 931 932 933 934
		- WINDOW_MARGINS_WIDTH (w)
		- (FRAME_WINDOW_P (f)
		   ? WINDOW_FRINGES_WIDTH (w)
		   : 0));

Martin Rudalics's avatar
Martin Rudalics committed
935 936 937 938 939
  /* Don't return a negative value.  */
  return max (pixelwise
	      ? width
	      : width / FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w)),
	      0);
940 941 942
}

DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 2, 0,
943 944 945 946 947 948 949 950 951 952
       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.  */)
953 954 955
  (Lisp_Object window, Lisp_Object pixelwise)
{
  return make_number (window_body_height (decode_live_window (window),
Paul Eggert's avatar
Paul Eggert committed
956
					  !NILP (pixelwise)));
957 958
}

959
DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 2, 0,
960 961 962 963 964 965 966 967 968
       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
969 970 971 972
visible, that column is not counted.

Note that the returned value includes the column reserved for the
continuation glyph.  */)
973 974 975
  (Lisp_Object window, Lisp_Object pixelwise)
{
  return make_number (window_body_width (decode_live_window (window),
Paul Eggert's avatar
Paul Eggert committed
976
					 !NILP (pixelwise)));
977 978 979 980
}

DEFUN ("window-mode-line-height", Fwindow_mode_line_height,
       Swindow_mode_line_height, 0, 1, 0,