window.c 236 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 4
   Copyright (C) 1985-1987, 1993-1998, 2000-2013 Free Software
   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"
Jim Blandy's avatar
Jim Blandy committed
30
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
31 32 33 34 35
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
36
#include "dispextern.h"
37 38
#include "blockinput.h"
#include "intervals.h"
39
#include "termhooks.h"		/* For FRAME_TERMINAL.  */
40 41 42
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
43 44 45
#ifdef MSDOS
#include "msdos.h"
#endif
46

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

58 59 60
static int displayed_window_lines (struct window *);
static int count_windows (struct window *);
static int get_leaf_windows (struct window *, struct window **, int);
61 62 63
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);
64 65 66 67 68
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
69
static void foreach_window (struct frame *,
70
				 int (* fn) (struct window *, void *),
Andreas Schwab's avatar
Andreas Schwab committed
71
                            void *);
72 73 74 75
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);
76 77
static int window_resize_check (struct window *, bool);
static void window_resize_apply (struct window *, bool);
78
static void window_resize_apply_total (struct window *, bool);
Glenn Morris's avatar
Glenn Morris committed
79
static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
80
static void select_window_1 (Lisp_Object, bool);
81

82 83 84 85 86 87 88 89
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,
					      Lisp_Object, Lisp_Object);
static void apply_window_adjustment (struct window *);

Jim Blandy's avatar
Jim Blandy committed
90 91 92 93 94 95
/* 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
96
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
97 98
Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
99 100 101 102 103
/* 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;

104 105 106
/* 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
107 108 109
   the selected window.  */
Lisp_Object minibuf_window;

110 111
/* Non-nil means it is the window whose mode line should be
   shown as the selected window when the minibuffer is selected.  */
112
Lisp_Object minibuf_selected_window;
113

114
/* Hook run at end of temp_output_buffer_show.  */
115
static Lisp_Object Qtemp_buffer_show_hook;
116

117 118 119
/* Incremented for each window created.  */
static int sequence_number;

120 121 122
/* Nonzero after init_window_once has finished.  */
static int window_initialized;

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

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

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

Paul Eggert's avatar
Paul Eggert committed
140
/* These setters are used only in this file, so they can be private.  */
141
static void
Paul Eggert's avatar
Paul Eggert committed
142 143 144 145
wset_combination_limit (struct window *w, Lisp_Object val)
{
  w->combination_limit = val;
}
146
static void
Paul Eggert's avatar
Paul Eggert committed
147 148 149 150
wset_dedicated (struct window *w, Lisp_Object val)
{
  w->dedicated = val;
}
151
static void
Paul Eggert's avatar
Paul Eggert committed
152 153 154 155
wset_display_table (struct window *w, Lisp_Object val)
{
  w->display_table = val;
}
156
static void
Paul Eggert's avatar
Paul Eggert committed
157 158 159 160
wset_new_normal (struct window *w, Lisp_Object val)
{
  w->new_normal = val;
}
161
static void
Paul Eggert's avatar
Paul Eggert committed
162 163 164 165
wset_new_total (struct window *w, Lisp_Object val)
{
  w->new_total = val;
}
166
static void
Paul Eggert's avatar
Paul Eggert committed
167 168 169 170
wset_normal_cols (struct window *w, Lisp_Object val)
{
  w->normal_cols = val;
}
171
static void
Paul Eggert's avatar
Paul Eggert committed
172 173 174 175
wset_normal_lines (struct window *w, Lisp_Object val)
{
  w->normal_lines = val;
}
176
static void
Paul Eggert's avatar
Paul Eggert committed
177 178 179 180
wset_parent (struct window *w, Lisp_Object val)
{
  w->parent = val;
}
181
static void
Paul Eggert's avatar
Paul Eggert committed
182 183 184 185
wset_pointm (struct window *w, Lisp_Object val)
{
  w->pointm = val;
}
186
static void
Paul Eggert's avatar
Paul Eggert committed
187 188 189 190
wset_start (struct window *w, Lisp_Object val)
{
  w->start = val;
}
191
static void
Paul Eggert's avatar
Paul Eggert committed
192 193 194 195
wset_temslot (struct window *w, Lisp_Object val)
{
  w->temslot = val;
}
196
static void
Paul Eggert's avatar
Paul Eggert committed
197 198 199 200
wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
{
  w->vertical_scroll_bar_type = val;
}
201
static void
Paul Eggert's avatar
Paul Eggert committed
202 203 204 205
wset_window_parameters (struct window *w, Lisp_Object val)
{
  w->window_parameters = val;
}
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 224 225 226 227 228 229
/* 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));
}

230 231
struct window *
decode_live_window (register Lisp_Object window)
232 233 234
{
  if (NILP (window))
    return XWINDOW (selected_window);
235

236 237 238 239
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

240
struct window *
241 242
decode_any_window (register Lisp_Object window)
{
243 244
  struct window *w;

245 246 247 248
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
249 250
  w = XWINDOW (window);
  return w;
251
}
252

Paul Eggert's avatar
Paul Eggert committed
253
static struct window *
254 255 256 257 258 259 260 261 262 263 264 265
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
266 267 268 269 270 271 272
/* 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);
273
  if (BUFFERP (w->contents))
Dmitry Antipov's avatar
Dmitry Antipov committed
274
    {
275
      struct buffer *b = XBUFFER (w->contents);
Paul Eggert's avatar
Paul Eggert committed
276

Dmitry Antipov's avatar
Dmitry Antipov committed
277 278 279 280
      if (b->base_buffer)
	b = b->base_buffer;
      b->window_count += arg;
      eassert (b->window_count >= 0);
281
      /* These should be recalculated by redisplay code.  */
282
      w->window_end_valid = 0;
283
      w->base_line_pos = 0;
Dmitry Antipov's avatar
Dmitry Antipov committed
284 285 286 287 288 289 290 291 292 293
    }
}

/* 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);
294 295 296 297 298
  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
299 300 301
  adjust_window_count (w, 1);
}

Jim Blandy's avatar
Jim Blandy committed
302
DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
303
       doc: /* Return t if OBJECT is a window and nil otherwise.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
304
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
305
{
306
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
307 308
}

309 310 311 312 313 314 315 316 317
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
window.  Deleted windows are not live.  */)
  (Lisp_Object object)
{
  return WINDOW_VALID_P (object) ? Qt : Qnil;
}

318
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
319
       doc: /* Return t if OBJECT is a live window and nil otherwise.
320 321
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
322
  (Lisp_Object object)
323
{
324
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
325
}
326 327

/* Frames and windows.  */
328
DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 0, 1, 0,
329
       doc: /* Return the frame that window WINDOW is on.
330
WINDOW must be a valid window and defaults to the selected one.  */)
331 332
  (Lisp_Object window)
{
333
  return decode_valid_window (window)->frame;
334 335 336
}

DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
337 338
       doc: /* Return the root window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
339 340
With a frame argument, return that frame's root window.
With a window argument, return the root window of that window's frame.  */)
341 342 343 344 345
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
346
    window = SELECTED_FRAME ()->root_window;
347 348
  else if (WINDOW_VALID_P (frame_or_window))
      window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
349 350 351
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
352
      window = XFRAME (frame_or_window)->root_window;
353 354 355 356 357 358
    }

  return window;
}

DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
359 360
       doc: /* Return the minibuffer window for frame FRAME.
If FRAME is omitted or nil, it defaults to the selected frame.  */)
361 362
  (Lisp_Object frame)
{
363
  return FRAME_MINIBUF_WINDOW (decode_live_frame (frame));
364 365 366 367 368
}

DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
       Swindow_minibuffer_p, 0, 1, 0,
       doc: /* Return non-nil if WINDOW is a minibuffer window.
369
WINDOW must be a valid window and defaults to the selected one.  */)
370 371
  (Lisp_Object window)
{
372
  return MINI_WINDOW_P (decode_valid_window (window)) ? Qt : Qnil;
373 374 375 376
}

/* 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,
377 378
       doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
379 380
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
381 382 383 384 385 386
the first window of that frame.  */)
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
387
    window = SELECTED_FRAME ()->root_window;
388
  else if (WINDOW_VALID_P (frame_or_window))
389
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
390 391 392
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
393
      window = XFRAME (frame_or_window)->root_window;
394 395
    }

396 397
  while (WINDOWP (XWINDOW (window)->contents))
    window = XWINDOW (window)->contents;
398 399 400 401 402 403

  return window;
}

DEFUN ("frame-selected-window", Fframe_selected_window,
       Sframe_selected_window, 0, 1, 0,
404 405
       doc: /* Return the selected window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
406 407 408
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.  */)
409 410 411 412 413
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
414
    window = SELECTED_FRAME ()->selected_window;
415
  else if (WINDOW_VALID_P (frame_or_window))
416
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
417 418 419
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
420
      window = XFRAME (frame_or_window)->selected_window;
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
    }

  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
448 449 450 451
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
452 453 454 455 456 457 458 459 460 461 462
}

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

463 464
int window_select_count;

465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
/* 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);

480
  /* Make the selected window's buffer current.  */
481
  Fset_buffer (w->contents);
482

483
  if (EQ (window, selected_window) && !inhibit_point_swap)
484 485 486 487
    /* `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;
488

489 490 491 492 493 494
  if (NILP (norecord))
    /* Mark the window for redisplay since the selected-window has a different
       mode-line.  */
    wset_redisplay (XWINDOW (selected_window));
  else
    redisplay_other_windows ();
495 496 497
  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
    {
498
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
499 500 501 502 503 504 505 506 507 508
      /* 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
509
    fset_selected_window (sf, window);
510

511
  select_window_1 (window, inhibit_point_swap);
512
  bset_last_selected_window (XBUFFER (w->contents), window);
513 514
  if (NILP (norecord))
    wset_redisplay (w);
515

516
 record_and_return:
517 518 519 520 521 522 523 524 525
  /* 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);
    }

526 527 528 529
  return window;
}

/* Select window with a minimum of fuss, i.e. don't record the change anywhere
Paul Eggert's avatar
Paul Eggert committed
530
   (not even for redisplay's benefit), and assume that the window's frame is
531
   already selected.  */
532
static void
533 534
select_window_1 (Lisp_Object window, bool inhibit_point_swap)
{
535 536 537
  /* 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.  */
538 539
  if (!inhibit_point_swap)
    {
540
      struct window *ow = XWINDOW (selected_window);
541 542 543 544
      if (BUFFERP (ow->contents))
	set_marker_both (ow->pointm, ow->contents,
			 BUF_PT (XBUFFER (ow->contents)),
			 BUF_PT_BYTE (XBUFFER (ow->contents)));
545 546 547 548 549 550 551 552 553
    }

  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.  */
554
  set_point_from_marker (XWINDOW (window)->pointm);
555 556 557
}

DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
558 559 560 561 562
       doc: /* Select WINDOW which must be a live window.
Also make WINDOW's frame the selected frame and WINDOW that frame's
selected window.  In addition, make WINDOW's buffer current and set that
buffer's value of `point' to the value of WINDOW's `window-point'.
Return WINDOW.
563 564 565 566

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.
567

568 569 570 571 572 573 574
Note that the main editor command loop sets the current buffer to the
buffer of the selected window before each command.  */)
  (register Lisp_Object window, Lisp_Object norecord)
{
  return select_window (window, norecord, 0);
}

575
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
576 577 578
       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.  */)
579 580
  (Lisp_Object window)
{
581 582
  struct window *w = decode_any_window (window);
  return WINDOW_LEAF_P (w) ? w->contents : Qnil;
583 584 585
}

DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
586
       doc: /* Return the parent window of window WINDOW.
587
WINDOW must be a valid window and defaults to the selected one.
588
Return nil for a window with no parent (e.g. a root window).  */)
589 590
  (Lisp_Object window)
{
591
  return decode_valid_window (window)->parent;
592 593
}

594
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
595
       doc: /* Return the topmost child window of window WINDOW.
596
WINDOW must be a valid window and defaults to the selected one.
597 598 599
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.  */)
600 601
  (Lisp_Object window)
{
602 603
  struct window *w = decode_valid_window (window);
  return WINDOW_VERTICAL_COMBINATION_P (w) ? w->contents : Qnil;
604 605
}

606
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
607
       doc: /* Return the leftmost child window of window WINDOW.
608
WINDOW must be a valid window and defaults to the selected one.
609 610 611
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.  */)
612 613
  (Lisp_Object window)
{
614 615
  struct window *w = decode_valid_window (window);
  return WINDOW_HORIZONTAL_COMBINATION_P (w) ? w->contents : Qnil;
616 617
}

618
DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
619
       doc: /* Return the next sibling window of window WINDOW.
620
WINDOW must be a valid window and defaults to the selected one.
621
Return nil if WINDOW has no next sibling.  */)
622 623
  (Lisp_Object window)
{
624
  return decode_valid_window (window)->next;
625 626
}

627
DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
628
       doc: /* Return the previous sibling window of window WINDOW.
629
WINDOW must be a valid window and defaults to the selected one.
630
Return nil if WINDOW has no previous sibling.  */)
631 632
  (Lisp_Object window)
{
633
  return decode_valid_window (window)->prev;
634
}
Gerd Moellmann's avatar
Gerd Moellmann committed
635

636
DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
637
       doc: /* Return combination limit of window WINDOW.
638
WINDOW must be a valid window used in horizontal or vertical combination.
639
If the return value is nil, child windows of WINDOW can be recombined with
640
WINDOW's siblings.  A return value of t means that child windows of
641
WINDOW are never \(re-)combined with WINDOW's siblings.  */)
642
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
643
{
644 645
  struct window *w;

646
  CHECK_VALID_WINDOW (window);
647
  w = XWINDOW (window);
648
  if (WINDOW_LEAF_P (w))
649
    error ("Combination limit is meaningful for internal windows only");
650
  return w->combination_limit;
Jim Blandy's avatar
Jim Blandy committed
651
}
652

653
DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
654
       doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
655
WINDOW must be a valid window used in horizontal or vertical combination.
656 657 658
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
659
future use.  */)
660
  (Lisp_Object window, Lisp_Object limit)
661
{
662 663 664 665
  struct window *w;

  CHECK_VALID_WINDOW (window);
  w = XWINDOW (window);
666
  if (WINDOW_LEAF_P (w))
667 668
    error ("Combination limit is meaningful for internal windows only");
  wset_combination_limit (w, limit);
Paul Eggert's avatar
Paul Eggert committed
669
  return limit;
670
}
671

672
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
673
       doc: /* Return the use time of window WINDOW.
674
WINDOW must be a live window and defaults to the selected one.
675 676 677
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.  */)
678 679
  (Lisp_Object window)
{
680
  return make_number (decode_live_window (window)->use_time);
681
}
682

683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
DEFUN ("window-pixel-width", Fwindow_pixel_width, Swindow_pixel_width, 0, 1, 0,
       doc: /* Return the pixel width of window WINDOW.
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,
       doc: /* Return the pixel height of window WINDOW.
WINDOW must be a valid window and defaults to the selected one.

The return value includes the mode line and header line, if any.  If
WINDOW is an internal window, its pixel height is the height of the
screen areas spanned by its children.  */)
  (Lisp_Object window)
{
  return make_number (decode_valid_window (window)->pixel_height);
}

708 709
DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
       doc: /* Return the total height, in lines, of window WINDOW.
710
WINDOW must be a valid window and defaults to the selected one.
711

712 713 714
The return value includes the mode line and header line, if any.
If WINDOW is an internal window, the total height is the height
of the screen areas spanned by its children.
715

716 717 718
On a graphical display, this total height is reported as an
integer multiple of the default character height.  */)
  (Lisp_Object window)
719
{
720
  return make_number (decode_valid_window (window)->total_lines);
721
}
722

723 724
DEFUN ("window-total-width", Fwindow_total_width, Swindow_total_width, 0, 1, 0,
       doc: /* Return the total width, in columns, of window WINDOW.
725
WINDOW must be a valid window and defaults to the selected one.
726

727 728 729
The return value includes any vertical dividers or scroll bars
belonging to WINDOW.  If WINDOW is an internal window, the total width
is the width of the screen areas spanned by its children.
730

731 732
On a graphical display, this total width is reported as an
integer multiple of the default character width.  */)
733 734
  (Lisp_Object window)
{
735
  return make_number (decode_valid_window (window)->total_cols);
736
}
737

738
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
739
       doc: /* Return the new total size of window WINDOW.
740
WINDOW must be a valid window and defaults to the selected one.  */)
741 742
  (Lisp_Object window)
{
743
  return decode_valid_window (window)->new_total;
744 745 746
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
747
       doc: /* Return the normal height of window WINDOW.
748
WINDOW must be a valid window and defaults to the selected one.
749
If HORIZONTAL is non-nil, return the normal width of WINDOW.  */)
750 751
  (Lisp_Object window, Lisp_Object horizontal)
{
752
  struct window *w = decode_valid_window (window);
753 754

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
755 756 757
}

DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
758
       doc: /* Return new normal size of window WINDOW.
759
WINDOW must be a valid window and defaults to the selected one.  */)
760 761
  (Lisp_Object window)
{
762
  return decode_valid_window (window)->new_normal;
763 764
}

765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
DEFUN ("window-new-pixel", Fwindow_new_pixel, Swindow_new_pixel, 0, 1, 0,
       doc: /* Return new pixel size of window WINDOW.
WINDOW must be a valid window and defaults to the selected one.  */)
  (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);
}

789
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
790
       doc: /* Return left column of window WINDOW.
791 792 793 794
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.

795
WINDOW must be a valid window and defaults to the selected one.  */)
796 797
  (Lisp_Object window)
{
798
  return make_number (decode_valid_window (window)->left_col);
799 800 801
}

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
802
       doc: /* Return top line of window WINDOW.
803 804 805 806
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.

807
WINDOW must be a valid window and defaults to the selected one.  */)
808 809
  (Lisp_Object window)
{
810
  return make_number (decode_valid_window (window)->top_line);
811 812 813 814 815
}

/* Return the number of lines of W's body.  Don't count any mode or
   header line of W.  */

816
static int
817
window_body_height (struct window *w, bool pixelwise)
818
{
819 820 821 822 823
  int pixels = (w->pixel_height
		- WINDOW_BOTTOM_DIVIDER_WIDTH (w)
		- WINDOW_HEADER_LINE_HEIGHT (w)
		- WINDOW_MODE_LINE_HEIGHT (w));
  int unit = FRAME_LINE_HEIGHT (WINDOW_XFRAME (w));
824

825
  return pixelwise ? pixels : ((pixels + unit - 1) / unit);
826 827 828 829 830 831 832
}

/* Return the number of columns of W's body.  Don't count columns
   occupied by the scroll bar or the vertical bar separating W from its
   right sibling.  On window-systems don't count fringes or display
   margins either.  */
int
833
window_body_width (struct window *w, bool pixelwise)
834 835 836
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));

837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
  int pixels = (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)
		       && !WINDOW_FULL_WIDTH_P (w))
		      /* According to Eli this is either 1 or 0.  */
		      ? 1 : 0))
		- WINDOW_MARGINS_WIDTH (w)
		- (FRAME_WINDOW_P (f)
		   ? WINDOW_FRINGES_WIDTH (w)
		   : 0));
  int unit = FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w));

  return pixelwise ? pixels : ((pixels + unit - 1) / unit);
}

DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 2, 0,
       doc: /* Return the height, in lines, of WINDOW's text area.
WINDOW must be a live window and defaults to the selected one.
859

860
Optional argument PIXELWISE non-nil means return the height in pixels.
861

862 863 864
The returned height does not include the mode line or header line.  On a
graphical display, the height is expressed as an integer multiple of the
default character height if PIXELWISE is nil.
865

866 867 868 869 870 871 872
If PIXELWISE is nil and a line at the bottom of the text area is only
partially visible, that counts as a whole line; to exclude
partially-visible lines, use `window-text-height'.  */)
  (Lisp_Object window, Lisp_Object pixelwise)
{
  return make_number (window_body_height (decode_live_window (window),
					  NILP (pixelwise) ? 0 : 1));
873 874
}

875 876
DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 2, 0,
       doc: /* Return the width, in columns, of WINDOW's text area.
877
WINDOW must be a live window and defaults to the selected one.
878

879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
Optional argument PIXELWISE non-nil means return the width in pixels.

The return value does not include any vertical dividers, fringe or
marginal areas, or scroll bars.  On a graphical display, the width is
expressed as an integer multiple of the default character width if
PIXELWISE is nil.

If PIXELWISE is nil and a column at the right of the text area is only
partially visible, that counts as a whole column; to exclude
partially-visible columns, use `window-text-width'.  */)
  (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,
       doc: /* Return the height in pixel of WINDOW's mode-line.
WINDOW must be a live window and defaults to the selected one.  */)
899
  (Lisp_Object window)
900
{
901
  return (make_number (WINDOW_MODE_LINE_HEIGHT (decode_live_window (window))));
902
}
903

904 905 906 907 908 909 910 911
DEFUN ("window-header-line-height", Fwindow_header_line_height,
       Swindow_header_line_height, 0, 1, 0,
       doc: /* Return the height in pixel of WINDOW's header-line.
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))));
}
912

913 914 915 916
DEFUN ("window-right-divider-width", Fwindow_right_divider_width,
       Swindow_right_divider_width, 0, 1, 0,
       doc: /* Return the width of WINDOW's right divider.
WINDOW must be a live window and defaults to the selected one.  */)
917 918
  (Lisp_Object window)
{
919 920 921 922 923 924 925 926 927 928
  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,
       doc: /* Return the width of WINDOW's bottom divider.
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))));
929
}
930

Jim Blandy's avatar
Jim Blandy committed
931
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
932
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
933
WINDOW must be a live window and defaults to the selected one.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
934
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
935
{
936
  return make_number (decode_live_window (window)->hscroll);
Jim Blandy's avatar
Jim Blandy committed
937 938
}

939 940 941 942 943
/* 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)
{
944 945 946 947 948 949 950 951
  /* 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);
952 953 954

  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (w->hscroll != new_hscroll)
955
    XBUFFER (w->contents)->prevent_redisplay_optimizations_p = 1;
956 957 958 959 960

  w->hscroll = new_hscroll;
  return make_number (new_hscroll);
}

Jim Blandy's avatar
Jim Blandy committed
961
DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
962
       doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
963
WINDOW must be a live window and defaults to the selected one.
964 965
Clip the number to a reasonable value if out of range.
Return the new number.  NCOL should be zero or positive.
966 967

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
968
window so that the location of point moves off-window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
969
  (Lisp_Object window, Lisp_Object ncol)
Jim Blandy's avatar
Jim Blandy committed
970
{
971
  CHECK_NUMBER (ncol);
972
  return set_window_hscroll (decode_live_window (window), XINT (ncol));
Jim Blandy's avatar
Jim Blandy committed
973 974
}

975 976
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
977
       doc: /* Return WINDOW's redisplay end trigger value.
978
WINDOW must be a live window and defaults to the selected one.
979
See `set-window-redisplay-end-trigger' for more information.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
980
  (Lisp_Object window)
981
{
982
  return decode_live_window (window)->redisplay_end_trigger;
983 984 985 986
}

DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
       Sset_window_redisplay_end_trigger, 2, 2, 0,
987
       doc: /* Set WINDOW's redisplay end trigger value to VALUE.
988 989 990 991 992 993
WINDOW must be a live window and defaults to the selected one.  VALUE
should be a buffer position (typically a marker) or nil.  If it is a
buffer position, then if redisplay in WINDOW reaches a position beyond
VALUE, the functions in `redisplay-end-trigger-functions' are called
with two arguments: WINDOW, and the end trigger value.  Afterwards the
end-trigger value is reset to nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
994
  (register Lisp_Object window, Lisp_Object value)
995
{
Paul Eggert's avatar
Paul Eggert committed
996 997
  wset_redisplay_end_trigger (decode_live_window (window), value);
  return value;
998 999
}

Jim Blandy's avatar
Jim Blandy committed
1000
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
1001
       doc: /* Return a list of the edge coordinates of WINDOW.
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
WINDOW must be a valid window and defaults to the selected one.

The returned list has the form (LEFT TOP RIGHT BOTTOM).  TOP and BOTTOM
count by lines, and LEFT and RIGHT count by columns, all relative to 0,
0 at top left corner of frame.

RIGHT is one more than the rightmost column occupied by WINDOW.  BOTTOM
is one more than the bottommost row occupied by WINDOW.  The edges
include the space used by WINDOW's scroll bar, display margins, fringes,
header line, and/or mode line.  For the edges of just the text area, use
`window-inside-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1013
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
1014
{
1015
  register struct window *w = decode_valid_window (window);
Jim Blandy's avatar
Jim Blandy committed
1016

1017 1018
  return list4i (WINDOW_LEFT_EDGE_COL (w), WINDOW_TOP_EDGE_LINE (w),
		 WINDOW_RIGHT_EDGE_COL (w), WINDOW_BOTTOM_EDGE_LINE (w));
Jim Blandy's avatar
Jim Blandy committed
1019 1020
}

1021 1022
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
1023 1024 1025 1026
WINDOW must be a valid window and defaults to the selected one.

The returned list has the form (LEFT TOP RIGHT BOTTOM), all relative to
0, 0 at the top left corner of the frame.
1027 1028 1029 1030 1031 1032

RIGHT is one more than the rightmost x position occupied by WINDOW.
BOTTOM is one more than the bottommost y position occupied by WINDOW.
The pixel edges include the space used by WINDOW's scroll bar, display
margins, fringes, header line, and/or mode line.  For the pixel edges
of just the text area, use `window-inside-pixel-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1033
  (Lisp_Object window)
1034
{
1035
  register struct window *w = decode_valid_window (window);
1036

1037 1038
  return list4i (WINDOW_LEFT_EDGE_X (w), WINDOW_TOP_EDGE_Y (w),
		 WINDOW_RIGHT_EDGE_X (w), WINDOW_BOTTOM_EDGE_Y (w));
1039 1040
}

1041
static void
Juanma Barranquero's avatar
Juanma Barranquero committed
1042
calc_absolute_offset (struct window *w, int *add_x, int *add_y)
1043
{
1044
  struct frame *f = XFRAME (w->frame);
1045 1046 1047 1048
  *add_y = f->top_pos;
#ifdef FRAME_MENUBAR_HEIGHT
  *add_y += FRAME_MENUBAR_HEIGHT (f);
#endif
1049 1050
#ifdef FRAME_TOOLBAR_TOP_HEIGHT
  *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
1051
#elif defined (FRAME_TOOLBAR_HEIGHT)
1052 1053 1054 1055 1056 1057
  *add_y += FRAME_TOOLBAR_HEIGHT (f);
#endif
#ifdef FRAME_NS_TITLEBAR_HEIGHT
  *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
#endif
  *add_x = f->left_pos;
1058 1059 1060
#ifdef FRAME_TOOLBAR_LEFT_WIDTH
  *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
#endif
1061 1062 1063 1064 1065