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

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 *, bool);
static void window_resize_apply (struct window *, bool);
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

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

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

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

129
/* Same for window_scroll_line_based.  */
130 131
static EMACS_INT window_scroll_preserve_hpos;
static EMACS_INT window_scroll_preserve_vpos;
132

Paul Eggert's avatar
Paul Eggert committed
133
/* These setters are used only in this file, so they can be private.  */
134
static void
Paul Eggert's avatar
Paul Eggert committed
135 136 137 138
wset_combination_limit (struct window *w, Lisp_Object val)
{
  w->combination_limit = val;
}
139
static void
Paul Eggert's avatar
Paul Eggert committed
140 141 142 143
wset_dedicated (struct window *w, Lisp_Object val)
{
  w->dedicated = val;
}
144
static void
Paul Eggert's avatar
Paul Eggert committed
145 146 147 148
wset_display_table (struct window *w, Lisp_Object val)
{
  w->display_table = val;
}
149
static void
Paul Eggert's avatar
Paul Eggert committed
150 151 152 153
wset_hchild (struct window *w, Lisp_Object val)
{
  w->hchild = 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_vchild (struct window *w, Lisp_Object val)
{
  w->vchild = val;
}
224
static void
Paul Eggert's avatar
Paul Eggert committed
225 226 227 228
wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
{
  w->vertical_scroll_bar_type = val;
}
229
static void
Paul Eggert's avatar
Paul Eggert committed
230 231 232 233 234
wset_window_parameters (struct window *w, Lisp_Object val)
{
  w->window_parameters = val;
}

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

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

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

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

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

Paul Eggert's avatar
Paul Eggert committed
258
static struct window *
259 260 261 262 263 264 265 266 267 268 269 270
decode_valid_window (register Lisp_Object window)
{
  struct window *w;

  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_VALID_WINDOW (window);
  w = XWINDOW (window);
  return w;
}

Dmitry Antipov's avatar
Dmitry Antipov committed
271 272 273 274 275 276 277 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);
  if (BUFFERP (w->buffer))
    {
      struct buffer *b = XBUFFER (w->buffer);
Paul Eggert's avatar
Paul Eggert committed
281

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

/* 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);
}

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

310 311 312 313 314 315 316 317 318
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;
}

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

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

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

  return window;
}

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

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

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

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

397
  while (NILP (XWINDOW (window)->buffer))
398
    {
399 400 401 402
      if (! NILP (XWINDOW (window)->hchild))
	window = XWINDOW (window)->hchild;
      else if (! NILP (XWINDOW (window)->vchild))
	window = XWINDOW (window)->vchild;
403
      else
404
	emacs_abort ();
405 406 407 408 409 410 411
    }

  return window;
}

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 426 427
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
428
      window = XFRAME (frame_or_window)->selected_window;
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
    }

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

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

471 472
int window_select_count;

473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
/* 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))
    {
491
      w->use_time = ++window_select_count;
492
      record_buffer (w->buffer);
493 494
    }

495 496 497
  /* Make the selected window's buffer current.  */
  Fset_buffer (w->buffer);

498 499 500 501 502 503
  if (EQ (window, selected_window) && !inhibit_point_swap)
    return window;

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

517 518 519 520 521 522 523 524
  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
525
   (not even for redisplay's benefit), and assume that the window's frame is
526
   already selected.  */
527
static void
528 529
select_window_1 (Lisp_Object window, bool inhibit_point_swap)
{
530 531 532
  /* 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.  */
533 534
  if (!inhibit_point_swap)
    {
535
      struct window *ow = XWINDOW (selected_window);
536 537 538 539
      if (! NILP (ow->buffer))
	set_marker_both (ow->pointm, ow->buffer,
			 BUF_PT (XBUFFER (ow->buffer)),
			 BUF_PT_BYTE (XBUFFER (ow->buffer)));
540 541 542 543 544 545 546 547 548 549
    }

  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.  */
  {
550
    register ptrdiff_t new_point = marker_position (XWINDOW (window)->pointm);
551 552 553 554 555 556 557 558 559 560
    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,
561 562 563 564 565
       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.
566 567 568 569

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

571 572 573 574 575 576 577
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);
}

578
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
579 580 581
       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.  */)
582 583
  (Lisp_Object window)
{
584
  return decode_any_window (window)->buffer;
585 586 587
}

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

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

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

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

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

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

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

653
DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
654
       doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
655
WINDOW must be a valid window used in horizontal or vertical combination.
656 657 658
If LIMIT is nil, child windows of WINDOW can be recombined with WINDOW's
siblings.  LIMIT t means that child windows of WINDOW are never
\(re-)combined with WINDOW's siblings.  Other values are reserved for
659
future use.  */)
660
  (Lisp_Object window, Lisp_Object limit)
661
{
662 663 664 665 666 667 668
  struct window *w;

  CHECK_VALID_WINDOW (window);
  w = XWINDOW (window);
  if (!NILP (w->buffer))
    error ("Combination limit is meaningful for internal windows only");
  wset_combination_limit (w, limit);
Paul Eggert's avatar
Paul Eggert committed
669
  return limit;
670
}
671

672
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
673
       doc: /* Return the use time of window WINDOW.
674
WINDOW must be a live window and defaults to the selected one.
675 676 677
The window with the highest use time is the most recently selected
one.  The window with the lowest use time is the least recently
selected one.  */)
678 679
  (Lisp_Object window)
{
680
  return make_number (decode_live_window (window)->use_time);
681
}
682

683 684
DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
       doc: /* Return the total height, in lines, of window WINDOW.
685
WINDOW must be a valid window and defaults to the selected one.
686

687 688 689
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.
690

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

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

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

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

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

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

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
730 731 732
}

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

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

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

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

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

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

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

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

  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;

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

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

  return width;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

925 926
  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
927 928
}

929 930
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
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), all relative to
0, 0 at the top left corner of the frame.
935 936 937 938 939 940

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

945 946
  return list4i (WINDOW_LEFT_EDGE_X (w), WINDOW_TOP_EDGE_Y (w),
		 WINDOW_RIGHT_EDGE_X (w), WINDOW_BOTTOM_EDGE_Y (w));
947 948
}

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

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

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

989
  calc_absolute_offset (w, &add_x, &add_y);
990

991 992 993 994
  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);
995 996
}

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

RIGHT is one more than the rightmost column of WINDOW's text area.
1006 1007 1008
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
1009
  (Lisp_Object window)
1010
{
1011
  register struct window *w = decode_live_window (window);
1012

1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
  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)));
1023 1024 1025
}

DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
1026
       doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
1027