window.c 117 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;

122 123 124
/* Non-nil means we can split a frame even if it is "unsplittable".  */
static int frame_override_unsplittable;

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

127 128
extern int scroll_margin;

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

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

Jim Blandy's avatar
Jim Blandy committed
147 148 149
Lisp_Object
make_window ()
{
150
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
151
  register struct window *p;
152 153 154 155 156 157 158 159
  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;
160 161 162 163 164 165 166 167
  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
168 169
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
170
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
171
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
172 173
  p->display_table = Qnil;
  p->dedicated = Qnil;
174
  XSETWINDOW (val, p);
Jim Blandy's avatar
Jim Blandy committed
175 176 177 178 179 180 181 182 183 184
  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;
}

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

  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
Jim Blandy's avatar
Jim Blandy committed
198 199
}

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

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

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

  if (posint < top)
    return Qnil;

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

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

258 259 260 261
      /* 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
262
      /* If that info is not correct, calculate afresh */
263 264 265 266 267 268 269 270 271
      /* 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.  */
272
      posval = *compute_motion (top, 0, (hscroll ? 1 - hscroll : 0), 0,
273
				posint, height, - (1 << (BITS_PER_SHORT - 1)),
274
				window_internal_width (w) - 1,
275
				hscroll, 0, w);
Jim Blandy's avatar
Jim Blandy committed
276 277 278 279 280 281 282 283 284

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

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

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

344 345 346 347 348 349 350 351 352 353 354 355 356 357
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\
358 359 360 361
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.")
362 363 364 365 366 367 368 369 370 371
  (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
372 373
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
374
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.\n\
Jim Blandy's avatar
Jim Blandy committed
375 376 377 378 379 380 381 382 383
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,
384
           Fcons (make_number (WINDOW_RIGHT_EDGE (w)),
Jim Blandy's avatar
Jim Blandy committed
385 386 387 388 389
		  Fcons (make_number (XFASTINT (w->top)
				      + XFASTINT (w->height)),
			 Qnil))));
}

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

415 416 417 418 419 420
  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
421 422
  /* Is the character is the mode line?  */
  if (*y == top + window_height - 1
423
      && ! MINI_WINDOW_P (w))
Jim Blandy's avatar
Jim Blandy committed
424
    return 2;
425

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

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

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

    default:
      abort ();
    }
}

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

Jim Blandy's avatar
Jim Blandy committed
485
  tem = first = FRAME_SELECTED_WINDOW (frame);
Jim Blandy's avatar
Jim Blandy committed
486

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

      if (found)
	{
Jim Blandy's avatar
Jim Blandy committed
493
	  *part = found - 1;
Jim Blandy's avatar
Jim Blandy committed
494 495 496
	  return tem;
	}

Jim Blandy's avatar
Jim Blandy committed
497
      tem = Fnext_window (tem, Qt, Qlambda);
Jim Blandy's avatar
Jim Blandy committed
498
    }
Jim Blandy's avatar
Jim Blandy committed
499
  while (! EQ (tem, first));
500

Jim Blandy's avatar
Jim Blandy committed
501
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
502 503
}

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

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

Jim Blandy's avatar
Jim Blandy committed
521
  return window_from_coordinates (XFRAME (frame),
Richard M. Stallman's avatar
Richard M. Stallman committed
522
				  XINT (x), XINT (y),
Jim Blandy's avatar
Jim Blandy committed
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
				  &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,
548 549
  "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
550 551 552 553 554 555
  (window)
     Lisp_Object window;
{
  return Fmarker_position (decode_window (window)->start);
}

556 557
/* This is text temporarily removed from the doc string below.

558 559 560 561 562 563 564
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\
565 566 567 568 569 570 571
      (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
572 573 574 575 576
  (window)
     Lisp_Object window;
{
  Lisp_Object value;
  struct window *w = decode_window (window);
577 578 579 580 581
  Lisp_Object buf;

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

582
#if 0 /* This change broke some things.  We should make it later.  */
583 584 585 586 587 588
  /* 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;
589
#endif
590

591 592
  XSETINT (value,
	   BUF_Z (XBUFFER (buf)) - XFASTINT (w->window_end_pos));
Jim Blandy's avatar
Jim Blandy committed
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625

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

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

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

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

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

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

718
  buf = w->buffer;
Jim Blandy's avatar
Jim Blandy committed
719 720 721
  if (XBUFFER (buf) != XMARKER (w->pointm)->buffer)
    abort ();

722 723 724
  if (w == XWINDOW (XBUFFER (buf)->last_selected_window))
    XBUFFER (buf)->last_selected_window = Qnil;

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

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

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

  p->prev = tem = o->prev;
Jim Blandy's avatar
Jim Blandy committed
774
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
775 776 777
    XWINDOW (tem)->next = replacement;

  p->parent = tem = o->parent;
Jim Blandy's avatar
Jim Blandy committed
778
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
    {
      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;
795 796 797 798 799 800 801 802 803 804 805 806
{
  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
807 808 809 810 811
{
  register Lisp_Object tem, parent, sib;
  register struct window *p;
  register struct window *par;

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

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

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

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

835 836
  /* Are we trying to delete any frame's selected window?  */
  {
837
    Lisp_Object frame, pwindow;
838

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

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

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

  tem = p->next;
Jim Blandy's avatar
Jim Blandy committed
880
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
881 882 883
    XWINDOW (tem)->prev = p->prev;

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

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

  /* 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
932 933 934
}


Jim Blandy's avatar
Jim Blandy committed
935
extern Lisp_Object next_frame (), prev_frame ();
Jim Blandy's avatar
Jim Blandy committed
936

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

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

Jim Blandy's avatar
Jim Blandy committed
977
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
978 979
    window = selected_window;
  else
980
    CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
981

Jim Blandy's avatar
Jim Blandy committed
982 983 984 985
  start_window = window;

  /* minibuf == nil may or may not include minibuffers.
     Decide if it does.  */
Jim Blandy's avatar
Jim Blandy committed
986
  if (NILP (minibuf))
987 988 989 990 991 992
    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
993

994
  /* all_frames == nil doesn't specify which frames to include.  */
Jim Blandy's avatar
Jim Blandy committed
995
  if (NILP (all_frames))
996
    all_frames = (! EQ (minibuf, Qlambda)
997 998 999 1000 1001
		  ? (FRAME_MINIBUF_WINDOW
		     (XFRAME
		      (WINDOW_FRAME
		       (XWINDOW (window)))))
		  : Qnil);
1002 1003
  else if (EQ (all_frames, Qvisible))
    ;
1004 1005
  else if (XFASTINT (all_frames) == 0)
    ;
1006 1007 1008 1009
  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
1010 1011
  else if (! EQ (all_frames, Qt))
    all_frames = Qnil;
1012 1013
  /* Now all_frames is t meaning search all frames,
     nil meaning search just current frame,
1014 1015
     visible meaning search just visible frames,
     0 meaning search visible and iconified frames,
1016
     or a window, meaning search the frame that window belongs to.  */
Jim Blandy's avatar
Jim Blandy committed
1017 1018 1019 1020 1021 1022 1023

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

Jim Blandy's avatar
Jim Blandy committed
1048 1049 1050 1051
	    break;
	  }

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

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

  return window;
}

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


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

Jim Blandy's avatar
Jim Blandy committed
1119
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
1120 1121
    window = selected_window;
  else
1122
    CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
1123

Jim Blandy's avatar
Jim Blandy committed
1124 1125 1126 1127
  start_window = window;

  /* minibuf == nil may or may not include minibuffers.
     Decide if it does.  */
Jim Blandy's avatar
Jim Blandy committed
1128
  if (NILP (minibuf))
1129 1130 1131 1132 1133 1134
    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
1135

Jim Blandy's avatar
Jim Blandy committed
1136 1137 1138
  /* all_frames == nil doesn't specify which frames to include.
     Decide which frames it includes.  */
  if (NILP (all_frames))
1139
    all_frames = (! EQ (minibuf, Qlambda)
Jim Blandy's avatar
Jim Blandy committed
1140 1141 1142
		   ? (FRAME_MINIBUF_WINDOW
		      (XFRAME
		       (WINDOW_FRAME
Jim Blandy's avatar
Jim Blandy committed
1143 1144
			(XWINDOW (window)))))
		   : Qnil);
1145 1146
  else if (EQ (all_frames, Qvisible))
    ;
1147 1148
  else if (XFASTINT (all_frames) == 0)
    ;
1149 1150 1151 1152
  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
1153 1154
  else if (! EQ (all_frames, Qt))
    all_frames = Qnil;
1155 1156
  /* Now all_frames is t meaning search all frames,
     nil meaning search just current frame,
1157 1158
     visible meaning search just visible frames,
     0 meaning search visible and iconified frames,
1159
     or a window, meaning search the frame that window belongs to.  */
Jim Blandy's avatar
Jim Blandy committed
1160 1161