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
   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
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

247
struct window *
248 249
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;
}

273 274 275
/* Build a frequently used 4-integer (X Y W H) list.  */

static Lisp_Object
276
quad (EMACS_INT x, EMACS_INT y, EMACS_INT w, EMACS_INT h)
277 278 279 280 281
{
  return list4 (make_number (x), make_number (y),
		make_number (w), make_number (h));
}

Jim Blandy's avatar
Jim Blandy committed
282
DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
283
       doc: /* Return t if OBJECT is a window and nil otherwise.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
284
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
285
{
286
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
287 288
}

289 290 291 292 293 294 295 296 297
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;
}

298
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
299
       doc: /* Return t if OBJECT is a live window and nil otherwise.
300 301
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
302
  (Lisp_Object object)
303
{
304
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
305
}
306 307

/* Frames and windows.  */
308
DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 0, 1, 0,
309
       doc: /* Return the frame that window WINDOW is on.
310
WINDOW must be a valid window and defaults to the selected one.  */)
311 312
  (Lisp_Object window)
{
313
  return decode_valid_window (window)->frame;
314 315 316
}

DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
317 318
       doc: /* Return the root window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
319 320
With a frame argument, return that frame's root window.
With a window argument, return the root window of that window's frame.  */)
321 322 323 324 325
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
326
    window = SELECTED_FRAME ()->root_window;
327 328
  else if (WINDOW_VALID_P (frame_or_window))
      window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
329 330 331
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
332
      window = XFRAME (frame_or_window)->root_window;
333 334 335 336 337 338
    }

  return window;
}

DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
339 340
       doc: /* Return the minibuffer window for frame FRAME.
If FRAME is omitted or nil, it defaults to the selected frame.  */)
341 342
  (Lisp_Object frame)
{
343
  return FRAME_MINIBUF_WINDOW (decode_live_frame (frame));
344 345 346 347 348
}

DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
       Swindow_minibuffer_p, 0, 1, 0,
       doc: /* Return non-nil if WINDOW is a minibuffer window.
349
WINDOW must be a valid window and defaults to the selected one.  */)
350 351
  (Lisp_Object window)
{
352
  return MINI_WINDOW_P (decode_valid_window (window)) ? Qt : Qnil;
353 354 355 356
}

/* 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,
357 358
       doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
359 360
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
361 362 363 364 365 366
the first window of that frame.  */)
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
367
    window = SELECTED_FRAME ()->root_window;
368
  else if (WINDOW_VALID_P (frame_or_window))
369
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
370 371 372
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
373
      window = XFRAME (frame_or_window)->root_window;
374 375
    }

376
  while (NILP (XWINDOW (window)->buffer))
377
    {
378 379 380 381
      if (! NILP (XWINDOW (window)->hchild))
	window = XWINDOW (window)->hchild;
      else if (! NILP (XWINDOW (window)->vchild))
	window = XWINDOW (window)->vchild;
382
      else
383
	emacs_abort ();
384 385 386 387 388 389 390
    }

  return window;
}

DEFUN ("frame-selected-window", Fframe_selected_window,
       Sframe_selected_window, 0, 1, 0,
391 392
       doc: /* Return the selected window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
393 394 395
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.  */)
396 397 398 399 400
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

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

  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
435 436 437 438
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
439 440 441 442 443 444 445 446 447 448 449
}

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

450 451
int window_select_count;

452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
/* 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))
    {
471
      w->use_time = ++window_select_count;
472
      record_buffer (w->buffer);
473 474
    }

475 476 477
  /* Make the selected window's buffer current.  */
  Fset_buffer (w->buffer);

478 479 480 481 482 483
  if (EQ (window, selected_window) && !inhibit_point_swap)
    return window;

  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
    {
484
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
485 486 487 488 489 490 491 492 493 494
      /* 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
495
    fset_selected_window (sf, window);
496

497 498 499
  /* 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.  */
500 501 502
  if (!inhibit_point_swap)
    {
      ow = XWINDOW (selected_window);
503 504 505 506
      if (! NILP (ow->buffer))
	set_marker_both (ow->pointm, ow->buffer,
			 BUF_PT (XBUFFER (ow->buffer)),
			 BUF_PT_BYTE (XBUFFER (ow->buffer)));
507 508 509
    }

  selected_window = window;
Paul Eggert's avatar
Paul Eggert committed
510
  bset_last_selected_window (XBUFFER (w->buffer), window);
511 512 513 514 515 516 517

  /* 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.  */
  {
518
    register ptrdiff_t new_point = marker_position (w->pointm);
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
    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.
539

540 541 542 543 544 545 546
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);
}

547
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
548 549 550
       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.  */)
551 552
  (Lisp_Object window)
{
553
  return decode_any_window (window)->buffer;
554 555 556
}

DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
557
       doc: /* Return the parent window of window WINDOW.
558
WINDOW must be a valid window and defaults to the selected one.
559
Return nil for a window with no parent (e.g. a root window).  */)
560 561
  (Lisp_Object window)
{
562
  return decode_valid_window (window)->parent;
563 564
}

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

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

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

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

605
DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
606
       doc: /* Return combination limit of window WINDOW.
607
If the return value is nil, child windows of WINDOW can be recombined with
608
WINDOW's siblings.  A return value of t means that child windows of
609 610 611 612
WINDOW are never \(re-)combined with WINDOW's siblings.

WINDOW must be a valid window.  The return value is meaningful for
internal windows only.  */)
613
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
614
{
615 616
  CHECK_VALID_WINDOW (window);
  return XWINDOW (window)->combination_limit;
Jim Blandy's avatar
Jim Blandy committed
617
}
618

619
DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
620
       doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
621 622 623
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
624 625 626 627
future use.

WINDOW must be a valid window.  Setting the combination limit is
meaningful for internal windows only.  */)
628
  (Lisp_Object window, Lisp_Object limit)
629
{
Paul Eggert's avatar
Paul Eggert committed
630 631
  wset_combination_limit (decode_valid_window (window), limit);
  return limit;
632
}
633

634
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
635
       doc: /* Return the use time of window WINDOW.
636
WINDOW must be a live window and defaults to the selected one.
637 638 639
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.  */)
640 641
  (Lisp_Object window)
{
642
  return make_number (decode_live_window (window)->use_time);
643
}
644

645 646
DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
       doc: /* Return the total height, in lines, of window WINDOW.
647
WINDOW must be a valid window and defaults to the selected one.
648

649 650 651
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.
652

653 654 655
On a graphical display, this total height is reported as an
integer multiple of the default character height.  */)
  (Lisp_Object window)
656
{
657
  return decode_valid_window (window)->total_lines;
658
}
659

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

664 665 666
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.
667

668 669
On a graphical display, this total width is reported as an
integer multiple of the default character width.  */)
670 671
  (Lisp_Object window)
{
672
  return decode_valid_window (window)->total_cols;
673
}
674

675
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
676
       doc: /* Return the new total size of window WINDOW.
677
WINDOW must be a valid window and defaults to the selected one.  */)
678 679
  (Lisp_Object window)
{
680
  return decode_valid_window (window)->new_total;
681 682 683
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
684
       doc: /* Return the normal height of window WINDOW.
685
WINDOW must be a valid window and defaults to the selected one.
686
If HORIZONTAL is non-nil, return the normal width of WINDOW.  */)
687 688
  (Lisp_Object window, Lisp_Object horizontal)
{
689
  struct window *w = decode_valid_window (window);
690 691

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
692 693 694
}

DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
695
       doc: /* Return new normal size of window WINDOW.
696
WINDOW must be a valid window and defaults to the selected one.  */)
697 698
  (Lisp_Object window)
{
699
  return decode_valid_window (window)->new_normal;
700 701
}

702
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
703
       doc: /* Return left column of window WINDOW.
704 705 706 707
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.

708
WINDOW must be a valid window and defaults to the selected one.  */)
709 710
  (Lisp_Object window)
{
711
  return decode_valid_window (window)->left_col;
712 713 714
}

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
715
       doc: /* Return top line of window WINDOW.
716 717 718 719
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.

720
WINDOW must be a valid window and defaults to the selected one.  */)
721 722
  (Lisp_Object window)
{
723
  return decode_valid_window (window)->top_line;
724 725 726 727 728
}

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

729
static int
730 731
window_body_lines (struct window *w)
{
732
  int height = XFASTINT (w->total_lines);
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753

  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));
754
  int width = XINT (w->total_cols);
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774

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

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

779 780 781 782 783 784
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)
785
{
786
  return make_number (window_body_lines (decode_live_window (window)));
787
}
788

789 790
DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 1, 0,
       doc: /* Return the width, in columns, of WINDOW's text area.
791
WINDOW must be a live window and defaults to the selected one.
792 793 794 795 796 797

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)
{
798
  return make_number (window_body_cols (decode_live_window (window)));
799
}
800

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

809 810 811 812 813
/* 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)
{
814 815 816 817 818 819 820 821
  /* 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);
822 823 824

  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (w->hscroll != new_hscroll)
825
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
826 827 828 829 830

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

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

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
838
window so that the location of point moves off-window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
839
  (Lisp_Object window, Lisp_Object ncol)
Jim Blandy's avatar
Jim Blandy committed
840
{
841
  CHECK_NUMBER (ncol);
842
  return set_window_hscroll (decode_live_window (window), XINT (ncol));
Jim Blandy's avatar
Jim Blandy committed
843 844
}

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

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

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

887 888
  return quad (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
889 890
}

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

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
903
  (Lisp_Object window)
904
{
905
  register struct window *w = decode_valid_window (window);
906

907 908
  return quad (WINDOW_LEFT_EDGE_X (w), WINDOW_TOP_EDGE_Y (w),
	       WINDOW_RIGHT_EDGE_X (w), WINDOW_BOTTOM_EDGE_Y (w));
909 910
}

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

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

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

951
  calc_absolute_offset (w, &add_x, &add_y);
952

953 954 955 956
  return quad (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);
957 958
}

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

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

975 976 977 978 979 980 981 982 983 984
  return quad (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));
985 986 987
}

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

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

1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
  return quad (WINDOW_BOX_LEFT_EDGE_X (w)
	       + WINDOW_LEFT_MARGIN_WIDTH (w)
	       + WINDOW_LEFT_FRINGE_WIDTH (w),
	       WINDOW_TOP_EDGE_Y (w)
	       + WINDOW_HEADER_LINE_HEIGHT (w),
	       WINDOW_BOX_RIGHT_EDGE_X (w)
	       - WINDOW_RIGHT_MARGIN_WIDTH (w)
	       - WINDOW_RIGHT_FRINGE_WIDTH (w),
	       WINDOW_BOTTOM_EDGE_Y (w)
	       - WINDOW_MODE_LINE_HEIGHT (w));
1012 1013
}

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

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
1027
  (Lisp_Object window)
1028
{
1029
  register struct window *w = decode_live_window (window);
1030
  int add_x, add_y;
1031

1032
  calc_absolute_offset (w, &add_x, &add_y);