window.c 282 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
static struct window *set_window_fringes (struct window *, Lisp_Object,
62 63
					  Lisp_Object, Lisp_Object,
					  Lisp_Object);
64 65 66
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
					      Lisp_Object, Lisp_Object,
68
					      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
/* 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).  */
83
static Lisp_Object old_selected_window;
84

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

218 219 220 221
static void
wset_update_mode_line (struct window *w)
{
  /* If this window is the selected window on its frame, set the
222
     global variable update_mode_lines, so that gui_consider_frame_title
Paul Eggert's avatar
Paul Eggert committed
223
     will consider this frame's title for redisplay.  */
224 225 226 227 228 229 230 231
  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
232
/* True if leaf window W doesn't reflect the actual state
233 234 235 236 237 238 239 240 241 242
   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));
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

418 419
  return window;
}
420

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

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

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

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

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

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

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

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

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

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

508
EMACS_INT window_select_count;
509

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

522
  CHECK_LIVE_WINDOW (window);
523

524
  w = XWINDOW (window);
525

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

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

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

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

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

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

574 575 576 577
  return window;
}

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

595
  selected_window = window;
596

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Martin Rudalics's avatar