window.c 170 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 4
   Copyright (C) 1985,86,87,93,94,95,96,97,1998,2000
   Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

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
10
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
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
20 21
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22

23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25
#include "lisp.h"
#include "buffer.h"
26
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
28 29 30 31 32
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
33
#include "dispextern.h"
34 35 36
#include "blockinput.h"
#include "intervals.h"

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

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

54

55
Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
56
Lisp_Object Qwindow_size_fixed, Qleft_bitmap_area, Qright_bitmap_area;
Gerd Moellmann's avatar
Gerd Moellmann committed
57
extern Lisp_Object Qheight, Qwidth;
Jim Blandy's avatar
Jim Blandy committed
58

Andreas Schwab's avatar
Andreas Schwab committed
59
static struct window *decode_window P_ ((Lisp_Object));
60
static Lisp_Object select_window_1 P_ ((Lisp_Object, int));
61 62 63 64 65
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
66
static int window_min_size_1 P_ ((struct window *, int));
67
static int window_min_size P_ ((struct window *, int, int, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
68
static void size_window P_ ((Lisp_Object, int, int, int));
69
static int freeze_window_start P_ ((struct window *, void *));
70
static int window_fixed_size_p P_ ((struct window *, int, int));
71
static void enlarge_window P_ ((Lisp_Object, int, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
72
static Lisp_Object window_list P_ ((void));
73
static int add_window_to_list P_ ((struct window *, void *));
74 75
static int candidate_window_p P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
				   Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
76 77 78 79
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 *));
80 81 82
static int foreach_window_1 P_ ((struct window *,
				 int (* fn) (struct window *, void *),
				 void *));
83
static Lisp_Object window_list_1 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
84

Jim Blandy's avatar
Jim Blandy committed
85 86 87 88 89 90
/* 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
91
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
92 93 94

Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
95 96 97 98 99 100
/* 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;

101 102 103
/* 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
104
   the selected window.  */
105

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

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

Jim Blandy's avatar
Jim Blandy committed
111 112 113
Lisp_Object Vminibuf_scroll_window;

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

Jim Blandy's avatar
Jim Blandy committed
115 116 117
Lisp_Object Vother_window_scroll_buffer;

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

Jim Blandy's avatar
Jim Blandy committed
119 120 121
Lisp_Object Vtemp_buffer_show_function;

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

Jim Blandy's avatar
Jim Blandy committed
123 124 125 126
int window_min_height;
int window_min_width;

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

Jim Blandy's avatar
Jim Blandy committed
128 129
int pop_up_windows;

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

Jim Blandy's avatar
Jim Blandy committed
132
int pop_up_frames;
Jim Blandy's avatar
Jim Blandy committed
133

134 135 136 137
/* Nonzero means reuse existing frames for displaying buffers.  */

int display_buffer_reuse_frames;

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

Jim Blandy's avatar
Jim Blandy committed
140
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
141 142

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

Jim Blandy's avatar
Jim Blandy committed
144 145
Lisp_Object Vdisplay_buffer_function;

146 147 148 149
/* Non-nil means that Fdisplay_buffer should even the heights of windows.  */

Lisp_Object Veven_window_heights;

150
/* List of buffer *names* for buffers that should have their own frames.  */
151

152 153 154
Lisp_Object Vspecial_display_buffer_names;

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

156 157 158
Lisp_Object Vspecial_display_regexps;

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

160 161
Lisp_Object Vspecial_display_function;

162
/* List of buffer *names* for buffers to appear in selected window.  */
163

164 165 166
Lisp_Object Vsame_window_buffer_names;

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

168 169
Lisp_Object Vsame_window_regexps;

170
/* Hook run at end of temp_output_buffer_show.  */
171

172 173
Lisp_Object Qtemp_buffer_show_hook;

174
/* Fdisplay_buffer always splits the largest window
Jim Blandy's avatar
Jim Blandy committed
175
   if that window is more than this high.  */
176

Jim Blandy's avatar
Jim Blandy committed
177 178 179
int split_height_threshold;

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

Jim Blandy's avatar
Jim Blandy committed
181 182 183
int next_screen_context_lines;

/* Incremented for each window created.  */
184

Jim Blandy's avatar
Jim Blandy committed
185 186
static int sequence_number;

187
/* Nonzero after init_window_once has finished.  */
188

189 190
static int window_initialized;

191
/* Hook to run when window config changes.  */
192

193 194 195
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

196 197 198
/* Nonzero means scroll commands try to put point
   at the same screen height as previously.  */

199 200 201
Lisp_Object Vscroll_preserve_screen_position;

#if 0 /* This isn't used anywhere.  */
202
/* Nonzero means we can split a frame even if it is "unsplittable".  */
203
static int inhibit_frame_unsplittable;
204
#endif /* 0 */
205

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

208 209
extern int scroll_margin;

210
extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
Jim Blandy's avatar
Jim Blandy committed
211 212

DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
213 214 215
  "Returns t if OBJECT is a window.")
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
216
{
217
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
218 219
}

220
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
221 222 223
  "Returns t if OBJECT is a window which is currently visible.")
     (object)
     Lisp_Object object;
224
{
225
  return (WINDOWP (object) && ! NILP (XWINDOW (object)->buffer) ? Qt : Qnil);
226 227
}

Jim Blandy's avatar
Jim Blandy committed
228 229 230
Lisp_Object
make_window ()
{
231
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
232
  register struct window *p;
233 234 235 236 237 238 239
  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);
240
  p = (struct window *) vec;
241 242 243 244 245 246
  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);
247
  p->orig_top = p->orig_height = Qnil;
Jim Blandy's avatar
Jim Blandy committed
248 249
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
250
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
251
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
252 253
  p->display_table = Qnil;
  p->dedicated = Qnil;
254 255 256 257 258 259 260 261 262 263 264
  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;
265
  XSETWINDOW (val, p);
266
  XSETFASTINT (p->last_point, 0);
267
  p->frozen_window_start_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
268 269

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
270 271 272 273 274 275 276 277 278 279
  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;
}

280 281 282 283 284 285
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
286
{
287
  if (NILP (frame))
288 289
    frame = selected_frame;
  CHECK_LIVE_FRAME (frame, 0);
290
  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
Jim Blandy's avatar
Jim Blandy committed
291 292
}

293
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
294 295 296 297 298
  "Returns non-nil if WINDOW is a minibuffer window.")
  (window)
     Lisp_Object window;
{
  struct window *w = decode_window (window);
299
  return MINI_WINDOW_P (w) ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
300 301 302
}


Jim Blandy's avatar
Jim Blandy committed
303
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
Miles Bader's avatar
Miles Bader committed
304
  Spos_visible_in_window_p, 0, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
305
  "Return t if position POS is currently on the frame in WINDOW.\n\
306
Return nil if that position is scrolled vertically out of view.\n\
Miles Bader's avatar
Miles Bader committed
307
If FULLY is non-nil, then only return t when POS is completely visible.\n\
Miles Bader's avatar
Miles Bader committed
308
POS defaults to point in WINDOW; WINDOW defaults to the selected window.")
Miles Bader's avatar
Miles Bader committed
309 310
  (pos, window, fully)
     Lisp_Object pos, window, fully;
Jim Blandy's avatar
Jim Blandy committed
311 312 313 314
{
  register struct window *w;
  register int posint;
  register struct buffer *buf;
315 316
  struct text_pos top;
  Lisp_Object in_window;
317
  int fully_p;
Jim Blandy's avatar
Jim Blandy committed
318

Miles Bader's avatar
Miles Bader committed
319 320 321 322 323
  w = decode_window (window);
  buf = XBUFFER (w->buffer);
  SET_TEXT_POS_FROM_MARKER (top, w->start);

  if (!NILP (pos))
Jim Blandy's avatar
Jim Blandy committed
324 325 326 327
    {
      CHECK_NUMBER_COERCE_MARKER (pos, 0);
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
328 329 330 331
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
332

333
  /* If position is above window start, it's not visible.  */
334
  if (posint < CHARPOS (top))
335 336
    in_window = Qnil;
  else if (XFASTINT (w->last_modified) >= BUF_MODIFF (buf)
Miles Bader's avatar
Miles Bader committed
337 338 339
	   && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (buf)
	   && posint < BUF_Z (buf) - XFASTINT (w->window_end_pos))
    {
340 341 342 343 344 345
      /* 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.  */
      if (!NILP (fully))
	{
346
	  pos_visible_p (w, posint, &fully_p, !NILP (fully));
347 348
	  in_window = fully_p ? Qt : Qnil;
	}
Miles Bader's avatar
Miles Bader committed
349
      else
350
	in_window = Qt;
Miles Bader's avatar
Miles Bader committed
351
    }
352 353 354 355 356
  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
357 358
  else
    {
359
      if (pos_visible_p (w, posint, &fully_p, !NILP (fully)))
360
	in_window = NILP (fully) || fully_p ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
361 362
      else
	in_window = Qnil;
Jim Blandy's avatar
Jim Blandy committed
363
    }
364 365

  return in_window;
Jim Blandy's avatar
Jim Blandy committed
366
}
367

Jim Blandy's avatar
Jim Blandy committed
368 369 370 371 372

static struct window *
decode_window (window)
     register Lisp_Object window;
{
Jim Blandy's avatar
Jim Blandy committed
373
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
374 375
    return XWINDOW (selected_window);

376
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
  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,
397 398 399 400
  "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
401 402 403
  (window)
     Lisp_Object window;
{
404
  return make_number (window_internal_width (decode_window (window)));
Jim Blandy's avatar
Jim Blandy committed
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
}

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);
424
  if (XINT (ncol) < 0) XSETFASTINT (ncol, 0);
Jim Blandy's avatar
Jim Blandy committed
425
  w = decode_window (window);
426
  if (XINT (w->hscroll) != XINT (ncol))
Gerd Moellmann's avatar
Gerd Moellmann committed
427 428
    /* Prevent redisplay shortcuts */
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
Jim Blandy's avatar
Jim Blandy committed
429 430 431 432
  w->hscroll = ncol;
  return ncol;
}

433 434 435 436 437 438 439 440 441 442 443 444 445 446
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\
447 448 449 450
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.")
451 452 453 454 455 456 457 458 459 460
  (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
461 462
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
463
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.\n\
Jim Blandy's avatar
Jim Blandy committed
464 465 466 467 468 469 470 471 472
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,
473
           Fcons (make_number (WINDOW_RIGHT_EDGE (w)),
Jim Blandy's avatar
Jim Blandy committed
474 475 476 477 478
		  Fcons (make_number (XFASTINT (w->top)
				      + XFASTINT (w->height)),
			 Qnil))));
}

479
/* Test if the character at column *X, row *Y is within window W.
Jim Blandy's avatar
Jim Blandy committed
480 481 482 483 484 485 486
   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,
487 488
      return 3.
   if it is on the window's top line, return 4;
489 490
   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.
491 492 493

   X and Y are frame relative pixel coordinates.  */

Jim Blandy's avatar
Jim Blandy committed
494 495 496 497 498
static int
coordinates_in_window (w, x, y)
     register struct window *w;
     register int *x, *y;
{
499 500
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  int left_x, right_x, top_y, bottom_y;
Gerd Moellmann's avatar
Gerd Moellmann committed
501
  int flags_area_width = FRAME_LEFT_FLAGS_AREA_WIDTH (f);
Jim Blandy's avatar
Jim Blandy committed
502

503 504 505 506 507
  /* Let's make this a global enum later, instead of using numbers
     everywhere.  */
  enum {ON_NOTHING, ON_TEXT, ON_MODE_LINE, ON_VERTICAL_BORDER,
	ON_HEADER_LINE, ON_LEFT_FRINGE, ON_RIGHT_FRINGE};

508 509
  /* 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.  */
510 511 512
  if (w->pseudo_window_p)
    {
      left_x = 0;
513
      right_x = XFASTINT (w->width) * CANON_Y_UNIT (f) - 1;
514 515 516 517 518
      top_y = WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w);
      bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
    }
  else
    {
519
      left_x = (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
520
		- FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
521
      right_x = WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X (w) - 1;
522
      top_y = (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
523
	       - FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
524 525
      bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
    }
526

527
  /* Completely outside anything interesting?  */
528 529 530 531 532 533 534
  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)
535 536 537 538 539 540 541 542 543 544 545
    return ON_NOTHING;
  
  /* On the mode line or header line?  If it's near the start of
     the mode or header line of window that's has a horizontal
     sibling, say it's on the vertical line.  That's to be able
     to resize windows horizontally in case we're using toolkit
     scroll bars.  */
  
  if (WINDOW_WANTS_MODELINE_P (w)
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
    {
546 547 548
      if (!WINDOW_RIGHTMOST_P (w)
	  && (abs (*x - ((XFASTINT (w->left) + XFASTINT (w->width))
			 * CANON_X_UNIT (f)))
549 550 551 552 553 554 555 556
	      < CANON_X_UNIT (f) / 2))
	return ON_VERTICAL_BORDER;
      return ON_MODE_LINE;
    }
  
  if (WINDOW_WANTS_HEADER_LINE_P (w)
      && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
    {
557 558 559
      if (!WINDOW_RIGHTMOST_P (w)
	  && (abs (*x - ((XFASTINT (w->left) + XFASTINT (w->width))
			 * CANON_X_UNIT (f)))
560 561 562 563
	      < CANON_X_UNIT (f) / 2))
	return ON_VERTICAL_BORDER;
      return ON_HEADER_LINE;
    }
564 565

  if (FRAME_WINDOW_P (f))
566
    {
567 568 569 570 571 572 573 574 575 576
      if (!w->pseudo_window_p
	  && !FRAME_HAS_VERTICAL_SCROLL_BARS (f)
	  && !WINDOW_RIGHTMOST_P (w)
	  && (abs (*x - right_x - flags_area_width) < CANON_X_UNIT (f) / 2))
	return ON_VERTICAL_BORDER;

      if (*x < left_x || *x > right_x)
	{
	  /* Other lines than the mode line don't include flags areas and
	     scroll bars on the left.  */
577
      
578 579 580 581 582
	  /* Convert X and Y to window-relative pixel coordinates.  */
	  *x -= left_x;
	  *y -= top_y;
	  return *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
	}
583
    }
584 585 586 587 588 589 590 591 592 593 594 595 596 597
  else
    {
      /* Need to say "*x > right_x" rather than >=, since on character
	 terminals, the vertical line's x coordinate is right_x.  */
      if (*x < left_x || *x > right_x)
	{
	  /* 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 ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
	}
598
  
599 600 601 602 603 604 605 606
      /* Here, too, "*x > right_x" is because of character terminals.  */
      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 ON_VERTICAL_BORDER;
    }
607 608 609 610 611
  
  /* Convert X and Y to window-relative pixel coordinates.  */
  *x -= left_x;
  *y -= top_y;
  return ON_TEXT;
Jim Blandy's avatar
Jim Blandy committed
612 613 614 615 616
}

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
617
COORDINATES is a cons of the form (X . Y), X and Y being distances\n\
Jim Blandy's avatar
Jim Blandy committed
618
measured in characters from the upper-left corner of the frame.\n\
Jim Blandy's avatar
Jim Blandy committed
619
(0 .  0) denotes the character in the upper left corner of the\n\
Jim Blandy's avatar
Jim Blandy committed
620
frame.\n\
Jim Blandy's avatar
Jim Blandy committed
621 622
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
623
If they are in the mode line of WINDOW, `mode-line' is returned.\n\
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
624
If they are in the top mode line of WINDOW, `header-line' is returned.\n\
625 626 627
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
628
If they are on the border between WINDOW and its right sibling,\n\
Jim Blandy's avatar
Jim Blandy committed
629
   `vertical-line' is returned.")
Jim Blandy's avatar
Jim Blandy committed
630 631 632
  (coordinates, window)
     register Lisp_Object coordinates, window;
{
633 634
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
635
  int x, y;
636
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
637

638
  CHECK_LIVE_WINDOW (window, 0);
639 640
  w = XWINDOW (window);
  f = XFRAME (w->frame);
Jim Blandy's avatar
Jim Blandy committed
641
  CHECK_CONS (coordinates, 1);
642 643 644 645 646 647 648 649
  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
650 651 652 653 654
    {
    case 0:			/* NOT in window at all. */
      return Qnil;

    case 1:			/* In text part of window. */
655 656 657 658 659
      /* 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
660 661 662

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

Jim Blandy's avatar
Jim Blandy committed
664
    case 3:			/* On right border of window.  */
Jim Blandy's avatar
Jim Blandy committed
665
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
666

667
    case 4:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
668
      return Qheader_line;
669

670 671 672 673 674 675
    case 5:
      return Qleft_bitmap_area;
      
    case 6:
      return Qright_bitmap_area;

Jim Blandy's avatar
Jim Blandy committed
676 677 678 679 680
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
681 682

/* Callback for foreach_window, used in window_from_coordinates.
683 684 685 686 687
   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
Dave Love's avatar
Dave Love committed
688
   *CW->part the part of the window under coordinates *X,*Y.  Return
689 690 691 692 693 694 695
   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
696 697

static int
698
check_window_containing (w, user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
699
     struct window *w;
700
     void *user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
701
{
702
  struct check_window_data *cw = (struct check_window_data *) user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
703 704
  int found;

705
  found = coordinates_in_window (w, cw->x, cw->y);
Gerd Moellmann's avatar
Gerd Moellmann committed
706 707
  if (found)
    {
708 709
      *cw->part = found - 1;
      XSETWINDOW (*cw->window, w);
Gerd Moellmann's avatar
Gerd Moellmann committed
710 711 712 713 714 715
    }
  
  return !found;
}


716 717 718 719 720
/* 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
721 722 723 724 725 726 727 728 729 730
   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.  */
731

Jim Blandy's avatar
Jim Blandy committed
732
Lisp_Object
Gerd Moellmann's avatar
Gerd Moellmann committed
733 734
window_from_coordinates (f, x, y, part, tool_bar_p)
     struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
735
     int x, y;
Jim Blandy's avatar
Jim Blandy committed
736
     int *part;
737
     int tool_bar_p;
Jim Blandy's avatar
Jim Blandy committed
738
{
Gerd Moellmann's avatar
Gerd Moellmann committed
739
  Lisp_Object window;
740
  struct check_window_data cw;
741

Gerd Moellmann's avatar
Gerd Moellmann committed
742
  window = Qnil;
743 744
  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
745 746 747 748 749 750 751 752
  
  /* 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))
753 754
    {
      *part = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
755
      window = f->tool_bar_window;
756
    }
757

Gerd Moellmann's avatar
Gerd Moellmann committed
758
  return window;
Jim Blandy's avatar
Jim Blandy committed
759 760
}

761
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
762
  "Return window containing coordinates X and Y on FRAME.\n\
Jim Blandy's avatar
Jim Blandy committed
763 764
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
765
column 0.")
Richard M. Stallman's avatar
Richard M. Stallman committed
766 767
  (x, y, frame)
      Lisp_Object x, y, frame;
Jim Blandy's avatar
Jim Blandy committed
768 769
{
  int part;
770
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
771

Jim Blandy's avatar
Jim Blandy committed
772
  if (NILP (frame))
773 774
    frame = selected_frame;
  CHECK_LIVE_FRAME (frame, 2);
775
  f = XFRAME (frame);
Jim Blandy's avatar
Jim Blandy committed
776

777 778 779 780 781 782 783 784
  /* 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
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
}

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,
809 810
  "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
811 812 813 814 815 816
  (window)
     Lisp_Object window;
{
  return Fmarker_position (decode_window (window)->start);
}

817 818
/* This is text temporarily removed from the doc string below.

819 820 821 822 823 824 825
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\
826 827
      (point))")  */

828
DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
829 830 831
  "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\
832 833 834 835 836
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
837 838 839
{
  Lisp_Object value;
  struct window *w = decode_window (window);
840 841 842 843 844
  Lisp_Object buf;

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

845
#if 0 /* This change broke some things.  We should make it later.  */
846 847 848 849 850 851
  /* 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;
852
#endif
853

854 855 856 857
  if (! NILP (update)
      && ! (! NILP (w->window_end_valid)
	    && XFASTINT (w->last_modified) >= MODIFF))
    {
858 859
      struct text_pos startp;
      struct it it;
860 861 862 863 864

      /* 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
865
         rmail had already narrowed the buffer.  */
866
      if (XMARKER (w->start)->charpos < BEGV)
867
	SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
868
      else if (XMARKER (w->start)->charpos > ZV)
869
	SET_TEXT_POS (startp, ZV, ZV_BYTE);
870
      else
871 872 873 874 875 876 877
	SET_TEXT_POS_FROM_MARKER (startp, w->start);

      /* Cannot use Fvertical_motion because that function doesn't
	 cope with variable-height lines.  */
      start_display (&it, w, startp);
      move_it_vertically (&it, window_box_height (w));
      value = make_number (IT_CHARPOS (it));
878 879
    }
  else
880
    XSETINT (value, BUF_Z (XBUFFER (buf)) - XFASTINT (w->window_end_pos));
Jim Blandy's avatar
Jim Blandy committed
881 882 883 884 885 886 887 888 889 890 891 892

  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);
893 894
  if (w == XWINDOW (selected_window)
      && XBUFFER (w->buffer) == current_buffer)
Jim Blandy's avatar
Jim Blandy committed
895 896 897
    Fgoto_char (pos);
  else
    set_marker_restricted (w->pointm, pos, w->buffer);
898
  
Jim Blandy's avatar
Jim Blandy committed
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
  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
915
  if (NILP (noforce))
Jim Blandy's avatar
Jim Blandy committed
916 917
    w->force_start = Qt;
  w->update_mode_line = Qt;
918
  XSETFASTINT (w->last_modified, 0);
919
  XSETFASTINT (w->last_overlay_modified, 0);
Jim Blandy's avatar
Jim Blandy committed
920 921
  if (!EQ (window, selected_window))
    windows_or_buffers_changed++;
922

Jim Blandy's avatar
Jim Blandy committed
923 924 925 926 927 928
  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\
929
See also `set-window-dedicated-p'.")
Jim Blandy's avatar
Jim Blandy committed
930 931 932 933 934 935
  (window)
     Lisp_Object window;
{
  return decode_window (window)->dedicated;
}

936 937 938 939 940 941 942
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
943 944 945 946 947
  (window, arg)
       Lisp_Object window, arg;
{
  register struct window *w = decode_window (window);

Jim Blandy's avatar
Jim Blandy committed
948
  if (NILP (arg))
Jim Blandy's avatar
Jim Blandy committed
949 950
    w->dedicated = Qnil;
  else
951
    w->dedicated = Qt;
Jim Blandy's avatar
Jim Blandy committed
952 953 954 955 956 957 958 959 960 961 962 963 964

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

965 966 967 968
/* 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
969

970
struct Lisp_Char_Table *
Jim Blandy's avatar
Jim Blandy committed
971 972 973
window_display_table (w)
     struct window *w;
{
974 975 976 977 978 979