window.c 220 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
#ifdef HAVE_XWIDGETS
Joakim Verona's avatar
Joakim Verona committed
56
#include "xwidget.h"
57
#endif
58

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
110 111 112 113 114
/* 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;

115 116 117
/* 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
118 119 120
   the selected window.  */
Lisp_Object minibuf_window;

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

125
/* Hook run at end of temp_output_buffer_show.  */
126
static Lisp_Object Qtemp_buffer_show_hook;
127

128 129 130
/* Nonzero after init_window_once has finished.  */
static int window_initialized;

131
/* Hook to run when window config changes.  */
132
static Lisp_Object Qwindow_configuration_change_hook;
133

134
/* Used by the function window_scroll_pixel_based */
135
static int window_scroll_pixel_based_preserve_x;
136
static int window_scroll_pixel_based_preserve_y;
137

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

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

227 228 229 230 231 232 233 234 235 236 237
/* 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));
}

238 239
struct window *
decode_live_window (register Lisp_Object window)
240 241 242
{
  if (NILP (window))
    return XWINDOW (selected_window);
243

244 245 246 247
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

248
struct window *
249 250
decode_any_window (register Lisp_Object window)
{
251 252
  struct window *w;

253 254 255 256
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
257 258
  w = XWINDOW (window);
  return w;
259
}
260

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

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

/* 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);
302 303 304 305 306
  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
307 308 309
  adjust_window_count (w, 1);
}

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

317 318 319 320 321 322 323 324 325
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;
}

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

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

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

  return window;
Jim Blandy's avatar
Jim Blandy committed
364 365
}

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

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

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

394
  if (NILP (frame_or_window))
395
    window = SELECTED_FRAME ()->root_window;
396
  else if (WINDOW_VALID_P (frame_or_window))
397
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
398 399 400
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
401
      window = XFRAME (frame_or_window)->root_window;
402
    }
Miles Bader's avatar
Miles Bader committed
403

404 405
  while (WINDOWP (XWINDOW (window)->contents))
    window = XWINDOW (window)->contents;
Jim Blandy's avatar
Jim Blandy committed
406

407 408
  return window;
}
409

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

  if (NILP (frame_or_window))
422
    window = SELECTED_FRAME ()->selected_window;
423
  else if (WINDOW_VALID_P (frame_or_window))
424
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
425
  else
426
    {
427
      CHECK_LIVE_FRAME (frame_or_window);
428
      window = XFRAME (frame_or_window)->selected_window;
429 430
    }

431
  return window;
Jim Blandy's avatar
Jim Blandy committed
432
}
433

434 435 436 437 438 439 440 441 442 443 444 445
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;
446

447 448
  CHECK_LIVE_FRAME (frame);
  CHECK_LIVE_WINDOW (window);
449

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

453 454 455
  if (EQ (frame, selected_frame))
    return Fselect_window (window, norecord);
  else
456 457 458 459
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
460 461 462 463 464 465 466
}

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)
467
{
468 469
  return selected_window;
}
470

471
int window_select_count;
472

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

484
  CHECK_LIVE_WINDOW (window);
485

486
  w = XWINDOW (window);
487

488
  /* Make the selected window's buffer current.  */
489
  Fset_buffer (w->contents);
490

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

  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
499
    {
500
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
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;
509
    }
510
  else
511
    fset_selected_window (sf, window);
512

513
  select_window_1 (window, inhibit_point_swap);
514 515
  bset_last_selected_window (XBUFFER (w->contents), window);
  windows_or_buffers_changed++;
516

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

527 528 529 530
  return window;
}

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

548
  selected_window = window;
549

550 551 552 553 554 555
  /* 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.  */
  {
556
    register ptrdiff_t new_point = marker_position (XWINDOW (window)->pointm);
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);
  }
564 565
}

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

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

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

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

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

615
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
616
       doc: /* Return the leftmost child window of window WINDOW.
617
WINDOW must be a valid window and defaults to the selected one.
618 619 620
Return nil if WINDOW is a live window (live windows have no children).
Return nil if WINDOW is an internal window whose children form a
vertical combination.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
621
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
622
{
623 624
  struct window *w = decode_valid_window (window);
  return WINDOW_HORIZONTAL_COMBINATION_P (w) ? w->contents : Qnil;
Jim Blandy's avatar
Jim Blandy committed
625 626
}

627
DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
628
       doc: /* Return the next 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 next sibling.  */)
631 632
  (Lisp_Object window)
{
633
  return decode_valid_window (window)->next;
634
}
635

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

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

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

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

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

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

696 697 698 699 700 701 702
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.

On a graphical display, this total height is reported as an
integer multiple of the default character height.  */)
  (Lisp_Object window)
703
{
704
  return make_number (decode_valid_window (window)->total_lines);
705 706 707 708
}

DEFUN ("window-total-width", Fwindow_total_width, Swindow_total_width, 0, 1, 0,
       doc: /* Return the total width, in columns, of window WINDOW.
709
WINDOW must be a valid window and defaults to the selected one.
710 711 712 713 714 715 716 717 718

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.

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

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

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

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
739 740 741
}

DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
742
       doc: /* Return new normal size of window WINDOW.
743
WINDOW must be a valid window and defaults to the selected one.  */)
744 745
  (Lisp_Object window)
{
746
  return decode_valid_window (window)->new_normal;
747 748
}

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

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

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

767
WINDOW must be a valid window and defaults to the selected one.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
768
  (Lisp_Object window)
769
{
770
  return make_number (decode_valid_window (window)->top_line);
771 772 773 774 775
}

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

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

  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));
801
  int width = w->total_cols;
802 803 804 805 806 807 808 809 810 811

  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;

812 813 814
  /* Display margins cannot be used for normal text.  */
  width -= WINDOW_LEFT_MARGIN_COLS (w) + WINDOW_RIGHT_MARGIN_COLS (w);

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

  return width;
}

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

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

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

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)
{
845
  return make_number (window_body_cols (decode_live_window (window)));
846 847
}

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

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

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

  w->hscroll = new_hscroll;
  return make_number (new_hscroll);
Jim Blandy's avatar
Jim Blandy committed
876 877 878
}

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

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
885
window so that the location of point moves off-window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
886
  (Lisp_Object window, Lisp_Object ncol)
Jim Blandy's avatar
Jim Blandy committed
887
{
888
  CHECK_NUMBER (ncol);
889
  return set_window_hscroll (decode_live_window (window), XINT (ncol));
Jim Blandy's avatar
Jim Blandy committed
890 891
}

892 893
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
894
       doc: /* Return WINDOW's redisplay end trigger value.
895
WINDOW must be a live window and defaults to the selected one.
896
See `set-window-redisplay-end-trigger' for more information.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
897
  (Lisp_Object window)
898
{
899
  return decode_live_window (window)->redisplay_end_trigger;
900 901 902 903
}

DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
       Sset_window_redisplay_end_trigger, 2, 2, 0,
904
       doc: /* Set WINDOW's redisplay end trigger value to VALUE.
905 906 907 908 909 910
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
911
  (register Lisp_Object window, Lisp_Object value)
912
{
Paul Eggert's avatar
Paul Eggert committed
913 914
  wset_redisplay_end_trigger (decode_live_window (window), value);
  return value;
915 916
}

Jim Blandy's avatar
Jim Blandy committed
917
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
918
       doc: /* Return a list of the edge coordinates of WINDOW.
919 920 921 922 923 924 925 926 927 928 929
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
930
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
931
{
932
  register struct window *w = decode_valid_window (window);
Jim Blandy's avatar
Jim Blandy committed
933

934 935
  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
936 937
}

938 939
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
940 941 942 943
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.
944 945 946 947 948 949

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
950
  (Lisp_Object window)
951
{
952
  register struct window *w = decode_valid_window (window);