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

This file is part of GNU Emacs.

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

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

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

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

23 24
#include <stdio.h>

Jim Blandy's avatar
Jim Blandy committed
25 26
#include "lisp.h"
#include "buffer.h"
27
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
28
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
29
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
30 31 32 33 34
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
35
#include "dispextern.h"
36
#include "blockinput.h"
37
#include "termhooks.h"		/* For FRAME_TERMINAL.  */
Paul Eggert's avatar
Paul Eggert committed
38
#include "xwidget.h"
Joakim Verona's avatar
Joakim Verona committed
39 40 41
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
42 43 44
#ifdef MSDOS
#include "msdos.h"
#endif
45

46 47 48
static ptrdiff_t count_windows (struct window *);
static ptrdiff_t get_leaf_windows (struct window *, struct window **,
				   ptrdiff_t);
Paul Eggert's avatar
Paul Eggert committed
49 50
static void window_scroll_pixel_based (Lisp_Object, int, bool, bool);
static void window_scroll_line_based (Lisp_Object, int, bool, bool);
Andreas Schwab's avatar
Andreas Schwab committed
51
static void foreach_window (struct frame *,
Paul Eggert's avatar
Paul Eggert committed
52
			    bool (* fn) (struct window *, void *),
Andreas Schwab's avatar
Andreas Schwab committed
53
                            void *);
Paul Eggert's avatar
Paul Eggert committed
54 55 56 57
static bool foreach_window_1 (struct window *,
			      bool (* fn) (struct window *, void *),
			      void *);
static bool window_resize_check (struct window *, bool);
58
static void window_resize_apply (struct window *, bool);
59
static void select_window_1 (Lisp_Object, bool);
60
static void run_window_configuration_change_hook (struct frame *);
61

62 63 64 65 66
static struct window *set_window_fringes (struct window *, Lisp_Object,
					  Lisp_Object, Lisp_Object);
static struct window *set_window_margins (struct window *, Lisp_Object,
					  Lisp_Object);
static struct window *set_window_scroll_bars (struct window *, Lisp_Object,
Paul Eggert's avatar
Paul Eggert committed
67 68
					      Lisp_Object, Lisp_Object,
					      Lisp_Object);
69 70
static void apply_window_adjustment (struct window *);

Jim Blandy's avatar
Jim Blandy committed
71 72 73 74 75 76
/* This is the window in which the terminal's cursor should
   be left when nothing is being done with it.  This must
   always be a leaf window, and its buffer is selected by
   the top level editing loop at the end of each command.

   This value is always the same as
Jim Blandy's avatar
Jim Blandy committed
77
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
78 79
Lisp_Object selected_window;

80 81 82 83 84
/* 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).  */
Lisp_Object old_selected_window;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

415 416
  return window;
}
417

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

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

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

442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
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;
}

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

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

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

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

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

495 496 497 498 499 500 501 502 503 504
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;
}

505
EMACS_INT window_select_count;
506

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

519
  CHECK_LIVE_WINDOW (window);
520

521
  w = XWINDOW (window);
522

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

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

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

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

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

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

571 572 573 574
  return window;
}

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

592
  selected_window = window;
593

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

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

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

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

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

641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
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);
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

792 793 794
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.  */)
795 796
  (Lisp_Object window)
{
797
  return (make_fixnum
798
	  (decode_valid_window (window)->old_pixel_width));
799 800
}

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

806 807 808
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.  */)
809 810
  (Lisp_Object window)
{
811
  return (make_fixnum
812
	  (decode_valid_window (window)->old_pixel_height));
813 814
}

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

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

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

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

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

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

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

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

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

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

892 893 894 895
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').  */)
896 897
  (Lisp_Object window)
{
898
  return decode_valid_window (window)->new_total;
899 900 901
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
902
       doc: /* Return the normal height of window WINDOW.
903
WINDOW must be a valid window and defaults to the selected one.
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
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.  */)
923 924
  (Lisp_Object window, Lisp_Object horizontal)
{
925
  struct window *w = decode_valid_window (window);
926 927

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
928 929 930
}

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

934 935 936
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').  */)
937 938
  (Lisp_Object window)
{
939
  return decode_valid_window (window)->new_normal;
940 941
}

942 943
DEFUN ("window-new-pixel", Fwindow_new_pixel, Swindow_new_pixel, 0, 1, 0,
       doc: /* Return new pixel size of window WINDOW.
944 945 946
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
947 948 949
`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').  */)
950 951 952 953 954 955 956 957 958 959
  (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)
{
960
  return make_fixnum (decode_valid_window (window)->pixel_left);
961 962 963 964 965 966 967
}

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)
{
968
  return make_fixnum (decode_valid_window (window)->pixel_top);
969 970
}

971
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
972
       doc: /* Return left column of window WINDOW.
973 974 975 976
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.

977
WINDOW must be a valid window and defaults to the selected one.  */)
978 979
  (Lisp_Object window)
{