window.c 211 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
Lisp_Object Qwindowp, Qwindow_live_p;
Martin Rudalics's avatar
Martin Rudalics committed
54
static Lisp_Object Qwindow_configuration_p, Qrecord_window_buffer;
55
static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
Martin Rudalics's avatar
Martin Rudalics committed
56
static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
57
static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
58
static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
Martin Rudalics's avatar
Martin Rudalics committed
59 60 61
static Lisp_Object Qsafe, Qabove, Qbelow;
static Lisp_Object Qauto_buffer_name;

62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
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 freeze_window_start (struct window *, void *);
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
78
static void foreach_window (struct frame *,
79
				 int (* fn) (struct window *, void *),
Andreas Schwab's avatar
Andreas Schwab committed
80
                            void *);
81 82 83 84
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);
85 86
static int window_resize_check (struct window *, int);
static void window_resize_apply (struct window *, int);
Glenn Morris's avatar
Glenn Morris committed
87
static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
88

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

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

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

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

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

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

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

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

125
/* Used by the function window_scroll_pixel_based */
126
static int window_scroll_pixel_based_preserve_x;
127
static int window_scroll_pixel_based_preserve_y;
128

129 130 131
/* Same for window_scroll_line_based.  */
static int window_scroll_preserve_hpos;
static int window_scroll_preserve_vpos;
132 133 134 135 136 137

static struct window *
decode_window (register Lisp_Object window)
{
  if (NILP (window))
    return XWINDOW (selected_window);
138

139 140 141 142 143 144 145 146 147 148 149 150 151
  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);
}
152

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

160
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
161 162
       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
163
  (Lisp_Object object)
164
{
165
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
166
}
167 168 169 170 171 172 173 174 175 176 177

/* 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,
178 179 180 181
       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
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
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,
223 224 225 226
       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
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
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,
257 258 259 260
       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
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
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;
}

313 314
int window_select_count;

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
/* 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.
403

404 405 406 407 408 409 410
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);
}

411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
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;
}

429 430
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 0, 1, 0,
       doc: /* Return WINDOW's topmost child window.
431
WINDOW can be any window and defaults to the selected one.
432
Return nil if WINDOW is not a vertical combination.  */)
433 434 435 436 437
  (Lisp_Object window)
{
  return decode_any_window (window)->vchild;
}

438 439
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 0, 1, 0,
       doc: /* Return WINDOW's leftmost child window.
440
WINDOW can be any window and defaults to the selected one.
441
Return nil if WINDOW is not a horizontal combination.  */)
442 443 444 445 446
  (Lisp_Object window)
{
  return decode_any_window (window)->hchild;
}

447 448
DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
       doc: /* Return WINDOW's next sibling window.
449
WINDOW can be any window and defaults to the selected one.
450
Return nil if WINDOW has no next sibling.  */)
451 452 453 454 455
  (Lisp_Object window)
{
  return decode_any_window (window)->next;
}

456 457
DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
       doc: /* Return WINDOW's previous sibling window.
458
WINDOW can be any window and defaults to the selected one.
459
Return nil if WINDOW has no previous sibling.  */)
460 461 462 463
  (Lisp_Object window)
{
  return decode_any_window (window)->prev;
}
Gerd Moellmann's avatar
Gerd Moellmann committed
464

465 466 467
DEFUN ("window-splits", Fwindow_splits, Swindow_splits, 0, 1, 0,
       doc: /* Return splits status for WINDOW.
WINDOW can be any window and defaults to the selected one.
Jim Blandy's avatar
Jim Blandy committed
468

469 470 471 472
If the value returned by this function is nil and WINDOW is resized, the
corresponding space is preferably taken from (or given to) WINDOW's
right sibling.  When WINDOW is deleted, its space is given to its left
sibling.
473

474 475 476
If the value returned by this function is non-nil, resizing and deleting
WINDOW may resize all windows in the same combination.  */)
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
477
{
478
  return decode_any_window (window)->splits;
Jim Blandy's avatar
Jim Blandy committed
479
}
480

481 482 483 484
DEFUN ("set-window-splits", Fset_window_splits, Sset_window_splits, 2, 2, 0,
       doc: /* Set splits status of WINDOW to STATUS.
WINDOW can be any window and defaults to the selected one.  Return
STATUS.
485

486 487 488
If STATUS is nil and WINDOW is later resized, the corresponding space is
preferably taken from (or given to) WINDOW's right sibling.  When WINDOW
is deleted, its space is given to its left sibling.
489

490 491 492
If STATUS is non-nil, resizing and deleting WINDOW may resize all
windows in the same combination.  */)
  (Lisp_Object window, Lisp_Object status)
493
{
494
  register struct window *w = decode_any_window (window);
495

496
  w->splits = status;
497

498 499
  return w->splits;
}
500

501 502 503
DEFUN ("window-nest", Fwindow_nest, Swindow_nest, 0, 1, 0,
       doc: /* Return nest status of WINDOW.
WINDOW can be any window and defaults to the selected one.
504

505 506 507 508 509 510 511
If the return value is nil, subwindows of WINDOW can be recombined with
WINDOW's siblings.  A return value of non-nil means that subwindows of
WINDOW are never \(re-)combined with WINDOW's siblings.  */)
  (Lisp_Object window)
{
  return decode_any_window (window)->nest;
}
512

513 514 515 516
DEFUN ("set-window-nest", Fset_window_nest, Sset_window_nest, 2, 2, 0,
       doc: /* Set nest status of WINDOW to STATUS.
WINDOW can be any window and defaults to the selected one.  Return
STATUS.
517

518 519 520 521 522 523
If STATUS is nil, subwindows of WINDOW can be recombined with WINDOW's
siblings.  STATUS non-nil means that subwindows of WINDOW are never
\(re-)combined with WINDOW's siblings.  */)
  (Lisp_Object window, Lisp_Object status)
{
  register struct window *w = decode_any_window (window);
524

525
  w->nest = status;
526

527 528
  return w->nest;
}
529

530 531 532 533 534 535 536 537
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
       doc: /* Return WINDOW's use time.
WINDOW defaults to the selected window.  The window with the highest use
time is the most recently selected one.  The window with the lowest use
time is the least recently selected one.  */)
  (Lisp_Object window)
{
  return decode_window (window)->use_time;
538
}
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560

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;
}
561

562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
       doc: /* Return new total size of WINDOW.
WINDOW defaults to the selected window.   */)
  (Lisp_Object window)
{
  return decode_any_window (window)->new_total;
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
       doc: /* Return normal height of WINDOW.
WINDOW can be any window and defaults to the selected one.  Optional
argument HORIZONTAL non-nil means return normal width of WINDOW.  */)
  (Lisp_Object window, Lisp_Object horizontal)
{
  if (NILP (horizontal))
    return decode_any_window (window)->normal_lines;
  else
    return decode_any_window (window)->normal_cols;
}

DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0,
       doc: /* Return new normal size of WINDOW.
WINDOW can be any window and defaults to the selected one.   */)
  (Lisp_Object window)
{
  return decode_any_window (window)->new_normal;
}

590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
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.  */

609
static int
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
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,
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
       doc: /* Return the number of lines or columns of WINDOW's body.
WINDOW must be a live window and defaults to the selected one.

If the optional argument HORIZONTAL is omitted or nil, the function
returns the number of WINDOW's lines, excluding the mode line and
header line, if any.

If HORIZONTAL is non-nil, the function returns the number of columns
excluding any vertical dividers or scroll bars owned by WINDOW.  On a
window-system the return value also excludes the number of columns
used for WINDOW's fringes or display margins.

Note that the return value is measured in canonical units, i.e. for
the default frame's face.  If the window shows some characters with
non-default face, e.g., if the font of some characters is larger or
smaller than the default font, the value returned by this function
will not match the actual number of lines or characters per line
shown in the window.  To get the actual number of columns and lines,
use `posn-at-point'.  */)
675 676 677 678 679 680 681 682 683
  (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));
}
684

Jim Blandy's avatar
Jim Blandy committed
685
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
686
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
687
WINDOW must be a live window and defaults to the selected one.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
688
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
689 690 691 692 693
{
  return decode_window (window)->hscroll;
}

DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
694
       doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
695
If WINDOW is nil, the selected window is used.
696
Return NCOL.  NCOL should be zero or positive.
697 698

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
699
window so that the location of point moves off-window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
700
  (Lisp_Object window, Lisp_Object ncol)
Jim Blandy's avatar
Jim Blandy committed
701
{
702 703
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
704

705
  CHECK_NUMBER (ncol);
706
  hscroll = max (0, XINT (ncol));
707

708 709
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
710
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
711

712
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
713 714 715
  return ncol;
}

716 717
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
718
       doc: /* Return WINDOW's redisplay end trigger value.
719
WINDOW defaults to the selected window.
720
See `set-window-redisplay-end-trigger' for more information.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
721
  (Lisp_Object window)
722 723 724 725 726 727
{
  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,
728 729 730 731 732 733
       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
734
  (register Lisp_Object window, Lisp_Object value)
735 736 737 738 739 740 741 742
{
  register struct window *w;

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

Jim Blandy's avatar
Jim Blandy committed
743
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
744
       doc: /* Return a list of the edge coordinates of WINDOW.
745 746 747 748 749 750 751 752 753
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
754
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
755
{
Kenichi Handa's avatar
Kenichi Handa committed
756
  register struct window *w = decode_any_window (window);
Jim Blandy's avatar
Jim Blandy committed
757

758 759 760 761 762
  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
763 764
}

765 766
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
767 768 769 770 771 772 773 774
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
775
  (Lisp_Object window)
776
{
Kenichi Handa's avatar
Kenichi Handa committed
777
  register struct window *w = decode_any_window (window);
778 779 780 781 782 783 784 785

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

786
static void
Juanma Barranquero's avatar
Juanma Barranquero committed
787
calc_absolute_offset (struct window *w, int *add_x, int *add_y)
788 789 790 791 792 793
{
  struct frame *f = XFRAME (w->frame);
  *add_y = f->top_pos;
#ifdef FRAME_MENUBAR_HEIGHT
  *add_y += FRAME_MENUBAR_HEIGHT (f);
#endif
794 795 796
#ifdef FRAME_TOOLBAR_TOP_HEIGHT
  *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
#elif FRAME_TOOLBAR_HEIGHT
797 798 799 800 801 802
  *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;
803 804 805
#ifdef FRAME_TOOLBAR_LEFT_WIDTH
  *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
#endif
806 807 808 809 810 811 812 813 814 815 816 817
}

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
818
of just the text area, use `window-inside-absolute-pixel-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
819
  (Lisp_Object window)
820 821 822
{
  register struct window *w = decode_any_window (window);
  int add_x, add_y;
823
  calc_absolute_offset (w, &add_x, &add_y);
824 825 826 827 828 829 830 831

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

832 833
DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
       doc: /* Return a list of the edge coordinates of WINDOW.
834 835 836 837 838 839 840 841
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
842
  (Lisp_Object window)
843
{
Kenichi Handa's avatar
Kenichi Handa committed
844
  register struct window *w = decode_any_window (window);
845 846 847 848 849 850

  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)),
851
		make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
852 853 854 855 856 857 858
			     - 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,
859
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
860 861 862 863 864 865
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,
866
display margins, fringes, header line, and/or mode line.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
867
  (Lisp_Object window)
868
{
Kenichi Handa's avatar
Kenichi Handa committed
869
  register struct window *w = decode_any_window (window);
870 871 872 873 874 875

  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)),
876
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
877 878 879 880 881 882
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

883 884 885 886 887 888 889 890 891 892 893
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
894
  (Lisp_Object window)
895 896 897
{
  register struct window *w = decode_any_window (window);
  int add_x, add_y;
898
  calc_absolute_offset (w, &add_x, &add_y);
899 900 901 902 903 904 905 906 907 908 909 910 911

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

912
/* Test if the character at column X, row Y is within window W.
913
   If it is not, return ON_NOTHING;
914
   if it is in the window's text area, return ON_TEXT;
915
   if it is on the window's modeline, return ON_MODE_LINE;
Jim Blandy's avatar
Jim Blandy committed
916
   if it is on the border between the window and its right sibling,
917
      return ON_VERTICAL_BORDER.
918
   if it is on a scroll bar, return ON_SCROLL_BAR.
919
   if it is on the window's top line, return ON_HEADER_LINE;
Kim F. Storm's avatar
Kim F. Storm committed
920
   if it is in left or right fringe of the window,
921
      return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
922
   if it is in the marginal area to the left/right of the window,
923
      return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
924 925 926

   X and Y are frame relative pixel coordinates.  */

927
static enum window_part
928
coordinates_in_window (register struct window *w, int x, int y)
Jim Blandy's avatar
Jim Blandy committed
929
{
930
  struct frame *f = XFRAME (WINDOW_FRAME (w));
931
  enum window_part part;
932
  int ux = FRAME_COLUMN_WIDTH (f);
933 934 935 936
  int left_x = WINDOW_LEFT_EDGE_X (w);
  int right_x = WINDOW_RIGHT_EDGE_X (w);
  int top_y = WINDOW_TOP_EDGE_Y (w);
  int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
937 938 939
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
940
  int lmargin_width, rmargin_width, text_left, text_right;
941

942 943
  /* Outside any interesting row or column?  */
  if (y < top_y || y >= bottom_y || x < left_x || x >= right_x)
944
    return ON_NOTHING;
945

946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
  /* On the mode line or header line?   */
  if ((WINDOW_WANTS_MODELINE_P (w)
       && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
       && (part = ON_MODE_LINE))
      || (WINDOW_WANTS_HEADER_LINE_P (w)
	  && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
	  && (part = ON_HEADER_LINE)))
    {
      /* If it's under/over the scroll bar portion of the mode/header
	 line, say it's on the vertical line.  That's to be able to
	 resize windows horizontally in case we're using toolkit scroll
	 bars.  Note: If scrollbars are on the left, the window that
	 must be eventually resized is that on the left of WINDOW.  */
      if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
	   && !WINDOW_LEFTMOST_P (w)
	   && eabs (x - left_x) < grabbable_width)
	  || (!WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
	      && !WINDOW_RIGHTMOST_P (w)
	      && eabs (x - right_x) < grabbable_width))
	return ON_VERTICAL_BORDER;
      else
	return part;
    }

970 971
  /* 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.  */
972 973 974
  if (w->pseudo_window_p)
    {
      left_x = 0;
975
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
976 977 978
    }
  else
    {
979 980
      left_x = WINDOW_BOX_LEFT_EDGE_X (w);
      right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
981
    }
982

983
  /* Outside any interesting column?  */
984 985
  if (x < left_x || x > right_x)
    return ON_SCROLL_BAR;
986 987 988

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

990 991 992 993
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

  if (FRAME_WINDOW_P (f))
994
    {
995
      if (!w->pseudo_window_p
996
	  && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
997
	  && !WINDOW_RIGHTMOST_P (w)
998 999
	  && (eabs (x - right_x) < grabbable_width))
	return ON_VERTICAL_BORDER;
1000
    }
1001 1002 1003 1004 1005 1006 1007 1008
  /* 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)
1009 1010 1011
    {
      if (lmargin_width > 0
	  && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1012 1013 1014 1015
	      ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
	      : (x < left_x + lmargin_width)))
	return ON_LEFT_MARGIN;

1016 1017 1018
      return ON_LEFT_FRINGE;
    }

1019
  if (x >= text_right)
1020 1021 1022
    {
      if (rmargin_width > 0
	  && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1023 1024 1025 1026
	      ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
	      : (x >= right_x - rmargin_width)))
	return ON_RIGHT_MARGIN;

1027 1028 1029 1030 1031
      return ON_RIGHT_FRINGE;
    }

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

1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
/* 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;
}

1071

Jim Blandy's avatar
Jim Blandy committed
1072
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
1073 1074 1075 1076
       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.
1077
\(0 . 0) denotes the character in the upper left corner of the
1078 1079 1080 1081 1082
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
1083 1084
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.
1085
If they are on the border between WINDOW and its right sibling,
1086 1087 1088
  `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
1089
  (register Lisp_Object coordinates, Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
1090
{
1091 1092
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
1093
  int x, y;
1094
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
1095

Kenichi Handa's avatar
Kenichi Handa committed
1096
  CHECK_WINDOW (window);
1097 1098
  w = XWINDOW (window);
  f = XFRAME (w->frame);
1099
  CHECK_CONS (coordinates);
1100 1101
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
1102 1103
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
1104 1105
  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);
1106

1107
  switch (coordinates_in_window (w, x, y))
Jim Blandy's avatar
Jim Blandy committed
1108
    {
1109
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
1110 1111
      return Qnil;

1112
    case ON_TEXT:
1113 1114 1115 1116
      /* 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);
1117 1118
      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
1119

1120
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
1121
      return Qmode_line;
1122

1123
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
1124
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
1125

1126
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
1127
      return Qheader_line;
1128

1129 1130
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
1131

1132 1133
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
1134

1135 1136
    case ON_LEFT_MARGIN:
      return Qleft_margin;
1137

1138 1139 1140
    case ON_RIGHT_MARGIN:
      return Qright_margin;

1141 1142 1143 1144
    case ON_SCROLL_BAR:
      /* Historically we are supposed to return nil in this case.  */
      return Qnil;

Jim Blandy's avatar
Jim Blandy committed
1145 1146 1147 1148 1149
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
1150 1151

/* Callback for foreach_window, used in window_from_coordinates.
1152 1153 1154 1155 1156
   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
1157
   *CW->part the part of the window under coordinates *X,*Y.  Return
1158 1159 1160 1161 1162
   zero from this function to stop iterating over windows.  */

struct check_window_data
{
  Lisp_Object *window;
1163
  int x, y;
1164
  enum window_part *part;
1165
};
Gerd Moellmann's avatar
Gerd Moellmann committed
1166 1167

static int
1168
check_window_containing (struct window *w, void *user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
1169
{
1170
  struct check_window_data *cw = (struct check_window_data *) user_data;
1171 1172
  enum window_part found;
  int continue_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
1173

1174
  found = coordinates_in_window (w, cw->x, cw->y);
1175
  if (found != ON_NOTHING)
Gerd Moellmann's avatar
Gerd Moellmann committed
1176
    {
1177
      *cw->part = found;
1178
      XSETWINDOW (*cw->window, w);
1179
      continue_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
1180
    }
1181

1182
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
1183 1184 1185
}


1186
/* Find the window containing frame-relative pixel position X/Y and
1187 1188 1189
   return it as a Lisp_Object.

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

1192
   If there is no window under X, Y return nil and leave *PART
Gerd Moellmann's avatar
Gerd Moellmann committed
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
   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.  */
1203

Jim Blandy's avatar
Jim Blandy committed
1204
Lisp_Object
1205 1206
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
1207
{
Gerd Moellmann's avatar
Gerd Moellmann committed
1208
  Lisp_Object window;
1209
  struct check_window_data cw;
1210 1211 1212 1213
  enum window_part dummy;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
1215
  window = Qnil;
1216
  cw.window = &window, cw.x = x, cw.y = y; cw.part = part;
1217
  foreach_window (f, check_window_containing, &cw);
1218

Gerd Moellmann's avatar
Gerd Moellmann committed
1219 1220 1221 1222 1223
  /* If not found above, see if it's in the tool bar window, if a tool
     bar exists.  */
  if (NILP (window)
      && tool_bar_p
      && WINDOWP (f->tool_bar_window)
1224
      && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
1225
      && (coordinates_in_window (XWINDOW (f->tool_bar_window), x, y)
1226
	  != ON_NOTHING))
1227
    {
1228
      *part = ON_TEXT;
Gerd Moellmann's avatar
Gerd Moellmann committed
1229
      window = f->tool_bar_window;
1230
    }
1231

Gerd Moellmann's avatar
Gerd Moellmann committed
1232
  return window;
Jim Blandy's avatar
Jim Blandy committed
1233 1234
}

1235
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
1236
       doc: /* Return window containing coordinates X and Y on FRAME.
1237
FRAME must be a live frame and defaults to the selected one.
1238 1239
The top left corner of the frame is considered to be row 0,
column 0.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1240
  (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
Jim Blandy's avatar
Jim Blandy committed
1241
{
1242
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
1243

Jim Blandy's avatar
Jim Blandy committed
1244
  if (NILP (frame))
1245
    frame = selected_frame;
1246
  CHECK_LIVE_FRAME (frame);
1247
  f = XFRAME (frame);
Jim Blandy's avatar
Jim Blandy committed
1248

1249
  /* Check that arguments are integers or floats.  */
1250 1251
  CHECK_NUMBER_OR_FLOAT (x);
  CHECK_NUMBER_OR_FLOAT (y);
1252

1253
  return window_from_coordinates (f,
1254 1255 1256 1257
				  (FRAME_PIXEL_X_FROM_CANON_X (f, x)
				   + FRAME_INTERNAL_BORDER_WIDTH (f)),
				  (FRAME_PIXEL_Y_FROM_CANON_Y (f, y)
				   + FRAME_INTERNAL_BORDER_WIDTH (f)),
1258
				  0, 0);
Jim Blandy's avatar
Jim Blandy committed
1259 1260 1261
}

DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1262
       doc: /* Return current value of point in WINDOW.
1263
WINDOW must be a live window and defaults to the selected one.
1264

1265 1266 1267 1268 1269 1270 1