window.c 217 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, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 2000,
4
                 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
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, 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
  p->last_cursor_off_p = p->cursor_off_p = 0;
277 278 279 280 281 282 283
  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
284 285

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

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

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

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


Jim Blandy's avatar
Jim Blandy committed
320
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
321
       Spos_visible_in_window_p, 0, 3, 0,
322
       doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
323 324 325
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.
326
If POS is only out of view because of horizontal scrolling, return non-nil.
327 328 329
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,
330 331 332 333
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.  */)
334
     (pos, window, partially)
335
     Lisp_Object pos, window, partially;
Jim Blandy's avatar
Jim Blandy committed
336 337 338 339
{
  register struct window *w;
  register int posint;
  register struct buffer *buf;
340
  struct text_pos top;
341
  Lisp_Object in_window = Qnil;
342
  int rtop, rbot, fully_p = 1;
343
  int x, y;
Jim Blandy's avatar
Jim Blandy committed
344

Miles Bader's avatar
Miles Bader committed
345 346 347 348 349
  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
350
    {
351
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
352 353
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
354 355 356 357
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
358

359 360 361 362 363 364
  /* 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)
365 366
      && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, NILP (partially))
      && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
367 368 369 370 371
    in_window = Qt;

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

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

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

391 392 393 394 395 396 397 398 399 400 401
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
402
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
403 404
       doc: /* Return the buffer that WINDOW is displaying.
WINDOW defaults to the selected window.  */)
405
     (window)
Jim Blandy's avatar
Jim Blandy committed
406 407 408 409 410 411
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

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

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
420 421 422 423 424
       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
425 426
     Lisp_Object window;
{
427
  return make_number (window_box_text_cols (decode_any_window (window)));
Jim Blandy's avatar
Jim Blandy committed
428 429 430
}

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

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

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

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

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

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

461 462
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
463 464 465
       doc: /* Return WINDOW's redisplay end trigger value.
See `set-window-redisplay-end-trigger' for more information.  */)
     (window)
466 467 468 469 470 471 472
     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,
473 474 475 476 477 478 479
       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)
480 481 482 483 484 485 486 487 488
     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
489
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
490 491
       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.
492 493 494 495 496
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'.  */)
497
     (window)
Jim Blandy's avatar
Jim Blandy committed
498 499
     Lisp_Object window;
{
500
  register struct window *w = decode_any_window (window);
Jim Blandy's avatar
Jim Blandy committed
501

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

509 510 511 512 513 514 515 516 517 518 519
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;
{
520
  register struct window *w = decode_any_window (window);
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538

  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;
{
539
  register struct window *w = decode_any_window (window);
540 541 542 543 544 545

  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)),
546
		make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
547 548 549 550 551 552 553
			     - 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,
554
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
555 556 557 558 559 560 561 562
\(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;
{
563
  register struct window *w = decode_any_window (window);
564 565 566 567 568 569

  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)),
570
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
571 572 573 574 575 576
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

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

   X and Y are frame relative pixel coordinates.  */

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

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

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

635 636 637 638 639
  /* 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.  */
640

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

    header_vertical_border_check:
647 648 649 650
      /* 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.  */
651 652
      if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
	  || WINDOW_RIGHTMOST_P (w))
653
	{
654 655
	  if (!WINDOW_LEFTMOST_P (w) && abs (*x - x0) < grabbable_width)
	    return ON_VERTICAL_BORDER;
656
	}
657
      else
658
	{
659 660
	  if (abs (*x - x1) < grabbable_width)
	    return ON_VERTICAL_BORDER;
661
	}
662

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

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

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

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

683 684
  /* Outside any interesting column?  */
  if (*x < left_x || *x > right_x)
685 686 687 688
    {
      *y -= top_y;
      return ON_SCROLL_BAR;
    }
689 690 691

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

693 694 695 696
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

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

718 719 720 721 722 723
  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)))
724
	{
725
	  *x -= left_x;
726 727 728 729 730
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_LEFT_MARGIN;
	}
731 732 733 734 735 736 737 738 739 740 741 742 743

      /* 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)))
744 745 746 747 748 749 750
	{
	  *x -= right_x;
	  if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_RIGHT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_RIGHT_MARGIN;
	}
751 752 753 754 755 756 757 758 759 760 761

      /* 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
762 763
}

764

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

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

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

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

812
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
813
      return Qmode_line;
814

815
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
816
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
817

818
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
819
      return Qheader_line;
820

821 822
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
823

824 825
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
826

827 828
    case ON_LEFT_MARGIN:
      return Qleft_margin;
829

830 831 832
    case ON_RIGHT_MARGIN:
      return Qright_margin;

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
842 843

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

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

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

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

876
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
877 878 879
}


880
/* Find the window containing frame-relative pixel position X/Y and
881 882 883 884 885 886
   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.

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

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

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

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

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

931 932 933
  if (wx) *wx = x;
  if (wy) *wy = y;

Gerd Moellmann's avatar
Gerd Moellmann committed
934
  return window;
Jim Blandy's avatar
Jim Blandy committed
935 936
}

937
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
938 939 940 941 942 943
       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
944
{
945
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
946

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

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

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

DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
965 966 967 968 969 970 971 972 973 974
       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
975 976 977 978 979 980 981 982 983 984 985
     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,
986 987 988
       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
989 990 991 992 993
     Lisp_Object window;
{
  return Fmarker_position (decode_window (window)->start);
}

994 995
/* This is text temporarily removed from the doc string below.

996 997 998 999 1000 1001 1002
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)
1003 1004
      (point))")  */

1005
DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1006 1007 1008 <