window.c 225 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
}

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
       doc: /* Return the buffer that WINDOW is displaying.
WINDOW can be any window and defaults to the selected one.
If WINDOW is an internal window return nil.  */)
  (Lisp_Object window)
{
  return decode_any_window (window)->buffer;
}

DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
       doc: /* Return WINDOW's parent window.
WINDOW can be any window and defaults to the selected one.
Return nil if WINDOW has no parent.  */)
  (Lisp_Object window)
{
  return decode_any_window (window)->parent;
}

DEFUN ("window-vchild", Fwindow_vchild, Swindow_vchild, 0, 1, 0,
       doc: /* Return WINDOW's first vertical child window.
WINDOW can be any window and defaults to the selected one.
Return nil if WINDOW has no vertical child.  */)
  (Lisp_Object window)
{
  return decode_any_window (window)->vchild;
}

DEFUN ("window-hchild", Fwindow_hchild, Swindow_hchild, 0, 1, 0,
       doc: /* Return WINDOW's first horizontal child window.
WINDOW can be any window and defaults to the selected one.
Return nil if WINDOW has no horizontal child.  */)
  (Lisp_Object window)
{
  return decode_any_window (window)->hchild;
}

DEFUN ("window-next", Fwindow_next, Swindow_next, 0, 1, 0,
       doc: /* Return WINDOW's right sibling window.
WINDOW can be any window and defaults to the selected one.
Return nil if WINDOW has no right sibling.  */)
  (Lisp_Object window)
{
  return decode_any_window (window)->next;
}

DEFUN ("window-prev", Fwindow_prev, Swindow_prev, 0, 1, 0,
       doc: /* Return WINDOW's left sibling window.
WINDOW can be any window and defaults to the selected one.
Return nil if WINDOW has no left sibling.  */)
  (Lisp_Object window)
{
  return decode_any_window (window)->prev;
}

Jim Blandy's avatar
Jim Blandy committed
226
Lisp_Object
227
make_window (void)
Jim Blandy's avatar
Jim Blandy committed
228
{
229
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
230
  register struct window *p;
231

232
  p = allocate_window ();
233 234
  ++sequence_number;
  XSETFASTINT (p->sequence_number, sequence_number);
235 236 237 238
  XSETFASTINT (p->left_col, 0);
  XSETFASTINT (p->top_line, 0);
  XSETFASTINT (p->total_lines, 0);
  XSETFASTINT (p->total_cols, 0);
239
  XSETFASTINT (p->hscroll, 0);
240
  XSETFASTINT (p->min_hscroll, 0);
241
  p->orig_top_line = p->orig_total_lines = Qnil;
Jim Blandy's avatar
Jim Blandy committed
242 243
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
244
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
245
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
246 247
  p->display_table = Qnil;
  p->dedicated = Qnil;
248
  p->window_parameters = Qnil;
249
  p->pseudo_window_p = 0;
250 251 252
  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));
253
  p->desired_matrix = p->current_matrix = 0;
254
  p->nrows_scale_factor = p->ncols_scale_factor = 1;
255
  p->phys_cursor_type = -1;
256
  p->phys_cursor_width = -1;
257 258 259 260 261
  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;
262
  XSETWINDOW (val, p);
263
  XSETFASTINT (p->last_point, 0);
264
  p->frozen_window_start_p = 0;
265
  p->last_cursor_off_p = p->cursor_off_p = 0;
266 267 268 269 270 271 272
  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;
273
  p->resize_proportionally = Qnil;
Gerd Moellmann's avatar
Gerd Moellmann committed
274 275

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

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

286
DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
287 288 289
       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
290
  (Lisp_Object frame)
Jim Blandy's avatar
Jim Blandy committed
291
{
292
  if (NILP (frame))
293
    frame = selected_frame;
294
  CHECK_LIVE_FRAME (frame);
295
  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
Jim Blandy's avatar
Jim Blandy committed
296 297
}

Paul Eggert's avatar
Paul Eggert committed
298
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
299
       Swindow_minibuffer_p, 0, 1, 0,
300
       doc: /* Return non-nil if WINDOW is a minibuffer window.
Kenichi Handa's avatar
Kenichi Handa committed
301
WINDOW defaults to the selected window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
302
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
303 304
{
  struct window *w = decode_window (window);
305
  return MINI_WINDOW_P (w) ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
306 307 308
}


Paul Eggert's avatar
Paul Eggert committed
309
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
310
       Spos_visible_in_window_p, 0, 3, 0,
311
       doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
312 313 314
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.
315
If POS is only out of view because of horizontal scrolling, return non-nil.
316
If POS is t, it specifies the position of the last visible glyph in WINDOW.
317 318 319
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,
320 321 322 323
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
324
off-window at the top and bottom of the row, ROWH is the height of the
325
display row, and VPOS is the row number (0-based) containing POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
326
  (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
Jim Blandy's avatar
Jim Blandy committed
327 328
{
  register struct window *w;
329
  register EMACS_INT posint;
Jim Blandy's avatar
Jim Blandy committed
330
  register struct buffer *buf;
331
  struct text_pos top;
332
  Lisp_Object in_window = Qnil;
333
  int rtop, rbot, rowh, vpos, fully_p = 1;
334
  int x, y;
Jim Blandy's avatar
Jim Blandy committed
335

Miles Bader's avatar
Miles Bader committed
336 337 338 339
  w = decode_window (window);
  buf = XBUFFER (w->buffer);
  SET_TEXT_POS_FROM_MARKER (top, w->start);

340 341 342
  if (EQ (pos, Qt))
    posint = -1;
  else if (!NILP (pos))
Jim Blandy's avatar
Jim Blandy committed
343
    {
344
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
345 346
      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 353
  /* If position is above window start or outside buffer boundaries,
     or if window start is out of range, position is not visible.  */
354 355
  if ((EQ (pos, Qt)
       || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
356 357
      && CHARPOS (top) >= BUF_BEGV (buf)
      && CHARPOS (top) <= BUF_ZV (buf)
358
      && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
359
      && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
360 361 362
    in_window = Qt;

  if (!NILP (in_window) && !NILP (partially))
363 364 365 366 367 368 369 370 371
    {
      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));
    }

372
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
373
}
374

375
DEFUN ("window-line-height", Fwindow_line_height,
376
       Swindow_line_height, 0, 2, 0,
377 378 379
       doc: /* Return height in pixels of text line LINE in window WINDOW.
If WINDOW is nil or omitted, use selected window.

380 381 382 383
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.
384

385
Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
386
in pixels of the visible part of the line, VPOS and YPOS are the
387
vertical position in lines and pixels of the line, relative to the top
388
of the first text line, and OFFBOT is the number of off-window pixels at
389 390
the bottom of the text line.  If there are off-window pixels at the top
of the (first) text line, YPOS is negative.
391 392 393

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
394
  (Lisp_Object line, Lisp_Object window)
395 396 397 398
{
  register struct window *w;
  register struct buffer *b;
  struct glyph_row *row, *end_row;
399
  int max_y, crop, i, n;
400 401 402 403 404

  w = decode_window (window);

  if (noninteractive
      || w->pseudo_window_p)
405
    return Qnil;
406 407 408 409 410 411 412 413 414 415 416 417

  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;

418 419 420 421 422 423 424 425 426 427
  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;
    }

428
  if (EQ (line, Qheader_line))
429
    {
430 431 432
      if (!WINDOW_WANTS_HEADER_LINE_P (w))
	return Qnil;
      row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
433 434
      if (!row->enabled_p)
	return Qnil;
435 436 437
      return list4 (make_number (row->height),
		    make_number (0), make_number (0),
		    make_number (0));
438
    }
439 440

  if (EQ (line, Qmode_line))
441
    {
442 443 444 445 446 447 448 449 450
      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));
    }
451

452
  CHECK_NUMBER (line);
453
  n = XINT (line);
454 455 456 457

  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);
458
  i = 0;
459 460 461 462 463

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

465 466 467
  if (row > end_row || !row->enabled_p)
    return Qnil;

468
  if (++n < 0)
469 470 471
    {
      if (-n > i)
	return Qnil;
472 473
      row += n;
      i += n;
474 475
    }

476
 found_row:
477 478
  crop = max (0, (row->y + row->height) - max_y);
  return list4 (make_number (row->height + min (0, row->y) - crop),
479
		make_number (i),
480 481
		make_number (row->y),
		make_number (crop));
482 483
}

484

Jim Blandy's avatar
Jim Blandy committed
485 486

DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
487 488 489
       doc: /* Return the number of lines in WINDOW.
WINDOW defaults to the selected window.

490 491 492 493
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
494
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
495
{
Kenichi Handa's avatar
Kenichi Handa committed
496
  return decode_any_window (window)->total_lines;
Jim Blandy's avatar
Jim Blandy committed
497 498 499
}

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
500
       doc: /* Return the number of display columns in WINDOW.
501 502 503 504 505
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
506
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
507
{
Kenichi Handa's avatar
Kenichi Handa committed
508
  return make_number (window_box_text_cols (decode_any_window (window)));
Jim Blandy's avatar
Jim Blandy committed
509 510
}

511 512 513
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
514
  (Lisp_Object window)
515 516 517 518
{
  return WINDOW_FULL_WIDTH_P (decode_any_window (window)) ? Qt : Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
519
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
520 521
       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
522
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
523 524 525 526 527
{
  return decode_window (window)->hscroll;
}

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

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
532
window so that the location of point moves off-window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
533
  (Lisp_Object window, Lisp_Object ncol)
Jim Blandy's avatar
Jim Blandy committed
534
{
535 536
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
537

538
  CHECK_NUMBER (ncol);
539
  hscroll = max (0, XINT (ncol));
540

541 542
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
543
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
544

545
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
546 547 548
  return ncol;
}

549 550
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
551
       doc: /* Return WINDOW's redisplay end trigger value.
552
WINDOW defaults to the selected window.
553
See `set-window-redisplay-end-trigger' for more information.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
554
  (Lisp_Object window)
555 556 557 558 559 560
{
  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,
561 562 563 564 565 566
       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
567
  (register Lisp_Object window, Lisp_Object value)
568 569 570 571 572 573 574 575
{
  register struct window *w;

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

Jim Blandy's avatar
Jim Blandy committed
576
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
577
       doc: /* Return a list of the edge coordinates of WINDOW.
578 579 580 581 582 583 584 585 586
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
587
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
588
{
Kenichi Handa's avatar
Kenichi Handa committed
589
  register struct window *w = decode_any_window (window);
Jim Blandy's avatar
Jim Blandy committed
590

591 592 593 594 595
  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
596 597
}

598 599
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
600 601 602 603 604 605 606 607
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
608
  (Lisp_Object window)
609
{
Kenichi Handa's avatar
Kenichi Handa committed
610
  register struct window *w = decode_any_window (window);
611 612 613 614 615 616 617 618

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

619 620 621 622 623 624 625 626
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
627 628 629
#ifdef FRAME_TOOLBAR_TOP_HEIGHT
  *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
#elif FRAME_TOOLBAR_HEIGHT
630 631 632 633 634 635
  *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;
636 637 638
#ifdef FRAME_TOOLBAR_LEFT_WIDTH
  *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
#endif
639 640 641 642 643 644 645 646 647 648 649 650
}

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
651
of just the text area, use `window-inside-absolute-pixel-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
652
  (Lisp_Object window)
653 654 655
{
  register struct window *w = decode_any_window (window);
  int add_x, add_y;
656
  calc_absolute_offset (w, &add_x, &add_y);
657 658 659 660 661 662 663 664

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

665 666
DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
       doc: /* Return a list of the edge coordinates of WINDOW.
667 668 669 670 671 672 673 674
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
675
  (Lisp_Object window)
676
{
Kenichi Handa's avatar
Kenichi Handa committed
677
  register struct window *w = decode_any_window (window);
678 679 680 681 682 683

  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)),
684
		make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
685 686 687 688 689 690 691
			     - 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,
692
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
693 694 695 696 697 698
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,
699
display margins, fringes, header line, and/or mode line.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
700
  (Lisp_Object window)
701
{
Kenichi Handa's avatar
Kenichi Handa committed
702
  register struct window *w = decode_any_window (window);
703 704 705 706 707 708

  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)),
709
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
710 711 712 713 714 715
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

716 717 718 719 720 721 722 723 724 725 726
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
727
  (Lisp_Object window)
728 729 730
{
  register struct window *w = decode_any_window (window);
  int add_x, add_y;
731
  calc_absolute_offset (w, &add_x, &add_y);
732 733 734 735 736 737 738 739 740 741 742 743 744

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

745
/* Test if the character at column X, row Y is within window W.
746
   If it is not, return ON_NOTHING;
747
   if it is in the window's text area, return ON_TEXT;
748
   if it is on the window's modeline, return ON_MODE_LINE;
Jim Blandy's avatar
Jim Blandy committed
749
   if it is on the border between the window and its right sibling,
750
      return ON_VERTICAL_BORDER.
751
   if it is on a scroll bar, return ON_SCROLL_BAR.
752
   if it is on the window's top line, return ON_HEADER_LINE;
Kim F. Storm's avatar
Kim F. Storm committed
753
   if it is in left or right fringe of the window,
754
      return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
755
   if it is in the marginal area to the left/right of the window,
756
      return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
757 758 759

   X and Y are frame relative pixel coordinates.  */

760
static enum window_part
761
coordinates_in_window (register struct window *w, int x, int y)
Jim Blandy's avatar
Jim Blandy committed
762
{
763
  struct frame *f = XFRAME (WINDOW_FRAME (w));
764
  int left_x, right_x;
765
  enum window_part part;
766 767 768
  int ux = FRAME_COLUMN_WIDTH (f);
  int x0 = WINDOW_LEFT_EDGE_X (w);
  int x1 = WINDOW_RIGHT_EDGE_X (w);
769 770 771
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
772
  int lmargin_width, rmargin_width, text_left, text_right;
773 774 775 776 777 778
  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;
779

780 781
  /* 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.  */
782 783 784
  if (w->pseudo_window_p)
    {
      left_x = 0;
785
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
786 787 788
    }
  else
    {
789 790
      left_x = WINDOW_BOX_LEFT_EDGE_X (w);
      right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
791
    }
792

793 794 795 796 797
  /* 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.  */
798

799
  if (WINDOW_WANTS_MODELINE_P (w)
800
      && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
801
    {
802 803 804
      part = ON_MODE_LINE;

    header_vertical_border_check:
805 806
      /* We're somewhere on the mode line.  We consider the place
	 between mode lines of horizontally adjacent mode lines
807
	 as the vertical border.  If scroll bars on the left,
808
	 return the right window.  */
809 810 811 812 813 814 815 816 817 818 819 820 821 822
      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)
823 824
	return ON_NOTHING;

825
      return part;
826
    }
827 828

  if (WINDOW_WANTS_HEADER_LINE_P (w)
829
      && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
830
    {
831 832
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
833
    }
834

835
  if (x < x0 || x >= x1) return ON_NOTHING;
836

837
  /* Outside any interesting column?  */
838 839
  if (x < left_x || x > right_x)
    return ON_SCROLL_BAR;
840 841 842

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

844 845 846 847
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

  if (FRAME_WINDOW_P (f))
848
    {
849
      if (!w->pseudo_window_p
850
	  && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
851
	  && !WINDOW_RIGHTMOST_P (w)
852 853
	  && (eabs (x - right_x) < grabbable_width))
	return ON_VERTICAL_BORDER;
854
    }
855 856 857 858 859 860 861 862
  /* 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)
863 864 865
    {
      if (lmargin_width > 0
	  && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
866 867 868 869
	      ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
	      : (x < left_x + lmargin_width)))
	return ON_LEFT_MARGIN;

870 871 872
      return ON_LEFT_FRINGE;
    }

873
  if (x >= text_right)
874 875 876
    {
      if (rmargin_width > 0
	  && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
877 878 879 880
	      ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
	      : (x >= right_x - rmargin_width)))
	return ON_RIGHT_MARGIN;

881 882 883 884 885
      return ON_RIGHT_FRINGE;
    }

  /* Everything special ruled out - must be on text area */
  return ON_TEXT;
Jim Blandy's avatar
Jim Blandy committed
886 887
}

888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
/* 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;
}

925

Jim Blandy's avatar
Jim Blandy committed
926
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
927 928 929 930
       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.
931
\(0 . 0) denotes the character in the upper left corner of the
932 933 934 935 936
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
937 938
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.
939
If they are on the border between WINDOW and its right sibling,
940 941 942
  `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
943
  (register Lisp_Object coordinates, Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
944
{
945 946
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
947
  int x, y;
948
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
949

Kenichi Handa's avatar
Kenichi Handa committed
950
  CHECK_WINDOW (window);
951 952
  w = XWINDOW (window);
  f = XFRAME (w->frame);
953
  CHECK_CONS (coordinates);
954 955
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
956 957
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
958 959
  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);
960

961
  switch (coordinates_in_window (w, x, y))
Jim Blandy's avatar
Jim Blandy committed
962
    {
963
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
964 965
      return Qnil;

966
    case ON_TEXT:
967 968 969 970
      /* 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);
971 972
      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
973

974
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
975
      return Qmode_line;
976

977
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
978
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
979

980
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
981
      return Qheader_line;
982

983 984
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
985

986 987
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
988

989 990
    case ON_LEFT_MARGIN:
      return Qleft_margin;
991

992 993 994
    case ON_RIGHT_MARGIN:
      return Qright_margin;

995 996 997 998
    case ON_SCROLL_BAR:
      /* Historically we are supposed to return nil in this case.  */
      return Qnil;

Jim Blandy's avatar
Jim Blandy committed
999 1000 1001 1002 1003
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
1004 1005

/* Callback for foreach_window, used in window_from_coordinates.
1006 1007 1008 1009 1010
   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
1011
   *CW->part the part of the window under coordinates *X,*Y.  Return
1012 1013 1014 1015 1016
   zero from this function to stop iterating over windows.  */

struct check_window_data
{
  Lisp_Object *window;
1017
  int x, y;
1018
  enum window_part *part;
1019
};
Gerd Moellmann's avatar
Gerd Moellmann committed
1020 1021

static int
1022
check_window_containing (struct window *w, void *user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
1023
{
1024
  struct check_window_data *cw = (struct check_window_data *) user_data;
1025 1026
  enum window_part found;
  int continue_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
1027

1028
  found = coordinates_in_window (w, cw->x, cw->y);
1029
  if (found != ON_NOTHING)
Gerd Moellmann's avatar
Gerd Moellmann committed
1030
    {
1031
      *cw->part = found;
1032
      XSETWINDOW (*cw->window, w);
1033
      continue_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
1034
    }
1035

1036
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
1037 1038 1039
}


1040
/* Find the window containing frame-relative pixel position X/Y and
1041 1042 1043
   return it as a Lisp_Object.

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

1046
   If there is no window under X, Y return nil and leave *PART
Gerd Moellmann's avatar
Gerd Moellmann committed
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
   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.  */
1057

Jim Blandy's avatar
Jim Blandy committed
1058
Lisp_Object
1059 1060
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
1061
{
Gerd Moellmann's avatar
Gerd Moellmann committed
1062
  Lisp_Object window;