window.c 247 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
/* Window creation, deletion and examination for GNU Emacs.
   Does not include redisplay.
3
   Copyright (C) 1985-1987, 1993-1998, 2000-2014 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 <http://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
#include "lisp.h"
26
#include "character.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "buffer.h"
28
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
29
#include "keymap.h"
Paul Eggert's avatar
Paul Eggert committed
30
#include "menu.h"
Jim Blandy's avatar
Jim Blandy committed
31
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
32 33 34 35 36
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
37
#include "dispextern.h"
38 39
#include "blockinput.h"
#include "intervals.h"
40
#include "termhooks.h"		/* For FRAME_TERMINAL.  */
41 42 43
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
44 45 46
#ifdef MSDOS
#include "msdos.h"
#endif
47

Paul Eggert's avatar
Paul Eggert committed
48 49
Lisp_Object Qwindowp, Qwindow_live_p;
static Lisp_Object Qwindow_valid_p;
50 51
static Lisp_Object Qwindow_configuration_p;
static Lisp_Object Qrecord_window_buffer;
52
static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
Martin Rudalics's avatar
Martin Rudalics committed
53
static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
54
static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
55
static Lisp_Object Qwindow_sanitize_window_sizes;
56
static Lisp_Object Qwindow_pixel_to_total;
57
static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
58
static Lisp_Object Qsafe, Qabove, Qbelow, Qwindow_size, Qclone_of;
59
static Lisp_Object Qfloor, Qceiling;
60
static Lisp_Object Qwindow_point_insertion_type;
Martin Rudalics's avatar
Martin Rudalics committed
61

62 63 64
static int displayed_window_lines (struct window *);
static int count_windows (struct window *);
static int get_leaf_windows (struct window *, struct window **, int);
65 66 67
static void window_scroll (Lisp_Object, EMACS_INT, bool, int);
static void window_scroll_pixel_based (Lisp_Object, int, bool, int);
static void window_scroll_line_based (Lisp_Object, int, bool, int);
68 69 70 71 72
static int add_window_to_list (struct window *, void *);
static Lisp_Object next_window (Lisp_Object, Lisp_Object,
                                Lisp_Object, int);
static void decode_next_window_args (Lisp_Object *, Lisp_Object *,
                                     Lisp_Object *);
Andreas Schwab's avatar
Andreas Schwab committed
73
static void foreach_window (struct frame *,
74
				 int (* fn) (struct window *, void *),
Andreas Schwab's avatar
Andreas Schwab committed
75
                            void *);
76 77 78 79
static int foreach_window_1 (struct window *,
                             int (* fn) (struct window *, void *),
                             void *);
static Lisp_Object window_list_1 (Lisp_Object, Lisp_Object, Lisp_Object);
80 81
static int window_resize_check (struct window *, bool);
static void window_resize_apply (struct window *, bool);
82
static void window_resize_apply_total (struct window *, bool);
Glenn Morris's avatar
Glenn Morris committed
83
static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
84
static void select_window_1 (Lisp_Object, bool);
85

86 87 88 89 90
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,
91
					      Lisp_Object, Lisp_Object, Lisp_Object);
92 93
static void apply_window_adjustment (struct window *);

Jim Blandy's avatar
Jim Blandy committed
94 95 96 97 98 99
/* 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
100
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
101 102
Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
103 104 105 106 107
/* 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;

108 109 110
/* 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
111 112 113
   the selected window.  */
Lisp_Object minibuf_window;

114 115
/* Non-nil means it is the window whose mode line should be
   shown as the selected window when the minibuffer is selected.  */
116
Lisp_Object minibuf_selected_window;
117

118
/* Hook run at end of temp_output_buffer_show.  */
119
static Lisp_Object Qtemp_buffer_show_hook;
120

121 122 123
/* Incremented for each window created.  */
static int sequence_number;

124
/* Hook to run when window config changes.  */
125
static Lisp_Object Qwindow_configuration_change_hook;
126

127
/* Used by the function window_scroll_pixel_based.  */
128
static int window_scroll_pixel_based_preserve_x;
129
static int window_scroll_pixel_based_preserve_y;
130

131
/* Same for window_scroll_line_based.  */
132 133
static EMACS_INT window_scroll_preserve_hpos;
static EMACS_INT window_scroll_preserve_vpos;
134

135 136 137 138 139 140
static void
CHECK_WINDOW_CONFIGURATION (Lisp_Object x)
{
  CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x);
}

Paul Eggert's avatar
Paul Eggert committed
141
/* These setters are used only in this file, so they can be private.  */
142
static void
Paul Eggert's avatar
Paul Eggert committed
143 144 145 146
wset_combination_limit (struct window *w, Lisp_Object val)
{
  w->combination_limit = val;
}
147

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

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

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

166
static void
Paul Eggert's avatar
Paul Eggert committed
167 168 169 170
wset_new_total (struct window *w, Lisp_Object val)
{
  w->new_total = val;
}
171

172
static void
Paul Eggert's avatar
Paul Eggert committed
173 174 175 176
wset_normal_cols (struct window *w, Lisp_Object val)
{
  w->normal_cols = val;
}
177

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

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

190
static void
Paul Eggert's avatar
Paul Eggert committed
191 192 193 194
wset_pointm (struct window *w, Lisp_Object val)
{
  w->pointm = val;
}
195 196 197 198 199 200 201

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

202
static void
Paul Eggert's avatar
Paul Eggert committed
203 204 205 206
wset_start (struct window *w, Lisp_Object val)
{
  w->start = val;
}
207

208
static void
Paul Eggert's avatar
Paul Eggert committed
209 210 211 212
wset_temslot (struct window *w, Lisp_Object val)
{
  w->temslot = val;
}
213

214
static void
Paul Eggert's avatar
Paul Eggert committed
215 216 217 218
wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
{
  w->vertical_scroll_bar_type = val;
}
219

220
static void
Paul Eggert's avatar
Paul Eggert committed
221 222 223 224
wset_window_parameters (struct window *w, Lisp_Object val)
{
  w->window_parameters = val;
}
225

226 227 228 229 230 231 232 233 234 235 236 237
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
238

239 240 241 242 243 244 245 246 247 248 249
/* Nonzero if leaf window W doesn't reflect the actual state
   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));
}

250 251
struct window *
decode_live_window (register Lisp_Object window)
252 253 254
{
  if (NILP (window))
    return XWINDOW (selected_window);
255

256 257 258 259
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

260
struct window *
261 262
decode_any_window (register Lisp_Object window)
{
263 264
  struct window *w;

265 266 267 268
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
269 270
  w = XWINDOW (window);
  return w;
271
}
272

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

Dmitry Antipov's avatar
Dmitry Antipov committed
297 298 299 300
      if (b->base_buffer)
	b = b->base_buffer;
      b->window_count += arg;
      eassert (b->window_count >= 0);
301
      /* These should be recalculated by redisplay code.  */
302
      w->window_end_valid = 0;
303
      w->base_line_pos = 0;
Dmitry Antipov's avatar
Dmitry Antipov committed
304 305 306 307 308 309 310 311 312 313
    }
}

/* 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);
314 315 316 317 318
  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
319 320 321
  adjust_window_count (w, 1);
}

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 352
  (Lisp_Object window)
{
353
  return decode_valid_window (window)->frame;
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 362 363 364 365
  (Lisp_Object frame_or_window)
{
  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 376 377 378
    }

  return window;
}

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.  */)
381 382
  (Lisp_Object frame)
{
383
  return FRAME_MINIBUF_WINDOW (decode_live_frame (frame));
384 385 386 387 388
}

DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
       Swindow_minibuffer_p, 0, 1, 0,
       doc: /* Return non-nil if WINDOW is a minibuffer window.
389
WINDOW must be a valid window and defaults to the selected one.  */)
390 391
  (Lisp_Object window)
{
392
  return MINI_WINDOW_P (decode_valid_window (window)) ? Qt : Qnil;
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 403 404 405 406
the first window of that frame.  */)
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  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 415
    }

416 417
  while (WINDOWP (XWINDOW (window)->contents))
    window = XWINDOW (window)->contents;
418 419 420 421 422 423

  return window;
}

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 438 439
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
440
      window = XFRAME (frame_or_window)->selected_window;
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
    }

  return window;
}

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;

  CHECK_LIVE_FRAME (frame);
  CHECK_LIVE_WINDOW (window);

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

  if (EQ (frame, selected_frame))
    return Fselect_window (window, norecord);
  else
468 469 470 471
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
472 473 474 475 476 477 478 479 480 481 482
}

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)
{
  return selected_window;
}

483 484
int window_select_count;

485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
/* If select_window is called with inhibit_point_swap non-zero it will
   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
select_window (Lisp_Object window, Lisp_Object norecord, int inhibit_point_swap)
{
  register struct window *w;
  struct frame *sf;

  CHECK_LIVE_WINDOW (window);

  w = XWINDOW (window);

500
  /* Make the selected window's buffer current.  */
501
  Fset_buffer (w->contents);
502

503
  if (EQ (window, selected_window) && !inhibit_point_swap)
504 505 506 507
    /* `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;
508

509
  if (NILP (norecord))
510 511 512 513 514
    { /* Mark the window for redisplay since the selected-window has
	 a different mode-line.  */
      wset_redisplay (XWINDOW (selected_window));
      wset_redisplay (w);
    }
515 516
  else
    redisplay_other_windows ();
517

518 519 520
  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
    {
521
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
522 523 524 525 526 527 528 529 530 531
      /* 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;
    }
  else
532
    fset_selected_window (sf, window);
533

534
  select_window_1 (window, inhibit_point_swap);
535
  bset_last_selected_window (XBUFFER (w->contents), window);
536

537
 record_and_return:
538 539 540 541 542 543 544 545 546
  /* record_buffer can run 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).  */
  if (NILP (norecord))
    {
      w->use_time = ++window_select_count;
      record_buffer (w->contents);
    }

547 548 549 550
  return window;
}

/* Select window with a minimum of fuss, i.e. don't record the change anywhere
Paul Eggert's avatar
Paul Eggert committed
551
   (not even for redisplay's benefit), and assume that the window's frame is
552
   already selected.  */
553
static void
554 555
select_window_1 (Lisp_Object window, bool inhibit_point_swap)
{
556 557 558
  /* 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.  */
559 560
  if (!inhibit_point_swap)
    {
561
      struct window *ow = XWINDOW (selected_window);
562 563 564 565
      if (BUFFERP (ow->contents))
	set_marker_both (ow->pointm, ow->contents,
			 BUF_PT (XBUFFER (ow->contents)),
			 BUF_PT_BYTE (XBUFFER (ow->contents)));
566 567 568 569 570 571 572 573 574
    }

  selected_window = window;

  /* 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.  */
575
  set_point_from_marker (XWINDOW (window)->pointm);
576 577 578
}

DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
579 580
       doc: /* Select WINDOW which must be a live window.
Also make WINDOW's frame the selected frame and WINDOW that frame's
581
selected window.  In addition, make WINDOW's buffer current and set its
582 583
buffer's value of `point' to the value of WINDOW's `window-point'.
Return WINDOW.
584 585 586 587

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
selected one.
588

589 590 591 592 593 594 595 596 597 598 599
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.  */)
600 601 602 603 604
  (register Lisp_Object window, Lisp_Object norecord)
{
  return select_window (window, norecord, 0);
}

605
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
606 607 608
       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.  */)
609 610
  (Lisp_Object window)
{
611 612
  struct window *w = decode_any_window (window);
  return WINDOW_LEAF_P (w) ? w->contents : Qnil;
613 614 615
}

DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
616
       doc: /* Return the parent window of window WINDOW.
617
WINDOW must be a valid window and defaults to the selected one.
618
Return nil for a window with no parent (e.g. a root window).  */)
619 620
  (Lisp_Object window)
{
621
  return decode_valid_window (window)->parent;
622 623
}

624
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
625
       doc: /* Return the topmost child window of window WINDOW.
626
WINDOW must be a valid window and defaults to the selected one.
627 628 629
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.  */)
630 631
  (Lisp_Object window)
{
632 633
  struct window *w = decode_valid_window (window);
  return WINDOW_VERTICAL_COMBINATION_P (w) ? w->contents : Qnil;
634 635
}

636
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
637
       doc: /* Return the leftmost child window of window WINDOW.
638
WINDOW must be a valid window and defaults to the selected one.
639 640 641
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.  */)
642 643
  (Lisp_Object window)
{
644 645
  struct window *w = decode_valid_window (window);
  return WINDOW_HORIZONTAL_COMBINATION_P (w) ? w->contents : Qnil;
646 647
}

648
DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
649
       doc: /* Return the next sibling window of window WINDOW.
650
WINDOW must be a valid window and defaults to the selected one.
651
Return nil if WINDOW has no next sibling.  */)
652 653
  (Lisp_Object window)
{
654
  return decode_valid_window (window)->next;
655 656
}

657
DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
658
       doc: /* Return the previous sibling window of window WINDOW.
659
WINDOW must be a valid window and defaults to the selected one.
660
Return nil if WINDOW has no previous sibling.  */)
661 662
  (Lisp_Object window)
{
663
  return decode_valid_window (window)->prev;
664
}
Gerd Moellmann's avatar
Gerd Moellmann committed
665

666
DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
667
       doc: /* Return combination limit of window WINDOW.
668
WINDOW must be a valid window used in horizontal or vertical combination.
669
If the return value is nil, child windows of WINDOW can be recombined with
670
WINDOW's siblings.  A return value of t means that child windows of
671
WINDOW are never \(re-)combined with WINDOW's siblings.  */)
672
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
673
{
674 675
  struct window *w;

676
  CHECK_VALID_WINDOW (window);
677
  w = XWINDOW (window);
678
  if (WINDOW_LEAF_P (w))
679
    error ("Combination limit is meaningful for internal windows only");
680
  return w->combination_limit;
Jim Blandy's avatar
Jim Blandy committed
681
}
682

683
DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
684
       doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
685
WINDOW must be a valid window used in horizontal or vertical combination.
686 687 688
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
\(re-)combined with WINDOW's siblings.  Other values are reserved for
689
future use.  */)
690
  (Lisp_Object window, Lisp_Object limit)
691
{
692 693 694 695
  struct window *w;

  CHECK_VALID_WINDOW (window);
  w = XWINDOW (window);
696
  if (WINDOW_LEAF_P (w))
697 698
    error ("Combination limit is meaningful for internal windows only");
  wset_combination_limit (w, limit);
Paul Eggert's avatar
Paul Eggert committed
699
  return limit;
700
}
701

702
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
703
       doc: /* Return the use time of window WINDOW.
704
WINDOW must be a live window and defaults to the selected one.
705 706 707
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.  */)
708 709
  (Lisp_Object window)
{
710
  return make_number (decode_live_window (window)->use_time);
711
}
712

713
DEFUN ("window-pixel-width", Fwindow_pixel_width, Swindow_pixel_width, 0, 1, 0,
714
       doc: /* Return the width of window WINDOW in pixels.
715 716 717 718 719 720 721 722 723 724 725 726
WINDOW must be a valid window and defaults to the selected one.

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)
{
  return make_number (decode_valid_window (window)->pixel_width);
}

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

730 731 732
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.  */)
733 734 735 736 737
  (Lisp_Object window)
{
  return make_number (decode_valid_window (window)->pixel_height);
}

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

742 743 744
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.
745

746 747 748 749 750 751 752 753 754 755 756 757 758
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)
759
{
760 761 762 763 764 765 766 767 768 769 770 771
  struct window *w = decode_valid_window (window);

  if (! EQ (round, Qfloor) && ! EQ (round, Qceiling))
    return make_number (w->total_lines);
  else
    {
      int unit = FRAME_LINE_HEIGHT (WINDOW_XFRAME (w));

      return make_number (EQ (round, Qceiling)
			  ? ((w->pixel_height + unit - 1) /unit)
			  : (w->pixel_height / unit));
    }
772
}
773

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

778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
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)
796
{
797 798 799 800 801 802 803 804 805 806 807 808
  struct window *w = decode_valid_window (window);

  if (! EQ (round, Qfloor) && ! EQ (round, Qceiling))
    return make_number (w->total_cols);
  else
    {
      int unit = FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w));

      return make_number (EQ (round, Qceiling)
			  ? ((w->pixel_width + unit - 1) /unit)
			  : (w->pixel_width / unit));
    }
809
}
810

811
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
812
       doc: /* Return the new total size of window WINDOW.
813 814
WINDOW must be a valid window and defaults to the selected one.

815 816 817 818
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').  */)
819 820
  (Lisp_Object window)
{
821
  return decode_valid_window (window)->new_total;
822 823 824
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
825
       doc: /* Return the normal height of window WINDOW.
826
WINDOW must be a valid window and defaults to the selected one.
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
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.  */)
846 847
  (Lisp_Object window, Lisp_Object horizontal)
{
848
  struct window *w = decode_valid_window (window);
849 850

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
851 852 853
}

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

857 858 859
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').  */)
860 861
  (Lisp_Object window)
{
862
  return decode_valid_window (window)->new_normal;
863 864
}

865 866
DEFUN ("window-new-pixel", Fwindow_new_pixel, Swindow_new_pixel, 0, 1, 0,
       doc: /* Return new pixel size of window WINDOW.
867 868 869
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
870 871 872
`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').  */)
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
  (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)
{
  return make_number (decode_valid_window (window)->pixel_left);
}

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)
{
  return make_number (decode_valid_window (window)->pixel_top);
}

894
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
895
       doc: /* Return left column of window WINDOW.
896 897 898 899
This is the distance, in columns, between the left edge of WINDOW and
the left edge of the frame's window area.  For instance, the return
value is 0 if there is no window to the left of WINDOW.

900
WINDOW must be a valid window and defaults to the selected one.  */)
901 902
  (Lisp_Object window)
{
903
  return make_number (decode_valid_window (window)->left_col);
904 905 906
}

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
907
       doc: /* Return top line of window WINDOW.
908 909 910 911
This is the distance, in lines, between the top of WINDOW and the top
of the frame's window area.  For instance, the return value is 0 if
there is no window above WINDOW.

912
WINDOW must be a valid window and defaults to the selected one.  */)
913 914
  (Lisp_Object window)
{
915
  return make_number (decode_valid_window (window)->top_line);
916 917
}

918 919 920
/* Return the number of lines/pixels of W's body.  Don't count any mode
   or header line or horizontal divider of W.  Rounds down to nearest
   integer when not working pixelwise. */
921
static int
922
window_body_height (struct window *w, bool pixelwise)
923
{
924
  int height = (w->pixel_height
925
		- WINDOW_HEADER_LINE_HEIGHT (w)
926 927 928
		- (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w)
		   ? WINDOW_SCROLL_BAR_AREA_HEIGHT (w)
		   : 0)
929 930
		- WINDOW_MODE_LINE_HEIGHT (w)
		- WINDOW_BOTTOM_DIVIDER_WIDTH (w));
931

Martin Rudalics's avatar
Martin Rudalics committed
932 933 934 935 936
  /* Don't return a negative value.  */
  return max (pixelwise
	      ? height
	      : height / FRAME_LINE_HEIGHT (WINDOW_XFRAME (w)),
	      0);
937 938
}

939 940 941 942 943
/* Return the number of columns/pixels of W's body.  Don't count columns
   occupied by the scroll bar or the divider/vertical bar separating W
   from its right sibling or margins.  On window-systems don't count
   fringes either.  Round down to nearest integer when not working
   pixelwise.  */
944
int
945
window_body_width (struct window *w, bool pixelwise)
946 947 948
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));

949 950 951 952 953 954 955 956 957
  int width = (w->pixel_width
	       - WINDOW_RIGHT_DIVIDER_WIDTH (w)
	       - (WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
		  ? WINDOW_SCROLL_BAR_AREA_WIDTH (w)
		  : ((!FRAME_WINDOW_P (f)
		      && !WINDOW_RIGHTMOST_P (w)
		      && !WINDOW_RIGHT_DIVIDER_WIDTH (w))
		     /* A vertical bar is either 1 or 0.  */
		     ? 1 : 0))
958 959 960 961 962
		- WINDOW_MARGINS_WIDTH (w)
		- (FRAME_WINDOW_P (f)
		   ? WINDOW_FRINGES_WIDTH (w)
		   : 0));

Martin Rudalics's avatar
Martin Rudalics committed
963 964 965 966 967
  /* Don't return a negative value.  */
  return max (pixelwise
	      ? width
	      : width / FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w)),
	      0);
968 969 970
}

DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 2, 0,
971 972 973 974 975 976 977 978 979 980
       doc: /* Return the height of WINDOW's text area.
WINDOW must be a live window and defaults to the selected one.  Optional
argument PIXELWISE non-nil means return the height of WINDOW's text area
in pixels.  The return value does not include the mode line or header
line or any horizontal divider.

If PIXELWISE is nil, return the largest integer smaller than WINDOW's
pixel height divided by the character height of WINDOW's frame.  This
means that if a line at the bottom of the text area is only partially
visible, that line is not counted.  */)
981 982 983 984
  (Lisp_Object window, Lisp_Object pixelwise)
{
  return make_number (window_body_height (decode_live_window (window),
					  NILP (pixelwise) ? 0 : 1));
985 986
}

987
DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 2, 0,
988 989 990 991 992 993 994 995 996 997
       doc: /* Return the width of WINDOW's text area.
WINDOW must be a live window and defaults to the selected one.  Optional
argument PIXELWISE non-nil means return the width in pixels.  The return
value does not include any vertical dividers, fringes or marginal areas,
or scroll bars.

If PIXELWISE is nil, return the largest integer smaller than WINDOW's
pixel width divided by the character width of WINDOW's frame.  This
means that if a column at the right of the text area is only partially
visible, that column is not counted.  */)
998 999 1000 1001 1002 1003 1004 1005
  (Lisp_Object window, Lisp_Object pixelwise)
{
  return make_number (window_body_width (decode_live_window (window),
					 NILP (pixelwise) ? 0 : 1));
}

DEFUN ("window-mode-line-height", Fwindow_mode_line_height,
       Swindow_mode_line_height, 0, 1, 0,
1006
       doc: /* Return the height in pixels of WINDOW's mode-line.
1007
WINDOW must be a live window and defaults to the selected one.  */)
1008
  (Lisp_Object window)
1009
{
1010
  return (make_number (WINDOW_MODE_LINE_HEIGHT (decode_live_window (window))));
1011
}
1012

1013 1014
DEFUN ("window-header-line-height", Fwindow_header_line_height,
       Swindow_header_line_height, 0, 1, 0,
1015
       doc: /* Return the height in pixels of WINDOW's header-line.
1016 1017 1018 1019 1020
WINDOW must be a live window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return (make_number (WINDOW_HEADER_LINE_HEIGHT (decode_live_window (window))));
}
1021

1022 1023
DEFUN ("window-right-divider-width", Fwindow_right_divider_width,
       Swindow_right_divider_width, 0, 1, 0,
1024
       doc: /* Return the width in pixels of WINDOW's right divider.
1025
WINDOW must be a live window and defaults to the selected one.  */)
1026 1027
  (Lisp_Object window)
{
1028 1029 1030 1031 1032
  return (make_number (WINDOW_RIGHT_DIVIDER_WIDTH (decode_live_window (window))));
}

DEFUN ("window-bottom-divider-width", Fwindow_bottom_divider_width,
       Swindow_bottom_divider_width, 0, 1, 0,
1033
       doc: /* Return the width in pixels of WINDOW's bottom divider.
1034 1035 1036 1037
WINDOW must be a live window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return (make_number (WINDOW_BOTTOM_DIVIDER_WIDTH (decode_live_window (window))));
1038
}
1039

1040 1041 1042 1043 1044 1045 1046 1047 1048
DEFUN ("window-scroll-bar-width", Fwindow_scroll_bar_width,
       Swindow_scroll_bar_width, 0, 1, 0,
       doc: /* Return the width in pixels of WINDOW's vertical scrollbar.
WINDOW must be a live window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return (make_number (WINDOW_SCROLL_BAR_AREA_WIDTH (decode_live_window (window))));
}

1049 1050 1051 1052 1053 1054 1055 1056 1057
DEFUN ("window-scroll-bar-height", Fwindow_scroll_bar_height,
       Swindow_scroll_bar_height, 0, 1, 0,
       doc: /* Return the height in pixels of WINDOW's horizontal scrollbar.
WINDOW must be a live window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return (make_number (WINDOW_SCROLL_BAR_AREA_HEIGHT (decode_live_window (window))));
}

Jim Blandy's avatar
Jim Blandy committed
1058
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
1059
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
1060
WINDOW must be a live window and defaults to the selected one.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1061
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
1062
{
1063
  return make_number (decode_live_window (window)->hscroll);
Jim Blandy's avatar
Jim Blandy committed
1064 1065
}

1066 1067 1068 1069 1070
/* Set W's horizontal scroll amount to HSCROLL clipped to a reasonable
   range, returning the new amount as a fixnum.  */
static Lisp_Object
set_window_hscroll (struct window *w, EMACS_INT hscroll)
{
1071 1072 1073 1074 1075 1076 1077 1078
  /* Horizontal scrolling has problems with large scroll amounts.
     It's too slow with long lines, and even with small lines the
     display can be messed up.  For now, though, impose only the limits
     required by the internal representation: horizontal scrolling must
     fit in fixnum (since it's visible to Elisp) and into ptrdiff_t
     (since it's stored in a ptrdiff_t).  */
  ptrdiff_t hscroll_max = min (MOST_POSITIVE_FIXNUM, PTRDIFF_MAX);
  ptrdiff_t new_hscroll = clip_to_bounds (0, hscroll, hscroll_max);
1079 1080 1081

  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (w->hscroll != new_hscroll)
1082
    XBUFFER (w->contents)->prevent_redisplay_optimizations_p = 1;