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
#include <stdio.h>

Jim Blandy's avatar
Jim Blandy committed
25
#include "lisp.h"
26
#include "character.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "buffer.h"
28
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
29
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
30
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
31 32 33 34 35
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
36
#include "dispextern.h"
37 38
#include "blockinput.h"
#include "intervals.h"
39
#include "termhooks.h"		/* For FRAME_TERMINAL.  */
40 41 42
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
43 44 45
#ifdef MSDOS
#include "msdos.h"
#endif
46

Paul Eggert's avatar
Paul Eggert committed
47 48
Lisp_Object Qwindowp, Qwindow_live_p;
static Lisp_Object Qwindow_valid_p;
49 50
static Lisp_Object Qwindow_configuration_p;
static Lisp_Object Qrecord_window_buffer;
51
static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
Martin Rudalics's avatar
Martin Rudalics committed
52
static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
53
static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
54
static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
55
static Lisp_Object Qsafe, Qabove, Qbelow, Qwindow_size, Qclone_of;
Martin Rudalics's avatar
Martin Rudalics committed
56

57 58 59
static int displayed_window_lines (struct window *);
static int count_windows (struct window *);
static int get_leaf_windows (struct window *, struct window **, int);
60 61 62
static void window_scroll (Lisp_Object, EMACS_INT, bool, int);
static void window_scroll_pixel_based (Lisp_Object, int, bool, int);
static void window_scroll_line_based (Lisp_Object, int, bool, int);
63 64 65 66 67 68
static Lisp_Object window_list (void);
static int add_window_to_list (struct window *, void *);
static Lisp_Object next_window (Lisp_Object, Lisp_Object,
                                Lisp_Object, int);
static void decode_next_window_args (Lisp_Object *, Lisp_Object *,
                                     Lisp_Object *);
Andreas Schwab's avatar
Andreas Schwab committed
69
static void foreach_window (struct frame *,
70
				 int (* fn) (struct window *, void *),
Andreas Schwab's avatar
Andreas Schwab committed
71
                            void *);
72 73 74 75
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);
76 77
static int window_resize_check (struct window *, bool);
static void window_resize_apply (struct window *, bool);
Glenn Morris's avatar
Glenn Morris committed
78
static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
79
static void select_window_1 (Lisp_Object, bool);
80

81 82 83 84 85 86 87 88
static struct window *set_window_fringes (struct window *, Lisp_Object,
					  Lisp_Object, Lisp_Object);
static struct window *set_window_margins (struct window *, Lisp_Object,
					  Lisp_Object);
static struct window *set_window_scroll_bars (struct window *, Lisp_Object,
					      Lisp_Object, Lisp_Object);
static void apply_window_adjustment (struct window *);

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

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

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

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

113
/* Hook run at end of temp_output_buffer_show.  */
114
static Lisp_Object Qtemp_buffer_show_hook;
115

116 117 118
/* Nonzero after init_window_once has finished.  */
static int window_initialized;

119
/* Hook to run when window config changes.  */
120
static Lisp_Object Qwindow_configuration_change_hook;
121

122
/* Used by the function window_scroll_pixel_based */
123
static int window_scroll_pixel_based_preserve_x;
124
static int window_scroll_pixel_based_preserve_y;
125

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

Paul Eggert's avatar
Paul Eggert committed
136
/* These setters are used only in this file, so they can be private.  */
137
static void
Paul Eggert's avatar
Paul Eggert committed
138 139 140 141
wset_combination_limit (struct window *w, Lisp_Object val)
{
  w->combination_limit = val;
}
142
static void
Paul Eggert's avatar
Paul Eggert committed
143 144 145 146
wset_dedicated (struct window *w, Lisp_Object val)
{
  w->dedicated = val;
}
147
static void
Paul Eggert's avatar
Paul Eggert committed
148 149 150 151
wset_display_table (struct window *w, Lisp_Object val)
{
  w->display_table = val;
}
152
static void
Paul Eggert's avatar
Paul Eggert committed
153 154 155 156
wset_new_normal (struct window *w, Lisp_Object val)
{
  w->new_normal = val;
}
157
static void
Paul Eggert's avatar
Paul Eggert committed
158 159 160 161
wset_new_total (struct window *w, Lisp_Object val)
{
  w->new_total = val;
}
162
static void
Paul Eggert's avatar
Paul Eggert committed
163 164 165 166
wset_normal_cols (struct window *w, Lisp_Object val)
{
  w->normal_cols = val;
}
167
static void
Paul Eggert's avatar
Paul Eggert committed
168 169 170 171
wset_normal_lines (struct window *w, Lisp_Object val)
{
  w->normal_lines = val;
}
172
static void
Paul Eggert's avatar
Paul Eggert committed
173 174 175 176
wset_parent (struct window *w, Lisp_Object val)
{
  w->parent = val;
}
177
static void
Paul Eggert's avatar
Paul Eggert committed
178 179 180 181
wset_pointm (struct window *w, Lisp_Object val)
{
  w->pointm = val;
}
182
static void
Paul Eggert's avatar
Paul Eggert committed
183 184 185 186
wset_start (struct window *w, Lisp_Object val)
{
  w->start = val;
}
187
static void
Paul Eggert's avatar
Paul Eggert committed
188 189 190 191
wset_temslot (struct window *w, Lisp_Object val)
{
  w->temslot = val;
}
192
static void
Paul Eggert's avatar
Paul Eggert committed
193 194 195 196
wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
{
  w->vertical_scroll_bar_type = val;
}
197
static void
Paul Eggert's avatar
Paul Eggert committed
198 199 200 201
wset_window_parameters (struct window *w, Lisp_Object val)
{
  w->window_parameters = val;
}
202 203 204 205 206 207 208 209 210 211 212 213
static void
wset_combination (struct window *w, bool horflag, Lisp_Object val)
{
  /* Since leaf windows never becomes non-leaf, there should
     be no buffer and markers in start and pointm fields of W.  */
  eassert (!BUFFERP (w->contents) && NILP (w->start) && NILP (w->pointm));
  w->contents = val;
  /* When an internal window is deleted and VAL is nil, HORFLAG
     is meaningless.  */
  if (!NILP (val))
    w->horizontal = horflag;
}
Paul Eggert's avatar
Paul Eggert committed
214

215 216 217 218 219 220 221 222 223 224 225
/* Nonzero if leaf window W doesn't reflect the actual state
   of displayed buffer due to its text or overlays change.  */

bool
window_outdated (struct window *w)
{
  struct buffer *b = XBUFFER (w->contents);
  return (w->last_modified < BUF_MODIFF (b)
	  || w->last_overlay_modified < BUF_OVERLAY_MODIFF (b));
}

226 227
struct window *
decode_live_window (register Lisp_Object window)
228 229 230
{
  if (NILP (window))
    return XWINDOW (selected_window);
231

232 233 234 235
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

236
struct window *
237 238
decode_any_window (register Lisp_Object window)
{
239 240
  struct window *w;

241 242 243 244
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
245 246
  w = XWINDOW (window);
  return w;
247
}
248

Paul Eggert's avatar
Paul Eggert committed
249
static struct window *
250 251 252 253 254 255 256 257 258 259 260 261
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
262 263 264 265 266 267 268
/* 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);
269
  if (BUFFERP (w->contents))
Dmitry Antipov's avatar
Dmitry Antipov committed
270
    {
271
      struct buffer *b = XBUFFER (w->contents);
Paul Eggert's avatar
Paul Eggert committed
272

Dmitry Antipov's avatar
Dmitry Antipov committed
273 274 275 276
      if (b->base_buffer)
	b = b->base_buffer;
      b->window_count += arg;
      eassert (b->window_count >= 0);
277
      /* These should be recalculated by redisplay code.  */
278
      w->window_end_valid = 0;
279
      w->base_line_pos = 0;
Dmitry Antipov's avatar
Dmitry Antipov committed
280 281 282 283 284 285 286 287 288 289
    }
}

/* 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);
290 291 292 293 294
  if (BUFFERP (val))
    /* Make sure that we do not assign the buffer
       to an internal window.  */
    eassert (MARKERP (w->start) && MARKERP (w->pointm));
  w->contents = val;
Dmitry Antipov's avatar
Dmitry Antipov committed
295 296 297
  adjust_window_count (w, 1);
}

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

305 306 307 308 309 310 311 312 313
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;
}

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

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

  if (NILP (frame_or_window))
342
    window = SELECTED_FRAME ()->root_window;
343 344
  else if (WINDOW_VALID_P (frame_or_window))
      window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
345 346 347
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
348
      window = XFRAME (frame_or_window)->root_window;
349 350 351 352 353 354
    }

  return window;
}

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

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

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

  if (NILP (frame_or_window))
383
    window = SELECTED_FRAME ()->root_window;
384
  else if (WINDOW_VALID_P (frame_or_window))
385
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
386 387 388
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
389
      window = XFRAME (frame_or_window)->root_window;
390 391
    }

392 393
  while (WINDOWP (XWINDOW (window)->contents))
    window = XWINDOW (window)->contents;
394 395 396 397 398 399

  return window;
}

DEFUN ("frame-selected-window", Fframe_selected_window,
       Sframe_selected_window, 0, 1, 0,
400 401
       doc: /* Return the selected window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
402 403 404
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.  */)
405 406 407 408 409
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
410
    window = SELECTED_FRAME ()->selected_window;
411
  else if (WINDOW_VALID_P (frame_or_window))
412
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
413 414 415
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
416
      window = XFRAME (frame_or_window)->selected_window;
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
    }

  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
444 445 446 447
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
448 449 450 451 452 453 454 455 456 457 458
}

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

459 460
int window_select_count;

461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
/* 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);

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

479
  if (EQ (window, selected_window) && !inhibit_point_swap)
480 481 482 483
    /* `switch-to-buffer' uses (select-window (selected-window)) as a "clever"
       way to call record_buffer from Elisp, so it's important that we call
       record_buffer before returning here.  */
    goto record_and_return;
484 485 486 487

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

501
  select_window_1 (window, inhibit_point_swap);
502
  bset_last_selected_window (XBUFFER (w->contents), window);
503
  windows_or_buffers_changed = 24;
504

505
 record_and_return:
506 507 508 509 510 511 512 513 514
  /* record_buffer can run QUIT, so make sure it is run only after we have
     re-established the invariant between selected_window and selected_frame,
     otherwise the temporary broken invariant might "escape" (bug#14161).  */
  if (NILP (norecord))
    {
      w->use_time = ++window_select_count;
      record_buffer (w->contents);
    }

515 516 517 518
  return window;
}

/* Select window with a minimum of fuss, i.e. don't record the change anywhere
Paul Eggert's avatar
Paul Eggert committed
519
   (not even for redisplay's benefit), and assume that the window's frame is
520
   already selected.  */
521
static void
522 523
select_window_1 (Lisp_Object window, bool inhibit_point_swap)
{
524 525 526
  /* 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.  */
527 528
  if (!inhibit_point_swap)
    {
529
      struct window *ow = XWINDOW (selected_window);
530 531 532 533
      if (BUFFERP (ow->contents))
	set_marker_both (ow->pointm, ow->contents,
			 BUF_PT (XBUFFER (ow->contents)),
			 BUF_PT_BYTE (XBUFFER (ow->contents)));
534 535 536 537 538 539 540 541 542
    }

  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.  */
543
  set_point_from_marker (XWINDOW (window)->pointm);
544 545 546
}

DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
547 548 549 550 551
       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.
552 553 554 555

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

557 558 559 560 561 562 563
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);
}

564
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
565 566 567
       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.  */)
568 569
  (Lisp_Object window)
{
570 571
  struct window *w = decode_any_window (window);
  return WINDOW_LEAF_P (w) ? w->contents : Qnil;
572 573 574
}

DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
575
       doc: /* Return the parent window of window WINDOW.
576
WINDOW must be a valid window and defaults to the selected one.
577
Return nil for a window with no parent (e.g. a root window).  */)
578 579
  (Lisp_Object window)
{
580
  return decode_valid_window (window)->parent;
581 582
}

583
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
584
       doc: /* Return the topmost child window of window WINDOW.
585
WINDOW must be a valid window and defaults to the selected one.
586 587 588
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.  */)
589 590
  (Lisp_Object window)
{
591 592
  struct window *w = decode_valid_window (window);
  return WINDOW_VERTICAL_COMBINATION_P (w) ? w->contents : Qnil;
593 594
}

595
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
596
       doc: /* Return the leftmost child window of window WINDOW.
597
WINDOW must be a valid window and defaults to the selected one.
598 599 600
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.  */)
601 602
  (Lisp_Object window)
{
603 604
  struct window *w = decode_valid_window (window);
  return WINDOW_HORIZONTAL_COMBINATION_P (w) ? w->contents : Qnil;
605 606
}

607
DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
608
       doc: /* Return the next sibling window of window WINDOW.
609
WINDOW must be a valid window and defaults to the selected one.
610
Return nil if WINDOW has no next sibling.  */)
611 612
  (Lisp_Object window)
{
613
  return decode_valid_window (window)->next;
614 615
}

616
DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
617
       doc: /* Return the previous sibling window of window WINDOW.
618
WINDOW must be a valid window and defaults to the selected one.
619
Return nil if WINDOW has no previous sibling.  */)
620 621
  (Lisp_Object window)
{
622
  return decode_valid_window (window)->prev;
623
}
Gerd Moellmann's avatar
Gerd Moellmann committed
624

625
DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
626
       doc: /* Return combination limit of window WINDOW.
627
WINDOW must be a valid window used in horizontal or vertical combination.
628
If the return value is nil, child windows of WINDOW can be recombined with
629
WINDOW's siblings.  A return value of t means that child windows of
630
WINDOW are never \(re-)combined with WINDOW's siblings.  */)
631
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
632
{
633 634
  struct window *w;

635
  CHECK_VALID_WINDOW (window);
636
  w = XWINDOW (window);
637
  if (WINDOW_LEAF_P (w))
638
    error ("Combination limit is meaningful for internal windows only");
639
  return w->combination_limit;
Jim Blandy's avatar
Jim Blandy committed
640
}
641

642
DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
643
       doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
644
WINDOW must be a valid window used in horizontal or vertical combination.
645 646 647
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
648
future use.  */)
649
  (Lisp_Object window, Lisp_Object limit)
650
{
651 652 653 654
  struct window *w;

  CHECK_VALID_WINDOW (window);
  w = XWINDOW (window);
655
  if (WINDOW_LEAF_P (w))
656 657
    error ("Combination limit is meaningful for internal windows only");
  wset_combination_limit (w, limit);
Paul Eggert's avatar
Paul Eggert committed
658
  return limit;
659
}
660

661
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
662
       doc: /* Return the use time of window WINDOW.
663
WINDOW must be a live window and defaults to the selected one.
664 665 666
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.  */)
667 668
  (Lisp_Object window)
{
669
  return make_number (decode_live_window (window)->use_time);
670
}
671

672 673
DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
       doc: /* Return the total height, in lines, of window WINDOW.
674
WINDOW must be a valid window and defaults to the selected one.
675

676 677 678
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.
679

680 681 682
On a graphical display, this total height is reported as an
integer multiple of the default character height.  */)
  (Lisp_Object window)
683
{
684
  return make_number (decode_valid_window (window)->total_lines);
685
}
686

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

691 692 693
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.
694

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

702
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
703
       doc: /* Return the new total size of window WINDOW.
704
WINDOW must be a valid window and defaults to the selected one.  */)
705 706
  (Lisp_Object window)
{
707
  return decode_valid_window (window)->new_total;
708 709 710
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
711
       doc: /* Return the normal height of window WINDOW.
712
WINDOW must be a valid window and defaults to the selected one.
713
If HORIZONTAL is non-nil, return the normal width of WINDOW.  */)
714 715
  (Lisp_Object window, Lisp_Object horizontal)
{
716
  struct window *w = decode_valid_window (window);
717 718

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
719 720 721
}

DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
722
       doc: /* Return new normal size of window WINDOW.
723
WINDOW must be a valid window and defaults to the selected one.  */)
724 725
  (Lisp_Object window)
{
726
  return decode_valid_window (window)->new_normal;
727 728
}

729
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
730
       doc: /* Return left column of window WINDOW.
731 732 733 734
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.

735
WINDOW must be a valid window and defaults to the selected one.  */)
736 737
  (Lisp_Object window)
{
738
  return make_number (decode_valid_window (window)->left_col);
739 740 741
}

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
742
       doc: /* Return top line of window WINDOW.
743 744 745 746
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.

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

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

756
static int
757 758
window_body_lines (struct window *w)
{
759
  int height = w->total_lines;
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780

  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));
781
  int width = w->total_cols;
782 783 784 785 786 787 788 789 790 791

  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;

792 793 794
  /* Display margins cannot be used for normal text.  */
  width -= WINDOW_LEFT_MARGIN_COLS (w) + WINDOW_RIGHT_MARGIN_COLS (w);

795
  if (FRAME_WINDOW_P (f))
796 797
    /* On window-systems, fringes cannot be used for normal text.  */
    width -= WINDOW_FRINGE_COLS (w);
798 799 800 801

  return width;
}

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

806 807 808 809 810 811
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)
812
{
813
  return make_number (window_body_lines (decode_live_window (window)));
814
}
815

816 817
DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 1, 0,
       doc: /* Return the width, in columns, of WINDOW's text area.
818
WINDOW must be a live window and defaults to the selected one.
819 820 821 822 823 824

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)
{
825
  return make_number (window_body_cols (decode_live_window (window)));
826
}
827

Jim Blandy's avatar
Jim Blandy committed
828
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
829
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
830
WINDOW must be a live window and defaults to the selected one.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
831
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
832
{
833
  return make_number (decode_live_window (window)->hscroll);
Jim Blandy's avatar
Jim Blandy committed
834 835
}

836 837 838 839 840
/* 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)
{
841 842 843 844 845 846 847 848
  /* 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);
849 850 851

  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (w->hscroll != new_hscroll)
852
    XBUFFER (w->contents)->prevent_redisplay_optimizations_p = 1;
853 854 855 856 857

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

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

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
865
window so that the location of point moves off-window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
866
  (Lisp_Object window, Lisp_Object ncol)
Jim Blandy's avatar
Jim Blandy committed
867
{
868
  CHECK_NUMBER (ncol);
869
  return set_window_hscroll (decode_live_window (window), XINT (ncol));
Jim Blandy's avatar
Jim Blandy committed
870 871
}

872 873
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
874
       doc: /* Return WINDOW's redisplay end trigger value.
875
WINDOW must be a live window and defaults to the selected one.
876
See `set-window-redisplay-end-trigger' for more information.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
877
  (Lisp_Object window)
878
{
879
  return decode_live_window (window)->redisplay_end_trigger;
880 881 882 883
}

DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
       Sset_window_redisplay_end_trigger, 2, 2, 0,
884
       doc: /* Set WINDOW's redisplay end trigger value to VALUE.
885 886 887 888 889 890
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
891
  (register Lisp_Object window, Lisp_Object value)
892
{
Paul Eggert's avatar
Paul Eggert committed
893 894
  wset_redisplay_end_trigger (decode_live_window (window), value);
  return value;
895 896
}

Jim Blandy's avatar
Jim Blandy committed
897
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
898
       doc: /* Return a list of the edge coordinates of WINDOW.
899 900 901 902 903 904 905 906 907 908 909
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
910
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
911
{
912
  register struct window *w = decode_valid_window (window);
Jim Blandy's avatar
Jim Blandy committed
913

914 915
  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
916 917
}

918 919
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
920 921 922 923
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.
924 925 926 927 928 929

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
930
  (Lisp_Object window)
931
{
932
  register struct window *w = decode_valid_window (window);
933

934 935
  return list4i (WINDOW_LEFT_EDGE_X (w), WINDOW_TOP_EDGE_Y (w),
		 WINDOW_RIGHT_EDGE_X (w), WINDOW_BOTTOM_EDGE_Y (w));
936 937
}

938
static void
Juanma Barranquero's avatar
Juanma Barranquero committed
939
calc_absolute_offset (struct window *w, int *add_x, int *add_y)
940
{
941
  struct frame *f = XFRAME (w->frame);
942 943 944 945
  *add_y = f->top_pos;
#ifdef FRAME_MENUBAR_HEIGHT
  *add_y += FRAME_MENUBAR_HEIGHT (f);
#endif
946 947
#ifdef FRAME_TOOLBAR_TOP_HEIGHT
  *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
948
#elif defined (FRAME_TOOLBAR_HEIGHT)
949 950 951 952 953 954
  *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;
955 956 957
#ifdef FRAME_TOOLBAR_LEFT_WIDTH
  *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
#endif
958 959 960 961 962
}

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.
963 964 965 966
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.
967 968 969 970 971

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
972
of just the text area, use `window-inside-absolute-pixel-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
973
  (Lisp_Object window)
974
{
975
  register struct window *w = decode_valid_window (window);
976
  int add_x, add_y;
977

978
  calc_absolute_offset (w, &add_x, &add_y);
979

980 981 982 983
  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);
984 985
}

986 987
DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
       doc: /* Return a list of the edge coordinates of WINDOW.
988 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).  TOP and BOTTOM
count by lines, and LEFT and RIGHT count by columns, all relative to 0,
0 at top left corner of frame.
993 994

RIGHT is one more than the rightmost column of WINDOW's text area.
995 996 997
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
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 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)));
1012 1013 1014
}

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