window.c 277 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

Jim Blandy's avatar
Jim Blandy committed
23 24
#include "lisp.h"
#include "buffer.h"
25
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
26
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
28 29 30 31 32
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
33
#include "dispextern.h"
34
#include "blockinput.h"
35
#include "termhooks.h"		/* For FRAME_TERMINAL.  */
Paul Eggert's avatar
Paul Eggert committed
36
#include "xwidget.h"
Joakim Verona's avatar
Joakim Verona committed
37 38 39
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
40 41 42
#ifdef MSDOS
#include "msdos.h"
#endif
Daniel Colascione's avatar
Daniel Colascione committed
43
#include "pdumper.h"
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
static void run_window_configuration_change_hook (struct frame *);
60

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

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

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

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

89 90 91
/* True mean window_change_record has to record all live frames.  */
static bool window_change_record_frames;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

204 205 206 207 208 209 210 211 212 213 214 215
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
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
221
     global variable update_mode_lines, so that gui_consider_frame_title
Paul Eggert's avatar
Paul Eggert committed
222
     will consider this frame's title for redisplay.  */
223 224 225 226 227 228 229 230
  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
231
/* True if leaf window W doesn't reflect the actual state
232 233 234 235 236 237 238 239 240 241
   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));
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

417 418
  return window;
}
419

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

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

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

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

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

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

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

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

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

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

507
EMACS_INT window_select_count;
508

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

521
  CHECK_LIVE_WINDOW (window);
522

523
  w = XWINDOW (window);
524

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

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

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

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

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

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

573 574 575 576
  return window;
}

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

594
  selected_window = window;
595

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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