window.c 178 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,97,1998,2000, 2001
4
   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"
Stefan Monnier's avatar
Stefan Monnier committed
27
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
29 30 31 32 33
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
34
#include "dispextern.h"
35 36 37
#include "blockinput.h"
#include "intervals.h"

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

51 52 53 54 55 56 57 58 59 60 61 62 63
/* Values returned from coordinates_in_window.  */

enum window_part
{
  ON_NOTHING,
  ON_TEXT,
  ON_MODE_LINE,
  ON_VERTICAL_BORDER,
  ON_HEADER_LINE,
  ON_LEFT_FRINGE,
  ON_RIGHT_FRINGE
};

64

65
Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
66
Lisp_Object Qwindow_size_fixed;
Gerd Moellmann's avatar
Gerd Moellmann committed
67
extern Lisp_Object Qheight, Qwidth;
Jim Blandy's avatar
Jim Blandy committed
68

69
static int displayed_window_lines P_ ((struct window *));
Andreas Schwab's avatar
Andreas Schwab committed
70
static struct window *decode_window P_ ((Lisp_Object));
71
static Lisp_Object select_window_1 P_ ((Lisp_Object, int));
72 73 74 75 76
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
77
static int window_min_size_1 P_ ((struct window *, int));
78
static int window_min_size P_ ((struct window *, int, int, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
79
static void size_window P_ ((Lisp_Object, int, int, int));
80
static int freeze_window_start P_ ((struct window *, void *));
81
static int window_fixed_size_p P_ ((struct window *, int, int));
82
static void enlarge_window P_ ((Lisp_Object, int, int, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
83
static Lisp_Object window_list P_ ((void));
84
static int add_window_to_list P_ ((struct window *, void *));
85 86
static int candidate_window_p P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
				   Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
87 88 89 90
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 *));
91 92 93
static int foreach_window_1 P_ ((struct window *,
				 int (* fn) (struct window *, void *),
				 void *));
94
static Lisp_Object window_list_1 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
95

96 97 98 99
/* The value of `window-size-fixed'.  */

int window_size_fixed;

Jim Blandy's avatar
Jim Blandy committed
100 101 102 103 104 105
/* 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
106
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
107 108 109

Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
110 111 112 113 114 115
/* 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;

116 117 118
/* 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
119
   the selected window.  */
120

Jim Blandy's avatar
Jim Blandy committed
121 122 123
Lisp_Object minibuf_window;

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

Jim Blandy's avatar
Jim Blandy committed
126 127 128
Lisp_Object Vminibuf_scroll_window;

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

Jim Blandy's avatar
Jim Blandy committed
130 131 132
Lisp_Object Vother_window_scroll_buffer;

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

Jim Blandy's avatar
Jim Blandy committed
134 135 136
Lisp_Object Vtemp_buffer_show_function;

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

Jim Blandy's avatar
Jim Blandy committed
138 139 140 141
int window_min_height;
int window_min_width;

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

Jim Blandy's avatar
Jim Blandy committed
143 144
int pop_up_windows;

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

Jim Blandy's avatar
Jim Blandy committed
147
int pop_up_frames;
Jim Blandy's avatar
Jim Blandy committed
148

149 150 151 152
/* Nonzero means reuse existing frames for displaying buffers.  */

int display_buffer_reuse_frames;

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

Jim Blandy's avatar
Jim Blandy committed
155
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
156 157

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

Jim Blandy's avatar
Jim Blandy committed
159 160
Lisp_Object Vdisplay_buffer_function;

161 162 163 164
/* Non-nil means that Fdisplay_buffer should even the heights of windows.  */

Lisp_Object Veven_window_heights;

165
/* List of buffer *names* for buffers that should have their own frames.  */
166

167 168 169
Lisp_Object Vspecial_display_buffer_names;

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

171 172 173
Lisp_Object Vspecial_display_regexps;

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

175 176
Lisp_Object Vspecial_display_function;

177
/* List of buffer *names* for buffers to appear in selected window.  */
178

179 180 181
Lisp_Object Vsame_window_buffer_names;

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

183 184
Lisp_Object Vsame_window_regexps;

185
/* Hook run at end of temp_output_buffer_show.  */
186

187 188
Lisp_Object Qtemp_buffer_show_hook;

189
/* Fdisplay_buffer always splits the largest window
Jim Blandy's avatar
Jim Blandy committed
190
   if that window is more than this high.  */
191

Jim Blandy's avatar
Jim Blandy committed
192 193 194
int split_height_threshold;

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

Jim Blandy's avatar
Jim Blandy committed
196 197 198
int next_screen_context_lines;

/* Incremented for each window created.  */
199

Jim Blandy's avatar
Jim Blandy committed
200 201
static int sequence_number;

202
/* Nonzero after init_window_once has finished.  */
203

204 205
static int window_initialized;

206
/* Hook to run when window config changes.  */
207

208 209 210
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

211 212 213
/* Nonzero means scroll commands try to put point
   at the same screen height as previously.  */

214 215 216
Lisp_Object Vscroll_preserve_screen_position;

#if 0 /* This isn't used anywhere.  */
217
/* Nonzero means we can split a frame even if it is "unsplittable".  */
218
static int inhibit_frame_unsplittable;
219
#endif /* 0 */
220

221 222
extern int scroll_margin;

223
extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
Jim Blandy's avatar
Jim Blandy committed
224 225

DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
226 227
       doc: /* Returns t if OBJECT is a window.  */)
     (object)
228
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
229
{
230
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
231 232
}

233
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
234
       doc: /* Returns t if OBJECT is a window which is currently visible.  */)
235 236
     (object)
     Lisp_Object object;
237
{
238
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
239 240
}

Jim Blandy's avatar
Jim Blandy committed
241 242 243
Lisp_Object
make_window ()
{
244
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
245
  register struct window *p;
246

247
  p = allocate_window ();
248 249 250 251 252 253
  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);
254
  XSETFASTINT (p->min_hscroll, 0);
255
  p->orig_top = p->orig_height = Qnil;
Jim Blandy's avatar
Jim Blandy committed
256 257
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
258
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
259
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
260 261
  p->display_table = Qnil;
  p->dedicated = Qnil;
262 263 264 265 266 267 268 269 270 271 272
  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;
273
  XSETWINDOW (val, p);
274
  XSETFASTINT (p->last_point, 0);
275
  p->frozen_window_start_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
276 277

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
278 279 280 281
  return val;
}

DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
282 283
       doc: /* Return the window that the cursor now appears in and commands apply to.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
284 285 286 287
{
  return selected_window;
}

288
DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
289 290 291 292
       doc: /* Return the window used now for minibuffers.
If the optional argument FRAME is specified, return the minibuffer window
used by that frame.  */)
     (frame)
293
    Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
294
{
295
  if (NILP (frame))
296
    frame = selected_frame;
297
  CHECK_LIVE_FRAME (frame);
298
  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
Jim Blandy's avatar
Jim Blandy committed
299 300
}

301
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
302 303
       doc: /* Returns non-nil if WINDOW is a minibuffer window.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
304 305 306
     Lisp_Object window;
{
  struct window *w = decode_window (window);
307
  return MINI_WINDOW_P (w) ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
308 309 310
}


Jim Blandy's avatar
Jim Blandy committed
311
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
312 313 314 315 316 317 318
       Spos_visible_in_window_p, 0, 3, 0,
       doc: /* Return t if position POS is currently on the frame in WINDOW.
Return nil if that position is scrolled vertically out of view.
If a character is only partially visible, nil is returned, unless the
optional argument PARTIALLY is non-nil.
POS defaults to point in WINDOW; WINDOW defaults to the selected window.  */)
     (pos, window, partially)
319
     Lisp_Object pos, window, partially;
Jim Blandy's avatar
Jim Blandy committed
320 321 322 323
{
  register struct window *w;
  register int posint;
  register struct buffer *buf;
324 325
  struct text_pos top;
  Lisp_Object in_window;
326
  int fully_p;
Jim Blandy's avatar
Jim Blandy committed
327

Miles Bader's avatar
Miles Bader committed
328 329 330 331 332
  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
333
    {
334
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
335 336
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
337 338 339 340
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
341

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

  return in_window;
Jim Blandy's avatar
Jim Blandy committed
375
}
376

Jim Blandy's avatar
Jim Blandy committed
377 378 379 380 381

static struct window *
decode_window (window)
     register Lisp_Object window;
{
Jim Blandy's avatar
Jim Blandy committed
382
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
383 384
    return XWINDOW (selected_window);

385
  CHECK_LIVE_WINDOW (window);
Jim Blandy's avatar
Jim Blandy committed
386 387 388 389
  return XWINDOW (window);
}

DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
390 391
       doc: /* Return the buffer that WINDOW is displaying.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
392 393 394 395 396 397
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
398 399
       doc: /* Return the number of lines in WINDOW (including its mode line).  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
400 401 402 403 404 405
     Lisp_Object window;
{
  return decode_window (window)->height;
}

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
406 407 408 409 410
       doc: /* Return the number of display columns in WINDOW.
This is the width that is usable columns available for text in WINDOW.
If you want to find out how many columns WINDOW takes up,
use  (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))).  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
411 412
     Lisp_Object window;
{
413
  return make_number (window_internal_width (decode_window (window)));
Jim Blandy's avatar
Jim Blandy committed
414 415 416
}

DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
417 418
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
419 420 421 422 423 424
     Lisp_Object window;
{
  return decode_window (window)->hscroll;
}

DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
425 426 427
       doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
NCOL should be zero or positive.  */)
     (window, ncol)
428
     Lisp_Object window, ncol;
Jim Blandy's avatar
Jim Blandy committed
429
{
430 431
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
432

433
  CHECK_NUMBER (ncol);
434 435 436 437
  hscroll = max (0, XINT (ncol));
  
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
438
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
439
  
440
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
441 442 443
  return ncol;
}

444 445
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
446 447 448
       doc: /* Return WINDOW's redisplay end trigger value.
See `set-window-redisplay-end-trigger' for more information.  */)
     (window)
449 450 451 452 453 454 455
     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,
456 457 458 459 460 461 462
       doc: /* Set WINDOW's redisplay end trigger value to VALUE.
VALUE should be a buffer position (typically a marker) or nil.
If it is a buffer position, then if redisplay in WINDOW reaches a position
beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
with two arguments: WINDOW, and the end trigger value.
Afterwards the end-trigger value is reset to nil.  */)
     (window, value)
463 464 465 466 467 468 469 470 471
     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
472
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
473 474 475 476 477 478
       doc: /* Return a list of the edge coordinates of WINDOW.
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
RIGHT is one more than the rightmost column used by WINDOW,
and BOTTOM is one more than the bottommost row used by WINDOW
 and its mode-line.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
479 480 481 482 483
     Lisp_Object window;
{
  register struct window *w = decode_window (window);

  return Fcons (w->left, Fcons (w->top,
484
           Fcons (make_number (WINDOW_RIGHT_EDGE (w)),
Jim Blandy's avatar
Jim Blandy committed
485 486 487 488 489
		  Fcons (make_number (XFASTINT (w->top)
				      + XFASTINT (w->height)),
			 Qnil))));
}

490
/* Test if the character at column *X, row *Y is within window W.
Jim Blandy's avatar
Jim Blandy committed
491 492 493 494 495 496 497
   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,
498 499
      return 3.
   if it is on the window's top line, return 4;
Kim F. Storm's avatar
Kim F. Storm committed
500
   if it is in left or right fringe of the window,
501
   return 5 or 6, and convert *X and *Y to window-relative corrdinates.
502 503 504

   X and Y are frame relative pixel coordinates.  */

505
static enum window_part
Jim Blandy's avatar
Jim Blandy committed
506 507 508 509
coordinates_in_window (w, x, y)
     register struct window *w;
     register int *x, *y;
{
510 511
  /* Let's make this a global enum later, instead of using numbers
     everywhere.  */
512 513
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  int left_x, right_x, top_y, bottom_y;
514
  enum window_part part;
Pavel Janík's avatar
Pavel Janík committed
515
  int ux = CANON_X_UNIT (f);
516 517
  int x0 = XFASTINT (w->left) * ux;
  int x1 = x0 + XFASTINT (w->width) * ux;
518 519 520
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
521 522 523 524

  if (*x < x0 || *x >= x1)
    return ON_NOTHING;
  
525 526
  /* 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.  */
527 528 529
  if (w->pseudo_window_p)
    {
      left_x = 0;
530
      right_x = XFASTINT (w->width) * CANON_X_UNIT (f) - 1;
531 532 533 534 535
      top_y = WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w);
      bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
    }
  else
    {
536
      left_x = (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
537
		- FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
538
      right_x = WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X (w) - 1;
539
      top_y = (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
540
	       - FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
541 542
      bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
    }
543

544 545 546 547 548
  /* 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.  */
549

550
  if (WINDOW_WANTS_MODELINE_P (w)
551 552
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
      && *y < bottom_y)
553
    {
554 555 556 557 558 559 560 561
      /* We're somewhere on the mode line.  We consider the place
	 between mode lines of horizontally adjacent mode lines
	 as the vertical border.    If scroll bars on the left,
	 return the right window.  */
      part = ON_MODE_LINE;
      
      if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
	{
562
	  if (abs (*x - x0) < grabbable_width)
563 564
	    part = ON_VERTICAL_BORDER;
	}
565
      else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < grabbable_width)
566
	part = ON_VERTICAL_BORDER;
567
    }
568 569 570 571 572 573 574 575
  else if (WINDOW_WANTS_HEADER_LINE_P (w)
	   && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
	   && *y >= top_y)
    {
      part = ON_HEADER_LINE;
      
      if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
	{
576
	  if (abs (*x - x0) < grabbable_width)
577 578
	    part = ON_VERTICAL_BORDER;
	}
579
      else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < grabbable_width)
580 581 582 583 584 585
	part = ON_VERTICAL_BORDER;
    }
  /* Outside anything interesting?  */
  else if (*y < top_y
	   || *y >= bottom_y
	   || *x < (left_x
586
		    - FRAME_LEFT_FRINGE_WIDTH (f)
587
		    - FRAME_LEFT_SCROLL_BAR_WIDTH (f) * ux)
588
	   || *x > (right_x
589
		    + FRAME_RIGHT_FRINGE_WIDTH (f)
590
		    + FRAME_RIGHT_SCROLL_BAR_WIDTH (f) * ux))
591
    {
592
      part = ON_NOTHING;
593
    }
594
  else if (FRAME_WINDOW_P (f))
595
    {
596 597 598
      if (!w->pseudo_window_p
	  && !FRAME_HAS_VERTICAL_SCROLL_BARS (f)
	  && !WINDOW_RIGHTMOST_P (w)
599
	  && (abs (*x - right_x - FRAME_RIGHT_FRINGE_WIDTH (f)) < grabbable_width))
600 601 602 603
	{
	  part = ON_VERTICAL_BORDER;
	}
      else if (*x < left_x || *x > right_x)
604
	{
Kim F. Storm's avatar
Kim F. Storm committed
605
	  /* Other lines than the mode line don't include fringes and
606
	     scroll bars on the left.  */
607
      
608 609 610
	  /* Convert X and Y to window-relative pixel coordinates.  */
	  *x -= left_x;
	  *y -= top_y;
611 612 613 614 615 616 617
	  part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
	}
      else
	{
	  *x -= left_x;
	  *y -= top_y;
	  part = ON_TEXT;
618
	}
619
    }
620 621 622 623 624 625
  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)
	{
Kim F. Storm's avatar
Kim F. Storm committed
626
	  /* Other lines than the mode line don't include fringes and
627 628 629 630 631
	     scroll bars on the left.  */
      
	  /* Convert X and Y to window-relative pixel coordinates.  */
	  *x -= left_x;
	  *y -= top_y;
632
	  part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
633 634
	}
      /* Here, too, "*x > right_x" is because of character terminals.  */
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
      else if (!w->pseudo_window_p
	       && !WINDOW_RIGHTMOST_P (w)
	       && *x > right_x - ux)
	{
	  /* On the border on the right side of the window?  Assume that
	     this area begins at RIGHT_X minus a canonical char width.  */
	  part = ON_VERTICAL_BORDER;
	}
      else
	{
	  /* Convert X and Y to window-relative pixel coordinates.  */
	  *x -= left_x;
	  *y -= top_y;
	  part = ON_TEXT;
	}
650
    }
651 652

  return part;
Jim Blandy's avatar
Jim Blandy committed
653 654
}

655

Jim Blandy's avatar
Jim Blandy committed
656
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
657 658 659 660 661 662 663 664 665 666
       Scoordinates_in_window_p, 2, 2, 0,
       doc: /* Return non-nil if COORDINATES are in WINDOW.
COORDINATES is a cons of the form (X . Y), X and Y being distances
measured in characters from the upper-left corner of the frame.
\(0 .  0) denotes the character in the upper left corner of the
frame.
If COORDINATES are in the text portion of WINDOW,
   the coordinates relative to the window are returned.
If they are in the mode line of WINDOW, `mode-line' is returned.
If they are in the top mode line of WINDOW, `header-line' is returned.
Kim F. Storm's avatar
Kim F. Storm committed
667 668
If they are in the left fringe of WINDOW, `left-fringe' is returned.
If they are in the right fringe of WINDOW, `right-fringe' is returned.
669 670 671
If they are on the border between WINDOW and its right sibling,
  `vertical-line' is returned.  */)
     (coordinates, window)
Jim Blandy's avatar
Jim Blandy committed
672 673
     register Lisp_Object coordinates, window;
{
674 675
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
676
  int x, y;
677
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
678

679
  CHECK_LIVE_WINDOW (window);
680 681
  w = XWINDOW (window);
  f = XFRAME (w->frame);
682
  CHECK_CONS (coordinates);
683 684
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
685 686
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
687 688 689 690
  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
691
    {
692
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
693 694
      return Qnil;

695 696 697
    case ON_TEXT:
      /* X and Y are now window relative pixel coordinates.  Convert
	 them to canonical char units before returning them.  */
698 699
      return Fcons (CANON_X_FROM_PIXEL_X (f, x), 
		    CANON_Y_FROM_PIXEL_Y (f, y));
Jim Blandy's avatar
Jim Blandy committed
700

701
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
702
      return Qmode_line;
703

704
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
705
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
706

707
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
708
      return Qheader_line;
709

710 711
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
712
      
713 714
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
715

Jim Blandy's avatar
Jim Blandy committed
716 717 718 719 720
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
721 722

/* Callback for foreach_window, used in window_from_coordinates.
723 724 725 726 727
   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
728
   *CW->part the part of the window under coordinates *X,*Y.  Return
729 730 731 732 733 734 735
   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
736 737

static int
738
check_window_containing (w, user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
739
     struct window *w;
740
     void *user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
741
{
742
  struct check_window_data *cw = (struct check_window_data *) user_data;
743 744
  enum window_part found;
  int continue_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
745

746
  found = coordinates_in_window (w, cw->x, cw->y);
747
  if (found != ON_NOTHING)
Gerd Moellmann's avatar
Gerd Moellmann committed
748
    {
749 750
      *cw->part = found - 1;
      XSETWINDOW (*cw->window, w);
751
      continue_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
752 753
    }
  
754
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
755 756 757
}


758 759 760 761 762
/* 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
763 764 765 766 767 768 769 770 771 772
   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.  */
773

Jim Blandy's avatar
Jim Blandy committed
774
Lisp_Object
Gerd Moellmann's avatar
Gerd Moellmann committed
775 776
window_from_coordinates (f, x, y, part, tool_bar_p)
     struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
777
     int x, y;
Jim Blandy's avatar
Jim Blandy committed
778
     int *part;
779
     int tool_bar_p;
Jim Blandy's avatar
Jim Blandy committed
780
{
Gerd Moellmann's avatar
Gerd Moellmann committed
781
  Lisp_Object window;
782
  struct check_window_data cw;
783

Gerd Moellmann's avatar
Gerd Moellmann committed
784
  window = Qnil;
785 786
  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
787 788 789 790 791 792 793
  
  /* 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
794 795
      && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
	  != ON_NOTHING))
796 797
    {
      *part = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
798
      window = f->tool_bar_window;
799
    }
800

Gerd Moellmann's avatar
Gerd Moellmann committed
801
  return window;
Jim Blandy's avatar
Jim Blandy committed
802 803
}

804
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
805 806 807 808 809 810
       doc: /* Return window containing coordinates X and Y on FRAME.
If omitted, FRAME defaults to the currently selected frame.
The top left corner of the frame is considered to be row 0,
column 0.  */)
     (x, y, frame)
     Lisp_Object x, y, frame;
Jim Blandy's avatar
Jim Blandy committed
811 812
{
  int part;
813
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
814

Jim Blandy's avatar
Jim Blandy committed
815
  if (NILP (frame))
816
    frame = selected_frame;
817
  CHECK_LIVE_FRAME (frame);
818
  f = XFRAME (frame);
Jim Blandy's avatar
Jim Blandy committed
819

820
  /* Check that arguments are integers or floats.  */
821 822
  CHECK_NUMBER_OR_FLOAT (x);
  CHECK_NUMBER_OR_FLOAT (y);
823 824 825 826 827

  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
828 829 830
}

DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
831 832 833 834 835 836 837 838 839 840
       doc: /* Return current value of point in WINDOW.
For a nonselected window, this is the value point would have
if that window were selected.

Note that, when WINDOW is the selected window and its buffer
is also currently selected, the value returned is the same as (point).
It would be more strictly correct to return the `top-level' value
of point, outside of any save-excursion forms.
But that is hard to define.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
841 842 843 844 845 846 847 848 849 850 851
     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,
852 853 854
       doc: /* Return position at which display currently starts in WINDOW.
This is updated by redisplay or by calling `set-window-start'.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
855 856 857 858 859
     Lisp_Object window;
{
  return Fmarker_position (decode_window (window)->start);
}

860 861
/* This is text temporarily removed from the doc string below.

862 863 864 865 866 867 868
This function returns nil if the position is not currently known.
That happens when redisplay is preempted and doesn't finish.
If in that case you want to compute where the end of the window would
have been if redisplay had finished, do this:
    (save-excursion
      (goto-char (window-start window))
      (vertical-motion (1- (window-height window)) window)
869 870
      (point))")  */

871
DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
872 873 874 875 876 877 878
       doc: /* Return position at which display currently ends in WINDOW.
This is updated by redisplay, when it runs to completion.
Simply changing the buffer text or setting `window-start'
does not update this value.
If UPDATE is non-nil, compute the up-to-date position
if it isn't already recorded.  */)
     (window, update)
879
     Lisp_Object window, update;
Jim Blandy's avatar
Jim Blandy committed
880 881 882
{
  Lisp_Object value;
  struct window *w = decode_window (window);
883 884 885
  Lisp_Object buf;

  buf = w->buffer;
886
  CHECK_BUFFER (buf);
887

888
#if 0 /* This change broke some things.  We should make it later.  */
889 890 891 892 893 894
  /* 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;
895
#endif
896

897 898 899 900
  if (! NILP (update)
      && ! (! NILP (w->window_end_valid)
	    && XFASTINT (w->last_modified) >= MODIFF))
    {
901 902
      struct text_pos startp;
      struct it it;
903
      struct buffer *old_buffer = NULL, *b = XBUFFER (buf);
904 905 906 907 908

      /* 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
909
         rmail had already narrowed the buffer.  */
910
      if (XMARKER (w->start)->charpos < BEGV)
911
	SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
912
      else if (XMARKER (w->start)->charpos > ZV)
913
	SET_TEXT_POS (startp, ZV, ZV_BYTE);
914
      else
915 916 917 918
	SET_TEXT_POS_FROM_MARKER (startp, w->start);

      /* Cannot use Fvertical_motion because that function doesn't
	 cope with variable-height lines.  */
919 920 921 922 923 924
      if (b != current_buffer)
	{
	  old_buffer = current_buffer;
	  set_buffer_internal (b);
	}
      
925 926
      start_display (&it, w, startp);
      move_it_vertically (&it, window_box_height (w));
927 928
      if (it.current_y < it.last_visible_y)
	move_it_past_eol (&it);
929
      value = make_number (IT_CHARPOS (it));
930 931 932
      
      if (old_buffer)
	set_buffer_internal (old_buffer);
933 934
    }
  else
935
    XSETINT (value, BUF_Z (XBUFFER (buf)) - XFASTINT (w->window_end_pos));
Jim Blandy's avatar
Jim Blandy committed
936 937 938 939 940

  return value;
}

DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
941 942
       doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.  */)
     (window, pos)
Jim Blandy's avatar
Jim Blandy committed
943 944 945 946
     Lisp_Object window, pos;
{
  register struct window *w = decode_window (window);

947
  CHECK_NUMBER_COERCE_MARKER (pos);
948 949
  if (w == XWINDOW (selected_window)
      && XBUFFER (w->buffer) == current_buffer)
Jim Blandy's avatar
Jim Blandy committed
950 951 952
    Fgoto_char (pos);
  else
    set_marker_restricted (w->pointm, pos, w->buffer);
953

954 955 956
  /* We have to make sure that redisplay updates the window to show
     the new value of point.  */
  if (!EQ (window, selected_window))
957
    ++windows_or_buffers_changed;
958
  
Jim Blandy's avatar
Jim Blandy committed
959 960 961 962
  return pos;
}

DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
963 964 965 966
       doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
Optional third arg NOFORCE non-nil inhibits next redisplay
from overriding motion of point in order to display at this exact start.  */)
     (window, pos, noforce)
Jim Blandy's avatar
Jim Blandy committed
967 968 969 970
     Lisp_Object window, pos, noforce;
{
  register struct window *w = decode_window (window);

971
  CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
972 973 974
  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
975
  if (NILP (noforce))
Jim Blandy's avatar
Jim Blandy committed
976 977
    w->force_start = Qt;
  w->update_mode_line = Qt;
978
  XSETFASTINT (w->last_modified, 0);
979
  XSETFASTINT (w->last_overlay_modified, 0);
Jim Blandy's avatar
Jim Blandy committed
980 981
  if (!EQ (window, selected_window))
    windows_or_buffers_changed++;
982

Jim Blandy's avatar
Jim Blandy committed
983 984 985 986 987
  return pos;
}

DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
       1, 1, 0,
988 989 990
       doc: /* Return WINDOW's dedicated object, usually t or nil.
See also `set-window-dedicated-p'.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
991 992 993 994 995
     Lisp_Object window;
{
  return decode_window (window)->dedicated;
}

996 997
DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
       Sset_window_dedicated_p, 2, 2, 0,
998 999 1000 1001 1002 1003 1004
       doc: /* Control whether WINDOW is dedicated to the buffer it displays.
If it is dedicated, Emacs will not automatically change
which buffer appears in it.
The second argument is the new value for the dedication flag;
non-nil means yes. */)
     (window, arg)
     Lisp_Object window, arg;
Jim Blandy's avatar
Jim Blandy committed
1005 1006 1007
{
  register struct window *w = decode_window (window);

Jim Blandy's avatar
Jim Blandy committed
1008
  if (NILP (arg))
Jim Blandy's avatar
Jim Blandy committed
1009 1010
    w->dedicated = Qnil;
  else
1011
    w->dedicated = Qt;
Jim Blandy's avatar
Jim Blandy committed
1012 1013 1014 1015 1016 1017

  return w->dedicated;
}

DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
       0, 1, 0,
1018 1019
       doc: /* Return the display-table that WINDOW is using.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
1020 1021 1022 1023 1024
     Lisp_Object window;
{
  return decode_window (window)->display_table;
}

1025 1026 1027 1028
/* 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
1029

1030
struct Lisp_Char_Table *
Jim Blandy's avatar
Jim Blandy committed
1031 1032 1033
window_display_table (w)
     struct window *w;
{
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
  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);
    }
1047