window.c 116 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, 86, 87, 93, 94, 95, 96 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
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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

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

33
Lisp_Object Qwindowp, Qwindow_live_p;
Jim Blandy's avatar
Jim Blandy committed
34 35 36 37

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

38
void delete_all_subwindows ();
Jim Blandy's avatar
Jim Blandy committed
39 40 41 42 43 44 45 46
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
47
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
48 49 50

Lisp_Object selected_window;

Jim Blandy's avatar
Jim Blandy committed
51
/* The minibuffer window of the selected frame.
Jim Blandy's avatar
Jim Blandy committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
   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
74 75
/* Nonzero implies make new frames for Fdisplay_buffer.  */
int pop_up_frames;
Jim Blandy's avatar
Jim Blandy committed
76 77

/* Non-nil means use this function instead of default */
Jim Blandy's avatar
Jim Blandy committed
78
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
79 80 81 82

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

83 84 85 86 87 88 89 90 91
/* 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;

92 93 94 95 96 97
/* List of buffer *names* for buffers to appear in selected window.  */
Lisp_Object Vsame_window_buffer_names;

/* List of regexps for buffer names to appear in selected window.  */
Lisp_Object Vsame_window_regexps;

98 99 100
/* Hook run at end of temp_output_buffer_show.  */
Lisp_Object Qtemp_buffer_show_hook;

101
/* Fdisplay_buffer always splits the largest window
Jim Blandy's avatar
Jim Blandy committed
102 103 104 105 106 107 108 109 110
   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;

111 112 113
/* Nonzero after init_window_once has finished.  */
static int window_initialized;

114 115 116 117
/* Hook to run when window config changes.  */
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

118 119 120 121
/* Nonzero means scroll commands try to put point
   at the same screen height as previously.  */
static int scroll_preserve_screen_position;

Jim Blandy's avatar
Jim Blandy committed
122
#define min(a, b) ((a) < (b) ? (a) : (b))
123

124 125
extern int scroll_margin;

126
extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
Jim Blandy's avatar
Jim Blandy committed
127 128

DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
129 130 131
  "Returns t if OBJECT is a window.")
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
132
{
133
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
134 135
}

136
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
137 138 139
  "Returns t if OBJECT is a window which is currently visible.")
     (object)
     Lisp_Object object;
140
{
141
  return (WINDOWP (object) && ! NILP (XWINDOW (object)->buffer) ? Qt : Qnil);
142 143
}

Jim Blandy's avatar
Jim Blandy committed
144 145 146
Lisp_Object
make_window ()
{
147
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
148
  register struct window *p;
149 150 151 152 153 154 155 156
  register struct Lisp_Vector *vec;
  int i;

  vec = allocate_vectorlike ((EMACS_INT) VECSIZE (struct window));
  for (i = 0; i < VECSIZE (struct window); i++)
    vec->contents[i] = Qnil;
  vec->size = VECSIZE (struct window);
  p = (struct window *)vec;
157 158 159 160 161 162 163 164
  XSETFASTINT (p->sequence_number, ++sequence_number);
  XSETFASTINT (p->left, 0);
  XSETFASTINT (p->top, 0);
  XSETFASTINT (p->height, 0);
  XSETFASTINT (p->width, 0);
  XSETFASTINT (p->hscroll, 0);
  XSETFASTINT (p->last_point_x, 0);
  XSETFASTINT (p->last_point_y, 0);
Jim Blandy's avatar
Jim Blandy committed
165 166
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
167
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
168
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
169 170
  p->display_table = Qnil;
  p->dedicated = Qnil;
171
  XSETWINDOW (val, p);
Jim Blandy's avatar
Jim Blandy committed
172 173 174 175 176 177 178 179 180 181
  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;
}

182 183 184 185 186 187
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
188
{
189
  if (NILP (frame))
190
    XSETFRAME (frame, selected_frame);
191 192 193 194
  else
    CHECK_LIVE_FRAME (frame, 0);

  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
Jim Blandy's avatar
Jim Blandy committed
195 196
}

197
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
198 199 200 201 202 203 204 205 206 207
  "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
208
  "Return t if position POS is currently on the frame in WINDOW.\n\
Jim Blandy's avatar
Jim Blandy committed
209 210 211 212 213 214 215 216 217 218 219
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;
220
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
221

Jim Blandy's avatar
Jim Blandy committed
222
  if (NILP (pos))
Karl Heuer's avatar
Karl Heuer committed
223
    posint = PT;
Jim Blandy's avatar
Jim Blandy committed
224 225 226 227 228 229
  else
    {
      CHECK_NUMBER_COERCE_MARKER (pos, 0);
      posint = XINT (pos);
    }

230
  w = decode_window (window);
Jim Blandy's avatar
Jim Blandy committed
231
  top = marker_position (w->start);
232
  hscroll = XINT (w->hscroll);
Jim Blandy's avatar
Jim Blandy committed
233 234 235 236 237 238 239

  if (posint < top)
    return Qnil;

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

  buf = XBUFFER (w->buffer);
240 241
  if (XFASTINT (w->last_modified) >= BUF_MODIFF (buf)
      && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (buf))
Jim Blandy's avatar
Jim Blandy committed
242
    {
Jim Blandy's avatar
Jim Blandy committed
243
      /* If frame is up to date,
Jim Blandy's avatar
Jim Blandy committed
244 245 246 247 248 249 250 251
	 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
    {
252
      if (posint > BUF_ZV (buf))
Jim Blandy's avatar
Jim Blandy committed
253 254
	return Qnil;

255 256 257 258
      /* 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
259
      /* If that info is not correct, calculate afresh */
260 261 262 263 264 265 266 267 268
      /* BUG FIX for the 7th arg (TOHPOS).

	 '0' is harmless, however, ' - (1 << (BITS_PER_SHORT - 1))' is
	 more appropriate here.  In case of HSCROLL > 0, this can avoid
	 needless calculation done until (HPOS == 0).

	 We want to determine if the position POSINT is in HEIGHT or
	 not.  We don't have to do calculation until (HPOS == 0).  We
	 can stop it when VPOS goes beyond HEIGHT.  */
269
      posval = *compute_motion (top, 0, (hscroll ? 1 - hscroll : 0), 0,
270
				posint, height, - (1 << (BITS_PER_SHORT - 1)),
271
				window_internal_width (w) - 1,
272
				hscroll, 0, w);
Jim Blandy's avatar
Jim Blandy committed
273 274 275 276 277 278 279 280 281

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

285
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
  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,
306 307 308 309
  "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
310 311 312
  (window)
     Lisp_Object window;
{
313
  return make_number (window_internal_width (decode_window (window)));
Jim Blandy's avatar
Jim Blandy committed
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
}

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);
333
  if (XINT (ncol) < 0) XSETFASTINT (ncol, 0);
Jim Blandy's avatar
Jim Blandy committed
334
  w = decode_window (window);
335
  if (XINT (w->hscroll) != XINT (ncol))
336
    XBUFFER (w->buffer)->clip_changed = 1; /* Prevent redisplay shortcuts */
Jim Blandy's avatar
Jim Blandy committed
337 338 339 340
  w->hscroll = ncol;
  return ncol;
}

341 342 343 344 345 346 347 348 349 350 351 352 353 354
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
  "Return WINDOW's redisplay end trigger value.\n\
See `set-window-redisplay-end-trigger' for more information.")
  (window)
     Lisp_Object window;
{
  return decode_window (window)->redisplay_end_trigger;
}

DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
       Sset_window_redisplay_end_trigger, 2, 2, 0,
  "Set WINDOW's redisplay end trigger value to VALUE.\n\
VALUE should be a buffer position (typically a marker) or nil.\n\
355 356 357 358
If it is a buffer position, then if redisplay in WINDOW reaches a position\n\
beyond VALUE, the functions in `redisplay-end-trigger-functions' are called\n\
with two arguments: WINDOW, and the end trigger value.\n\
Afterwards the end-trigger value is reset to nil.")
359 360 361 362 363 364 365 366 367 368
  (window, value)
     register Lisp_Object window, value;
{
  register struct window *w;

  w = decode_window (window);
  w->redisplay_end_trigger = value;
  return value;
}

Jim Blandy's avatar
Jim Blandy committed
369 370
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
371
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.\n\
Jim Blandy's avatar
Jim Blandy committed
372 373 374 375 376 377 378 379 380
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,
381
           Fcons (make_number (WINDOW_RIGHT_EDGE (w)),
Jim Blandy's avatar
Jim Blandy committed
382 383 384 385 386
		  Fcons (make_number (XFASTINT (w->top)
				      + XFASTINT (w->height)),
			 Qnil))));
}

Jim Blandy's avatar
Jim Blandy committed
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
/* 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);
402 403 404
  register int right_edge = WINDOW_RIGHT_EDGE (w);
  register int left_margin = WINDOW_LEFT_MARGIN (w);
  register int right_margin = WINDOW_RIGHT_MARGIN (w);
Jim Blandy's avatar
Jim Blandy committed
405 406
  register int window_height = XINT (w->height);
  register int top = XFASTINT (w->top);
407 408
  
  if (   *x < left || *x >= right_edge
Jim Blandy's avatar
Jim Blandy committed
409 410 411
      || *y < top  || *y >= top  + window_height)
    return 0;

412 413 414 415 416 417
  if (left_margin != left && *x < left_margin && *x >= left)
    return 3;
  
  if (right_margin != right_edge && *x >= right_margin && *x < right_edge)
    return 3;
  
Jim Blandy's avatar
Jim Blandy committed
418 419
  /* Is the character is the mode line?  */
  if (*y == top + window_height - 1
420
      && ! MINI_WINDOW_P (w))
Jim Blandy's avatar
Jim Blandy committed
421
    return 2;
422

423
  *x -= WINDOW_LEFT_MARGIN (w);
Jim Blandy's avatar
Jim Blandy committed
424 425 426 427 428 429 430
  *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
431
COORDINATES is a cons of the form (X . Y), X and Y being distances\n\
Jim Blandy's avatar
Jim Blandy committed
432
measured in characters from the upper-left corner of the frame.\n\
Jim Blandy's avatar
Jim Blandy committed
433
(0 .  0) denotes the character in the upper left corner of the\n\
Jim Blandy's avatar
Jim Blandy committed
434
frame.\n\
Jim Blandy's avatar
Jim Blandy committed
435 436
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
437
If they are in the mode line of WINDOW, `mode-line' is returned.\n\
Jim Blandy's avatar
Jim Blandy committed
438
If they are on the border between WINDOW and its right sibling,\n\
Jim Blandy's avatar
Jim Blandy committed
439
   `vertical-line' is returned.")
Jim Blandy's avatar
Jim Blandy committed
440 441 442 443 444
  (coordinates, window)
     register Lisp_Object coordinates, window;
{
  int x, y;

445
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
446 447 448 449 450 451 452 453 454 455 456 457 458 459
  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;
460

Jim Blandy's avatar
Jim Blandy committed
461
    case 3:			/* On right border of window.  */
Jim Blandy's avatar
Jim Blandy committed
462
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
463 464 465 466 467 468

    default:
      abort ();
    }
}

Jim Blandy's avatar
Jim Blandy committed
469
/* Find the window containing column x, row y, and return it as a
Jim Blandy's avatar
Jim Blandy committed
470 471 472 473
   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
474
Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
475 476
window_from_coordinates (frame, x, y, part)
     FRAME_PTR frame;
Jim Blandy's avatar
Jim Blandy committed
477
     int x, y;
Jim Blandy's avatar
Jim Blandy committed
478
     int *part;
Jim Blandy's avatar
Jim Blandy committed
479 480 481
{
  register Lisp_Object tem, first;

Jim Blandy's avatar
Jim Blandy committed
482
  tem = first = FRAME_SELECTED_WINDOW (frame);
Jim Blandy's avatar
Jim Blandy committed
483

Jim Blandy's avatar
Jim Blandy committed
484
  do
Jim Blandy's avatar
Jim Blandy committed
485 486 487 488 489
    {
      int found = coordinates_in_window (XWINDOW (tem), &x, &y);

      if (found)
	{
Jim Blandy's avatar
Jim Blandy committed
490
	  *part = found - 1;
Jim Blandy's avatar
Jim Blandy committed
491 492 493
	  return tem;
	}

Jim Blandy's avatar
Jim Blandy committed
494
      tem = Fnext_window (tem, Qt, Qlambda);
Jim Blandy's avatar
Jim Blandy committed
495
    }
Jim Blandy's avatar
Jim Blandy committed
496
  while (! EQ (tem, first));
497

Jim Blandy's avatar
Jim Blandy committed
498
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
499 500
}

501
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
502
  "Return window containing coordinates X and Y on FRAME.\n\
Jim Blandy's avatar
Jim Blandy committed
503 504
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
505
column 0.")
Richard M. Stallman's avatar
Richard M. Stallman committed
506 507
  (x, y, frame)
      Lisp_Object x, y, frame;
Jim Blandy's avatar
Jim Blandy committed
508 509 510
{
  int part;

Jim Blandy's avatar
Jim Blandy committed
511
  if (NILP (frame))
512
    XSETFRAME (frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
513
  else
Jim Blandy's avatar
Jim Blandy committed
514
    CHECK_LIVE_FRAME (frame, 2);
Richard M. Stallman's avatar
Richard M. Stallman committed
515 516
  CHECK_NUMBER (x, 0);
  CHECK_NUMBER (y, 1);
Jim Blandy's avatar
Jim Blandy committed
517

Jim Blandy's avatar
Jim Blandy committed
518
  return window_from_coordinates (XFRAME (frame),
Richard M. Stallman's avatar
Richard M. Stallman committed
519
				  XINT (x), XINT (y),
Jim Blandy's avatar
Jim Blandy committed
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
				  &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,
545 546
  "Return position at which display currently starts in WINDOW.\n\
This is updated by redisplay or by calling `set-window-start'.")
Jim Blandy's avatar
Jim Blandy committed
547 548 549 550 551 552
  (window)
     Lisp_Object window;
{
  return Fmarker_position (decode_window (window)->start);
}

553 554
/* This is text temporarily removed from the doc string below.

555 556 557 558 559 560 561
This function returns nil if the position is not currently known.\n\
That happens when redisplay is preempted and doesn't finish.\n\
If in that case you want to compute where the end of the window would\n\
have been if redisplay had finished, do this:\n\
    (save-excursion\n\
      (goto-char (window-start window))\n\
      (vertical-motion (1- (window-height window)) window)\n\
562 563 564 565 566 567 568
      (point))")  */

DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 1, 0,
  "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
569 570 571 572 573
  (window)
     Lisp_Object window;
{
  Lisp_Object value;
  struct window *w = decode_window (window);
574 575 576 577 578
  Lisp_Object buf;

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

579
#if 0 /* This change broke some things.  We should make it later.  */
580 581 582 583 584 585
  /* If we don't know the end position, return nil.
     The user can compute it with vertical-motion if he wants to.
     It would be nicer to do it automatically,
     but that's so slow that it would probably bother people.  */
  if (NILP (w->window_end_valid))
    return Qnil;
586
#endif
587

588 589
  XSETINT (value,
	   BUF_Z (XBUFFER (buf)) - XFASTINT (w->window_end_pos));
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

  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
623
  if (NILP (noforce))
Jim Blandy's avatar
Jim Blandy committed
624 625
    w->force_start = Qt;
  w->update_mode_line = Qt;
626
  XSETFASTINT (w->last_modified, 0);
627
  XSETFASTINT (w->last_overlay_modified, 0);
Jim Blandy's avatar
Jim Blandy committed
628 629
  if (!EQ (window, selected_window))
    windows_or_buffers_changed++;
Jim Blandy's avatar
Jim Blandy committed
630 631 632 633 634 635
  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\
636
See also `set-window-dedicated-p'.")
Jim Blandy's avatar
Jim Blandy committed
637 638 639 640 641 642
  (window)
     Lisp_Object window;
{
  return decode_window (window)->dedicated;
}

643 644 645 646 647 648 649
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
650 651 652 653 654
  (window, arg)
       Lisp_Object window, arg;
{
  register struct window *w = decode_window (window);

Jim Blandy's avatar
Jim Blandy committed
655
  if (NILP (arg))
Jim Blandy's avatar
Jim Blandy committed
656 657
    w->dedicated = Qnil;
  else
658
    w->dedicated = Qt;
Jim Blandy's avatar
Jim Blandy committed
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676

  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.  */

677
struct Lisp_Char_Table *
Jim Blandy's avatar
Jim Blandy committed
678 679 680 681 682
window_display_table (w)
     struct window *w;
{
  Lisp_Object tem;
  tem = w->display_table;
683 684
  if (DISP_TABLE_P (tem))
    return XCHAR_TABLE (tem);
Jim Blandy's avatar
Jim Blandy committed
685
  tem = XBUFFER (w->buffer)->display_table;
686 687
  if (DISP_TABLE_P (tem))
    return XCHAR_TABLE (tem);
Jim Blandy's avatar
Jim Blandy committed
688
  tem = Vstandard_display_table;
689 690
  if (DISP_TABLE_P (tem))
    return XCHAR_TABLE (tem);
Jim Blandy's avatar
Jim Blandy committed
691 692 693
  return 0;
}

Jim Blandy's avatar
Jim Blandy committed
694
DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
  "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;
{
713
  Lisp_Object buf;
Jim Blandy's avatar
Jim Blandy committed
714

715
  buf = w->buffer;
Jim Blandy's avatar
Jim Blandy committed
716 717 718
  if (XBUFFER (buf) != XMARKER (w->pointm)->buffer)
    abort ();

719 720 721
  if (w == XWINDOW (XBUFFER (buf)->last_selected_window))
    XBUFFER (buf)->last_selected_window = Qnil;

722
#if 0
Jim Blandy's avatar
Jim Blandy committed
723 724 725 726
  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.  */
727 728 729 730 731 732 733 734
#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
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
    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
755 756
  /* 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
757

758
  if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
Jim Blandy's avatar
Jim Blandy committed
759
    FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
Jim Blandy's avatar
Jim Blandy committed
760 761 762 763 764 765 766

  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
767
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
768 769 770
    XWINDOW (tem)->prev = replacement;

  p->prev = tem = o->prev;
Jim Blandy's avatar
Jim Blandy committed
771
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
772 773 774
    XWINDOW (tem)->next = replacement;

  p->parent = tem = o->parent;
Jim Blandy's avatar
Jim Blandy committed
775
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
    {
      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;
792 793 794 795 796 797 798 799 800 801 802 803
{
  delete_window (window);

  if (! NILP (Vwindow_configuration_change_hook)
      && ! NILP (Vrun_hooks))
    call1 (Vrun_hooks, Qwindow_configuration_change_hook);

  return Qnil;
}

delete_window (window)
     register Lisp_Object window;
Jim Blandy's avatar
Jim Blandy committed
804 805 806 807 808
{
  register Lisp_Object tem, parent, sib;
  register struct window *p;
  register struct window *par;

809 810 811
  /* 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
812
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
813 814 815 816
    window = selected_window;
  else
    CHECK_WINDOW (window, 0);
  p = XWINDOW (window);
817 818 819 820 821

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

Jim Blandy's avatar
Jim Blandy committed
824
  parent = p->parent;
Jim Blandy's avatar
Jim Blandy committed
825
  if (NILP (parent))
Jim Blandy's avatar
Jim Blandy committed
826 827 828 829
    error ("Attempt to delete minibuffer or sole ordinary window");
  par = XWINDOW (parent);

  windows_or_buffers_changed++;
830
  FRAME_WINDOW_SIZES_CHANGED (XFRAME (WINDOW_FRAME (p))) = 1;
Jim Blandy's avatar
Jim Blandy committed
831

832 833
  /* Are we trying to delete any frame's selected window?  */
  {
834
    Lisp_Object frame, pwindow;
835

836 837 838 839 840 841 842 843 844 845 846 847 848 849
    /* 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))
850
      {
851 852
	Lisp_Object alternative;
	alternative = Fnext_window (window, Qlambda, Qnil);
853 854 855 856 857 858 859 860 861

	/* 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
862
	  FRAME_SELECTED_WINDOW (XFRAME (frame)) = alternative;
863 864
      }
  }
Jim Blandy's avatar
Jim Blandy committed
865 866 867 868

  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
869
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
870 871 872 873 874 875 876
    {
      unshow_buffer (p);
      unchain_marker (p->pointm);
      unchain_marker (p->start);
    }

  tem = p->next;
Jim Blandy's avatar
Jim Blandy committed
877
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
878 879 880
    XWINDOW (tem)->prev = p->prev;

  tem = p->prev;
Jim Blandy's avatar
Jim Blandy committed
881
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
882 883 884 885 886 887 888 889 890
    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
891
  if (NILP (sib))
Jim Blandy's avatar
Jim Blandy committed
892 893 894 895 896 897
    {
      /* 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;
898 899
      XWINDOW (sib)->top = p->top;
      XWINDOW (sib)->left = p->left;
Jim Blandy's avatar
Jim Blandy committed
900 901 902
    }

  /* Stretch that sibling.  */
Jim Blandy's avatar
Jim Blandy committed
903
  if (!NILP (par->vchild))
Jim Blandy's avatar
Jim Blandy committed
904 905 906
    set_window_height (sib,
		       XFASTINT (XWINDOW (sib)->height) + XFASTINT (p->height),
		       1);
Jim Blandy's avatar
Jim Blandy committed
907
  if (!NILP (par->hchild))
Jim Blandy's avatar
Jim Blandy committed
908 909 910 911 912 913 914
    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
915
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
916
    tem = par->vchild;
Jim Blandy's avatar
Jim Blandy committed
917
  if (NILP (XWINDOW (tem)->next))
Jim Blandy's avatar
Jim Blandy committed
918
    replace_window (parent, tem);
919 920 921 922 923 924 925 926 927 928

  /* 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
929 930 931
}


Jim Blandy's avatar
Jim Blandy committed
932
extern Lisp_Object next_frame (), prev_frame ();
Jim Blandy's avatar
Jim Blandy committed
933

934 935 936 937 938
/* 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
939
  "Return next window after WINDOW in canonical ordering of windows.\n\
Jim Blandy's avatar
Jim Blandy committed
940 941 942 943 944 945 946
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
947 948
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
949
too.  Therefore, `next-window' can be used to iterate through the\n\
Jim Blandy's avatar
Jim Blandy committed
950 951
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
952
\n\
Jim Blandy's avatar
Jim Blandy committed
953 954
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\
955
above.  ALL-FRAMES = `visible' means include windows on all visible frames.\n\
956
ALL-FRAMES = 0 means include windows on all visible and iconified frames.\n\
957
If ALL-FRAMES is a frame, restrict search to windows on that frame.\n\
958
Anything else means restrict to WINDOW's frame.\n\
Jim Blandy's avatar
Jim Blandy committed
959 960 961 962 963
\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.")
964 965 966 967
  (window, minibuf, all_frames) */

DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
       0)
Jim Blandy's avatar
Jim Blandy committed
968 969
  (window, minibuf, all_frames)
     register Lisp_Object window, minibuf, all_frames;
Jim Blandy's avatar
Jim Blandy committed
970 971
{
  register Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
972
  Lisp_Object start_window;
Jim Blandy's avatar
Jim Blandy committed
973

Jim Blandy's avatar
Jim Blandy committed
974
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
975 976
    window = selected_window;
  else
977
    CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
978

Jim Blandy's avatar
Jim Blandy committed
979 980 981 982
  start_window = window;

  /* minibuf == nil may or may not include minibuffers.
     Decide if it does.  */
Jim Blandy's avatar
Jim Blandy committed
983
  if (NILP (minibuf))
984 985 986 987 988 989
    minibuf = (minibuf_level ? minibuf_window : Qlambda);
  else if (! EQ (minibuf, Qt))
    minibuf = Qlambda;
  /* Now minibuf can be t => count all minibuffer windows,
     lambda => count none of them,
     or a specific minibuffer window (the active one) to count.  */
Jim Blandy's avatar
Jim Blandy committed
990

991
  /* all_frames == nil doesn't specify which frames to include.  */
Jim Blandy's avatar
Jim Blandy committed
992
  if (NILP (all_frames))
993
    all_frames = (! EQ (minibuf, Qlambda)
994 995 996 997 998
		  ? (FRAME_MINIBUF_WINDOW
		     (XFRAME
		      (WINDOW_FRAME
		       (XWINDOW (window)))))
		  : Qnil);
999 1000
  else if (EQ (all_frames, Qvisible))
    ;
1001 1002
  else if (XFASTINT (all_frames) == 0)
    ;
1003 1004 1005 1006
  else if (FRAMEP (all_frames) && ! EQ (all_frames, Fwindow_frame (window)))
    /* If all_frames is a frame and window arg isn't on that frame, just
       return the first window on the frame.  */
    return Fframe_first_window (all_frames);
Jim Blandy's avatar
Jim Blandy committed
1007 1008
  else if (! EQ (all_frames, Qt))
    all_frames = Qnil;
1009 1010
  /* Now all_frames is t meaning search all frames,
     nil meaning search just current frame,
1011 1012
     visible meaning search just visible frames,
     0 meaning search visible and iconified frames,
1013
     or a window, meaning search the frame that window belongs to.  */
Jim Blandy's avatar
Jim Blandy committed
1014 1015 1016 1017 1018 1019 1020

  /* 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
1021 1022
      while (tem = XWINDOW (window)->next, NILP (tem))
	if (tem = XWINDOW (window)->parent, !NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1023
	  window = tem;
Jim Blandy's avatar
Jim Blandy committed
1024
	else
Jim Blandy's avatar
Jim Blandy committed
1025
	  {
Jim Blandy's avatar
Jim Blandy committed
1026 1027 1028 1029
	    /* We've reached the end of this frame.
	       Which other frames are acceptable?  */
	    tem = WINDOW_FRAME (XWINDOW (window));
	    if (! NILP (all_frames))
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
	      {
		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))
1041
		  XSETFRAME (tem, selected_frame);
1042
	      }
Jim Blandy's avatar
Jim Blandy committed
1043
	    tem = FRAME_ROOT_WINDOW (XFRAME (tem));
Jim Blandy's avatar
Jim Blandy committed
1044

Jim Blandy's avatar
Jim Blandy committed
1045 1046 1047 1048
	    break;
	  }

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

Jim Blandy's avatar
Jim Blandy committed
1050 1051 1052 1053
      /* 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
1054
	  if (!NILP (XWINDOW (window)->hchild))
Jim Blandy's avatar
Jim Blandy committed
1055
	    window = XWINDOW (window)->hchild;
Jim Blandy's avatar
Jim Blandy committed
1056
	  else if (!NILP (XWINDOW (window)->vchild))
Jim Blandy's avatar
Jim Blandy committed
1057 1058 1059 1060
	    window = XWINDOW (window)->vchild;
	  else break;
	}
    }
1061
  /* Which windows are acceptable?
Jim Blandy's avatar
Jim Blandy committed
1062
     Exit the loop and accept this window if
1063 1064 1065
     this isn't a minibuffer window,
     or we're accepting all minibuffer windows,
     or this is the active minibuffer and we are accepting that one, or
Jim Blandy's avatar
Jim Blandy committed
1066
     we've come all the way around and we're back at the original window.  */
Jim Blandy's avatar
Jim Blandy committed
1067
  while (MINI_WINDOW_P (XWINDOW (window))
Jim Blandy's avatar
Jim Blandy committed
1068
	 && ! EQ (minibuf, Qt)
1069
	 && ! EQ (minibuf, window)
1070
	 && ! EQ (window, start_window));
Jim Blandy's avatar
Jim Blandy committed
1071 1072 1073 1074

  return window;
}

1075 1076 1077 1078 1079
/* 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,
1080
  "Return the window preceding WINDOW in canonical ordering of windows.\n\
Jim Blandy's avatar
Jim Blandy committed
1081 1082 1083 1084 1085 1086 1087
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
1088 1089
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
1090
too.  Therefore, `previous-window' can be used to iterate through\n\
Jim Blandy's avatar
Jim Blandy committed
1091
the set of windows even when the minibuffer is on another frame.  If\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
1092
the minibuffer does not count, only windows from WINDOW's frame count\n\
Jim Blandy's avatar
Jim Blandy committed
1093
\n\
Jim Blandy's avatar
Jim Blandy committed
1094 1095
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\
1096
above.  ALL-FRAMES = `visible' means include windows on all visible frames.\n\
1097
ALL-FRAMES = 0 means include windows on all visible and iconified frames.\n\
1098
If ALL-FRAMES is a frame, restrict search to windows on that frame.\n\
1099
Anything else means restrict to WINDOW's frame.\n\
Jim Blandy's avatar
Jim Blandy committed
1100 1101 1102 1103 1104
\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.")
1105 1106 1107 1108 1109
  (window, minibuf, all_frames)  */


DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
       0)
Jim Blandy's avatar
Jim Blandy committed
1110 1111
  (window, minibuf, all_frames)
     register Lisp_Object window, minibuf, all_frames;
Jim Blandy's avatar
Jim Blandy committed
1112 1113
{
  register Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
1114
  Lisp_Object start_window;
Jim Blandy's avatar
Jim Blandy committed
1115

Jim Blandy's avatar
Jim Blandy committed
1116
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
1117 1118
    window = selected_window;
  else
1119
    CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
1120

Jim Blandy's avatar
Jim Blandy committed
1121 1122 1123 1124
  start_window = window;

  /* minibuf == nil may or may not include minibuffers.
     Decide if it does.  */
Jim Blandy's avatar
Jim Blandy committed
1125
  if (NILP (minibuf))
1126 1127 1128 1129 1130 1131
    minibuf = (minibuf_level ? minibuf_window : Qlambda);
  else if (! EQ (minibuf, Qt))
    minibuf = Qlambda;
  /* Now minibuf can be t => count all minibuffer windows,
     lambda => count none of them,
     or a specific minibuffer window (the active one) to count.  */
Jim Blandy's avatar
Jim Blandy committed
1132

Jim Blandy's avatar
Jim Blandy committed
1133 1134 1135
  /* all_frames == nil doesn't specify which frames to include.
     Decide which frames it includes.  */
  if (NILP (all_frames))
1136
    all_frames = (! EQ (minibuf, Qlambda)
Jim Blandy's avatar
Jim Blandy committed
1137 1138 1139
		   ? (FRAME_MINIBUF_WINDOW
		      (XFRAME
		       (WINDOW_FRAME
Jim Blandy's avatar
Jim Blandy committed
1140 1141
			(XWINDOW (window)))))
		   : Qnil);
1142 1143
  else if (EQ (all_frames, Qvisible))
    ;
1144 1145
  else if (XFASTINT (all_frames) == 0)
    ;
1146 1147 1148 1149
  else if (FRAMEP (all_frames) && ! EQ (all_frames, Fwindow_frame (window)))
    /* If all_frames is a frame and window arg isn't on that frame, just
       return the first window on the frame.  */
    return Fframe_first_window (all_frames);
Jim Blandy's avatar
Jim Blandy committed
1150 1151
  else if (! EQ (all_frames, Qt))
    all_frames = Qnil;
1152 1153
  /* Now all_frames is t meaning search all frames,
     nil meaning search just current frame,
1154 1155
     visible meaning search just visible frames,
     0 meaning search visible and iconified frames,
1156
     or a window, meaning search the frame that window belongs to.  */
Jim Blandy's avatar
Jim Blandy committed
1157 1158 1159 1160 1161 1162 1163

  /* 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
116