window.c 229 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 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404

/* Frames and windows.  */
DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 1, 1, 0,
       doc: /* Return the frame that window WINDOW is on.
WINDOW can be any window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return decode_any_window (window)->frame;
}

DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
       doc: /* Return the root window of FRAME_OR_WINDOW.
If omitted, FRAME_OR_WINDOW defaults to the currently selected frame.
Else if FRAME_OR_WINDOW denotes any window, return the root window of
that window's frame.  If FRAME_OR_WINDOW denotes a live frame, return
the root window of that frame.  */)
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
    window = SELECTED_FRAME ()->root_window;
  else if (WINDOWP (frame_or_window))
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
      window = XFRAME (frame_or_window)->root_window;
    }

  return window;
}

DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
       doc: /* Return the window used now for minibuffers.
If the optional argument FRAME is specified, return the minibuffer window
used by that frame.  */)
  (Lisp_Object frame)
{
  if (NILP (frame))
    frame = selected_frame;
  CHECK_LIVE_FRAME (frame);
  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
}

DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
       Swindow_minibuffer_p, 0, 1, 0,
       doc: /* Return non-nil if WINDOW is a minibuffer window.
WINDOW can be any window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return MINI_WINDOW_P (decode_any_window (window)) ? Qt : Qnil;
}

/* Don't move this to window.el - this must be a safe routine.  */
DEFUN ("frame-first-window", Fframe_first_window, Sframe_first_window, 0, 1, 0,
       doc: /* Return the topmost, leftmost live window on FRAME_OR_WINDOW.
If omitted, FRAME_OR_WINDOW defaults to the currently selected frame.
Else if FRAME_OR_WINDOW denotes any window, return the first window of
that window's frame.  If FRAME_OR_WINDOW denotes a live frame, return
the first window of that frame.  */)
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
    window = SELECTED_FRAME ()->root_window;
  else if (WINDOWP (frame_or_window))
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->root_window;
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
      window = XFRAME (frame_or_window)->root_window;
    }

  while (NILP (XWINDOW (window)->buffer))
    {
      if (! NILP (XWINDOW (window)->hchild))
	window = XWINDOW (window)->hchild;
      else if (! NILP (XWINDOW (window)->vchild))
	window = XWINDOW (window)->vchild;
      else
	abort ();
    }

  return window;
}

DEFUN ("frame-selected-window", Fframe_selected_window,
       Sframe_selected_window, 0, 1, 0,
       doc: /* Return the selected window of FRAME_OR_WINDOW.
If omitted, FRAME_OR_WINDOW defaults to the currently selected frame.
Else if FRAME_OR_WINDOW denotes any window, return the selected window
of that window's frame.  If FRAME_OR_WINDOW denotes a live frame, return
the selected window of that frame.  */)
  (Lisp_Object frame_or_window)
{
  Lisp_Object window;

  if (NILP (frame_or_window))
    window = SELECTED_FRAME ()->selected_window;
  else if (WINDOWP (frame_or_window))
    window = XFRAME (WINDOW_FRAME (XWINDOW (frame_or_window)))->selected_window;
  else
    {
      CHECK_LIVE_FRAME (frame_or_window);
      window = XFRAME (frame_or_window)->selected_window;
    }

  return window;
}

DEFUN ("set-frame-selected-window", Fset_frame_selected_window,
       Sset_frame_selected_window, 2, 3, 0,
       doc: /* Set selected window of FRAME to WINDOW.
FRAME must be a live frame and defaults to the selected one.  If FRAME
is the selected frame, this makes WINDOW the selected window.  Optional
argument NORECORD non-nil means to neither change the order of recently
selected windows nor the buffer list.  WINDOW must denote a live window.
Return WINDOW.  */)
  (Lisp_Object frame, Lisp_Object window, Lisp_Object norecord)
{
  if (NILP (frame))
    frame = selected_frame;

  CHECK_LIVE_FRAME (frame);
  CHECK_LIVE_WINDOW (window);

  if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
    error ("In `set-frame-selected-window', WINDOW is not on FRAME");

  if (EQ (frame, selected_frame))
    return Fselect_window (window, norecord);
  else
    return XFRAME (frame)->selected_window = window;
}

DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
       doc: /* Return the selected window.
The selected window is the window in which the standard cursor for
selected windows appears and to which many commands apply.  */)
  (void)
{
  return selected_window;
}

/* If select_window is called with inhibit_point_swap non-zero it will
   not store point of the old selected window's buffer back into that
   window's pointm slot.  This is needed by Fset_window_configuration to
   avoid that the display routine is called with selected_window set to
   Qnil causing a subsequent crash.  */
static Lisp_Object
select_window (Lisp_Object window, Lisp_Object norecord, int inhibit_point_swap)
{
  register struct window *w;
  register struct window *ow;
  struct frame *sf;

  CHECK_LIVE_WINDOW (window);

  w = XWINDOW (window);
  w->frozen_window_start_p = 0;

  if (NILP (norecord))
    {
      ++window_select_count;
      XSETFASTINT (w->use_time, window_select_count);
      record_buffer (w->buffer);
    }

  if (EQ (window, selected_window) && !inhibit_point_swap)
    return window;

  sf = SELECTED_FRAME ();
  if (XFRAME (WINDOW_FRAME (w)) != sf)
    {
      XFRAME (WINDOW_FRAME (w))->selected_window = window;
      /* Use this rather than Fhandle_switch_frame
	 so that FRAME_FOCUS_FRAME is moved appropriately as we
	 move around in the state where a minibuffer in a separate
	 frame is active.  */
      Fselect_frame (WINDOW_FRAME (w), norecord);
      /* Fselect_frame called us back so we've done all the work already.  */
      eassert (EQ (window, selected_window));
      return window;
    }
  else
    sf->selected_window = window;

  /* Store the current buffer's actual point into the
     old selected window.  It belongs to that window,
     and when the window is not selected, must be in the window.  */
  if (!inhibit_point_swap)
    {
      ow = XWINDOW (selected_window);
      if (! NILP (ow->buffer))
	set_marker_both (ow->pointm, ow->buffer,
			 BUF_PT (XBUFFER (ow->buffer)),
			 BUF_PT_BYTE (XBUFFER (ow->buffer)));
    }

  selected_window = window;

  Fset_buffer (w->buffer);

  BVAR (XBUFFER (w->buffer), last_selected_window) = window;

  /* Go to the point recorded in the window.
     This is important when the buffer is in more
     than one window.  It also matters when
     redisplay_window has altered point after scrolling,
     because it makes the change only in the window.  */
  {
    register EMACS_INT new_point = marker_position (w->pointm);
    if (new_point < BEGV)
      SET_PT (BEGV);
    else if (new_point > ZV)
      SET_PT (ZV);
    else
      SET_PT (new_point);
  }

  windows_or_buffers_changed++;
  return window;
}

DEFUN ("select-window", Fselect_window, Sselect_window, 1, 2, 0,
       doc: /* Select WINDOW.  Most editing will apply to WINDOW's buffer.
Also make WINDOW's buffer current and make WINDOW the frame's selected
window.  Return WINDOW.

Optional second arg NORECORD non-nil means do not put this buffer at the
front of the buffer list and do not make this window the most recently
selected one.
405

406 407 408 409 410 411 412
Note that the main editor command loop sets the current buffer to the
buffer of the selected window before each command.  */)
  (register Lisp_Object window, Lisp_Object norecord)
{
  return select_window (window, norecord, 0);
}

413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
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
467
Lisp_Object
468
make_window (void)
Jim Blandy's avatar
Jim Blandy committed
469
{
470
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
471
  register struct window *p;
472

473
  p = allocate_window ();
474 475
  ++sequence_number;
  XSETFASTINT (p->sequence_number, sequence_number);
476 477 478 479
  XSETFASTINT (p->left_col, 0);
  XSETFASTINT (p->top_line, 0);
  XSETFASTINT (p->total_lines, 0);
  XSETFASTINT (p->total_cols, 0);
480
  XSETFASTINT (p->hscroll, 0);
481
  XSETFASTINT (p->min_hscroll, 0);
482
  p->orig_top_line = p->orig_total_lines = Qnil;
Jim Blandy's avatar
Jim Blandy committed
483 484
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
485
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
486
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
487 488
  p->display_table = Qnil;
  p->dedicated = Qnil;
489
  p->window_parameters = Qnil;
490
  p->pseudo_window_p = 0;
491 492 493
  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));
494
  p->desired_matrix = p->current_matrix = 0;
495
  p->nrows_scale_factor = p->ncols_scale_factor = 1;
496
  p->phys_cursor_type = -1;
497
  p->phys_cursor_width = -1;
498 499 500 501 502
  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;
503
  XSETWINDOW (val, p);
504
  XSETFASTINT (p->last_point, 0);
505
  p->frozen_window_start_p = 0;
506
  p->last_cursor_off_p = p->cursor_off_p = 0;
507 508 509 510 511 512 513
  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;
514
  p->resize_proportionally = Qnil;
Gerd Moellmann's avatar
Gerd Moellmann committed
515 516

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
517 518 519
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
520
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
521
       Spos_visible_in_window_p, 0, 3, 0,
522
       doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
523 524 525
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.
526
If POS is only out of view because of horizontal scrolling, return non-nil.
527
If POS is t, it specifies the position of the last visible glyph in WINDOW.
528 529 530
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,
531 532 533 534
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
535
off-window at the top and bottom of the row, ROWH is the height of the
536
display row, and VPOS is the row number (0-based) containing POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
537
  (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
Jim Blandy's avatar
Jim Blandy committed
538 539
{
  register struct window *w;
540
  register EMACS_INT posint;
Jim Blandy's avatar
Jim Blandy committed
541
  register struct buffer *buf;
542
  struct text_pos top;
543
  Lisp_Object in_window = Qnil;
544
  int rtop, rbot, rowh, vpos, fully_p = 1;
545
  int x, y;
Jim Blandy's avatar
Jim Blandy committed
546

Miles Bader's avatar
Miles Bader committed
547 548 549 550
  w = decode_window (window);
  buf = XBUFFER (w->buffer);
  SET_TEXT_POS_FROM_MARKER (top, w->start);

551 552 553
  if (EQ (pos, Qt))
    posint = -1;
  else if (!NILP (pos))
Jim Blandy's avatar
Jim Blandy committed
554
    {
555
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
556 557
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
558 559 560 561
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
562

563 564
  /* If position is above window start or outside buffer boundaries,
     or if window start is out of range, position is not visible.  */
565 566
  if ((EQ (pos, Qt)
       || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
567 568
      && CHARPOS (top) >= BUF_BEGV (buf)
      && CHARPOS (top) <= BUF_ZV (buf)
569
      && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
570
      && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
571 572 573
    in_window = Qt;

  if (!NILP (in_window) && !NILP (partially))
574 575 576 577 578 579 580 581 582
    {
      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));
    }

583
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
584
}
585

586
DEFUN ("window-line-height", Fwindow_line_height,
587
       Swindow_line_height, 0, 2, 0,
588 589 590
       doc: /* Return height in pixels of text line LINE in window WINDOW.
If WINDOW is nil or omitted, use selected window.

591 592 593 594
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.
595

596
Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
597
in pixels of the visible part of the line, VPOS and YPOS are the
598
vertical position in lines and pixels of the line, relative to the top
599
of the first text line, and OFFBOT is the number of off-window pixels at
600 601
the bottom of the text line.  If there are off-window pixels at the top
of the (first) text line, YPOS is negative.
602 603 604

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
605
  (Lisp_Object line, Lisp_Object window)
606 607 608 609
{
  register struct window *w;
  register struct buffer *b;
  struct glyph_row *row, *end_row;
610
  int max_y, crop, i, n;
611 612 613 614 615

  w = decode_window (window);

  if (noninteractive
      || w->pseudo_window_p)
616
    return Qnil;
617 618 619 620 621 622 623 624 625 626 627 628

  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;

629 630 631 632 633 634 635 636 637 638
  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;
    }

639
  if (EQ (line, Qheader_line))
640
    {
641 642 643
      if (!WINDOW_WANTS_HEADER_LINE_P (w))
	return Qnil;
      row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
644 645
      if (!row->enabled_p)
	return Qnil;
646 647 648
      return list4 (make_number (row->height),
		    make_number (0), make_number (0),
		    make_number (0));
649
    }
650 651

  if (EQ (line, Qmode_line))
652
    {
653 654 655 656 657 658 659 660 661
      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));
    }
662

663
  CHECK_NUMBER (line);
664
  n = XINT (line);
665 666 667 668

  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);
669
  i = 0;
670 671 672 673 674

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

676 677 678
  if (row > end_row || !row->enabled_p)
    return Qnil;

679
  if (++n < 0)
680 681 682
    {
      if (-n > i)
	return Qnil;
683 684
      row += n;
      i += n;
685 686
    }

687
 found_row:
688 689
  crop = max (0, (row->y + row->height) - max_y);
  return list4 (make_number (row->height + min (0, row->y) - crop),
690
		make_number (i),
691 692
		make_number (row->y),
		make_number (crop));
693
}
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715

DEFUN ("window-total-size", Fwindow_total_size, Swindow_total_size, 0, 2, 0,
       doc: /* Return the total number of lines of WINDOW.
WINDOW can be any window and defaults to the selected one.  The return
value includes WINDOW's mode line and header line, if any.  If WINDOW
is internal, the return value is the sum of the total number of lines
of WINDOW's child windows if these are vertically combined and the
height of WINDOW's first child otherwise.

Optional argument HORIZONTAL non-nil means return the total number of
columns of WINDOW.  In this case the return value includes any vertical
dividers or scrollbars of WINDOW.  If WINDOW is internal, the return
value is the sum of the total number of columns of WINDOW's child
windows if they are horizontally combined and the width of WINDOW's
first child otherwise.  */)
  (Lisp_Object window, Lisp_Object horizontal)
{
  if (NILP (horizontal))
    return decode_any_window (window)->total_lines;
  else
    return decode_any_window (window)->total_cols;
}
716

717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
       doc: /* Return left column of WINDOW.
WINDOW can be any window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return decode_any_window (window)->left_col;
}

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
       doc: /* Return top line of WINDOW.
WINDOW can be any window and defaults to the selected one.  */)
  (Lisp_Object window)
{
  return decode_any_window (window)->top_line;
}

/* Return the number of lines of W's body.  Don't count any mode or
   header line of W.  */

int
window_body_lines (struct window *w)
{
  int height = XFASTINT (w->total_lines);

  if (!MINI_WINDOW_P (w))
    {
      if (WINDOW_WANTS_MODELINE_P (w))
	--height;
      if (WINDOW_WANTS_HEADER_LINE_P (w))
	--height;
    }

  return height;
}

/* Return the number of columns of W's body.  Don't count columns
   occupied by the scroll bar or the vertical bar separating W from its
   right sibling.  On window-systems don't count fringes or display
   margins either.  */

int
window_body_cols (struct window *w)
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  int width = XINT (w->total_cols);

  if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
    /* Scroll bars occupy a few columns.  */
    width -= WINDOW_CONFIG_SCROLL_BAR_COLS (w);
  else if (!FRAME_WINDOW_P (f)
	   && !WINDOW_RIGHTMOST_P (w) && !WINDOW_FULL_WIDTH_P (w))
    /* The column of `|' characters separating side-by-side windows
       occupies one column only.  */
    width -= 1;

  if (FRAME_WINDOW_P (f))
    /* On window-systems, fringes and display margins cannot be
       used for normal text.  */
    width -= (WINDOW_FRINGE_COLS (w)
	      + WINDOW_LEFT_MARGIN_COLS (w)
	      + WINDOW_RIGHT_MARGIN_COLS (w));

  return width;
}

DEFUN ("window-body-size", Fwindow_body_size, Swindow_body_size, 0, 2, 0,
       doc: /* Return the number of lines of WINDOW's body.
WINDOW must be a live window and defaults to the selected one.  The
return value does not include WINDOW's mode line and header line, if
any.

Optional argument HORIZONTAL non-nil means return the number of columns
of WINDOW's body.  In this case, the return value does not include any
vertical dividers or scroll bars owned by WINDOW.  On a window-system
the return value does not include the number of columns used for
WINDOW's fringes or display margins either.  */)
  (Lisp_Object window, Lisp_Object horizontal)
{
  struct window *w = decode_any_window (window);

  if (NILP (horizontal))
    return make_number (window_body_lines (w));
  else
    return make_number (window_body_cols (w));
}
802

Jim Blandy's avatar
Jim Blandy committed
803
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
804 805
       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
806
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
807 808 809 810 811
{
  return decode_window (window)->hscroll;
}

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

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
816
window so that the location of point moves off-window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
817
  (Lisp_Object window, Lisp_Object ncol)
Jim Blandy's avatar
Jim Blandy committed
818
{
819 820
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
821

822
  CHECK_NUMBER (ncol);
823
  hscroll = max (0, XINT (ncol));
824

825 826
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
827
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
828

829
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
830 831 832
  return ncol;
}

833 834
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
835
       doc: /* Return WINDOW's redisplay end trigger value.
836
WINDOW defaults to the selected window.
837
See `set-window-redisplay-end-trigger' for more information.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
838
  (Lisp_Object window)
839 840 841 842 843 844
{
  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,
845 846 847 848 849 850
       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
851
  (register Lisp_Object window, Lisp_Object value)
852 853 854 855 856 857 858 859
{
  register struct window *w;

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

Jim Blandy's avatar
Jim Blandy committed
860
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
861
       doc: /* Return a list of the edge coordinates of WINDOW.
862 863 864 865 866 867 868 869 870
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
871
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
872
{
Kenichi Handa's avatar
Kenichi Handa committed
873
  register struct window *w = decode_any_window (window);
Jim Blandy's avatar
Jim Blandy committed
874

875 876 877 878 879
  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
880 881
}

882 883
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
884 885 886 887 888 889 890 891
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
892
  (Lisp_Object window)
893
{
Kenichi Handa's avatar
Kenichi Handa committed
894
  register struct window *w = decode_any_window (window);
895 896 897 898 899 900 901 902

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

903 904 905 906 907 908 909 910
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
911 912 913
#ifdef FRAME_TOOLBAR_TOP_HEIGHT
  *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
#elif FRAME_TOOLBAR_HEIGHT
914 915 916 917 918 919
  *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;
920 921 922
#ifdef FRAME_TOOLBAR_LEFT_WIDTH
  *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
#endif
923 924 925 926 927 928 929 930 931 932 933 934
}

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
935
of just the text area, use `window-inside-absolute-pixel-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
936
  (Lisp_Object window)
937 938 939
{
  register struct window *w = decode_any_window (window);
  int add_x, add_y;
940
  calc_absolute_offset (w, &add_x, &add_y);
941 942 943 944 945 946 947 948

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

949 950
DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
       doc: /* Return a list of the edge coordinates of WINDOW.
951 952 953 954 955 956 957 958
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
959
  (Lisp_Object window)
960
{
Kenichi Handa's avatar
Kenichi Handa committed
961
  register struct window *w = decode_any_window (window);
962 963 964 965 966 967

  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)),
968
		make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
969 970 971 972 973 974 975
			     - 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,
976
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
977 978 979 980 981 982
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,
983
display margins, fringes, header line, and/or mode line.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
984
  (Lisp_Object window)
985
{
Kenichi Handa's avatar
Kenichi Handa committed
986
  register struct window *w = decode_any_window (window);
987 988 989 990 991 992

  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)),
993
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
994 995 996 997 998 999
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
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
1011
  (Lisp_Object window)
1012 1013 1014
{
  register struct window *w = decode_any_window (window);
  int add_x, add_y;
1015
  calc_absolute_offset (w, &add_x, &add_y);
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028

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

1029
/* Test if the character at column X, row Y is within window W.
1030
   If it is not, return ON_NOTHING;
1031
   if it is in the window's text area, return ON_TEXT;
1032
   if it is on the window's modeline, return ON_MODE_LINE;
Jim Blandy's avatar
Jim Blandy committed
1033
   if it is on the border between the window and its right sibling,
1034
      return ON_VERTICAL_BORDER.
1035
   if it is on a scroll bar, return ON_SCROLL_BAR.
1036
   if it is on the window's top line, return ON_HEADER_LINE;
Kim F. Storm's avatar
Kim F. Storm committed
1037
   if it is in left or right fringe of the window,
1038
      return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
1039
   if it is in the marginal area to the left/right of the window,
1040
      return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
1041 1042 1043

   X and Y are frame relative pixel coordinates.  */

1044
static enum window_part
1045
coordinates_in_window (register struct window *w, int x, int y)
Jim Blandy's avatar
Jim Blandy committed
1046
{
1047
  struct frame *f = XFRAME (WINDOW_FRAME (w));
1048
  int left_x, right_x;
1049
  enum window_part part;
1050 1051 1052
  int ux = FRAME_COLUMN_WIDTH (f);
  int x0 = WINDOW_LEFT_EDGE_X (w);
  int x1 = WINDOW_RIGHT_EDGE_X (w);
1053 1054 1055
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
1056
  int lmargin_width, rmargin_width, text_left, text_right;
1057 1058 1059 1060 1061 1062
  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;
1063

1064 1065
  /* 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.  */
1066 1067 1068
  if (w->pseudo_window_p)
    {
      left_x = 0;
1069
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
1070 1071 1072
    }
  else
    {
1073 1074
      left_x = WINDOW_BOX_LEFT_EDGE_X (w);
      right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
1075
    }
1076

1077 1078 1079 1080 1081
  /* 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.  */
1082

1083
  if (WINDOW_WANTS_MODELINE_P (w)
1084
      && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
1085
    {
1086 1087 1088
      part = ON_MODE_LINE;

    header_vertical_border_check:
1089 1090
      /* We're somewhere on the mode line.  We consider the place
	 between mode lines of horizontally adjacent mode lines
1091
	 as the vertical border.  If scroll bars on the left,
1092
	 return the right window.  */
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
      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)
1107 1108
	return ON_NOTHING;

1109
      return part;
1110
    }
1111 1112

  if (WINDOW_WANTS_HEADER_LINE_P (w)
1113
      && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
1114
    {
1115 1116
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
1117
    }
1118

1119
  if (x < x0 || x >= x1) return ON_NOTHING;
1120

1121
  /* Outside any interesting column?  */
1122 1123
  if (x < left_x || x > right_x)
    return ON_SCROLL_BAR;
1124 1125 1126

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

1128 1129 1130 1131
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

  if (FRAME_WINDOW_P (f))
1132
    {
1133
      if (!w->pseudo_window_p
1134
	  && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
1135
	  && !WINDOW_RIGHTMOST_P (w)
1136 1137
	  && (eabs (x - right_x) < grabbable_width))
	return ON_VERTICAL_BORDER;
1138
    }
1139 1140 1141 1142 1143 1144 1145 1146
  /* 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)
1147 1148 1149
    {
      if (lmargin_width > 0
	  && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1150 1151 1152 1153
	      ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
	      : (x < left_x + lmargin_width)))
	return ON_LEFT_MARGIN;

1154 1155 1156
      return ON_LEFT_FRINGE;
    }

1157
  if (x >= text_right)
1158 1159 1160
    {
      if (rmargin_width > 0
	  && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1161 1162 1163 1164
	      ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
	      : (x >= right_x - rmargin_width)))
	return ON_RIGHT_MARGIN;

1165 1166 1167 1168 1169
      return ON_RIGHT_FRINGE;
    }

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

1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
/* 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;
}

1209

Jim Blandy's avatar
Jim Blandy committed
1210
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
1211 1212 1213 1214
       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.
1215