window.c 165 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
/* Window creation, deletion and examination for GNU Emacs.
   Does not include redisplay.
Richard M. Stallman's avatar
Richard M. Stallman committed
3
   Copyright (C) 1985,86,87,93,94,95,96,97,1998 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"
Andreas Schwab's avatar
Andreas Schwab committed
32
#include "dispextern.h"
33 34 35
#include "blockinput.h"
#include "intervals.h"

36
#ifdef HAVE_X_WINDOWS
Andreas Schwab's avatar
Andreas Schwab committed
37
#include "xterm.h"
38
#endif	/* HAVE_X_WINDOWS */
Andrew Innes's avatar
Andrew Innes committed
39 40 41
#ifdef WINDOWSNT
#include "w32term.h"
#endif
42 43 44
#ifdef MSDOS
#include "msdos.h"
#endif
45 46 47

#ifndef max
#define max(a, b) ((a) < (b) ? (b) : (a))
Andreas Schwab's avatar
Andreas Schwab committed
48
#endif
Jim Blandy's avatar
Jim Blandy committed
49

50

51
Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
52
Lisp_Object Qwindow_size_fixed, Qleft_bitmap_area, Qright_bitmap_area;
Gerd Moellmann's avatar
Gerd Moellmann committed
53
extern Lisp_Object Qheight, Qwidth;
Jim Blandy's avatar
Jim Blandy committed
54

Andreas Schwab's avatar
Andreas Schwab committed
55
static struct window *decode_window P_ ((Lisp_Object));
56
static Lisp_Object select_window_1 P_ ((Lisp_Object, int));
57 58 59 60 61
static int count_windows P_ ((struct window *));
static int get_leaf_windows P_ ((struct window *, struct window **, int));
static void window_scroll P_ ((Lisp_Object, int, int, int));
static void window_scroll_pixel_based P_ ((Lisp_Object, int, int, int));
static void window_scroll_line_based P_ ((Lisp_Object, int, int, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
62
static int window_min_size_1 P_ ((struct window *, int));
63
static int window_min_size P_ ((struct window *, int, int, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
64
static void size_window P_ ((Lisp_Object, int, int, int));
65
static int freeze_window_start P_ ((struct window *, void *));
66
static int window_fixed_size_p P_ ((struct window *, int, int));
67
static void enlarge_window P_ ((Lisp_Object, int, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
68
static Lisp_Object window_list P_ ((void));
69
static int add_window_to_list P_ ((struct window *, void *));
70 71
static int candidate_window_p P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
				   Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
72 73 74 75
static Lisp_Object next_window P_ ((Lisp_Object, Lisp_Object,
				    Lisp_Object, int));
static void decode_next_window_args P_ ((Lisp_Object *, Lisp_Object *,
					 Lisp_Object *));
76 77 78
static int foreach_window_1 P_ ((struct window *,
				 int (* fn) (struct window *, void *),
				 void *));
79

Jim Blandy's avatar
Jim Blandy committed
80 81 82 83 84 85
/* 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
86
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
87 88 89

Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
90 91 92 93 94 95
/* A list of all windows for use by next_window and Fwindow_list.
   Functions creating or deleting windows should invalidate this cache
   by setting it to nil.  */

Lisp_Object Vwindow_list;

96 97 98
/* The mini-buffer window of the selected frame.
   Note that you cannot test for mini-bufferness of an arbitrary window
   by comparing against this; but you can test for mini-bufferness of
Jim Blandy's avatar
Jim Blandy committed
99
   the selected window.  */
100

Jim Blandy's avatar
Jim Blandy committed
101 102 103
Lisp_Object minibuf_window;

/* Non-nil means it is the window for C-M-v to scroll
104 105
   when the mini-buffer is selected.  */

Jim Blandy's avatar
Jim Blandy committed
106 107 108
Lisp_Object Vminibuf_scroll_window;

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

Jim Blandy's avatar
Jim Blandy committed
110 111 112
Lisp_Object Vother_window_scroll_buffer;

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

Jim Blandy's avatar
Jim Blandy committed
114 115 116
Lisp_Object Vtemp_buffer_show_function;

/* If a window gets smaller than either of these, it is removed. */
117

Jim Blandy's avatar
Jim Blandy committed
118 119 120 121
int window_min_height;
int window_min_width;

/* Nonzero implies Fdisplay_buffer should create windows. */
122

Jim Blandy's avatar
Jim Blandy committed
123 124
int pop_up_windows;

Jim Blandy's avatar
Jim Blandy committed
125
/* Nonzero implies make new frames for Fdisplay_buffer.  */
126

Jim Blandy's avatar
Jim Blandy committed
127
int pop_up_frames;
Jim Blandy's avatar
Jim Blandy committed
128

129 130 131 132
/* Nonzero means reuse existing frames for displaying buffers.  */

int display_buffer_reuse_frames;

Jim Blandy's avatar
Jim Blandy committed
133
/* Non-nil means use this function instead of default */
134

Jim Blandy's avatar
Jim Blandy committed
135
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
136 137

/* Function to call to handle Fdisplay_buffer.  */
138

Jim Blandy's avatar
Jim Blandy committed
139 140
Lisp_Object Vdisplay_buffer_function;

141
/* List of buffer *names* for buffers that should have their own frames.  */
142

143 144 145
Lisp_Object Vspecial_display_buffer_names;

/* List of regexps for buffer names that should have their own frames.  */
146

147 148 149
Lisp_Object Vspecial_display_regexps;

/* Function to pop up a special frame.  */
150

151 152
Lisp_Object Vspecial_display_function;

153
/* List of buffer *names* for buffers to appear in selected window.  */
154

155 156 157
Lisp_Object Vsame_window_buffer_names;

/* List of regexps for buffer names to appear in selected window.  */
158

159 160
Lisp_Object Vsame_window_regexps;

161
/* Hook run at end of temp_output_buffer_show.  */
162

163 164
Lisp_Object Qtemp_buffer_show_hook;

165
/* Fdisplay_buffer always splits the largest window
Jim Blandy's avatar
Jim Blandy committed
166
   if that window is more than this high.  */
167

Jim Blandy's avatar
Jim Blandy committed
168 169 170
int split_height_threshold;

/* Number of lines of continuity in scrolling by screenfuls.  */
171

Jim Blandy's avatar
Jim Blandy committed
172 173 174
int next_screen_context_lines;

/* Incremented for each window created.  */
175

Jim Blandy's avatar
Jim Blandy committed
176 177
static int sequence_number;

178
/* Nonzero after init_window_once has finished.  */
179

180 181
static int window_initialized;

182
/* Hook to run when window config changes.  */
183

184 185 186
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

187 188 189
/* Nonzero means scroll commands try to put point
   at the same screen height as previously.  */

190 191 192
Lisp_Object Vscroll_preserve_screen_position;

#if 0 /* This isn't used anywhere.  */
193
/* Nonzero means we can split a frame even if it is "unsplittable".  */
194
static int inhibit_frame_unsplittable;
195
#endif /* 0 */
196

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

199 200
extern int scroll_margin;

201
extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
Jim Blandy's avatar
Jim Blandy committed
202 203

DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
204 205 206
  "Returns t if OBJECT is a window.")
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
207
{
208
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
209 210
}

211
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
212 213 214
  "Returns t if OBJECT is a window which is currently visible.")
     (object)
     Lisp_Object object;
215
{
216
  return (WINDOWP (object) && ! NILP (XWINDOW (object)->buffer) ? Qt : Qnil);
217 218
}

Jim Blandy's avatar
Jim Blandy committed
219 220 221
Lisp_Object
make_window ()
{
222
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
223
  register struct window *p;
224 225 226 227 228 229 230
  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);
231
  p = (struct window *) vec;
232 233 234 235 236 237
  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);
238
  p->orig_top = p->orig_height = Qnil;
Jim Blandy's avatar
Jim Blandy committed
239 240
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
241
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
242
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
243 244
  p->display_table = Qnil;
  p->dedicated = Qnil;
245 246 247 248 249 250 251 252 253 254 255
  p->pseudo_window_p = 0;
  bzero (&p->cursor, sizeof (p->cursor));
  bzero (&p->last_cursor, sizeof (p->last_cursor));
  bzero (&p->phys_cursor, sizeof (p->phys_cursor));
  p->desired_matrix = p->current_matrix = 0;
  p->phys_cursor_type = -1;
  p->must_be_updated_p = 0;
  XSETFASTINT (p->window_end_vpos, 0);
  XSETFASTINT (p->window_end_pos, 0);
  p->window_end_valid = Qnil;
  p->vscroll = 0;
256
  XSETWINDOW (val, p);
257
  XSETFASTINT (p->last_point, 0);
258
  p->frozen_window_start_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
259 260

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
261 262 263 264 265 266 267 268 269 270
  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;
}

271 272 273 274 275 276
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
277
{
278
  if (NILP (frame))
279 280
    frame = selected_frame;
  CHECK_LIVE_FRAME (frame, 0);
281
  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
Jim Blandy's avatar
Jim Blandy committed
282 283
}

284
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
285 286 287 288 289 290 291 292 293 294
  "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
295
  "Return t if position POS is currently on the frame in WINDOW.\n\
Jim Blandy's avatar
Jim Blandy committed
296 297 298 299 300 301 302 303
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 posint;
  register struct buffer *buf;
304 305
  struct text_pos top;
  Lisp_Object in_window;
Jim Blandy's avatar
Jim Blandy committed
306

Jim Blandy's avatar
Jim Blandy committed
307
  if (NILP (pos))
Karl Heuer's avatar
Karl Heuer committed
308
    posint = PT;
Jim Blandy's avatar
Jim Blandy committed
309 310 311 312 313 314
  else
    {
      CHECK_NUMBER_COERCE_MARKER (pos, 0);
      posint = XINT (pos);
    }

315
  w = decode_window (window);
316
  buf = XBUFFER (w->buffer);
317
  SET_TEXT_POS_FROM_MARKER (top, w->start);
Jim Blandy's avatar
Jim Blandy committed
318

319 320
  /* If position above window, it's not visible.  */
  if (posint < CHARPOS (top))
321 322 323 324 325 326 327 328 329 330 331 332 333 334
    in_window = Qnil;
  else if (XFASTINT (w->last_modified) >= BUF_MODIFF (buf)
      && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (buf)
      && posint < BUF_Z (buf) - XFASTINT (w->window_end_pos))
    /* If frame is up to date, and POSINT is < window end pos, use
       that info.  This doesn't work for POSINT == end pos, because
       the window end pos is actually the position _after_ the last
       char in the window.  */
    in_window = Qt;
  else if (posint > BUF_ZV (buf))
    in_window = Qnil;
  else if (CHARPOS (top) < BUF_BEGV (buf) || CHARPOS (top) > BUF_ZV (buf))
    /* If window start is out of range, do something reasonable.  */
    in_window = Qnil;
Jim Blandy's avatar
Jim Blandy committed
335 336
  else
    {
337 338 339
      struct it it;
      start_display (&it, w, top);
      move_it_to (&it, posint, 0, it.last_visible_y, -1,
340 341
 		  MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
      in_window = IT_CHARPOS (it) == posint ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
342
    }
343 344

  return in_window;
Jim Blandy's avatar
Jim Blandy committed
345 346 347 348 349 350
}

static struct window *
decode_window (window)
     register Lisp_Object window;
{
Jim Blandy's avatar
Jim Blandy committed
351
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
352 353
    return XWINDOW (selected_window);

354
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
  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,
375 376 377 378
  "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
379 380 381
  (window)
     Lisp_Object window;
{
382
  return make_number (window_internal_width (decode_window (window)));
Jim Blandy's avatar
Jim Blandy committed
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
}

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);
402
  if (XINT (ncol) < 0) XSETFASTINT (ncol, 0);
Jim Blandy's avatar
Jim Blandy committed
403
  w = decode_window (window);
404
  if (XINT (w->hscroll) != XINT (ncol))
Gerd Moellmann's avatar
Gerd Moellmann committed
405 406
    /* Prevent redisplay shortcuts */
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
Jim Blandy's avatar
Jim Blandy committed
407 408 409 410
  w->hscroll = ncol;
  return ncol;
}

411 412 413 414 415 416 417 418 419 420 421 422 423 424
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\
425 426 427 428
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.")
429 430 431 432 433 434 435 436 437 438
  (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
439 440
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
441
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.\n\
Jim Blandy's avatar
Jim Blandy committed
442 443 444 445 446 447 448 449 450
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,
451
           Fcons (make_number (WINDOW_RIGHT_EDGE (w)),
Jim Blandy's avatar
Jim Blandy committed
452 453 454 455 456
		  Fcons (make_number (XFASTINT (w->top)
				      + XFASTINT (w->height)),
			 Qnil))));
}

457
/* Test if the character at column *X, row *Y is within window W.
Jim Blandy's avatar
Jim Blandy committed
458 459 460 461 462 463 464
   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,
465 466
      return 3.
   if it is on the window's top line, return 4;
467 468
   if it is in the bitmap area to the left/right of the window,
   return 5 or 6, and convert *X and *Y to window-relative corrdinates.
469 470 471

   X and Y are frame relative pixel coordinates.  */

Jim Blandy's avatar
Jim Blandy committed
472 473 474 475 476
static int
coordinates_in_window (w, x, y)
     register struct window *w;
     register int *x, *y;
{
477 478
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  int left_x, right_x, top_y, bottom_y;
Gerd Moellmann's avatar
Gerd Moellmann committed
479
  int flags_area_width = FRAME_LEFT_FLAGS_AREA_WIDTH (f);
Jim Blandy's avatar
Jim Blandy committed
480

481 482
  /* In what's below, we subtract 1 when computing right_x because we
     want the rightmost pixel, which is given by left_pixel+width-1.  */
483 484 485
  if (w->pseudo_window_p)
    {
      left_x = 0;
486
      right_x = XFASTINT (w->width) * CANON_Y_UNIT (f) - 1;
487 488 489 490 491
      top_y = WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w);
      bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
    }
  else
    {
492
      left_x = (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
493
		- FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
494
      right_x = WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X (w) - 1;
495
      top_y = (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
496
	       - FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
497 498
      bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
    }
499

500 501 502 503 504 505 506 507 508 509 510 511 512
  if (*y < top_y
      || *y >= bottom_y
      || *x < (left_x
	       - flags_area_width
	       - (FRAME_LEFT_SCROLL_BAR_WIDTH (f)
		  * CANON_X_UNIT (f)))
      || *x > right_x + flags_area_width)
    /* Completely outside anything interesting.  */
    return 0;
  else if (WINDOW_WANTS_MODELINE_P (w)
	   && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
    /* On the mode line.  */
    return 2;
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
513 514
  else if (WINDOW_WANTS_HEADER_LINE_P (w)
	   && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
515 516 517
    /* On the top line.  */
    return 4;
  else if (*x < left_x || *x >= right_x)
518 519 520 521 522 523 524 525 526
    {
      /* Other lines than the mode line don't include flags areas and
	 scroll bars on the left.  */
      
      /* Convert X and Y to window-relative pixel coordinates.  */
      *x -= left_x;
      *y -= top_y;
      return *x < left_x ? 5 : 6;
    }
527 528 529 530 531 532 533 534 535 536 537 538 539
  else if (!w->pseudo_window_p
	   && !WINDOW_RIGHTMOST_P (w)
	   && *x >= right_x - CANON_X_UNIT (f))
    /* On the border on the right side of the window?  Assume that
       this area begins at RIGHT_X minus a canonical char width.  */
    return 3;
  else
    {
      /* Convert X and Y to window-relative pixel coordinates.  */
      *x -= left_x;
      *y -= top_y;
      return 1;
    }
Jim Blandy's avatar
Jim Blandy committed
540 541 542 543 544
}

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
545
COORDINATES is a cons of the form (X . Y), X and Y being distances\n\
Jim Blandy's avatar
Jim Blandy committed
546
measured in characters from the upper-left corner of the frame.\n\
Jim Blandy's avatar
Jim Blandy committed
547
(0 .  0) denotes the character in the upper left corner of the\n\
Jim Blandy's avatar
Jim Blandy committed
548
frame.\n\
Jim Blandy's avatar
Jim Blandy committed
549 550
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
551
If they are in the mode line of WINDOW, `mode-line' is returned.\n\
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
552
If they are in the top mode line of WINDOW, `header-line' is returned.\n\
553 554 555
If they are in the bitmap-area to the left of the window,\n\
   `left-bitmap-area' is returned, if they are in the area on the right of\n\
   the window, `right-bitmap-area' is returned.\n\
Jim Blandy's avatar
Jim Blandy committed
556
If they are on the border between WINDOW and its right sibling,\n\
Jim Blandy's avatar
Jim Blandy committed
557
   `vertical-line' is returned.")
Jim Blandy's avatar
Jim Blandy committed
558 559 560
  (coordinates, window)
     register Lisp_Object coordinates, window;
{
561 562
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
563
  int x, y;
564
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
565

566
  CHECK_LIVE_WINDOW (window, 0);
567 568
  w = XWINDOW (window);
  f = XFRAME (w->frame);
Jim Blandy's avatar
Jim Blandy committed
569
  CHECK_CONS (coordinates, 1);
570 571 572 573 574 575 576 577
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
  CHECK_NUMBER_OR_FLOAT (lx, 1);
  CHECK_NUMBER_OR_FLOAT (ly, 1);
  x = PIXEL_X_FROM_CANON_X (f, lx);
  y = PIXEL_Y_FROM_CANON_Y (f, ly);

  switch (coordinates_in_window (w, &x, &y))
Jim Blandy's avatar
Jim Blandy committed
578 579 580 581 582
    {
    case 0:			/* NOT in window at all. */
      return Qnil;

    case 1:			/* In text part of window. */
583 584 585 586 587
      /* X and Y are now window relative pixel coordinates.
	 Convert them to canonical char units before returning
	 them.  */
      return Fcons (CANON_X_FROM_PIXEL_X (f, x), 
		    CANON_Y_FROM_PIXEL_Y (f, y));
Jim Blandy's avatar
Jim Blandy committed
588 589 590

    case 2:			/* In mode line of window. */
      return Qmode_line;
591

Jim Blandy's avatar
Jim Blandy committed
592
    case 3:			/* On right border of window.  */
Jim Blandy's avatar
Jim Blandy committed
593
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
594

595
    case 4:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
596
      return Qheader_line;
597

598 599 600 601 602 603
    case 5:
      return Qleft_bitmap_area;
      
    case 6:
      return Qright_bitmap_area;

Jim Blandy's avatar
Jim Blandy committed
604 605 606 607 608
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
609 610

/* Callback for foreach_window, used in window_from_coordinates.
611 612 613 614 615 616 617 618 619 620 621 622 623
   Check if window W contains coordinates specified by USER_DATA which
   is actually a pointer to a struct check_window_data CW.

   Check if window W contains coordinates *CW->x and *CW->y.  If it
   does, return W in *CW->window, as Lisp_Object, and return in
   *CW->part the part of the window under coordinates *X/*Y.  Return
   zero from this function to stop iterating over windows.  */

struct check_window_data
{
  Lisp_Object *window;
  int *x, *y, *part;
};
Gerd Moellmann's avatar
Gerd Moellmann committed
624 625

static int
626
check_window_containing (w, user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
627
     struct window *w;
628
     void *user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
629
{
630
  struct check_window_data *cw = (struct check_window_data *) user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
631 632
  int found;

633
  found = coordinates_in_window (w, cw->x, cw->y);
Gerd Moellmann's avatar
Gerd Moellmann committed
634 635
  if (found)
    {
636 637
      *cw->part = found - 1;
      XSETWINDOW (*cw->window, w);
Gerd Moellmann's avatar
Gerd Moellmann committed
638 639 640 641 642 643
    }
  
  return !found;
}


644 645 646 647 648
/* Find the window containing frame-relative pixel position X/Y and
   return it as a 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
Gerd Moellmann's avatar
Gerd Moellmann committed
649 650 651 652 653 654 655 656 657 658
   unmodified.  TOOL_BAR_P non-zero means detect tool-bar windows.

   This function was previously implemented with a loop cycling over
   windows with Fnext_window, and starting with the frame's selected
   window.  It turned out that this doesn't work with an
   implementation of next_window using Vwindow_list, because
   FRAME_SELECTED_WINDOW (F) is not always contained in the window
   tree of F when this function is called asynchronously from
   note_mouse_highlight.  The original loop didn't terminate in this
   case.  */
659

Jim Blandy's avatar
Jim Blandy committed
660
Lisp_Object
Gerd Moellmann's avatar
Gerd Moellmann committed
661 662
window_from_coordinates (f, x, y, part, tool_bar_p)
     struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
663
     int x, y;
Jim Blandy's avatar
Jim Blandy committed
664
     int *part;
665
     int tool_bar_p;
Jim Blandy's avatar
Jim Blandy committed
666
{
Gerd Moellmann's avatar
Gerd Moellmann committed
667
  Lisp_Object window;
668
  struct check_window_data cw;
669

Gerd Moellmann's avatar
Gerd Moellmann committed
670
  window = Qnil;
671 672
  cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
  foreach_window (f, check_window_containing, &cw);
Gerd Moellmann's avatar
Gerd Moellmann committed
673 674 675 676 677 678 679 680
  
  /* If not found above, see if it's in the tool bar window, if a tool
     bar exists.  */
  if (NILP (window)
      && tool_bar_p
      && WINDOWP (f->tool_bar_window)
      && XINT (XWINDOW (f->tool_bar_window)->height) > 0
      && coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y))
681 682
    {
      *part = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
683
      window = f->tool_bar_window;
684
    }
685

Gerd Moellmann's avatar
Gerd Moellmann committed
686
  return window;
Jim Blandy's avatar
Jim Blandy committed
687 688
}

689
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
690
  "Return window containing coordinates X and Y on FRAME.\n\
Jim Blandy's avatar
Jim Blandy committed
691 692
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
693
column 0.")
Richard M. Stallman's avatar
Richard M. Stallman committed
694 695
  (x, y, frame)
      Lisp_Object x, y, frame;
Jim Blandy's avatar
Jim Blandy committed
696 697
{
  int part;
698
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
699

Jim Blandy's avatar
Jim Blandy committed
700
  if (NILP (frame))
701 702
    frame = selected_frame;
  CHECK_LIVE_FRAME (frame, 2);
703
  f = XFRAME (frame);
Jim Blandy's avatar
Jim Blandy committed
704

705 706 707 708 709 710 711 712
  /* Check that arguments are integers or floats.  */
  CHECK_NUMBER_OR_FLOAT (x, 0);
  CHECK_NUMBER_OR_FLOAT (y, 1);

  return window_from_coordinates (f, 
				  PIXEL_X_FROM_CANON_X (f, x),
				  PIXEL_Y_FROM_CANON_Y (f, y),
				  &part, 0);
Jim Blandy's avatar
Jim Blandy committed
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
}

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,
737 738
  "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
739 740 741 742 743 744
  (window)
     Lisp_Object window;
{
  return Fmarker_position (decode_window (window)->start);
}

745 746
/* This is text temporarily removed from the doc string below.

747 748 749 750 751 752 753
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\
754 755
      (point))")  */

756
DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
757 758 759
  "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\
760 761 762 763 764
does not update this value.\n\
If UP-TO-DATE is non-nil, compute the up-to-date position\n\
if it isn't already recorded.")
  (window, update)
     Lisp_Object window, update;
Jim Blandy's avatar
Jim Blandy committed
765 766 767
{
  Lisp_Object value;
  struct window *w = decode_window (window);
768 769 770 771 772
  Lisp_Object buf;

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

773
#if 0 /* This change broke some things.  We should make it later.  */
774 775 776 777 778 779
  /* 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;
780
#endif
781

782 783 784 785 786
  if (! NILP (update)
      && ! (! NILP (w->window_end_valid)
	    && XFASTINT (w->last_modified) >= MODIFF))
    {
      int opoint = PT, opoint_byte = PT_BYTE;
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801

      /* In case W->start is out of the range, use something
         reasonable.  This situation occured when loading a file with
         `-l' containing a call to `rmail' with subsequent other
         commands.  At the end, W->start happened to be BEG, while
         rmail had already narrowed the buffer.  This leads to an
         abort in temp_set_pt_both.  */
      if (XMARKER (w->start)->charpos < BEGV)
	TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
      else if (XMARKER (w->start)->charpos > ZV)
	TEMP_SET_PT_BOTH (ZV, ZV_BYTE);
      else
	TEMP_SET_PT_BOTH (XMARKER (w->start)->charpos,
			  XMARKER (w->start)->bytepos);
      
802 803 804 805 806 807 808
      Fvertical_motion (make_number (window_internal_height (w)), Qnil);
      XSETINT (value, PT);
      TEMP_SET_PT_BOTH (opoint, opoint_byte);
    }
  else
    XSETINT (value,
	     BUF_Z (XBUFFER (buf)) - XFASTINT (w->window_end_pos));
Jim Blandy's avatar
Jim Blandy committed
809 810 811 812 813 814 815 816 817 818 819 820

  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);
821 822
  if (w == XWINDOW (selected_window)
      && XBUFFER (w->buffer) == current_buffer)
Jim Blandy's avatar
Jim Blandy committed
823 824 825
    Fgoto_char (pos);
  else
    set_marker_restricted (w->pointm, pos, w->buffer);
826
  
Jim Blandy's avatar
Jim Blandy committed
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
  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
843
  if (NILP (noforce))
Jim Blandy's avatar
Jim Blandy committed
844 845
    w->force_start = Qt;
  w->update_mode_line = Qt;
846
  XSETFASTINT (w->last_modified, 0);
847
  XSETFASTINT (w->last_overlay_modified, 0);
Jim Blandy's avatar
Jim Blandy committed
848 849
  if (!EQ (window, selected_window))
    windows_or_buffers_changed++;
850

Jim Blandy's avatar
Jim Blandy committed
851 852 853 854 855 856
  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\
857
See also `set-window-dedicated-p'.")
Jim Blandy's avatar
Jim Blandy committed
858 859 860 861 862 863
  (window)
     Lisp_Object window;
{
  return decode_window (window)->dedicated;
}

864 865 866 867 868 869 870
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
871 872 873 874 875
  (window, arg)
       Lisp_Object window, arg;
{
  register struct window *w = decode_window (window);

Jim Blandy's avatar
Jim Blandy committed
876
  if (NILP (arg))
Jim Blandy's avatar
Jim Blandy committed
877 878
    w->dedicated = Qnil;
  else
879
    w->dedicated = Qt;
Jim Blandy's avatar
Jim Blandy committed
880 881 882 883 884 885 886 887 888 889 890 891 892

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

893 894 895 896
/* Get the display table for use 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.  */
Jim Blandy's avatar
Jim Blandy committed
897

898
struct Lisp_Char_Table *
Jim Blandy's avatar
Jim Blandy committed
899 900 901
window_display_table (w)
     struct window *w;
{
902 903 904 905 906 907 908 909 910 911 912 913 914
  struct Lisp_Char_Table *dp = NULL;

  if (DISP_TABLE_P (w->display_table))
    dp = XCHAR_TABLE (w->display_table);
  else if (BUFFERP (w->buffer))
    {
      struct buffer *b = XBUFFER (w->buffer);
      
      if (DISP_TABLE_P (b->display_table))
	dp = XCHAR_TABLE (b->display_table);
      else if (DISP_TABLE_P (Vstandard_display_table))
	dp = XCHAR_TABLE (Vstandard_display_table);
    }
915

916
  return dp;
Jim Blandy's avatar
Jim Blandy committed
917 918
}

Jim Blandy's avatar
Jim Blandy committed
919
DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
920 921 922 923 924 925 926 927 928 929 930 931 932
  "Set WINDOW's display-table to TABLE.")
  (window, table)
     register Lisp_Object window, table;
{
  register struct window *w;

  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.  */
Andreas Schwab's avatar
Andreas Schwab committed
933
static void
Jim Blandy's avatar
Jim Blandy committed
934 935 936
unshow_buffer (w)
     register struct window *w;
{
937
  Lisp_Object buf;
938
  struct buffer *b;
Jim Blandy's avatar
Jim Blandy committed
939

940
  buf = w->buffer;
941 942
  b = XBUFFER (buf);
  if (b != XMARKER (w->pointm)->buffer)
Jim Blandy's avatar
Jim Blandy committed
943 944
    abort ();

945
#if 0
Jim Blandy's avatar
Jim Blandy committed
946 947 948 949
  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.  */
950 951 952 953 954 955 956 957
#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.  */
958
    b->last_window_start = marker_position (w->start);
Jim Blandy's avatar
Jim Blandy committed
959 960 961 962

  /* 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.  */
963 964
  if (! EQ (buf, XWINDOW (selected_window)->buffer)
      /* This line helps to fix Horsley's testbug.el bug.  */
965 966
      && !(WINDOWP (b->last_selected_window)
	   && w != XWINDOW (b->last_selected_window)
967
	   && EQ (buf, XWINDOW (b->last_selected_window)->buffer)))
968 969 970 971 972 973 974
    temp_set_point_both (b,
			 clip_to_bounds (BUF_BEGV (b),
					 XMARKER (w->pointm)->charpos,
					 BUF_ZV (b)),
			 clip_to_bounds (BUF_BEGV_BYTE (b),
					 marker_byte_position (w->pointm),
					 BUF_ZV_BYTE (b)));
975
  
976 977
  if (WINDOWP (b->last_selected_window)
      && w == XWINDOW (b->last_selected_window))
978
    b->last_selected_window = Qnil;
Jim Blandy's avatar
Jim Blandy committed
979 980 981
}

/* Put replacement into the window structure in place of old. */
Andreas Schwab's avatar
Andreas Schwab committed
982
static void
Jim Blandy's avatar
Jim Blandy committed
983 984 985 986 987 988
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
989 990
  /* 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
991

992
  if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame))))
Jim Blandy's avatar
Jim Blandy committed
993
    FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement;
Jim Blandy's avatar
Jim Blandy committed
994 995 996 997 998

  p->left = o->left;
  p->top = o->top;
  p->width = o->width;
  p->height = o->height;
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
  p->desired_matrix = p->current_matrix = 0;
  p->vscroll = 0;
  bzero (&p->cursor, sizeof (p->cursor));
  bzero (&p->last_cursor, sizeof (p->last_cursor));
  bzero (&p->phys_cursor, sizeof (p->phys_cursor));
  p->phys_cursor_type = -1;
  p->must_be_updated_p = 0;
  p->pseudo_window_p = 0;
  XSETFASTINT (p->window_end_vpos, 0);
  XSETFASTINT (p->window_end_pos, 0);
  p->window_end_valid = Qnil;
1010
  p->frozen_window_start_p = 0;
1011
  p->orig_top = p->orig_height = Qnil;
Jim Blandy's avatar
Jim Blandy committed
1012 1013

  p->next = tem = o->next;
Jim Blandy's avatar
Jim Blandy committed
1014
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1015 1016 1017
    XWINDOW (tem)->prev = replacement;

  p->prev = tem = o->prev;
Jim Blandy's avatar
Jim Blandy committed
1018
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1019 1020 1021
    XWINDOW (tem)->next = replacement;

  p->parent = tem = o->parent;
Jim Blandy's avatar
Jim Blandy committed
1022
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
    {
      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;
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
{
  delete_window (window);

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

  return Qnil;
}

Andreas Schwab's avatar
Andreas Schwab committed
1049
void
1050 1051
delete_window (window)
     register Lisp_Object window;
Jim Blandy's avatar
Jim Blandy committed
1052 1053 1054 1055
{
  register Lisp_Object tem, parent, sib;
  register struct window *p;
  register struct window *par;
1056
  FRAME_PTR frame;
Jim Blandy's avatar
Jim Blandy committed
1057

1058 1059 1060
  /* 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
1061
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
1062 1063 1064 1065
    window = selected_window;
  else
    CHECK_WINDOW (window, 0);
  p = XWINDOW (window);
1066 1067 1068 1069 1070

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

Jim Blandy's avatar
Jim Blandy committed
1073
  parent = p->parent;
Jim Blandy's avatar
Jim Blandy committed
1074
  if (NILP (parent))
Jim Blandy's avatar
Jim Blandy committed
1075 1076 1077 1078
    error ("Attempt to delete minibuffer or sole ordinary window");
  par = XWINDOW (parent);

  windows_or_buffers_changed++;
Gerd Moellmann's avatar
Gerd Moellmann committed
1079
  Vwindow_list = Qnil;
1080 1081
  frame = XFRAME (WINDOW_FRAME (p));
  FRAME_WINDOW_SIZES_CHANGED (frame) = 1;
Jim Blandy's avatar
Jim Blandy committed
1082

1083 1084
  /* Are we trying to delete any frame's selected window?  */
  {
1085
    Lisp_Object frame, pwindow;
1086

1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
    /* 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))
1101
      {
1102 1103
	Lisp_Object alternative;
	alternative = Fnext_window (window, Qlambda, Qnil);
1104 1105 1106 1107 1108 1109 1110 1111 1112

	/* 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
1113
	  FRAME_SELECTED_WINDOW (XFRAME (frame)) = alternative;
1114 1115
      }
  }
Jim Blandy's avatar
Jim Blandy committed
1116 1117 1118 1119

  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
1120
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1121 1122 1123 1124 1125 1126
    {
      unshow_buffer (p);
      unchain_marker (p->pointm);
      unchain_marker (p->start);
    }

1127 1128 1129 1130 1131
  /* Free window glyph matrices.  It is sure that they are allocated
     again when ADJUST_GLYPHS is called.  Block input so that expose
     events and other events that access glyph matrices are not
     processed while we are changing them.  */
  BLOCK_INPUT;
1132 1133
  free_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (frame)));

Jim Blandy's avatar
Jim Blandy committed
1134
  tem = p->next;
Jim Blandy's avatar
Jim Blandy committed
1135
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1136 1137 1138
    XWINDOW (tem)->prev = p->prev;

  tem = p->prev;
Jim Blandy's avatar
Jim Blandy committed
1139
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1140 1141 1142 1143 1144 1145 1146 1147 1148
    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
1149
  if (NILP (sib))
Jim Blandy's avatar
Jim Blandy committed
1150 1151 1152 1153 1154 1155
    {
      /* 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;
1156 1157
      XWINDOW (sib)->top = p->top;
      XWINDOW (sib)->left = p->left;
Jim Blandy's avatar
Jim Blandy committed
1158 1159 1160
    }

  /* Stretch that sibling.  */
Jim Blandy's avatar
Jim Blandy committed
1161
  if (!NILP (par->vchild))
Jim Blandy's avatar
Jim Blandy committed
1162 1163 1164
    set_window_height (sib,
		       XFASTINT (XWINDOW (sib)->height) + XFASTINT (p->height),
		       1);
Jim Blandy's avatar
Jim Blandy committed
1165
  if (!NILP (par->hchild))
Jim Blandy's avatar
Jim Blandy committed
1166 1167 1168 1169 1170 1171 1172
    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
1173
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
1174
    tem = par->vchild;
Jim Blandy's avatar
Jim Blandy committed
1175
  if (NILP (XWINDOW (tem)->next))
Jim Blandy's avatar
Jim Blandy committed
1176
    replace_window (parent, tem);
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186

  /* 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;
1187 1188 1189

  /* Adjust glyph matrices. */
  adjust_glyphs (frame);
1190
  UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
1191
}
Gerd Moellmann's avatar
Gerd Moellmann committed
1192 1193


Jim Blandy's avatar
Jim Blandy committed
1194

Gerd Moellmann's avatar
Gerd Moellmann committed
1195 1196 1197 1198
/***********************************************************************
			     Window List
 ***********************************************************************/

1199 1200 1201
/* Add window W to *USER_DATA.  USER_DATA is actually a Lisp_Object
   pointer.  This is a callback function for foreach_window, used in
   function window_list.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1202 1203

static int
1204
add_window_to_list (w, user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
1205
     struct window *w;