window.c 247 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
/* Window creation, deletion and examination for GNU Emacs.
   Does not include redisplay.
Paul Eggert's avatar
Paul Eggert committed
3
   Copyright (C) 1985-1987, 1993-1998, 2000-2015 Free Software
4
   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"
Paul Eggert's avatar
Paul Eggert committed
30
#include "menu.h"
Jim Blandy's avatar
Jim Blandy committed
31
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
32 33 34 35 36
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
37
#include "dispextern.h"
38 39
#include "blockinput.h"
#include "intervals.h"
40
#include "termhooks.h"		/* For FRAME_TERMINAL.  */
Joakim Verona's avatar
Joakim Verona committed
41 42 43
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
44 45 46
#ifdef MSDOS
#include "msdos.h"
#endif
47
#ifdef HAVE_XWIDGETS
Joakim Verona's avatar
Joakim Verona committed
48
#include "xwidget.h"
49
#endif
50

Paul Eggert's avatar
Paul Eggert committed
51 52
Lisp_Object Qwindowp, Qwindow_live_p;
static Lisp_Object Qwindow_valid_p;
53 54
static Lisp_Object Qwindow_configuration_p;
static Lisp_Object Qrecord_window_buffer;
55
static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
Martin Rudalics's avatar
Martin Rudalics committed
56
static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
57
static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
58
static Lisp_Object Qwindow_sanitize_window_sizes;
59
static Lisp_Object Qwindow_pixel_to_total;
60
static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
61
static Lisp_Object Qsafe, Qabove, Qbelow, Qwindow_size, Qclone_of;
62
static Lisp_Object Qfloor, Qceiling;
63
static Lisp_Object Qwindow_point_insertion_type;
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 69 70
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);
71 72 73 74 75
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
76
static void foreach_window (struct frame *,
77
				 int (* fn) (struct window *, void *),
Andreas Schwab's avatar
Andreas Schwab committed
78
                            void *);
79 80 81 82
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);
83 84
static int window_resize_check (struct window *, bool);
static void window_resize_apply (struct window *, bool);
85
static void window_resize_apply_total (struct window *, bool);
Glenn Morris's avatar
Glenn Morris committed
86
static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
87
static void select_window_1 (Lisp_Object, bool);
88

89 90 91 92 93
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,
94
					      Lisp_Object, Lisp_Object, Lisp_Object);
95 96
static void apply_window_adjustment (struct window *);

Jim Blandy's avatar
Jim Blandy committed
97 98 99 100 101 102
/* 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
103
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
104 105
Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
106 107 108 109 110
/* 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;

111 112 113
/* 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
114 115 116
   the selected window.  */
Lisp_Object minibuf_window;

117 118
/* Non-nil means it is the window whose mode line should be
   shown as the selected window when the minibuffer is selected.  */
119
Lisp_Object minibuf_selected_window;
120

121
/* Hook run at end of temp_output_buffer_show.  */
122
static Lisp_Object Qtemp_buffer_show_hook;
123

124 125
/* Incremented for each window created.  */
static int sequence_number;
126

127
/* Hook to run when window config changes.  */
128
static Lisp_Object Qwindow_configuration_change_hook;
129

130
/* Used by the function window_scroll_pixel_based.  */
131
static int window_scroll_pixel_based_preserve_x;
132
static int window_scroll_pixel_based_preserve_y;
133

134
/* Same for window_scroll_line_based.  */
135 136
static EMACS_INT window_scroll_preserve_hpos;
static EMACS_INT window_scroll_preserve_vpos;
137

138 139 140 141 142 143
static void
CHECK_WINDOW_CONFIGURATION (Lisp_Object x)
{
  CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x);
}

Paul Eggert's avatar
Paul Eggert committed
144
/* These setters are used only in this file, so they can be private.  */
145
static void
Paul Eggert's avatar
Paul Eggert committed
146 147 148 149
wset_combination_limit (struct window *w, Lisp_Object val)
{
  w->combination_limit = val;
}
150

151
static void
Paul Eggert's avatar
Paul Eggert committed
152 153 154 155
wset_dedicated (struct window *w, Lisp_Object val)
{
  w->dedicated = val;
}
156

157
static void
Paul Eggert's avatar
Paul Eggert committed
158 159 160 161
wset_display_table (struct window *w, Lisp_Object val)
{
  w->display_table = val;
}
162

163
static void
Paul Eggert's avatar
Paul Eggert committed
164 165 166 167
wset_new_normal (struct window *w, Lisp_Object val)
{
  w->new_normal = val;
}
168

169
static void
Paul Eggert's avatar
Paul Eggert committed
170 171 172 173
wset_new_total (struct window *w, Lisp_Object val)
{
  w->new_total = val;
}
174

175
static void
Paul Eggert's avatar
Paul Eggert committed
176 177 178 179
wset_normal_cols (struct window *w, Lisp_Object val)
{
  w->normal_cols = val;
}
180

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

187
static void
Paul Eggert's avatar
Paul Eggert committed
188 189 190 191
wset_parent (struct window *w, Lisp_Object val)
{
  w->parent = val;
}
192

193
static void
Paul Eggert's avatar
Paul Eggert committed
194 195 196 197
wset_pointm (struct window *w, Lisp_Object val)
{
  w->pointm = val;
}
198 199 200 201 202 203 204

static void
wset_old_pointm (struct window *w, Lisp_Object val)
{
  w->old_pointm = val;
}

205
static void
Paul Eggert's avatar
Paul Eggert committed
206 207 208 209
wset_start (struct window *w, Lisp_Object val)
{
  w->start = val;
}
210

211
static void
Paul Eggert's avatar
Paul Eggert committed
212 213 214 215
wset_temslot (struct window *w, Lisp_Object val)
{
  w->temslot = val;
}
216

217
static void
Paul Eggert's avatar
Paul Eggert committed
218 219 220 221
wset_vertical_scroll_bar_type (struct window *w, Lisp_Object val)
{
  w->vertical_scroll_bar_type = val;
}
222

223
static void
Paul Eggert's avatar
Paul Eggert committed
224 225 226 227
wset_window_parameters (struct window *w, Lisp_Object val)
{
  w->window_parameters = val;
}
228

229 230 231 232 233 234 235 236 237 238 239 240
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
241

242 243 244 245 246 247 248 249 250 251 252
/* 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));
}

253 254
struct window *
decode_live_window (register Lisp_Object window)
255 256 257
{
  if (NILP (window))
    return XWINDOW (selected_window);
258

259 260 261 262
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

263
struct window *
264 265
decode_any_window (register Lisp_Object window)
{
266 267
  struct window *w;

268 269 270 271
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
272 273
  w = XWINDOW (window);
  return w;
274
}
275

Paul Eggert's avatar
Paul Eggert committed
276
static struct window *
277 278 279 280 281 282 283 284 285 286 287 288
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
289 290 291 292 293 294 295
/* 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);
296
  if (BUFFERP (w->contents))
Dmitry Antipov's avatar
Dmitry Antipov committed
297
    {
298
      struct buffer *b = XBUFFER (w->contents);
Paul Eggert's avatar
Paul Eggert committed
299

Dmitry Antipov's avatar
Dmitry Antipov committed
300 301 302 303
      if (b->base_buffer)
	b = b->base_buffer;
      b->window_count += arg;
      eassert (b->window_count >= 0);
304
      /* These should be recalculated by redisplay code.  */
305
      w->window_end_valid = 0;
306
      w->base_line_pos = 0;
Dmitry Antipov's avatar
Dmitry Antipov committed
307 308 309 310 311 312 313 314 315 316
    }
}

/* 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);
317 318 319 320 321
  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
322 323 324
  adjust_window_count (w, 1);
}

Jim Blandy's avatar
Jim Blandy committed
325
DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
326
       doc: /* Return t if OBJECT is a window and nil otherwise.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
327
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
328
{
329
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
330 331
}

332 333 334
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
335
window.  Windows that have been deleted are not valid.  */)
336 337 338 339 340
  (Lisp_Object object)
{
  return WINDOW_VALID_P (object) ? Qt : Qnil;
}

341
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
342
       doc: /* Return t if OBJECT is a live window and nil otherwise.
343 344
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
345
  (Lisp_Object object)
346
{
347
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
348
}
349 350

/* Frames and windows.  */
351
DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 0, 1, 0,
352
       doc: /* Return the frame that window WINDOW is on.
353
WINDOW must be a valid window and defaults to the selected one.  */)
354
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
355
{
356
  return decode_valid_window (window)->frame;
Jim Blandy's avatar
Jim Blandy committed
357 358
}

359
DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
360 361
       doc: /* Return the root window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
362 363
With a frame argument, return that frame's root window.
With a window argument, return the root window of that window's frame.  */)
364
  (Lisp_Object frame_or_window)
Jim Blandy's avatar
Jim Blandy committed
365
{
366 367 368
  Lisp_Object window;

  if (NILP (frame_or_window))
369
    window = SELECTED_FRAME ()->root_window;
370 371
  else if (WINDOW_VALID_P (frame_or_window))
      window = XFRAME (XWINDOW (frame_or_window)->frame)->root_window;
372 373 374
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
375
      window = XFRAME (frame_or_window)->root_window;
376 377 378
    }

  return window;
Jim Blandy's avatar
Jim Blandy committed
379 380
}

381
DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
382 383
       doc: /* Return the minibuffer window for frame FRAME.
If FRAME is omitted or nil, it defaults to the selected frame.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
384
  (Lisp_Object frame)
Jim Blandy's avatar
Jim Blandy committed
385
{
386
  return FRAME_MINIBUF_WINDOW (decode_live_frame (frame));
Jim Blandy's avatar
Jim Blandy committed
387 388
}

389 390
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
       Swindow_minibuffer_p, 0, 1, 0,
391
       doc: /* Return non-nil if WINDOW is a minibuffer window.
392
WINDOW must be a valid window and defaults to the selected one.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
393
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
394
{
395
  return MINI_WINDOW_P (decode_valid_window (window)) ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
396 397
}

398 399
/* 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,
400 401
       doc: /* Return the topmost, leftmost live window on FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
402 403
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
404 405
the first window of that frame.  */)
  (Lisp_Object frame_or_window)
Jim Blandy's avatar
Jim Blandy committed
406
{
407
  Lisp_Object window;
Jim Blandy's avatar
Jim Blandy committed
408

409
  if (NILP (frame_or_window))
410
    window = SELECTED_FRAME ()->root_window;
411
  else if (WINDOW_VALID_P (frame_or_window))
412
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
413 414 415
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
416
      window = XFRAME (frame_or_window)->root_window;
417
    }
Miles Bader's avatar
Miles Bader committed
418

419 420
  while (WINDOWP (XWINDOW (window)->contents))
    window = XWINDOW (window)->contents;
Jim Blandy's avatar
Jim Blandy committed
421

422 423
  return window;
}
424

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

  if (NILP (frame_or_window))
437
    window = SELECTED_FRAME ()->selected_window;
438
  else if (WINDOW_VALID_P (frame_or_window))
439
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
440
  else
441
    {
442
      CHECK_LIVE_FRAME (frame_or_window);
443
      window = XFRAME (frame_or_window)->selected_window;
444 445
    }

446
  return window;
Jim Blandy's avatar
Jim Blandy committed
447
}
448

449 450 451 452 453 454 455 456 457 458 459 460
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;
461

462 463
  CHECK_LIVE_FRAME (frame);
  CHECK_LIVE_WINDOW (window);
464

465 466
  if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
    error ("In `set-frame-selected-window', WINDOW is not on FRAME");
467

468 469 470
  if (EQ (frame, selected_frame))
    return Fselect_window (window, norecord);
  else
471 472 473 474
    {
      fset_selected_window (XFRAME (frame), window);
      return window;
    }
475 476 477 478 479 480 481
}

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)
482
{
483 484
  return selected_window;
}
485

486
int window_select_count;
487

488 489 490 491 492 493 494 495 496 497
/* 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;
498

499
  CHECK_LIVE_WINDOW (window);
500

501
  w = XWINDOW (window);
502

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

506
  if (EQ (window, selected_window) && !inhibit_point_swap)
507 508 509 510
    /* `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;
511

512
  if (NILP (norecord))
513 514 515 516 517
    { /* Mark the window for redisplay since the selected-window has
	 a different mode-line.  */
      wset_redisplay (XWINDOW (selected_window));
      wset_redisplay (w);
    }
518 519
  else
    redisplay_other_windows ();
520

521 522
  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
523
    {
524
      fset_selected_window (XFRAME (WINDOW_FRAME (w)), window);
525 526 527 528 529 530 531 532
      /* 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;
533
    }
534
  else
535
    fset_selected_window (sf, window);
536

537
  select_window_1 (window, inhibit_point_swap);
538
  bset_last_selected_window (XBUFFER (w->contents), window);
539

540
 record_and_return:
541 542 543 544 545 546 547 548 549
  /* 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);
    }

550 551 552 553
  return window;
}

/* Select window with a minimum of fuss, i.e. don't record the change anywhere
Paul Eggert's avatar
Paul Eggert committed
554
   (not even for redisplay's benefit), and assume that the window's frame is
555
   already selected.  */
556
static void
557 558
select_window_1 (Lisp_Object window, bool inhibit_point_swap)
{
559 560 561
  /* 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.  */
562
  if (!inhibit_point_swap)
563
    {
564
      struct window *ow = XWINDOW (selected_window);
565 566 567 568
      if (BUFFERP (ow->contents))
	set_marker_both (ow->pointm, ow->contents,
			 BUF_PT (XBUFFER (ow->contents)),
			 BUF_PT_BYTE (XBUFFER (ow->contents)));
569
    }
570

571
  selected_window = window;
572

573 574 575 576 577
  /* 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.  */
Joakim Verona's avatar
Joakim Verona committed
578
  set_point_from_marker (XWINDOW (window)->pointm);
579 580
}

581
DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
582 583
       doc: /* Select WINDOW which must be a live window.
Also make WINDOW's frame the selected frame and WINDOW that frame's
584
selected window.  In addition, make WINDOW's buffer current and set its
585 586
buffer's value of `point' to the value of WINDOW's `window-point'.
Return WINDOW.
587 588 589 590

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

592 593 594 595 596 597 598 599 600 601 602
Run `buffer-list-update-hook' unless NORECORD is non-nil.  Note that
applications and internal routines often select a window temporarily for
various purposes; mostly, to simplify coding.  As a rule, such
selections should be not recorded and therefore will not pollute
`buffer-list-update-hook'.  Selections that "really count" are those
causing a visible change in the next redisplay of WINDOW's frame and
should be always recorded.  So if you think of running a function each
time a window gets selected put it on `buffer-list-update-hook'.

Also note that the main editor command loop sets the current buffer to
the buffer of the selected window before each command.  */)
603 604 605 606
  (register Lisp_Object window, Lisp_Object norecord)
{
  return select_window (window, norecord, 0);
}
Jim Blandy's avatar
Jim Blandy committed
607

608
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
609 610 611
       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.  */)
612 613
  (Lisp_Object window)
{
614 615
  struct window *w = decode_any_window (window);
  return WINDOW_LEAF_P (w) ? w->contents : Qnil;
Jim Blandy's avatar
Jim Blandy committed
616 617
}

618
DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
619
       doc: /* Return the parent window of window WINDOW.
620
WINDOW must be a valid window and defaults to the selected one.
621
Return nil for a window with no parent (e.g. a root window).  */)
622
  (Lisp_Object window)
Kenichi Handa's avatar
Kenichi Handa committed
623
{
624
  return decode_valid_window (window)->parent;
625
}
Kenichi Handa's avatar
Kenichi Handa committed
626

627
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
628
       doc: /* Return the topmost child window of window WINDOW.
629
WINDOW must be a valid window and defaults to the selected one.
630 631 632
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.  */)
633 634
  (Lisp_Object window)
{
635 636
  struct window *w = decode_valid_window (window);
  return WINDOW_VERTICAL_COMBINATION_P (w) ? w->contents : Qnil;
Kenichi Handa's avatar
Kenichi Handa committed
637 638
}

639
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
640
       doc: /* Return the leftmost child window of window WINDOW.
641
WINDOW must be a valid window and defaults to the selected one.
642 643 644
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
645
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
646
{
647 648
  struct window *w = decode_valid_window (window);
  return WINDOW_HORIZONTAL_COMBINATION_P (w) ? w->contents : Qnil;
Jim Blandy's avatar
Jim Blandy committed
649 650
}

651
DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
652
       doc: /* Return the next sibling window of window WINDOW.
653
WINDOW must be a valid window and defaults to the selected one.
654
Return nil if WINDOW has no next sibling.  */)
655 656
  (Lisp_Object window)
{
657
  return decode_valid_window (window)->next;
658
}
659

660
DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
661
       doc: /* Return the previous sibling window of window WINDOW.
662
WINDOW must be a valid window and defaults to the selected one.
663
Return nil if WINDOW has no previous sibling.  */)
664 665
  (Lisp_Object window)
{
666
  return decode_valid_window (window)->prev;
667
}
Gerd Moellmann's avatar
Gerd Moellmann committed
668

669
DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
670
       doc: /* Return combination limit of window WINDOW.
671
WINDOW must be a valid window used in horizontal or vertical combination.
672
If the return value is nil, child windows of WINDOW can be recombined with
673
WINDOW's siblings.  A return value of t means that child windows of
674
WINDOW are never \(re-)combined with WINDOW's siblings.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
675
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
676
{
677 678
  struct window *w;

679
  CHECK_VALID_WINDOW (window);
680
  w = XWINDOW (window);
681
  if (WINDOW_LEAF_P (w))
682
    error ("Combination limit is meaningful for internal windows only");
683
  return w->combination_limit;
Jim Blandy's avatar
Jim Blandy committed
684 685
}

686
DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
687
       doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
688
WINDOW must be a valid window used in horizontal or vertical combination.
689 690 691
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
692
future use.  */)
693
  (Lisp_Object window, Lisp_Object limit)
694
{
695 696 697 698
  struct window *w;

  CHECK_VALID_WINDOW (window);
  w = XWINDOW (window);
699
  if (WINDOW_LEAF_P (w))
700 701
    error ("Combination limit is meaningful for internal windows only");
  wset_combination_limit (w, limit);
Paul Eggert's avatar
Paul Eggert committed
702
  return limit;
703
}
704

705
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
706
       doc: /* Return the use time of window WINDOW.
707
WINDOW must be a live window and defaults to the selected one.
708 709 710
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.  */)
711 712
  (Lisp_Object window)
{
713
  return make_number (decode_live_window (window)->use_time);
714
}
715

716
DEFUN ("window-pixel-width", Fwindow_pixel_width, Swindow_pixel_width, 0, 1, 0,
717
       doc: /* Return the width of window WINDOW in pixels.
718
WINDOW must be a valid window and defaults to the selected one.
719

720 721 722 723 724 725 726 727
The return value includes the fringes and margins of WINDOW as well as
any vertical dividers or scroll bars belonging to WINDOW.  If WINDOW is
an internal window, its pixel width is the width of the screen areas
spanned by its children.  */)
     (Lisp_Object window)
{
  return make_number (decode_valid_window (window)->pixel_width);
}
728

729
DEFUN ("window-pixel-height", Fwindow_pixel_height, Swindow_pixel_height, 0, 1, 0,
730
       doc: /* Return the height of window WINDOW in pixels.
731 732
WINDOW must be a valid window and defaults to the selected one.

733 734 735
The return value includes the mode line and header line and the bottom
divider, if any.  If WINDOW is an internal window, its pixel height is
the height of the screen areas spanned by its children.  */)
736
  (Lisp_Object window)
737
{
738
  return make_number (decode_valid_window (window)->pixel_height);
739 740
}

741 742
DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 2, 0,
       doc: /* Return the height of window WINDOW in lines.
743
WINDOW must be a valid window and defaults to the selected one.
744

745 746 747
The return value includes the heights of WINDOW's mode and header line
and its bottom divider, if any.  If WINDOW is an internal window, the
total height is the height of the screen areas spanned by its children.
748

749 750 751 752 753 754 755 756 757 758 759 760 761
If WINDOW's pixel height is not an integral multiple of its frame's
character height, the number of lines occupied by WINDOW is rounded
internally.  This is done in a way such that, if WINDOW is a parent
window, the sum of the total heights of all its children internally
equals the total height of WINDOW.

If the optional argument ROUND is `ceiling', return the smallest integer
larger than WINDOW's pixel height divided by the character height of
WINDOW's frame.  ROUND `floor' means to return the largest integer
smaller than WINDOW's pixel height divided by the character height of
WINDOW's frame.  Any other value of ROUND means to return the internal
total height of WINDOW.  */)
  (Lisp_Object window, Lisp_Object round)
762
{
763 764 765 766 767 768 769 770 771 772 773 774
  struct window *w = decode_valid_window (window);

  if (! EQ (round, Qfloor) && ! EQ (round, Qceiling))
    return make_number (w->total_lines);
  else
    {
      int unit = FRAME_LINE_HEIGHT (WINDOW_XFRAME (w));

      return make_number (EQ (round, Qceiling)
			  ? ((w->pixel_height + unit - 1) /unit)
			  : (w->pixel_height / unit));
    }
775
}
776

777 778
DEFUN ("window-total-width", Fwindow_total_width, Swindow_total_width, 0, 2, 0,
       doc: /* Return the total width of window WINDOW in columns.
779
WINDOW must be a valid window and defaults to the selected one.
780

781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
The return value includes the widths of WINDOW's fringes, margins,
scroll bars and its right divider, if any.  If WINDOW is an internal
window, the total width is the width of the screen areas spanned by its
children.

If WINDOW's pixel width is not an integral multiple of its frame's
character width, the number of lines occupied by WINDOW is rounded
internally.  This is done in a way such that, if WINDOW is a parent
window, the sum of the total widths of all its children internally
equals the total width of WINDOW.

If the optional argument ROUND is `ceiling', return the smallest integer
larger than WINDOW's pixel width divided by the character width of
WINDOW's frame.  ROUND `floor' means to return the largest integer
smaller than WINDOW's pixel width divided by the character width of
WINDOW's frame.  Any other value of ROUND means to return the internal
total width of WINDOW.  */)
  (Lisp_Object window, Lisp_Object round)
799
{
800 801 802 803 804 805 806 807 808 809 810 811
  struct window *w = decode_valid_window (window);

  if (! EQ (round, Qfloor) && ! EQ (round, Qceiling))
    return make_number (w->total_cols);
  else
    {
      int unit = FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w));

      return make_number (EQ (round, Qceiling)
			  ? ((w->pixel_width + unit - 1) /unit)
			  : (w->pixel_width / unit));
    }
812
}
813

814
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
815
       doc: /* Return the new total size of window WINDOW.
816 817
WINDOW must be a valid window and defaults to the selected one.

818 819 820 821
The new total size of WINDOW is the value set by the last call of
`set-window-new-total' for WINDOW.  If it is valid, it will be shortly
installed as WINDOW's total height (see `window-total-height') or total
width (see `window-total-width').  */)
822 823
  (Lisp_Object window)
{
824
  return decode_valid_window (window)->new_total;
825 826 827
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
828
       doc: /* Return the normal height of window WINDOW.
829
WINDOW must be a valid window and defaults to the selected one.
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
If HORIZONTAL is non-nil, return the normal width of WINDOW.

The normal height of a frame's root window or a window that is
horizontally combined (a window that has a left or right sibling) is
1.0.  The normal height of a window that is vertically combined (has a
sibling above or below) is the fraction of the window's height with
respect to its parent.  The sum of the normal heights of all windows in a
vertical combination equals 1.0.

Similarly, the normal width of a frame's root window or a window that is
vertically combined equals 1.0.  The normal width of a window that is
horizontally combined is the fraction of the window's width with respect
to its parent.  The sum of the normal widths of all windows in a
horizontal combination equals 1.0.

The normal sizes of windows are used to restore the proportional sizes
of windows after they have been shrunk to their minimum sizes; for
example when a frame is temporarily made very small and afterwards gets
re-enlarged to its previous size.  */)
849 850
  (Lisp_Object window, Lisp_Object horizontal)
{
851
  struct window *w = decode_valid_window (window);
852 853

  return NILP (horizontal) ? w->normal_lines : w->normal_cols;
854 855 856
}

DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
857
       doc: /* Return new normal size of window WINDOW.
858 859
WINDOW must be a valid window and defaults to the selected one.

860 861 862
The new normal size of WINDOW is the value set by the last call of
`set-window-new-normal' for WINDOW.  If valid, it will be shortly
installed as WINDOW's normal size (see `window-normal-size').  */)
863 864
  (Lisp_Object window)
{
865
  return decode_valid_window (window)->new_normal;
866 867
}

868 869
DEFUN ("window-new-pixel", Fwindow_new_pixel, Swindow_new_pixel, 0, 1, 0,
       doc: /* Return new pixel size of window WINDOW.
870 871 872
WINDOW must be a valid window and defaults to the selected one.

The new pixel size of WINDOW is the value set by the last call of
873 874 875
`set-window-new-pixel' for WINDOW.  If it is valid, it will be shortly
installed as WINDOW's pixel height (see `window-pixel-height') or pixel
width (see `window-pixel-width').  */)
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
  (Lisp_Object window)
{
  return decode_valid_window (window)->new_pixel;
}

DEFUN ("window-pixel-left", Fwindow_pixel_left, Swindow_pixel_left, 0, 1, 0,
       doc: /* Return left pixel edge of window WINDOW.
WINDOW must be a valid window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return make_number (decode_valid_window (window)->pixel_left);
}

DEFUN ("window-pixel-top", Fwindow_pixel_top, Swindow_pixel_top, 0, 1, 0,
       doc: /* Return top pixel edge of window WINDOW.
WINDOW must be a valid window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return make_number (decode_valid_window (window)->pixel_top);
}

897
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,