window.c 215 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-2012
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
#include "lisp.h"
26
#include "character.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "buffer.h"
28
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
29
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
30
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
31 32 33 34 35
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
36
#include "dispextern.h"
37 38
#include "blockinput.h"
#include "intervals.h"
39
#include "termhooks.h"		/* For FRAME_TERMINAL.  */
40

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

54
Lisp_Object Qwindowp, Qwindow_live_p;
Martin Rudalics's avatar
Martin Rudalics committed
55
static Lisp_Object Qwindow_configuration_p, Qrecord_window_buffer;
56
static Lisp_Object Qwindow_deletable_p, Qdelete_window, Qdisplay_buffer;
Martin Rudalics's avatar
Martin Rudalics committed
57
static Lisp_Object Qreplace_buffer_in_windows, Qget_mru_window;
58
static Lisp_Object Qwindow_resize_root_window, Qwindow_resize_root_window_vertically;
59
static Lisp_Object Qscroll_up, Qscroll_down, Qscroll_command;
Martin Rudalics's avatar
Martin Rudalics committed
60
static Lisp_Object Qsafe, Qabove, Qbelow;
61
static Lisp_Object Qauto_buffer_name, Qclone_of;
Martin Rudalics's avatar
Martin Rudalics committed
62

63 64 65 66
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);
67
static void window_scroll (Lisp_Object, EMACS_INT, int, int);
68 69 70 71 72 73 74 75 76 77 78
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
79
static void foreach_window (struct frame *,
80
				 int (* fn) (struct window *, void *),
Andreas Schwab's avatar
Andreas Schwab committed
81
                            void *);
82 83 84 85
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);
86 87
static int window_resize_check (struct window *, int);
static void window_resize_apply (struct window *, int);
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
/* Used by the function window_scroll_pixel_based */
127
static int window_scroll_pixel_based_preserve_x;
128
static int window_scroll_pixel_based_preserve_y;
129

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

140 141 142 143 144 145 146
  CHECK_LIVE_WINDOW (window);
  return XWINDOW (window);
}

static struct window *
decode_any_window (register Lisp_Object window)
{
147 148
  struct window *w;

149 150 151 152
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
153
  w = XWINDOW (window);
154 155
  /* The following test throws up every time a tooltip frame is displayed.  */
  /* CHECK_LIVE_FRAME (w->frame); */
156
  return w;
157
}
158

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

166
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
167
       doc: /* Return t if OBJECT is a live window and nil otherwise.
168 169
A live window is a window that displays a buffer.
Internal windows and deleted windows are not live.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
170
  (Lisp_Object object)
171
{
172
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
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.
178
If WINDOW is omitted or nil, it defaults to the selected window.  */)
179 180 181 182 183 184
  (Lisp_Object window)
{
  return decode_any_window (window)->frame;
}

DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
185 186
       doc: /* Return the root window of FRAME-OR-WINDOW.
If omitted, FRAME-OR-WINDOW defaults to the currently selected frame.
187 188
With a frame argument, return that frame's root window.
With a window argument, return the root window of that window's frame.  */)
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
  (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,
207 208
       doc: /* Return the minibuffer window for frame FRAME.
If FRAME is omitted or nil, it defaults to the selected frame.  */)
209 210 211 212 213 214 215 216 217 218 219
  (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.
220
If WINDOW is omitted or nil, it defaults to the selected window.  */)
221 222 223 224 225 226 227
  (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,
228 229 230 231
       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
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
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,
262 263 264 265
       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
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
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;
}

318 319
int window_select_count;

320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
/* 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))
    {
339
      w->use_time = ++window_select_count;
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
      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.  */
  {
386
    register ptrdiff_t new_point = marker_position (w->pointm);
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
    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.
407

408 409 410 411 412 413 414
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);
}

415
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
416 417 418
       doc: /* Return the buffer displayed in window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
Return nil for an internal window or a deleted window.  */)
419 420 421 422 423 424
  (Lisp_Object window)
{
  return decode_any_window (window)->buffer;
}

DEFUN ("window-parent", Fwindow_parent, Swindow_parent, 0, 1, 0,
425 426 427
       doc: /* Return the parent window of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
Return nil for a window with no parent (e.g. a root window).  */)
428 429 430 431 432
  (Lisp_Object window)
{
  return decode_any_window (window)->parent;
}

433 434 435 436 437
DEFUN ("window-top-child", Fwindow_top_child, Swindow_top_child, 1, 1, 0,
       doc: /* Return the topmost child window of window WINDOW.
Return nil if WINDOW is a live window (live windows have no children).
Return nil if WINDOW is an internal window whose children form a
horizontal combination.  */)
438 439
  (Lisp_Object window)
{
440
  CHECK_WINDOW (window);
441 442 443
  return decode_any_window (window)->vchild;
}

444 445 446 447 448
DEFUN ("window-left-child", Fwindow_left_child, Swindow_left_child, 1, 1, 0,
       doc: /* Return the leftmost child window of window WINDOW.
Return nil if WINDOW is a live window (live windows have no children).
Return nil if WINDOW is an internal window whose children form a
vertical combination.  */)
449 450
  (Lisp_Object window)
{
451
  CHECK_WINDOW (window);
452 453 454
  return decode_any_window (window)->hchild;
}

455
DEFUN ("window-next-sibling", Fwindow_next_sibling, Swindow_next_sibling, 0, 1, 0,
456 457
       doc: /* Return the next sibling window of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
458
Return nil if WINDOW has no next sibling.  */)
459 460 461 462 463
  (Lisp_Object window)
{
  return decode_any_window (window)->next;
}

464
DEFUN ("window-prev-sibling", Fwindow_prev_sibling, Swindow_prev_sibling, 0, 1, 0,
465 466
       doc: /* Return the previous sibling window of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
467
Return nil if WINDOW has no previous sibling.  */)
468 469 470 471
  (Lisp_Object window)
{
  return decode_any_window (window)->prev;
}
Gerd Moellmann's avatar
Gerd Moellmann committed
472

473
DEFUN ("window-combination-limit", Fwindow_combination_limit, Swindow_combination_limit, 1, 1, 0,
474
       doc: /* Return combination limit of window WINDOW.
475
If the return value is nil, child windows of WINDOW can be recombined with
476
WINDOW's siblings.  A return value of t means that child windows of
477 478
WINDOW are never \(re-)combined with WINDOW's siblings.  */)
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
479
{
480
  return decode_any_window (window)->combination_limit;
Jim Blandy's avatar
Jim Blandy committed
481
}
482

483
DEFUN ("set-window-combination-limit", Fset_window_combination_limit, Sset_window_combination_limit, 2, 2, 0,
484 485 486
       doc: /* Set combination limit of window WINDOW to LIMIT; return LIMIT.
If LIMIT is nil, child windows of WINDOW can be recombined with
WINDOW's siblings.  LIMIT t means that child windows of WINDOW are
487 488
never \(re-)combined with WINDOW's siblings.  Other values are reserved
for future use.  */)
489
  (Lisp_Object window, Lisp_Object limit)
490
{
491
  register struct window *w = decode_any_window (window);
492
  w->combination_limit = limit;
493
  return w->combination_limit;
494
}
495

496
DEFUN ("window-use-time", Fwindow_use_time, Swindow_use_time, 0, 1, 0,
497 498 499 500 501
       doc: /* Return the use time of window WINDOW.
If WINDOW is omitted or nil, it 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.  */)
502 503
  (Lisp_Object window)
{
504
  return make_number (decode_window (window)->use_time);
505
}
506

507 508
DEFUN ("window-total-height", Fwindow_total_height, Swindow_total_height, 0, 1, 0,
       doc: /* Return the total height, in lines, of window WINDOW.
509
If WINDOW is omitted or nil, it defaults to the selected window.
510

511 512 513
The return value includes the mode line and header line, if any.
If WINDOW is an internal window, the total height is the height
of the screen areas spanned by its children.
514

515 516 517
On a graphical display, this total height is reported as an
integer multiple of the default character height.  */)
  (Lisp_Object window)
518
{
519 520
  return decode_any_window (window)->total_lines;
}
521

522 523 524
DEFUN ("window-total-width", Fwindow_total_width, Swindow_total_width, 0, 1, 0,
       doc: /* Return the total width, in columns, of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
525

526 527 528
The return value includes any vertical dividers or scroll bars
belonging to WINDOW.  If WINDOW is an internal window, the total width
is the width of the screen areas spanned by its children.
529

530 531
On a graphical display, this total width is reported as an
integer multiple of the default character width.  */)
532 533
  (Lisp_Object window)
{
534
  return decode_any_window (window)->total_cols;
535
}
536

537
DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0,
538 539
       doc: /* Return the new total size of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.   */)
540 541 542 543 544 545
  (Lisp_Object window)
{
  return decode_any_window (window)->new_total;
}

DEFUN ("window-normal-size", Fwindow_normal_size, Swindow_normal_size, 0, 2, 0,
546 547 548
       doc: /* Return the normal height of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.
If HORIZONTAL is non-nil, return the normal width of WINDOW.  */)
549 550 551 552 553 554 555 556 557
  (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,
558 559
       doc: /* Return new normal size of window WINDOW.
If WINDOW is omitted or nil, it defaults to the selected window.  */)
560 561 562 563 564
  (Lisp_Object window)
{
  return decode_any_window (window)->new_normal;
}

565
DEFUN ("window-left-column", Fwindow_left_column, Swindow_left_column, 0, 1, 0,
566
       doc: /* Return left column of window WINDOW.
567 568 569 570
This is the distance, in columns, between the left edge of WINDOW and
the left edge of the frame's window area.  For instance, the return
value is 0 if there is no window to the left of WINDOW.

571
If WINDOW is omitted or nil, it defaults to the selected window.  */)
572 573 574 575 576 577
  (Lisp_Object window)
{
  return decode_any_window (window)->left_col;
}

DEFUN ("window-top-line", Fwindow_top_line, Swindow_top_line, 0, 1, 0,
578
       doc: /* Return top line of window WINDOW.
579 580 581 582
This is the distance, in lines, between the top of WINDOW and the top
of the frame's window area.  For instance, the return value is 0 if
there is no window above WINDOW.

583
If WINDOW is omitted or nil, it defaults to the selected window.  */)
584 585 586 587 588 589 590 591
  (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.  */

592
static int
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 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
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;
}

638 639 640 641
DEFUN ("window-body-height", Fwindow_body_height, Swindow_body_height, 0, 1, 0,
       doc: /* Return the height, in lines, of WINDOW's text area.
If WINDOW is omitted or nil, it defaults to the selected window.
Signal an error if the window is not live.
642

643 644 645 646 647 648
The returned height does not include the mode line or header line.
On a graphical display, the height is expressed as an integer multiple
of the default character height.  If a line at the bottom of the text
area is only partially visible, that counts as a whole line; to
exclude partially-visible lines, use `window-text-height'.  */)
  (Lisp_Object window)
649
{
650 651 652
  struct window *w = decode_window (window);
  return make_number (window_body_lines (w));
}
653

654 655 656 657 658 659 660 661 662 663 664 665
DEFUN ("window-body-width", Fwindow_body_width, Swindow_body_width, 0, 1, 0,
       doc: /* Return the width, in columns, of WINDOW's text area.
If WINDOW is omitted or nil, it defaults to the selected window.
Signal an error if the window is not live.

The return value does not include any vertical dividers, fringe or
marginal areas, or scroll bars.  On a graphical display, the width is
expressed as an integer multiple of the default character width.  */)
  (Lisp_Object window)
{
  struct window *w = decode_window (window);
  return make_number (window_body_cols (w));
666
}
667

Jim Blandy's avatar
Jim Blandy committed
668
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
669
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
670
WINDOW must be a live window and defaults to the selected one.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
671
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
672
{
673
  return make_number (decode_window (window)->hscroll);
Jim Blandy's avatar
Jim Blandy committed
674 675
}

676 677 678 679 680
/* Set W's horizontal scroll amount to HSCROLL clipped to a reasonable
   range, returning the new amount as a fixnum.  */
static Lisp_Object
set_window_hscroll (struct window *w, EMACS_INT hscroll)
{
681 682 683 684 685 686 687 688
  /* Horizontal scrolling has problems with large scroll amounts.
     It's too slow with long lines, and even with small lines the
     display can be messed up.  For now, though, impose only the limits
     required by the internal representation: horizontal scrolling must
     fit in fixnum (since it's visible to Elisp) and into ptrdiff_t
     (since it's stored in a ptrdiff_t).  */
  ptrdiff_t hscroll_max = min (MOST_POSITIVE_FIXNUM, PTRDIFF_MAX);
  ptrdiff_t new_hscroll = clip_to_bounds (0, hscroll, hscroll_max);
689 690 691 692 693 694 695 696 697

  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (w->hscroll != new_hscroll)
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;

  w->hscroll = new_hscroll;
  return make_number (new_hscroll);
}

Jim Blandy's avatar
Jim Blandy committed
698
DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
699
       doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
700
If WINDOW is nil, the selected window is used.
701 702
Clip the number to a reasonable value if out of range.
Return the new number.  NCOL should be zero or positive.
703 704

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
705
window so that the location of point moves off-window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
706
  (Lisp_Object window, Lisp_Object ncol)
Jim Blandy's avatar
Jim Blandy committed
707
{
708
  struct window *w = decode_window (window);
Jim Blandy's avatar
Jim Blandy committed
709

710
  CHECK_NUMBER (ncol);
711
  return set_window_hscroll (w, XINT (ncol));
Jim Blandy's avatar
Jim Blandy committed
712 713
}

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

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

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

756 757 758 759 760
  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
761 762
}

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

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

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

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

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

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

  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)),
849
		make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
850 851 852 853 854 855 856
			     - 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,
857 858 859
       doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
The list has the form (LEFT TOP RIGHT BOTTOM), all relative to (0,0)
at the top left corner of the frame's window area.
860 861 862 863

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,
864
display margins, fringes, header line, and/or mode line.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
865
  (Lisp_Object window)
866
{
867
  register struct window *w = decode_window (window);
868 869 870 871 872 873

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

881 882 883
DEFUN ("window-inside-absolute-pixel-edges",
       Fwindow_inside_absolute_pixel_edges,
       Swindow_inside_absolute_pixel_edges, 0, 1, 0,
884 885 886
       doc: /* Return a list of the edge pixel coordinates of WINDOW's text area.
The list has the form (LEFT TOP RIGHT BOTTOM), all relative to (0,0)
at the top left corner of the frame's window area.
887 888 889 890 891

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
892
  (Lisp_Object window)
893
{
894
  register struct window *w = decode_window (window);
895
  int add_x, add_y;
896
  calc_absolute_offset (w, &add_x, &add_y);
897 898 899 900 901 902 903 904 905 906 907 908 909

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

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

   X and Y are frame relative pixel coordinates.  */

925
static enum window_part
926
coordinates_in_window (register struct window *w, int x, int y)
Jim Blandy's avatar
Jim Blandy committed
927
{
928
  struct frame *f = XFRAME (WINDOW_FRAME (w));
929
  enum window_part part;
930
  int ux = FRAME_COLUMN_WIDTH (f);
931 932 933 934
  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);
935 936 937
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
938
  int lmargin_width, rmargin_width, text_left, text_right;
939

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

944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
  /* 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;
    }

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

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

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

988 989 990 991
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

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

1014 1015 1016
      return ON_LEFT_FRINGE;
    }

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

1025 1026 1027 1028 1029
      return ON_RIGHT_FRINGE;
    }

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

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
/* 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;
}

1069

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

1095
  CHECK_LIVE_WINDOW (window);
1096 1097
  w = XWINDOW (window);
  f = XFRAME (w->frame);
1098
  CHECK_CONS (coordinates);
1099 1100
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
1101 1102
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
1103 1104
  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);
1105

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

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

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

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

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

1128 1129
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
1130

1131 1132
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
1133

1134 1135
    case ON_LEFT_MARGIN:
      return Qleft_margin;
1136

1137 1138 1139
    case ON_RIGHT_MARGIN:
      return Qright_margin;

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
1149 1150

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

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

static int