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

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

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

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

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

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

118 119 120
/* Nonzero after init_window_once has finished.  */
static int window_initialized;

121
/* Hook to run when window config changes.  */
122
static Lisp_Object Qwindow_configuration_change_hook;
123

124
/* Used by the function window_scroll_pixel_based */
125
static int window_scroll_pixel_based_preserve_x;
126
static int window_scroll_pixel_based_preserve_y;
127

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

Paul Eggert's avatar
Paul Eggert committed
138
/* These setters are used only in this file, so they can be private.  */
139
static void
Paul Eggert's avatar
Paul Eggert committed
140 141 142 143
wset_combination_limit (struct window *w, Lisp_Object val)
{
  w->combination_limit = val;
}
144
static void
Paul Eggert's avatar
Paul Eggert committed
145 146 147 148
wset_dedicated (struct window *w, Lisp_Object val)
{
  w->dedicated = val;
}
149
static void
Paul Eggert's avatar
Paul Eggert committed
150 151 152 153
wset_display_table (struct window *w, Lisp_Object val)
{
  w->display_table = val;
}
154
static void
Paul Eggert's avatar
Paul Eggert committed
155 156 157 158
wset_left_fringe_width (struct window *w, Lisp_Object val)
{
  w->left_fringe_width = val;
}
159
static void
Paul Eggert's avatar
Paul Eggert committed
160 161 162 163
wset_left_margin_cols (struct window *w, Lisp_Object val)
{
  w->left_margin_cols = 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_right_fringe_width (struct window *w, Lisp_Object val)
{
  w->right_fringe_width = val;
}
199
static void
Paul Eggert's avatar
Paul Eggert committed
200 201 202 203
wset_right_margin_cols (struct window *w, Lisp_Object val)
{
  w->right_margin_cols = val;
}
204
static void
Paul Eggert's avatar
Paul Eggert committed
205 206 207 208
wset_scroll_bar_width (struct window *w, Lisp_Object val)
{
  w->scroll_bar_width = val;
}
209
static void
Paul Eggert's avatar
Paul Eggert committed
210 211 212 213
wset_start (struct window *w, Lisp_Object val)
{
  w->start = val;
}
214
static void
Paul Eggert's avatar
Paul Eggert committed
215 216 217 218
wset_temslot (struct window *w, Lisp_Object val)
{
  w->temslot = val;
}
219
static void
Paul Eggert's avatar
Paul Eggert committed
220 221 222 223
wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
{
  w->vertical_scroll_bar_type = val;
}
224
static void
Paul Eggert's avatar
Paul Eggert committed
225 226 227 228
wset_window_parameters (struct window *w, Lisp_Object val)
{
  w->window_parameters = val;
}
229 230 231 232 233 234 235 236 237 238 239 240
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
241

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

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

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

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

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

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

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

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

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

321 322 323 324 325 326 327 328 329
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;
}

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

DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
349 350
       doc: /* Return the root window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
351 352
With a frame argument, return that frame's root window.
With a window argument, return the root window of that window's frame.  */)
353 354 355 356 357
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
358
    window = SELECTED_FRAME ()->root_window;
359 360
  else if (WINDOW_VALID_P (frame_or_window))
      window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
361 362 363
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
364
      window = XFRAME (frame_or_window)->root_window;
365 366 367 368 369 370
    }

  return window;
}

DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
371 372
       doc: /* Return the minibuffer window for frame FRAME.
If FRAME is omitted or nil, it defaults to the selected frame.  */)
373 374
  (Lisp_Object frame)
{
375
  return FRAME_MINIBUF_WINDOW (decode_live_frame (frame));
376 377 378 379 380
}

DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
       Swindow_minibuffer_p, 0, 1, 0,
       doc: /* Return non-nil if WINDOW is a minibuffer window.
381
WINDOW must be a valid window and defaults to the selected one.  */)
382 383
  (Lisp_Object window)
{
384
  return MINI_WINDOW_P (decode_valid_window (window)) ? Qt : Qnil;
385 386 387 388
}

/* 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,
389 390
       doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
391 392
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
393 394 395 396 397 398
the first window of that frame.  */)
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
399
    window = SELECTED_FRAME ()->root_window;
400
  else if (WINDOW_VALID_P (frame_or_window))
401
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
402 403 404
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
405
      window = XFRAME (frame_or_window)->root_window;
406 407
    }

408 409
  while (WINDOWP (XWINDOW (window)->contents))
    window = XWINDOW (window)->contents;
410 411 412 413 414 415

  return window;
}

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

  if (NILP (frame_or_window))
426
    window = SELECTED_FRAME ()->selected_window;
427
  else if (WINDOW_VALID_P (frame_or_window))
428
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
429 430 431
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
432
      window = XFRAME (frame_or_window)->selected_window;
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
    }

  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
460 461 462 463
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
464 465 466 467 468 469 470 471 472 473 474
}

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

475 476
int window_select_count;

477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
/* 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);
  w->frozen_window_start_p = 0;

493
  /* Make the selected window's buffer current.  */
494
  Fset_buffer (w->contents);
495

496
  if (EQ (window, selected_window) && !inhibit_point_swap)
497 498 499 500
    /* `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;
501 502 503 504

  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
    {
505
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
506 507 508 509 510 511 512 513 514 515
      /* 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
516
    fset_selected_window (sf, window);
517

518
  select_window_1 (window, inhibit_point_swap);
519 520
  bset_last_selected_window (XBUFFER (w->contents), window);
  windows_or_buffers_changed++;
521

522
 record_and_return:
523 524 525 526 527 528 529 530 531
  /* 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);
    }

532 533 534 535
  return window;
}

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

  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.  */
  {
561
    register ptrdiff_t new_point = marker_position (XWINDOW (window)->pointm);
562 563 564 565 566 567 568 569 570 571
    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,
572 573 574 575 576
       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.
577 578 579 580

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

582 583 584 585 586 587 588
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);
}

589
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
590 591 592
       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.  */)
593 594
  (Lisp_Object window)
{
595 596
  struct window *w = decode_any_window (window);
  return WINDOW_LEAF_P (w) ? w->contents : Qnil;
597 598 599
}

DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
600
       doc: /* Return the parent window of window WINDOW.
601
WINDOW must be a valid window and defaults to the selected one.
602
Return nil for a window with no parent (e.g. a root window).  */)
603 604
  (Lisp_Object window)
{
605
  return decode_valid_window (window)->parent;
606 607
}

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

620
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
621
       doc: /* Return the leftmost child window of window WINDOW.
622
WINDOW must be a valid window and defaults to the selected one.
623 624 625
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.  */)
626 627
  (Lisp_Object window)
{
628 629
  struct window *w = decode_valid_window (window);
  return WINDOW_HORIZONTAL_COMBINATION_P (w) ? w->contents : Qnil;
630 631
}

632
DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
633
       doc: /* Return the next sibling window of window WINDOW.
634
WINDOW must be a valid window and defaults to the selected one.
635
Return nil if WINDOW has no next sibling.  */)
636 637
  (Lisp_Object window)
{
638
  return decode_valid_window (window)->next;
639 640
}

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

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

660
  CHECK_VALID_WINDOW (window);
661
  w = XWINDOW (window);
662
  if (WINDOW_LEAF_P (w))
663
    error ("Combination limit is meaningful for internal windows only");
664
  return w->combination_limit;
Jim Blandy's avatar
Jim Blandy committed
665
}
666

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

  CHECK_VALID_WINDOW (window);
  w = XWINDOW (window);
680
  if (WINDOW_LEAF_P (w))
681 682
    error ("Combination limit is meaningful for internal windows only");
  wset_combination_limit (w, limit);
Paul Eggert's avatar
Paul Eggert committed
683
  return limit;
684
}
685

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

701 702 703
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.
704

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

712 713
DEFUN ("window-total-width", Fwindow_total_width, Swindow_total_width, 0, 1, 0,
       doc: /* Return the total width, in columns, of window WINDOW.
714
WINDOW must be a valid window and defaults to the selected one.
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.
719

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

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

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

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
744 745 746
}

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

754
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
755
       doc: /* Return left column of window WINDOW.
756 757 758 759
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.

760
WINDOW must be a valid window and defaults to the selected one.  */)
761 762
  (Lisp_Object window)
{
763
  return make_number (decode_valid_window (window)->left_col);
764 765 766
}

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
767
       doc: /* Return top line of window WINDOW.
768 769 770 771
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.

772
WINDOW must be a valid window and defaults to the selected one.  */)
773 774
  (Lisp_Object window)
{
775
  return make_number (decode_valid_window (window)->top_line);
776 777 778 779 780
}

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

781
static int
782 783
window_body_lines (struct window *w)
{
784
  int height = w->total_lines;
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805

  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));
806
  int width = w->total_cols;
807 808 809 810 811 812 813 814 815 816

  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;

817 818 819
  /* Display margins cannot be used for normal text.  */
  width -= WINDOW_LEFT_MARGIN_COLS (w) + WINDOW_RIGHT_MARGIN_COLS (w);

820
  if (FRAME_WINDOW_P (f))
821 822
    /* On window-systems, fringes cannot be used for normal text.  */
    width -= WINDOW_FRINGE_COLS (w);
823 824 825 826

  return width;
}

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

831 832 833 834 835 836
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)
837
{
838
  return make_number (window_body_lines (decode_live_window (window)));
839
}
840

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

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)
{
850
  return make_number (window_body_cols (decode_live_window (window)));
851
}
852

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

861 862 863 864 865
/* 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)
{
866 867 868 869 870 871 872 873
  /* 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);
874 875 876

  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (w->hscroll != new_hscroll)
877
    XBUFFER (w->contents)->prevent_redisplay_optimizations_p = 1;
878 879 880 881 882

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

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

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

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

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

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

939 940
  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
941 942
}

943 944
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
945 946 947 948
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.
949 950 951 952 953 954

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
955
  (Lisp_Object window)
956
{
957
  register struct window *w = decode_valid_window (window);
958

959 960
  return list4i (WINDOW_LEFT_EDGE_X (w), WINDOW_TOP_EDGE_Y (w),
		 WINDOW_RIGHT_EDGE_X (w), WINDOW_BOTTOM_EDGE_Y (w));
961 962
}

963
static void
Juanma Barranquero's avatar
Juanma Barranquero committed
964
calc_absolute_offset (struct window *w, int *add_x, int *add_y)
965
{
966
  struct frame *f = XFRAME (w->frame);
967 968 969 970
  *add_y = f->top_pos;
#ifdef FRAME_MENUBAR_HEIGHT
  *add_y += FRAME_MENUBAR_HEIGHT (f);
#endif
971 972 973
#ifdef FRAME_TOOLBAR_TOP_HEIGHT
  *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
#elif FRAME_TOOLBAR_HEIGHT
974 975 976 977 978 979
  *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;
980 981 982
#ifdef FRAME_TOOLBAR_LEFT_WIDTH
  *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
#endif
983 984 985 986 987
}

DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
       Swindow_absolute_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
988 989 990 991
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 display.
992 993 994 995 996

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
997
of just the text area, use `window-inside-absolute-pixel-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
998
  (Lisp_Object window)
999
{
1000
  register struct window *w = decode_valid_window (window);
1001
  int add_x, add_y;
1002

1003
  calc_absolute_offset (w, &add_x, &add_y);
1004

1005 1006 1007 1008
  return list4i (WINDOW_LEFT_EDGE_X (w) + add_x,
		 WINDOW_TOP_EDGE_Y (w) + add_y,
		 WINDOW_RIGHT_EDGE_X (w) + add_x,
		 WINDOW_BOTTOM_EDGE_Y (w) + add_y);
1009 1010
}

1011 1012
DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
       doc: /* Return a list of the edge coordinates of WINDOW.
1013 1014 1015 1016 1017
WINDOW must be a live 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.
1018 1019

RIGHT is one more than the rightmost column of WINDOW's text area.
Martin Rudalics's avatar