window.c 205 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, 1993,94,95,96,97,98, 2000,01,02,03,04
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 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

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

int window_size_fixed;

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

Lisp_Object selected_window;

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

102 103 104
/* 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
105
   the selected window.  */
106

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

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

112
Lisp_Object minibuf_selected_window;
113

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

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

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

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

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

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

127 128 129 130
/* 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;
131

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

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

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

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

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

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

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

int display_buffer_reuse_frames;

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

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

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

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

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

Lisp_Object Veven_window_heights;

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

163 164 165
Lisp_Object Vspecial_display_buffer_names;

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

167 168 169
Lisp_Object Vspecial_display_regexps;

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

171 172
Lisp_Object Vspecial_display_function;

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

175 176 177
Lisp_Object Vsame_window_buffer_names;

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

179 180
Lisp_Object Vsame_window_regexps;

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

183 184
Lisp_Object Qtemp_buffer_show_hook;

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

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

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

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

/* Incremented for each window created.  */
195

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

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

200 201
static int window_initialized;

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

204 205 206
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

207 208 209
/* Nonzero means scroll commands try to put point
   at the same screen height as previously.  */

210 211 212
Lisp_Object Vscroll_preserve_screen_position;

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

217
extern EMACS_INT scroll_margin;
218

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

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

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

243
  p = allocate_window ();
244
  XSETFASTINT (p->sequence_number, ++sequence_number);
245 246 247 248
  XSETFASTINT (p->left_col, 0);
  XSETFASTINT (p->top_line, 0);
  XSETFASTINT (p->total_lines, 0);
  XSETFASTINT (p->total_cols, 0);
249
  XSETFASTINT (p->hscroll, 0);
250
  XSETFASTINT (p->min_hscroll, 0);
251
  p->orig_top_line = p->orig_total_lines = Qnil;
Jim Blandy's avatar
Jim Blandy committed
252 253
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
254
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
255
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
256 257
  p->display_table = Qnil;
  p->dedicated = Qnil;
258 259 260 261 262 263
  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;
264
  p->phys_cursor_width = -1;
265 266 267 268 269
  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;
270
  XSETWINDOW (val, p);
271
  XSETFASTINT (p->last_point, 0);
272
  p->frozen_window_start_p = 0;
273 274
  p->height_fixed_p = 0;
  p->last_cursor_off_p = p->cursor_off_p = 0;
275 276 277 278 279 280 281
  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;
282
  p->overlay_arrow_bitmap = 0;
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 defaults to the selected window.  */)
311
     (window)
Jim Blandy's avatar
Jim Blandy committed
312 313 314
     Lisp_Object window;
{
  struct window *w = decode_window (window);
315
  return MINI_WINDOW_P (w) ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
316 317 318
}


Jim Blandy's avatar
Jim Blandy committed
319
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
320
       Spos_visible_in_window_p, 0, 3, 0,
321
       doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
322 323 324
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.
325
If POS is only out of view because of horizontal scrolling, return non-nil.
326 327 328
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,
329 330 331
return value is a list (X Y FULLY) where X and Y are the pixel coordinates
relative to the top left corner of the window, and FULLY is t if the
character after POS is fully visible and nil otherwise.  */)
332
     (pos, window, partially)
333
     Lisp_Object pos, window, partially;
Jim Blandy's avatar
Jim Blandy committed
334 335 336 337
{
  register struct window *w;
  register int posint;
  register struct buffer *buf;
338
  struct text_pos top;
339 340 341
  Lisp_Object in_window = Qnil;
  int fully_p = 1;
  int x, y;
Jim Blandy's avatar
Jim Blandy committed
342

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

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

  if (!NILP (in_window) && !NILP (partially))
    in_window = Fcons (make_number (x),
		       Fcons (make_number (y),
			      Fcons (fully_p ? Qt : Qnil, Qnil)));
371
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
372
}
373

Jim Blandy's avatar
Jim Blandy committed
374 375 376 377 378

static struct window *
decode_window (window)
     register Lisp_Object window;
{
Jim Blandy's avatar
Jim Blandy committed
379
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
380 381
    return XWINDOW (selected_window);

382
  CHECK_LIVE_WINDOW (window);
Jim Blandy's avatar
Jim Blandy committed
383 384 385
  return XWINDOW (window);
}

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

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

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

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

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

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

445
  CHECK_NUMBER (ncol);
446
  hscroll = max (0, XINT (ncol));
447

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

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

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

497 498 499 500 501
  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
502 503
}

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

  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;
{
534
  register struct window *w = decode_any_window (window);
535 536 537 538 539 540 541 542 543 544 545 546 547 548

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

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

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

   X and Y are frame relative pixel coordinates.  */

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

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

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

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

631 632 633 634 635
  /* 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.  */
636

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

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

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

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

  /* Outside any interesting column?  */
  if (*x < left_x || *x > right_x)
675
    return ON_VERTICAL_BORDER;
676 677 678

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

680 681 682 683
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

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

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

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

      /* 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
749 750
}

751

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

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

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

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

799
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
800
      return Qmode_line;
801

802
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
803
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
804

805
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
806
      return Qheader_line;
807

808 809
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
810

811 812
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
813

814 815
    case ON_LEFT_MARGIN:
      return Qleft_margin;
816

817 818 819
    case ON_RIGHT_MARGIN:
      return Qright_margin;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
825 826

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

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

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

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

859
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
860 861 862
}


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

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

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

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

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

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

914 915 916
  if (wx) *wx = x;
  if (wy) *wy = y;

Gerd Moellmann's avatar
Gerd Moellmann committed
917
  return window;
Jim Blandy's avatar
Jim Blandy committed
918 919
}

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

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

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

939
  return window_from_coordinates (f,
940 941 942
				  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
943 944 945
}

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

975 976
/* This is text temporarily removed from the doc string below.

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

986
DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
987 988 989 990
       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.
991 992
Return nil if there is no recorded value.  \(This can happen if the
last redisplay of WINDOW was preempted, and did not finish.)
993 994 995
If UPDATE is non-nil, compute the up-to-date position
if it isn't already recorded.  */)
     (window, update)
996
     Lisp_Object window, update;
Jim Blandy's avatar
Jim Blandy committed
997 998 999
{
  Lisp_Object value;
  struct window *w = decode_window (window);
1000 1001 1002
  Lisp_Object buf;

  buf = w->buffer;
1003
  CHECK_BUFFER (buf);
1004

1005
#if 0 /* This change broke some things.  We should make it later.  */
1006 1007 1008 1009 1010 1011
  /* 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;
1012
#endif
1013

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