window.c 183 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
/* Window creation, deletion and examination for GNU Emacs.
   Does not include redisplay.
3
   Copyright (C) 1985,86,87,93,94,95,96,97,1998,2000, 2001, 2002, 2003
4
   Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

This file is part of GNU Emacs.

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

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

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
20 21
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22

23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24 25
#include "lisp.h"
#include "buffer.h"
26
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
27
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
29 30 31 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 53 54 55 56 57 58 59 60
/* Values returned from coordinates_in_window.  */

enum window_part
{
  ON_NOTHING,
  ON_TEXT,
  ON_MODE_LINE,
  ON_VERTICAL_BORDER,
  ON_HEADER_LINE,
  ON_LEFT_FRINGE,
61 62 63
  ON_RIGHT_FRINGE,
  ON_LEFT_MARGIN,
  ON_RIGHT_MARGIN
64 65
};

66

67
Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
68
Lisp_Object Qwindow_size_fixed;
69
extern Lisp_Object Qleft_margin, Qright_margin;
Gerd Moellmann's avatar
Gerd Moellmann committed
70
extern Lisp_Object Qheight, Qwidth;
Jim Blandy's avatar
Jim Blandy committed
71

72
static int displayed_window_lines P_ ((struct window *));
Andreas Schwab's avatar
Andreas Schwab committed
73
static struct window *decode_window P_ ((Lisp_Object));
74
static Lisp_Object select_window_1 P_ ((Lisp_Object, int));
75 76 77 78 79
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
80
static int window_min_size_1 P_ ((struct window *, int));
81
static int window_min_size P_ ((struct window *, int, int, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
82
static void size_window P_ ((Lisp_Object, int, int, int));
83
static int freeze_window_start P_ ((struct window *, void *));
84
static int window_fixed_size_p P_ ((struct window *, int, int));
85
static void enlarge_window P_ ((Lisp_Object, int, int, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
86
static Lisp_Object window_list P_ ((void));
87
static int add_window_to_list P_ ((struct window *, void *));
88 89
static int candidate_window_p P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
				   Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
90 91 92 93
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 *));
94 95 96
static int foreach_window_1 P_ ((struct window *,
				 int (* fn) (struct window *, void *),
				 void *));
97
static Lisp_Object window_list_1 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
98

99 100 101 102
/* The value of `window-size-fixed'.  */

int window_size_fixed;

Jim Blandy's avatar
Jim Blandy committed
103 104 105 106 107 108
/* 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
109
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
110 111 112

Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
113 114 115 116 117 118
/* 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;

119 120 121
/* 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
122
   the selected window.  */
123

Jim Blandy's avatar
Jim Blandy committed
124 125
Lisp_Object minibuf_window;

126 127 128
/* Non-nil means it is the window whose mode line should be
   shown as the selected window when the minibuffer is selected.  */

129
Lisp_Object minibuf_selected_window;
130

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

Jim Blandy's avatar
Jim Blandy committed
134 135 136
Lisp_Object Vminibuf_scroll_window;

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

Jim Blandy's avatar
Jim Blandy committed
138 139 140
Lisp_Object Vother_window_scroll_buffer;

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

Jim Blandy's avatar
Jim Blandy committed
142 143
Lisp_Object Vtemp_buffer_show_function;

144 145 146 147
/* 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;
148

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

151 152
EMACS_INT window_min_height;
EMACS_INT window_min_width;
Jim Blandy's avatar
Jim Blandy committed
153 154

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

Jim Blandy's avatar
Jim Blandy committed
156 157
int pop_up_windows;

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

Jim Blandy's avatar
Jim Blandy committed
160
int pop_up_frames;
Jim Blandy's avatar
Jim Blandy committed
161

162 163 164 165
/* Nonzero means reuse existing frames for displaying buffers.  */

int display_buffer_reuse_frames;

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

Jim Blandy's avatar
Jim Blandy committed
168
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
169 170

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

Jim Blandy's avatar
Jim Blandy committed
172 173
Lisp_Object Vdisplay_buffer_function;

174 175 176 177
/* Non-nil means that Fdisplay_buffer should even the heights of windows.  */

Lisp_Object Veven_window_heights;

178
/* List of buffer *names* for buffers that should have their own frames.  */
179

180 181 182
Lisp_Object Vspecial_display_buffer_names;

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

184 185 186
Lisp_Object Vspecial_display_regexps;

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

188 189
Lisp_Object Vspecial_display_function;

190
/* List of buffer *names* for buffers to appear in selected window.  */
191

192 193 194
Lisp_Object Vsame_window_buffer_names;

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

196 197
Lisp_Object Vsame_window_regexps;

198
/* Hook run at end of temp_output_buffer_show.  */
199

200 201
Lisp_Object Qtemp_buffer_show_hook;

202
/* Fdisplay_buffer always splits the largest window
Jim Blandy's avatar
Jim Blandy committed
203
   if that window is more than this high.  */
204

205
EMACS_INT split_height_threshold;
Jim Blandy's avatar
Jim Blandy committed
206 207

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

209
EMACS_INT next_screen_context_lines;
Jim Blandy's avatar
Jim Blandy committed
210 211

/* Incremented for each window created.  */
212

Jim Blandy's avatar
Jim Blandy committed
213 214
static int sequence_number;

215
/* Nonzero after init_window_once has finished.  */
216

217 218
static int window_initialized;

219
/* Hook to run when window config changes.  */
220

221 222 223
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

224 225 226
/* Nonzero means scroll commands try to put point
   at the same screen height as previously.  */

227 228 229
Lisp_Object Vscroll_preserve_screen_position;

#if 0 /* This isn't used anywhere.  */
230
/* Nonzero means we can split a frame even if it is "unsplittable".  */
231
static int inhibit_frame_unsplittable;
232
#endif /* 0 */
233

234
extern EMACS_INT scroll_margin;
235

236
extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
Jim Blandy's avatar
Jim Blandy committed
237 238

DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
239 240
       doc: /* Returns t if OBJECT is a window.  */)
     (object)
241
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
242
{
243
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
244 245
}

246
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
247
       doc: /* Returns t if OBJECT is a window which is currently visible.  */)
248 249
     (object)
     Lisp_Object object;
250
{
251
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
252 253
}

Jim Blandy's avatar
Jim Blandy committed
254 255 256
Lisp_Object
make_window ()
{
257
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
258
  register struct window *p;
259

260
  p = allocate_window ();
261 262 263 264 265 266
  XSETFASTINT (p->sequence_number, ++sequence_number);
  XSETFASTINT (p->left, 0);
  XSETFASTINT (p->top, 0);
  XSETFASTINT (p->height, 0);
  XSETFASTINT (p->width, 0);
  XSETFASTINT (p->hscroll, 0);
267
  XSETFASTINT (p->min_hscroll, 0);
268
  p->orig_top = p->orig_height = Qnil;
Jim Blandy's avatar
Jim Blandy committed
269 270
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
271
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
272
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
273 274
  p->display_table = Qnil;
  p->dedicated = Qnil;
275 276 277 278 279 280
  p->pseudo_window_p = 0;
  bzero (&p->cursor, sizeof (p->cursor));
  bzero (&p->last_cursor, sizeof (p->last_cursor));
  bzero (&p->phys_cursor, sizeof (p->phys_cursor));
  p->desired_matrix = p->current_matrix = 0;
  p->phys_cursor_type = -1;
281
  p->phys_cursor_width = -1;
282 283 284 285 286
  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;
287
  XSETWINDOW (val, p);
288
  XSETFASTINT (p->last_point, 0);
289
  p->frozen_window_start_p = 0;
290 291
  p->height_fixed_p = 0;
  p->last_cursor_off_p = p->cursor_off_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
292 293

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

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

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

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


Jim Blandy's avatar
Jim Blandy committed
327
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
328 329 330 331 332 333 334
       Spos_visible_in_window_p, 0, 3, 0,
       doc: /* Return t if position POS is currently on the frame in WINDOW.
Return nil if that position is scrolled vertically out of view.
If a character is only partially visible, nil is returned, unless the
optional argument PARTIALLY is non-nil.
POS defaults to point in WINDOW; WINDOW defaults to the selected window.  */)
     (pos, window, partially)
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 341
  struct text_pos top;
  Lisp_Object in_window;
342
  int fully_p;
Jim Blandy's avatar
Jim Blandy committed
343

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

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

DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
406 407
       doc: /* Return the buffer that WINDOW is displaying.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
408 409 410 411 412 413
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

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

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
422 423 424 425 426
       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
427 428
     Lisp_Object window;
{
429
  return make_number (window_internal_width (decode_window (window)));
Jim Blandy's avatar
Jim Blandy committed
430 431 432
}

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

DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
441
       doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
442 443 444 445
NCOL should be zero or positive.

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

452
  CHECK_NUMBER (ncol);
453
  hscroll = max (0, XINT (ncol));
454

455 456
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
457
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
458

459
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
460 461 462
  return ncol;
}

463 464
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
465 466 467
       doc: /* Return WINDOW's redisplay end trigger value.
See `set-window-redisplay-end-trigger' for more information.  */)
     (window)
468 469 470 471 472 473 474
     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,
475 476 477 478 479 480 481
       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)
482 483 484 485 486 487 488 489 490
     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
491
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
492 493 494 495 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.
RIGHT is one more than the rightmost column used by WINDOW,
and BOTTOM is one more than the bottommost row used by WINDOW
 and its mode-line.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
498 499 500 501 502
     Lisp_Object window;
{
  register struct window *w = decode_window (window);

  return Fcons (w->left, Fcons (w->top,
503
           Fcons (make_number (WINDOW_RIGHT_EDGE (w)),
Jim Blandy's avatar
Jim Blandy committed
504 505 506 507 508
		  Fcons (make_number (XFASTINT (w->top)
				      + XFASTINT (w->height)),
			 Qnil))));
}

509
/* Test if the character at column *X, row *Y is within window W.
Jim Blandy's avatar
Jim Blandy committed
510 511 512 513 514 515 516
   If it is not, return 0;
   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
      return 1;
   if it is on the window's modeline, return 2;
   if it is on the border between the window and its right sibling,
517 518
      return 3.
   if it is on the window's top line, return 4;
Kim F. Storm's avatar
Kim F. Storm committed
519
   if it is in left or right fringe of the window,
520 521 522
   return 5 or 6, and convert *X and *Y to window-relative coordinates;
   if it is in the marginal area to the left/right of the window,
   return 7 or 8, and convert *X and *Y to window-relative coordinates.
523 524 525

   X and Y are frame relative pixel coordinates.  */

526
static enum window_part
Jim Blandy's avatar
Jim Blandy committed
527 528 529 530
coordinates_in_window (w, x, y)
     register struct window *w;
     register int *x, *y;
{
531 532
  /* Let's make this a global enum later, instead of using numbers
     everywhere.  */
533 534
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  int left_x, right_x, top_y, bottom_y;
535
  enum window_part part;
Pavel Janík's avatar
Pavel Janík committed
536
  int ux = CANON_X_UNIT (f);
537 538
  int x0 = XFASTINT (w->left) * ux;
  int x1 = x0 + XFASTINT (w->width) * ux;
539 540 541
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
542
  int lmargin_width = 0, rmargin_width = 0;
543 544 545

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

547 548
  /* 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.  */
549 550 551
  if (w->pseudo_window_p)
    {
      left_x = 0;
552
      right_x = XFASTINT (w->width) * CANON_X_UNIT (f) - 1;
553 554 555 556 557
      top_y = WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w);
      bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
    }
  else
    {
558
      left_x = (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
559
		- FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
560
      right_x = WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X (w) - 1;
561
      top_y = (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
562
	       - FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
563 564
      bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
    }
565

566 567 568 569 570
  /* 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.  */
571

572
  if (WINDOW_WANTS_MODELINE_P (w)
573 574
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
      && *y < bottom_y)
575
    {
576 577 578 579 580
      /* 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.  */
      part = ON_MODE_LINE;
581

582 583
      if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
	{
584
	  if (abs (*x - x0) < grabbable_width)
585 586
	    part = ON_VERTICAL_BORDER;
	}
587
      else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < grabbable_width)
588
	part = ON_VERTICAL_BORDER;
589
    }
590 591 592 593 594
  else if (WINDOW_WANTS_HEADER_LINE_P (w)
	   && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
	   && *y >= top_y)
    {
      part = ON_HEADER_LINE;
595

596 597
      if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
	{
598
	  if (abs (*x - x0) < grabbable_width)
599 600
	    part = ON_VERTICAL_BORDER;
	}
601
      else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < grabbable_width)
602 603 604 605 606 607
	part = ON_VERTICAL_BORDER;
    }
  /* Outside anything interesting?  */
  else if (*y < top_y
	   || *y >= bottom_y
	   || *x < (left_x
608
		    - FRAME_LEFT_FRINGE_WIDTH (f)
609
		    - FRAME_LEFT_SCROLL_BAR_WIDTH (f) * ux)
610
	   || *x > (right_x
611
		    + FRAME_RIGHT_FRINGE_WIDTH (f)
612
		    + FRAME_RIGHT_SCROLL_BAR_WIDTH (f) * ux))
613
    {
614
      part = ON_NOTHING;
615
    }
616
  else if (FRAME_WINDOW_P (f))
617
    {
618 619 620
      if (!w->pseudo_window_p
	  && !FRAME_HAS_VERTICAL_SCROLL_BARS (f)
	  && !WINDOW_RIGHTMOST_P (w)
621
	  && (abs (*x - right_x - FRAME_RIGHT_FRINGE_WIDTH (f)) < grabbable_width))
622 623 624 625
	{
	  part = ON_VERTICAL_BORDER;
	}
      else if (*x < left_x || *x > right_x)
626
	{
Kim F. Storm's avatar
Kim F. Storm committed
627
	  /* Other lines than the mode line don't include fringes and
628
	     scroll bars on the left.  */
629

630 631 632
	  /* Convert X and Y to window-relative pixel coordinates.  */
	  *x -= left_x;
	  *y -= top_y;
633 634 635 636
	  part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
	}
      else
	{
637 638 639 640 641
	  lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
	  rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
	  /* You can never be on a margin area if its width is zero.  */
	  if (lmargin_width
	      && *x <= window_box_right (w, LEFT_MARGIN_AREA))
642
	    part = ON_LEFT_MARGIN;
643 644
	  else if (rmargin_width
		   && *x >= window_box_left (w, RIGHT_MARGIN_AREA))
645 646 647 648 649 650 651
	    part = ON_RIGHT_MARGIN;
	  else
	    {
	      part = ON_TEXT;
	      *x -= left_x;
	      *y -= top_y;
	    }
652
	}
653
    }
654 655 656 657 658 659
  else
    {
      /* Need to say "*x > right_x" rather than >=, since on character
	 terminals, the vertical line's x coordinate is right_x.  */
      if (*x < left_x || *x > right_x)
	{
Kim F. Storm's avatar
Kim F. Storm committed
660
	  /* Other lines than the mode line don't include fringes and
661
	     scroll bars on the left.  */
662

663 664 665
	  /* Convert X and Y to window-relative pixel coordinates.  */
	  *x -= left_x;
	  *y -= top_y;
666
	  part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
667 668
	}
      /* Here, too, "*x > right_x" is because of character terminals.  */
669 670 671 672 673 674 675 676 677 678
      else if (!w->pseudo_window_p
	       && !WINDOW_RIGHTMOST_P (w)
	       && *x > right_x - ux)
	{
	  /* On the border on the right side of the window?  Assume that
	     this area begins at RIGHT_X minus a canonical char width.  */
	  part = ON_VERTICAL_BORDER;
	}
      else
	{
679 680 681 682 683 684
	  lmargin_width = window_box_width (w, LEFT_MARGIN_AREA);
	  rmargin_width = window_box_width (w, RIGHT_MARGIN_AREA);
	  /* You can never be on a margin area if its width is zero.
	     This is especially important for character terminals.  */
	  if (lmargin_width
	      && *x <= window_box_right (w, LEFT_MARGIN_AREA))
685
	    part = ON_LEFT_MARGIN;
686 687
	  else if (rmargin_width
		   && *x >= window_box_left (w, RIGHT_MARGIN_AREA))
688 689 690 691 692 693 694 695
	    part = ON_RIGHT_MARGIN;
	  else
	    {
	      part = ON_TEXT;
	      /* Convert X and Y to window-relative pixel coordinates.  */
	      *x -= left_x;
	      *y -= top_y;
	    }
696
	}
697
    }
698 699

  return part;
Jim Blandy's avatar
Jim Blandy committed
700 701
}

702

Jim Blandy's avatar
Jim Blandy committed
703
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
704 705 706 707 708 709 710 711 712 713
       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
714 715
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.
716
If they are on the border between WINDOW and its right sibling,
717 718 719
  `vertical-line' is returned.
If they are in the windows's left or right marginal areas, `left-margin'\n\
  or `right-margin' is returned.  */)
720
     (coordinates, window)
Jim Blandy's avatar
Jim Blandy committed
721 722
     register Lisp_Object coordinates, window;
{
723 724
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
725
  int x, y;
726
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
727

728
  CHECK_LIVE_WINDOW (window);
729 730
  w = XWINDOW (window);
  f = XFRAME (w->frame);
731
  CHECK_CONS (coordinates);
732 733
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
734 735
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
736 737 738 739
  x = PIXEL_X_FROM_CANON_X (f, lx);
  y = PIXEL_Y_FROM_CANON_Y (f, ly);

  switch (coordinates_in_window (w, &x, &y))
Jim Blandy's avatar
Jim Blandy committed
740
    {
741
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
742 743
      return Qnil;

744 745 746
    case ON_TEXT:
      /* X and Y are now window relative pixel coordinates.  Convert
	 them to canonical char units before returning them.  */
747
      return Fcons (CANON_X_FROM_PIXEL_X (f, x),
748
		    CANON_Y_FROM_PIXEL_Y (f, y));
Jim Blandy's avatar
Jim Blandy committed
749

750
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
751
      return Qmode_line;
752

753
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
754
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
755

756
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
757
      return Qheader_line;
758

759 760
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
761

762 763
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
764

765 766
    case ON_LEFT_MARGIN:
      return Qleft_margin;
767

768 769 770
    case ON_RIGHT_MARGIN:
      return Qright_margin;

Jim Blandy's avatar
Jim Blandy committed
771 772 773 774 775
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
776 777

/* Callback for foreach_window, used in window_from_coordinates.
778 779 780 781 782
   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
783
   *CW->part the part of the window under coordinates *X,*Y.  Return
784 785 786 787 788 789 790
   zero from this function to stop iterating over windows.  */

struct check_window_data
{
  Lisp_Object *window;
  int *x, *y, *part;
};
Gerd Moellmann's avatar
Gerd Moellmann committed
791 792

static int
793
check_window_containing (w, user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
794
     struct window *w;
795
     void *user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
796
{
797
  struct check_window_data *cw = (struct check_window_data *) user_data;
798 799
  enum window_part found;
  int continue_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
800

801
  found = coordinates_in_window (w, cw->x, cw->y);
802
  if (found != ON_NOTHING)
Gerd Moellmann's avatar
Gerd Moellmann committed
803
    {
804 805
      *cw->part = found - 1;
      XSETWINDOW (*cw->window, w);
806
      continue_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
807
    }
808

809
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
810 811 812
}


813 814 815 816 817
/* Find the window containing frame-relative pixel position X/Y and
   return it as a Lisp_Object.  If X, Y is on the window's modeline,
   set *PART to 1; if it is on the separating line between the window
   and its right sibling, set it to 2; otherwise set it to 0.  If
   there is no window under X, Y return nil and leave *PART
Gerd Moellmann's avatar
Gerd Moellmann committed
818 819 820 821 822 823 824 825 826 827
   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.  */
828

Jim Blandy's avatar
Jim Blandy committed
829
Lisp_Object
Gerd Moellmann's avatar
Gerd Moellmann committed
830 831
window_from_coordinates (f, x, y, part, tool_bar_p)
     struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
832
     int x, y;
Jim Blandy's avatar
Jim Blandy committed
833
     int *part;
834
     int tool_bar_p;
Jim Blandy's avatar
Jim Blandy committed
835
{
Gerd Moellmann's avatar
Gerd Moellmann committed
836
  Lisp_Object window;
837
  struct check_window_data cw;
838

Gerd Moellmann's avatar
Gerd Moellmann committed
839
  window = Qnil;
840 841
  cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
  foreach_window (f, check_window_containing, &cw);
842

Gerd Moellmann's avatar
Gerd Moellmann committed
843 844 845 846 847 848
  /* 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)
      && XINT (XWINDOW (f->tool_bar_window)->height) > 0
849 850
      && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
	  != ON_NOTHING))
851 852
    {
      *part = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
853
      window = f->tool_bar_window;
854
    }
855

Gerd Moellmann's avatar
Gerd Moellmann committed
856
  return window;
Jim Blandy's avatar
Jim Blandy committed
857 858
}

859
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
860 861 862 863 864 865
       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
866 867
{
  int part;
868
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
869

Jim Blandy's avatar
Jim Blandy committed
870
  if (NILP (frame))
871
    frame = selected_frame;
872
  CHECK_LIVE_FRAME (frame);
873
  f = XFRAME (frame);
Jim Blandy's avatar
Jim Blandy committed
874

875
  /* Check that arguments are integers or floats.  */
876 877
  CHECK_NUMBER_OR_FLOAT (x);
  CHECK_NUMBER_OR_FLOAT (y);
878

879
  return window_from_coordinates (f,
880 881 882
				  PIXEL_X_FROM_CANON_X (f, x),
				  PIXEL_Y_FROM_CANON_Y (f, y),
				  &part, 0);
Jim Blandy's avatar
Jim Blandy committed
883 884 885
}

DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
886 887 888 889 890 891 892 893 894 895
       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
896 897 898 899 900 901 902 903 904 905 906
     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,
907 908 909
       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
910 911 912 913 914
     Lisp_Object window;
{
  return Fmarker_position (decode_window (window)->start);
}

915