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
   Copyright (C) 1985-1987, 1993-1998, 2000-2012
Glenn Morris's avatar
Glenn Morris committed
4
                 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

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

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

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

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

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

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

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

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

static struct window *
decode_any_window (register Lisp_Object window)
{
250 251
  struct window *w;

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

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

Paul Eggert's avatar
Paul Eggert committed
260
static struct window *
261 262 263 264 265 266 267 268 269 270 271 272
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;
}

Jim Blandy's avatar
Jim Blandy committed
273
DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
274
       doc: /* Return t if OBJECT is a window and nil otherwise.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
275
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
276
{
277
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
278 279
}

280 281 282 283 284 285 286 287 288
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;
}

289
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
290
       doc: /* Return t if OBJECT is a live window and nil otherwise.
291 292
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
293
  (Lisp_Object object)
294
{
295
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
296
}
297 298 299 300

/* Frames and windows.  */
DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 1, 1, 0,
       doc: /* Return the frame that window WINDOW is on.
301
WINDOW must be a valid window and defaults to the selected one.  */)
302 303
  (Lisp_Object window)
{
304
  return decode_valid_window (window)->frame;
305 306 307
}

DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
308 309
       doc: /* Return the root window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
310 311
With a frame argument, return that frame's root window.
With a window argument, return the root window of that window's frame.  */)
312 313 314 315 316
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
317
    window = SELECTED_FRAME ()->root_window;
318 319
  else if (WINDOW_VALID_P (frame_or_window))
      window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
320 321 322
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
323
      window = XFRAME (frame_or_window)->root_window;
324 325 326 327 328 329
    }

  return window;
}

DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
330 331
       doc: /* Return the minibuffer window for frame FRAME.
If FRAME is omitted or nil, it defaults to the selected frame.  */)
332 333 334 335 336 337 338 339 340 341 342
  (Lisp_Object frame)
{
  if (NILP (frame))
    frame = selected_frame;
  CHECK_LIVE_FRAME (frame);
  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
}

DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
       Swindow_minibuffer_p, 0, 1, 0,
       doc: /* Return non-nil if WINDOW is a minibuffer window.
343
WINDOW must be a valid window and defaults to the selected one.  */)
344 345
  (Lisp_Object window)
{
346
  return MINI_WINDOW_P (decode_valid_window (window)) ? Qt : Qnil;
347 348 349 350
}

/* 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,
351 352
       doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
353 354
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
355 356 357 358 359 360
the first window of that frame.  */)
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

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

370
  while (NILP (XWINDOW (window)->buffer))
371
    {
372 373 374 375
      if (! NILP (XWINDOW (window)->hchild))
	window = XWINDOW (window)->hchild;
      else if (! NILP (XWINDOW (window)->vchild))
	window = XWINDOW (window)->vchild;
376
      else
377
	emacs_abort ();
378 379 380 381 382 383 384
    }

  return window;
}

DEFUN ("frame-selected-window", Fframe_selected_window,
       Sframe_selected_window, 0, 1, 0,
385 386
       doc: /* Return the selected window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
387 388 389
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.  */)
390 391 392 393 394
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
395
    window = SELECTED_FRAME ()->selected_window;
396
  else if (WINDOW_VALID_P (frame_or_window))
397
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
398 399 400
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
401
      window = XFRAME (frame_or_window)->selected_window;
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
    }

  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
429 430 431 432
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
433 434 435 436 437 438 439 440 441 442 443
}

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

444 445
int window_select_count;

446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
/* 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;
  register struct window *ow;
  struct frame *sf;

  CHECK_LIVE_WINDOW (window);

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

  if (NILP (norecord))
    {
465
      w->use_time = ++window_select_count;
466
      record_buffer (w->buffer);
467 468
    }

469 470 471
  /* Make the selected window's buffer current.  */
  Fset_buffer (w->buffer);

472 473 474 475 476 477
  if (EQ (window, selected_window) && !inhibit_point_swap)
    return window;

  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
    {
478
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
479 480 481 482 483 484 485 486 487 488
      /* 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
489
    fset_selected_window (sf, window);
490

491 492 493
  /* 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.  */
494 495 496
  if (!inhibit_point_swap)
    {
      ow = XWINDOW (selected_window);
497 498 499 500
      if (! NILP (ow->buffer))
	set_marker_both (ow->pointm, ow->buffer,
			 BUF_PT (XBUFFER (ow->buffer)),
			 BUF_PT_BYTE (XBUFFER (ow->buffer)));
501 502 503
    }

  selected_window = window;
Paul Eggert's avatar
Paul Eggert committed
504
  bset_last_selected_window (XBUFFER (w->buffer), window);
505 506 507 508 509 510 511

  /* 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.  */
  {
512
    register ptrdiff_t new_point = marker_position (w->pointm);
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
    if (new_point < BEGV)
      SET_PT (BEGV);
    else if (new_point > ZV)
      SET_PT (ZV);
    else
      SET_PT (new_point);
  }

  windows_or_buffers_changed++;
  return window;
}

DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
       doc: /* Select WINDOW.  Most editing will apply to WINDOW's buffer.
Also make WINDOW's buffer current and make WINDOW the frame's selected
window.  Return WINDOW.

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

534 535 536 537 538 539 540
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);
}

541
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
542 543 544
       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.  */)
545 546
  (Lisp_Object window)
{
547
  return decode_any_window (window)->buffer;
548 549 550
}

DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
551
       doc: /* Return the parent window of window WINDOW.
552
WINDOW must be a valid window and defaults to the selected one.
553
Return nil for a window with no parent (e.g. a root window).  */)
554 555
  (Lisp_Object window)
{
556
  return decode_valid_window (window)->parent;
557 558
}

559 560
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 1, 1, 0,
       doc: /* Return the topmost child window of window WINDOW.
561
WINDOW must be a valid window and defaults to the selected one.
562 563 564
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.  */)
565 566
  (Lisp_Object window)
{
567
  CHECK_WINDOW (window);
568
  return decode_valid_window (window)->vchild;
569 570
}

571 572
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 1, 1, 0,
       doc: /* Return the leftmost child window of window WINDOW.
573
WINDOW must be a valid window and defaults to the selected one.
574 575 576
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.  */)
577 578
  (Lisp_Object window)
{
579
  CHECK_WINDOW (window);
580
  return decode_valid_window (window)->hchild;
581 582
}

583
DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
584
       doc: /* Return the next sibling window of window WINDOW.
585
WINDOW must be a valid window and defaults to the selected one.
586
Return nil if WINDOW has no next sibling.  */)
587 588
  (Lisp_Object window)
{
589
  return decode_valid_window (window)->next;
590 591
}

592
DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
593
       doc: /* Return the previous sibling window of window WINDOW.
594
WINDOW must be a valid window and defaults to the selected one.
595
Return nil if WINDOW has no previous sibling.  */)
596 597
  (Lisp_Object window)
{
598
  return decode_valid_window (window)->prev;
599
}
Gerd Moellmann's avatar
Gerd Moellmann committed
600

601
DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
602
       doc: /* Return combination limit of window WINDOW.
603
WINDOW must be a valid window and defaults to the selected one.
604
If the return value is nil, child windows of WINDOW can be recombined with
605
WINDOW's siblings.  A return value of t means that child windows of
606 607
WINDOW are never \(re-)combined with WINDOW's siblings.  */)
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
608
{
609
  return decode_valid_window (window)->combination_limit;
Jim Blandy's avatar
Jim Blandy committed
610
}
611

612
DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
613
       doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
614
WINDOW must be a valid window and defaults to the selected one.
615 616 617 618
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
future use.  */)
619
  (Lisp_Object window, Lisp_Object limit)
620
{
Paul Eggert's avatar
Paul Eggert committed
621 622
  wset_combination_limit (decode_valid_window (window), limit);
  return limit;
623
}
624

625
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
626
       doc: /* Return the use time of window WINDOW.
627
WINDOW must be a live window and defaults to the selected one.
628 629 630
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.  */)
631 632
  (Lisp_Object window)
{
633
  return make_number (decode_live_window (window)->use_time);
634
}
635

636 637
DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
       doc: /* Return the total height, in lines, of window WINDOW.
638
WINDOW must be a valid window and defaults to the selected one.
639

640 641 642
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.
643

644 645 646
On a graphical display, this total height is reported as an
integer multiple of the default character height.  */)
  (Lisp_Object window)
647
{
648
  return decode_valid_window (window)->total_lines;
649
}
650

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

655 656 657
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.
658

659 660
On a graphical display, this total width is reported as an
integer multiple of the default character width.  */)
661 662
  (Lisp_Object window)
{
663
  return decode_valid_window (window)->total_cols;
664
}
665

666
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
667
       doc: /* Return the new total size of window WINDOW.
668
WINDOW must be a valid window and defaults to the selected one.  */)
669 670
  (Lisp_Object window)
{
671
  return decode_valid_window (window)->new_total;
672 673 674
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
675
       doc: /* Return the normal height of window WINDOW.
676
WINDOW must be a valid window and defaults to the selected one.
677
If HORIZONTAL is non-nil, return the normal width of WINDOW.  */)
678 679
  (Lisp_Object window, Lisp_Object horizontal)
{
680
  struct window *w = decode_valid_window (window);
681 682

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
683 684 685
}

DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
686
       doc: /* Return new normal size of window WINDOW.
687
WINDOW must be a valid window and defaults to the selected one.  */)
688 689
  (Lisp_Object window)
{
690
  return decode_valid_window (window)->new_normal;
691 692
}

693
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
694
       doc: /* Return left column of window WINDOW.
695 696 697 698
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.

699
WINDOW must be a valid window and defaults to the selected one.  */)
700 701
  (Lisp_Object window)
{
702
  return decode_valid_window (window)->left_col;
703 704 705
}

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
706
       doc: /* Return top line of window WINDOW.
707 708 709 710
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.

711
WINDOW must be a valid window and defaults to the selected one.  */)
712 713
  (Lisp_Object window)
{
714
  return decode_valid_window (window)->top_line;
715 716 717 718 719
}

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

720
static int
721 722
window_body_lines (struct window *w)
{
723
  int height = XFASTINT (w->total_lines);
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744

  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));
745
  int width = XINT (w->total_cols);
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765

  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;

  if (FRAME_WINDOW_P (f))
    /* On window-systems, fringes and display margins cannot be
       used for normal text.  */
    width -= (WINDOW_FRINGE_COLS (w)
	      + WINDOW_LEFT_MARGIN_COLS (w)
	      + WINDOW_RIGHT_MARGIN_COLS (w));

  return width;
}

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

770 771 772 773 774 775
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)
776
{
777
  struct window *w = decode_live_window (window);
778 779
  return make_number (window_body_lines (w));
}
780

781 782
DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 1, 0,
       doc: /* Return the width, in columns, of WINDOW's text area.
783
WINDOW must be a live window and defaults to the selected one.
784 785 786 787 788 789

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)
{
790
  struct window *w = decode_live_window (window);
791
  return make_number (window_body_cols (w));
792
}
793

Jim Blandy's avatar
Jim Blandy committed
794
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
795
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
796
WINDOW must be a live window and defaults to the selected one.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
797
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
798
{
799
  return make_number (decode_live_window (window)->hscroll);
Jim Blandy's avatar
Jim Blandy committed
800 801
}

802 803 804 805 806
/* 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)
{
807 808 809 810 811 812 813 814
  /* 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);
815 816 817

  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (w->hscroll != new_hscroll)
818
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
819 820 821 822 823

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

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

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
831
window so that the location of point moves off-window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
832
  (Lisp_Object window, Lisp_Object ncol)
Jim Blandy's avatar
Jim Blandy committed
833
{
834
  struct window *w = decode_live_window (window);
Jim Blandy's avatar
Jim Blandy committed
835

836
  CHECK_NUMBER (ncol);
837
  return set_window_hscroll (w, XINT (ncol));
Jim Blandy's avatar
Jim Blandy committed
838 839
}

840 841
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
842
       doc: /* Return WINDOW's redisplay end trigger value.
843
WINDOW must be a live window and defaults to the selected one.
844
See `set-window-redisplay-end-trigger' for more information.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
845
  (Lisp_Object window)
846
{
847
  return decode_live_window (window)->redisplay_end_trigger;
848 849 850 851
}

DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
       Sset_window_redisplay_end_trigger, 2, 2, 0,
852
       doc: /* Set WINDOW's redisplay end trigger value to VALUE.
853 854 855 856 857 858
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
859
  (register Lisp_Object window, Lisp_Object value)
860
{
Paul Eggert's avatar
Paul Eggert committed
861 862
  wset_redisplay_end_trigger (decode_live_window (window), value);
  return value;
863 864
}

Jim Blandy's avatar
Jim Blandy committed
865
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
866
       doc: /* Return a list of the edge coordinates of WINDOW.
867 868 869 870 871 872 873 874 875 876 877
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
878
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
879
{
880
  register struct window *w = decode_valid_window (window);
Jim Blandy's avatar
Jim Blandy committed
881

882 883 884 885 886
  return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
	 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
	 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
	 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
		Qnil))));
Jim Blandy's avatar
Jim Blandy committed
887 888
}

889 890
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
891 892 893 894
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.
895 896 897 898 899 900

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
901
  (Lisp_Object window)
902
{
903
  register struct window *w = decode_valid_window (window);
904 905 906 907 908 909 910 911

  return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
	 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
	 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
	 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
		Qnil))));
}

912
static void
Juanma Barranquero's avatar
Juanma Barranquero committed
913
calc_absolute_offset (struct window *w, int *add_x, int *add_y)
914
{
915
  struct frame *f = XFRAME (w->frame);
916 917 918 919
  *add_y = f->top_pos;
#ifdef FRAME_MENUBAR_HEIGHT
  *add_y += FRAME_MENUBAR_HEIGHT (f);
#endif
920 921 922
#ifdef FRAME_TOOLBAR_TOP_HEIGHT
  *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
#elif FRAME_TOOLBAR_HEIGHT
923 924 925 926 927 928
  *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;
929 930 931
#ifdef FRAME_TOOLBAR_LEFT_WIDTH
  *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
#endif
932 933 934 935 936
}

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.
937 938 939 940
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.
941 942 943 944 945

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
946
of just the text area, use `window-inside-absolute-pixel-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
947
  (Lisp_Object window)
948
{
949
  register struct window *w = decode_valid_window (window);
950
  int add_x, add_y;
951
  calc_absolute_offset (w, &add_x, &add_y);
952 953 954 955 956 957 958 959

  return Fcons (make_number (WINDOW_LEFT_EDGE_X (w) + add_x),
         Fcons (make_number (WINDOW_TOP_EDGE_Y (w) + add_y),
	 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w) + add_x),
	 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w) + add_y),
		Qnil))));
}

960 961
DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
       doc: /* Return a list of the edge coordinates of WINDOW.
962 963 964 965 966
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.
967 968

RIGHT is one more than the rightmost column of WINDOW's text area.
969 970 971
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
972
  (Lisp_Object window)
973
{
974
  register struct window *w = decode_live_window (window);
975 976 977 978 979 980

  return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
			     + WINDOW_LEFT_MARGIN_COLS (w)
			     + WINDOW_LEFT_FRINGE_COLS (w)),
		make_number (WINDOW_TOP_EDGE_LINE (w)
			     + WINDOW_HEADER_LINE_LINES (w)),
981
		make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
982 983 984 985 986 987 988
			     - WINDOW_RIGHT_MARGIN_COLS (w)
			     - WINDOW_RIGHT_FRINGE_COLS (w)),
		make_number (WINDOW_BOTTOM_EDGE_LINE (w)
			     - WINDOW_MODE_LINE_LINES (w)));
}

DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
989
       doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
990 991 992 993
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.
994 995 996 997

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,
998
display margins, fringes, header line, and/or mode line.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
999
  (Lisp_Object window)
1000
{
1001
  register struct window *w = decode_live_window (window);
1002 1003 1004 1005 1006 1007

  return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
			     + WINDOW_LEFT_MARGIN_WIDTH (w)
			     + WINDOW_LEFT_FRINGE_WIDTH (w)),
		make_number (WINDOW_TOP_EDGE_Y (w)
			     + WINDOW_HEADER_LINE_HEIGHT (w)),
1008
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
1009 1010 1011 1012 1013 1014
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

1015 1016 1017
DEFUN ("window-inside-absolute-pixel-edges",
       Fwindow_inside_absolute_pixel_edges,
       Swindow_inside_absolute_pixel_edges, 0, 1, 0,
1018
       doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
1019 1020 1021 1022
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.
1023 1024 1025 1026 1027

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,
display margins, fringes, header line, and/or mode line.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1028
  (Lisp_Object window)
1029
{
1030
  register struct window *w = decode_live_window (window);
1031
  int add_x, add_y;
1032
  calc_absolute_offset (w, &add_x, &add_y);
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045

  return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
			     + WINDOW_LEFT_MARGIN_WIDTH (w)
			     + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
		make_number (WINDOW_TOP_EDGE_Y (w)
			     + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
}

1046
/* Test if the character at column X, row Y is within window W.
1047
   If it is not, return ON_NOTHING;
1048
   if it is in the window's text area, return ON_TEXT;
1049
   if it is on the window's modeline, return ON_MODE_LINE;
Jim Blandy's avatar
Jim Blandy committed
1050
   if it is on the border between the window and its right sibling,
1051
      return ON_VERTICAL_BORDER.
1052
   if it is on a scroll bar, return ON_SCROLL_BAR.