window.c 203 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,86,87,93,94,95,96,97,1998,2000, 2001, 2002, 2003
4
   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
#include "window.h"
#include "commands.h"
#include "indent.h"
32
#include "systty.h" /* For emacs_tty in termchar.h */
Jim Blandy's avatar
Jim Blandy committed
33 34
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
35
#include "dispextern.h"
36 37 38
#include "blockinput.h"
#include "intervals.h"

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


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

57
static int displayed_window_lines P_ ((struct window *));
Andreas Schwab's avatar
Andreas Schwab committed
58
static struct window *decode_window P_ ((Lisp_Object));
59 60 61 62 63
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
64
static int window_min_size_1 P_ ((struct window *, int));
65
static int window_min_size P_ ((struct window *, int, int, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
66
static void size_window P_ ((Lisp_Object, int, int, int));
67
static int freeze_window_start P_ ((struct window *, void *));
68
static int window_fixed_size_p P_ ((struct window *, int, int));
69
static void enlarge_window P_ ((Lisp_Object, int, int, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
70
static Lisp_Object window_list P_ ((void));
71
static int add_window_to_list P_ ((struct window *, void *));
72 73
static int candidate_window_p P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
				   Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
74 75 76 77
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 *));
78 79 80
static int foreach_window_1 P_ ((struct window *,
				 int (* fn) (struct window *, void *),
				 void *));
81
static Lisp_Object window_list_1 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
82

83 84 85 86
/* The value of `window-size-fixed'.  */

int window_size_fixed;

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

Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
97 98 99 100 101 102
/* A list of all windows for use by next_window and Fwindow_list.
   Functions creating or deleting windows should invalidate this cache
   by setting it to nil.  */

Lisp_Object Vwindow_list;

103 104 105
/* The mini-buffer window of the selected frame.
   Note that you cannot test for mini-bufferness of an arbitrary window
   by comparing against this; but you can test for mini-bufferness of
Jim Blandy's avatar
Jim Blandy committed
106
   the selected window.  */
107

Jim Blandy's avatar
Jim Blandy committed
108 109
Lisp_Object minibuf_window;

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

113
Lisp_Object minibuf_selected_window;
114

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

Jim Blandy's avatar
Jim Blandy committed
118 119 120
Lisp_Object Vminibuf_scroll_window;

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

Jim Blandy's avatar
Jim Blandy committed
122 123 124
Lisp_Object Vother_window_scroll_buffer;

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

Jim Blandy's avatar
Jim Blandy committed
126 127
Lisp_Object Vtemp_buffer_show_function;

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;

208 209 210
/* Nonzero means scroll commands try to put point
   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
  XSETFASTINT (p->sequence_number, ++sequence_number);
246 247 248 249
  XSETFASTINT (p->left_col, 0);
  XSETFASTINT (p->top_line, 0);
  XSETFASTINT (p->total_lines, 0);
  XSETFASTINT (p->total_cols, 0);
250
  XSETFASTINT (p->hscroll, 0);
251
  XSETFASTINT (p->min_hscroll, 0);
252
  p->orig_top_line = p->orig_total_lines = Qnil;
Jim Blandy's avatar
Jim Blandy committed
253 254
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
255
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
256
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
257 258
  p->display_table = Qnil;
  p->dedicated = Qnil;
259 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;
  p->phys_cursor_type = -1;
265
  p->phys_cursor_width = -1;
266 267 268 269 270
  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;
271
  XSETWINDOW (val, p);
272
  XSETFASTINT (p->last_point, 0);
273
  p->frozen_window_start_p = 0;
274 275
  p->height_fixed_p = 0;
  p->last_cursor_off_p = p->cursor_off_p = 0;
276 277 278 279 280 281 282
  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
283 284

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

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

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

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


Jim Blandy's avatar
Jim Blandy committed
318
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
319 320 321 322 323 324 325
       Spos_visible_in_window_p, 0, 3, 0,
       doc: /* Return t if position POS is currently on the frame in WINDOW.
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.
POS defaults to point in WINDOW; WINDOW defaults to the selected window.  */)
     (pos, window, partially)
326
     Lisp_Object pos, window, partially;
Jim Blandy's avatar
Jim Blandy committed
327 328 329 330
{
  register struct window *w;
  register int posint;
  register struct buffer *buf;
331 332
  struct text_pos top;
  Lisp_Object in_window;
333
  int fully_p;
Jim Blandy's avatar
Jim Blandy committed
334

Miles Bader's avatar
Miles Bader committed
335 336 337 338 339
  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
340
    {
341
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
342 343
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
344 345 346 347
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
348

349
  /* If position is above window start, it's not visible.  */
350
  if (posint < CHARPOS (top))
351 352
    in_window = Qnil;
  else if (XFASTINT (w->last_modified) >= BUF_MODIFF (buf)
Miles Bader's avatar
Miles Bader committed
353 354 355
	   && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (buf)
	   && posint < BUF_Z (buf) - XFASTINT (w->window_end_pos))
    {
356 357 358 359
      /* If frame is up-to-date, and POSINT is < window end pos, use
	 that info.  This doesn't work for POSINT == end pos, because
	 the window end pos is actually the position _after_ the last
	 char in the window.  */
360
      if (NILP (partially))
361
	{
362
	  pos_visible_p (w, posint, &fully_p, NILP (partially));
363 364
	  in_window = fully_p ? Qt : Qnil;
	}
Miles Bader's avatar
Miles Bader committed
365
      else
366
	in_window = Qt;
Miles Bader's avatar
Miles Bader committed
367
    }
368 369 370 371 372
  else if (posint > BUF_ZV (buf))
    in_window = Qnil;
  else if (CHARPOS (top) < BUF_BEGV (buf) || CHARPOS (top) > BUF_ZV (buf))
    /* If window start is out of range, do something reasonable.  */
    in_window = Qnil;
Jim Blandy's avatar
Jim Blandy committed
373 374
  else
    {
375 376
      if (pos_visible_p (w, posint, &fully_p, NILP (partially)))
	in_window = !NILP (partially) || fully_p ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
377 378
      else
	in_window = Qnil;
Jim Blandy's avatar
Jim Blandy committed
379
    }
380 381

  return in_window;
Jim Blandy's avatar
Jim Blandy committed
382
}
383

Jim Blandy's avatar
Jim Blandy committed
384 385 386 387 388

static struct window *
decode_window (window)
     register Lisp_Object window;
{
Jim Blandy's avatar
Jim Blandy committed
389
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
390 391
    return XWINDOW (selected_window);

392
  CHECK_LIVE_WINDOW (window);
Jim Blandy's avatar
Jim Blandy committed
393 394 395 396
  return XWINDOW (window);
}

DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
397 398
       doc: /* Return the buffer that WINDOW is displaying.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
399 400 401 402 403 404
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
405 406
       doc: /* Return the number of lines in WINDOW (including its mode line).  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
407 408
     Lisp_Object window;
{
409
  return decode_window (window)->total_lines;
Jim Blandy's avatar
Jim Blandy committed
410 411 412
}

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
413 414 415 416 417
       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
418 419
     Lisp_Object window;
{
420
  return make_number (window_box_text_cols (decode_window (window)));
Jim Blandy's avatar
Jim Blandy committed
421 422 423
}

DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
424 425
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
426 427 428 429 430 431
     Lisp_Object window;
{
  return decode_window (window)->hscroll;
}

DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
432
       doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
433 434 435 436
NCOL should be zero or positive.

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
window so that the location of point becomes invisible.  */)
437
     (window, ncol)
438
     Lisp_Object window, ncol;
Jim Blandy's avatar
Jim Blandy committed
439
{
440 441
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
442

443
  CHECK_NUMBER (ncol);
444
  hscroll = max (0, XINT (ncol));
445

446 447
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
448
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
449

450
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
451 452 453
  return ncol;
}

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

495 496 497 498 499
  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
500 501
}

502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
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;
{
  register struct window *w = decode_window (window);

  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;
{
  register struct window *w = decode_window (window);

  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,
       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 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;
{
  register struct window *w = decode_window (window);

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

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

   X and Y are frame relative pixel coordinates.  */

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

  if (*x < x0 || *x >= x1)
    return ON_NOTHING;
607

608 609
  /* 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.  */
610 611 612
  if (w->pseudo_window_p)
    {
      left_x = 0;
613 614 615
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
      top_y = WINDOW_TOP_EDGE_Y (w);
      bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
616 617 618
    }
  else
    {
619 620 621 622
      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);
623
    }
624

625 626 627 628
  /* Outside any interesting row?  */
  if (*y < top_y || *y >= bottom_y)
    return ON_NOTHING;

629 630 631 632 633
  /* 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.  */
634

635
  if (WINDOW_WANTS_MODELINE_P (w)
636
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
637
    {
638 639 640
      part = ON_MODE_LINE;

    header_vertical_border_check:
641 642 643 644
      /* 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.  */
645 646
      if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
	  || WINDOW_RIGHTMOST_P (w))
647
	{
648 649
	  if (!WINDOW_LEFTMOST_P (w) && abs (*x - x0) < grabbable_width)
	    return ON_VERTICAL_BORDER;
650
	}
651
      else
652
	{
653 654
	  if (abs (*x - x1) < grabbable_width)
	    return ON_VERTICAL_BORDER;
655
	}
656

657 658 659 660
      /* Convert X and Y to window relative coordinates.
	 Mode line starts at left edge of window.  */
      *x -= x0;
      *y -= top_y;
661
      return part;
662
    }
663 664 665

  if (WINDOW_WANTS_HEADER_LINE_P (w)
      && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
666
    {
667 668
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
669
    }
670 671 672 673 674 675 676

  /* Outside any interesting column?  */
  if (*x < left_x || *x > right_x)
    return ON_NOTHING;

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

678 679 680 681
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

  if (FRAME_WINDOW_P (f))
682
    {
683
      if (!w->pseudo_window_p
684
	  && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
685
	  && !WINDOW_RIGHTMOST_P (w)
686 687
	  && (abs (*x - right_x) < grabbable_width))
	return ON_VERTICAL_BORDER;
688
    }
689 690 691 692
  else
    {
      /* Need to say "*x > right_x" rather than >=, since on character
	 terminals, the vertical line's x coordinate is right_x.  */
693 694 695
      if (!w->pseudo_window_p
	  && !WINDOW_RIGHTMOST_P (w)
	  && *x > right_x - ux)
696 697 698
	{
	  /* On the border on the right side of the window?  Assume that
	     this area begins at RIGHT_X minus a canonical char width.  */
699
	  return ON_VERTICAL_BORDER;
700
	}
701
    }
702

703 704 705 706 707 708
  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)))
709
	{
710
	  *x -= left_x;
711 712 713 714 715
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_LEFT_MARGIN;
	}
716 717 718 719 720 721 722 723 724 725 726 727 728

      /* 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)))
729 730 731 732 733 734 735
	{
	  *x -= right_x;
	  if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_RIGHT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_RIGHT_MARGIN;
	}
736 737 738 739 740 741 742 743 744 745 746

      /* 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
747 748
}

749

Jim Blandy's avatar
Jim Blandy committed
750
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
751 752 753 754 755 756 757 758 759 760
       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
761 762
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.
763
If they are on the border between WINDOW and its right sibling,
764 765 766
  `vertical-line' is returned.
If they are in the windows's left or right marginal areas, `left-margin'\n\
  or `right-margin' is returned.  */)
767
     (coordinates, window)
Jim Blandy's avatar
Jim Blandy committed
768 769
     register Lisp_Object coordinates, window;
{
770 771
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
772
  int x, y;
773
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
774

775
  CHECK_LIVE_WINDOW (window);
776 777
  w = XWINDOW (window);
  f = XFRAME (w->frame);
778
  CHECK_CONS (coordinates);
779 780
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
781 782
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
783 784
  x = FRAME_PIXEL_X_FROM_CANON_X (f, lx);
  y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly);
785 786

  switch (coordinates_in_window (w, &x, &y))
Jim Blandy's avatar
Jim Blandy committed
787
    {
788
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
789 790
      return Qnil;

791 792 793
    case ON_TEXT:
      /* X and Y are now window relative pixel coordinates.  Convert
	 them to canonical char units before returning them.  */
794 795
      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
796

797
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
798
      return Qmode_line;
799

800
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
801
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
802

803
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
804
      return Qheader_line;
805

806 807
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
808

809 810
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
811

812 813
    case ON_LEFT_MARGIN:
      return Qleft_margin;
814

815 816 817
    case ON_RIGHT_MARGIN:
      return Qright_margin;

Jim Blandy's avatar
Jim Blandy committed
818 819 820 821 822
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
823 824

/* Callback for foreach_window, used in window_from_coordinates.
825 826 827 828 829
   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
830
   *CW->part the part of the window under coordinates *X,*Y.  Return
831 832 833 834 835
   zero from this function to stop iterating over windows.  */

struct check_window_data
{
  Lisp_Object *window;
836 837
  int *x, *y;
  enum window_part *part;
838
};
Gerd Moellmann's avatar
Gerd Moellmann committed
839 840

static int
841
check_window_containing (w, user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
842
     struct window *w;
843
     void *user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
844
{
845
  struct check_window_data *cw = (struct check_window_data *) user_data;
846 847
  enum window_part found;
  int continue_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
848

849
  found = coordinates_in_window (w, cw->x, cw->y);
850
  if (found != ON_NOTHING)
Gerd Moellmann's avatar
Gerd Moellmann committed
851
    {
852
      *cw->part = found;
853
      XSETWINDOW (*cw->window, w);
854
      continue_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
855
    }
856

857
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
858 859 860
}


861
/* Find the window containing frame-relative pixel position X/Y and
862 863 864 865 866 867
   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.

868
   If there is no window under X, Y return nil and leave *PART
Gerd Moellmann's avatar
Gerd Moellmann committed
869 870 871 872 873 874 875 876 877 878
   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.  */
879

Jim Blandy's avatar
Jim Blandy committed
880
Lisp_Object
881
window_from_coordinates (f, x, y, part, wx, wy, tool_bar_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
882
     struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
883
     int x, y;
884
     enum window_part *part;
885
     int *wx, *wy;
886
     int tool_bar_p;
Jim Blandy's avatar
Jim Blandy committed
887
{
Gerd Moellmann's avatar
Gerd Moellmann committed
888
  Lisp_Object window;
889
  struct check_window_data cw;
890 891 892 893
  enum window_part dummy;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
895
  window = Qnil;
896 897
  cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
  foreach_window (f, check_window_containing, &cw);
898

Gerd Moellmann's avatar
Gerd Moellmann committed
899 900 901 902 903
  /* 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)
904
      && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0
905 906
      && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
	  != ON_NOTHING))
907
    {
908
      *part = ON_TEXT;
Gerd Moellmann's avatar
Gerd Moellmann committed
909
      window = f->tool_bar_window;
910
    }
911

912 913 914
  if (wx) *wx = x;
  if (wy) *wy = y;

Gerd Moellmann's avatar
Gerd Moellmann committed
915
  return window;
Jim Blandy's avatar
Jim Blandy committed
916 917
}

918
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
919 920 921 922 923 924
       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
925
{
926
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
927

Jim Blandy's avatar
Jim Blandy committed
928
  if (NILP (frame))
929
    frame = selected_frame;
930
  CHECK_LIVE_FRAME (frame);
931
  f = XFRAME (frame);
Jim Blandy's avatar
Jim Blandy committed
932

933
  /* Check that arguments are integers or floats.  */
934 935
  CHECK_NUMBER_OR_FLOAT (x);
  CHECK_NUMBER_OR_FLOAT (y);
936

937
  return window_from_coordinates (f,
938 939 940
				  FRAME_PIXEL_X_FROM_CANON_X (f, x),
				  FRAME_PIXEL_Y_FROM_CANON_Y (f, y),
				  0, 0, 0, 0);
Jim Blandy's avatar
Jim Blandy committed
941 942 943
}

DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
944 945 946 947 948 949 950 951 952 953
       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
954 955 956 957 958 959 960 961 962 963 964
     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,
965 966 967
       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
968 969 970 971 972
     Lisp_Object window;
{
  return Fmarker_position (decode_window (window)->start);
}

973 974
/* This is text temporarily removed from the doc string below.

975 976 977 978 979 980 981
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)
982 983
      (point))")  */

984
DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
985 986 987 988 989 990 991
       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.
If UPDATE is non-nil, compute the up-to-date position
if it isn't already recorded.  */)
     (window, update)
992
     Lisp_Object window, update;
Jim Blandy's avatar
Jim Blandy committed
993 994 995
{
  Lisp_Object value;
  struct window *w = decode_window (window);
996 997 998
  Lisp_Object buf;

  buf = w->buffer;
999
  CHECK_BUFFER (buf);
1000

1001
#if 0 /* This change broke some things.  We should make it later.  */
1002 1003 1004 1005 1006 1007
  /* If we don't know the end position, return nil.
     The user can compute it with vertical-motion if he wants to.
     It would be nicer to do it automatically,
     but that's so slow that it would probably bother people.  */
  if (NILP (w->window_end_valid))
    return Qnil;
1008
#endif
1009

1010 1011 1012 1013
  if (! NILP (update)
      && ! (! NILP (w->window_end_valid)
	    && XFASTINT (w->last_modified) >= MODIFF))
    {
1014 1015
      struct text_pos startp;
      struct it it;
1016
      struct buffer *old_buffer = NULL, *b = XBUFFER (buf);
1017 1018

      /* In case W->start is out of the range, use something
Juanma Barranquero's avatar
Juanma Barranquero committed
1019
         reasonable.  This situation occurred when loading a file with
1020 1021
         `-l' containing a call to `rmail' with subsequent other
         commands.  At the end, W->start happened to be BEG, while
1022
         rmail had already narrowed the buffer.  */
1023
      if (XMARKER (w->start)->charpos < BEGV)
1024
	SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
1025
      else if (XMARKER (w->start)->charpos > ZV)