window.c 179 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
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 48 49
#ifdef macintosh
#include "macterm.h"
#endif
50

51 52 53 54 55 56 57 58 59 60 61 62 63
/* 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,
  ON_RIGHT_FRINGE
};

64

65
Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
66
Lisp_Object Qwindow_size_fixed;
Gerd Moellmann's avatar
Gerd Moellmann committed
67
extern Lisp_Object Qheight, Qwidth;
Jim Blandy's avatar
Jim Blandy committed
68

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

96 97 98 99
/* The value of `window-size-fixed'.  */

int window_size_fixed;

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

Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
110 111 112 113 114 115
/* 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;

116 117 118
/* 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
119
   the selected window.  */
120

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

/* Non-nil means it is the window for C-M-v to scroll
124 125
   when the mini-buffer is selected.  */

Jim Blandy's avatar
Jim Blandy committed
126 127 128
Lisp_Object Vminibuf_scroll_window;

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

Jim Blandy's avatar
Jim Blandy committed
130 131 132
Lisp_Object Vother_window_scroll_buffer;

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

Jim Blandy's avatar
Jim Blandy committed
134 135
Lisp_Object Vtemp_buffer_show_function;

136 137 138 139
/* 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;
140

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

Jim Blandy's avatar
Jim Blandy committed
143 144 145 146
int window_min_height;
int window_min_width;

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

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

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

Jim Blandy's avatar
Jim Blandy committed
152
int pop_up_frames;
Jim Blandy's avatar
Jim Blandy committed
153

154 155 156 157
/* Nonzero means reuse existing frames for displaying buffers.  */

int display_buffer_reuse_frames;

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

Jim Blandy's avatar
Jim Blandy committed
160
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
161 162

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

Jim Blandy's avatar
Jim Blandy committed
164 165
Lisp_Object Vdisplay_buffer_function;

166 167 168 169
/* Non-nil means that Fdisplay_buffer should even the heights of windows.  */

Lisp_Object Veven_window_heights;

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

172 173 174
Lisp_Object Vspecial_display_buffer_names;

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

176 177 178
Lisp_Object Vspecial_display_regexps;

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

180 181
Lisp_Object Vspecial_display_function;

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

184 185 186
Lisp_Object Vsame_window_buffer_names;

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

188 189
Lisp_Object Vsame_window_regexps;

190
/* Hook run at end of temp_output_buffer_show.  */
191

192 193
Lisp_Object Qtemp_buffer_show_hook;

194
/* Fdisplay_buffer always splits the largest window
Jim Blandy's avatar
Jim Blandy committed
195
   if that window is more than this high.  */
196

Jim Blandy's avatar
Jim Blandy committed
197 198 199
int split_height_threshold;

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

Jim Blandy's avatar
Jim Blandy committed
201 202 203
int next_screen_context_lines;

/* Incremented for each window created.  */
204

Jim Blandy's avatar
Jim Blandy committed
205 206
static int sequence_number;

207
/* Nonzero after init_window_once has finished.  */
208

209 210
static int window_initialized;

211
/* Hook to run when window config changes.  */
212

213 214 215
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

216 217 218
/* Nonzero means scroll commands try to put point
   at the same screen height as previously.  */

219 220 221
Lisp_Object Vscroll_preserve_screen_position;

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

226 227
extern int scroll_margin;

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

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

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

252
  p = allocate_window ();
253 254 255 256 257 258
  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);
259
  XSETFASTINT (p->min_hscroll, 0);
260
  p->orig_top = p->orig_height = Qnil;
Jim Blandy's avatar
Jim Blandy committed
261 262
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
263
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
264
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
265 266
  p->display_table = Qnil;
  p->dedicated = Qnil;
267 268 269 270 271 272 273 274 275 276 277
  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;
  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;
278
  XSETWINDOW (val, p);
279
  XSETFASTINT (p->last_point, 0);
280
  p->frozen_window_start_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
281 282

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
283 284 285 286
  return val;
}

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

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

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


Jim Blandy's avatar
Jim Blandy committed
316
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
317 318 319 320 321 322 323
       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)
324
     Lisp_Object pos, window, partially;
Jim Blandy's avatar
Jim Blandy committed
325 326 327 328
{
  register struct window *w;
  register int posint;
  register struct buffer *buf;
329 330
  struct text_pos top;
  Lisp_Object in_window;
331
  int fully_p;
Jim Blandy's avatar
Jim Blandy committed
332

Miles Bader's avatar
Miles Bader committed
333 334 335 336 337
  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
338
    {
339
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
340 341
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
342 343 344 345
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
346

347
  /* If position is above window start, it's not visible.  */
348
  if (posint < CHARPOS (top))
349 350
    in_window = Qnil;
  else if (XFASTINT (w->last_modified) >= BUF_MODIFF (buf)
Miles Bader's avatar
Miles Bader committed
351 352 353
	   && XFASTINT (w->last_overlay_modified) >= BUF_OVERLAY_MODIFF (buf)
	   && posint < BUF_Z (buf) - XFASTINT (w->window_end_pos))
    {
354 355 356 357
      /* 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.  */
358
      if (NILP (partially))
359
	{
360
	  pos_visible_p (w, posint, &fully_p, NILP (partially));
361 362
	  in_window = fully_p ? Qt : Qnil;
	}
Miles Bader's avatar
Miles Bader committed
363
      else
364
	in_window = Qt;
Miles Bader's avatar
Miles Bader committed
365
    }
366 367 368 369 370
  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
371 372
  else
    {
373 374
      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
375 376
      else
	in_window = Qnil;
Jim Blandy's avatar
Jim Blandy committed
377
    }
378 379

  return in_window;
Jim Blandy's avatar
Jim Blandy committed
380
}
381

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

390
  CHECK_LIVE_WINDOW (window);
Jim Blandy's avatar
Jim Blandy committed
391 392 393 394
  return XWINDOW (window);
}

DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
395 396
       doc: /* Return the buffer that WINDOW is displaying.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
397 398 399 400 401 402
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

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

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
411 412 413 414 415
       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
416 417
     Lisp_Object window;
{
418
  return make_number (window_internal_width (decode_window (window)));
Jim Blandy's avatar
Jim Blandy committed
419 420 421
}

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

DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
430 431 432
       doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
NCOL should be zero or positive.  */)
     (window, ncol)
433
     Lisp_Object window, ncol;
Jim Blandy's avatar
Jim Blandy committed
434
{
435 436
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
437

438
  CHECK_NUMBER (ncol);
439 440 441 442
  hscroll = max (0, XINT (ncol));
  
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
443
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
444
  
445
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
446 447 448
  return ncol;
}

449 450
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
451 452 453
       doc: /* Return WINDOW's redisplay end trigger value.
See `set-window-redisplay-end-trigger' for more information.  */)
     (window)
454 455 456 457 458 459 460
     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,
461 462 463 464 465 466 467
       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)
468 469 470 471 472 473 474 475 476
     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
477
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
478 479 480 481 482 483
       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
484 485 486 487 488
     Lisp_Object window;
{
  register struct window *w = decode_window (window);

  return Fcons (w->left, Fcons (w->top,
489
           Fcons (make_number (WINDOW_RIGHT_EDGE (w)),
Jim Blandy's avatar
Jim Blandy committed
490 491 492 493 494
		  Fcons (make_number (XFASTINT (w->top)
				      + XFASTINT (w->height)),
			 Qnil))));
}

495
/* Test if the character at column *X, row *Y is within window W.
Jim Blandy's avatar
Jim Blandy committed
496 497 498 499 500 501 502
   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,
503 504
      return 3.
   if it is on the window's top line, return 4;
Kim F. Storm's avatar
Kim F. Storm committed
505
   if it is in left or right fringe of the window,
506
   return 5 or 6, and convert *X and *Y to window-relative corrdinates.
507 508 509

   X and Y are frame relative pixel coordinates.  */

510
static enum window_part
Jim Blandy's avatar
Jim Blandy committed
511 512 513 514
coordinates_in_window (w, x, y)
     register struct window *w;
     register int *x, *y;
{
515 516
  /* Let's make this a global enum later, instead of using numbers
     everywhere.  */
517 518
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  int left_x, right_x, top_y, bottom_y;
519
  enum window_part part;
Pavel Janík's avatar
Pavel Janík committed
520
  int ux = CANON_X_UNIT (f);
521 522
  int x0 = XFASTINT (w->left) * ux;
  int x1 = x0 + XFASTINT (w->width) * ux;
523 524 525
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
526 527 528 529

  if (*x < x0 || *x >= x1)
    return ON_NOTHING;
  
530 531
  /* 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.  */
532 533 534
  if (w->pseudo_window_p)
    {
      left_x = 0;
535
      right_x = XFASTINT (w->width) * CANON_X_UNIT (f) - 1;
536 537 538 539 540
      top_y = WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w);
      bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
    }
  else
    {
541
      left_x = (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
542
		- FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
543
      right_x = WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X (w) - 1;
544
      top_y = (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
545
	       - FRAME_INTERNAL_BORDER_WIDTH_SAFE (f));
546 547
      bottom_y = WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y (w);
    }
548

549 550 551 552 553
  /* 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.  */
554

555
  if (WINDOW_WANTS_MODELINE_P (w)
556 557
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w)
      && *y < bottom_y)
558
    {
559 560 561 562 563 564 565 566
      /* 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;
      
      if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
	{
567
	  if (abs (*x - x0) < grabbable_width)
568 569
	    part = ON_VERTICAL_BORDER;
	}
570
      else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < grabbable_width)
571
	part = ON_VERTICAL_BORDER;
572
    }
573 574 575 576 577 578 579 580
  else if (WINDOW_WANTS_HEADER_LINE_P (w)
	   && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w)
	   && *y >= top_y)
    {
      part = ON_HEADER_LINE;
      
      if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
	{
581
	  if (abs (*x - x0) < grabbable_width)
582 583
	    part = ON_VERTICAL_BORDER;
	}
584
      else if (!WINDOW_RIGHTMOST_P (w) && abs (*x - x1) < grabbable_width)
585 586 587 588 589 590
	part = ON_VERTICAL_BORDER;
    }
  /* Outside anything interesting?  */
  else if (*y < top_y
	   || *y >= bottom_y
	   || *x < (left_x
591
		    - FRAME_LEFT_FRINGE_WIDTH (f)
592
		    - FRAME_LEFT_SCROLL_BAR_WIDTH (f) * ux)
593
	   || *x > (right_x
594
		    + FRAME_RIGHT_FRINGE_WIDTH (f)
595
		    + FRAME_RIGHT_SCROLL_BAR_WIDTH (f) * ux))
596
    {
597
      part = ON_NOTHING;
598
    }
599
  else if (FRAME_WINDOW_P (f))
600
    {
601 602 603
      if (!w->pseudo_window_p
	  && !FRAME_HAS_VERTICAL_SCROLL_BARS (f)
	  && !WINDOW_RIGHTMOST_P (w)
604
	  && (abs (*x - right_x - FRAME_RIGHT_FRINGE_WIDTH (f)) < grabbable_width))
605 606 607 608
	{
	  part = ON_VERTICAL_BORDER;
	}
      else if (*x < left_x || *x > right_x)
609
	{
Kim F. Storm's avatar
Kim F. Storm committed
610
	  /* Other lines than the mode line don't include fringes and
611
	     scroll bars on the left.  */
612
      
613 614 615
	  /* Convert X and Y to window-relative pixel coordinates.  */
	  *x -= left_x;
	  *y -= top_y;
616 617 618 619 620 621 622
	  part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
	}
      else
	{
	  *x -= left_x;
	  *y -= top_y;
	  part = ON_TEXT;
623
	}
624
    }
625 626 627 628 629 630
  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
631
	  /* Other lines than the mode line don't include fringes and
632 633 634 635 636
	     scroll bars on the left.  */
      
	  /* Convert X and Y to window-relative pixel coordinates.  */
	  *x -= left_x;
	  *y -= top_y;
637
	  part = *x < left_x ? ON_LEFT_FRINGE : ON_RIGHT_FRINGE;
638 639
	}
      /* Here, too, "*x > right_x" is because of character terminals.  */
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
      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
	{
	  /* Convert X and Y to window-relative pixel coordinates.  */
	  *x -= left_x;
	  *y -= top_y;
	  part = ON_TEXT;
	}
655
    }
656 657

  return part;
Jim Blandy's avatar
Jim Blandy committed
658 659
}

660

Jim Blandy's avatar
Jim Blandy committed
661
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
662 663 664 665 666 667 668 669 670 671
       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
672 673
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.
674 675 676
If they are on the border between WINDOW and its right sibling,
  `vertical-line' is returned.  */)
     (coordinates, window)
Jim Blandy's avatar
Jim Blandy committed
677 678
     register Lisp_Object coordinates, window;
{
679 680
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
681
  int x, y;
682
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
683

684
  CHECK_LIVE_WINDOW (window);
685 686
  w = XWINDOW (window);
  f = XFRAME (w->frame);
687
  CHECK_CONS (coordinates);
688 689
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
690 691
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
692 693 694 695
  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
696
    {
697
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
698 699
      return Qnil;

700 701 702
    case ON_TEXT:
      /* X and Y are now window relative pixel coordinates.  Convert
	 them to canonical char units before returning them.  */
703 704
      return Fcons (CANON_X_FROM_PIXEL_X (f, x), 
		    CANON_Y_FROM_PIXEL_Y (f, y));
Jim Blandy's avatar
Jim Blandy committed
705

706
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
707
      return Qmode_line;
708

709
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
710
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
711

712
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
713
      return Qheader_line;
714

715 716
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
717
      
718 719
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
720

Jim Blandy's avatar
Jim Blandy committed
721 722 723 724 725
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
726 727

/* Callback for foreach_window, used in window_from_coordinates.
728 729 730 731 732
   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
733
   *CW->part the part of the window under coordinates *X,*Y.  Return
734 735 736 737 738 739 740
   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
741 742

static int
743
check_window_containing (w, user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
744
     struct window *w;
745
     void *user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
746
{
747
  struct check_window_data *cw = (struct check_window_data *) user_data;
748 749
  enum window_part found;
  int continue_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
750

751
  found = coordinates_in_window (w, cw->x, cw->y);
752
  if (found != ON_NOTHING)
Gerd Moellmann's avatar
Gerd Moellmann committed
753
    {
754 755
      *cw->part = found - 1;
      XSETWINDOW (*cw->window, w);
756
      continue_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
757 758
    }
  
759
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
760 761 762
}


763 764 765 766 767
/* 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
768 769 770 771 772 773 774 775 776 777
   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.  */
778

Jim Blandy's avatar
Jim Blandy committed
779
Lisp_Object
Gerd Moellmann's avatar
Gerd Moellmann committed
780 781
window_from_coordinates (f, x, y, part, tool_bar_p)
     struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
782
     int x, y;
Jim Blandy's avatar
Jim Blandy committed
783
     int *part;
784
     int tool_bar_p;
Jim Blandy's avatar
Jim Blandy committed
785
{
Gerd Moellmann's avatar
Gerd Moellmann committed
786
  Lisp_Object window;
787
  struct check_window_data cw;
788

Gerd Moellmann's avatar
Gerd Moellmann committed
789
  window = Qnil;
790 791
  cw.window = &window, cw.x = &x, cw.y = &y; cw.part = part;
  foreach_window (f, check_window_containing, &cw);
Gerd Moellmann's avatar
Gerd Moellmann committed
792 793 794 795 796 797 798
  
  /* 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
799 800
      && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
	  != ON_NOTHING))
801 802
    {
      *part = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
803
      window = f->tool_bar_window;
804
    }
805

Gerd Moellmann's avatar
Gerd Moellmann committed
806
  return window;
Jim Blandy's avatar
Jim Blandy committed
807 808
}

809
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
810 811 812 813 814 815
       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
816 817
{
  int part;
818
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
819

Jim Blandy's avatar
Jim Blandy committed
820
  if (NILP (frame))
821
    frame = selected_frame;
822
  CHECK_LIVE_FRAME (frame);
823
  f = XFRAME (frame);
Jim Blandy's avatar
Jim Blandy committed
824

825
  /* Check that arguments are integers or floats.  */
826 827
  CHECK_NUMBER_OR_FLOAT (x);
  CHECK_NUMBER_OR_FLOAT (y);
828 829 830 831 832

  return window_from_coordinates (f, 
				  PIXEL_X_FROM_CANON_X (f, x),
				  PIXEL_Y_FROM_CANON_Y (f, y),
				  &part, 0);
Jim Blandy's avatar
Jim Blandy committed
833 834 835
}

DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
836 837 838 839 840 841 842 843 844 845
       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
846 847 848 849 850 851 852 853 854 855 856
     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,
857 858 859
       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
860 861 862 863 864
     Lisp_Object window;
{
  return Fmarker_position (decode_window (window)->start);
}

865 866
/* This is text temporarily removed from the doc string below.

867 868 869 870 871 872 873
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)
874 875
      (point))")  */

876
DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
877 878 879 880 881 882 883
       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.
If UPDATE is non-nil, compute the up-to-date position
if it isn't already recorded.  */)
     (window, update)
884
     Lisp_Object window, update;
Jim Blandy's avatar
Jim Blandy committed
885 886 887
{
  Lisp_Object value;
  struct window *w = decode_window (window);
888 889 890
  Lisp_Object buf;

  buf = w->buffer;
891
  CHECK_BUFFER (buf);
892

893
#if 0 /* This change broke some things.  We should make it later.  */
894 895 896 897 898 899
  /* If we don't know the end position, return nil.
     The user can compute it with vertical-motion if he wants to.
     It would be nicer to do it automatically,
     but that's so slow that it would probably bother people.  */
  if (NILP (w->window_end_valid))
    return Qnil;
900
#endif
901

902 903 904 905
  if (! NILP (update)
      && ! (! NILP (w->window_end_valid)
	    && XFASTINT (w->last_modified) >= MODIFF))
    {
906 907
      struct text_pos startp;
      struct it it;
908
      struct buffer *old_buffer = NULL, *b = XBUFFER (buf);
909 910 911 912 913

      /* In case W->start is out of the range, use something
         reasonable.  This situation occured when loading a file with
         `-l' containing a call to `rmail' with subsequent other
         commands.  At the end, W->start happened to be BEG, while
914
         rmail had already narrowed the buffer.  */
915
      if (XMARKER (w->start)->charpos < BEGV)
916
	SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
917
      else if (XMARKER (w->start)->charpos > ZV)
918
	SET_TEXT_POS (startp, ZV, ZV_BYTE);
919
      else
920 921 922 923
	SET_TEXT_POS_FROM_MARKER (startp, w->start);

      /* Cannot use Fvertical_motion because that function doesn't
	 cope with variable-height lines.  */
924 925 926 927 928 929
      if (b != current_buffer)
	{
	  old_buffer = current_buffer;
	  set_buffer_internal (b);
	}
      
930 931
      start_display (&it, w, startp);
      move_it_vertically (&it, window_box_height (w));
932 933
      if (it.current_y < it.last_visible_y)
	move_it_past_eol (&it);
934
      value = make_number (IT_CHARPOS (it));
935 936 937
      
      if (old_buffer)
	set_buffer_internal (old_buffer);
938 939
    }
  else
940
    XSETINT (value, BUF_Z (XBUFFER (buf)) - XFASTINT (w->window_end_pos));
Jim Blandy's avatar
Jim Blandy committed
941 942 943 944 945

  return value;
}

DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
946 947
       doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer.  */)
     (window, pos)
Jim Blandy's avatar
Jim Blandy committed
948 949 950 951
     Lisp_Object window, pos;
{
  register struct window *w = decode_window (window);

952
  CHECK_NUMBER_COERCE_MARKER (pos);