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.  */
Joakim Verona's avatar
Joakim Verona committed
38 39 40
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
41 42 43
#ifdef MSDOS
#include "msdos.h"
#endif
44 45 46
#ifdef HAVE_XWIDGETS
# include "xwidget.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

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

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

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

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

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

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

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

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

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

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

315 316 317
DEFUN ("window-valid-p", Fwindow_valid_p, Swindow_valid_p, 1, 1, 0,
       doc: /* Return t if OBJECT is a valid window and nil otherwise.
A valid window is either a window that displays a buffer or an internal
318
window.  Windows that have been deleted are not valid.  */)
319 320 321 322 323
  (Lisp_Object object)
{
  return WINDOW_VALID_P (object) ? Qt : Qnil;
}

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

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

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

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

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

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

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

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

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

405 406
  return window;
}
407

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

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

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

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

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

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

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

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

469
EMACS_INT window_select_count;
470

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

483
  CHECK_LIVE_WINDOW (window);
484

485
  w = XWINDOW (window);
486

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

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

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

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

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

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

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 574

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

729 730 731
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.
732

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

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

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

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

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

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

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
838 839 840
}

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

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

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

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

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

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

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

905 906 907
/* 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. */
908
static int
909
window_body_height (struct window *w, bool pixelwise)
910
{
911
  int height = (w->pixel_height
912
		- WINDOW_HEADER_LINE_HEIGHT (w)
913 914 915
		- (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w)
		   ? WINDOW_SCROLL_BAR_AREA_HEIGHT (w)
		   : 0)
916 917
		- WINDOW_MODE_LINE_HEIGHT (w)
		- WINDOW_BOTTOM_DIVIDER_WIDTH (w));
918

Martin Rudalics's avatar
Martin Rudalics committed
919 920 921 922 923
  /* Don't return a negative value.  */
  return max (pixelwise
	      ? height
	      : height / FRAME_LINE_HEIGHT (WINDOW_XFRAME (w)),
	      0);
924 925
}

926 927 928 929 930
/* 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.  */
931
int
932
window_body_width (struct window *w, bool pixelwise)
933 934 935
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));

936 937 938 939
  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
940 941 942 943
		  : (/* A vertical bar is either 1 or 0.  */
		     !FRAME_WINDOW_P (f)
		     && !WINDOW_RIGHTMOST_P (w)
		     && !WINDOW_RIGHT_DIVIDER_WIDTH (w)))
944 945 946 947 948
		- WINDOW_MARGINS_WIDTH (w)
		- (FRAME_WINDOW_P (f)
		   ? WINDOW_FRINGES_WIDTH (w)
		   : 0));

Martin Rudalics's avatar
Martin Rudalics committed
949 950 951 952 953
  /* Don't return a negative value.  */
  return max (pixelwise
	      ? width
	      : width / FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w)),
	      0);
954 955 956
}

DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 2, 0,
957 958 959 960 961 962 963 964 965 966
       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.  */)
967 968 969
  (Lisp_Object window, Lisp_Object pixelwise)
{
  return make_number (window_body_height (decode_live_window (window),
Paul Eggert's avatar
Paul Eggert committed
970
					  !NILP (pixelwise)));
971 972
}

973
DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 2, 0,
974 975 976 977 978 979 980 981 982
       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
983 984 985 986
visible, that column is not counted.

Note that the returned value includes the column reserved for the
continuation glyph.  */)
Martin Rudalics's avatar