window.c 98 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, 1993, 1994 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
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.  */

21
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
22 23
#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

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

82 83 84 85 86 87 88 89 90
/* List of buffer *names* for buffers that should have their own frames.  */
Lisp_Object Vspecial_display_buffer_names;

/* List of regexps for buffer names that should have their own frames.  */
Lisp_Object Vspecial_display_regexps;

/* Function to pop up a special frame.  */
Lisp_Object Vspecial_display_function;

Jim Blandy's avatar
Jim Blandy committed
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
/* 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;
}

111
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
112 113 114 115 116 117 118 119 120
  "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
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
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
144
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
145 146 147 148 149 150 151 152 153 154 155 156
  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;
}

157 158 159 160 161 162
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
163
{
Jim Blandy's avatar
Jim Blandy committed
164
#ifdef MULTI_FRAME
165 166 167 168 169 170 171
  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
172 173
}

174
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
175 176 177 178 179 180 181 182 183 184
  "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
185
  "Return t if position POS is currently on the frame in WINDOW.\n\
Jim Blandy's avatar
Jim Blandy committed
186 187 188 189 190 191 192 193 194 195 196
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;
197
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
198

Jim Blandy's avatar
Jim Blandy committed
199
  if (NILP (pos))
Karl Heuer's avatar
Karl Heuer committed
200
    posint = PT;
Jim Blandy's avatar
Jim Blandy committed
201 202 203 204 205 206
  else
    {
      CHECK_NUMBER_COERCE_MARKER (pos, 0);
      posint = XINT (pos);
    }

207
  w = decode_window (window);
Jim Blandy's avatar
Jim Blandy committed
208
  top = marker_position (w->start);
209
  hscroll = XINT (w->hscroll);
Jim Blandy's avatar
Jim Blandy committed
210 211 212 213 214 215 216 217 218

  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
219
      /* If frame is up to date,
Jim Blandy's avatar
Jim Blandy committed
220 221 222 223 224 225 226 227
	 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
    {
228
      if (posint > BUF_ZV (buf))
Jim Blandy's avatar
Jim Blandy committed
229 230
	return Qnil;

231 232 233 234
      /* w->start can be out of range.  If it is, do something reasonable.  */
      if (top < BUF_BEGV (buf) || top > BUF_ZV (buf))
	return Qnil;

Jim Blandy's avatar
Jim Blandy committed
235
      /* If that info is not correct, calculate afresh */
236 237
      posval = *compute_motion (top, 0, (hscroll ? 1 - hscroll : 0),
				posint, height, 0,
238
				window_internal_width (w) - 1,
239
				hscroll, 0, w);
Jim Blandy's avatar
Jim Blandy committed
240 241 242 243 244 245 246 247 248

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

252
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
  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,
273 274 275 276
  "Return the number of display columns in WINDOW.\n\
This is the width that is usable columns available for text in WINDOW.\n\
If you want to find out how many columns WINDOW takes up,\n\
use  (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))).")
Jim Blandy's avatar
Jim Blandy committed
277 278 279
  (window)
     Lisp_Object window;
{
280
  return make_number (window_internal_width (decode_window (window)));
Jim Blandy's avatar
Jim Blandy committed
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
}

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

383
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
  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
400
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
401 402 403 404 405 406

    default:
      abort ();
    }
}

Jim Blandy's avatar
Jim Blandy committed
407
/* Find the window containing column x, row y, and return it as a
Jim Blandy's avatar
Jim Blandy committed
408 409 410 411
   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
412
Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
413 414
window_from_coordinates (frame, x, y, part)
     FRAME_PTR frame;
Jim Blandy's avatar
Jim Blandy committed
415
     int x, y;
Jim Blandy's avatar
Jim Blandy committed
416
     int *part;
Jim Blandy's avatar
Jim Blandy committed
417 418 419
{
  register Lisp_Object tem, first;

Jim Blandy's avatar
Jim Blandy committed
420
  tem = first = FRAME_SELECTED_WINDOW (frame);
Jim Blandy's avatar
Jim Blandy committed
421

Jim Blandy's avatar
Jim Blandy committed
422
  do
Jim Blandy's avatar
Jim Blandy committed
423 424 425 426 427
    {
      int found = coordinates_in_window (XWINDOW (tem), &x, &y);

      if (found)
	{
Jim Blandy's avatar
Jim Blandy committed
428
	  *part = found - 1;
Jim Blandy's avatar
Jim Blandy committed
429 430 431
	  return tem;
	}

Jim Blandy's avatar
Jim Blandy committed
432
      tem = Fnext_window (tem, Qt, Qlambda);
Jim Blandy's avatar
Jim Blandy committed
433
    }
Jim Blandy's avatar
Jim Blandy committed
434 435 436
  while (! EQ (tem, first));
  
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
437 438
}

439
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
440
  "Return window containing coordinates X and Y on FRAME.\n\
Jim Blandy's avatar
Jim Blandy committed
441 442
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
443
column 0.")
Richard M. Stallman's avatar
Richard M. Stallman committed
444 445
  (x, y, frame)
      Lisp_Object x, y, frame;
Jim Blandy's avatar
Jim Blandy committed
446 447 448
{
  int part;

449
#ifdef MULTI_FRAME
Jim Blandy's avatar
Jim Blandy committed
450 451
  if (NILP (frame))
    XSET (frame, Lisp_Frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
452
  else
Jim Blandy's avatar
Jim Blandy committed
453
    CHECK_LIVE_FRAME (frame, 2);
454
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
455 456
  CHECK_NUMBER (x, 0);
  CHECK_NUMBER (y, 1);
Jim Blandy's avatar
Jim Blandy committed
457

Jim Blandy's avatar
Jim Blandy committed
458
  return window_from_coordinates (XFRAME (frame),
Richard M. Stallman's avatar
Richard M. Stallman committed
459
				  XINT (x), XINT (y),
Jim Blandy's avatar
Jim Blandy committed
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
				  &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,
Richard M. Stallman's avatar
Richard M. Stallman committed
493 494 495 496
  "Return position at which display currently ends in WINDOW.\n\
This is updated by redisplay, when it runs to completion.\n\
Simply changing the buffer text or setting `window-start'\n\
does not update this value.")
Jim Blandy's avatar
Jim Blandy committed
497 498 499 500 501
  (window)
     Lisp_Object window;
{
  Lisp_Object value;
  struct window *w = decode_window (window);
502 503 504 505 506
  Lisp_Object buf;

  buf = w->buffer;
  CHECK_BUFFER (buf, 0);

Jim Blandy's avatar
Jim Blandy committed
507
  XSET (value, Lisp_Int,
508
	BUF_Z (XBUFFER (buf)) - XFASTINT (w->window_end_pos));
Jim Blandy's avatar
Jim Blandy committed
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541

  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
542
  if (NILP (noforce))
Jim Blandy's avatar
Jim Blandy committed
543 544 545
    w->force_start = Qt;
  w->update_mode_line = Qt;
  XFASTINT (w->last_modified) = 0;
Jim Blandy's avatar
Jim Blandy committed
546 547
  if (!EQ (window, selected_window))
    windows_or_buffers_changed++;
Jim Blandy's avatar
Jim Blandy committed
548 549 550 551 552 553
  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\
554
See also `set-window-dedicated-p'.")
Jim Blandy's avatar
Jim Blandy committed
555 556 557 558 559 560
  (window)
     Lisp_Object window;
{
  return decode_window (window)->dedicated;
}

561 562 563 564 565 566 567
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
568 569 570 571 572
  (window, arg)
       Lisp_Object window, arg;
{
  register struct window *w = decode_window (window);

Jim Blandy's avatar
Jim Blandy committed
573
  if (NILP (arg))
Jim Blandy's avatar
Jim Blandy committed
574 575
    w->dedicated = Qnil;
  else
576
    w->dedicated = Qt;
Jim Blandy's avatar
Jim Blandy committed
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611

  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
612
DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
  "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;
{
631
  Lisp_Object buf;
Jim Blandy's avatar
Jim Blandy committed
632

633
  buf = w->buffer;
Jim Blandy's avatar
Jim Blandy committed
634 635 636
  if (XBUFFER (buf) != XMARKER (w->pointm)->buffer)
    abort ();

637
#if 0
Jim Blandy's avatar
Jim Blandy committed
638 639 640 641
  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.  */
642 643 644 645 646 647 648 649
#endif
    /* last_window_start records the start position that this buffer
       had in the last window to be disconnected from it.
       Now that this statement is unconditional,
       it is possible for the buffer to be displayed in the
       selected window, while last_window_start reflects another
       window which was recently showing the same buffer.
       Some people might say that might be a good thing.  Let's see.  */
Jim Blandy's avatar
Jim Blandy committed
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
    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
670 671
  /* 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
672

673
  if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
Jim Blandy's avatar
Jim Blandy committed
674
    FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
Jim Blandy's avatar
Jim Blandy committed
675 676 677 678 679 680 681

  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
682
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
683 684 685
    XWINDOW (tem)->prev = replacement;

  p->prev = tem = o->prev;
Jim Blandy's avatar
Jim Blandy committed
686
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
687 688 689
    XWINDOW (tem)->next = replacement;

  p->parent = tem = o->parent;
Jim Blandy's avatar
Jim Blandy committed
690
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
    {
      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;

712 713 714
  /* 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
715
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
716 717 718 719
    window = selected_window;
  else
    CHECK_WINDOW (window, 0);
  p = XWINDOW (window);
720 721 722 723 724 725 726

  /* 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
727
  parent = p->parent;
Jim Blandy's avatar
Jim Blandy committed
728
  if (NILP (parent))
Jim Blandy's avatar
Jim Blandy committed
729 730 731 732 733
    error ("Attempt to delete minibuffer or sole ordinary window");
  par = XWINDOW (parent);

  windows_or_buffers_changed++;

734 735
  /* Are we trying to delete any frame's selected window?  */
  {
736
    Lisp_Object frame, pwindow;
737

738 739 740 741 742 743 744 745 746 747 748 749 750 751
    /* 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))
752
      {
753 754
	Lisp_Object alternative;
	alternative = Fnext_window (window, Qlambda, Qnil);
755 756 757 758 759 760 761 762 763

	/* 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
764
	  FRAME_SELECTED_WINDOW (XFRAME (frame)) = alternative;
765 766
      }
  }
Jim Blandy's avatar
Jim Blandy committed
767 768 769 770

  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
771
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
772 773 774 775 776 777 778
    {
      unshow_buffer (p);
      unchain_marker (p->pointm);
      unchain_marker (p->start);
    }

  tem = p->next;
Jim Blandy's avatar
Jim Blandy committed
779
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
780 781 782
    XWINDOW (tem)->prev = p->prev;

  tem = p->prev;
Jim Blandy's avatar
Jim Blandy committed
783
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
784 785 786 787 788 789 790 791 792
    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
793
  if (NILP (sib))
Jim Blandy's avatar
Jim Blandy committed
794 795 796 797 798 799
    {
      /* 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;
800 801
      XWINDOW (sib)->top = p->top;
      XWINDOW (sib)->left = p->left;
Jim Blandy's avatar
Jim Blandy committed
802 803 804
    }

  /* Stretch that sibling.  */
Jim Blandy's avatar
Jim Blandy committed
805
  if (!NILP (par->vchild))
Jim Blandy's avatar
Jim Blandy committed
806 807 808
    set_window_height (sib,
		       XFASTINT (XWINDOW (sib)->height) + XFASTINT (p->height),
		       1);
Jim Blandy's avatar
Jim Blandy committed
809
  if (!NILP (par->hchild))
Jim Blandy's avatar
Jim Blandy committed
810 811 812 813 814 815 816
    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
817
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
818
    tem = par->vchild;
Jim Blandy's avatar
Jim Blandy committed
819
  if (NILP (XWINDOW (tem)->next))
Jim Blandy's avatar
Jim Blandy committed
820
    replace_window (parent, tem);
821 822 823 824 825 826 827 828 829 830 831

  /* 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
832 833 834 835
  return Qnil;
}


Jim Blandy's avatar
Jim Blandy committed
836
extern Lisp_Object next_frame (), prev_frame ();
Jim Blandy's avatar
Jim Blandy committed
837

838 839 840 841 842
/* This comment supplies the doc string for `next-window',
   for make-docfile to see.  We cannot put this in the real DEFUN
   due to limits in the Unix cpp.

DEFUN ("next-window", Ffoo, Sfoo, 0, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
843
  "Return next window after WINDOW in canonical ordering of windows.\n\
Jim Blandy's avatar
Jim Blandy committed
844 845 846 847 848 849 850
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
851 852
Several frames may share a single minibuffer; if the minibuffer\n\
counts, all windows on all frames that share that minibuffer count\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
853
too.  Therefore, `next-window' can be used to iterate through the\n\
Jim Blandy's avatar
Jim Blandy committed
854 855
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
856
\n\
Jim Blandy's avatar
Jim Blandy committed
857 858
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\
859
above.  ALL-FRAMES = `visible' means include windows on all visible frames.\n\
860
ALL-FRAMES = 0 means include windows on all visible and iconified frames.\n\
861
Anything else means restrict to WINDOW's frame.\n\
Jim Blandy's avatar
Jim Blandy committed
862 863 864 865 866
\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.")
867 868 869 870
  (window, minibuf, all_frames) */

DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
       0)
Jim Blandy's avatar
Jim Blandy committed
871 872
  (window, minibuf, all_frames)
     register Lisp_Object window, minibuf, all_frames;
Jim Blandy's avatar
Jim Blandy committed
873 874
{
  register Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
875
  Lisp_Object start_window;
Jim Blandy's avatar
Jim Blandy committed
876

Jim Blandy's avatar
Jim Blandy committed
877
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
878 879
    window = selected_window;
  else
880
    CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
881

Jim Blandy's avatar
Jim Blandy committed
882 883 884 885
  start_window = window;

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

889
#ifdef MULTI_FRAME
890
  /* all_frames == nil doesn't specify which frames to include.  */
Jim Blandy's avatar
Jim Blandy committed
891 892
  if (NILP (all_frames))
    all_frames = (EQ (minibuf, Qt)
893 894 895 896 897
		  ? (FRAME_MINIBUF_WINDOW
		     (XFRAME
		      (WINDOW_FRAME
		       (XWINDOW (window)))))
		  : Qnil);
898 899
  else if (EQ (all_frames, Qvisible))
    ;
900 901
  else if (XFASTINT (all_frames) == 0)
    ;
Jim Blandy's avatar
Jim Blandy committed
902 903
  else if (! EQ (all_frames, Qt))
    all_frames = Qnil;
904 905
  /* Now all_frames is t meaning search all frames,
     nil meaning search just current frame,
906 907
     visible meaning search just visible frames,
     0 meaning search visible and iconified frames,
908
     or a window, meaning search the frame that window belongs to.  */
909
#endif
Jim Blandy's avatar
Jim Blandy committed
910 911 912 913 914 915 916

  /* 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
917 918
      while (tem = XWINDOW (window)->next, NILP (tem))
	if (tem = XWINDOW (window)->parent, !NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
919
	  window = tem;
Jim Blandy's avatar
Jim Blandy committed
920
	else
Jim Blandy's avatar
Jim Blandy committed
921
	  {
Jim Blandy's avatar
Jim Blandy committed
922 923 924 925 926
	    /* 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))
927 928 929 930 931 932 933 934 935 936 937 938 939
	      {
		Lisp_Object tem1;

		tem1 = tem;
		tem = next_frame (tem, all_frames);
		/* In the case where the minibuffer is active,
		   and we include its frame as well as the selected one,
		   next_frame may get stuck in that frame.
		   If that happens, go back to the selected frame
		   so we can complete the cycle.  */
		if (EQ (tem, tem1))
		  XSET (tem, Lisp_Frame, selected_frame);
	      }
Jim Blandy's avatar
Jim Blandy committed
940
#endif
Jim Blandy's avatar
Jim Blandy committed
941
	    tem = FRAME_ROOT_WINDOW (XFRAME (tem));
Jim Blandy's avatar
Jim Blandy committed
942

Jim Blandy's avatar
Jim Blandy committed
943 944 945 946
	    break;
	  }

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

Jim Blandy's avatar
Jim Blandy committed
948 949 950 951
      /* 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
952
	  if (!NILP (XWINDOW (window)->hchild))
Jim Blandy's avatar
Jim Blandy committed
953
	    window = XWINDOW (window)->hchild;
Jim Blandy's avatar
Jim Blandy committed
954
	  else if (!NILP (XWINDOW (window)->vchild))
Jim Blandy's avatar
Jim Blandy committed
955 956 957 958
	    window = XWINDOW (window)->vchild;
	  else break;
	}
    }
Jim Blandy's avatar
Jim Blandy committed
959 960
  /* Which windows are acceptible?
     Exit the loop and accept this window if
Jim Blandy's avatar
Jim Blandy committed
961
     this isn't a minibuffer window, or
Jim Blandy's avatar
Jim Blandy committed
962 963
     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
964
  while (MINI_WINDOW_P (XWINDOW (window))
Jim Blandy's avatar
Jim Blandy committed
965
	 && ! EQ (minibuf, Qt)
966
	 && ! EQ (window, start_window));
Jim Blandy's avatar
Jim Blandy committed
967 968 969 970

  return window;
}

971 972 973 974 975
/* This comment supplies the doc string for `previous-window',
   for make-docfile to see.  We cannot put this in the real DEFUN
   due to limits in the Unix cpp.

DEFUN ("previous-window", Ffoo, Sfoo, 0, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
976 977 978 979 980 981 982 983
  "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
984 985
Several frames may share a single minibuffer; if the minibuffer\n\
counts, all windows on all frames that share that minibuffer count\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
986
too.  Therefore, `previous-window' can be used to iterate through\n\
Jim Blandy's avatar
Jim Blandy committed
987
the set of windows even when the minibuffer is on another frame.  If\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
988
the minibuffer does not count, only windows from WINDOW's frame count\n\
Jim Blandy's avatar
Jim Blandy committed
989
\n\
Jim Blandy's avatar
Jim Blandy committed
990 991
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\
992
above.  ALL-FRAMES = `visible' means include windows on all visible frames.\n\
993
ALL-FRAMES = 0 means include windows on all visible and iconified frames.\n\
994
Anything else means restrict to WINDOW's frame.\n\
Jim Blandy's avatar
Jim Blandy committed
995 996 997 998 999
\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.")
1000 1001 1002 1003 1004
  (window, minibuf, all_frames)  */


DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
       0)
Jim Blandy's avatar
Jim Blandy committed
1005 1006
  (window, minibuf, all_frames)
     register Lisp_Object window, minibuf, all_frames;
Jim Blandy's avatar
Jim Blandy committed
1007 1008
{
  register Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
1009
  Lisp_Object start_window;
Jim Blandy's avatar
Jim Blandy committed
1010

Jim Blandy's avatar
Jim Blandy committed
1011
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
1012 1013
    window = selected_window;
  else
1014
    CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
1015

Jim Blandy's avatar
Jim Blandy committed
1016 1017 1018 1019
  start_window = window;

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

1023
#ifdef MULTI_FRAME
Jim Blandy's avatar
Jim Blandy committed
1024 1025 1026 1027 1028 1029 1030
  /* 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
1031 1032
			(XWINDOW (window)))))
		   : Qnil);
1033 1034
  else if (EQ (all_frames, Qvisible))
    ;
1035 1036
  else if (XFASTINT (all_frames) == 0)
    ;
Jim Blandy's avatar
Jim Blandy committed
1037 1038
  else if (! EQ (all_frames, Qt))
    all_frames = Qnil;
1039 1040
  /* Now all_frames is t meaning search all frames,
     nil meaning search just current frame,
1041 1042
     visible meaning search just visible frames,
     0 meaning search visible and iconified frames,
1043
     or a window, meaning search the frame that window belongs to.  */
1044
#endif
Jim Blandy's avatar
Jim Blandy committed
1045 1046 1047 1048 1049 1050 1051

  /* 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
1052 1053
      while (tem = XWINDOW (window)->prev, NILP (tem))
	if (tem = XWINDOW (window)->parent, !NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1054
	  window = tem;
Jim Blandy's avatar
Jim Blandy committed
1055
	else
Jim Blandy's avatar
Jim Blandy committed
1056
	  {
Jim Blandy's avatar
Jim Blandy committed
1057 1058 1059 1060 1061
	    /* 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
1062 1063 1064 1065 1066 1067 1068 1069 1070
	      /* 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.  */
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
	      {
		Lisp_Object tem1;

		tem1 = tem;
		tem = prev_frame (tem, all_frames);
		/* In the case where the minibuffer is active,
		   and we include its frame as well as the selected one,
		   next_frame may get stuck in that frame.
		   If that happens, go back to the selected frame
		   so we can complete the cycle.  */
		if (EQ (tem, tem1))
		  XSET (tem, Lisp_Frame, selected_frame);
	      }
Jim Blandy's avatar
Jim Blandy committed
1084
#endif
1085 1086
	    /* If this frame has a minibuffer, find that window first,
	       because it is conceptually the last window in that frame.  */
1087 1088 1089
	    if (FRAME_HAS_MINIBUF_P (XFRAME (tem)))
	      tem = FRAME_MINIBUF_WINDOW (XFRAME (tem));
	    else
1090
	      tem = FRAME_ROOT_WINDOW (XFRAME (tem));
Jim Blandy's avatar
Jim Blandy committed
1091

Jim Blandy's avatar
Jim Blandy committed
1092 1093 1094 1095 1096 1097 1098 1099
	    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
1100
	  if (!NILP (XWINDOW (window)->hchild))
Jim Blandy's avatar
Jim Blandy committed
1101
	    window = XWINDOW (window)->hchild;
Jim Blandy's avatar
Jim Blandy committed
1102
	  else if (!NILP (XWINDOW (window)->vchild))
Jim Blandy's avatar
Jim Blandy committed
1103 1104
	    window = XWINDOW (window)->vchild;
	  else break;
Jim Blandy's avatar
Jim Blandy committed
1105
	  while (tem = XWINDOW (window)->next, !NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1106 1107 1108
	    window = tem;
	}
    }
Jim Blandy's avatar
Jim Blandy committed
1109 1110
  /* Which windows are acceptable?
     Exit the loop and accept this window if
Jim Blandy's avatar
Jim Blandy committed
1111
     this isn't a minibuffer window, or
Jim Blandy's avatar
Jim Blandy committed
1112 1113
     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
1114
  while (MINI_WINDOW_P (XWINDOW (window))
Jim Blandy's avatar
Jim Blandy committed
1115
	 && !EQ (minibuf, Qt)
1116
	 && !EQ (window, start_window));
Jim Blandy's avatar
Jim Blandy committed
1117 1118 1119 1120

  return window;
}

Jim Blandy's avatar
Jim Blandy committed
1121
DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
Jim Blandy's avatar
Jim Blandy committed
1122 1123
  "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
1124 1125
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
1126 1127 1128
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
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
{
  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
1139
      w = Fnext_window (w, Qnil, all_frames);
Jim Blandy's avatar
Jim Blandy committed
1140 1141 1142 1143
      i--;
    }
  while (i < 0)
    {
Jim Blandy's avatar
Jim Blandy committed
1144
      w = Fprevious_window (w, Qnil, all_frames);
Jim Blandy's avatar
Jim Blandy committed
1145 1146 1147 1148 1149 1150 1151 1152
      i++;
    }
  Fselect_window (w);
  return Qnil;
}

/* Look at all windows, performing an operation specified by TYPE
   with argument OBJ.
1153 1154
   If FRAMES is Qt, look at all frames;
                Qnil, look at just the selected frame;
1155
		Qvisible, look at visible frames;
1156
	        a frame, just look at windows on that frame.
Jim Blandy's avatar
Jim Blandy committed
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
   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,
1168
  UNSHOW_BUFFER		/* Arg is buffer */
Jim Blandy's avatar
Jim Blandy committed
1169 1170 1171
};

static Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
1172
window_loop (type, obj, mini, frames)
Jim Blandy's avatar
Jim Blandy committed
1173
     enum window_loop type;
Jim Blandy's avatar
Jim Blandy committed
1174
     register Lisp_Object obj, frames;
Jim Blandy's avatar
Jim Blandy committed
1175 1176 1177 1178 1179
     int mini;
{
  register Lisp_Object w;
  register Lisp_Object best_window;
  register Lisp_Object next_window;
1180
  register Lisp_Object last_window;
Jim Blandy's avatar
Jim Blandy committed
1181
  FRAME_PTR frame;
1182 1183
  Lisp_Object frame_arg;
  frame_arg = Qt;
Jim Blandy's avatar
Jim Blandy committed
1184

1185
#ifdef MULTI_FRAME
Jim Blandy's avatar
Jim Blandy committed
1186 1187 1188 1189 1190 1191 1192
  /* 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
1193
  else
Jim Blandy's avatar
Jim Blandy committed
1194
    frame = 0;
1195 1196
  if (frame)
    frame_arg = Qlambda;
1197 1198
  else if (XFASTINT (frames) == 0)
    frame_arg = frames;
1199 1200
  else if (EQ (frames, Qvisible))
    frame_arg = frames;
1201 1202 1203
#else
  frame = 0;
#endif
Jim Blandy's avatar
Jim Blandy committed
1204

1205 1206 1207 1208
  /* frame_arg is Qlambda to stick to one frame,
     Qvisible to consider all visible frames,
     or Qt otherwise.  */

Jim Blandy's avatar
Jim Blandy committed
1209 1210
  /* Pick a window to start with.  */
  if (XTYPE (obj) == Lisp_Window)
1211
    w = obj;
Jim Blandy's avatar
Jim Blandy committed
1212
  else if (frame)
1213
    w = FRAME_SELECTED_WINDOW (frame);
Jim Blandy's avatar
Jim Blandy committed
1214
  else
1215 1216 1217 1218 1219 1220 1221 1222 1223
    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.  */

1224
  last_window = Fprevious_window (w, mini ? Qt : Qnil, frame_arg);
Jim Blandy's avatar
Jim Blandy committed
1225 1226

  best_window = Qnil;
1227
  for (;;)
Jim Blandy's avatar
Jim Blandy committed
1228
    {
1229 1230
      FRAME_PTR w_frame = XFRAME (WINDOW_FRAME (XWINDOW (w)));

Jim Blandy's avatar
Jim Blandy committed
1231 1232
      /* Pick the next window now, since some operations will delete
	 the current window.  */
1233
      next_window = Fnext_window (w, mini ? Qt : Qnil, frame_arg);
Jim Blandy's avatar
Jim Blandy committed
1234

1235 1236 1237
      /* Note that we do not pay attention here to whether
	 the frame is visible, since Fnext_window skips non-visible frames
	 if that is desired, under the control of frame_arg.  */
1238
      if (! MINI_WINDOW_P (XWINDOW (w))
Jim Blandy's avatar
Jim Blandy committed
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
	  || (mini && minibuf_level > 0))
	switch (type)
	  {
	  case GET_BUFFER_WINDOW:
	    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
1249
	    if (!NILP (obj) && XFASTINT (XWINDOW (w)->width)
1250
		!= FRAME_WIDTH (XFRAME (WINDOW_FRAME (XWINDOW (w)))))
Jim Blandy's avatar
Jim Blandy committed
1251 1252 1253
	      break;
	    /* Ignore dedicated windows and minibuffers.  */
	    if (MINI_WINDOW_P (XWINDOW (w))
Jim Blandy's avatar
Jim Blandy committed
1254
		|| !NILP (XWINDOW (w)->dedicated))
Jim Blandy's avatar
Jim Blandy committed
1255
	      break;
Jim Blandy's avatar
Jim Blandy committed
1256
	    if (NILP (best_window)
Jim Blandy's avatar
Jim Blandy committed
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
		|| (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
1271
		   on the frame, find a new buffer to display there.  */
Jim Blandy's avatar
Jim Blandy committed
1272
		if (NILP (XWINDOW (w)->parent))
Jim Blandy's avatar
Jim Blandy committed
1273
		  {
1274 1275
		    Lisp_Object new_buffer;
		    new_buffer = Fother_buffer (obj, Qnil);
Jim Blandy's avatar
Jim Blandy committed
1276
		    if (NILP (new_buffer))
Jim Blandy's avatar
Jim Blandy committed
1277 1278 1279
		      new_buffer
			= Fget_buffer_create (build_string ("*scratch*"));
		    Fset_window_buffer (w, new_buffer);
1280 1281
		    if (EQ (w, selected_window))
		      Fset_buffer (XWINDOW (w)->buffer);
Jim Blandy's avatar
Jim Blandy committed
1282 1283 1284 1285 1286 1287 1288 1289 1290
		  }
		else
		  Fdelete_window (w);
	      }
	    break;

	  case GET_LARGEST_WINDOW:
	    /* Ignore dedicated windows and minibuffers.  */
	    if (MINI_WINDOW_P (XWINDOW (w))
Jim Blandy's avatar
Jim Blandy committed
1291
		|| !NILP (XWINDOW (w)->dedicated))
Jim Blandy's avatar
Jim Blandy committed
1292 1293 1294 1295
	      break;
	    {
	      struct window *best_window_ptr = XWINDOW (best_window);
	      struct window *w_ptr = XWINDOW (w);
1296 1297 1298 1299
	      if (NILP (best_window)
		  || (XFASTINT (w_ptr->height) * XFASTINT (w_ptr->width)
		      > (XFASTINT (best_window_ptr->height)
			 * XFASTINT (best_window_ptr->width))))
Jim Blandy's avatar
Jim Blandy committed
1300 1301 1302 1303 1304 1305 1306 1307
		best_window = w;
	    }
	    break;

	  case UNSHOW_BUFFER:
	    if (EQ (XWINDOW (w)->buffer, obj))
	      {
		/* Find another buffer to show in this window.  */
1308
		Lisp_Object another_buffer;
1309
		FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (w)));
1310
		another_buffer = Fother_buffer (obj, Qnil);
Jim Blandy's avatar
Jim Blandy committed
1311
		if (NILP (another_buffer))
Jim Blandy's avatar
Jim Blandy committed
1312 1313
		  another_buffer
		    = Fget_buffer_create (build_string ("*scratch*"));
1314 1315 1316 1317
#ifdef MULTI_FRAME
		/* If this window is dedicated, and in a frame of its own,
		   kill the frame.  */
		if (EQ (w, FRAME_ROOT_WINDOW (f))
1318
		    && !NILP (XWINDOW (w)->dedicated)
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329
		    && other_visible_frames (f))
		  Fdelete_frame (WINDOW_FRAME (XWINDOW (w)), Qnil);
		else
#endif
		  {
		    /* Otherwise show a different buffer in the window.  */
		    XWINDOW (w)->dedicated = Qnil;
		    Fset_window_buffer (w, another_buffer);
		    if (EQ (w, selected_window))
		      Fset_buffer (XWINDOW (w)->buffer);
		  }
Jim Blandy's avatar
Jim Blandy committed
1330 1331 1332
	      }
	    break;
	  }
1333 1334 1335 1336

      if (EQ (w, last_window))
	break;

Jim Blandy's avatar
Jim Blandy committed
1337 1338 1339 1340 1341
      w = next_window;
    }

  return best_window;
}     
1342

Jim Blandy's avatar
Jim Blandy committed
1343 1344
DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 1, 0,
  "Return the window least recently selected or used for display.\n\
1345
If optional argument FRAME is `visible', search all visible frames.\n\
1346
If FRAME is 0, search all visible and iconified frames.\n\
1347 1348 1349 1350 1351
If FRAME is t, search all frames.\n\
If FRAME is nil, search only the selected frame.\n\
If FRAME is a frame, search only that frame.")
  (frame)
    Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
1352 1353 1354
{
  register Lisp_Object w;
  /* First try for a window that is full-width */