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

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
/* True mean window_change_record has to record all live frames.  */
static bool window_change_record_frames;

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

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

104
/* Incremented for each window created.  */
105
static EMACS_INT sequence_number;
106

107
/* Used by the function window_scroll_pixel_based.  */
108
static int window_scroll_pixel_based_preserve_x;
109
static int window_scroll_pixel_based_preserve_y;
110

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

206 207 208 209 210 211 212 213 214 215 216 217
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
218

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

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

250 251 252 253
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

254
struct window *
255 256
decode_any_window (register Lisp_Object window)
{
257 258
  struct window *w;

259 260 261 262
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
263 264
  w = XWINDOW (window);
  return w;
265
}
266

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

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

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

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

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

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

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

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

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

  return window;
Jim Blandy's avatar
Jim Blandy committed
376 377
}

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

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

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

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

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

419 420
  return window;
}
421

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

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

443
  return window;
Jim Blandy's avatar
Jim Blandy committed
444
}
445

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

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

475 476
  CHECK_LIVE_FRAME (frame);
  CHECK_LIVE_WINDOW (window);
477

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

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

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

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

509
EMACS_INT window_select_count;
510

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

523
  CHECK_LIVE_WINDOW (window);
524

525
  w = XWINDOW (window);
526

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

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

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

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

561
  select_window_1 (window, inhibit_point_swap);
562
  bset_last_selected_window (XBUFFER (w->contents), window);
563

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

575 576 577 578
  return window;
}

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

596
  selected_window = window;
597

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

823 824 825
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.
826

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

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

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

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

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

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

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

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

896 897 898 899
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').  */)
900 901
  (Lisp_Object window)
{
902
  return decode_valid_window (window)->new_total;
903 904 905
}

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

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
932 933 934
}

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

938 939 940
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').  */)
941 942
  (Lisp_Object window)
{
943
  return decode_valid_window (window)->new_normal;
944 945
}

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

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)
{
972
  return make_fixnum (decode_valid_window (window)->pixel_top);
973 974
}

975
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
976
       doc: /* Return left column of window WINDOW.
977 978 979 980