window.c 212 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 4
   Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 2000,
     2001, 2002, 2003, 2004, 2005  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
20 21
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22

23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25
#include "lisp.h"
#include "buffer.h"
26
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
27
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
29 30 31 32 33
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
34
#include "dispextern.h"
35 36 37
#include "blockinput.h"
#include "intervals.h"

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


52
Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
53
Lisp_Object Qwindow_size_fixed;
54
extern Lisp_Object Qleft_margin, Qright_margin;
Jim Blandy's avatar
Jim Blandy committed
55

56
static int displayed_window_lines P_ ((struct window *));
Andreas Schwab's avatar
Andreas Schwab committed
57
static struct window *decode_window P_ ((Lisp_Object));
58 59 60 61 62
static int count_windows P_ ((struct window *));
static int get_leaf_windows P_ ((struct window *, struct window **, int));
static void window_scroll P_ ((Lisp_Object, int, int, int));
static void window_scroll_pixel_based P_ ((Lisp_Object, int, int, int));
static void window_scroll_line_based P_ ((Lisp_Object, int, int, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
63
static int window_min_size_1 P_ ((struct window *, int));
64
static int window_min_size P_ ((struct window *, int, int, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
65
static void size_window P_ ((Lisp_Object, int, int, int));
66
static int freeze_window_start P_ ((struct window *, void *));
67
static int window_fixed_size_p P_ ((struct window *, int, int));
68
static void enlarge_window P_ ((Lisp_Object, int, int, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
69
static Lisp_Object window_list P_ ((void));
70
static int add_window_to_list P_ ((struct window *, void *));
71 72
static int candidate_window_p P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
				   Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
73 74 75 76
static Lisp_Object next_window P_ ((Lisp_Object, Lisp_Object,
				    Lisp_Object, int));
static void decode_next_window_args P_ ((Lisp_Object *, Lisp_Object *,
					 Lisp_Object *));
77 78 79
static int foreach_window_1 P_ ((struct window *,
				 int (* fn) (struct window *, void *),
				 void *));
80
static Lisp_Object window_list_1 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
81

Jim Blandy's avatar
Jim Blandy committed
82 83 84 85 86 87
/* 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
88
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
89 90 91

Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
92 93 94 95 96 97
/* 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;

98 99 100
/* 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
101
   the selected window.  */
102

Jim Blandy's avatar
Jim Blandy committed
103 104
Lisp_Object minibuf_window;

105 106 107
/* Non-nil means it is the window whose mode line should be
   shown as the selected window when the minibuffer is selected.  */

108
Lisp_Object minibuf_selected_window;
109

Jim Blandy's avatar
Jim Blandy committed
110
/* Non-nil means it is the window for C-M-v to scroll
111 112
   when the mini-buffer is selected.  */

Jim Blandy's avatar
Jim Blandy committed
113 114 115
Lisp_Object Vminibuf_scroll_window;

/* Non-nil means this is the buffer whose window C-M-v should scroll.  */
116

Jim Blandy's avatar
Jim Blandy committed
117 118 119
Lisp_Object Vother_window_scroll_buffer;

/* Non-nil means it's function to call to display temp buffers.  */
120

Jim Blandy's avatar
Jim Blandy committed
121 122
Lisp_Object Vtemp_buffer_show_function;

123 124 125 126 127
/* Non-zero means line and page scrolling on tall lines (with images)
   does partial scrolling by modifying window-vscroll.  */

int auto_window_vscroll_p;

128 129 130 131
/* Non-zero means to use mode-line-inactive face in all windows but the
   selected-window and the minibuffer-scroll-window when the
   minibuffer is active.  */
int mode_line_in_non_selected_windows;
132

Jim Blandy's avatar
Jim Blandy committed
133
/* If a window gets smaller than either of these, it is removed. */
134

135 136
EMACS_INT window_min_height;
EMACS_INT window_min_width;
Jim Blandy's avatar
Jim Blandy committed
137 138

/* Nonzero implies Fdisplay_buffer should create windows. */
139

Jim Blandy's avatar
Jim Blandy committed
140 141
int pop_up_windows;

Jim Blandy's avatar
Jim Blandy committed
142
/* Nonzero implies make new frames for Fdisplay_buffer.  */
143

Jim Blandy's avatar
Jim Blandy committed
144
int pop_up_frames;
Jim Blandy's avatar
Jim Blandy committed
145

146 147 148 149
/* Nonzero means reuse existing frames for displaying buffers.  */

int display_buffer_reuse_frames;

Jim Blandy's avatar
Jim Blandy committed
150
/* Non-nil means use this function instead of default */
151

Jim Blandy's avatar
Jim Blandy committed
152
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
153 154

/* Function to call to handle Fdisplay_buffer.  */
155

Jim Blandy's avatar
Jim Blandy committed
156 157
Lisp_Object Vdisplay_buffer_function;

158 159 160 161
/* Non-nil means that Fdisplay_buffer should even the heights of windows.  */

Lisp_Object Veven_window_heights;

162
/* List of buffer *names* for buffers that should have their own frames.  */
163

164 165 166
Lisp_Object Vspecial_display_buffer_names;

/* List of regexps for buffer names that should have their own frames.  */
167

168 169 170
Lisp_Object Vspecial_display_regexps;

/* Function to pop up a special frame.  */
171

172 173
Lisp_Object Vspecial_display_function;

174
/* List of buffer *names* for buffers to appear in selected window.  */
175

176 177 178
Lisp_Object Vsame_window_buffer_names;

/* List of regexps for buffer names to appear in selected window.  */
179

180 181
Lisp_Object Vsame_window_regexps;

182
/* Hook run at end of temp_output_buffer_show.  */
183

184 185
Lisp_Object Qtemp_buffer_show_hook;

186
/* Fdisplay_buffer always splits the largest window
Jim Blandy's avatar
Jim Blandy committed
187
   if that window is more than this high.  */
188

189
EMACS_INT split_height_threshold;
Jim Blandy's avatar
Jim Blandy committed
190 191

/* Number of lines of continuity in scrolling by screenfuls.  */
192

193
EMACS_INT next_screen_context_lines;
Jim Blandy's avatar
Jim Blandy committed
194 195

/* Incremented for each window created.  */
196

Jim Blandy's avatar
Jim Blandy committed
197 198
static int sequence_number;

199
/* Nonzero after init_window_once has finished.  */
200

201 202
static int window_initialized;

203
/* Hook to run when window config changes.  */
204

205 206 207
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

Kim F. Storm's avatar
Kim F. Storm committed
208
/* Non-nil means scroll commands try to put point
209 210
   at the same screen height as previously.  */

211 212 213
Lisp_Object Vscroll_preserve_screen_position;

#if 0 /* This isn't used anywhere.  */
214
/* Nonzero means we can split a frame even if it is "unsplittable".  */
215
static int inhibit_frame_unsplittable;
216
#endif /* 0 */
217

218
extern EMACS_INT scroll_margin;
219

220
extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
Jim Blandy's avatar
Jim Blandy committed
221 222

DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
223 224
       doc: /* Returns t if OBJECT is a window.  */)
     (object)
225
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
226
{
227
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
228 229
}

230
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
231
       doc: /* Returns t if OBJECT is a window which is currently visible.  */)
232 233
     (object)
     Lisp_Object object;
234
{
235
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
236 237
}

Jim Blandy's avatar
Jim Blandy committed
238 239 240
Lisp_Object
make_window ()
{
241
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
242
  register struct window *p;
243

244
  p = allocate_window ();
245 246
  ++sequence_number;
  XSETFASTINT (p->sequence_number, sequence_number);
247 248 249 250
  XSETFASTINT (p->left_col, 0);
  XSETFASTINT (p->top_line, 0);
  XSETFASTINT (p->total_lines, 0);
  XSETFASTINT (p->total_cols, 0);
251
  XSETFASTINT (p->hscroll, 0);
252
  XSETFASTINT (p->min_hscroll, 0);
253
  p->orig_top_line = p->orig_total_lines = Qnil;
Jim Blandy's avatar
Jim Blandy committed
254 255
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
256
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
257
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
258 259
  p->display_table = Qnil;
  p->dedicated = Qnil;
260 261 262 263 264
  p->pseudo_window_p = 0;
  bzero (&p->cursor, sizeof (p->cursor));
  bzero (&p->last_cursor, sizeof (p->last_cursor));
  bzero (&p->phys_cursor, sizeof (p->phys_cursor));
  p->desired_matrix = p->current_matrix = 0;
265
  p->nrows_scale_factor = p->ncols_scale_factor = 1;
266
  p->phys_cursor_type = -1;
267
  p->phys_cursor_width = -1;
268 269 270 271 272
  p->must_be_updated_p = 0;
  XSETFASTINT (p->window_end_vpos, 0);
  XSETFASTINT (p->window_end_pos, 0);
  p->window_end_valid = Qnil;
  p->vscroll = 0;
273
  XSETWINDOW (val, p);
274
  XSETFASTINT (p->last_point, 0);
275
  p->frozen_window_start_p = 0;
276 277
  p->height_fixed_p = 0;
  p->last_cursor_off_p = p->cursor_off_p = 0;
278 279 280 281 282 283 284
  p->left_margin_cols = Qnil;
  p->right_margin_cols = Qnil;
  p->left_fringe_width = Qnil;
  p->right_fringe_width = Qnil;
  p->fringes_outside_margins = Qnil;
  p->scroll_bar_width = Qnil;
  p->vertical_scroll_bar_type = Qt;
Gerd Moellmann's avatar
Gerd Moellmann committed
285 286

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
287 288 289 290
  return val;
}

DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
291 292
       doc: /* Return the window that the cursor now appears in and commands apply to.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
293 294 295 296
{
  return selected_window;
}

297
DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
298 299 300 301
       doc: /* Return the window used now for minibuffers.
If the optional argument FRAME is specified, return the minibuffer window
used by that frame.  */)
     (frame)
302
    Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
303
{
304
  if (NILP (frame))
305
    frame = selected_frame;
306
  CHECK_LIVE_FRAME (frame);
307
  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
Jim Blandy's avatar
Jim Blandy committed
308 309
}

310
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
311 312
       doc: /* Returns non-nil if WINDOW is a minibuffer window.
WINDOW defaults to the selected window.  */)
313
     (window)
Jim Blandy's avatar
Jim Blandy committed
314 315 316
     Lisp_Object window;
{
  struct window *w = decode_window (window);
317
  return MINI_WINDOW_P (w) ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
318 319 320
}


Jim Blandy's avatar
Jim Blandy committed
321
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
322
       Spos_visible_in_window_p, 0, 3, 0,
323
       doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
324 325 326
Return nil if that position is scrolled vertically out of view.
If a character is only partially visible, nil is returned, unless the
optional argument PARTIALLY is non-nil.
327
If POS is only out of view because of horizontal scrolling, return non-nil.
328 329 330
POS defaults to point in WINDOW; WINDOW defaults to the selected window.

If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
331 332 333 334
return value is a list (X Y PARTIAL) where X and Y are the pixel coordinates
relative to the top left corner of the window. PARTIAL is nil if the character
after POS is fully visible; otherwise it is a cons (RTOP . RBOT) where RTOP
and RBOT are the number of pixels invisible at the top and bottom of the row.  */)
335
     (pos, window, partially)
336
     Lisp_Object pos, window, partially;
Jim Blandy's avatar
Jim Blandy committed
337 338 339 340
{
  register struct window *w;
  register int posint;
  register struct buffer *buf;
341
  struct text_pos top;
342
  Lisp_Object in_window = Qnil;
343
  int rtop, rbot, fully_p = 1;
344
  int x, y;
Jim Blandy's avatar
Jim Blandy committed
345

Miles Bader's avatar
Miles Bader committed
346 347 348 349 350
  w = decode_window (window);
  buf = XBUFFER (w->buffer);
  SET_TEXT_POS_FROM_MARKER (top, w->start);

  if (!NILP (pos))
Jim Blandy's avatar
Jim Blandy committed
351
    {
352
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
353 354
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
355 356 357 358
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
359

360 361 362 363 364 365
  /* If position is above window start or outside buffer boundaries,
     or if window start is out of range, position is not visible.  */
  if (posint >= CHARPOS (top)
      && posint <= BUF_ZV (buf)
      && CHARPOS (top) >= BUF_BEGV (buf)
      && CHARPOS (top) <= BUF_ZV (buf)
366 367
      && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, NILP (partially))
      && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
368 369 370 371 372
    in_window = Qt;

  if (!NILP (in_window) && !NILP (partially))
    in_window = Fcons (make_number (x),
		       Fcons (make_number (y),
373 374 375 376
			      Fcons ((fully_p ? Qnil
				     : Fcons (make_number (rtop),
					      make_number (rbot))),
				     Qnil)));
377
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
378
}
379

Jim Blandy's avatar
Jim Blandy committed
380 381 382 383 384

static struct window *
decode_window (window)
     register Lisp_Object window;
{
Jim Blandy's avatar
Jim Blandy committed
385
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
386 387
    return XWINDOW (selected_window);

388
  CHECK_LIVE_WINDOW (window);
Jim Blandy's avatar
Jim Blandy committed
389 390 391
  return XWINDOW (window);
}

392 393 394 395 396 397 398 399 400 401 402
static struct window *
decode_any_window (window)
     register Lisp_Object window;
{
  if (NILP (window))
    return XWINDOW (selected_window);

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

Jim Blandy's avatar
Jim Blandy committed
403
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
404 405
       doc: /* Return the buffer that WINDOW is displaying.
WINDOW defaults to the selected window.  */)
406
     (window)
Jim Blandy's avatar
Jim Blandy committed
407 408 409 410 411 412
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
413 414
       doc: /* Return the number of lines in WINDOW (including its mode line).  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
415 416
     Lisp_Object window;
{
417
  return decode_any_window (window)->total_lines;
Jim Blandy's avatar
Jim Blandy committed
418 419 420
}

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
421 422 423 424 425
       doc: /* Return the number of display columns in WINDOW.
This is the width that is usable columns available for text in WINDOW.
If you want to find out how many columns WINDOW takes up,
use  (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))).  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
426 427
     Lisp_Object window;
{
428
  return make_number (window_box_text_cols (decode_any_window (window)));
Jim Blandy's avatar
Jim Blandy committed
429 430 431
}

DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
432 433
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
434 435 436 437 438 439
     Lisp_Object window;
{
  return decode_window (window)->hscroll;
}

DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
440
       doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
441
Return NCOL.  NCOL should be zero or positive.
442 443 444

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
window so that the location of point becomes invisible.  */)
445
     (window, ncol)
446
     Lisp_Object window, ncol;
Jim Blandy's avatar
Jim Blandy committed
447
{
448 449
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
450

451
  CHECK_NUMBER (ncol);
452
  hscroll = max (0, XINT (ncol));
453

454 455
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
456
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
457

458
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
459 460 461
  return ncol;
}

462 463
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
464 465 466
       doc: /* Return WINDOW's redisplay end trigger value.
See `set-window-redisplay-end-trigger' for more information.  */)
     (window)
467 468 469 470 471 472 473
     Lisp_Object window;
{
  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,
474 475 476 477 478 479 480
       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.  */)
     (window, value)
481 482 483 484 485 486 487 488 489
     register Lisp_Object window, value;
{
  register struct window *w;

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

Jim Blandy's avatar
Jim Blandy committed
490
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
491 492
       doc: /* Return a list of the edge coordinates of WINDOW.
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
493 494 495 496 497
RIGHT is one more than the rightmost column occupied by WINDOW,
and BOTTOM is one more than the bottommost row occupied by WINDOW.
The edges include the space used by the window's scroll bar,
display margins, fringes, header line, and mode line, if it has them.
To get the edges of the actual text area, use `window-inside-edges'.  */)
498
     (window)
Jim Blandy's avatar
Jim Blandy committed
499 500
     Lisp_Object window;
{
501
  register struct window *w = decode_any_window (window);
Jim Blandy's avatar
Jim Blandy committed
502

503 504 505 506 507
  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
508 509
}

510 511 512 513 514 515 516 517 518 519 520
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
RIGHT is one more than the rightmost x position occupied by WINDOW,
and BOTTOM is one more than the bottommost y position occupied by WINDOW.
The pixel edges include the space used by the window's scroll bar,
display margins, fringes, header line, and mode line, if it has them.
To get the edges of the actual text area, use `window-inside-pixel-edges'.  */)
     (window)
     Lisp_Object window;
{
521
  register struct window *w = decode_any_window (window);
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539

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

DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
       doc: /* Return a list of the edge coordinates of WINDOW.
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
RIGHT is one more than the rightmost column used by text in WINDOW,
and BOTTOM is one more than the bottommost row used by text in WINDOW.
The inside edges do not include the space used by the window's scroll bar,
display margins, fringes, header line, and/or mode line.  */)
     (window)
     Lisp_Object window;
{
540
  register struct window *w = decode_any_window (window);
541 542 543 544 545 546 547 548 549 550 551 552 553 554

  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)),
		make_number (WINDOW_RIGHT_EDGE_COL (w)
			     - 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,
555
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
556 557 558 559 560 561 562 563
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
RIGHT is one more than the rightmost x position used by text in WINDOW,
and BOTTOM is one more than the bottommost y position used by text in WINDOW.
The inside edges do not include the space used by the window's scroll bar,
display margins, fringes, header line, and/or mode line.  */)
     (window)
     Lisp_Object window;
{
564
  register struct window *w = decode_any_window (window);
565 566 567 568 569 570 571 572 573 574 575 576 577

  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)),
		make_number (WINDOW_RIGHT_EDGE_X (w)
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

578
/* Test if the character at column *X, row *Y is within window W.
579
   If it is not, return ON_NOTHING;
Jim Blandy's avatar
Jim Blandy committed
580 581 582
   if it is in the window's text area,
      set *x and *y to its location relative to the upper left corner
         of the window, and
583 584
      return ON_TEXT;
   if it is on the window's modeline, return ON_MODE_LINE;
Jim Blandy's avatar
Jim Blandy committed
585
   if it is on the border between the window and its right sibling,
586
      return ON_VERTICAL_BORDER.
587 588
   if it is on a scroll bar,
      return ON_SCROLL_BAR.
589
   if it is on the window's top line, return ON_HEADER_LINE;
Kim F. Storm's avatar
Kim F. Storm committed
590
   if it is in left or right fringe of the window,
591 592
      return ON_LEFT_FRINGE or ON_RIGHT_FRINGE, and convert *X and *Y
      to window-relative coordinates;
593
   if it is in the marginal area to the left/right of the window,
594 595
      return ON_LEFT_MARGIN or ON_RIGHT_MARGIN, and convert *X and *Y
      to window-relative coordinates.
596 597 598

   X and Y are frame relative pixel coordinates.  */

599
static enum window_part
Jim Blandy's avatar
Jim Blandy committed
600 601 602 603
coordinates_in_window (w, x, y)
     register struct window *w;
     register int *x, *y;
{
604 605
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  int left_x, right_x, top_y, bottom_y;
606
  enum window_part part;
607 608 609
  int ux = FRAME_COLUMN_WIDTH (f);
  int x0 = WINDOW_LEFT_EDGE_X (w);
  int x1 = WINDOW_RIGHT_EDGE_X (w);
610 611 612
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
613
  int lmargin_width, rmargin_width, text_left, text_right;
614

615 616
  /* 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.  */
617 618 619
  if (w->pseudo_window_p)
    {
      left_x = 0;
620 621 622
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
      top_y = WINDOW_TOP_EDGE_Y (w);
      bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
623 624 625
    }
  else
    {
626 627 628 629
      left_x = WINDOW_BOX_LEFT_EDGE_X (w);
      right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
      top_y = WINDOW_TOP_EDGE_Y (w);
      bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
630
    }
631

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

636 637 638 639 640
  /* On the mode line or header line?  If it's near the start of
     the mode or header line of window that's has a horizontal
     sibling, say it's on the vertical line.  That's to be able
     to resize windows horizontally in case we're using toolkit
     scroll bars.  */
641

642
  if (WINDOW_WANTS_MODELINE_P (w)
643
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
644
    {
645 646 647
      part = ON_MODE_LINE;

    header_vertical_border_check:
648 649 650 651
      /* We're somewhere on the mode line.  We consider the place
	 between mode lines of horizontally adjacent mode lines
	 as the vertical border.    If scroll bars on the left,
	 return the right window.  */
652 653
      if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
	  || WINDOW_RIGHTMOST_P (w))
654
	{
655 656
	  if (!WINDOW_LEFTMOST_P (w) && abs (*x - x0) < grabbable_width)
	    return ON_VERTICAL_BORDER;
657
	}
658
      else
659
	{
660 661
	  if (abs (*x - x1) < grabbable_width)
	    return ON_VERTICAL_BORDER;
662
	}
663

664 665 666
      if (*x < x0 || *x >= x1)
	return ON_NOTHING;

667 668 669 670
      /* Convert X and Y to window relative coordinates.
	 Mode line starts at left edge of window.  */
      *x -= x0;
      *y -= top_y;
671
      return part;
672
    }
673 674 675

  if (WINDOW_WANTS_HEADER_LINE_P (w)
      && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
676
    {
677 678
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
679
    }
680

681 682 683
  if (*x < x0 || *x >= x1)
    return ON_NOTHING;

684 685
  /* Outside any interesting column?  */
  if (*x < left_x || *x > right_x)
686
    return ON_SCROLL_BAR;
687 688 689

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

691 692 693 694
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

  if (FRAME_WINDOW_P (f))
695
    {
696
      if (!w->pseudo_window_p
697
	  && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
698
	  && !WINDOW_RIGHTMOST_P (w)
699 700
	  && (abs (*x - right_x) < grabbable_width))
	return ON_VERTICAL_BORDER;
701
    }
702 703 704 705
  else
    {
      /* Need to say "*x > right_x" rather than >=, since on character
	 terminals, the vertical line's x coordinate is right_x.  */
706 707 708
      if (!w->pseudo_window_p
	  && !WINDOW_RIGHTMOST_P (w)
	  && *x > right_x - ux)
709 710 711
	{
	  /* On the border on the right side of the window?  Assume that
	     this area begins at RIGHT_X minus a canonical char width.  */
712
	  return ON_VERTICAL_BORDER;
713
	}
714
    }
715

716 717 718 719 720 721
  if (*x < text_left)
    {
      if (lmargin_width > 0
	  && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
	      ? (*x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
	      : (*x < left_x + lmargin_width)))
722
	{
723
	  *x -= left_x;
724 725 726 727 728
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_LEFT_MARGIN;
	}
729 730 731 732 733 734 735 736 737 738 739 740 741

      /* Convert X and Y to window-relative pixel coordinates.  */
      *x -= left_x;
      *y -= top_y;
      return ON_LEFT_FRINGE;
    }

  if (*x >= text_right)
    {
      if (rmargin_width > 0
	  && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
	      ? (*x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
	      : (*x >= right_x - rmargin_width)))
742 743 744 745 746 747 748
	{
	  *x -= right_x;
	  if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_RIGHT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_RIGHT_MARGIN;
	}
749 750 751 752 753 754 755 756 757 758 759

      /* Convert X and Y to window-relative pixel coordinates.  */
      *x -= left_x + WINDOW_LEFT_FRINGE_WIDTH (w);
      *y -= top_y;
      return ON_RIGHT_FRINGE;
    }

  /* Everything special ruled out - must be on text area */
  *x -= left_x + WINDOW_LEFT_FRINGE_WIDTH (w);
  *y -= top_y;
  return ON_TEXT;
Jim Blandy's avatar
Jim Blandy committed
760 761
}

762

Jim Blandy's avatar
Jim Blandy committed
763
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
764 765 766 767 768 769 770 771 772 773
       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.
\(0 .  0) denotes the character in the upper left corner of the
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
774 775
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.
776
If they are on the border between WINDOW and its right sibling,
777 778 779
  `vertical-line' is returned.
If they are in the windows's left or right marginal areas, `left-margin'\n\
  or `right-margin' is returned.  */)
780
     (coordinates, window)
Jim Blandy's avatar
Jim Blandy committed
781 782
     register Lisp_Object coordinates, window;
{
783 784
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
785
  int x, y;
786
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
787

788
  CHECK_WINDOW (window);
789 790
  w = XWINDOW (window);
  f = XFRAME (w->frame);
791
  CHECK_CONS (coordinates);
792 793
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
794 795
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
796 797
  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);
798 799

  switch (coordinates_in_window (w, &x, &y))
Jim Blandy's avatar
Jim Blandy committed
800
    {
801
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
802 803
      return Qnil;

804 805 806
    case ON_TEXT:
      /* X and Y are now window relative pixel coordinates.  Convert
	 them to canonical char units before returning them.  */
807 808
      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
809

810
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
811
      return Qmode_line;
812

813
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
814
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
815

816
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
817
      return Qheader_line;
818

819 820
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
821

822 823
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
824

825 826
    case ON_LEFT_MARGIN:
      return Qleft_margin;
827

828 829 830
    case ON_RIGHT_MARGIN:
      return Qright_margin;

831 832 833 834
    case ON_SCROLL_BAR:
      /* Historically we are supposed to return nil in this case.  */
      return Qnil;

Jim Blandy's avatar
Jim Blandy committed
835 836 837 838 839
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
840 841

/* Callback for foreach_window, used in window_from_coordinates.
842 843 844 845 846
   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
847
   *CW->part the part of the window under coordinates *X,*Y.  Return
848 849 850 851 852
   zero from this function to stop iterating over windows.  */

struct check_window_data
{
  Lisp_Object *window;
853 854
  int *x, *y;
  enum window_part *part;
855
};
Gerd Moellmann's avatar
Gerd Moellmann committed
856 857

static int
858
check_window_containing (w, user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
859
     struct window *w;
860
     void *user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
861
{
862
  struct check_window_data *cw = (struct check_window_data *) user_data;
863 864
  enum window_part found;
  int continue_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
865

866
  found = coordinates_in_window (w, cw->x, cw->y);
867
  if (found != ON_NOTHING)
Gerd Moellmann's avatar
Gerd Moellmann committed
868
    {
869
      *cw->part = found;
870
      XSETWINDOW (*cw->window, w);
871
      continue_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
872
    }
873

874
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
875 876 877
}


878
/* Find the window containing frame-relative pixel position X/Y and
879 880 881 882 883 884
   return it as a Lisp_Object.

   If X, Y is on one of the window's special `window_part' elements,
   set *PART to the id of that element, and return X and Y converted
   to window relative coordinates in WX and WY.

885
   If there is no window under X, Y return nil and leave *PART
Gerd Moellmann's avatar
Gerd Moellmann committed
886 887 888 889 890 891 892 893 894 895
   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.  */
896

Jim Blandy's avatar
Jim Blandy committed
897
Lisp_Object
898
window_from_coordinates (f, x, y, part, wx, wy, tool_bar_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
899
     struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
900
     int x, y;
901
     enum window_part *part;
902
     int *wx, *wy;
903
     int tool_bar_p;
Jim Blandy's avatar
Jim Blandy committed
904
{
Gerd Moellmann's avatar
Gerd Moellmann committed
905
  Lisp_Object window;
906
  struct check_window_data cw;
907 908 909 910
  enum window_part dummy;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
912
  window = Qnil;
913 914
  cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
  foreach_window (f, check_window_containing, &cw);
915

Gerd Moellmann's avatar
Gerd Moellmann committed
916 917 918 919 920
  /* 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)
921
      && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
922 923
      && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
	  != ON_NOTHING))
924
    {
925
      *part = ON_TEXT;
Gerd Moellmann's avatar
Gerd Moellmann committed
926
      window = f->tool_bar_window;
927
    }
928

929 930 931
  if (wx) *wx = x;
  if (wy) *wy = y;

Gerd Moellmann's avatar
Gerd Moellmann committed
932
  return window;
Jim Blandy's avatar
Jim Blandy committed
933 934
}

935
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
936 937 938 939 940 941
       doc: /* Return window containing coordinates X and Y on FRAME.
If omitted, FRAME defaults to the currently selected frame.
The top left corner of the frame is considered to be row 0,
column 0.  */)
     (x, y, frame)
     Lisp_Object x, y, frame;
Jim Blandy's avatar
Jim Blandy committed
942
{
943
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
944

Jim Blandy's avatar
Jim Blandy committed
945
  if (NILP (frame))
946
    frame = selected_frame;
947
  CHECK_LIVE_FRAME (frame);
948
  f = XFRAME (frame);
Jim Blandy's avatar
Jim Blandy committed
949

950
  /* Check that arguments are integers or floats.  */
951 952
  CHECK_NUMBER_OR_FLOAT (x);
  CHECK_NUMBER_OR_FLOAT (y);
953

954
  return window_from_coordinates (f,
955 956 957 958
				  (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)),
959
				  0, 0, 0, 0);
Jim Blandy's avatar
Jim Blandy committed
960 961 962
}

DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
963 964 965 966 967 968 969 970 971 972
       doc: /* Return current value of point in WINDOW.
For a nonselected window, this is the value point would have
if that window were selected.

Note that, when WINDOW is the selected window and its buffer
is also currently selected, the value returned is the same as (point).
It would be more strictly correct to return the `top-level' value
of point, outside of any save-excursion forms.
But that is hard to define.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
973 974 975 976 977 978 979 980 981 982 983
     Lisp_Object window;
{
  register struct window *w = decode_window (window);

  if (w == XWINDOW (selected_window)
      && current_buffer == XBUFFER (w->buffer))
    return Fpoint ();
  return Fmarker_position (w->pointm);
}

DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
984 985 986
       doc: /* Return position at which display currently starts in WINDOW.
This is updated by redisplay or by calling `set-window-start'.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
987 988 989 990 991
     Lisp_Object window;
{
  return Fmarker_position (decode_window (window)->start);
}

992 993
/* This is text temporarily removed from the doc string below.

994 995 996 997 998 999 1000
This function returns nil if the position is not currently known.
That happens when redisplay is preempted and doesn't finish.
If in that case you want to compute where the end of the window would
have been if redisplay had finished, do this:
    (save-excursion
      (goto-char (window-start window))
      (vertical-motion (1- (window-height window)) window)
1001 1002
      (point))")  */

1003
DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1004 1005 1006 1007
       doc: /* Return position at which display currently ends in WINDOW.
This is updated by redisplay, when it runs to completion.
Simply changing the buffer text or setting `window-start'
does not update this value.
1008 1009
Return nil if there is no recorded value.  \(This can happen if the
last redisplay of WINDOW was preempted, and did not finish.)
1010 1011 1012
If UPDATE is non-nil, compute the up-to-date position
if it isn't already recorded.  */)
     (window, update)
1013
     Lisp_Object window, update;
Jim Blandy's avatar
Jim Blandy committed
1014