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.
Paul Eggert's avatar
Paul Eggert committed
3
   Copyright (C) 1985-1987, 1993-1998, 2000-2016 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 26
#include "lisp.h"
#include "buffer.h"
27
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
28
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
29
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
30 31 32 33 34
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
35
#include "dispextern.h"
36
#include "blockinput.h"
37
#include "termhooks.h"		/* For FRAME_TERMINAL.  */
Paul Eggert's avatar
Paul Eggert committed
38
#include "xwidget.h"
Joakim Verona's avatar
Joakim Verona committed
39 40 41
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
42 43 44
#ifdef MSDOS
#include "msdos.h"
#endif
45

46 47 48
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
49 50
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
51
static void foreach_window (struct frame *,
Paul Eggert's avatar
Paul Eggert committed
52
			    bool (* fn) (struct window *, void *),
Andreas Schwab's avatar
Andreas Schwab committed
53
                            void *);
Paul Eggert's avatar
Paul Eggert committed
54 55 56 57
static bool foreach_window_1 (struct window *,
			      bool (* fn) (struct window *, void *),
			      void *);
static bool window_resize_check (struct window *, bool);
58
static void window_resize_apply (struct window *, bool);
59
static void select_window_1 (Lisp_Object, bool);
60

61 62 63 64 65
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
66 67
					      Lisp_Object, Lisp_Object,
					      Lisp_Object);
68 69
static void apply_window_adjustment (struct window *);

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

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

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

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

94
/* Incremented for each window created.  */
95
static EMACS_INT sequence_number;
96

97
/* Used by the function window_scroll_pixel_based.  */
98
static int window_scroll_pixel_based_preserve_x;
99
static int window_scroll_pixel_based_preserve_y;
100

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

209 210 211 212 213
static void
wset_update_mode_line (struct window *w)
{
  /* If this window is the selected window on its frame, set the
     global variable update_mode_lines, so that x_consider_frame_title
Paul Eggert's avatar
Paul Eggert committed
214
     will consider this frame's title for redisplay.  */
215 216 217 218 219 220 221 222
  Lisp_Object fselected_window = XFRAME (WINDOW_FRAME (w))->selected_window;

  if (WINDOWP (fselected_window) && XWINDOW (fselected_window) == w)
    update_mode_lines = 42;
  else
    w->update_mode_line = true;
}

Paul Eggert's avatar
Paul Eggert committed
223
/* True if leaf window W doesn't reflect the actual state
224 225 226 227 228 229 230 231 232 233
   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));
}

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

240 241 242 243
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

244
struct window *
245 246
decode_any_window (register Lisp_Object window)
{
247 248
  struct window *w;

249 250 251 252
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
253 254
  w = XWINDOW (window);
  return w;
255
}
256

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

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

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

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

313 314 315
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
316
window.  Windows that have been deleted are not valid.  */)
317 318 319 320 321
  (Lisp_Object object)
{
  return WINDOW_VALID_P (object) ? Qt : Qnil;
}

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

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

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

  return window;
Jim Blandy's avatar
Jim Blandy committed
360 361
}

362
DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
363 364
       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
365
  (Lisp_Object frame)
Jim Blandy's avatar
Jim Blandy committed
366
{
367
  return FRAME_MINIBUF_WINDOW (decode_live_frame (frame));
Jim Blandy's avatar
Jim Blandy committed
368 369
}

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

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

390
  if (NILP (frame_or_window))
391
    window = SELECTED_FRAME ()->root_window;
392
  else if (WINDOW_VALID_P (frame_or_window))
393
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
394 395 396
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
397
      window = XFRAME (frame_or_window)->root_window;
398
    }
Miles Bader's avatar
Miles Bader committed
399

400 401
  while (WINDOWP (XWINDOW (window)->contents))
    window = XWINDOW (window)->contents;
Jim Blandy's avatar
Jim Blandy committed
402

403 404
  return window;
}
405

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

  if (NILP (frame_or_window))
418
    window = SELECTED_FRAME ()->selected_window;
419
  else if (WINDOW_VALID_P (frame_or_window))
420
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
421
  else
422
    {
423
      CHECK_LIVE_FRAME (frame_or_window);
424
      window = XFRAME (frame_or_window)->selected_window;
425 426
    }

427
  return window;
Jim Blandy's avatar
Jim Blandy committed
428
}
429

430 431 432 433 434 435 436 437 438 439 440 441
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;
442

443 444
  CHECK_LIVE_FRAME (frame);
  CHECK_LIVE_WINDOW (window);
445

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

449 450 451
  if (EQ (frame, selected_frame))
    return Fselect_window (window, norecord);
  else
452 453 454 455
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
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)
463
{
464 465
  return selected_window;
}
466

467
EMACS_INT window_select_count;
468

Paul Eggert's avatar
Paul Eggert committed
469
/* If select_window is called with inhibit_point_swap true it will
470 471 472 473 474
   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
475 476
select_window (Lisp_Object window, Lisp_Object norecord,
	       bool inhibit_point_swap)
477
{
Paul Eggert's avatar
Paul Eggert committed
478
  struct window *w;
479
  struct frame *sf;
480

481
  CHECK_LIVE_WINDOW (window);
482

483
  w = XWINDOW (window);
484

485
  /* Make the selected window's buffer current.  */
486
  Fset_buffer (w->contents);
487

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

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

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

519
  select_window_1 (window, inhibit_point_swap);
520
  bset_last_selected_window (XBUFFER (w->contents), window);
521

522
 record_and_return:
523 524 525 526 527 528 529 530 531
  /* 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);
    }

532 533 534 535
  return window;
}

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

553
  selected_window = window;
554

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

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

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

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

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

609
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
610
       doc: /* Return the topmost 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
horizontal combination.  */)
615 616
  (Lisp_Object window)
{
617 618
  struct window *w = decode_valid_window (window);
  return WINDOW_VERTICAL_COMBINATION_P (w) ? w->contents : Qnil;
Kenichi Handa's avatar
Kenichi Handa committed
619 620
}

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

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

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

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

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

668
DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
669
       doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
670
WINDOW must be a valid window used in horizontal or vertical combination.
671 672
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
673
(re-)combined with WINDOW's siblings.  Other values are reserved for
674
future use.  */)
675
  (Lisp_Object window, Lisp_Object limit)
676
{
677 678 679 680
  struct window *w;

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

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

702 703 704 705 706 707 708 709
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);
}
710

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

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

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

727 728 729
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.
730

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

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

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

796
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
797
       doc: /* Return the new total size of window WINDOW.
798 799
WINDOW must be a valid window and defaults to the selected one.

800 801 802 803
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').  */)
804 805
  (Lisp_Object window)
{
806
  return decode_valid_window (window)->new_total;
807 808 809
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
810
       doc: /* Return the normal height of window WINDOW.
811
WINDOW must be a valid window and defaults to the selected one.
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
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.  */)
831 832
  (Lisp_Object window, Lisp_Object horizontal)
{
833
  struct window *w = decode_valid_window (window);
834 835

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
836 837 838
}

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

842 843 844
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').  */)
845 846
  (Lisp_Object window)
{
847
  return decode_valid_window (window)->new_normal;
848 849
}

850 851
DEFUN ("window-new-pixel", Fwindow_new_pixel, Swindow_new_pixel, 0, 1, 0,
       doc: /* Return new pixel size of window WINDOW.
852 853 854
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
855 856 857
`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').  */)
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
  (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);
}

879
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
880
       doc: /* Return left column of window WINDOW.
881 882 883 884
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.

885
WINDOW must be a valid window and defaults to the selected one.  */)
886 887
  (Lisp_Object window)
{
888
  return make_number (decode_valid_window (window)->left_col);
889 890 891
}

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
892
       doc: /* Return top line of window WINDOW.
893 894 895 896
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.

897
WINDOW must be a valid window and defaults to the selected one.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
898
  (Lisp_Object window)
899
{
900
  return make_number (decode_valid_window (window)->top_line);
901 902
}