window.c 175 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"
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 56 57 58 59 60 61 62 63 64 65 66
/* 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
};

67

68
Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
69
Lisp_Object Qwindow_size_fixed, Qleft_fringe, Qright_fringe;
Gerd Moellmann's avatar
Gerd Moellmann committed
70
extern Lisp_Object Qheight, Qwidth;
Jim Blandy's avatar
Jim Blandy committed
71

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

98 99 100 101
/* The value of `window-size-fixed'.  */

int window_size_fixed;

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

Lisp_Object selected_window;

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

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

Jim Blandy's avatar
Jim Blandy committed
123 124 125
Lisp_Object minibuf_window;

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

Jim Blandy's avatar
Jim Blandy committed
128 129 130
Lisp_Object Vminibuf_scroll_window;

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

Jim Blandy's avatar
Jim Blandy committed
132 133 134
Lisp_Object Vother_window_scroll_buffer;

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

Jim Blandy's avatar
Jim Blandy committed
136 137 138
Lisp_Object Vtemp_buffer_show_function;

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

Jim Blandy's avatar
Jim Blandy committed
140 141 142 143
int window_min_height;
int window_min_width;

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

Jim Blandy's avatar
Jim Blandy committed
145 146
int pop_up_windows;

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

Jim Blandy's avatar
Jim Blandy committed
149
int pop_up_frames;
Jim Blandy's avatar
Jim Blandy committed
150

151 152 153 154
/* Nonzero means reuse existing frames for displaying buffers.  */

int display_buffer_reuse_frames;

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

Jim Blandy's avatar
Jim Blandy committed
157
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
158 159

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

Jim Blandy's avatar
Jim Blandy committed
161 162
Lisp_Object Vdisplay_buffer_function;

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

Lisp_Object Veven_window_heights;

167
/* List of buffer *names* for buffers that should have their own frames.  */
168

169 170 171
Lisp_Object Vspecial_display_buffer_names;

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

173 174 175
Lisp_Object Vspecial_display_regexps;

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

177 178
Lisp_Object Vspecial_display_function;

179
/* List of buffer *names* for buffers to appear in selected window.  */
180

181 182 183
Lisp_Object Vsame_window_buffer_names;

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

185 186
Lisp_Object Vsame_window_regexps;

187
/* Hook run at end of temp_output_buffer_show.  */
188

189 190
Lisp_Object Qtemp_buffer_show_hook;

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

Jim Blandy's avatar
Jim Blandy committed
194 195 196
int split_height_threshold;

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

Jim Blandy's avatar
Jim Blandy committed
198 199 200
int next_screen_context_lines;

/* Incremented for each window created.  */
201

Jim Blandy's avatar
Jim Blandy committed
202 203
static int sequence_number;

204
/* Nonzero after init_window_once has finished.  */
205

206 207
static int window_initialized;

208
/* Hook to run when window config changes.  */
209

210 211 212
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

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

216 217 218
Lisp_Object Vscroll_preserve_screen_position;

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

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

225 226
extern int scroll_margin;

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

237
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
238 239 240
  "Returns t if OBJECT is a window which is currently visible.")
     (object)
     Lisp_Object object;
241
{
242
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
243 244
}

Jim Blandy's avatar
Jim Blandy committed
245 246 247
Lisp_Object
make_window ()
{
248
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
249
  register struct window *p;
250 251 252 253 254 255 256
  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);
257
  p = (struct window *) vec;
258 259 260 261 262 263
  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);
264
  XSETFASTINT (p->min_hscroll, 0);
265
  p->orig_top = p->orig_height = Qnil;
Jim Blandy's avatar
Jim Blandy committed
266 267
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
268
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
269
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
270 271
  p->display_table = Qnil;
  p->dedicated = Qnil;
272 273 274 275 276 277 278 279 280 281 282
  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;
283
  XSETWINDOW (val, p);
284
  XSETFASTINT (p->last_point, 0);
285
  p->frozen_window_start_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
286 287

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
288 289 290 291 292 293 294 295 296 297
  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;
}

298 299 300 301 302 303
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
304
{
305
  if (NILP (frame))
306 307
    frame = selected_frame;
  CHECK_LIVE_FRAME (frame, 0);
308
  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
Jim Blandy's avatar
Jim Blandy committed
309 310
}

311
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
312 313 314 315 316
  "Returns non-nil if WINDOW is a minibuffer window.")
  (window)
     Lisp_Object window;
{
  struct window *w = decode_window (window);
317
  return MINI_WINDOW_P (w) ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
318 319 320
}


Jim Blandy's avatar
Jim Blandy committed
321
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
Miles Bader's avatar
Miles Bader committed
322
  Spos_visible_in_window_p, 0, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
323
  "Return t if position POS is currently on the frame in WINDOW.\n\
324
Return nil if that position is scrolled vertically out of view.\n\
325 326
If a character is only partially visible, nil is returned, unless the\n\
optional argument PARTIALLY is non-nil.\n\
Miles Bader's avatar
Miles Bader committed
327
POS defaults to point in WINDOW; WINDOW defaults to the selected window.")
328 329
  (pos, window, partially)
     Lisp_Object pos, window, partially;
Jim Blandy's avatar
Jim Blandy committed
330 331 332 333
{
  register struct window *w;
  register int posint;
  register struct buffer *buf;
334 335
  struct text_pos top;
  Lisp_Object in_window;
336
  int fully_p;
Jim Blandy's avatar
Jim Blandy committed
337

Miles Bader's avatar
Miles Bader committed
338 339 340 341 342
  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
343 344 345 346
    {
      CHECK_NUMBER_COERCE_MARKER (pos, 0);
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
347 348 349 350
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
351

352
  /* If position is above window start, it's not visible.  */
353
  if (posint < CHARPOS (top))
354 355
    in_window = Qnil;
  else if (XFASTINT (w->last_modified) >= BUF_MODIFF (buf)
Miles Bader's avatar
Miles Bader committed
356 357 358
	   && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (buf)
	   && posint < BUF_Z (buf) - XFASTINT (w->window_end_pos))
    {
359 360 361 362
      /* 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.  */
363
      if (NILP (partially))
364
	{
365
	  pos_visible_p (w, posint, &fully_p, NILP (partially));
366 367
	  in_window = fully_p ? Qt : Qnil;
	}
Miles Bader's avatar
Miles Bader committed
368
      else
369
	in_window = Qt;
Miles Bader's avatar
Miles Bader committed
370
    }
371 372 373 374 375
  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
376 377
  else
    {
378 379
      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
380 381
      else
	in_window = Qnil;
Jim Blandy's avatar
Jim Blandy committed
382
    }
383 384

  return in_window;
Jim Blandy's avatar
Jim Blandy committed
385
}
386

Jim Blandy's avatar
Jim Blandy committed
387 388 389 390 391

static struct window *
decode_window (window)
     register Lisp_Object window;
{
Jim Blandy's avatar
Jim Blandy committed
392
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
393 394
    return XWINDOW (selected_window);

395
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
  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,
416 417 418 419
  "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
420 421 422
  (window)
     Lisp_Object window;
{
423
  return make_number (window_internal_width (decode_window (window)));
Jim Blandy's avatar
Jim Blandy committed
424 425 426 427 428 429 430 431 432 433 434 435 436 437
}

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)
438
     Lisp_Object window, ncol;
Jim Blandy's avatar
Jim Blandy committed
439
{
440 441
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
442 443

  CHECK_NUMBER (ncol, 1);
444 445 446 447
  hscroll = max (0, XINT (ncol));
  
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
448
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
449
  
450
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
451 452 453
  return ncol;
}

454 455 456 457 458 459 460 461 462 463 464 465 466 467
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\
468 469 470 471
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.")
472 473 474 475 476 477 478 479 480 481
  (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
482 483
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
484
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.\n\
Jim Blandy's avatar
Jim Blandy committed
485 486 487 488 489 490 491 492 493
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,
494
           Fcons (make_number (WINDOW_RIGHT_EDGE (w)),
Jim Blandy's avatar
Jim Blandy committed
495 496 497 498 499
		  Fcons (make_number (XFASTINT (w->top)
				      + XFASTINT (w->height)),
			 Qnil))));
}

500
/* Test if the character at column *X, row *Y is within window W.
Jim Blandy's avatar
Jim Blandy committed
501 502 503 504 505 506 507
   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,
508 509
      return 3.
   if it is on the window's top line, return 4;
510 511
   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.
512 513 514

   X and Y are frame relative pixel coordinates.  */

515
static enum window_part
Jim Blandy's avatar
Jim Blandy committed
516 517 518 519
coordinates_in_window (w, x, y)
     register struct window *w;
     register int *x, *y;
{
520 521
  /* Let's make this a global enum later, instead of using numbers
     everywhere.  */
522 523 524
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  int left_x, right_x, top_y, bottom_y;
  int flags_area_width = FRAME_LEFT_FLAGS_AREA_WIDTH (f);
525
  enum window_part part;
526 527 528
  int ux = CANON_X_UNIT (f), uy = CANON_Y_UNIT (f);
  int x0 = XFASTINT (w->left) * ux;
  int x1 = x0 + XFASTINT (w->width) * ux;
529 530 531
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
532 533 534 535

  if (*x < x0 || *x >= x1)
    return ON_NOTHING;
  
536 537
  /* 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.  */
538 539 540
  if (w->pseudo_window_p)
    {
      left_x = 0;
541
      right_x = XFASTINT (w->width) * CANON_X_UNIT (f) - 1;
542 543 544 545 546
      top_y = WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w);
      bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
    }
  else
    {
547
      left_x = (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
548
		- FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
549
      right_x = WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X (w) - 1;
550
      top_y = (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
551
	       - FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
552 553
      bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
    }
554

555 556 557 558 559
  /* 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.  */
560

561
  if (WINDOW_WANTS_MODELINE_P (w)
562 563
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
      && *y < bottom_y)
564
    {
565 566 567 568 569 570 571 572
      /* 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))
	{
573
	  if (abs (*x - x0) < grabbable_width)
574 575
	    part = ON_VERTICAL_BORDER;
	}
576
      else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < grabbable_width)
577
	part = ON_VERTICAL_BORDER;
578
    }
579 580 581 582 583 584 585 586
  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))
	{
587
	  if (abs (*x - x0) < grabbable_width)
588 589
	    part = ON_VERTICAL_BORDER;
	}
590
      else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < grabbable_width)
591 592 593 594 595 596 597 598
	part = ON_VERTICAL_BORDER;
    }
  /* Outside anything interesting?  */
  else if (*y < top_y
	   || *y >= bottom_y
	   || *x < (left_x
		    - flags_area_width
		    - FRAME_LEFT_SCROLL_BAR_WIDTH (f) * ux)
599 600 601
	   || *x > (right_x
		    + flags_area_width
		    + FRAME_RIGHT_SCROLL_BAR_WIDTH (f) * ux))
602
    {
603
      part = ON_NOTHING;
604
    }
605
  else if (FRAME_WINDOW_P (f))
606
    {
607 608 609
      if (!w->pseudo_window_p
	  && !FRAME_HAS_VERTICAL_SCROLL_BARS (f)
	  && !WINDOW_RIGHTMOST_P (w)
610
	  && (abs (*x - right_x - flags_area_width) < grabbable_width))
611 612 613 614
	{
	  part = ON_VERTICAL_BORDER;
	}
      else if (*x < left_x || *x > right_x)
615 616 617
	{
	  /* Other lines than the mode line don't include flags areas and
	     scroll bars on the left.  */
618
      
619 620 621
	  /* Convert X and Y to window-relative pixel coordinates.  */
	  *x -= left_x;
	  *y -= top_y;
622 623 624 625 626 627 628
	  part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
	}
      else
	{
	  *x -= left_x;
	  *y -= top_y;
	  part = ON_TEXT;
629
	}
630
    }
631 632 633 634 635 636 637 638 639 640 641 642
  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;
643
	  part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
644 645
	}
      /* Here, too, "*x > right_x" is because of character terminals.  */
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
      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;
	}
661
    }
662 663

  return part;
Jim Blandy's avatar
Jim Blandy committed
664 665
}

666

Jim Blandy's avatar
Jim Blandy committed
667 668 669
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
670
COORDINATES is a cons of the form (X . Y), X and Y being distances\n\
Jim Blandy's avatar
Jim Blandy committed
671
measured in characters from the upper-left corner of the frame.\n\
672
\(0 .  0) denotes the character in the upper left corner of the\n\
Jim Blandy's avatar
Jim Blandy committed
673
frame.\n\
Jim Blandy's avatar
Jim Blandy committed
674 675
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
676
If they are in the mode line of WINDOW, `mode-line' is returned.\n\
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
677
If they are in the top mode line of WINDOW, `header-line' is returned.\n\
678 679 680
If they are in the fringe to the left of the window,\n\
   `left-fringe' is returned, if they are in the area on the right of\n\
   the window, `right-fringe' is returned.\n\
Jim Blandy's avatar
Jim Blandy committed
681
If they are on the border between WINDOW and its right sibling,\n\
Jim Blandy's avatar
Jim Blandy committed
682
   `vertical-line' is returned.")
Jim Blandy's avatar
Jim Blandy committed
683 684 685
  (coordinates, window)
     register Lisp_Object coordinates, window;
{
686 687
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
688
  int x, y;
689
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
690

691
  CHECK_LIVE_WINDOW (window, 0);
692 693
  w = XWINDOW (window);
  f = XFRAME (w->frame);
Jim Blandy's avatar
Jim Blandy committed
694
  CHECK_CONS (coordinates, 1);
695 696 697 698 699 700 701 702
  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
703
    {
704
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
705 706
      return Qnil;

707 708 709
    case ON_TEXT:
      /* X and Y are now window relative pixel coordinates.  Convert
	 them to canonical char units before returning them.  */
710 711
      return Fcons (CANON_X_FROM_PIXEL_X (f, x), 
		    CANON_Y_FROM_PIXEL_Y (f, y));
Jim Blandy's avatar
Jim Blandy committed
712

713
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
714
      return Qmode_line;
715

716
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
717
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
718

719
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
720
      return Qheader_line;
721

722 723
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
724
      
725 726
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
727

Jim Blandy's avatar
Jim Blandy committed
728 729 730 731 732
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
733 734

/* Callback for foreach_window, used in window_from_coordinates.
735 736 737 738 739
   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
740
   *CW->part the part of the window under coordinates *X,*Y.  Return
741 742 743 744 745 746 747
   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
748 749

static int
750
check_window_containing (w, user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
751
     struct window *w;
752
     void *user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
753
{
754
  struct check_window_data *cw = (struct check_window_data *) user_data;
755 756
  enum window_part found;
  int continue_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
757

758
  found = coordinates_in_window (w, cw->x, cw->y);
759
  if (found != ON_NOTHING)
Gerd Moellmann's avatar
Gerd Moellmann committed
760
    {
761 762
      *cw->part = found - 1;
      XSETWINDOW (*cw->window, w);
763
      continue_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
764 765
    }
  
766
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
767 768 769
}


770 771 772 773 774
/* 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
775 776 777 778 779 780 781 782 783 784
   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.  */
785

Jim Blandy's avatar
Jim Blandy committed
786
Lisp_Object
Gerd Moellmann's avatar
Gerd Moellmann committed
787 788
window_from_coordinates (f, x, y, part, tool_bar_p)
     struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
789
     int x, y;
Jim Blandy's avatar
Jim Blandy committed
790
     int *part;
791
     int tool_bar_p;
Jim Blandy's avatar
Jim Blandy committed
792
{
Gerd Moellmann's avatar
Gerd Moellmann committed
793
  Lisp_Object window;
794
  struct check_window_data cw;
795

Gerd Moellmann's avatar
Gerd Moellmann committed
796
  window = Qnil;
797 798
  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
799 800 801 802 803 804 805
  
  /* 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
806 807
      && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
	  != ON_NOTHING))
808 809
    {
      *part = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
810
      window = f->tool_bar_window;
811
    }
812

Gerd Moellmann's avatar
Gerd Moellmann committed
813
  return window;
Jim Blandy's avatar
Jim Blandy committed
814 815
}

816
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
817
  "Return window containing coordinates X and Y on FRAME.\n\
Jim Blandy's avatar
Jim Blandy committed
818 819
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
820
column 0.")
Richard M. Stallman's avatar
Richard M. Stallman committed
821 822
  (x, y, frame)
      Lisp_Object x, y, frame;
Jim Blandy's avatar
Jim Blandy committed
823 824
{
  int part;
825
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
826

Jim Blandy's avatar
Jim Blandy committed
827
  if (NILP (frame))
828 829
    frame = selected_frame;
  CHECK_LIVE_FRAME (frame, 2);
830
  f = XFRAME (frame);
Jim Blandy's avatar
Jim Blandy committed
831

832 833 834 835 836 837 838 839
  /* 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
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
}

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,
864 865
  "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
866 867 868 869 870 871
  (window)
     Lisp_Object window;
{
  return Fmarker_position (decode_window (window)->start);
}

872 873
/* This is text temporarily removed from the doc string below.

874 875 876 877 878 879 880
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\
881 882
      (point))")  */

883
DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
884 885 886
  "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\
887
does not update this value.\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
888
If UPDATE is non-nil, compute the up-to-date position\n\
889 890 891
if it isn't already recorded.")
  (window, update)
     Lisp_Object window, update;
Jim Blandy's avatar
Jim Blandy committed
892 893 894
{
  Lisp_Object value;
  struct window *w = decode_window (window);
895 896 897 898 899
  Lisp_Object buf;

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

900
#if 0 /* This change broke some things.  We should make it later.  */
901 902 903 904 905 906
  /* 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;
907
#endif
908

909 910 911 912
  if (! NILP (update)
      && ! (! NILP (w->window_end_valid)
	    && XFASTINT (w->last_modified) >= MODIFF))
    {
913 914
      struct text_pos startp;
      struct it it;
915 916 917 918 919

      /* 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
920
         rmail had already narrowed the buffer.  */
921
      if (XMARKER (w->start)->charpos < BEGV)
922
	SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
923
      else if (XMARKER (w->start)->charpos > ZV)
924
	SET_TEXT_POS (startp, ZV, ZV_BYTE);
925
      else
926 927 928 929 930 931
	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));
932
      move_it_past_eol (&it);
933
      value = make_number (IT_CHARPOS (it));
934 935
    }
  else
936
    XSETINT (value, BUF_Z (XBUFFER (buf)) - XFASTINT (w->window_end_pos));
Jim Blandy's avatar
Jim Blandy committed
937 938 939 940 941 942 943 944 945 946 947 948

  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);
949 950
  if (w == XWINDOW (selected_window)
      && XBUFFER (w->buffer) == current_buffer)
Jim Blandy's avatar
Jim Blandy committed
951 952 953
    Fgoto_char (pos);
  else
    set_marker_restricted (w->pointm, pos, w->buffer);
954

955 956 957
  /* We have to make sure that redisplay updates the window to show
     the new value of point.  */
  if (!EQ (window, selected_window))
958
    ++windows_or_buffers_changed;
959
  
Jim Blandy's avatar
Jim Blandy committed
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
  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
976
  if (NILP (noforce))
Jim Blandy's avatar
Jim Blandy committed
977 978
    w->force_start = Qt;
  w->update_mode_line = Qt;
979
  XSETFASTINT (w->last_modified, 0);
980
  XSETFASTINT (w->last_overlay_modified, 0);
Jim Blandy's avatar
Jim Blandy committed
981 982
  if (!EQ (window, selected_window))
    windows_or_buffers_changed++;
983

Jim Blandy's avatar
Jim Blandy committed
984 985 986 987 988 989
  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\
990
See also `set-window-dedicated-p'.")
Jim Blandy's avatar
Jim Blandy committed
991 992 993 994 995 996
  (window)
     Lisp_Object window;
{
  return decode_window (window)->dedicated;
}

997 998 999 1000 1001 1002 <