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;
Martin Rudalics's avatar
Martin Rudalics committed
58
static Lisp_Object Qwindow_configuration_p, Qrecord_window_buffer;
59
static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
Martin Rudalics's avatar
Martin Rudalics committed
60
static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
61
static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
62
static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
63
static Lisp_Object Qsafe, Qabove, Qbelow, Qwindow_size, Qclone_of;
Martin Rudalics's avatar
Martin Rudalics committed
64

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
119 120 121
/* Incremented for each window created.  */
static int sequence_number;

122 123 124
/* Nonzero after init_window_once has finished.  */
static int window_initialized;

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

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

132
/* Same for window_scroll_line_based.  */
133 134
static EMACS_INT window_scroll_preserve_hpos;
static EMACS_INT window_scroll_preserve_vpos;
135

Paul Eggert's avatar
Paul Eggert committed
136
/* These setters are used only in this file, so they can be private.  */
137
static void
Paul Eggert's avatar
Paul Eggert committed
138 139 140 141
wset_combination_limit (struct window *w, Lisp_Object val)
{
  w->combination_limit = val;
}
142
static void
Paul Eggert's avatar
Paul Eggert committed
143 144 145 146
wset_dedicated (struct window *w, Lisp_Object val)
{
  w->dedicated = val;
}
147
static void
Paul Eggert's avatar
Paul Eggert committed
148 149 150 151
wset_display_table (struct window *w, Lisp_Object val)
{
  w->display_table = val;
}
152
static void
Paul Eggert's avatar
Paul Eggert committed
153 154 155 156
wset_hchild (struct window *w, Lisp_Object val)
{
  w->hchild = val;
}
157
static void
Paul Eggert's avatar
Paul Eggert committed
158 159 160 161
wset_left_fringe_width (struct window *w, Lisp_Object val)
{
  w->left_fringe_width = val;
}
162
static void
Paul Eggert's avatar
Paul Eggert committed
163 164 165 166
wset_left_margin_cols (struct window *w, Lisp_Object val)
{
  w->left_margin_cols = val;
}
167
static void
Paul Eggert's avatar
Paul Eggert committed
168 169 170 171
wset_new_normal (struct window *w, Lisp_Object val)
{
  w->new_normal = val;
}
172
static void
Paul Eggert's avatar
Paul Eggert committed
173 174 175 176
wset_new_total (struct window *w, Lisp_Object val)
{
  w->new_total = val;
}
177
static void
Paul Eggert's avatar
Paul Eggert committed
178 179 180 181
wset_normal_cols (struct window *w, Lisp_Object val)
{
  w->normal_cols = val;
}
182
static void
Paul Eggert's avatar
Paul Eggert committed
183 184 185 186
wset_normal_lines (struct window *w, Lisp_Object val)
{
  w->normal_lines = val;
}
187
static void
Paul Eggert's avatar
Paul Eggert committed
188 189 190 191
wset_parent (struct window *w, Lisp_Object val)
{
  w->parent = val;
}
192
static void
Paul Eggert's avatar
Paul Eggert committed
193 194 195 196
wset_pointm (struct window *w, Lisp_Object val)
{
  w->pointm = val;
}
197
static void
Paul Eggert's avatar
Paul Eggert committed
198 199 200 201
wset_right_fringe_width (struct window *w, Lisp_Object val)
{
  w->right_fringe_width = val;
}
202
static void
Paul Eggert's avatar
Paul Eggert committed
203 204 205 206
wset_right_margin_cols (struct window *w, Lisp_Object val)
{
  w->right_margin_cols = val;
}
207
static void
Paul Eggert's avatar
Paul Eggert committed
208 209 210 211
wset_scroll_bar_width (struct window *w, Lisp_Object val)
{
  w->scroll_bar_width = val;
}
212
static void
Paul Eggert's avatar
Paul Eggert committed
213 214 215 216
wset_start (struct window *w, Lisp_Object val)
{
  w->start = val;
}
217
static void
Paul Eggert's avatar
Paul Eggert committed
218 219 220 221
wset_temslot (struct window *w, Lisp_Object val)
{
  w->temslot = val;
}
222
static void
Paul Eggert's avatar
Paul Eggert committed
223 224 225 226
wset_vchild (struct window *w, Lisp_Object val)
{
  w->vchild = val;
}
227
static void
Paul Eggert's avatar
Paul Eggert committed
228 229 230 231
wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
{
  w->vertical_scroll_bar_type = val;
}
232
static void
Paul Eggert's avatar
Paul Eggert committed
233 234 235 236 237
wset_window_parameters (struct window *w, Lisp_Object val)
{
  w->window_parameters = val;
}

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 281 282 283
/* 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);
  if (BUFFERP (w->buffer))
    {
      struct buffer *b = XBUFFER (w->buffer);
Paul Eggert's avatar
Paul Eggert committed
284

Dmitry Antipov's avatar
Dmitry Antipov committed
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
      if (b->base_buffer)
	b = b->base_buffer;
      b->window_count += arg;
      eassert (b->window_count >= 0);
    }
}

/* 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);
  w->buffer = val;
  adjust_window_count (w, 1);
}

303 304 305
/* Build a frequently used 4-integer (X Y W H) list.  */

static Lisp_Object
306
list4i (EMACS_INT x, EMACS_INT y, EMACS_INT w, EMACS_INT h)
307 308 309 310 311
{
  return list4 (make_number (x), make_number (y),
		make_number (w), make_number (h));
}

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

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

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

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

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

  return window;
}

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

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

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

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

406
  while (NILP (XWINDOW (window)->buffer))
407
    {
408 409 410 411
      if (! NILP (XWINDOW (window)->hchild))
	window = XWINDOW (window)->hchild;
      else if (! NILP (XWINDOW (window)->vchild))
	window = XWINDOW (window)->vchild;
412
      else
413
	emacs_abort ();
414 415 416 417 418 419 420
    }

  return window;
}

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

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

  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
465 466 467 468
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
469 470 471 472 473 474 475 476 477 478 479
}

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

480 481
int window_select_count;

482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
/* If select_window is called with inhibit_point_swap non-zero it will
   not store point of the old selected window's buffer back into that
   window's pointm slot.  This is needed by Fset_window_configuration to
   avoid that the display routine is called with selected_window set to
   Qnil causing a subsequent crash.  */
static Lisp_Object
select_window (Lisp_Object window, Lisp_Object norecord, int inhibit_point_swap)
{
  register struct window *w;
  struct frame *sf;

  CHECK_LIVE_WINDOW (window);

  w = XWINDOW (window);
  w->frozen_window_start_p = 0;

  if (NILP (norecord))
    {
500
      w->use_time = ++window_select_count;
501
      record_buffer (w->buffer);
502 503
    }

504 505 506
  /* Make the selected window's buffer current.  */
  Fset_buffer (w->buffer);

507 508 509 510 511 512
  if (EQ (window, selected_window) && !inhibit_point_swap)
    return window;

  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
    {
513
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
514 515 516 517 518 519 520 521 522 523
      /* 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
524
    fset_selected_window (sf, window);
525

526 527 528 529 530 531 532 533
  select_window_1 (window, inhibit_point_swap);

  bset_last_selected_window (XBUFFER (w->buffer), window);
  windows_or_buffers_changed++;
  return window;
}

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

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

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

580 581 582 583 584 585 586
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);
}

587
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
588 589 590
       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.  */)
591 592
  (Lisp_Object window)
{
593
  return decode_any_window (window)->buffer;
594 595 596
}

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

605
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
606
       doc: /* Return the topmost child window of window WINDOW.
607
WINDOW must be a valid window and defaults to the selected one.
608 609 610
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.  */)
611 612
  (Lisp_Object window)
{
613
  return decode_valid_window (window)->vchild;
614 615
}

616
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
617
       doc: /* Return the leftmost child window of window WINDOW.
618
WINDOW must be a valid window and defaults to the selected one.
619 620 621
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.  */)
622 623
  (Lisp_Object window)
{
624
  return decode_valid_window (window)->hchild;
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
If the return value is nil, child windows of WINDOW can be recombined with
648
WINDOW's siblings.  A return value of t means that child windows of
649 650 651 652
WINDOW are never \(re-)combined with WINDOW's siblings.

WINDOW must be a valid window.  The return value is meaningful for
internal windows only.  */)
653
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
654
{
655 656
  CHECK_VALID_WINDOW (window);
  return XWINDOW (window)->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 662 663
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
664 665 666 667
future use.

WINDOW must be a valid window.  Setting the combination limit is
meaningful for internal windows only.  */)
668
  (Lisp_Object window, Lisp_Object limit)
669
{
Paul Eggert's avatar
Paul Eggert committed
670 671
  wset_combination_limit (decode_valid_window (window), limit);
  return limit;
672
}
673

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

689 690 691
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.
692

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

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

704 705 706
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.
707

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

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

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

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
732 733 734
}

DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
735
       doc: /* Return new normal size of window WINDOW.
736
WINDOW must be a valid window and defaults to the selected one.  */)
737 738
  (Lisp_Object window)
{
739
  return decode_valid_window (window)->new_normal;
740 741
}

742
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
743
       doc: /* Return left column of window WINDOW.
744 745 746 747
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.

748
WINDOW must be a valid window and defaults to the selected one.  */)
749 750
  (Lisp_Object window)
{
751
  return decode_valid_window (window)->left_col;
752 753 754
}

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
755
       doc: /* Return top line of window WINDOW.
756 757 758 759
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.

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

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

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

  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));
794
  int width = XINT (w->total_cols);
795 796 797 798 799 800 801 802 803 804

  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;

805 806 807
  /* Display margins cannot be used for normal text.  */
  width -= WINDOW_LEFT_MARGIN_COLS (w) + WINDOW_RIGHT_MARGIN_COLS (w);

808
  if (FRAME_WINDOW_P (f))
809 810
    /* On window-systems, fringes cannot be used for normal text.  */
    width -= WINDOW_FRINGE_COLS (w);
811 812 813 814

  return width;
}

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

819 820 821 822 823 824
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)
825
{
826
  return make_number (window_body_lines (decode_live_window (window)));
827
}
828

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

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)
{
838
  return make_number (window_body_cols (decode_live_window (window)));
839
}
840

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

849 850 851 852 853
/* 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)
{
854 855 856 857 858 859 860 861
  /* 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);
862 863 864

  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (w->hscroll != new_hscroll)
865
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
866 867 868 869 870

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

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

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
878
window so that the location of point moves off-window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
879
  (Lisp_Object window, Lisp_Object ncol)
Jim Blandy's avatar
Jim Blandy committed
880
{
881
  CHECK_NUMBER (ncol);
882
  return set_window_hscroll (decode_live_window (window), XINT (ncol));
Jim Blandy's avatar
Jim Blandy committed
883 884
}

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

DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
       Sset_window_redisplay_end_trigger, 2, 2, 0,
897
       doc: /* Set WINDOW's redisplay end trigger value to VALUE.
898 899 900 901 902 903
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
904
  (register Lisp_Object window, Lisp_Object value)
905
{
Paul Eggert's avatar
Paul Eggert committed
906 907
  wset_redisplay_end_trigger (decode_live_window (window), value);
  return value;
908 909
}

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

927 928
  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
929 930
}

931 932
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
933 934 935 936
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.
937 938 939 940 941 942

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
943
  (Lisp_Object window)
944
{
945
  register struct window *w = decode_valid_window (window);
946

947 948
  return list4i (WINDOW_LEFT_EDGE_X (w), WINDOW_TOP_EDGE_Y (w),
		 WINDOW_RIGHT_EDGE_X (w), WINDOW_BOTTOM_EDGE_Y (w));
949 950
}

951
static void
Juanma Barranquero's avatar
Juanma Barranquero committed
952
calc_absolute_offset (struct window *w, int *add_x, int *add_y)
953
{
954
  struct frame *f = XFRAME (w->frame);
955 956 957 958
  *add_y = f->top_pos;
#ifdef FRAME_MENUBAR_HEIGHT
  *add_y += FRAME_MENUBAR_HEIGHT (f);
#endif
959 960 961
#ifdef FRAME_TOOLBAR_TOP_HEIGHT
  *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
#elif FRAME_TOOLBAR_HEIGHT
962 963 964 965 966 967
  *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;
968 969 970
#ifdef FRAME_TOOLBAR_LEFT_WIDTH
  *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
#endif
971 972 973 974 975
}

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.
976 977 978 979
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.
980 981 982 983 984

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
985
of just the text area, use `window-inside-absolute-pixel-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
986
  (Lisp_Object window)
987
{
988
  register struct window *w = decode_valid_window (window);
989
  int add_x, add_y;
990

991
  calc_absolute_offset (w, &add_x, &add_y);
992

993 994 995 996
  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);
997 998
}

999 1000
DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
       doc: /* Return a list of the edge coordinates of WINDOW.
1001 1002 1003 1004 1005
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.
1006 1007

RIGHT is one more than the rightmost column of WINDOW's text area.
1008 1009 1010
BOTTOM is one more than the bottommost row of WINDOW's text area.  The
inside edges do not include the space used by the WINDOW's scroll bar,
display margins, fringes, header line, and/or mode line.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1011
  (Lisp_Object window)
1012
{
1013
  register struct window *w = decode_live_window (window);
1014

1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
  return list4i ((WINDOW_BOX_LEFT_EDGE_COL (w)
		  + WINDOW_LEFT_MARGIN_COLS (w)
		  + WINDOW_LEFT_FRINGE_COLS (w)),
		 (WINDOW_TOP_EDGE_LINE (w)
		  + WINDOW_HEADER_LINE_LINES (w)),
		 (WINDOW_BOX_RIGHT_EDGE_COL (w)
		  - WINDOW_RIGHT_MARGIN_COLS (w)
		  - WINDOW_RIGHT_FRINGE_COLS (w)),
		 (WINDOW_BOTTOM_EDGE_LINE (w)
		  - WINDOW_MODE_LINE_LINES (w)));
1025 1026 1027
}

DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
1028
       doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
1029 1030 1031 1032
WINDOW must be a live 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's window area.
1033 1034 1035 1036

RIGHT is one more than the rightmost x position of WINDOW's text area.
BOTTOM is one more than the bottommost y position of WINDOW's text area.
The inside edges do not include the space used by WINDOW's scroll bar,
1037
display margins, fringes, header line, and/or mode line.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1038
  (Lisp_Object window)