window.c 210 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;

Kim F. Storm's avatar
Kim F. Storm committed
207
/* Non-nil means scroll commands try to put point
208 209
   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 245
  ++sequence_number;
  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
  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;
264
  p->nrows_scale_factor = p->ncols_scale_factor = 1;
265
  p->phys_cursor_type = -1;
266
  p->phys_cursor_width = -1;
267 268 269 270 271
  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;
272
  XSETWINDOW (val, p);
273
  XSETFASTINT (p->last_point, 0);
274
  p->frozen_window_start_p = 0;
275 276
  p->height_fixed_p = 0;
  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;
284
  p->overlay_arrow_bitmap = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
285 286

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

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

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

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


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

If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
331 332 333
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.  */)
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 342 343
  Lisp_Object in_window = Qnil;
  int fully_p = 1;
  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 365 366 367 368 369 370 371 372
  /* 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)));
373
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
374
}
375

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

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

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

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

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

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

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

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

447
  CHECK_NUMBER (ncol);
448
  hscroll = max (0, XINT (ncol));
449

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

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

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

499 500 501 502 503
  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
504 505
}

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

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

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

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

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

   X and Y are frame relative pixel coordinates.  */

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

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

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

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

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

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

660 661 662
      if (*x < x0 || *x >= x1)
	return ON_NOTHING;

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

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

677 678 679
  if (*x < x0 || *x >= x1)
    return ON_NOTHING;

680 681
  /* Outside any interesting column?  */
  if (*x < left_x || *x > right_x)
682
    return ON_SCROLL_BAR;
683 684 685

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

687 688 689 690
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

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

712 713 714 715 716 717
  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)))
718
	{
719
	  *x -= left_x;
720 721 722 723 724
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_LEFT_MARGIN;
	}
725 726 727 728 729 730 731 732 733 734 735 736 737

      /* 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)))
738 739 740 741 742 743 744
	{
	  *x -= right_x;
	  if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_RIGHT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_RIGHT_MARGIN;
	}
745 746 747 748 749 750 751 752 753 754 755

      /* 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
756 757
}

758

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

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

  switch (coordinates_in_window (w, &x, &y))
Jim Blandy's avatar
Jim Blandy committed
796
    {
797
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
798 799
      return Qnil;

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

806
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
807
      return Qmode_line;
808

809
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
810
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
811

812
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
813
      return Qheader_line;
814

815 816
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
817

818 819
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
820

821 822
    case ON_LEFT_MARGIN:
      return Qleft_margin;
823

824 825 826
    case ON_RIGHT_MARGIN:
      return Qright_margin;

827 828 829 830
    case ON_SCROLL_BAR:
      /* Historically we are supposed to return nil in this case.  */
      return Qnil;

Jim Blandy's avatar
Jim Blandy committed
831 832 833 834 835
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
836 837

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

struct check_window_data
{
  Lisp_Object *window;
849 850
  int *x, *y;
  enum window_part *part;
851
};
Gerd Moellmann's avatar
Gerd Moellmann committed
852 853

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

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

870
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
871 872 873
}


874
/* Find the window containing frame-relative pixel position X/Y and
875 876 877 878 879 880
   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.

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
908
  window = Qnil;
909 910
  cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
  foreach_window (f, check_window_containing, &cw);
911

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

925 926 927
  if (wx) *wx = x;
  if (wy) *wy = y;

Gerd Moellmann's avatar
Gerd Moellmann committed
928
  return window;
Jim Blandy's avatar
Jim Blandy committed
929 930
}

931
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
932 933 934 935 936 937
       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
938
{
939
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
940

Jim Blandy's avatar
Jim Blandy committed
941
  if (NILP (frame))
942
    frame = selected_frame;
943
  CHECK_LIVE_FRAME (frame);
944
  f = XFRAME (frame);
Jim Blandy's avatar
Jim Blandy committed
945

946
  /* Check that arguments are integers or floats.  */
947 948
  CHECK_NUMBER_OR_FLOAT (x);
  CHECK_NUMBER_OR_FLOAT (y);
949

950
  return window_from_coordinates (f,
951 952 953 954
				  (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)),
955
				  0, 0, 0, 0);
Jim Blandy's avatar
Jim Blandy committed
956 957 958
}

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

988 989
/* This is text temporarily removed from the doc string below.

990 991 992 993 994 995 996
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)
997 998
      (point))")  */

999
DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1000 1001 1002 1003
       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.
1004 1005
Return nil if there is no recorded value.  \(This can happen if the
last redisplay of WINDOW was preempted, and did not finish.)
1006 1007 1008
If UPDATE is non-nil, compute the up-to-date position
if it isn't already recorded.  */)
     (window, update)
1009
     Lisp_Object window, update;
Jim Blandy's avatar
Jim Blandy committed
1010 1011 1012
{
  Lisp_Object value;
  struct window *w = decode_window (window);
1013 1014 1015
  Lisp_Object buf;

  buf = w->buffer;
1016
  CHECK_BUFFER (buf);