window.c 212 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
/* Window creation, deletion and examination for GNU Emacs.
   Does not include redisplay.
3
   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 131
/* Non-zero means line and page scrolling on tall lines (with images)
   does partial scrolling by modifying window-vscroll.  */

int auto_window_vscroll_p;

132 133 134 135
/* 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;
136

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

139 140
EMACS_INT window_min_height;
EMACS_INT window_min_width;
Jim Blandy's avatar
Jim Blandy committed
141 142

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

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

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

Jim Blandy's avatar
Jim Blandy committed
148
int pop_up_frames;
Jim Blandy's avatar
Jim Blandy committed
149

150 151 152 153
/* Nonzero means reuse existing frames for displaying buffers.  */

int display_buffer_reuse_frames;

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

Jim Blandy's avatar
Jim Blandy committed
156
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
157 158

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

Jim Blandy's avatar
Jim Blandy committed
160 161
Lisp_Object Vdisplay_buffer_function;

162 163 164 165
/* Non-nil means that Fdisplay_buffer should even the heights of windows.  */

Lisp_Object Veven_window_heights;

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

168 169 170
Lisp_Object Vspecial_display_buffer_names;

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

172 173 174
Lisp_Object Vspecial_display_regexps;

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

176 177
Lisp_Object Vspecial_display_function;

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

180 181 182
Lisp_Object Vsame_window_buffer_names;

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

184 185
Lisp_Object Vsame_window_regexps;

186
/* Hook run at end of temp_output_buffer_show.  */
187

188 189
Lisp_Object Qtemp_buffer_show_hook;

190
/* Fdisplay_buffer always splits the largest window
Jim Blandy's avatar
Jim Blandy committed
191
   if that window is more than this high.  */
192

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

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

197
EMACS_INT next_screen_context_lines;
Jim Blandy's avatar
Jim Blandy committed
198 199

/* Incremented for each window created.  */
200

Jim Blandy's avatar
Jim Blandy committed
201 202
static int sequence_number;

203
/* Nonzero after init_window_once has finished.  */
204

205 206
static int window_initialized;

207
/* Hook to run when window config changes.  */
208

209 210 211
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

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

215 216 217
Lisp_Object Vscroll_preserve_screen_position;

#if 0 /* This isn't used anywhere.  */
218
/* Nonzero means we can split a frame even if it is "unsplittable".  */
219
static int inhibit_frame_unsplittable;
220
#endif /* 0 */
221

222
extern EMACS_INT scroll_margin;
223

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

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

Jim Blandy's avatar
Jim Blandy committed
242 243 244
Lisp_Object
make_window ()
{
245
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
246
  register struct window *p;
247

248
  p = allocate_window ();
249 250
  ++sequence_number;
  XSETFASTINT (p->sequence_number, sequence_number);
251 252 253 254
  XSETFASTINT (p->left_col, 0);
  XSETFASTINT (p->top_line, 0);
  XSETFASTINT (p->total_lines, 0);
  XSETFASTINT (p->total_cols, 0);
255
  XSETFASTINT (p->hscroll, 0);
256
  XSETFASTINT (p->min_hscroll, 0);
257
  p->orig_top_line = p->orig_total_lines = Qnil;
Jim Blandy's avatar
Jim Blandy committed
258 259
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
260
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
261
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
262 263
  p->display_table = Qnil;
  p->dedicated = Qnil;
264 265 266 267 268
  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;
269
  p->nrows_scale_factor = p->ncols_scale_factor = 1;
270
  p->phys_cursor_type = -1;
271
  p->phys_cursor_width = -1;
272 273 274 275 276
  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;
277
  XSETWINDOW (val, p);
278
  XSETFASTINT (p->last_point, 0);
279
  p->frozen_window_start_p = 0;
280 281
  p->height_fixed_p = 0;
  p->last_cursor_off_p = p->cursor_off_p = 0;
282 283 284 285 286 287 288
  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;
289
  p->overlay_arrow_bitmap = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
290 291

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
292 293 294 295
  return val;
}

DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
296 297
       doc: /* Return the window that the cursor now appears in and commands apply to.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
298 299 300 301
{
  return selected_window;
}

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

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


Jim Blandy's avatar
Jim Blandy committed
326
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
327
       Spos_visible_in_window_p, 0, 3, 0,
328
       doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
329 330 331
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.
332
If POS is only out of view because of horizontal scrolling, return non-nil.
333 334 335
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,
336 337 338 339
return value is a list (X Y PARTIAL) where X and Y are the pixel coordinates
relative to the top left corner of the window. PARTIAL is nil if the character
after POS is fully visible; otherwise it is a cons (RTOP . RBOT) where RTOP
and RBOT are the number of pixels invisible at the top and bottom of the row.  */)
340
     (pos, window, partially)
341
     Lisp_Object pos, window, partially;
Jim Blandy's avatar
Jim Blandy committed
342 343 344 345
{
  register struct window *w;
  register int posint;
  register struct buffer *buf;
346
  struct text_pos top;
347
  Lisp_Object in_window = Qnil;
348
  int rtop, rbot, fully_p = 1;
349
  int x, y;
Jim Blandy's avatar
Jim Blandy committed
350

Miles Bader's avatar
Miles Bader committed
351 352 353 354 355
  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
356
    {
357
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
358 359
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
360 361 362 363
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
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)
371 372
      && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, NILP (partially))
      && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
373 374 375 376 377
    in_window = Qt;

  if (!NILP (in_window) && !NILP (partially))
    in_window = Fcons (make_number (x),
		       Fcons (make_number (y),
378 379 380 381
			      Fcons ((fully_p ? Qnil
				     : Fcons (make_number (rtop),
					      make_number (rbot))),
				     Qnil)));
382
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
383
}
384

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

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

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

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

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
426 427 428 429 430
       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
431 432
     Lisp_Object window;
{
433
  return make_number (window_box_text_cols (decode_any_window (window)));
Jim Blandy's avatar
Jim Blandy committed
434 435 436
}

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

DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
445
       doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
446
Return NCOL.  NCOL should be zero or positive.
447 448 449

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

456
  CHECK_NUMBER (ncol);
457
  hscroll = max (0, XINT (ncol));
458

459 460
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
461
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
462

463
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
464 465 466
  return ncol;
}

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

508 509 510 511 512
  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
513 514
}

515 516 517 518 519 520 521 522 523 524 525
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;
{
526
  register struct window *w = decode_any_window (window);
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

  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;
{
545
  register struct window *w = decode_any_window (window);
546 547 548 549 550 551 552 553 554 555 556 557 558 559

  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,
560
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
561 562 563 564 565 566 567 568
\(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;
{
569
  register struct window *w = decode_any_window (window);
570 571 572 573 574 575 576 577 578 579 580 581 582

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

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

   X and Y are frame relative pixel coordinates.  */

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

620 621
  /* 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.  */
622 623 624
  if (w->pseudo_window_p)
    {
      left_x = 0;
625 626 627
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
      top_y = WINDOW_TOP_EDGE_Y (w);
      bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
628 629 630
    }
  else
    {
631 632 633 634
      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);
635
    }
636

637 638 639 640
  /* Outside any interesting row?  */
  if (*y < top_y || *y >= bottom_y)
    return ON_NOTHING;

641 642 643 644 645
  /* 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.  */
646

647
  if (WINDOW_WANTS_MODELINE_P (w)
648
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
649
    {
650 651 652
      part = ON_MODE_LINE;

    header_vertical_border_check:
653 654 655 656
      /* 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.  */
657 658
      if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
	  || WINDOW_RIGHTMOST_P (w))
659
	{
660 661
	  if (!WINDOW_LEFTMOST_P (w) && abs (*x - x0) < grabbable_width)
	    return ON_VERTICAL_BORDER;
662
	}
663
      else
664
	{
665 666
	  if (abs (*x - x1) < grabbable_width)
	    return ON_VERTICAL_BORDER;
667
	}
668

669 670 671
      if (*x < x0 || *x >= x1)
	return ON_NOTHING;

672 673 674 675
      /* Convert X and Y to window relative coordinates.
	 Mode line starts at left edge of window.  */
      *x -= x0;
      *y -= top_y;
676
      return part;
677
    }
678 679 680

  if (WINDOW_WANTS_HEADER_LINE_P (w)
      && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
681
    {
682 683
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
684
    }
685

686 687 688
  if (*x < x0 || *x >= x1)
    return ON_NOTHING;

689 690
  /* Outside any interesting column?  */
  if (*x < left_x || *x > right_x)
691
    return ON_SCROLL_BAR;
692 693 694

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

696 697 698 699
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

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

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

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

      /* 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
765 766
}

767

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

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

  switch (coordinates_in_window (w, &x, &y))
Jim Blandy's avatar
Jim Blandy committed
805
    {
806
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
807 808
      return Qnil;

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

815
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
816
      return Qmode_line;
817

818
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
819
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
820

821
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
822
      return Qheader_line;
823

824 825
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
826

827 828
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
829

830 831
    case ON_LEFT_MARGIN:
      return Qleft_margin;
832

833 834 835
    case ON_RIGHT_MARGIN:
      return Qright_margin;

836 837 838 839
    case ON_SCROLL_BAR:
      /* Historically we are supposed to return nil in this case.  */
      return Qnil;

Jim Blandy's avatar
Jim Blandy committed
840 841 842 843 844
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
845 846

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

struct check_window_data
{
  Lisp_Object *window;
858 859
  int *x, *y;
  enum window_part *part;
860
};
Gerd Moellmann's avatar
Gerd Moellmann committed
861 862

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

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

879
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
880 881 882
}


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

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
917
  window = Qnil;
918 919
  cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
  foreach_window (f, check_window_containing, &cw);
920

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

934 935 936
  if (wx) *wx = x;
  if (wy) *wy = y;

Gerd Moellmann's avatar
Gerd Moellmann committed
937
  return window;
Jim Blandy's avatar
Jim Blandy committed
938 939
}

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

Jim Blandy's avatar
Jim Blandy committed
950
  if (NILP (frame))
951
    frame = selected_frame;
952
  CHECK_LIVE_FRAME (frame);
953
  f = XFRAME (frame);
Jim Blandy's avatar
Jim Blandy committed
954

955
  /* Check that arguments are integers or floats.  */
956 957
  CHECK_NUMBER_OR_FLOAT (x);
  CHECK_NUMBER_OR_FLOAT (y);
958

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

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

997 998
/* This is text temporarily removed from the doc string below.

999 1000 1001 1002 1003 1004 1005
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)
1006 1007
      (point))")  */

1008
DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1009 1010 1011 1012
       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.