window.c 258 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-2019 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 <https://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
static void run_window_configuration_change_hook (struct frame *);
61

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

210 211 212 213 214
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
215
     will consider this frame's title for redisplay.  */
216 217 218 219 220 221 222 223
  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
224
/* True if leaf window W doesn't reflect the actual state
225 226 227 228 229 230 231 232 233 234
   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));
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

404 405
  return window;
}
406

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

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

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

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

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

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

450 451 452
  if (EQ (frame, selected_frame))
    return Fselect_window (window, norecord);
  else
453 454 455 456
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
457 458 459 460 461 462 463
}

DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
       doc: /* Return the selected window.
The selected window is the window in which the standard cursor for
selected windows appears and to which many commands apply.  */)
  (void)
464
{
465 466
  return selected_window;
}
467

468
EMACS_INT window_select_count;
469

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

482
  CHECK_LIVE_WINDOW (window);
483

484
  w = XWINDOW (window);
485

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

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

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

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

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

523
 record_and_return:
Paul Eggert's avatar
Paul Eggert committed
524 525 526 527
  /* record_buffer can call maybe_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).  */
528 529 530 531 532 533
  if (NILP (norecord))
    {
      w->use_time = ++window_select_count;
      record_buffer (w->contents);
    }

534 535 536 537
  return window;
}

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

555
  selected_window = window;
556

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

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

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
574 575
selected one.  Also, do not mark WINDOW for redisplay unless NORECORD
equals the special symbol `mark-for-redisplay'.
576

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

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

612
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
613
       doc: /* Return the topmost child window of window WINDOW.
614
WINDOW must be a valid window and defaults to the selected one.
615 616 617
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.  */)
618 619
  (Lisp_Object window)
{
620 621
  struct window *w = decode_valid_window (window);
  return WINDOW_VERTICAL_COMBINATION_P (w) ? w->contents : Qnil;
Kenichi Handa's avatar
Kenichi Handa committed
622 623
}

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

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

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

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

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

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

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

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

705 706 707 708 709 710
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)
{
711
  return make_fixnum (decode_valid_window (window)->pixel_width);
712
}
713

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

718 719 720
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.  */)
721
  (Lisp_Object window)
722
{
723
  return make_fixnum (decode_valid_window (window)->pixel_height);
724 725
}

726 727
DEFUN ("window-pixel-width-before-size-change",
       Fwindow_pixel_width_before_size_change,
728 729 730 731 732 733 734 735 736
       Swindow_pixel_width_before_size_change, 0, 1, 0,
       doc: /* Return pixel width of window WINDOW before last size changes.
WINDOW must be a valid window and defaults to the selected one.

The return value is the pixel width of WINDOW at the last time
`window-size-change-functions' was run.  It's zero if WINDOW was made
after that.  */)
  (Lisp_Object window)
{
737
  return (make_fixnum
738 739 740
	  (decode_valid_window (window)->pixel_width_before_size_change));
}

741 742
DEFUN ("window-pixel-height-before-size-change",
       Fwindow_pixel_height_before_size_change,
743 744 745 746 747 748 749 750 751
       Swindow_pixel_height_before_size_change, 0, 1, 0,
       doc: /* Return pixel height of window WINDOW before last size changes.
WINDOW must be a valid window and defaults to the selected one.

The return value is the pixel height of WINDOW at the last time
`window-size-change-functions' was run.  It's zero if WINDOW was made
after that.  */)
  (Lisp_Object window)
{
752
  return (make_fixnum
753 754 755
	  (decode_valid_window (window)->pixel_height_before_size_change));
}

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

760 761 762
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.
763

764 765 766 767 768 769 770 771 772 773 774 775 776
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)
777
{
778 779 780
  struct window *w = decode_valid_window (window);

  if (! EQ (round, Qfloor) && ! EQ (round, Qceiling))
781
    return make_fixnum (w->total_lines);
782 783 784 785
  else
    {
      int unit = FRAME_LINE_HEIGHT (WINDOW_XFRAME (w));

786
      return make_fixnum (EQ (round, Qceiling)
787 788 789
			  ? ((w->pixel_height + unit - 1) /unit)
			  : (w->pixel_height / unit));
    }
790
}
791

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

796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
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)
814
{
815 816 817
  struct window *w = decode_valid_window (window);

  if (! EQ (round, Qfloor) && ! EQ (round, Qceiling))
818
    return make_fixnum (w->total_cols);
819 820 821 822
  else
    {
      int unit = FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w));

823
      return make_fixnum (EQ (round, Qceiling)
824 825 826
			  ? ((w->pixel_width + unit - 1) /unit)
			  : (w->pixel_width / unit));
    }
827
}
828

829
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
830
       doc: /* Return the new total size of window WINDOW.
831 832
WINDOW must be a valid window and defaults to the selected one.

833 834 835 836
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').  */)
837 838
  (Lisp_Object window)
{
839
  return decode_valid_window (window)->new_total;
840 841 842
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
843
       doc: /* Return the normal height of window WINDOW.
844
WINDOW must be a valid window and defaults to the selected one.
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
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.  */)
864 865
  (Lisp_Object window, Lisp_Object horizontal)
{
866
  struct window *w = decode_valid_window (window);
867 868

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
869 870 871
}

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

875 876 877
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').  */)
878 879
  (Lisp_Object window)
{
880
  return decode_valid_window (window)->new_normal;
881 882
}

883 884
DEFUN ("window-new-pixel", Fwindow_new_pixel, Swindow_new_pixel, 0, 1, 0,
       doc: /* Return new pixel size of window WINDOW.
885 886 887
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