window.c 184 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, 2002, 2003
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
#ifdef MAC_OS
48 49
#include "macterm.h"
#endif
50 51


52
Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
53
Lisp_Object Qwindow_size_fixed;
54
extern Lisp_Object Qleft_margin, Qright_margin;
Jim Blandy's avatar
Jim Blandy committed
55

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

82 83 84 85
/* The value of `window-size-fixed'.  */

int window_size_fixed;

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

Lisp_Object selected_window;

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

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

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

109 110 111
/* Non-nil means it is the window whose mode line should be
   shown as the selected window when the minibuffer is selected.  */

112
Lisp_Object minibuf_selected_window;
113

Jim Blandy's avatar
Jim Blandy committed
114
/* Non-nil means it is the window for C-M-v to scroll
115 116
   when the mini-buffer is selected.  */

Jim Blandy's avatar
Jim Blandy committed
117 118 119
Lisp_Object Vminibuf_scroll_window;

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

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

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

Jim Blandy's avatar
Jim Blandy committed
125 126
Lisp_Object Vtemp_buffer_show_function;

127 128 129 130
/* Non-zero means to use mode-line-inactive face in all windows but the
   selected-window and the minibuffer-scroll-window when the
   minibuffer is active.  */
int mode_line_in_non_selected_windows;
131

Jim Blandy's avatar
Jim Blandy committed
132
/* If a window gets smaller than either of these, it is removed. */
133

134 135
EMACS_INT window_min_height;
EMACS_INT window_min_width;
Jim Blandy's avatar
Jim Blandy committed
136 137

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

Jim Blandy's avatar
Jim Blandy committed
139 140
int pop_up_windows;

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

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

145 146 147 148
/* Nonzero means reuse existing frames for displaying buffers.  */

int display_buffer_reuse_frames;

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

Jim Blandy's avatar
Jim Blandy committed
151
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
152 153

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

Jim Blandy's avatar
Jim Blandy committed
155 156
Lisp_Object Vdisplay_buffer_function;

157 158 159 160
/* Non-nil means that Fdisplay_buffer should even the heights of windows.  */

Lisp_Object Veven_window_heights;

161
/* List of buffer *names* for buffers that should have their own frames.  */
162

163 164 165
Lisp_Object Vspecial_display_buffer_names;

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

167 168 169
Lisp_Object Vspecial_display_regexps;

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

171 172
Lisp_Object Vspecial_display_function;

173
/* List of buffer *names* for buffers to appear in selected window.  */
174

175 176 177
Lisp_Object Vsame_window_buffer_names;

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

179 180
Lisp_Object Vsame_window_regexps;

181
/* Hook run at end of temp_output_buffer_show.  */
182

183 184
Lisp_Object Qtemp_buffer_show_hook;

185
/* Fdisplay_buffer always splits the largest window
Jim Blandy's avatar
Jim Blandy committed
186
   if that window is more than this high.  */
187

188
EMACS_INT split_height_threshold;
Jim Blandy's avatar
Jim Blandy committed
189 190

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

192
EMACS_INT next_screen_context_lines;
Jim Blandy's avatar
Jim Blandy committed
193 194

/* Incremented for each window created.  */
195

Jim Blandy's avatar
Jim Blandy committed
196 197
static int sequence_number;

198
/* Nonzero after init_window_once has finished.  */
199

200 201
static int window_initialized;

202
/* Hook to run when window config changes.  */
203

204 205 206
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

207 208 209
/* Nonzero means scroll commands try to put point
   at the same screen height as previously.  */

210 211 212
Lisp_Object Vscroll_preserve_screen_position;

#if 0 /* This isn't used anywhere.  */
213
/* Nonzero means we can split a frame even if it is "unsplittable".  */
214
static int inhibit_frame_unsplittable;
215
#endif /* 0 */
216

217
extern EMACS_INT scroll_margin;
218

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

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

Jim Blandy's avatar
Jim Blandy committed
237 238 239
Lisp_Object
make_window ()
{
240
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
241
  register struct window *p;
242

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

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

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

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

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


Jim Blandy's avatar
Jim Blandy committed
310
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
311 312 313 314 315 316 317
       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)
318
     Lisp_Object pos, window, partially;
Jim Blandy's avatar
Jim Blandy committed
319 320 321 322
{
  register struct window *w;
  register int posint;
  register struct buffer *buf;
323 324
  struct text_pos top;
  Lisp_Object in_window;
325
  int fully_p;
Jim Blandy's avatar
Jim Blandy committed
326

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

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

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

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

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

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

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

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
405 406 407 408 409
       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
410 411
     Lisp_Object window;
{
412
  return make_number (window_internal_width (decode_window (window)));
Jim Blandy's avatar
Jim Blandy committed
413 414 415
}

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

DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
424
       doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
425 426 427 428
NCOL should be zero or positive.

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
window so that the location of point becomes invisible.  */)
429
     (window, ncol)
430
     Lisp_Object window, ncol;
Jim Blandy's avatar
Jim Blandy committed
431
{
432 433
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
434

435
  CHECK_NUMBER (ncol);
436
  hscroll = max (0, XINT (ncol));
437

438 439
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
440
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
441

442
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
443 444 445
  return ncol;
}

446 447
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
448 449 450
       doc: /* Return WINDOW's redisplay end trigger value.
See `set-window-redisplay-end-trigger' for more information.  */)
     (window)
451 452 453 454 455 456 457
     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,
458 459 460 461 462 463 464
       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)
465 466 467 468 469 470 471 472 473
     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
474
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
475 476 477 478 479 480
       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
481 482 483 484 485
     Lisp_Object window;
{
  register struct window *w = decode_window (window);

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

492
/* Test if the character at column *X, row *Y is within window W.
493
   If it is not, return ON_NOTHING;
Jim Blandy's avatar
Jim Blandy committed
494 495 496
   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
497 498
      return ON_TEXT;
   if it is on the window's modeline, return ON_MODE_LINE;
Jim Blandy's avatar
Jim Blandy committed
499
   if it is on the border between the window and its right sibling,
500 501
      return ON_VERTICAL_BORDER.
   if it is on the window's top line, return ON_HEADER_LINE;
Kim F. Storm's avatar
Kim F. Storm committed
502
   if it is in left or right fringe of the window,
503 504
      return ON_LEFT_FRINGE or ON_RIGHT_FRINGE, and convert *X and *Y
      to window-relative coordinates;
505
   if it is in the marginal area to the left/right of the window,
506 507
      return ON_LEFT_MARGIN or ON_RIGHT_MARGIN, and convert *X and *Y
      to window-relative coordinates.
508 509 510

   X and Y are frame relative pixel coordinates.  */

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

  if (*x < x0 || *x >= x1)
    return ON_NOTHING;
531

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

551 552 553 554 555
  /* 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.  */
556

557
  if (WINDOW_WANTS_MODELINE_P (w)
558 559
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
      && *y < bottom_y)
560
    {
561 562 563 564 565
      /* 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;
566

567 568
      if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
	{
569
	  if (abs (*x - x0) < grabbable_width)
570 571
	    part = ON_VERTICAL_BORDER;
	}
572
      else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < grabbable_width)
573
	part = ON_VERTICAL_BORDER;
574
    }
575 576 577 578 579
  else if (WINDOW_WANTS_HEADER_LINE_P (w)
	   && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
	   && *y >= top_y)
    {
      part = ON_HEADER_LINE;
580

581 582
      if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
	{
583
	  if (abs (*x - x0) < grabbable_width)
584 585
	    part = ON_VERTICAL_BORDER;
	}
586
      else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < grabbable_width)
587 588 589 590 591 592
	part = ON_VERTICAL_BORDER;
    }
  /* Outside anything interesting?  */
  else if (*y < top_y
	   || *y >= bottom_y
	   || *x < (left_x
593
		    - FRAME_LEFT_FRINGE_WIDTH (f)
594
		    - FRAME_LEFT_SCROLL_BAR_WIDTH (f) * ux)
595
	   || *x > (right_x
596
		    + FRAME_RIGHT_FRINGE_WIDTH (f)
597
		    + FRAME_RIGHT_SCROLL_BAR_WIDTH (f) * ux))
598
    {
599
      part = ON_NOTHING;
600
    }
601
  else if (FRAME_WINDOW_P (f))
602
    {
603 604 605
      if (!w->pseudo_window_p
	  && !FRAME_HAS_VERTICAL_SCROLL_BARS (f)
	  && !WINDOW_RIGHTMOST_P (w)
606
	  && (abs (*x - right_x - FRAME_RIGHT_FRINGE_WIDTH (f)) < grabbable_width))
607 608 609 610
	{
	  part = ON_VERTICAL_BORDER;
	}
      else if (*x < left_x || *x > right_x)
611
	{
Kim F. Storm's avatar
Kim F. Storm committed
612
	  /* Other lines than the mode line don't include fringes and
613
	     scroll bars on the left.  */
614

615 616 617
	  /* Convert X and Y to window-relative pixel coordinates.  */
	  *x -= left_x;
	  *y -= top_y;
618 619 620 621
	  part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
	}
      else
	{
622 623 624 625 626
	  lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
	  rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
	  /* You can never be on a margin area if its width is zero.  */
	  if (lmargin_width
	      && *x <= window_box_right (w, LEFT_MARGIN_AREA))
627
	    part = ON_LEFT_MARGIN;
628 629
	  else if (rmargin_width
		   && *x >= window_box_left (w, RIGHT_MARGIN_AREA))
630 631 632 633 634 635 636
	    part = ON_RIGHT_MARGIN;
	  else
	    {
	      part = ON_TEXT;
	      *x -= left_x;
	      *y -= top_y;
	    }
637
	}
638
    }
639 640 641 642 643 644
  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
645
	  /* Other lines than the mode line don't include fringes and
646
	     scroll bars on the left.  */
647

648 649 650
	  /* Convert X and Y to window-relative pixel coordinates.  */
	  *x -= left_x;
	  *y -= top_y;
651
	  part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
652 653
	}
      /* Here, too, "*x > right_x" is because of character terminals.  */
654 655 656 657 658 659 660 661 662 663
      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
	{
664 665 666 667 668 669
	  lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
	  rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
	  /* You can never be on a margin area if its width is zero.
	     This is especially important for character terminals.  */
	  if (lmargin_width
	      && *x <= window_box_right (w, LEFT_MARGIN_AREA))
670
	    part = ON_LEFT_MARGIN;
671 672
	  else if (rmargin_width
		   && *x >= window_box_left (w, RIGHT_MARGIN_AREA))
673 674 675 676 677 678 679 680
	    part = ON_RIGHT_MARGIN;
	  else
	    {
	      part = ON_TEXT;
	      /* Convert X and Y to window-relative pixel coordinates.  */
	      *x -= left_x;
	      *y -= top_y;
	    }
681
	}
682
    }
683 684

  return part;
Jim Blandy's avatar
Jim Blandy committed
685 686
}

687

Jim Blandy's avatar
Jim Blandy committed
688
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
689 690 691 692 693 694 695 696 697 698
       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
699 700
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.
701
If they are on the border between WINDOW and its right sibling,
702 703 704
  `vertical-line' is returned.
If they are in the windows's left or right marginal areas, `left-margin'\n\
  or `right-margin' is returned.  */)
705
     (coordinates, window)
Jim Blandy's avatar
Jim Blandy committed
706 707
     register Lisp_Object coordinates, window;
{
708 709
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
710
  int x, y;
711
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
712

713
  CHECK_LIVE_WINDOW (window);
714 715
  w = XWINDOW (window);
  f = XFRAME (w->frame);
716
  CHECK_CONS (coordinates);
717 718
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
719 720
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
721 722 723 724
  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
725
    {
726
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
727 728
      return Qnil;

729 730 731
    case ON_TEXT:
      /* X and Y are now window relative pixel coordinates.  Convert
	 them to canonical char units before returning them.  */
732
      return Fcons (CANON_X_FROM_PIXEL_X (f, x),
733
		    CANON_Y_FROM_PIXEL_Y (f, y));
Jim Blandy's avatar
Jim Blandy committed
734

735
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
736
      return Qmode_line;
737

738
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
739
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
740

741
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
742
      return Qheader_line;
743

744 745
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
746

747 748
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
749

750 751
    case ON_LEFT_MARGIN:
      return Qleft_margin;
752

753 754 755
    case ON_RIGHT_MARGIN:
      return Qright_margin;

Jim Blandy's avatar
Jim Blandy committed
756 757 758 759 760
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
761 762

/* Callback for foreach_window, used in window_from_coordinates.
763 764 765 766 767
   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
768
   *CW->part the part of the window under coordinates *X,*Y.  Return
769 770 771 772 773
   zero from this function to stop iterating over windows.  */

struct check_window_data
{
  Lisp_Object *window;
774 775
  int *x, *y;
  enum window_part *part;
776
};
Gerd Moellmann's avatar
Gerd Moellmann committed
777 778

static int
779
check_window_containing (w, user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
780
     struct window *w;
781
     void *user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
782
{
783
  struct check_window_data *cw = (struct check_window_data *) user_data;
784 785
  enum window_part found;
  int continue_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
786

787
  found = coordinates_in_window (w, cw->x, cw->y);
788
  if (found != ON_NOTHING)
Gerd Moellmann's avatar
Gerd Moellmann committed
789
    {
790
      *cw->part = found;
791
      XSETWINDOW (*cw->window, w);
792
      continue_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
793
    }
794

795
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
796 797 798
}


799
/* Find the window containing frame-relative pixel position X/Y and
800 801 802
   return it as a Lisp_Object.  If X, Y is on one of the window's 
   special `window_part' elements, set *PART to the id of that element.
   If there is no window under X, Y return nil and leave *PART
Gerd Moellmann's avatar
Gerd Moellmann committed
803 804 805 806 807 808 809 810 811 812
   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.  */
813

Jim Blandy's avatar
Jim Blandy committed
814
Lisp_Object
Gerd Moellmann's avatar
Gerd Moellmann committed
815 816
window_from_coordinates (f, x, y, part, tool_bar_p)
     struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
817
     int x, y;
818
     enum window_part *part;
819
     int tool_bar_p;
Jim Blandy's avatar
Jim Blandy committed
820
{
Gerd Moellmann's avatar
Gerd Moellmann committed
821
  Lisp_Object window;
822
  struct check_window_data cw;
823 824 825 826
  enum window_part dummy;

  if (part == 0)
    part = &dummy;
827

Gerd Moellmann's avatar
Gerd Moellmann committed
828
  window = Qnil;
829 830
  cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
  foreach_window (f, check_window_containing, &cw);
831

Gerd Moellmann's avatar
Gerd Moellmann committed
832 833 834 835 836 837
  /* 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
838 839
      && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
	  != ON_NOTHING))
840
    {
841
      *part = ON_TEXT;
Gerd Moellmann's avatar
Gerd Moellmann committed
842
      window = f->tool_bar_window;
843
    }
844

Gerd Moellmann's avatar
Gerd Moellmann committed
845
  return window;
Jim Blandy's avatar
Jim Blandy committed
846 847
}

848
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
849 850 851 852 853 854
       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
855
{
856
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
857

Jim Blandy's avatar
Jim Blandy committed
858
  if (NILP (frame))
859
    frame = selected_frame;
860
  CHECK_LIVE_FRAME (frame);
861
  f = XFRAME (frame);
Jim Blandy's avatar
Jim Blandy committed
862

863
  /* Check that arguments are integers or floats.  */
864 865
  CHECK_NUMBER_OR_FLOAT (x);
  CHECK_NUMBER_OR_FLOAT (y);
866

867
  return window_from_coordinates (f,
868 869
				  PIXEL_X_FROM_CANON_X (f, x),
				  PIXEL_Y_FROM_CANON_Y (f, y),
870
				  0, 0);
Jim Blandy's avatar
Jim Blandy committed
871 872 873
}

DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
874 875 876 877 878 879 880 881 882 883
       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
884 885 886 887 888 889 890 891 892 893 894
     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,
895 896 897
       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
898 899 900 901 902
     Lisp_Object window;
{
  return Fmarker_position (decode_window (window)->start);
}

903 904
/* This is text temporarily removed from the doc string below.

905 906 907 908 909 910 911
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)
912 913
      (point))")  */

914
DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
915 916 917 918 919 920 921
       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)
922
     Lisp_Object window, update;
Jim Blandy's avatar
Jim Blandy committed
923 924 925
{
  Lisp_Object value;
  struct window *w = decode_window (window);
926 927 928
  Lisp_Object buf;

  buf = w->buffer;
929
  CHECK_BUFFER (buf);
930

931
#if 0 /* This change broke some things.  We should make it later.  */
932 933 934 935 936 937
  /* 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;
938
#endif
939

940 941 942 943
  if (! NILP (update)
      && ! (! NILP (w->window_end_valid)
	    && XFASTINT (w->last_modified) >= MODIFF))
    {
944 945
      struct text_pos startp;
      struct it it;
946
      struct buffer *old_buffer = NULL, *b = XBUFFER (buf);
947 948

      /* In case W->start is out of the range, use something
Juanma Barranquero's avatar
Juanma Barranquero committed
949
         reasonable.  This situation occurred when loading a file with
950 951
         `-l' containing a call to `rmail' with subsequent other
         commands.  At the end, W->start happened to be BEG, while
952
         rmail had already narrowed the buffer.  */
953
      if (XMARKER (w->start)->charpos < BEGV)
954
	SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
955
      else if (XMARKER (w->start)->charpos > ZV)
956
	SET_TEXT_POS (startp, ZV, ZV_BYTE);
957
      else
958 959 960 961
	SET_TEXT_POS_FROM_MARKER (startp, w->start);

      /* Cannot use Fvertical_motion because that function doesn't
	 cope with variable-height lines.  */
962 963 964 965 966
      if (b != current_buffer)
	{
	  old_buffer = current_buffer;
	  set_buffer_internal (b);
	}
967

968 969
      start_display (&it, w, startp);
      move_it_vertically (&it, window_box_height (w));
970 971
      if (it.current_y < it.last_visible_y)
	move_it_past_eol (&it);