window.c 87.1 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, 1986, 1987, 1992, 1993 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23
any later version.

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
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */

#include "config.h"
#include "lisp.h"
#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
24
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
25 26 27 28 29
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Jim Blandy's avatar
Jim Blandy committed
30
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
31

32
Lisp_Object Qwindowp, Qlive_window_p;
Jim Blandy's avatar
Jim Blandy committed
33 34 35 36

Lisp_Object Fnext_window (), Fdelete_window (), Fselect_window ();
Lisp_Object Fset_window_buffer (), Fsplit_window (), Frecenter ();

37
void delete_all_subwindows ();
Jim Blandy's avatar
Jim Blandy committed
38 39 40 41 42 43 44 45
static struct window *decode_window();

/* 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
46
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
47 48 49

Lisp_Object selected_window;

Jim Blandy's avatar
Jim Blandy committed
50
/* The minibuffer window of the selected frame.
Jim Blandy's avatar
Jim Blandy committed
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
   Note that you cannot test for minibufferness of an arbitrary window
   by comparing against this; but you can test for minibufferness of
   the selected window.  */
Lisp_Object minibuf_window;

/* Non-nil means it is the window for C-M-v to scroll
   when the minibuffer is selected.  */
Lisp_Object Vminibuf_scroll_window;

/* Non-nil means this is the buffer whose window C-M-v should scroll.  */
Lisp_Object Vother_window_scroll_buffer;

/* Last mouse click data structure (nil if no mouse support).  */
Lisp_Object Vmouse_event;

/* Non-nil means it's function to call to display temp buffers.  */
Lisp_Object Vtemp_buffer_show_function;

/* If a window gets smaller than either of these, it is removed. */
int window_min_height;
int window_min_width;

/* Nonzero implies Fdisplay_buffer should create windows. */
int pop_up_windows;

Jim Blandy's avatar
Jim Blandy committed
76 77
/* Nonzero implies make new frames for Fdisplay_buffer.  */
int pop_up_frames;
Jim Blandy's avatar
Jim Blandy committed
78 79

/* Non-nil means use this function instead of default */
Jim Blandy's avatar
Jim Blandy committed
80
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104

/* Function to call to handle Fdisplay_buffer.  */
Lisp_Object Vdisplay_buffer_function;

/* Fdisplay_buffer always splits the largest window 
   if that window is more than this high.  */
int split_height_threshold;

/* Number of lines of continuity in scrolling by screenfuls.  */
int next_screen_context_lines;

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

#define min(a, b) ((a) < (b) ? (a) : (b))

DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
  "Returns t if OBJ is a window.")
  (obj)
     Lisp_Object obj;
{
  return XTYPE (obj) == Lisp_Window ? Qt : Qnil;
}

105 106 107 108 109 110 111 112 113 114
DEFUN ("live-window-p", Flive_window_p, Slive_window_p, 1, 1, 0,
  "Returns t if OBJ is a window which is currently visible.")
     (obj)
     Lisp_Object obj;
{
  return ((XTYPE (obj) == Lisp_Window
	   && ! NILP (XWINDOW (obj)->buffer))
	  ? Qt : Qnil);
}

Jim Blandy's avatar
Jim Blandy committed
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
Lisp_Object
make_window ()
{
  register Lisp_Object val;
  register struct window *p;

  /* Add sizeof (Lisp_Object) here because sizeof (struct Lisp_Vector)
     includes the first element.  */
  val = Fmake_vector (
    make_number ((sizeof (struct window) - sizeof (struct Lisp_Vector)
		  + sizeof (Lisp_Object))
		 / sizeof (Lisp_Object)),
    Qnil);
  XSETTYPE (val, Lisp_Window);
  p = XWINDOW (val);
  XFASTINT (p->sequence_number) = ++sequence_number;
  XFASTINT (p->left) = XFASTINT (p->top)
    = XFASTINT (p->height) = XFASTINT (p->width)
      = XFASTINT (p->hscroll) = 0;
  XFASTINT (p->last_point_x) = XFASTINT (p->last_point_y) = 0;
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
  XFASTINT (p->use_time) = 0;
Jim Blandy's avatar
Jim Blandy committed
138
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
139 140 141 142 143 144 145 146 147 148 149 150
  p->display_table = Qnil;
  p->dedicated = Qnil;
  return val;
}

DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
  "Return the window that the cursor now appears in and commands apply to.")
  ()
{
  return selected_window;
}

151 152 153 154 155 156
DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
  "Return the window used now for minibuffers.\n\
If the optional argument FRAME is specified, return the minibuffer window\n\
used by that frame.")
  (frame)
    Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
157
{
Jim Blandy's avatar
Jim Blandy committed
158
#ifdef MULTI_FRAME
159 160 161 162 163 164 165
  if (NILP (frame))
    XSET (frame, Lisp_Frame, selected_frame);
  else
    CHECK_LIVE_FRAME (frame, 0);
#endif

  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
Jim Blandy's avatar
Jim Blandy committed
166 167
}

168
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
169 170 171 172 173 174 175 176 177 178
  "Returns non-nil if WINDOW is a minibuffer window.")
  (window)
     Lisp_Object window;
{
  struct window *w = decode_window (window);
  return (MINI_WINDOW_P (w) ? Qt : Qnil);
}

DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
  Spos_visible_in_window_p, 0, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
179
  "Return t if position POS is currently on the frame in WINDOW.\n\
Jim Blandy's avatar
Jim Blandy committed
180 181 182 183 184 185 186 187 188 189 190 191
Returns nil if that position is scrolled vertically out of view.\n\
POS defaults to point; WINDOW, to the selected window.")
  (pos, window)
     Lisp_Object pos, window;
{
  register struct window *w;
  register int top;
  register int height;
  register int posint;
  register struct buffer *buf;
  struct position posval;

Jim Blandy's avatar
Jim Blandy committed
192
  if (NILP (pos))
Jim Blandy's avatar
Jim Blandy committed
193 194 195 196 197 198 199
    posint = point;
  else
    {
      CHECK_NUMBER_COERCE_MARKER (pos, 0);
      posint = XINT (pos);
    }

200
  w = decode_window (window);
Jim Blandy's avatar
Jim Blandy committed
201 202 203 204 205 206 207 208 209 210
  top = marker_position (w->start);

  if (posint < top)
    return Qnil;

  height = XFASTINT (w->height) - ! MINI_WINDOW_P (w);

  buf = XBUFFER (w->buffer);
  if (XFASTINT (w->last_modified) >= BUF_MODIFF (buf))
    {
Jim Blandy's avatar
Jim Blandy committed
211
      /* If frame is up to date,
Jim Blandy's avatar
Jim Blandy committed
212 213 214 215 216 217 218 219 220 221 222 223 224
	 use the info recorded about how much text fit on it. */
      if (posint < BUF_Z (buf) - XFASTINT (w->window_end_pos)
	  || (XFASTINT (w->window_end_vpos) < height))
	return Qt;
      return Qnil;
    }
  else
    {
      if (posint > BUF_Z (buf))
	return Qnil;

      /* If that info is not correct, calculate afresh */
      posval = *compute_motion (top, 0, 0, posint, height, 0,
225
				window_internal_width (w) - 1,
Jim Blandy's avatar
Jim Blandy committed
226 227 228 229 230 231 232 233 234 235
				XINT (w->hscroll), 0);

      return posval.vpos < height ? Qt : Qnil;
    }
}

static struct window *
decode_window (window)
     register Lisp_Object window;
{
Jim Blandy's avatar
Jim Blandy committed
236
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
237 238
    return XWINDOW (selected_window);

239
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
  return XWINDOW (window);
}

DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
  "Return the buffer that WINDOW is displaying.")
  (window)
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
  "Return the number of lines in WINDOW (including its mode line).")
  (window)
     Lisp_Object window;
{
  return decode_window (window)->height;
}

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
  "Return the number of columns in WINDOW.")
  (window)
     Lisp_Object window;
{
  register struct window *w = decode_window (window);
265
  register int width = XFASTINT (w->width);
Jim Blandy's avatar
Jim Blandy committed
266

267
  return make_number (window_internal_width (w));
Jim Blandy's avatar
Jim Blandy committed
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
}

DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
  "Return the number of columns by which WINDOW is scrolled from left margin.")
  (window)
     Lisp_Object window;
{
  return decode_window (window)->hscroll;
}

DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
  "Set number of columns WINDOW is scrolled from left margin to NCOL.\n\
NCOL should be zero or positive.")
  (window, ncol)
     register Lisp_Object window, ncol;
{
  register struct window *w;

  CHECK_NUMBER (ncol, 1);
  if (XINT (ncol) < 0) XFASTINT (ncol) = 0;
  if (XFASTINT (ncol) >= (1 << (SHORTBITS - 1)))
    args_out_of_range (ncol, Qnil);
  w = decode_window (window);
291
  if (XINT (w->hscroll) != XINT (ncol))
Jim Blandy's avatar
Jim Blandy committed
292 293 294 295 296 297 298
    clip_changed = 1;		/* Prevent redisplay shortcuts */
  w->hscroll = ncol;
  return ncol;
}

DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
  "Return a list of the edge coordinates of WINDOW.\n\
Jim Blandy's avatar
Jim Blandy committed
299
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.\n\
Jim Blandy's avatar
Jim Blandy committed
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
RIGHT is one more than the rightmost column used by WINDOW,\n\
and BOTTOM is one more than the bottommost row used by WINDOW\n\
 and its mode-line.")
  (window)
     Lisp_Object window;
{
  register struct window *w = decode_window (window);

  return Fcons (w->left, Fcons (w->top,
           Fcons (make_number (XFASTINT (w->left) + XFASTINT (w->width)),
		  Fcons (make_number (XFASTINT (w->top)
				      + XFASTINT (w->height)),
			 Qnil))));
}

Jim Blandy's avatar
Jim Blandy committed
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
/* Test if the character at column *x, row *y is within window *w.
   If it is not, return 0;
   if it is in the window's text area,
      set *x and *y to its location relative to the upper left corner
         of the window, and
      return 1;
   if it is on the window's modeline, return 2;
   if it is on the border between the window and its right sibling,
      return 3.  */
static int
coordinates_in_window (w, x, y)
     register struct window *w;
     register int *x, *y;
{
  register int left = XINT (w->left);
  register int width = XINT (w->width);
  register int window_height = XINT (w->height);
  register int top = XFASTINT (w->top);

  if (   *x < left || *x >= left + width
      || *y < top  || *y >= top  + window_height)
    return 0;

  /* Is the character is the mode line?  */
  if (*y == top + window_height - 1
340
      && ! MINI_WINDOW_P (w))
Jim Blandy's avatar
Jim Blandy committed
341 342 343 344
    return 2;
  
  /* Is the character in the right border?  */
  if (*x == left + width - 1
Jim Blandy's avatar
Jim Blandy committed
345
      && left + width != FRAME_WIDTH (XFRAME (w->frame)))
Jim Blandy's avatar
Jim Blandy committed
346 347 348 349 350 351 352 353 354 355
    return 3;

  *x -= left;
  *y -= top;
  return 1;
}

DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
  Scoordinates_in_window_p, 2, 2, 0,
  "Return non-nil if COORDINATES are in WINDOW.\n\
Jim Blandy's avatar
Jim Blandy committed
356
COORDINATES is a cons of the form (X . Y), X and Y being distances\n\
Jim Blandy's avatar
Jim Blandy committed
357
measured in characters from the upper-left corner of the frame.\n\
Jim Blandy's avatar
Jim Blandy committed
358
(0 .  0) denotes the character in the upper left corner of the\n\
Jim Blandy's avatar
Jim Blandy committed
359
frame.\n\
Jim Blandy's avatar
Jim Blandy committed
360 361
If COORDINATES are in the text portion of WINDOW,\n\
   the coordinates relative to the window are returned.\n\
Jim Blandy's avatar
Jim Blandy committed
362
If they are in the mode line of WINDOW, `mode-line' is returned.\n\
Jim Blandy's avatar
Jim Blandy committed
363
If they are on the border between WINDOW and its right sibling,\n\
Jim Blandy's avatar
Jim Blandy committed
364
   `vertical-line' is returned.")
Jim Blandy's avatar
Jim Blandy committed
365 366 367 368 369
  (coordinates, window)
     register Lisp_Object coordinates, window;
{
  int x, y;

370
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
  CHECK_CONS (coordinates, 1);
  x = XINT (Fcar (coordinates));
  y = XINT (Fcdr (coordinates));

  switch (coordinates_in_window (XWINDOW (window), &x, &y))
    {
    case 0:			/* NOT in window at all. */
      return Qnil;

    case 1:			/* In text part of window. */
      return Fcons (x, y);

    case 2:			/* In mode line of window. */
      return Qmode_line;
      
    case 3:			/* On right border of window.  */
Jim Blandy's avatar
Jim Blandy committed
387
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
388 389 390 391 392 393

    default:
      abort ();
    }
}

Jim Blandy's avatar
Jim Blandy committed
394
/* Find the window containing column x, row y, and return it as a
Jim Blandy's avatar
Jim Blandy committed
395 396 397 398
   Lisp_Object.  If x, y is on the window's modeline, set *part
   to 1; if it is on the separating line between the window and its
   right sibling, set it to 2; otherwise set it to 0.  If there is no
   window under x, y return nil and leave *part unmodified.  */
Jim Blandy's avatar
Jim Blandy committed
399
Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
400 401
window_from_coordinates (frame, x, y, part)
     FRAME_PTR frame;
Jim Blandy's avatar
Jim Blandy committed
402
     int x, y;
Jim Blandy's avatar
Jim Blandy committed
403
     int *part;
Jim Blandy's avatar
Jim Blandy committed
404 405 406
{
  register Lisp_Object tem, first;

Jim Blandy's avatar
Jim Blandy committed
407
  tem = first = FRAME_SELECTED_WINDOW (frame);
Jim Blandy's avatar
Jim Blandy committed
408

Jim Blandy's avatar
Jim Blandy committed
409
  do
Jim Blandy's avatar
Jim Blandy committed
410 411 412 413 414
    {
      int found = coordinates_in_window (XWINDOW (tem), &x, &y);

      if (found)
	{
Jim Blandy's avatar
Jim Blandy committed
415
	  *part = found - 1;
Jim Blandy's avatar
Jim Blandy committed
416 417 418
	  return tem;
	}

Jim Blandy's avatar
Jim Blandy committed
419
      tem = Fnext_window (tem, Qt, Qlambda);
Jim Blandy's avatar
Jim Blandy committed
420
    }
Jim Blandy's avatar
Jim Blandy committed
421 422 423
  while (! EQ (tem, first));
  
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
424 425
}

426
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
427
  "Return window containing coordinates X and Y on FRAME.\n\
Jim Blandy's avatar
Jim Blandy committed
428 429
If omitted, FRAME defaults to the currently selected frame.\n\
The top left corner of the frame is considered to be row 0,\n\
Jim Blandy's avatar
Jim Blandy committed
430
column 0.")
Richard M. Stallman's avatar
Richard M. Stallman committed
431 432
  (x, y, frame)
      Lisp_Object x, y, frame;
Jim Blandy's avatar
Jim Blandy committed
433 434 435
{
  int part;

436
#ifdef MULTI_FRAME
Jim Blandy's avatar
Jim Blandy committed
437 438
  if (NILP (frame))
    XSET (frame, Lisp_Frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
439
  else
Jim Blandy's avatar
Jim Blandy committed
440
    CHECK_LIVE_FRAME (frame, 2);
441
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
442 443
  CHECK_NUMBER (x, 0);
  CHECK_NUMBER (y, 1);
Jim Blandy's avatar
Jim Blandy committed
444

Jim Blandy's avatar
Jim Blandy committed
445
  return window_from_coordinates (XFRAME (frame),
Richard M. Stallman's avatar
Richard M. Stallman committed
446
				  XINT (x), XINT (y),
Jim Blandy's avatar
Jim Blandy committed
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
				  &part);
}

DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
  "Return current value of point in WINDOW.\n\
For a nonselected window, this is the value point would have\n\
if that window were selected.\n\
\n\
Note that, when WINDOW is the selected window and its buffer\n\
is also currently selected, the value returned is the same as (point).\n\
It would be more strictly correct to return the `top-level' value\n\
of point, outside of any save-excursion forms.\n\
But that is hard to define.")
  (window)
     Lisp_Object window;
{
  register struct window *w = decode_window (window);

  if (w == XWINDOW (selected_window)
      && current_buffer == XBUFFER (w->buffer))
    return Fpoint ();
  return Fmarker_position (w->pointm);
}

DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
  "Return position at which display currently starts in WINDOW.")
  (window)
     Lisp_Object window;
{
  return Fmarker_position (decode_window (window)->start);
}

DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 1, 0,
  "Return position at which display currently ends in WINDOW.")
  (window)
     Lisp_Object window;
{
  Lisp_Object value;
  struct window *w = decode_window (window);
  
  XSET (value, Lisp_Int,
	BUF_Z (current_buffer) - XFASTINT (w->window_end_pos));

  return value;
}

DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
  "Make point value in WINDOW be at position POS in WINDOW's buffer.")
  (window, pos)
     Lisp_Object window, pos;
{
  register struct window *w = decode_window (window);

  CHECK_NUMBER_COERCE_MARKER (pos, 1);
  if (w == XWINDOW (selected_window))
    Fgoto_char (pos);
  else
    set_marker_restricted (w->pointm, pos, w->buffer);

  return pos;
}

DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
  "Make display in WINDOW start at position POS in WINDOW's buffer.\n\
Optional third arg NOFORCE non-nil inhibits next redisplay\n\
from overriding motion of point in order to display at this exact start.")
  (window, pos, noforce)
     Lisp_Object window, pos, noforce;
{
  register struct window *w = decode_window (window);

  CHECK_NUMBER_COERCE_MARKER (pos, 1);
  set_marker_restricted (w->start, pos, w->buffer);
  /* this is not right, but much easier than doing what is right. */
  w->start_at_line_beg = Qnil;
Jim Blandy's avatar
Jim Blandy committed
522
  if (NILP (noforce))
Jim Blandy's avatar
Jim Blandy committed
523 524 525
    w->force_start = Qt;
  w->update_mode_line = Qt;
  XFASTINT (w->last_modified) = 0;
Jim Blandy's avatar
Jim Blandy committed
526 527
  if (!EQ (window, selected_window))
    windows_or_buffers_changed++;
Jim Blandy's avatar
Jim Blandy committed
528 529 530 531 532 533 534 535 536 537 538 539 540
  return pos;
}

DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
       1, 1, 0,
  "Return WINDOW's dedicated object, usually t or nil.\n\
See also `set-window-buffer-dedicated'.")
  (window)
     Lisp_Object window;
{
  return decode_window (window)->dedicated;
}

541 542 543 544 545 546 547
DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
       Sset_window_dedicated_p, 2, 2, 0,
  "Control whether WINDOW is dedicated to the buffer it displays.\n\
If it is dedicated, Emacs will not automatically change\n\
which buffer appears in it.\n\
The second argument is the new value for the dedication flag;\n\
non-nil means yes.")
Jim Blandy's avatar
Jim Blandy committed
548 549 550 551 552
  (window, arg)
       Lisp_Object window, arg;
{
  register struct window *w = decode_window (window);

Jim Blandy's avatar
Jim Blandy committed
553
  if (NILP (arg))
Jim Blandy's avatar
Jim Blandy committed
554 555
    w->dedicated = Qnil;
  else
556
    w->dedicated = Qt;
Jim Blandy's avatar
Jim Blandy committed
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591

  return w->dedicated;
}

DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
       0, 1, 0,
  "Return the display-table that WINDOW is using.")
  (window)
     Lisp_Object window;
{
  return decode_window (window)->display_table;
}

/* Get the display table for use currently on window W.
   This is either W's display table or W's buffer's display table.
   Ignore the specified tables if they are not valid;
   if no valid table is specified, return 0.  */

struct Lisp_Vector *
window_display_table (w)
     struct window *w;
{
  Lisp_Object tem;
  tem = w->display_table;
  if (XTYPE (tem) == Lisp_Vector && XVECTOR (tem)->size == DISP_TABLE_SIZE)
    return XVECTOR (tem);
  tem = XBUFFER (w->buffer)->display_table;
  if (XTYPE (tem) == Lisp_Vector && XVECTOR (tem)->size == DISP_TABLE_SIZE)
    return XVECTOR (tem);
  tem = Vstandard_display_table;
  if (XTYPE (tem) == Lisp_Vector && XVECTOR (tem)->size == DISP_TABLE_SIZE)
    return XVECTOR (tem);
  return 0;
}

Jim Blandy's avatar
Jim Blandy committed
592
DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
  "Set WINDOW's display-table to TABLE.")
  (window, table)
     register Lisp_Object window, table;
{
  register struct window *w;
  register Lisp_Object z;	/* Return value. */

  w = decode_window (window);
  w->display_table = table;
  return table;
}

/* Record info on buffer window w is displaying
   when it is about to cease to display that buffer.  */
static
unshow_buffer (w)
     register struct window *w;
{
  Lisp_Object buf = w->buffer;

  if (XBUFFER (buf) != XMARKER (w->pointm)->buffer)
    abort ();

  if (w == XWINDOW (selected_window)
      || ! EQ (buf, XWINDOW (selected_window)->buffer))
    /* Do this except when the selected window's buffer
       is being removed from some other window.  */
    XBUFFER (buf)->last_window_start = marker_position (w->start);

  /* Point in the selected window's buffer
     is actually stored in that buffer, and the window's pointm isn't used.
     So don't clobber point in that buffer.  */
  if (! EQ (buf, XWINDOW (selected_window)->buffer))
    BUF_PT (XBUFFER (buf))
      = clip_to_bounds (BUF_BEGV (XBUFFER (buf)),
			marker_position (w->pointm),
			BUF_ZV (XBUFFER (buf)));
}

/* Put replacement into the window structure in place of old. */
static
replace_window (old, replacement)
     Lisp_Object old, replacement;
{
  register Lisp_Object tem;
  register struct window *o = XWINDOW (old), *p = XWINDOW (replacement);

Jim Blandy's avatar
Jim Blandy committed
640 641
  /* If OLD is its frame's root_window, then replacement is the new
     root_window for that frame.  */
Jim Blandy's avatar
Jim Blandy committed
642

643
  if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
Jim Blandy's avatar
Jim Blandy committed
644
    FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
Jim Blandy's avatar
Jim Blandy committed
645 646 647 648 649 650 651

  p->left = o->left;
  p->top = o->top;
  p->width = o->width;
  p->height = o->height;

  p->next = tem = o->next;
Jim Blandy's avatar
Jim Blandy committed
652
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
653 654 655
    XWINDOW (tem)->prev = replacement;

  p->prev = tem = o->prev;
Jim Blandy's avatar
Jim Blandy committed
656
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
657 658 659
    XWINDOW (tem)->next = replacement;

  p->parent = tem = o->parent;
Jim Blandy's avatar
Jim Blandy committed
660
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
    {
      if (EQ (XWINDOW (tem)->vchild, old))
	XWINDOW (tem)->vchild = replacement;
      if (EQ (XWINDOW (tem)->hchild, old))
	XWINDOW (tem)->hchild = replacement;
    }

/*** Here, if replacement is a vertical combination
and so is its new parent, we should make replacement's
children be children of that parent instead.  ***/
}

DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
  "Remove WINDOW from the display.  Default is selected window.")
  (window)
     register Lisp_Object window;
{
  register Lisp_Object tem, parent, sib;
  register struct window *p;
  register struct window *par;

682 683 684
  /* Because this function is called by other C code on non-leaf
     windows, the CHECK_LIVE_WINDOW macro would choke inappropriately,
     so we can't decode_window here.  */
Jim Blandy's avatar
Jim Blandy committed
685
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
686 687 688 689
    window = selected_window;
  else
    CHECK_WINDOW (window, 0);
  p = XWINDOW (window);
690 691 692 693 694 695 696

  /* It's okay to delete an already-deleted window.  */
  if (NILP (p->buffer)
      && NILP (p->hchild)
      && NILP (p->vchild))
    return Qnil;

Jim Blandy's avatar
Jim Blandy committed
697
  parent = p->parent;
Jim Blandy's avatar
Jim Blandy committed
698
  if (NILP (parent))
Jim Blandy's avatar
Jim Blandy committed
699 700 701 702 703
    error ("Attempt to delete minibuffer or sole ordinary window");
  par = XWINDOW (parent);

  windows_or_buffers_changed++;

704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
  /* Are we trying to delete any frame's selected window?  */
  {
    Lisp_Object frame = WINDOW_FRAME (XWINDOW (window));

    if (EQ (window, FRAME_SELECTED_WINDOW (XFRAME (frame))))
      {
	Lisp_Object alternative = Fnext_window (window, Qlambda, Qnil);

	/* If we're about to delete the selected window on the
	   selected frame, then we should use Fselect_window to select
	   the new window.  On the other hand, if we're about to
	   delete the selected window on any other frame, we shouldn't do
	   anything but set the frame's selected_window slot.  */
	if (EQ (window, selected_window))
	  Fselect_window (alternative);
	else
	  FRAME_SELECTED_WINDOW (XFRAME (frame)) = alternative;
      }
  }
Jim Blandy's avatar
Jim Blandy committed
723 724 725 726

  tem = p->buffer;
  /* tem is null for dummy parent windows
     (which have inferiors but not any contents themselves) */
Jim Blandy's avatar
Jim Blandy committed
727
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
728 729 730 731 732 733 734
    {
      unshow_buffer (p);
      unchain_marker (p->pointm);
      unchain_marker (p->start);
    }

  tem = p->next;
Jim Blandy's avatar
Jim Blandy committed
735
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
736 737 738
    XWINDOW (tem)->prev = p->prev;

  tem = p->prev;
Jim Blandy's avatar
Jim Blandy committed
739
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
740 741 742 743 744 745 746 747 748
    XWINDOW (tem)->next = p->next;

  if (EQ (window, par->hchild))
    par->hchild = p->next;
  if (EQ (window, par->vchild))
    par->vchild = p->next;

  /* Find one of our siblings to give our space to.  */
  sib = p->prev;
Jim Blandy's avatar
Jim Blandy committed
749
  if (NILP (sib))
Jim Blandy's avatar
Jim Blandy committed
750 751 752 753 754 755
    {
      /* If p gives its space to its next sibling, that sibling needs
	 to have its top/left side pulled back to where p's is.
	 set_window_{height,width} will re-position the sibling's
	 children.  */
      sib = p->next;
756 757
      XWINDOW (sib)->top = p->top;
      XWINDOW (sib)->left = p->left;
Jim Blandy's avatar
Jim Blandy committed
758 759 760
    }

  /* Stretch that sibling.  */
Jim Blandy's avatar
Jim Blandy committed
761
  if (!NILP (par->vchild))
Jim Blandy's avatar
Jim Blandy committed
762 763 764
    set_window_height (sib,
		       XFASTINT (XWINDOW (sib)->height) + XFASTINT (p->height),
		       1);
Jim Blandy's avatar
Jim Blandy committed
765
  if (!NILP (par->hchild))
Jim Blandy's avatar
Jim Blandy committed
766 767 768 769 770 771 772
    set_window_width (sib,
		      XFASTINT (XWINDOW (sib)->width) + XFASTINT (p->width),
		      1);

  /* If parent now has only one child,
     put the child into the parent's place.  */
  tem = par->hchild;
Jim Blandy's avatar
Jim Blandy committed
773
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
774
    tem = par->vchild;
Jim Blandy's avatar
Jim Blandy committed
775
  if (NILP (XWINDOW (tem)->next))
Jim Blandy's avatar
Jim Blandy committed
776
    replace_window (parent, tem);
777 778 779 780 781 782 783 784 785 786 787

  /* Since we may be deleting combination windows, we must make sure that
     not only p but all its children have been marked as deleted.  */
  if (! NILP (p->hchild))
    delete_all_subwindows (XWINDOW (p->hchild));
  else if (! NILP (p->vchild))
    delete_all_subwindows (XWINDOW (p->vchild));

  /* Mark this window as deleted.  */
  p->buffer = p->hchild = p->vchild = Qnil;

Jim Blandy's avatar
Jim Blandy committed
788 789 790 791
  return Qnil;
}


Jim Blandy's avatar
Jim Blandy committed
792
extern Lisp_Object next_frame (), prev_frame ();
Jim Blandy's avatar
Jim Blandy committed
793 794 795

DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
  "Return next window after WINDOW in canonical ordering of windows.\n\
Jim Blandy's avatar
Jim Blandy committed
796 797 798 799 800 801 802
If omitted, WINDOW defaults to the selected window.\n\
\n\
Optional second arg MINIBUF t means count the minibuffer window even\n\
if not active.  MINIBUF nil or omitted means count the minibuffer iff\n\
it is active.  MINIBUF neither t nor nil means not to count the\n\
minibuffer even if it is active.\n\
\n\
Jim Blandy's avatar
Jim Blandy committed
803 804
Several frames may share a single minibuffer; if the minibuffer\n\
counts, all windows on all frames that share that minibuffer count\n\
Jim Blandy's avatar
Jim Blandy committed
805
too.  This means that next-window may be used to iterate through the\n\
Jim Blandy's avatar
Jim Blandy committed
806 807
set of windows even when the minibuffer is on another frame.  If the\n\
minibuffer does not count, only windows from WINDOW's frame count.\n\
Jim Blandy's avatar
Jim Blandy committed
808
\n\
Jim Blandy's avatar
Jim Blandy committed
809 810
Optional third arg ALL-FRAMES t means include windows on all frames.\n\
ALL-FRAMES nil or omitted means cycle within the frames as specified\n\
Jim Blandy's avatar
Jim Blandy committed
811 812 813 814 815 816
above.  If neither nil nor t, restrict to WINDOW's frame.\n\
\n\
If you use consistent values for MINIBUF and ALL-FRAMES, you can use\n\
`next-window' to iterate through the entire cycle of acceptable\n\
windows, eventually ending up back at the window you started with.\n\
`previous-window' traverses the same cycle, in the reverse order.")
Jim Blandy's avatar
Jim Blandy committed
817 818
  (window, minibuf, all_frames)
     register Lisp_Object window, minibuf, all_frames;
Jim Blandy's avatar
Jim Blandy committed
819 820
{
  register Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
821
  Lisp_Object start_window;
Jim Blandy's avatar
Jim Blandy committed
822

Jim Blandy's avatar
Jim Blandy committed
823
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
824 825
    window = selected_window;
  else
826
    CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
827

Jim Blandy's avatar
Jim Blandy committed
828 829 830 831
  start_window = window;

  /* minibuf == nil may or may not include minibuffers.
     Decide if it does.  */
Jim Blandy's avatar
Jim Blandy committed
832
  if (NILP (minibuf))
Jim Blandy's avatar
Jim Blandy committed
833 834
    minibuf = (minibuf_level ? Qt : Qlambda);

Jim Blandy's avatar
Jim Blandy committed
835 836 837 838 839 840 841
  /* all_frames == nil doesn't specify which frames to include.
     Decide which frames it includes.  */
  if (NILP (all_frames))
    all_frames = (EQ (minibuf, Qt)
		   ? (FRAME_MINIBUF_WINDOW
		      (XFRAME
		       (WINDOW_FRAME
Jim Blandy's avatar
Jim Blandy committed
842 843
			(XWINDOW (window)))))
		   : Qnil);
Jim Blandy's avatar
Jim Blandy committed
844 845
  else if (! EQ (all_frames, Qt))
    all_frames = Qnil;
Jim Blandy's avatar
Jim Blandy committed
846 847 848 849 850 851 852

  /* Do this loop at least once, to get the next window, and perhaps
     again, if we hit the minibuffer and that is not acceptable.  */
  do
    {
      /* Find a window that actually has a next one.  This loop
	 climbs up the tree.  */
Jim Blandy's avatar
Jim Blandy committed
853 854
      while (tem = XWINDOW (window)->next, NILP (tem))
	if (tem = XWINDOW (window)->parent, !NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
855
	  window = tem;
Jim Blandy's avatar
Jim Blandy committed
856
	else
Jim Blandy's avatar
Jim Blandy committed
857
	  {
Jim Blandy's avatar
Jim Blandy committed
858 859 860 861 862 863
	    /* We've reached the end of this frame.
	       Which other frames are acceptable?  */
	    tem = WINDOW_FRAME (XWINDOW (window));
#ifdef MULTI_FRAME
	    if (! NILP (all_frames))
	      tem = next_frame (tem, all_frames);
Jim Blandy's avatar
Jim Blandy committed
864
#endif
Jim Blandy's avatar
Jim Blandy committed
865
	    tem = FRAME_ROOT_WINDOW (XFRAME (tem));
Jim Blandy's avatar
Jim Blandy committed
866

Jim Blandy's avatar
Jim Blandy committed
867 868 869 870
	    break;
	  }

      window = tem;
Jim Blandy's avatar
Jim Blandy committed
871

Jim Blandy's avatar
Jim Blandy committed
872 873 874 875
      /* If we're in a combination window, find its first child and
	 recurse on that.  Otherwise, we've found the window we want.  */
      while (1)
	{
Jim Blandy's avatar
Jim Blandy committed
876
	  if (!NILP (XWINDOW (window)->hchild))
Jim Blandy's avatar
Jim Blandy committed
877
	    window = XWINDOW (window)->hchild;
Jim Blandy's avatar
Jim Blandy committed
878
	  else if (!NILP (XWINDOW (window)->vchild))
Jim Blandy's avatar
Jim Blandy committed
879 880 881 882
	    window = XWINDOW (window)->vchild;
	  else break;
	}
    }
Jim Blandy's avatar
Jim Blandy committed
883 884
  /* Which windows are acceptible?
     Exit the loop and accept this window if
Jim Blandy's avatar
Jim Blandy committed
885
     this isn't a minibuffer window, or
Jim Blandy's avatar
Jim Blandy committed
886 887
     we're accepting minibuffer windows, or
     we've come all the way around and we're back at the original window.  */
Jim Blandy's avatar
Jim Blandy committed
888
  while (MINI_WINDOW_P (XWINDOW (window))
Jim Blandy's avatar
Jim Blandy committed
889
	 && ! EQ (minibuf, Qt)
890
	 && ! EQ (window, start_window));
Jim Blandy's avatar
Jim Blandy committed
891 892 893 894 895

  return window;
}

DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
896 897 898 899 900 901 902 903
  "Return the window preceeding WINDOW in canonical ordering of windows.\n\
If omitted, WINDOW defaults to the selected window.\n\
\n\
Optional second arg MINIBUF t means count the minibuffer window even\n\
if not active.  MINIBUF nil or omitted means count the minibuffer iff\n\
it is active.  MINIBUF neither t nor nil means not to count the\n\
minibuffer even if it is active.\n\
\n\
Jim Blandy's avatar
Jim Blandy committed
904 905
Several frames may share a single minibuffer; if the minibuffer\n\
counts, all windows on all frames that share that minibuffer count\n\
Jim Blandy's avatar
Jim Blandy committed
906
too.  This means that previous-window may be used to iterate through\n\
Jim Blandy's avatar
Jim Blandy committed
907 908
the set of windows even when the minibuffer is on another frame.  If\n\
the minibuffer does not count, only windows from WINDOW's frame\n\
Jim Blandy's avatar
Jim Blandy committed
909 910
count.\n\
\n\
Jim Blandy's avatar
Jim Blandy committed
911 912
Optional third arg ALL-FRAMES t means include windows on all frames.\n\
ALL-FRAMES nil or omitted means cycle within the frames as specified\n\
Jim Blandy's avatar
Jim Blandy committed
913 914 915 916 917 918
above.  If neither nil nor t, restrict to WINDOW's frame.\n\
\n\
If you use consistent values for MINIBUF and ALL-FRAMES, you can use\n\
`previous-window' to iterate through the entire cycle of acceptable\n\
windows, eventually ending up back at the window you started with.\n\
`next-window' traverses the same cycle, in the reverse order.")
Jim Blandy's avatar
Jim Blandy committed
919 920
  (window, minibuf, all_frames)
     register Lisp_Object window, minibuf, all_frames;
Jim Blandy's avatar
Jim Blandy committed
921 922
{
  register Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
923
  Lisp_Object start_window;
Jim Blandy's avatar
Jim Blandy committed
924

Jim Blandy's avatar
Jim Blandy committed
925
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
926 927
    window = selected_window;
  else
928
    CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
929

Jim Blandy's avatar
Jim Blandy committed
930 931 932 933
  start_window = window;

  /* minibuf == nil may or may not include minibuffers.
     Decide if it does.  */
Jim Blandy's avatar
Jim Blandy committed
934
  if (NILP (minibuf))
Jim Blandy's avatar
Jim Blandy committed
935 936
    minibuf = (minibuf_level ? Qt : Qlambda);

Jim Blandy's avatar
Jim Blandy committed
937 938 939 940 941 942 943
  /* all_frames == nil doesn't specify which frames to include.
     Decide which frames it includes.  */
  if (NILP (all_frames))
    all_frames = (EQ (minibuf, Qt)
		   ? (FRAME_MINIBUF_WINDOW
		      (XFRAME
		       (WINDOW_FRAME
Jim Blandy's avatar
Jim Blandy committed
944 945
			(XWINDOW (window)))))
		   : Qnil);
Jim Blandy's avatar
Jim Blandy committed
946 947
  else if (! EQ (all_frames, Qt))
    all_frames = Qnil;
Jim Blandy's avatar
Jim Blandy committed
948 949 950 951 952 953 954

  /* Do this loop at least once, to get the previous window, and perhaps
     again, if we hit the minibuffer and that is not acceptable.  */
  do
    {
      /* Find a window that actually has a previous one.  This loop
	 climbs up the tree.  */
Jim Blandy's avatar
Jim Blandy committed
955 956
      while (tem = XWINDOW (window)->prev, NILP (tem))
	if (tem = XWINDOW (window)->parent, !NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
957
	  window = tem;
Jim Blandy's avatar
Jim Blandy committed
958
	else
Jim Blandy's avatar
Jim Blandy committed
959
	  {
Jim Blandy's avatar
Jim Blandy committed
960 961 962 963 964
	    /* We have found the top window on the frame.
	       Which frames are acceptable?  */
	    tem = WINDOW_FRAME (XWINDOW (window));
#ifdef MULTI_FRAME
	    if (! NILP (all_frames))
Jim Blandy's avatar
Jim Blandy committed
965 966 967 968 969 970 971 972 973 974
	      /* It's actually important that we use prev_frame here,
		 rather than next_frame.  All the windows acceptable
		 according to the given parameters should form a ring;
		 Fnext_window and Fprevious_window should go back and
		 forth around the ring.  If we use next_frame here,
		 then Fnext_window and Fprevious_window take different
		 paths through the set of acceptable windows.
		 window_loop assumes that these `ring' requirement are
		 met.  */
	      tem = prev_frame (tem, all_frames);
Jim Blandy's avatar
Jim Blandy committed
975
#endif
Jim Blandy's avatar
Jim Blandy committed
976
	    tem = FRAME_ROOT_WINDOW (XFRAME (tem));
Jim Blandy's avatar
Jim Blandy committed
977

Jim Blandy's avatar
Jim Blandy committed
978 979 980 981 982 983 984 985
	    break;
	  }

      window = tem;
      /* If we're in a combination window, find its last child and
	 recurse on that.  Otherwise, we've found the window we want.  */
      while (1)
	{
Jim Blandy's avatar
Jim Blandy committed
986
	  if (!NILP (XWINDOW (window)->hchild))
Jim Blandy's avatar
Jim Blandy committed
987
	    window = XWINDOW (window)->hchild;
Jim Blandy's avatar
Jim Blandy committed
988
	  else if (!NILP (XWINDOW (window)->vchild))
Jim Blandy's avatar
Jim Blandy committed
989 990
	    window = XWINDOW (window)->vchild;
	  else break;
Jim Blandy's avatar
Jim Blandy committed
991
	  while (tem = XWINDOW (window)->next, !NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
992 993 994
	    window = tem;
	}
    }
Jim Blandy's avatar
Jim Blandy committed
995 996
  /* Which windows are acceptable?
     Exit the loop and accept this window if
Jim Blandy's avatar
Jim Blandy committed
997
     this isn't a minibuffer window, or
Jim Blandy's avatar
Jim Blandy committed
998 999
     we're accepting minibuffer windows, or
     we've come all the way around and we're back at the original window.  */
Jim Blandy's avatar
Jim Blandy committed
1000
  while (MINI_WINDOW_P (XWINDOW (window))
Jim Blandy's avatar
Jim Blandy committed
1001
	 && !EQ (minibuf, Qt)
1002
	 && !EQ (window, start_window));
Jim Blandy's avatar
Jim Blandy committed
1003 1004 1005 1006

  return window;
}

Jim Blandy's avatar
Jim Blandy committed
1007
DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
Jim Blandy's avatar
Jim Blandy committed
1008 1009
  "Select the ARG'th different window on this frame.\n\
All windows on current frame are arranged in a cyclic order.\n\
Jim Blandy's avatar
Jim Blandy committed
1010 1011
This command selects the window ARG steps away in that order.\n\
A negative ARG moves in the opposite order.  If the optional second\n\
Jim Blandy's avatar
Jim Blandy committed
1012 1013 1014
argument ALL_FRAMES is non-nil, cycle through all frames.")
  (n, all_frames)
     register Lisp_Object n, all_frames;
Jim Blandy's avatar
Jim Blandy committed
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
{
  register int i;
  register Lisp_Object w;

  CHECK_NUMBER (n, 0);
  w = selected_window;
  i = XINT (n);

  while (i > 0)
    {
Jim Blandy's avatar
Jim Blandy committed
1025
      w = Fnext_window (w, Qnil, all_frames);
Jim Blandy's avatar
Jim Blandy committed
1026 1027 1028 1029
      i--;
    }
  while (i < 0)
    {
Jim Blandy's avatar
Jim Blandy committed
1030
      w = Fprevious_window (w, Qnil, all_frames);
Jim Blandy's avatar
Jim Blandy committed
1031 1032 1033 1034 1035 1036 1037 1038
      i++;
    }
  Fselect_window (w);
  return Qnil;
}

/* Look at all windows, performing an operation specified by TYPE
   with argument OBJ.
Jim Blandy's avatar
Jim Blandy committed
1039 1040
   If FRAMES is Qt, look at all frames, if Qnil, look at just the selected
   frame.  If FRAMES is a frame, just look at windows on that frame.
Jim Blandy's avatar
Jim Blandy committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
   If MINI is non-zero, perform the operation on minibuffer windows too.
*/

enum window_loop
{
  WINDOW_LOOP_UNUSED,
  GET_BUFFER_WINDOW,		/* Arg is buffer */
  GET_LRU_WINDOW,		/* Arg is t for full-width windows only */
  DELETE_OTHER_WINDOWS,		/* Arg is window not to delete */
  DELETE_BUFFER_WINDOWS,	/* Arg is buffer */
  GET_LARGEST_WINDOW,
  UNSHOW_BUFFER,		/* Arg is buffer */
};

static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
1056
window_loop (type, obj, mini, frames)
Jim Blandy's avatar
Jim Blandy committed
1057
     enum window_loop type;
Jim Blandy's avatar
Jim Blandy committed
1058
     register Lisp_Object obj, frames;
Jim Blandy's avatar
Jim Blandy committed
1059 1060 1061 1062 1063
     int mini;
{
  register Lisp_Object w;
  register Lisp_Object best_window;
  register Lisp_Object next_window;
1064
  register Lisp_Object last_window;
Jim Blandy's avatar
Jim Blandy committed
1065 1066
  FRAME_PTR frame;

1067
#ifdef MULTI_FRAME
Jim Blandy's avatar
Jim Blandy committed
1068 1069 1070 1071 1072 1073 1074
  /* If we're only looping through windows on a particular frame,
     frame points to that frame.  If we're looping through windows
     on all frames, frame is 0.  */
  if (FRAMEP (frames))
    frame = XFRAME (frames);
  else if (NILP (frames))
    frame = selected_frame;
Jim Blandy's avatar
Jim Blandy committed
1075
  else
Jim Blandy's avatar
Jim Blandy committed
1076
    frame = 0;
1077 1078 1079
#else
  frame = 0;
#endif
Jim Blandy's avatar
Jim Blandy committed
1080 1081 1082

  /* Pick a window to start with.  */
  if (XTYPE (obj) == Lisp_Window)
1083
    w = obj;
Jim Blandy's avatar
Jim Blandy committed
1084
  else if (frame)
1085
    w = FRAME_SELECTED_WINDOW (frame);
Jim Blandy's avatar
Jim Blandy committed
1086
  else
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
    w = FRAME_SELECTED_WINDOW (selected_frame);

  /* Figure out the last window we're going to mess with.  Since
     Fnext_window, given the same options, is guaranteed to go in a
     ring, we can just use Fprevious_window to find the last one.

     We can't just wait until we hit the first window again, because
     it might be deleted.  */

#ifdef MULTI_FRAME
  if (frame)
    last_window = Fprevious_window (w, (mini ? Qt : Qnil), Qlambda);
  else
#endif	/* MULTI_FRAME */
    /* We know frame is 0, so we're looping through all frames.
       Or we know this isn't a MULTI_FRAME Emacs, so who cares?  */
    last_window = Fprevious_window (w, mini ? Qt : Qnil, Qt);
Jim Blandy's avatar
Jim Blandy committed
1104 1105

  best_window = Qnil;
1106
  for (;;)
Jim Blandy's avatar
Jim Blandy committed
1107 1108 1109
    {
      /* Pick the next window now, since some operations will delete
	 the current window.  */
Jim Blandy's avatar
Jim Blandy committed
1110 1111
#ifdef MULTI_FRAME
      if (frame)
Jim Blandy's avatar
Jim Blandy committed
1112
	next_window = Fnext_window (w, (mini ? Qt : Qnil), Qlambda);
Jim Blandy's avatar
Jim Blandy committed
1113
      else
1114
#endif				/* MULTI_FRAME */
Jim Blandy's avatar
Jim Blandy committed
1115 1116
	/* We know frame is 0, so we're looping through all frames.
	   Or we know this isn't a MULTI_FRAME Emacs, so who cares?  */
Jim Blandy's avatar
Jim Blandy committed
1117 1118 1119 1120 1121 1122 1123 1124
	next_window = Fnext_window (w, mini ? Qt : Qnil, Qt);

      if (!MINI_WINDOW_P (XWINDOW (w))
	  || (mini && minibuf_level > 0))
	switch (type)
	  {
	  case GET_BUFFER_WINDOW:
#if 0
Jim Blandy's avatar
Jim Blandy committed
1125 1126 1127
	    /* Ignore invisible and iconified frames.  */
	    if (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (w))))
		|| FRAME_ICONIFIED_P (XFRAME (WINDOW_FRAME (XWINDOW (w)))))
Jim Blandy's avatar
Jim Blandy committed
1128 1129 1130 1131 1132 1133 1134 1135
	      break;
#endif
	    if (XBUFFER (XWINDOW (w)->buffer) == XBUFFER (obj))
	      return w;
	    break;

	  case GET_LRU_WINDOW:
	    /* t as arg means consider only full-width windows */
Jim Blandy's avatar
Jim Blandy committed
1136
	    if (!NILP (obj) && XFASTINT (XWINDOW (w)->width)
Jim Blandy's avatar
Jim Blandy committed
1137
		!= FRAME_WIDTH (frame))
Jim Blandy's avatar
Jim Blandy committed
1138 1139
	      break;
#if 0
Jim Blandy's avatar
Jim Blandy committed
1140 1141 1142
	    /* Ignore invisible and iconified frames.  */
	    if (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (w))))
		|| FRAME_ICONIFIED_P (XFRAME (WINDOW_FRAME (XWINDOW (w)))))
Jim Blandy's avatar
Jim Blandy committed
1143 1144 1145 1146
	      break;
#endif
	    /* Ignore dedicated windows and minibuffers.  */
	    if (MINI_WINDOW_P (XWINDOW (w))
Jim Blandy's avatar
Jim Blandy committed
1147
		|| !NILP (XWINDOW (w)->dedicated))
Jim Blandy's avatar
Jim Blandy committed
1148
	      break;
Jim Blandy's avatar
Jim Blandy committed
1149
	    if (NILP (best_window)
Jim Blandy's avatar
Jim Blandy committed
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
		|| (XFASTINT (XWINDOW (best_window)->use_time)
		    > XFASTINT (XWINDOW (w)->use_time)))
	      best_window = w;
	    break;

	  case DELETE_OTHER_WINDOWS:
	    if (XWINDOW (w) != XWINDOW (obj))
	      Fdelete_window (w);
	    break;

	  case DELETE_BUFFER_WINDOWS:
	    if (EQ (XWINDOW (w)->buffer, obj))
	      {
		/* If we're deleting the buffer displayed in the only window
Jim Blandy's avatar
Jim Blandy committed
1164
		   on the frame, find a new buffer to display there.  */
Jim Blandy's avatar
Jim Blandy committed
1165
		if (NILP (XWINDOW (w)->parent))
Jim Blandy's avatar
Jim Blandy committed
1166
		  {
1167
		    Lisp_Object new_buffer = Fother_buffer (obj, Qnil);
Jim Blandy's avatar
Jim Blandy committed
1168
		    if (NILP (new_buffer))
Jim Blandy's avatar
Jim Blandy committed
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
		      new_buffer
			= Fget_buffer_create (build_string ("*scratch*"));
		    Fset_window_buffer (w, new_buffer);
		    Fset_buffer (XWINDOW (w)->buffer);
		  }
		else
		  Fdelete_window (w);
	      }
	    break;

	  case GET_LARGEST_WINDOW:
#if 0
Jim Blandy's avatar
Jim Blandy committed
1181 1182 1183
	    /* Ignore invisible and iconified frames.  */
	    if (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (w))))
		|| FRAME_ICONIFIED_P (XFRAME (WINDOW_FRAME (XWINDOW (w)))))
Jim Blandy's avatar
Jim Blandy committed
1184 1185 1186 1187
	      break;
#endif
	    /* Ignore dedicated windows and minibuffers.  */
	    if (MINI_WINDOW_P (XWINDOW (w))
Jim Blandy's avatar
Jim Blandy committed
1188
		|| !NILP (XWINDOW (w)->dedicated))
Jim Blandy's avatar
Jim Blandy committed
1189 1190 1191 1192
	      break;
	    {
	      struct window *best_window_ptr = XWINDOW (best_window);
	      struct window *w_ptr = XWINDOW (w);
Jim Blandy's avatar
Jim Blandy committed
1193
	      if (NILP (best_window) ||
Jim Blandy's avatar
Jim Blandy committed
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
		  (XFASTINT (w_ptr->height) * XFASTINT (w_ptr->width))
		  > (XFASTINT (best_window_ptr->height)
		     * XFASTINT (best_window_ptr->width)))
		best_window = w;
	    }
	    break;

	  case UNSHOW_BUFFER:
	    if (EQ (XWINDOW (w)->buffer, obj))
	      {
		/* Find another buffer to show in this window.  */
1205
		Lisp_Object another_buffer = Fother_buffer (obj, Qnil);
Jim Blandy's avatar
Jim Blandy committed
1206
		if (NILP (another_buffer))
Jim Blandy's avatar
Jim Blandy committed
1207 1208 1209 1210 1211 1212 1213 1214
		  another_buffer
		    = Fget_buffer_create (build_string ("*scratch*"));
		Fset_window_buffer (w, another_buffer);
		if (EQ (w, selected_window))
		  Fset_buffer (XWINDOW (w)->buffer);
	      }
	    break;
	  }
1215 1216 1217 1218

      if (EQ (w, last_window))
	break;

Jim Blandy's avatar
Jim Blandy committed
1219 1220 1221 1222 1223
      w = next_window;
    }

  return best_window;
}     
1224

Jim Blandy's avatar
Jim Blandy committed
1225 1226
DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 1, 0,
  "Return the window least recently selected or used for display.\n\
Jim Blandy's avatar
Jim Blandy committed
1227 1228 1229 1230
If optional argument FRAMES is t, search all frames.  If FRAME is a\n\
frame, search only that frame.\n")
  (frames)
    Lisp_Object frames;
Jim Blandy's avatar
Jim Blandy committed
1231 1232 1233
{
  register Lisp_Object w;
  /* First try for a window that is full-width */
Jim Blandy's avatar
Jim Blandy committed
1234
  w = window_loop (GET_LRU_WINDOW, Qt, 0, frames);
Jim Blandy's avatar
Jim Blandy committed
1235
  if (!NILP (w) && !EQ (w, selected_window))
Jim Blandy's avatar
Jim Blandy committed
1236 1237
    return w;
  /* If none of them, try the rest */
Jim Blandy's avatar
Jim Blandy committed
1238
  return window_loop (GET_LRU_WINDOW, Qnil, 0, frames);
Jim Blandy's avatar
Jim Blandy committed
1239 1240 1241 1242
}

DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 1, 0,
  "Return the largest window in area.\n\
Jim Blandy's avatar
Jim Blandy committed
1243 1244 1245 1246
If optional argument FRAMES is t, search all frames.  If FRAME is a\n\
frame, search only that frame.\n")
  (frame)
    Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
1247 1248
{
  return window_loop (GET_LARGEST_WINDOW, Qnil, 0,
Jim Blandy's avatar
Jim Blandy committed
1249
		      frame);
Jim Blandy's avatar
Jim Blandy committed
1250 1251 1252 1253
}

DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 1, 2, 0,
  "Return a window currently displaying BUFFER, or nil if none.\n\
Jim Blandy's avatar
Jim Blandy committed
1254 1255 1256 1257
If optional argument FRAMES is t, search all frames.  If FRAME is a\n\
frame, search only that frame.\n")
  (buffer, frame)
    Lisp_Object buffer, frame;
Jim Blandy's avatar
Jim Blandy committed
1258 1259 1260
{
  buffer = Fget_buffer (buffer);
  if (XTYPE (buffer) == Lisp_Buffer)
Jim Blandy's avatar
Jim Blandy committed
1261
    return window_loop (GET_BUFFER_WINDOW, buffer, 1, frame);
Jim Blandy's avatar
Jim Blandy committed
1262 1263 1264 1265 1266 1267
  else
    return Qnil;
}

DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
  0, 1, "",
Jim Blandy's avatar
Jim Blandy committed
1268 1269
  "Make WINDOW (or the selected window) fill its frame.\n\
Only the frame WINDOW is on is affected.")
Jim Blandy's avatar
Jim Blandy committed
1270 1271 1272 1273 1274 1275 1276 1277
  (window)
     Lisp_Object window;
{
  struct window *w;
  int opoint = point;
  struct buffer *obuf = current_buffer;
  int top;

Jim Blandy's avatar
Jim Blandy committed
1278
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
1279 1280
    window = selected_window;
  else
1281
    CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
1282 1283 1284 1285

  w = XWINDOW (window);
  top = XFASTINT (w->top);

1286
  window_loop (DELETE_OTHER_WINDOWS, window, 0, WINDOW_FRAME (w));
Jim Blandy's avatar
Jim Blandy committed
1287 1288 1289

  Fset_buffer (w->buffer);
  SET_PT (marker_position (w->start));
1290
  Frecenter (make_number (top - FRAME_MENU_BAR_LINES (XFRAME (WINDOW_FRAME (w)))));
Jim Blandy's avatar
Jim Blandy committed
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302

  set_buffer_internal (obuf);
  SET_PT (opoint);
  return Qnil;
}

DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
  1, 1, "bDelete windows on (buffer): ",
  "Delete all windows showing BUFFER.")
  (buffer)
     Lisp_Object buffer;
{
Jim Blandy's avatar
Jim Blandy committed
1303
  if (!NILP