window.c 227 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
/* Window creation, deletion and examination for GNU Emacs.
   Does not include redisplay.
3
   Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 2000,
4
                 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
10
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22

23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25
#include "lisp.h"
#include "buffer.h"
26
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
27
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
29 30 31 32 33
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
34
#include "dispextern.h"
35 36 37
#include "blockinput.h"
#include "intervals.h"

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


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

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

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

Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
93 94 95 96 97 98
/* 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;

99 100 101
/* 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
102
   the selected window.  */
103

Jim Blandy's avatar
Jim Blandy committed
104 105
Lisp_Object minibuf_window;

106 107 108
/* Non-nil means it is the window whose mode line should be
   shown as the selected window when the minibuffer is selected.  */

109
Lisp_Object minibuf_selected_window;
110

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

Jim Blandy's avatar
Jim Blandy committed
114 115 116
Lisp_Object Vminibuf_scroll_window;

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

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

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

Jim Blandy's avatar
Jim Blandy committed
122 123
Lisp_Object Vtemp_buffer_show_function;

124 125 126 127 128
/* Non-zero means line and page scrolling on tall lines (with images)
   does partial scrolling by modifying window-vscroll.  */

int auto_window_vscroll_p;

129 130 131 132
/* 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;
133

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

136 137
EMACS_INT window_min_height;
EMACS_INT window_min_width;
Jim Blandy's avatar
Jim Blandy committed
138 139

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

Jim Blandy's avatar
Jim Blandy committed
141 142
int pop_up_windows;

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

Jim Blandy's avatar
Jim Blandy committed
145
int pop_up_frames;
Jim Blandy's avatar
Jim Blandy committed
146

147 148 149 150
/* Nonzero means reuse existing frames for displaying buffers.  */

int display_buffer_reuse_frames;

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

Jim Blandy's avatar
Jim Blandy committed
153
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
154 155

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

Jim Blandy's avatar
Jim Blandy committed
157 158
Lisp_Object Vdisplay_buffer_function;

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

Lisp_Object Veven_window_heights;

163
/* List of buffer *names* for buffers that should have their own frames.  */
164

165 166 167
Lisp_Object Vspecial_display_buffer_names;

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

169 170 171
Lisp_Object Vspecial_display_regexps;

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

173 174
Lisp_Object Vspecial_display_function;

175
/* List of buffer *names* for buffers to appear in selected window.  */
176

177 178 179
Lisp_Object Vsame_window_buffer_names;

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

181 182
Lisp_Object Vsame_window_regexps;

183
/* Hook run at end of temp_output_buffer_show.  */
184

185 186
Lisp_Object Qtemp_buffer_show_hook;

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

190
EMACS_INT split_height_threshold;
Jim Blandy's avatar
Jim Blandy committed
191 192

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

194
EMACS_INT next_screen_context_lines;
Jim Blandy's avatar
Jim Blandy committed
195 196

/* Incremented for each window created.  */
197

Jim Blandy's avatar
Jim Blandy committed
198 199
static int sequence_number;

200
/* Nonzero after init_window_once has finished.  */
201

202 203
static int window_initialized;

204
/* Hook to run when window config changes.  */
205

206 207 208
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

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

212 213
Lisp_Object Vscroll_preserve_screen_position;

214 215 216 217
/* Incremented by 1 whenever a window is deleted.  */

int window_deletion_count;

218 219
/* Used by the function window_scroll_pixel_based */

220
static int window_scroll_pixel_based_preserve_y;
221

222
#if 0 /* This isn't used anywhere.  */
223
/* Nonzero means we can split a frame even if it is "unsplittable".  */
224
static int inhibit_frame_unsplittable;
225
#endif /* 0 */
226

227
extern EMACS_INT scroll_margin;
228

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

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

Jim Blandy's avatar
Jim Blandy committed
247 248 249
Lisp_Object
make_window ()
{
250
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
251
  register struct window *p;
252

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

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
295 296 297 298
  return val;
}

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

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

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


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

Miles Bader's avatar
Miles Bader committed
356 357 358 359 360
  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
361
    {
362
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
363 364
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
365 366 367 368
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
369

370 371 372 373 374 375
  /* 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)
376
      && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
377
      && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
378 379 380
    in_window = Qt;

  if (!NILP (in_window) && !NILP (partially))
381 382 383 384 385 386 387 388 389
    {
      Lisp_Object part = Qnil;
      if (!fully_p)
	part = list4 (make_number (rtop), make_number (rbot),
			make_number (rowh), make_number (vpos));
      in_window = Fcons (make_number (x),
			 Fcons (make_number (y), part));
    }

390
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
391
}
392

Jim Blandy's avatar
Jim Blandy committed
393 394 395 396 397

static struct window *
decode_window (window)
     register Lisp_Object window;
{
Jim Blandy's avatar
Jim Blandy committed
398
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
399 400
    return XWINDOW (selected_window);

401
  CHECK_LIVE_WINDOW (window);
Jim Blandy's avatar
Jim Blandy committed
402 403 404
  return XWINDOW (window);
}

405 406 407 408 409 410 411 412 413 414 415
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
416
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
417 418
       doc: /* Return the buffer that WINDOW is displaying.
WINDOW defaults to the selected window.  */)
419
     (window)
Jim Blandy's avatar
Jim Blandy committed
420 421 422 423 424 425
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
426 427
       doc: /* Return the number of lines in WINDOW (including its mode line).  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
428 429
     Lisp_Object window;
{
430
  return decode_any_window (window)->total_lines;
Jim Blandy's avatar
Jim Blandy committed
431 432 433
}

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
434 435 436 437 438
       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
439 440
     Lisp_Object window;
{
441
  return make_number (window_box_text_cols (decode_any_window (window)));
Jim Blandy's avatar
Jim Blandy committed
442 443 444
}

DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
445 446
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
447 448 449 450 451 452
     Lisp_Object window;
{
  return decode_window (window)->hscroll;
}

DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
453
       doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
454
Return NCOL.  NCOL should be zero or positive.
455 456 457

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
window so that the location of point becomes invisible.  */)
458
     (window, ncol)
459
     Lisp_Object window, ncol;
Jim Blandy's avatar
Jim Blandy committed
460
{
461 462
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
463

464
  CHECK_NUMBER (ncol);
465
  hscroll = max (0, XINT (ncol));
466

467 468
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
469
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
470

471
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
472 473 474
  return ncol;
}

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

516 517 518 519 520
  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
521 522
}

523 524 525 526 527 528 529 530 531 532 533
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;
{
534
  register struct window *w = decode_any_window (window);
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552

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

  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)),
584
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
585 586 587 588 589 590
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

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

   X and Y are frame relative pixel coordinates.  */

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

628 629
  /* 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.  */
630 631 632
  if (w->pseudo_window_p)
    {
      left_x = 0;
633 634 635
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
      top_y = WINDOW_TOP_EDGE_Y (w);
      bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
636 637 638
    }
  else
    {
639 640 641 642
      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);
643
    }
644

645 646 647 648
  /* Outside any interesting row?  */
  if (*y < top_y || *y >= bottom_y)
    return ON_NOTHING;

649 650 651 652 653
  /* 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.  */
654

655
  if (WINDOW_WANTS_MODELINE_P (w)
656
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
657
    {
658 659 660
      part = ON_MODE_LINE;

    header_vertical_border_check:
661 662 663 664
      /* 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.  */
665 666
      if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
	  || WINDOW_RIGHTMOST_P (w))
667
	{
668
	  if (!WINDOW_LEFTMOST_P (w) && abs (*x - x0) < grabbable_width)
669
	    {
670 671
	      /* Convert X and Y to window relative coordinates.
		 Vertical border is at the left edge of window.  */
672 673 674 675
	      *x = max (0, *x - x0);
	      *y -= top_y;
	      return ON_VERTICAL_BORDER;
	    }
676
	}
677
      else
678
	{
679
	  if (abs (*x - x1) < grabbable_width)
680
	    {
681 682
	      /* Convert X and Y to window relative coordinates.
		 Vertical border is at the right edge of window.  */
683 684 685 686
	      *x = min (x1, *x) - x0;
	      *y -= top_y;
	      return ON_VERTICAL_BORDER;
	    }
687
	}
688

689 690 691
      if (*x < x0 || *x >= x1)
	return ON_NOTHING;

692 693 694 695
      /* Convert X and Y to window relative coordinates.
	 Mode line starts at left edge of window.  */
      *x -= x0;
      *y -= top_y;
696
      return part;
697
    }
698 699 700

  if (WINDOW_WANTS_HEADER_LINE_P (w)
      && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
701
    {
702 703
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
704
    }
705

706 707 708
  if (*x < x0 || *x >= x1)
    return ON_NOTHING;

709 710
  /* Outside any interesting column?  */
  if (*x < left_x || *x > right_x)
711 712 713 714
    {
      *y -= top_y;
      return ON_SCROLL_BAR;
    }
715 716 717

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

719 720 721 722
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

  if (FRAME_WINDOW_P (f))
723
    {
724
      if (!w->pseudo_window_p
725
	  && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
726
	  && !WINDOW_RIGHTMOST_P (w)
727
	  && (abs (*x - right_x) < grabbable_width))
728
	{
729 730
	  /* Convert X and Y to window relative coordinates.
	     Vertical border is at the right edge of window.  */
731 732 733 734
	  *x = min (right_x, *x) - left_x;
	  *y -= top_y;
	  return ON_VERTICAL_BORDER;
	}
735
    }
736 737 738 739
  else
    {
      /* Need to say "*x > right_x" rather than >=, since on character
	 terminals, the vertical line's x coordinate is right_x.  */
740 741 742
      if (!w->pseudo_window_p
	  && !WINDOW_RIGHTMOST_P (w)
	  && *x > right_x - ux)
743 744 745
	{
	  /* On the border on the right side of the window?  Assume that
	     this area begins at RIGHT_X minus a canonical char width.  */
746 747
	  *x = min (right_x, *x) - left_x;
	  *y -= top_y;
748
	  return ON_VERTICAL_BORDER;
749
	}
750
    }
751

752 753 754 755 756 757
  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)))
758
	{
759
	  *x -= left_x;
760 761 762 763 764
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_LEFT_MARGIN;
	}
765 766 767 768 769 770 771 772 773 774 775 776 777

      /* 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)))
778
	{
779 780 781
	  *x -= right_x - rmargin_width;
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x += WINDOW_RIGHT_FRINGE_WIDTH (w);
782 783 784
	  *y -= top_y;
	  return ON_RIGHT_MARGIN;
	}
785 786 787 788 789 790 791 792

      /* 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 */
793
  *x -= text_left;
794 795
  *y -= top_y;
  return ON_TEXT;
Jim Blandy's avatar
Jim Blandy committed
796 797
}

798

Jim Blandy's avatar
Jim Blandy committed
799
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
800 801 802 803 804 805 806 807 808 809
       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
810 811
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.
812
If they are on the border between WINDOW and its right sibling,
813 814 815
  `vertical-line' is returned.
If they are in the windows's left or right marginal areas, `left-margin'\n\
  or `right-margin' is returned.  */)
816
     (coordinates, window)
Jim Blandy's avatar
Jim Blandy committed
817 818
     register Lisp_Object coordinates, window;
{
819 820
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
821
  int x, y;
822
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
823

824
  CHECK_WINDOW (window);
825 826
  w = XWINDOW (window);
  f = XFRAME (w->frame);
827
  CHECK_CONS (coordinates);
828 829
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
830 831
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
832 833
  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);
834 835

  switch (coordinates_in_window (w, &x, &y))
Jim Blandy's avatar
Jim Blandy committed
836
    {
837
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
838 839
      return Qnil;

840 841 842
    case ON_TEXT:
      /* X and Y are now window relative pixel coordinates.  Convert
	 them to canonical char units before returning them.  */
843 844
      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
845

846
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
847
      return Qmode_line;
848

849
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
850
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
851

852
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
853
      return Qheader_line;
854

855 856
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
857

858 859
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
860

861 862
    case ON_LEFT_MARGIN:
      return Qleft_margin;
863

864 865 866
    case ON_RIGHT_MARGIN:
      return Qright_margin;

867 868 869 870
    case ON_SCROLL_BAR:
      /* Historically we are supposed to return nil in this case.  */
      return Qnil;

Jim Blandy's avatar
Jim Blandy committed
871 872 873 874 875
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
876 877

/* Callback for foreach_window, used in window_from_coordinates.
878 879 880 881 882
   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
883
   *CW->part the part of the window under coordinates *X,*Y.  Return
884 885 886 887 888
   zero from this function to stop iterating over windows.  */

struct check_window_data
{
  Lisp_Object *window;
889 890
  int *x, *y;
  enum window_part *part;
891
};
Gerd Moellmann's avatar
Gerd Moellmann committed
892 893

static int
894
check_window_containing (w, user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
895
     struct window *w;
896
     void *user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
897
{
898
  struct check_window_data *cw = (struct check_window_data *) user_data;
899 900
  enum window_part found;
  int continue_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
901

902
  found = coordinates_in_window (w, cw->x, cw->y);
903
  if (found != ON_NOTHING)
Gerd Moellmann's avatar
Gerd Moellmann committed
904
    {
905
      *cw->part = found;
906
      XSETWINDOW (*cw->window, w);
907
      continue_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
908
    }
909

910
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
911 912 913
}


914
/* Find the window containing frame-relative pixel position X/Y and
915 916 917 918 919 920
   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.

921
   If there is no window under X, Y return nil and leave *PART
Gerd Moellmann's avatar
Gerd Moellmann committed
922 923 924 925 926 927 928 929 930 931
   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 wit