window.c 87.2 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
/* Window creation, deletion and examination for GNU Emacs.
   Does not include redisplay.
Jim Blandy's avatar
Jim Blandy committed
3
   Copyright (C) 1985, 1986, 1987, 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, Qwindow_live_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
   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;

/* 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
73 74
/* Nonzero implies make new frames for Fdisplay_buffer.  */
int pop_up_frames;
Jim Blandy's avatar
Jim Blandy committed
75 76

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

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

102
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
103 104 105 106 107 108 109 110 111
  "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
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
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
135
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
136 137 138 139 140 141 142 143 144 145 146 147
  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;
}

148 149 150 151 152 153
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
154
{
Jim Blandy's avatar
Jim Blandy committed
155
#ifdef MULTI_FRAME
156 157 158 159 160 161 162
  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
163 164
}

165
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
166 167 168 169 170 171 172 173 174 175
  "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
176
  "Return t if position POS is currently on the frame in WINDOW.\n\
Jim Blandy's avatar
Jim Blandy committed
177 178 179 180 181 182 183 184 185 186 187 188
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
189
  if (NILP (pos))
Jim Blandy's avatar
Jim Blandy committed
190 191 192 193 194 195 196
    posint = point;
  else
    {
      CHECK_NUMBER_COERCE_MARKER (pos, 0);
      posint = XINT (pos);
    }

197
  w = decode_window (window);
Jim Blandy's avatar
Jim Blandy committed
198 199 200 201 202 203 204 205 206 207
  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
208
      /* If frame is up to date,
Jim Blandy's avatar
Jim Blandy committed
209 210 211 212 213 214 215 216 217 218 219 220 221
	 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,
222
				window_internal_width (w) - 1,
Jim Blandy's avatar
Jim Blandy committed
223 224 225 226 227 228 229 230 231 232
				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
233
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
234 235
    return XWINDOW (selected_window);

236
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
  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);
262
  register int width = XFASTINT (w->width);
Jim Blandy's avatar
Jim Blandy committed
263

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

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);
288
  if (XINT (w->hscroll) != XINT (ncol))
Jim Blandy's avatar
Jim Blandy committed
289 290 291 292 293 294 295
    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
296
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.\n\
Jim Blandy's avatar
Jim Blandy committed
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
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
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
/* 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
337
      && ! MINI_WINDOW_P (w))
Jim Blandy's avatar
Jim Blandy committed
338 339 340 341
    return 2;
  
  /* Is the character in the right border?  */
  if (*x == left + width - 1
Jim Blandy's avatar
Jim Blandy committed
342
      && left + width != FRAME_WIDTH (XFRAME (w->frame)))
Jim Blandy's avatar
Jim Blandy committed
343 344 345 346 347 348 349 350 351 352
    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
353
COORDINATES is a cons of the form (X . Y), X and Y being distances\n\
Jim Blandy's avatar
Jim Blandy committed
354
measured in characters from the upper-left corner of the frame.\n\
Jim Blandy's avatar
Jim Blandy committed
355
(0 .  0) denotes the character in the upper left corner of the\n\
Jim Blandy's avatar
Jim Blandy committed
356
frame.\n\
Jim Blandy's avatar
Jim Blandy committed
357 358
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
359
If they are in the mode line of WINDOW, `mode-line' is returned.\n\
Jim Blandy's avatar
Jim Blandy committed
360
If they are on the border between WINDOW and its right sibling,\n\
Jim Blandy's avatar
Jim Blandy committed
361
   `vertical-line' is returned.")
Jim Blandy's avatar
Jim Blandy committed
362 363 364 365 366
  (coordinates, window)
     register Lisp_Object coordinates, window;
{
  int x, y;

367
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
  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
384
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
385 386 387 388 389 390

    default:
      abort ();
    }
}

Jim Blandy's avatar
Jim Blandy committed
391
/* Find the window containing column x, row y, and return it as a
Jim Blandy's avatar
Jim Blandy committed
392 393 394 395
   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
396
Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
397 398
window_from_coordinates (frame, x, y, part)
     FRAME_PTR frame;
Jim Blandy's avatar
Jim Blandy committed
399
     int x, y;
Jim Blandy's avatar
Jim Blandy committed
400
     int *part;
Jim Blandy's avatar
Jim Blandy committed
401 402 403
{
  register Lisp_Object tem, first;

Jim Blandy's avatar
Jim Blandy committed
404
  tem = first = FRAME_SELECTED_WINDOW (frame);
Jim Blandy's avatar
Jim Blandy committed
405

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

      if (found)
	{
Jim Blandy's avatar
Jim Blandy committed
412
	  *part = found - 1;
Jim Blandy's avatar
Jim Blandy committed
413 414 415
	  return tem;
	}

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

423
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
424
  "Return window containing coordinates X and Y on FRAME.\n\
Jim Blandy's avatar
Jim Blandy committed
425 426
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
427
column 0.")
Richard M. Stallman's avatar
Richard M. Stallman committed
428 429
  (x, y, frame)
      Lisp_Object x, y, frame;
Jim Blandy's avatar
Jim Blandy committed
430 431 432
{
  int part;

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

Jim Blandy's avatar
Jim Blandy committed
442
  return window_from_coordinates (XFRAME (frame),
Richard M. Stallman's avatar
Richard M. Stallman committed
443
				  XINT (x), XINT (y),
Jim Blandy's avatar
Jim Blandy committed
444 445 446 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
				  &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
519
  if (NILP (noforce))
Jim Blandy's avatar
Jim Blandy committed
520 521 522
    w->force_start = Qt;
  w->update_mode_line = Qt;
  XFASTINT (w->last_modified) = 0;
Jim Blandy's avatar
Jim Blandy committed
523 524
  if (!EQ (window, selected_window))
    windows_or_buffers_changed++;
Jim Blandy's avatar
Jim Blandy committed
525 526 527 528 529 530
  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\
531
See also `set-window-dedicated-p'.")
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536 537
  (window)
     Lisp_Object window;
{
  return decode_window (window)->dedicated;
}

538 539 540 541 542 543 544
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
545 546 547 548 549
  (window, arg)
       Lisp_Object window, arg;
{
  register struct window *w = decode_window (window);

Jim Blandy's avatar
Jim Blandy committed
550
  if (NILP (arg))
Jim Blandy's avatar
Jim Blandy committed
551 552
    w->dedicated = Qnil;
  else
553
    w->dedicated = Qt;
Jim Blandy's avatar
Jim Blandy committed
554 555 556 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

  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
589
DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
590 591 592 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
  "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
637 638
  /* 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
639

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

  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
649
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
650 651 652
    XWINDOW (tem)->prev = replacement;

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

  p->parent = tem = o->parent;
Jim Blandy's avatar
Jim Blandy committed
657
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
    {
      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;

679 680 681
  /* 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
682
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
683 684 685 686
    window = selected_window;
  else
    CHECK_WINDOW (window, 0);
  p = XWINDOW (window);
687 688 689 690 691 692 693

  /* 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
694
  parent = p->parent;
Jim Blandy's avatar
Jim Blandy committed
695
  if (NILP (parent))
Jim Blandy's avatar
Jim Blandy committed
696 697 698 699 700
    error ("Attempt to delete minibuffer or sole ordinary window");
  par = XWINDOW (parent);

  windows_or_buffers_changed++;

701 702
  /* Are we trying to delete any frame's selected window?  */
  {
703
    Lisp_Object frame, pwindow;
704

705 706 707 708 709 710 711 712 713 714 715 716 717 718
    /* See if the frame's selected window is either WINDOW
       or any subwindow of it, by finding all that window's parents
       and comparing each one with WINDOW.  */
    frame = WINDOW_FRAME (XWINDOW (window));
    pwindow = FRAME_SELECTED_WINDOW (XFRAME (frame));

    while (!NILP (pwindow))
      {
	if (EQ (window, pwindow))
	  break;
	pwindow = XWINDOW (pwindow)->parent;
      }

    if (EQ (window, pwindow))
719 720 721 722 723 724 725 726 727 728 729
      {
	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
730
	  FRAME_SELECTED_WINDOW (XFRAME (frame)) = alternative;
731 732
      }
  }
Jim Blandy's avatar
Jim Blandy committed
733 734 735 736

  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
737
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
738 739 740 741 742 743 744
    {
      unshow_buffer (p);
      unchain_marker (p->pointm);
      unchain_marker (p->start);
    }

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

  tem = p->prev;
Jim Blandy's avatar
Jim Blandy committed
749
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
750 751 752 753 754 755 756 757 758
    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
759
  if (NILP (sib))
Jim Blandy's avatar
Jim Blandy committed
760 761 762 763 764 765
    {
      /* 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;
766 767
      XWINDOW (sib)->top = p->top;
      XWINDOW (sib)->left = p->left;
Jim Blandy's avatar
Jim Blandy committed
768 769 770
    }

  /* Stretch that sibling.  */
Jim Blandy's avatar
Jim Blandy committed
771
  if (!NILP (par->vchild))
Jim Blandy's avatar
Jim Blandy committed
772 773 774
    set_window_height (sib,
		       XFASTINT (XWINDOW (sib)->height) + XFASTINT (p->height),
		       1);
Jim Blandy's avatar
Jim Blandy committed
775
  if (!NILP (par->hchild))
Jim Blandy's avatar
Jim Blandy committed
776 777 778 779 780 781 782
    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
783
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
784
    tem = par->vchild;
Jim Blandy's avatar
Jim Blandy committed
785
  if (NILP (XWINDOW (tem)->next))
Jim Blandy's avatar
Jim Blandy committed
786
    replace_window (parent, tem);
787 788 789 790 791 792 793 794 795 796 797

  /* 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
798 799 800 801
  return Qnil;
}


Jim Blandy's avatar
Jim Blandy committed
802
extern Lisp_Object next_frame (), prev_frame ();
Jim Blandy's avatar
Jim Blandy committed
803 804 805

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
806 807 808 809 810 811 812
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
813 814
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
815
too.  This means that next-window may be used to iterate through the\n\
Jim Blandy's avatar
Jim Blandy committed
816 817
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
818
\n\
Jim Blandy's avatar
Jim Blandy committed
819 820
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
821 822 823 824 825 826
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
827 828
  (window, minibuf, all_frames)
     register Lisp_Object window, minibuf, all_frames;
Jim Blandy's avatar
Jim Blandy committed
829 830
{
  register Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
831
  Lisp_Object start_window;
Jim Blandy's avatar
Jim Blandy committed
832

Jim Blandy's avatar
Jim Blandy committed
833
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
834 835
    window = selected_window;
  else
836
    CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
837

Jim Blandy's avatar
Jim Blandy committed
838 839 840 841
  start_window = window;

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

Jim Blandy's avatar
Jim Blandy committed
845 846 847 848 849 850 851
  /* 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
852 853
			(XWINDOW (window)))))
		   : Qnil);
Jim Blandy's avatar
Jim Blandy committed
854 855
  else if (! EQ (all_frames, Qt))
    all_frames = Qnil;
856 857 858
  /* Now all_frames is t meaning search all frames,
     nil meaning search just current frame,
     or a window, meaning search the frame that window belongs to.  */
Jim Blandy's avatar
Jim Blandy committed
859 860 861 862 863 864 865

  /* 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
866 867
      while (tem = XWINDOW (window)->next, NILP (tem))
	if (tem = XWINDOW (window)->parent, !NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
868
	  window = tem;
Jim Blandy's avatar
Jim Blandy committed
869
	else
Jim Blandy's avatar
Jim Blandy committed
870
	  {
Jim Blandy's avatar
Jim Blandy committed
871 872 873 874 875 876
	    /* 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
877
#endif
Jim Blandy's avatar
Jim Blandy committed
878
	    tem = FRAME_ROOT_WINDOW (XFRAME (tem));
Jim Blandy's avatar
Jim Blandy committed
879

Jim Blandy's avatar
Jim Blandy committed
880 881 882 883
	    break;
	  }

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

Jim Blandy's avatar
Jim Blandy committed
885 886 887 888
      /* 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
889
	  if (!NILP (XWINDOW (window)->hchild))
Jim Blandy's avatar
Jim Blandy committed
890
	    window = XWINDOW (window)->hchild;
Jim Blandy's avatar
Jim Blandy committed
891
	  else if (!NILP (XWINDOW (window)->vchild))
Jim Blandy's avatar
Jim Blandy committed
892 893 894 895
	    window = XWINDOW (window)->vchild;
	  else break;
	}
    }
Jim Blandy's avatar
Jim Blandy committed
896 897
  /* Which windows are acceptible?
     Exit the loop and accept this window if
Jim Blandy's avatar
Jim Blandy committed
898
     this isn't a minibuffer window, or
Jim Blandy's avatar
Jim Blandy committed
899 900
     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
901
  while (MINI_WINDOW_P (XWINDOW (window))
Jim Blandy's avatar
Jim Blandy committed
902
	 && ! EQ (minibuf, Qt)
903
	 && ! EQ (window, start_window));
Jim Blandy's avatar
Jim Blandy committed
904 905 906 907 908

  return window;
}

DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
909 910 911 912 913 914 915 916
  "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
917 918
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
919
too.  This means that previous-window may be used to iterate through\n\
Jim Blandy's avatar
Jim Blandy committed
920 921
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
922 923
count.\n\
\n\
Jim Blandy's avatar
Jim Blandy committed
924 925
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
926 927 928 929 930 931
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
932 933
  (window, minibuf, all_frames)
     register Lisp_Object window, minibuf, all_frames;
Jim Blandy's avatar
Jim Blandy committed
934 935
{
  register Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
936
  Lisp_Object start_window;
Jim Blandy's avatar
Jim Blandy committed
937

Jim Blandy's avatar
Jim Blandy committed
938
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
939 940
    window = selected_window;
  else
941
    CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
942

Jim Blandy's avatar
Jim Blandy committed
943 944 945 946
  start_window = window;

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

Jim Blandy's avatar
Jim Blandy committed
950 951 952 953 954 955 956
  /* 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
957 958
			(XWINDOW (window)))))
		   : Qnil);
Jim Blandy's avatar
Jim Blandy committed
959 960
  else if (! EQ (all_frames, Qt))
    all_frames = Qnil;
961 962 963
  /* Now all_frames is t meaning search all frames,
     nil meaning search just current frame,
     or a window, meaning search the frame that window belongs to.  */
Jim Blandy's avatar
Jim Blandy committed
964 965 966 967 968 969 970

  /* 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
971 972
      while (tem = XWINDOW (window)->prev, NILP (tem))
	if (tem = XWINDOW (window)->parent, !NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
973
	  window = tem;
Jim Blandy's avatar
Jim Blandy committed
974
	else
Jim Blandy's avatar
Jim Blandy committed
975
	  {
Jim Blandy's avatar
Jim Blandy committed
976 977 978 979 980
	    /* 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
981 982 983 984 985 986 987 988 989 990
	      /* 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
991
#endif
992 993
	    /* If this frame has a minibuffer, find that window first,
	       because it is conceptually the last window in that frame.  */
994 995 996
	    if (FRAME_HAS_MINIBUF_P (XFRAME (tem)))
	      tem = FRAME_MINIBUF_WINDOW (XFRAME (tem));
	    else
997
	      tem = FRAME_ROOT_WINDOW (XFRAME (tem));
Jim Blandy's avatar
Jim Blandy committed
998

Jim Blandy's avatar
Jim Blandy committed
999 1000 1001 1002 1003 1004 1005 1006
	    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
1007
	  if (!NILP (XWINDOW (window)->hchild))
Jim Blandy's avatar
Jim Blandy committed
1008
	    window = XWINDOW (window)->hchild;
Jim Blandy's avatar
Jim Blandy committed
1009
	  else if (!NILP (XWINDOW (window)->vchild))
Jim Blandy's avatar
Jim Blandy committed
1010 1011
	    window = XWINDOW (window)->vchild;
	  else break;
Jim Blandy's avatar
Jim Blandy committed
1012
	  while (tem = XWINDOW (window)->next, !NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1013 1014 1015
	    window = tem;
	}
    }
Jim Blandy's avatar
Jim Blandy committed
1016 1017
  /* Which windows are acceptable?
     Exit the loop and accept this window if
Jim Blandy's avatar
Jim Blandy committed
1018
     this isn't a minibuffer window, or
Jim Blandy's avatar
Jim Blandy committed
1019 1020
     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
1021
  while (MINI_WINDOW_P (XWINDOW (window))
Jim Blandy's avatar
Jim Blandy committed
1022
	 && !EQ (minibuf, Qt)
1023
	 && !EQ (window, start_window));
Jim Blandy's avatar
Jim Blandy committed
1024 1025 1026 1027

  return window;
}

Jim Blandy's avatar
Jim Blandy committed
1028
DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
Jim Blandy's avatar
Jim Blandy committed
1029 1030
  "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
1031 1032
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
1033 1034 1035
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
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
{
  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
1046
      w = Fnext_window (w, Qnil, all_frames);
Jim Blandy's avatar
Jim Blandy committed
1047 1048 1049 1050
      i--;
    }
  while (i < 0)
    {
Jim Blandy's avatar
Jim Blandy committed
1051
      w = Fprevious_window (w, Qnil, all_frames);
Jim Blandy's avatar
Jim Blandy committed
1052 1053 1054 1055 1056 1057 1058 1059
      i++;
    }
  Fselect_window (w);
  return Qnil;
}

/* Look at all windows, performing an operation specified by TYPE
   with argument OBJ.
1060 1061 1062
   If FRAMES is Qt, look at all frames;
                Qnil, look at just the selected frame;
	        a frame, just look at windows on that frame.
Jim Blandy's avatar
Jim Blandy committed
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
   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
1078
window_loop (type, obj, mini, frames)
Jim Blandy's avatar
Jim Blandy committed
1079
     enum window_loop type;
Jim Blandy's avatar
Jim Blandy committed
1080
     register Lisp_Object obj, frames;
Jim Blandy's avatar
Jim Blandy committed
1081 1082 1083 1084 1085
     int mini;
{
  register Lisp_Object w;
  register Lisp_Object best_window;
  register Lisp_Object next_window;
1086
  register Lisp_Object last_window;
Jim Blandy's avatar
Jim Blandy committed
1087 1088
  FRAME_PTR frame;

1089
#ifdef MULTI_FRAME
Jim Blandy's avatar
Jim Blandy committed
1090 1091 1092 1093 1094 1095 1096
  /* 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
1097
  else
Jim Blandy's avatar
Jim Blandy committed
1098
    frame = 0;
1099 1100 1101
#else
  frame = 0;
#endif
Jim Blandy's avatar
Jim Blandy committed
1102 1103 1104

  /* Pick a window to start with.  */
  if (XTYPE (obj) == Lisp_Window)
1105
    w = obj;
Jim Blandy's avatar
Jim Blandy committed
1106
  else if (frame)
1107
    w = FRAME_SELECTED_WINDOW (frame);
Jim Blandy's avatar
Jim Blandy committed
1108
  else
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
    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
1126 1127

  best_window = Qnil;
1128
  for (;;)
Jim Blandy's avatar
Jim Blandy committed
1129
    {
1130 1131
      FRAME_PTR w_frame = XFRAME (WINDOW_FRAME (XWINDOW (w)));

Jim Blandy's avatar
Jim Blandy committed
1132 1133
      /* Pick the next window now, since some operations will delete
	 the current window.  */
Jim Blandy's avatar
Jim Blandy committed
1134 1135
#ifdef MULTI_FRAME
      if (frame)
Jim Blandy's avatar
Jim Blandy committed
1136
	next_window = Fnext_window (w, (mini ? Qt : Qnil), Qlambda);
Jim Blandy's avatar
Jim Blandy committed
1137
      else
1138
#endif				/* MULTI_FRAME */
Jim Blandy's avatar
Jim Blandy committed
1139 1140
	/* 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
1141 1142
	next_window = Fnext_window (w, mini ? Qt : Qnil, Qt);

1143
      if (! MINI_WINDOW_P (XWINDOW (w))
Jim Blandy's avatar
Jim Blandy committed
1144 1145 1146 1147
	  || (mini && minibuf_level > 0))
	switch (type)
	  {
	  case GET_BUFFER_WINDOW:
1148 1149 1150
	    /* Ignore invisible and iconified frames.  */
	    if (! FRAME_VISIBLE_P (w_frame)
		|| FRAME_ICONIFIED_P (w_frame))
Jim Blandy's avatar
Jim Blandy committed
1151 1152 1153 1154 1155 1156 1157
	      break;
	    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
1158
	    if (!NILP (obj) && XFASTINT (XWINDOW (w)->width)
1159
		!= FRAME_WIDTH (XFRAME (WINDOW_FRAME (XWINDOW (w)))))
Jim Blandy's avatar
Jim Blandy committed
1160 1161
	      break;
#if 0
Jim Blandy's avatar
Jim Blandy committed
1162 1163 1164
	    /* 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
1165 1166 1167 1168
	      break;
#endif
	    /* Ignore dedicated windows and minibuffers.  */
	    if (MINI_WINDOW_P (XWINDOW (w))
Jim Blandy's avatar
Jim Blandy committed
1169
		|| !NILP (XWINDOW (w)->dedicated))
Jim Blandy's avatar
Jim Blandy committed
1170
	      break;
Jim Blandy's avatar
Jim Blandy committed
1171
	    if (NILP (best_window)
Jim Blandy's avatar
Jim Blandy committed
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
		|| (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
1186
		   on the frame, find a new buffer to display there.  */
Jim Blandy's avatar
Jim Blandy committed
1187
		if (NILP (XWINDOW (w)->parent))
Jim Blandy's avatar
Jim Blandy committed
1188
		  {
1189
		    Lisp_Object new_buffer = Fother_buffer (obj, Qnil);
Jim Blandy's avatar
Jim Blandy committed
1190
		    if (NILP (new_buffer))
Jim Blandy's avatar
Jim Blandy committed
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
		      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
1203 1204 1205
	    /* 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
1206 1207 1208 1209
	      break;
#endif
	    /* Ignore dedicated windows and minibuffers.  */
	    if (MINI_WINDOW_P (XWINDOW (w))
Jim Blandy's avatar
Jim Blandy committed
1210
		|| !NILP (XWINDOW (w)->dedicated))
Jim Blandy's avatar
Jim Blandy committed
1211 1212 1213 1214
	      break;
	    {
	      struct window *best_window_ptr = XWINDOW (best_window);
	      struct window *w_ptr = XWINDOW (w);
Jim Blandy's avatar
Jim Blandy committed
1215
	      if (NILP (best_window) ||
Jim Blandy's avatar
Jim Blandy committed
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
		  (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.  */
1227
		Lisp_Object another_buffer = Fother_buffer (obj, Qnil);
Jim Blandy's avatar
Jim Blandy committed
1228
		if (NILP (another_buffer))
Jim Blandy's avatar
Jim Blandy committed
1229 1230 1231 1232 1233 1234 1235 1236
		  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;
	  }
1237 1238 1239 1240

      if (EQ (w, last_window))
	break;

Jim Blandy's avatar
Jim Blandy committed
1241 1242 1243 1244 1245
      w = next_window;
    }

  return best_window;
}     
1246

Jim Blandy's avatar
Jim Blandy committed
1247 1248
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
1249 1250 1251 1252
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
1253 1254 1255
{
  register Lisp_Object w;
  /* First try for a window that is full-width */
Jim Blandy's avatar
Jim Blandy committed
1256
  w = window_loop (GET_LRU_WINDOW, Qt, 0, frames);
Jim Blandy's avatar
Jim Blandy committed
1257
  if (!NILP (w) && !EQ (w, selected_window))
Jim Blandy's avatar
Jim Blandy committed
1258 1259
    return w;
  /* If none of them, try the rest */
Jim Blandy's avatar
Jim Blandy committed
1260
  return window_loop (GET_LRU_WINDOW, Qnil, 0, frames);
Jim Blandy's avatar
Jim Blandy committed
1261 1262 1263 1264
}

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
1265 1266 1267 1268
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
1269 1270
{
  return window_loop (GET_LARGEST_WINDOW, Qnil, 0,
Jim Blandy's avatar
Jim Blandy committed
1271
		      frame);
Jim Blandy's avatar
Jim Blandy committed
1272 1273 1274 1275
}

DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 1, 2, 0,
  "Return a window currently displaying BUFFER, or nil if none.\n\
1276 1277
If optional argument FRAME is t, search all visible frames.\n\
If FRAME is nil, search only the selected frame.\n\
1278
If FRAME is a frame, search only that frame.\n")
Jim Blandy's avatar