window.c 240 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
/* Window creation, deletion and examination for GNU Emacs.
   Does not include redisplay.
Paul Eggert's avatar
Paul Eggert committed
3
   Copyright (C) 1985-1987, 1993-1998, 2000-2015 Free Software
4
   Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

21
#include <config.h>
Paul Eggert's avatar
Paul Eggert committed
22

23 24
#include <stdio.h>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

402 403
  return window;
}
404

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

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

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

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

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

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

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

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)
462
{
463 464
  return selected_window;
}
465

466
EMACS_INT window_select_count;
467

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

480
  CHECK_LIVE_WINDOW (window);
481

482
  w = XWINDOW (window);
483

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

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

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

502 503
  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
504
    {
505
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
506 507 508 509 510 511 512 513
      /* Use this rather than Fhandle_switch_frame
	 so that FRAME_FOCUS_FRAME is moved appropriately as we
	 move around in the state where a minibuffer in a separate
	 frame is active.  */
      Fselect_frame (WINDOW_FRAME (w), norecord);
      /* Fselect_frame called us back so we've done all the work already.  */
      eassert (EQ (window, selected_window));
      return window;
514
    }
515
  else
516
    fset_selected_window (sf, window);
517

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

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

531 532 533 534
  return window;
}

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

552
  selected_window = window;
553

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Note that the returned value includes the column reserved for the
continuation glyph.  */)
984 985 986
  (Lisp_Object window, Lisp_Object pixelwise)
{
  return make_number (window_body_width (decode_live_window (window),