window.c 224 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-1987, 1993-1998, 2000-2011
Glenn Morris's avatar
Glenn Morris committed
4
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

21
#include <config.h>
22
#include <stdio.h>
23
#include <setjmp.h>
24

Jim Blandy's avatar
Jim Blandy committed
25 26
#include "lisp.h"
#include "buffer.h"
27
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
28
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
29
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
30 31 32 33 34
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
35
#include "dispextern.h"
36 37
#include "blockinput.h"
#include "intervals.h"
38
#include "termhooks.h"		/* For FRAME_TERMINAL.  */
39

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

53 54 55 56 57
Lisp_Object Qwindowp, Qwindow_live_p;
static Lisp_Object Qwindow_configuration_p;
static Lisp_Object Qdisplay_buffer;
static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
static Lisp_Object Qwindow_size_fixed;
58

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
static int displayed_window_lines (struct window *);
static struct window *decode_window (Lisp_Object);
static int count_windows (struct window *);
static int get_leaf_windows (struct window *, struct window **, int);
static void window_scroll (Lisp_Object, int, int, int);
static void window_scroll_pixel_based (Lisp_Object, int, int, int);
static void window_scroll_line_based (Lisp_Object, int, int, int);
static int window_min_size_1 (struct window *, int, int);
static int window_min_size_2 (struct window *, int, int);
static int window_min_size (struct window *, int, int, int, int *);
static void size_window (Lisp_Object, int, int, int, int, int);
static int freeze_window_start (struct window *, void *);
static int window_fixed_size_p (struct window *, int, int);
static void enlarge_window (Lisp_Object, int, int);
static Lisp_Object window_list (void);
static int add_window_to_list (struct window *, void *);
static int candidate_window_p (Lisp_Object, Lisp_Object, Lisp_Object,
                               Lisp_Object);
static Lisp_Object next_window (Lisp_Object, Lisp_Object,
                                Lisp_Object, int);
static void decode_next_window_args (Lisp_Object *, Lisp_Object *,
                                     Lisp_Object *);
Andreas Schwab's avatar
Andreas Schwab committed
81
static void foreach_window (struct frame *,
82
				 int (* fn) (struct window *, void *),
Andreas Schwab's avatar
Andreas Schwab committed
83
                            void *);
84 85 86 87
static int foreach_window_1 (struct window *,
                             int (* fn) (struct window *, void *),
                             void *);
static Lisp_Object window_list_1 (Lisp_Object, Lisp_Object, Lisp_Object);
Glenn Morris's avatar
Glenn Morris committed
88
static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
89

Jim Blandy's avatar
Jim Blandy committed
90 91 92 93 94 95
/* 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
96
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
97 98
Lisp_Object selected_window;

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

104 105 106
/* 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
107 108 109
   the selected window.  */
Lisp_Object minibuf_window;

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

114
/* Hook run at end of temp_output_buffer_show.  */
115
static Lisp_Object Qtemp_buffer_show_hook;
116

Jim Blandy's avatar
Jim Blandy committed
117 118 119
/* Incremented for each window created.  */
static int sequence_number;

120 121 122
/* Nonzero after init_window_once has finished.  */
static int window_initialized;

123
/* Hook to run when window config changes.  */
124
static Lisp_Object Qwindow_configuration_change_hook;
125

126
/* Incremented by 1 whenever a window is deleted.  */
127
static int window_deletion_count;
128

129
/* Used by the function window_scroll_pixel_based */
130
static int window_scroll_pixel_based_preserve_x;
131
static int window_scroll_pixel_based_preserve_y;
132

133 134 135
/* Same for window_scroll_line_based.  */
static int window_scroll_preserve_hpos;
static int window_scroll_preserve_vpos;
136 137 138 139 140 141

static struct window *
decode_window (register Lisp_Object window)
{
  if (NILP (window))
    return XWINDOW (selected_window);
142

143 144 145 146 147 148 149 150 151 152 153 154 155
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

static struct window *
decode_any_window (register Lisp_Object window)
{
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
  return XWINDOW (window);
}
156

Jim Blandy's avatar
Jim Blandy committed
157
DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
158
       doc: /* Return t if OBJECT is a window and nil otherwise.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
159
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
160
{
161
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
162 163
}

164
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
165 166
       doc: /* Return t if OBJECT is a live window and nil otherwise.
A live window is a window that displays a buffer.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
167
  (Lisp_Object object)
168
{
169
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
170 171
}

Jim Blandy's avatar
Jim Blandy committed
172
Lisp_Object
173
make_window (void)
Jim Blandy's avatar
Jim Blandy committed
174
{
175
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
176
  register struct window *p;
177

178
  p = allocate_window ();
179 180
  ++sequence_number;
  XSETFASTINT (p->sequence_number, sequence_number);
181 182 183 184
  XSETFASTINT (p->left_col, 0);
  XSETFASTINT (p->top_line, 0);
  XSETFASTINT (p->total_lines, 0);
  XSETFASTINT (p->total_cols, 0);
185
  XSETFASTINT (p->hscroll, 0);
186
  XSETFASTINT (p->min_hscroll, 0);
187
  p->orig_top_line = p->orig_total_lines = Qnil;
Jim Blandy's avatar
Jim Blandy committed
188 189
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
190
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
191
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
192 193
  p->display_table = Qnil;
  p->dedicated = Qnil;
194
  p->window_parameters = Qnil;
195
  p->pseudo_window_p = 0;
196 197 198
  memset (&p->cursor, 0, sizeof (p->cursor));
  memset (&p->last_cursor, 0, sizeof (p->last_cursor));
  memset (&p->phys_cursor, 0, sizeof (p->phys_cursor));
199
  p->desired_matrix = p->current_matrix = 0;
200
  p->nrows_scale_factor = p->ncols_scale_factor = 1;
201
  p->phys_cursor_type = -1;
202
  p->phys_cursor_width = -1;
203 204 205 206 207
  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;
208
  XSETWINDOW (val, p);
209
  XSETFASTINT (p->last_point, 0);
210
  p->frozen_window_start_p = 0;
211
  p->last_cursor_off_p = p->cursor_off_p = 0;
212 213 214 215 216 217 218
  p->left_margin_cols = Qnil;
  p->right_margin_cols = Qnil;
  p->left_fringe_width = Qnil;
  p->right_fringe_width = Qnil;
  p->fringes_outside_margins = Qnil;
  p->scroll_bar_width = Qnil;
  p->vertical_scroll_bar_type = Qt;
219
  p->resize_proportionally = Qnil;
Gerd Moellmann's avatar
Gerd Moellmann committed
220 221

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
222 223 224
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
225
DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
226
       doc: /* Return the window that the cursor now appears in and commands apply to.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
227
  (void)
Jim Blandy's avatar
Jim Blandy committed
228 229 230 231
{
  return selected_window;
}

232
DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
233 234 235
       doc: /* Return the window used now for minibuffers.
If the optional argument FRAME is specified, return the minibuffer window
used by that frame.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
236
  (Lisp_Object frame)
Jim Blandy's avatar
Jim Blandy committed
237
{
238
  if (NILP (frame))
239
    frame = selected_frame;
240
  CHECK_LIVE_FRAME (frame);
241
  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
Jim Blandy's avatar
Jim Blandy committed
242 243
}

Paul Eggert's avatar
Paul Eggert committed
244
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
245
       Swindow_minibuffer_p, 0, 1, 0,
246
       doc: /* Return non-nil if WINDOW is a minibuffer window.
Kenichi Handa's avatar
Kenichi Handa committed
247
WINDOW defaults to the selected window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
248
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
249 250
{
  struct window *w = decode_window (window);
251
  return MINI_WINDOW_P (w) ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
252 253 254
}


Paul Eggert's avatar
Paul Eggert committed
255
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
256
       Spos_visible_in_window_p, 0, 3, 0,
257
       doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
258 259 260
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.
261
If POS is only out of view because of horizontal scrolling, return non-nil.
262
If POS is t, it specifies the position of the last visible glyph in WINDOW.
263 264 265
POS defaults to point in WINDOW; WINDOW defaults to the selected window.

If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
266 267 268 269
return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
where X and Y are the pixel coordinates relative to the top left corner
of the window.  The remaining elements are omitted if the character after
POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
270
off-window at the top and bottom of the row, ROWH is the height of the
271
display row, and VPOS is the row number (0-based) containing POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
272
  (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
Jim Blandy's avatar
Jim Blandy committed
273 274
{
  register struct window *w;
275
  register EMACS_INT posint;
Jim Blandy's avatar
Jim Blandy committed
276
  register struct buffer *buf;
277
  struct text_pos top;
278
  Lisp_Object in_window = Qnil;
279
  int rtop, rbot, rowh, vpos, fully_p = 1;
280
  int x, y;
Jim Blandy's avatar
Jim Blandy committed
281

Miles Bader's avatar
Miles Bader committed
282 283 284 285
  w = decode_window (window);
  buf = XBUFFER (w->buffer);
  SET_TEXT_POS_FROM_MARKER (top, w->start);

286 287 288
  if (EQ (pos, Qt))
    posint = -1;
  else if (!NILP (pos))
Jim Blandy's avatar
Jim Blandy committed
289
    {
290
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
291 292
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
293 294 295 296
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
297

298 299
  /* If position is above window start or outside buffer boundaries,
     or if window start is out of range, position is not visible.  */
300 301
  if ((EQ (pos, Qt)
       || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
302 303
      && CHARPOS (top) >= BUF_BEGV (buf)
      && CHARPOS (top) <= BUF_ZV (buf)
304
      && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
305
      && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
306 307 308
    in_window = Qt;

  if (!NILP (in_window) && !NILP (partially))
309 310 311 312 313 314 315 316 317
    {
      Lisp_Object part = Qnil;
      if (!fully_p)
	part = list4 (make_number (rtop), make_number (rbot),
			make_number (rowh), make_number (vpos));
      in_window = Fcons (make_number (x),
			 Fcons (make_number (y), part));
    }

318
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
319
}
320

321
DEFUN ("window-line-height", Fwindow_line_height,
322
       Swindow_line_height, 0, 2, 0,
323 324 325
       doc: /* Return height in pixels of text line LINE in window WINDOW.
If WINDOW is nil or omitted, use selected window.

326 327 328 329
Return height of current line if LINE is omitted or nil.  Return height of
header or mode line if LINE is `header-line' and `mode-line'.
Otherwise, LINE is a text line number starting from 0.  A negative number
counts from the end of the window.
330

331
Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
332
in pixels of the visible part of the line, VPOS and YPOS are the
333
vertical position in lines and pixels of the line, relative to the top
334
of the first text line, and OFFBOT is the number of off-window pixels at
335 336
the bottom of the text line.  If there are off-window pixels at the top
of the (first) text line, YPOS is negative.
337 338 339

Return nil if window display is not up-to-date.  In that case, use
`pos-visible-in-window-p' to obtain the information.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
340
  (Lisp_Object line, Lisp_Object window)
341 342 343 344
{
  register struct window *w;
  register struct buffer *b;
  struct glyph_row *row, *end_row;
345
  int max_y, crop, i, n;
346 347 348 349 350

  w = decode_window (window);

  if (noninteractive
      || w->pseudo_window_p)
351
    return Qnil;
352 353 354 355 356 357 358 359 360 361 362 363

  CHECK_BUFFER (w->buffer);
  b = XBUFFER (w->buffer);

  /* Fail if current matrix is not up-to-date.  */
  if (NILP (w->window_end_valid)
      || current_buffer->clip_changed
      || current_buffer->prevent_redisplay_optimizations_p
      || XFASTINT (w->last_modified) < BUF_MODIFF (b)
      || XFASTINT (w->last_overlay_modified) < BUF_OVERLAY_MODIFF (b))
    return Qnil;

364 365 366 367 368 369 370 371 372 373
  if (NILP (line))
    {
      i = w->cursor.vpos;
      if (i < 0 || i >= w->current_matrix->nrows
	  || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
	return Qnil;
      max_y = window_text_bottom_y (w);
      goto found_row;
    }

374
  if (EQ (line, Qheader_line))
375
    {
376 377 378
      if (!WINDOW_WANTS_HEADER_LINE_P (w))
	return Qnil;
      row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
379 380
      if (!row->enabled_p)
	return Qnil;
381 382 383
      return list4 (make_number (row->height),
		    make_number (0), make_number (0),
		    make_number (0));
384
    }
385 386

  if (EQ (line, Qmode_line))
387
    {
388 389 390 391 392 393 394 395 396
      row = MATRIX_MODE_LINE_ROW (w->current_matrix);
      if (!row->enabled_p)
	return Qnil;
      return list4 (make_number (row->height),
		    make_number (0), /* not accurate */
		    make_number (WINDOW_HEADER_LINE_HEIGHT (w)
				 + window_text_bottom_y (w)),
		    make_number (0));
    }
397

398
  CHECK_NUMBER (line);
399
  n = XINT (line);
400 401 402 403

  row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
  end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
  max_y = window_text_bottom_y (w);
404
  i = 0;
405 406 407 408 409

  while ((n < 0 || i < n)
	 && row <= end_row && row->enabled_p
	 && row->y + row->height < max_y)
    row++, i++;
410

411 412 413
  if (row > end_row || !row->enabled_p)
    return Qnil;

414
  if (++n < 0)
415 416 417
    {
      if (-n > i)
	return Qnil;
418 419
      row += n;
      i += n;
420 421
    }

422
 found_row:
423 424
  crop = max (0, (row->y + row->height) - max_y);
  return list4 (make_number (row->height + min (0, row->y) - crop),
425
		make_number (i),
426 427
		make_number (row->y),
		make_number (crop));
428 429
}

430

Jim Blandy's avatar
Jim Blandy committed
431

Paul Eggert's avatar
Paul Eggert committed
432
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
433 434
       doc: /* Return the buffer that WINDOW is displaying.
WINDOW defaults to the selected window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
435
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
436 437 438 439 440
{
  return decode_window (window)->buffer;
}

DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
441 442 443
       doc: /* Return the number of lines in WINDOW.
WINDOW defaults to the selected window.

444 445 446 447
The return value includes WINDOW's mode line and header line, if any.

Note: The function does not take into account the value of `line-spacing'
when calculating the number of lines in WINDOW.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
448
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
449
{
Kenichi Handa's avatar
Kenichi Handa committed
450
  return decode_any_window (window)->total_lines;
Jim Blandy's avatar
Jim Blandy committed
451 452 453
}

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
454
       doc: /* Return the number of display columns in WINDOW.
455 456 457 458 459
WINDOW defaults to the selected window.

Note: The return value is the number of 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))).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
460
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
461
{
Kenichi Handa's avatar
Kenichi Handa committed
462
  return make_number (window_box_text_cols (decode_any_window (window)));
Jim Blandy's avatar
Jim Blandy committed
463 464
}

465 466 467
DEFUN ("window-full-width-p", Fwindow_full_width_p, Swindow_full_width_p, 0, 1, 0,
       doc: /* Return t if WINDOW is as wide as its frame.
WINDOW defaults to the selected window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
468
  (Lisp_Object window)
469 470 471 472
{
  return WINDOW_FULL_WIDTH_P (decode_any_window (window)) ? Qt : Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
473
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
474 475
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
WINDOW defaults to the selected window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
476
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
477 478 479 480 481
{
  return decode_window (window)->hscroll;
}

DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
482
       doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
483
Return NCOL.  NCOL should be zero or positive.
484 485

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
486
window so that the location of point moves off-window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
487
  (Lisp_Object window, Lisp_Object ncol)
Jim Blandy's avatar
Jim Blandy committed
488
{
489 490
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
491

492
  CHECK_NUMBER (ncol);
493
  hscroll = max (0, XINT (ncol));
494

495 496
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
497
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
498

499
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
500 501 502
  return ncol;
}

503 504
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
505
       doc: /* Return WINDOW's redisplay end trigger value.
506
WINDOW defaults to the selected window.
507
See `set-window-redisplay-end-trigger' for more information.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
508
  (Lisp_Object window)
509 510 511 512 513 514
{
  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,
515 516 517 518 519 520
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
521
  (register Lisp_Object window, Lisp_Object value)
522 523 524 525 526 527 528 529
{
  register struct window *w;

  w = decode_window (window);
  w->redisplay_end_trigger = value;
  return value;
}

Jim Blandy's avatar
Jim Blandy committed
530
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
531
       doc: /* Return a list of the edge coordinates of WINDOW.
532 533 534 535 536 537 538 539 540
The list has the form (LEFT TOP RIGHT BOTTOM).
TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
all relative to 0, 0 at top left corner of frame.

RIGHT is one more than the rightmost column occupied by WINDOW.
BOTTOM is one more than the bottommost row occupied by WINDOW.
The edges include the space used by WINDOW's scroll bar, display
margins, fringes, header line, and/or mode line.  For the edges of
just the text area, use `window-inside-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
541
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
542
{
Kenichi Handa's avatar
Kenichi Handa committed
543
  register struct window *w = decode_any_window (window);
Jim Blandy's avatar
Jim Blandy committed
544

545 546 547 548 549
  return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
	 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
	 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
	 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
		Qnil))));
Jim Blandy's avatar
Jim Blandy committed
550 551
}

552 553
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
554 555 556 557 558 559 560 561
The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
the top left corner of the frame.

RIGHT is one more than the rightmost x position occupied by WINDOW.
BOTTOM is one more than the bottommost y position occupied by WINDOW.
The pixel edges include the space used by WINDOW's scroll bar, display
margins, fringes, header line, and/or mode line.  For the pixel edges
of just the text area, use `window-inside-pixel-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
562
  (Lisp_Object window)
563
{
Kenichi Handa's avatar
Kenichi Handa committed
564
  register struct window *w = decode_any_window (window);
565 566 567 568 569 570 571 572

  return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
	 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
	 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
	 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
		Qnil))));
}

573 574 575 576 577 578 579 580
static void
calc_absolute_offset(struct window *w, int *add_x, int *add_y)
{
  struct frame *f = XFRAME (w->frame);
  *add_y = f->top_pos;
#ifdef FRAME_MENUBAR_HEIGHT
  *add_y += FRAME_MENUBAR_HEIGHT (f);
#endif
581 582 583
#ifdef FRAME_TOOLBAR_TOP_HEIGHT
  *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
#elif FRAME_TOOLBAR_HEIGHT
584 585 586 587 588 589
  *add_y += FRAME_TOOLBAR_HEIGHT (f);
#endif
#ifdef FRAME_NS_TITLEBAR_HEIGHT
  *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
#endif
  *add_x = f->left_pos;
590 591 592
#ifdef FRAME_TOOLBAR_LEFT_WIDTH
  *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
#endif
593 594 595 596 597 598 599 600 601 602 603 604
}

DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
       Swindow_absolute_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
the top left corner of the display.

RIGHT is one more than the rightmost x position occupied by WINDOW.
BOTTOM is one more than the bottommost y position occupied by WINDOW.
The pixel edges include the space used by WINDOW's scroll bar, display
margins, fringes, header line, and/or mode line.  For the pixel edges
605
of just the text area, use `window-inside-absolute-pixel-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
606
  (Lisp_Object window)
607 608 609
{
  register struct window *w = decode_any_window (window);
  int add_x, add_y;
610
  calc_absolute_offset (w, &add_x, &add_y);
611 612 613 614 615 616 617 618

  return Fcons (make_number (WINDOW_LEFT_EDGE_X (w) + add_x),
         Fcons (make_number (WINDOW_TOP_EDGE_Y (w) + add_y),
	 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w) + add_x),
	 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w) + add_y),
		Qnil))));
}

619 620
DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
       doc: /* Return a list of the edge coordinates of WINDOW.
621 622 623 624 625 626 627 628
The list has the form (LEFT TOP RIGHT BOTTOM).
TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
all relative to 0, 0 at top left corner of frame.

RIGHT is one more than the rightmost column of WINDOW's text area.
BOTTOM is one more than the bottommost row of WINDOW's text area.
The inside edges do not include the space used by the WINDOW's scroll
bar, display margins, fringes, header line, and/or mode line.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
629
  (Lisp_Object window)
630
{
Kenichi Handa's avatar
Kenichi Handa committed
631
  register struct window *w = decode_any_window (window);
632 633 634 635 636 637

  return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
			     + WINDOW_LEFT_MARGIN_COLS (w)
			     + WINDOW_LEFT_FRINGE_COLS (w)),
		make_number (WINDOW_TOP_EDGE_LINE (w)
			     + WINDOW_HEADER_LINE_LINES (w)),
638
		make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
639 640 641 642 643 644 645
			     - WINDOW_RIGHT_MARGIN_COLS (w)
			     - WINDOW_RIGHT_FRINGE_COLS (w)),
		make_number (WINDOW_BOTTOM_EDGE_LINE (w)
			     - WINDOW_MODE_LINE_LINES (w)));
}

DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
646
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
647 648 649 650 651 652
The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
the top left corner of the frame.

RIGHT is one more than the rightmost x position of WINDOW's text area.
BOTTOM is one more than the bottommost y position of WINDOW's text area.
The inside edges do not include the space used by WINDOW's scroll bar,
653
display margins, fringes, header line, and/or mode line.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
654
  (Lisp_Object window)
655
{
Kenichi Handa's avatar
Kenichi Handa committed
656
  register struct window *w = decode_any_window (window);
657 658 659 660 661 662

  return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
			     + WINDOW_LEFT_MARGIN_WIDTH (w)
			     + WINDOW_LEFT_FRINGE_WIDTH (w)),
		make_number (WINDOW_TOP_EDGE_Y (w)
			     + WINDOW_HEADER_LINE_HEIGHT (w)),
663
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
664 665 666 667 668 669
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

670 671 672 673 674 675 676 677 678 679 680
DEFUN ("window-inside-absolute-pixel-edges",
       Fwindow_inside_absolute_pixel_edges,
       Swindow_inside_absolute_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
the top left corner of the display.

RIGHT is one more than the rightmost x position of WINDOW's text area.
BOTTOM is one more than the bottommost y position of WINDOW's text area.
The inside edges do not include the space used by WINDOW's scroll bar,
display margins, fringes, header line, and/or mode line.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
681
  (Lisp_Object window)
682 683 684
{
  register struct window *w = decode_any_window (window);
  int add_x, add_y;
685
  calc_absolute_offset (w, &add_x, &add_y);
686 687 688 689 690 691 692 693 694 695 696 697 698

  return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
			     + WINDOW_LEFT_MARGIN_WIDTH (w)
			     + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
		make_number (WINDOW_TOP_EDGE_Y (w)
			     + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
}

699
/* Test if the character at column X, row Y is within window W.
700
   If it is not, return ON_NOTHING;
701
   if it is in the window's text area, return ON_TEXT;
702
   if it is on the window's modeline, return ON_MODE_LINE;
Jim Blandy's avatar
Jim Blandy committed
703
   if it is on the border between the window and its right sibling,
704
      return ON_VERTICAL_BORDER.
705
   if it is on a scroll bar, return ON_SCROLL_BAR.
706
   if it is on the window's top line, return ON_HEADER_LINE;
Kim F. Storm's avatar
Kim F. Storm committed
707
   if it is in left or right fringe of the window,
708
      return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
709
   if it is in the marginal area to the left/right of the window,
710
      return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
711 712 713

   X and Y are frame relative pixel coordinates.  */

714
static enum window_part
715
coordinates_in_window (register struct window *w, int x, int y)
Jim Blandy's avatar
Jim Blandy committed
716
{
717
  struct frame *f = XFRAME (WINDOW_FRAME (w));
718
  int left_x, right_x;
719
  enum window_part part;
720 721 722
  int ux = FRAME_COLUMN_WIDTH (f);
  int x0 = WINDOW_LEFT_EDGE_X (w);
  int x1 = WINDOW_RIGHT_EDGE_X (w);
723 724 725
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
726
  int lmargin_width, rmargin_width, text_left, text_right;
727 728 729 730 731 732
  int top_y = WINDOW_TOP_EDGE_Y (w);
  int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);

  /* Outside any interesting row?  */
  if (y < top_y || y >= bottom_y)
    return ON_NOTHING;
733

734 735
  /* 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.  */
736 737 738
  if (w->pseudo_window_p)
    {
      left_x = 0;
739
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
740 741 742
    }
  else
    {
743 744
      left_x = WINDOW_BOX_LEFT_EDGE_X (w);
      right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
745
    }
746

747 748 749 750 751
  /* 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.  */
752

753
  if (WINDOW_WANTS_MODELINE_P (w)
754
      && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
755
    {
756 757 758
      part = ON_MODE_LINE;

    header_vertical_border_check:
759 760
      /* We're somewhere on the mode line.  We consider the place
	 between mode lines of horizontally adjacent mode lines
761
	 as the vertical border.  If scroll bars on the left,
762
	 return the right window.  */
763 764 765 766 767 768 769 770 771 772 773 774 775 776
      if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
	   || WINDOW_RIGHTMOST_P (w))
	  && !WINDOW_LEFTMOST_P (w)
	  && eabs (x - x0) < grabbable_width)
	return ON_VERTICAL_BORDER;

      /* Make sure we're not at the rightmost position of a
	 mode-/header-line and there's yet another window on the
	 right.  (Bug#1372)  */
      else if ((WINDOW_RIGHTMOST_P (w) || x < x1)
	       && eabs (x - x1) < grabbable_width)
	return ON_VERTICAL_BORDER;

      if (x < x0 || x >= x1)
777 778
	return ON_NOTHING;

779
      return part;
780
    }
781 782

  if (WINDOW_WANTS_HEADER_LINE_P (w)
783
      && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
784
    {
785 786
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
787
    }
788

789
  if (x < x0 || x >= x1) return ON_NOTHING;
790

791
  /* Outside any interesting column?  */
792 793
  if (x < left_x || x > right_x)
    return ON_SCROLL_BAR;
794 795 796

  lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
  rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
797

798 799 800 801
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

  if (FRAME_WINDOW_P (f))
802
    {
803
      if (!w->pseudo_window_p
804
	  && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
805
	  && !WINDOW_RIGHTMOST_P (w)
806 807
	  && (eabs (x - right_x) < grabbable_width))
	return ON_VERTICAL_BORDER;
808
    }
809 810 811 812 813 814 815 816
  /* Need to say "x > right_x" rather than >=, since on character
     terminals, the vertical line's x coordinate is right_x.  */
  else if (!w->pseudo_window_p
	   && !WINDOW_RIGHTMOST_P (w)
	   && x > right_x - ux)
    return ON_VERTICAL_BORDER;

  if (x < text_left)
817 818 819
    {
      if (lmargin_width > 0
	  && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
820 821 822 823
	      ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
	      : (x < left_x + lmargin_width)))
	return ON_LEFT_MARGIN;

824 825 826
      return ON_LEFT_FRINGE;
    }

827
  if (x >= text_right)
828 829 830
    {
      if (rmargin_width > 0
	  && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
831 832 833 834
	      ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
	      : (x >= right_x - rmargin_width)))
	return ON_RIGHT_MARGIN;

835 836 837 838 839
      return ON_RIGHT_FRINGE;
    }

  /* Everything special ruled out - must be on text area */
  return ON_TEXT;
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 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
/* Take X is the frame-relative pixel x-coordinate, and return the
   x-coordinate relative to part PART of window W. */
int
window_relative_x_coord (struct window *w, enum window_part part, int x)
{
  int left_x = (w->pseudo_window_p) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w);

  switch (part)
    {
    case ON_TEXT:
      return x - window_box_left (w, TEXT_AREA);

    case ON_LEFT_FRINGE:
      return x - left_x;

    case ON_RIGHT_FRINGE:
      return x - left_x - WINDOW_LEFT_FRINGE_WIDTH (w);

    case ON_LEFT_MARGIN:
      return (x - left_x
	      - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
		 ? WINDOW_LEFT_FRINGE_WIDTH (w) : 0));

    case ON_RIGHT_MARGIN:
      return (x + 1
	      - ((w->pseudo_window_p)
		 ? WINDOW_TOTAL_WIDTH (w)
		 : WINDOW_BOX_RIGHT_EDGE_X (w))
	      + window_box_width (w, RIGHT_MARGIN_AREA)
	      + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
		 ? WINDOW_RIGHT_FRINGE_WIDTH (w) : 0));
    }

  /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER:  */
  return 0;
}

879

Jim Blandy's avatar
Jim Blandy committed
880
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
881 882 883 884
       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.
885
\(0 . 0) denotes the character in the upper left corner of the
886 887 888 889 890
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
891 892
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.
893
If they are on the border between WINDOW and its right sibling,
894 895 896
  `vertical-line' is returned.
If they are in the windows's left or right marginal areas, `left-margin'\n\
  or `right-margin' is returned.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
897
  (register Lisp_Object coordinates, Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
898
{
899 900
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
901
  int x, y;
902
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
903

Kenichi Handa's avatar
Kenichi Handa committed
904
  CHECK_WINDOW (window);
905 906
  w = XWINDOW (window);
  f = XFRAME (w->frame);
907
  CHECK_CONS (coordinates);
908 909
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
910 911
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
912 913
  x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
  y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
914

915
  switch (coordinates_in_window (w, x, y))
Jim Blandy's avatar
Jim Blandy committed
916
    {
917
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
918 919
      return Qnil;

920
    case ON_TEXT:
921 922 923 924
      /* Convert X and Y to window relative pixel coordinates, and
	 return the canonical char units.  */
      x -= window_box_left (w, TEXT_AREA);
      y -= WINDOW_TOP_EDGE_Y (w);
925 926
      return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
		    FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
Jim Blandy's avatar
Jim Blandy committed
927

928
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
929
      return Qmode_line;
930

931
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
932
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
933

934
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
935
      return Qheader_line;
936

937 938
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
939

940 941
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
942

943 944
    case ON_LEFT_MARGIN:
      return Qleft_margin;
945

946 947 948
    case ON_RIGHT_MARGIN:
      return Qright_margin;

949 950 951 952
    case ON_SCROLL_BAR:
      /* Historically we are supposed to return nil in this case.  */
      return Qnil;

Jim Blandy's avatar
Jim Blandy committed
953 954 955 956 957
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
958 959

/* Callback for foreach_window, used in window_from_coordinates.
960 961 962 963 964
   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
965
   *CW->part the part of the window under coordinates *X,*Y.  Return
966 967 968 969 970
   zero from this function to stop iterating over windows.  */

struct check_window_data
{
  Lisp_Object *window;
971
  int x, y;
972
  enum window_part *part;
973
};
Gerd Moellmann's avatar
Gerd Moellmann committed
974 975

static int
976
check_window_containing (struct window *w, void *user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
977
{
978
  struct check_window_data *cw = (struct check_window_data *) user_data;
979 980
  enum window_part found;
  int continue_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
981

982
  found = coordinates_in_window (w, cw->x, cw->y);
983
  if (found != ON_NOTHING)
Gerd Moellmann's avatar
Gerd Moellmann committed
984
    {
985
      *cw->part = found;
986
      XSETWINDOW (*cw->window, w);
987
      continue_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
988
    }
989

990
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
991 992 993
}


994
/* Find the window containing frame-relative pixel position X/Y and
995 996 997
   return it as a Lisp_Object.

   If X, Y is on one of the window's special `window_part' elements,
998
   set *PART to the id of that element.
999

1000
   If there is no window under X, Y return nil and leave *PART
Gerd Moellmann's avatar
Gerd Moellmann committed
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
   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.  */
1011

Jim Blandy's avatar
Jim Blandy committed
1012
Lisp_Object
1013 1014
window_from_coordinates (struct frame *f, int x, int y,
			 enum window_part *part, int tool_bar_p)
Jim Blandy's avatar
Jim Blandy committed
1015
{
Gerd Moellmann's avatar
Gerd Moellmann committed
1016
  Lisp_Object window;
1017
  struct check_window_data cw;
1018 1019 1020 1021
  enum window_part dummy;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
1023
  window = Qnil;
1024
  cw.window = &window, cw.x = x, cw.y = y; cw.part = part;
1025
  foreach_window (f, check_window_containing, &cw);