window.c 275 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
Daniel Colascione's avatar
Daniel Colascione committed
45
#include "pdumper.h"
46

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

81 82 83
/* The value of selected_window at the last time window change
   functions were run.  This is always the same as
   FRAME_OLD_SELECTED_WINDOW (old_selected_frame).  */
84
static Lisp_Object old_selected_window;
85

Gerd Moellmann's avatar
Gerd Moellmann committed
86 87 88 89 90
/* 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;

91 92 93
/* 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
94 95 96
   the selected window.  */
Lisp_Object minibuf_window;

97 98
/* Non-nil means it is the window whose mode line should be
   shown as the selected window when the minibuffer is selected.  */
99
Lisp_Object minibuf_selected_window;
100

101
/* Incremented for each window created.  */
102
static EMACS_INT sequence_number;
103

104
/* Used by the function window_scroll_pixel_based.  */
105
static int window_scroll_pixel_based_preserve_x;
106
static int window_scroll_pixel_based_preserve_y;
107

108
/* Same for window_scroll_line_based.  */
109 110
static EMACS_INT window_scroll_preserve_hpos;
static EMACS_INT window_scroll_preserve_vpos;
111

112 113 114 115 116 117
static void
CHECK_WINDOW_CONFIGURATION (Lisp_Object x)
{
  CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x);
}

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

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

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

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

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

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

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

161
static void
Paul Eggert's avatar
Paul Eggert committed
162 163 164 165
wset_parent (struct window *w, Lisp_Object val)
{
  w->parent = val;
}
166

167
static void
Paul Eggert's avatar
Paul Eggert committed
168 169 170 171
wset_pointm (struct window *w, Lisp_Object val)
{
  w->pointm = val;
}
172 173 174 175 176 177 178

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

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

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

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

197
static void
Paul Eggert's avatar
Paul Eggert committed
198 199 200 201
wset_window_parameters (struct window *w, Lisp_Object val)
{
  w->window_parameters = val;
}
202

203 204 205 206 207 208 209 210 211 212 213 214
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
215

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

241 242
struct window *
decode_live_window (register Lisp_Object window)
243 244 245
{
  if (NILP (window))
    return XWINDOW (selected_window);
246

247 248 249 250
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

251
struct window *
252 253
decode_any_window (register Lisp_Object window)
{
254 255
  struct window *w;

256 257 258 259
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
260 261
  w = XWINDOW (window);
  return w;
262
}
263

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

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

/* 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);
305 306 307 308 309
  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
310 311 312
  adjust_window_count (w, 1);
}

313 314 315 316 317 318
static void
wset_old_buffer (struct window *w, Lisp_Object val)
{
  w->old_buffer = val;
}

Jim Blandy's avatar
Jim Blandy committed
319
DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
320
       doc: /* Return t if OBJECT is a window and nil otherwise.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
321
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
322
{
323
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
324 325
}

326 327 328
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
329
window.  Windows that have been deleted are not valid.  */)
330 331 332 333 334
  (Lisp_Object object)
{
  return WINDOW_VALID_P (object) ? Qt : Qnil;
}

335
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
336
       doc: /* Return t if OBJECT is a live window and nil otherwise.
337 338
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
339
  (Lisp_Object object)
340
{
341
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
342
}
343 344

/* Frames and windows.  */
345
DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 0, 1, 0,
346
       doc: /* Return the frame that window WINDOW is on.
347
WINDOW must be a valid window and defaults to the selected one.  */)
348
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
349
{
350
  return decode_valid_window (window)->frame;
Jim Blandy's avatar
Jim Blandy committed
351 352
}

353
DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
354 355
       doc: /* Return the root window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
356 357
With a frame argument, return that frame's root window.
With a window argument, return the root window of that window's frame.  */)
358
  (Lisp_Object frame_or_window)
Jim Blandy's avatar
Jim Blandy committed
359
{
360 361 362
  Lisp_Object window;

  if (NILP (frame_or_window))
363
    window = SELECTED_FRAME ()->root_window;
364 365
  else if (WINDOW_VALID_P (frame_or_window))
      window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
366 367 368
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
369
      window = XFRAME (frame_or_window)->root_window;
370 371 372
    }

  return window;
Jim Blandy's avatar
Jim Blandy committed
373 374
}

375
DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
376 377
       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
378
  (Lisp_Object frame)
Jim Blandy's avatar
Jim Blandy committed
379
{
380
  return FRAME_MINIBUF_WINDOW (decode_live_frame (frame));
Jim Blandy's avatar
Jim Blandy committed
381 382
}

383 384
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
       Swindow_minibuffer_p, 0, 1, 0,
385
       doc: /* Return non-nil if WINDOW is a minibuffer window.
386
WINDOW must be a valid window and defaults to the selected one.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
387
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
388
{
389
  return MINI_WINDOW_P (decode_valid_window (window)) ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
390 391
}

392 393
/* 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,
394 395
       doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
396 397
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
398 399
the first window of that frame.  */)
  (Lisp_Object frame_or_window)
Jim Blandy's avatar
Jim Blandy committed
400
{
401
  Lisp_Object window;
Jim Blandy's avatar
Jim Blandy committed
402

403
  if (NILP (frame_or_window))
404
    window = SELECTED_FRAME ()->root_window;
405
  else if (WINDOW_VALID_P (frame_or_window))
406
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
407 408 409
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
410
      window = XFRAME (frame_or_window)->root_window;
411
    }
Miles Bader's avatar
Miles Bader committed
412

413 414
  while (WINDOWP (XWINDOW (window)->contents))
    window = XWINDOW (window)->contents;
Jim Blandy's avatar
Jim Blandy committed
415

416 417
  return window;
}
418

419 420
DEFUN ("frame-selected-window", Fframe_selected_window,
       Sframe_selected_window, 0, 1, 0,
421 422
       doc: /* Return the selected window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
423 424 425
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.  */)
426 427 428 429 430
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
431
    window = SELECTED_FRAME ()->selected_window;
432
  else if (WINDOW_VALID_P (frame_or_window))
433
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
434
  else
435
    {
436
      CHECK_LIVE_FRAME (frame_or_window);
437
      window = XFRAME (frame_or_window)->selected_window;
438 439
    }

440
  return window;
Jim Blandy's avatar
Jim Blandy committed
441
}
442

443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
DEFUN ("frame-old-selected-window", Fframe_old_selected_window,
       Sframe_old_selected_window, 0, 1, 0,
       doc: /* Return old selected window of FRAME.
FRAME must be a live frame and defaults to the selected one.

The return value is the window selected on FRAME the last time window
change functions were run for FRAME.  */)
  (Lisp_Object frame)
{
  if (NILP (frame))
    frame = selected_frame;
  CHECK_LIVE_FRAME (frame);

  return XFRAME (frame)->old_selected_window;
}

459 460 461 462 463 464 465 466 467 468 469 470
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;
471

472 473
  CHECK_LIVE_FRAME (frame);
  CHECK_LIVE_WINDOW (window);
474

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

478 479 480
  if (EQ (frame, selected_frame))
    return Fselect_window (window, norecord);
  else
481 482 483 484
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
485 486 487 488 489 490 491
}

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)
492
{
493 494
  return selected_window;
}
495

496 497 498 499 500 501 502 503 504 505
DEFUN ("old-selected-window", Fold_selected_window,
       Sold_selected_window, 0, 0, 0,
       doc: /* Return the old selected window.
The return value is the window selected the last time window change
functions were run.  */)
  (void)
{
  return old_selected_window;
}

506
EMACS_INT window_select_count;
507

Paul Eggert's avatar
Paul Eggert committed
508
/* If select_window is called with inhibit_point_swap true it will
509 510 511 512 513
   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
514 515
select_window (Lisp_Object window, Lisp_Object norecord,
	       bool inhibit_point_swap)
516
{
Paul Eggert's avatar
Paul Eggert committed
517
  struct window *w;
518
  struct frame *sf;
519

520
  CHECK_LIVE_WINDOW (window);
521

522
  w = XWINDOW (window);
523

524
  /* Make the selected window's buffer current.  */
525
  Fset_buffer (w->contents);
526

527
  if (EQ (window, selected_window) && !inhibit_point_swap)
528 529 530 531
    /* `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;
532

533
  if (NILP (norecord) || EQ (norecord, Qmark_for_redisplay))
534 535 536 537 538
    { /* Mark the window for redisplay since the selected-window has
	 a different mode-line.  */
      wset_redisplay (XWINDOW (selected_window));
      wset_redisplay (w);
    }
539 540
  else
    redisplay_other_windows ();
541

542 543
  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
544
    {
545
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
546 547 548 549 550 551 552 553
      /* 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;
554
    }
555
  else
556
    fset_selected_window (sf, window);
557

558
  select_window_1 (window, inhibit_point_swap);
559
  bset_last_selected_window (XBUFFER (w->contents), window);
560

561
 record_and_return:
Paul Eggert's avatar
Paul Eggert committed
562 563 564 565
  /* 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).  */
566 567 568 569 570 571
  if (NILP (norecord))
    {
      w->use_time = ++window_select_count;
      record_buffer (w->contents);
    }

572 573 574 575
  return window;
}

/* Select window with a minimum of fuss, i.e. don't record the change anywhere
Paul Eggert's avatar
Paul Eggert committed
576
   (not even for redisplay's benefit), and assume that the window's frame is
577
   already selected.  */
578
static void
579 580
select_window_1 (Lisp_Object window, bool inhibit_point_swap)
{
581 582 583
  /* 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.  */
584
  if (!inhibit_point_swap)
585
    {
586
      struct window *ow = XWINDOW (selected_window);
587 588 589 590
      if (BUFFERP (ow->contents))
	set_marker_both (ow->pointm, ow->contents,
			 BUF_PT (XBUFFER (ow->contents)),
			 BUF_PT_BYTE (XBUFFER (ow->contents)));
591
    }
592

593
  selected_window = window;
594

595 596 597 598 599
  /* 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
600
  set_point_from_marker (XWINDOW (window)->pointm);
601 602
}

603
DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
604 605
       doc: /* Select WINDOW which must be a live window.
Also make WINDOW's frame the selected frame and WINDOW that frame's
606
selected window.  In addition, make WINDOW's buffer current and set its
607 608
buffer's value of `point' to the value of WINDOW's `window-point'.
Return WINDOW.
609 610 611

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

615 616 617 618 619 620 621 622 623 624 625
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
626
  (Lisp_Object window, Lisp_Object norecord)
627
{
Paul Eggert's avatar
Paul Eggert committed
628
  return select_window (window, norecord, false);
629
}
Jim Blandy's avatar
Jim Blandy committed
630

631
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
632 633 634
       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.  */)
635 636
  (Lisp_Object window)
{
637
  struct window *w = decode_any_window (window);
638

639
  return WINDOW_LEAF_P (w) ? w->contents : Qnil;
Jim Blandy's avatar
Jim Blandy committed
640 641
}

642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
DEFUN ("window-old-buffer", Fwindow_old_buffer, Swindow_old_buffer, 0, 1, 0,
       doc: /* Return the old buffer displayed by WINDOW.
WINDOW must be a live window and defaults to the selected one.

The return value is the buffer shown in WINDOW at the last time window
change functions were run.  It is nil if WINDOW was created after
that.  It is t if WINDOW has been restored from a window configuration
after that.  */)
  (Lisp_Object window)
{
  struct window *w = decode_live_window (window);

  return (NILP (w->old_buffer)
	  /* A new window.  */
	  ? Qnil
	  : (w->change_stamp != WINDOW_XFRAME (w)->change_stamp)
	  /* A window restored from a configuration.  */
	  ? Qt
	  /* A window that was live the last time seen by window
	     change functions.  */
	  : w->old_buffer);
}

665
DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
666
       doc: /* Return the parent window of window WINDOW.
667
WINDOW must be a valid window and defaults to the selected one.
668
Return nil for a window with no parent (e.g. a root window).  */)
669
  (Lisp_Object window)
Kenichi Handa's avatar
Kenichi Handa committed
670
{
671
  return decode_valid_window (window)->parent;
672
}
Kenichi Handa's avatar
Kenichi Handa committed
673

674
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
675
       doc: /* Return the topmost child window of window WINDOW.
676
WINDOW must be a valid window and defaults to the selected one.
677 678 679
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.  */)
680 681
  (Lisp_Object window)
{
682 683
  struct window *w = decode_valid_window (window);
  return WINDOW_VERTICAL_COMBINATION_P (w) ? w->contents : Qnil;
Kenichi Handa's avatar
Kenichi Handa committed
684 685
}

686
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
687
       doc: /* Return the leftmost child window of window WINDOW.
688
WINDOW must be a valid window and defaults to the selected one.
689 690 691
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
692
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
693
{
694 695
  struct window *w = decode_valid_window (window);
  return WINDOW_HORIZONTAL_COMBINATION_P (w) ? w->contents : Qnil;
Jim Blandy's avatar
Jim Blandy committed
696 697
}

698
DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
699
       doc: /* Return the next sibling window of window WINDOW.
700
WINDOW must be a valid window and defaults to the selected one.
701
Return nil if WINDOW has no next sibling.  */)
702 703
  (Lisp_Object window)
{
704
  return decode_valid_window (window)->next;
705
}
706

707
DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
708
       doc: /* Return the previous sibling window of window WINDOW.
709
WINDOW must be a valid window and defaults to the selected one.
710
Return nil if WINDOW has no previous sibling.  */)
711 712
  (Lisp_Object window)
{
713
  return decode_valid_window (window)->prev;
714
}
Gerd Moellmann's avatar
Gerd Moellmann committed
715

716
DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
717
       doc: /* Return combination limit of window WINDOW.
718
WINDOW must be a valid window used in horizontal or vertical combination.
719
If the return value is nil, child windows of WINDOW can be recombined with
720
WINDOW's siblings.  A return value of t means that child windows of
721
WINDOW are never (re-)combined with WINDOW's siblings.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
722
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
723
{
724 725
  struct window *w;

726
  CHECK_VALID_WINDOW (window);
727
  w = XWINDOW (window);
728
  if (WINDOW_LEAF_P (w))
729
    error ("Combination limit is meaningful for internal windows only");
730
  return w->combination_limit;
Jim Blandy's avatar
Jim Blandy committed
731 732
}

733
DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
734
       doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
735
WINDOW must be a valid window used in horizontal or vertical combination.
736 737
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
738
\(re-)combined with WINDOW's siblings.  Other values are reserved for
739
future use.  */)
740
  (Lisp_Object window, Lisp_Object limit)
741
{
742 743 744 745
  struct window *w;

  CHECK_VALID_WINDOW (window);
  w = XWINDOW (window);
746
  if (WINDOW_LEAF_P (w))
747 748
    error ("Combination limit is meaningful for internal windows only");
  wset_combination_limit (w, limit);
Paul Eggert's avatar
Paul Eggert committed
749
  return limit;
750
}
751

752
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
753
       doc: /* Return the use time of window WINDOW.
754
WINDOW must be a live window and defaults to the selected one.
755 756 757
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.  */)
758 759
  (Lisp_Object window)
{
760
  return make_fixnum (decode_live_window (window)->use_time);
761
}
762

763
DEFUN ("window-pixel-width", Fwindow_pixel_width, Swindow_pixel_width, 0, 1, 0,
764
       doc: /* Return the width of window WINDOW in pixels.
765
WINDOW must be a valid window and defaults to the selected one.
766

767 768 769 770 771 772
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)
{
773
  return make_fixnum (decode_valid_window (window)->pixel_width);
774
}
775

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

780 781 782
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.  */)
783
  (Lisp_Object window)
784
{
785
  return make_fixnum (decode_valid_window (window)->pixel_height);
786 787
}

788 789 790
DEFUN ("window-old-pixel-width", Fwindow_old_pixel_width,
       Swindow_old_pixel_width, 0, 1, 0,
       doc: /* Return old total pixel width of WINDOW.
791 792
WINDOW must be a valid window and defaults to the selected one.

793 794 795
The return value is the total pixel width of WINDOW after the last
time window change functions found WINDOW live on its frame.  It is
zero if WINDOW was created after that.  */)
796 797
  (Lisp_Object window)
{
798
  return (make_fixnum
799
	  (decode_valid_window (window)->old_pixel_width));
800 801
}

802 803 804
DEFUN ("window-old-pixel-height", Fwindow_old_pixel_height,
       Swindow_old_pixel_height, 0, 1, 0,
       doc: /* Return old total pixel height of WINDOW.
805 806
WINDOW must be a valid window and defaults to the selected one.

807 808 809
The return value is the total pixel height of WINDOW after the last
time window change functions found WINDOW live on its frame.  It is
zero if WINDOW was created after that.  */)
810 811
  (Lisp_Object window)
{
812
  return (make_fixnum
813
	  (decode_valid_window (window)->old_pixel_height));
814 815
}

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

820 821 822
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.
823

824 825 826 827 828 829 830 831 832 833 834 835 836
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)
837
{
838 839 840
  struct window *w = decode_valid_window (window);

  if (! EQ (round, Qfloor) && ! EQ (round, Qceiling))
841
    return make_fixnum (w->total_lines);
842 843 844 845
  else
    {
      int unit = FRAME_LINE_HEIGHT (WINDOW_XFRAME (w));

846
      return make_fixnum (EQ (round, Qceiling)
847 848 849
			  ? ((w->pixel_height + unit - 1) /unit)
			  : (w->pixel_height / unit));
    }
850
}
851

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

856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
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)
874
{
875 876 877
  struct window *w = decode_valid_window (window);

  if (! EQ (round, Qfloor) && ! EQ (round, Qceiling))
878
    return make_fixnum (w->total_cols);
879 880 881 882
  else
    {
      int unit = FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w));

883
      return make_fixnum (EQ (round, Qceiling)
884 885 886
			  ? ((w->pixel_width + unit - 1) /unit)
			  : (w->pixel_width / unit));
    }
887
}
888

889
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
890
       doc: /* Return the new total size of window WINDOW.
891 892
WINDOW must be a valid window and defaults to the selected one.

893 894 895 896
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').  */)
Martin Rudalics's avatar