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

#define WINDOW_INLINE EXTERN_INLINE

25 26
#include <stdio.h>

Jim Blandy's avatar
Jim Blandy committed
27
#include "lisp.h"
28
#include "character.h"
Jim Blandy's avatar
Jim Blandy committed
29
#include "buffer.h"
30
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
31
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
32
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
33 34 35 36 37
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
38
#include "dispextern.h"
39 40
#include "blockinput.h"
#include "intervals.h"
41
#include "termhooks.h"		/* For FRAME_TERMINAL.  */
42

43
#ifdef HAVE_X_WINDOWS
Andreas Schwab's avatar
Andreas Schwab committed
44
#include "xterm.h"
45
#endif	/* HAVE_X_WINDOWS */
Daniel Colascione's avatar
Daniel Colascione committed
46
#ifdef HAVE_NTGUI
Andrew Innes's avatar
Andrew Innes committed
47 48
#include "w32term.h"
#endif
49 50 51
#ifdef MSDOS
#include "msdos.h"
#endif
52 53 54
#ifdef HAVE_NS
#include "nsterm.h"
#endif
55

Paul Eggert's avatar
Paul Eggert committed
56 57
Lisp_Object Qwindowp, Qwindow_live_p;
static Lisp_Object Qwindow_valid_p;
58 59
static Lisp_Object Qwindow_configuration_p;
static Lisp_Object Qrecord_window_buffer;
60
static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
Martin Rudalics's avatar
Martin Rudalics committed
61
static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
62
static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
63
static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
64
static Lisp_Object Qsafe, Qabove, Qbelow, Qwindow_size, Qclone_of;
Martin Rudalics's avatar
Martin Rudalics committed
65

66 67 68
static int displayed_window_lines (struct window *);
static int count_windows (struct window *);
static int get_leaf_windows (struct window *, struct window **, int);
69 70 71
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);
72 73 74 75 76 77
static Lisp_Object window_list (void);
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
78
static void foreach_window (struct frame *,
79
				 int (* fn) (struct window *, void *),
Andreas Schwab's avatar
Andreas Schwab committed
80
                            void *);
81 82 83 84
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);
85 86
static int window_resize_check (struct window *, bool);
static void window_resize_apply (struct window *, bool);
Glenn Morris's avatar
Glenn Morris committed
87
static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
88
static void select_window_1 (Lisp_Object, bool);
89

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

Gerd Moellmann's avatar
Gerd Moellmann committed
107 108 109 110 111
/* 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;

112 113 114
/* 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
115 116 117
   the selected window.  */
Lisp_Object minibuf_window;

118 119
/* Non-nil means it is the window whose mode line should be
   shown as the selected window when the minibuffer is selected.  */
120
Lisp_Object minibuf_selected_window;
121

122
/* Hook run at end of temp_output_buffer_show.  */
123
static Lisp_Object Qtemp_buffer_show_hook;
124

125 126 127
/* Nonzero after init_window_once has finished.  */
static int window_initialized;

128
/* Hook to run when window config changes.  */
129
static Lisp_Object Qwindow_configuration_change_hook;
130

131
/* Used by the function window_scroll_pixel_based */
132
static int window_scroll_pixel_based_preserve_x;
133
static int window_scroll_pixel_based_preserve_y;
134

135
/* Same for window_scroll_line_based.  */
136 137
static EMACS_INT window_scroll_preserve_hpos;
static EMACS_INT window_scroll_preserve_vpos;
138

139 140 141 142 143 144
static void
CHECK_WINDOW_CONFIGURATION (Lisp_Object x)
{
  CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x);
}

Paul Eggert's avatar
Paul Eggert committed
145
/* These setters are used only in this file, so they can be private.  */
146
static void
Paul Eggert's avatar
Paul Eggert committed
147 148 149 150
wset_combination_limit (struct window *w, Lisp_Object val)
{
  w->combination_limit = val;
}
151
static void
Paul Eggert's avatar
Paul Eggert committed
152 153 154 155
wset_dedicated (struct window *w, Lisp_Object val)
{
  w->dedicated = val;
}
156
static void
Paul Eggert's avatar
Paul Eggert committed
157 158 159 160
wset_display_table (struct window *w, Lisp_Object val)
{
  w->display_table = val;
}
161
static void
Paul Eggert's avatar
Paul Eggert committed
162 163 164 165
wset_new_normal (struct window *w, Lisp_Object val)
{
  w->new_normal = val;
}
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
static void
Paul Eggert's avatar
Paul Eggert committed
172 173 174 175
wset_normal_cols (struct window *w, Lisp_Object val)
{
  w->normal_cols = val;
}
176
static void
Paul Eggert's avatar
Paul Eggert committed
177 178 179 180
wset_normal_lines (struct window *w, Lisp_Object val)
{
  w->normal_lines = val;
}
181
static void
Paul Eggert's avatar
Paul Eggert committed
182 183 184 185
wset_parent (struct window *w, Lisp_Object val)
{
  w->parent = val;
}
186
static void
Paul Eggert's avatar
Paul Eggert committed
187 188 189 190
wset_pointm (struct window *w, Lisp_Object val)
{
  w->pointm = val;
}
191
static void
Paul Eggert's avatar
Paul Eggert committed
192 193 194 195
wset_start (struct window *w, Lisp_Object val)
{
  w->start = val;
}
196
static void
Paul Eggert's avatar
Paul Eggert committed
197 198 199 200
wset_temslot (struct window *w, Lisp_Object val)
{
  w->temslot = val;
}
201
static void
Paul Eggert's avatar
Paul Eggert committed
202 203 204 205
wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
{
  w->vertical_scroll_bar_type = val;
}
206
static void
Paul Eggert's avatar
Paul Eggert committed
207 208 209 210
wset_window_parameters (struct window *w, Lisp_Object val)
{
  w->window_parameters = val;
}
211 212 213 214 215 216 217 218 219 220 221 222
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
223

224 225 226 227 228 229 230 231 232 233 234
/* 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));
}

235 236
struct window *
decode_live_window (register Lisp_Object window)
237 238 239
{
  if (NILP (window))
    return XWINDOW (selected_window);
240

241 242 243 244
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

245
struct window *
246 247
decode_any_window (register Lisp_Object window)
{
248 249
  struct window *w;

250 251 252 253
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
254 255
  w = XWINDOW (window);
  return w;
256
}
257

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

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

/* 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);
299 300 301 302 303
  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
304 305 306
  adjust_window_count (w, 1);
}

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

314 315 316 317 318 319 320 321 322
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;
}

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

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

  if (NILP (frame_or_window))
351
    window = SELECTED_FRAME ()->root_window;
352 353
  else if (WINDOW_VALID_P (frame_or_window))
      window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
354 355 356
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
357
      window = XFRAME (frame_or_window)->root_window;
358 359 360 361 362 363
    }

  return window;
}

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

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

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

  if (NILP (frame_or_window))
392
    window = SELECTED_FRAME ()->root_window;
393
  else if (WINDOW_VALID_P (frame_or_window))
394
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
395 396 397
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
398
      window = XFRAME (frame_or_window)->root_window;
399 400
    }

401 402
  while (WINDOWP (XWINDOW (window)->contents))
    window = XWINDOW (window)->contents;
403 404 405 406 407 408

  return window;
}

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

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

  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
453 454 455 456
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
457 458 459 460 461 462 463 464 465 466 467
}

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

468 469
int window_select_count;

470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
/* 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);

485
  /* Make the selected window's buffer current.  */
486
  Fset_buffer (w->contents);
487

488
  if (EQ (window, selected_window) && !inhibit_point_swap)
489 490 491 492
    /* `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;
493 494 495 496

  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
    {
497
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
498 499 500 501 502 503 504 505 506 507
      /* 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
508
    fset_selected_window (sf, window);
509

510
  select_window_1 (window, inhibit_point_swap);
511 512
  bset_last_selected_window (XBUFFER (w->contents), window);
  windows_or_buffers_changed++;
513

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

524 525 526 527
  return window;
}

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

  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.  */
  {
553
    register ptrdiff_t new_point = marker_position (XWINDOW (window)->pointm);
554 555 556 557 558 559 560 561 562 563
    if (new_point < BEGV)
      SET_PT (BEGV);
    else if (new_point > ZV)
      SET_PT (ZV);
    else
      SET_PT (new_point);
  }
}

DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
564 565 566 567 568
       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.
569 570 571 572

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

574 575 576 577 578 579 580
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);
}

581
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
582 583 584
       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.  */)
585 586
  (Lisp_Object window)
{
587 588
  struct window *w = decode_any_window (window);
  return WINDOW_LEAF_P (w) ? w->contents : Qnil;
589 590 591
}

DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
592
       doc: /* Return the parent window of window WINDOW.
593
WINDOW must be a valid window and defaults to the selected one.
594
Return nil for a window with no parent (e.g. a root window).  */)
595 596
  (Lisp_Object window)
{
597
  return decode_valid_window (window)->parent;
598 599
}

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

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

624
DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
625
       doc: /* Return the next sibling window of window WINDOW.
626
WINDOW must be a valid window and defaults to the selected one.
627
Return nil if WINDOW has no next sibling.  */)
628 629
  (Lisp_Object window)
{
630
  return decode_valid_window (window)->next;
631 632
}

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

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

652
  CHECK_VALID_WINDOW (window);
653
  w = XWINDOW (window);
654
  if (WINDOW_LEAF_P (w))
655
    error ("Combination limit is meaningful for internal windows only");
656
  return w->combination_limit;
Jim Blandy's avatar
Jim Blandy committed
657
}
658

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

  CHECK_VALID_WINDOW (window);
  w = XWINDOW (window);
672
  if (WINDOW_LEAF_P (w))
673 674
    error ("Combination limit is meaningful for internal windows only");
  wset_combination_limit (w, limit);
Paul Eggert's avatar
Paul Eggert committed
675
  return limit;
676
}
677

678
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
679
       doc: /* Return the use time of window WINDOW.
680
WINDOW must be a live window and defaults to the selected one.
681 682 683
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.  */)
684 685
  (Lisp_Object window)
{
686
  return make_number (decode_live_window (window)->use_time);
687
}
688

689 690
DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
       doc: /* Return the total height, in lines, of window WINDOW.
691
WINDOW must be a valid window and defaults to the selected one.
692

693 694 695
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.
696

697 698 699
On a graphical display, this total height is reported as an
integer multiple of the default character height.  */)
  (Lisp_Object window)
700
{
701
  return make_number (decode_valid_window (window)->total_lines);
702
}
703

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

708 709 710
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.
711

712 713
On a graphical display, this total width is reported as an
integer multiple of the default character width.  */)
714 715
  (Lisp_Object window)
{
716
  return make_number (decode_valid_window (window)->total_cols);
717
}
718

719
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
720
       doc: /* Return the new total size of window WINDOW.
721
WINDOW must be a valid window and defaults to the selected one.  */)
722 723
  (Lisp_Object window)
{
724
  return decode_valid_window (window)->new_total;
725 726 727
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
728
       doc: /* Return the normal height of window WINDOW.
729
WINDOW must be a valid window and defaults to the selected one.
730
If HORIZONTAL is non-nil, return the normal width of WINDOW.  */)
731 732
  (Lisp_Object window, Lisp_Object horizontal)
{
733
  struct window *w = decode_valid_window (window);
734 735

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
736 737 738
}

DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
739
       doc: /* Return new normal 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_normal;
744 745
}

746
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
747
       doc: /* Return left column of window WINDOW.
748 749 750 751
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.

752
WINDOW must be a valid window and defaults to the selected one.  */)
753 754
  (Lisp_Object window)
{
755
  return make_number (decode_valid_window (window)->left_col);
756 757 758
}

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
759
       doc: /* Return top line of window WINDOW.
760 761 762 763
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.

764
WINDOW must be a valid window and defaults to the selected one.  */)
765 766
  (Lisp_Object window)
{
767
  return make_number (decode_valid_window (window)->top_line);
768 769 770 771 772
}

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

773
static int
774 775
window_body_lines (struct window *w)
{
776
  int height = w->total_lines;
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797

  if (!MINI_WINDOW_P (w))
    {
      if (WINDOW_WANTS_MODELINE_P (w))
	--height;
      if (WINDOW_WANTS_HEADER_LINE_P (w))
	--height;
    }

  return height;
}

/* 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
window_body_cols (struct window *w)
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
798
  int width = w->total_cols;
799 800 801 802 803 804 805 806 807 808

  if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
    /* Scroll bars occupy a few columns.  */
    width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
  else if (!FRAME_WINDOW_P (f)
	   && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
    /* The column of `|' characters separating side-by-side windows
       occupies one column only.  */
    width -= 1;

809 810 811
  /* Display margins cannot be used for normal text.  */
  width -= WINDOW_LEFT_MARGIN_COLS (w) + WINDOW_RIGHT_MARGIN_COLS (w);

812
  if (FRAME_WINDOW_P (f))
813 814
    /* On window-systems, fringes cannot be used for normal text.  */
    width -= WINDOW_FRINGE_COLS (w);
815 816 817 818

  return width;
}

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

823 824 825 826 827 828
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 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)
829
{
830
  return make_number (window_body_lines (decode_live_window (window)));
831
}
832

833 834
DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 1, 0,
       doc: /* Return the width, in columns, of WINDOW's text area.
835
WINDOW must be a live window and defaults to the selected one.
836 837 838 839 840 841

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.  */)
  (Lisp_Object window)
{
842
  return make_number (window_body_cols (decode_live_window (window)));
843
}
844

Jim Blandy's avatar
Jim Blandy committed
845
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
846
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
847
WINDOW must be a live window and defaults to the selected one.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
848
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
849
{
850
  return make_number (decode_live_window (window)->hscroll);
Jim Blandy's avatar
Jim Blandy committed
851 852
}

853 854 855 856 857
/* 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)
{
858 859 860 861 862 863 864 865
  /* 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);
866 867 868

  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (w->hscroll != new_hscroll)
869
    XBUFFER (w->contents)->prevent_redisplay_optimizations_p = 1;
870 871 872 873 874

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

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

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
882
window so that the location of point moves off-window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
883
  (Lisp_Object window, Lisp_Object ncol)