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
Lisp_Object minibuf_window;

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

Lisp_Object Vminibuf_selected_window;

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

Jim Blandy's avatar
Jim Blandy committed
131 132 133
Lisp_Object Vminibuf_scroll_window;

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

Jim Blandy's avatar
Jim Blandy committed
135 136 137
Lisp_Object Vother_window_scroll_buffer;

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

Jim Blandy's avatar
Jim Blandy committed
139 140
Lisp_Object Vtemp_buffer_show_function;

141 142 143 144
/* 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;
145

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

Jim Blandy's avatar
Jim Blandy committed
148 149 150 151
int window_min_height;
int window_min_width;

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

Jim Blandy's avatar
Jim Blandy committed
153 154
int pop_up_windows;

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

Jim Blandy's avatar
Jim Blandy committed
157
int pop_up_frames;
Jim Blandy's avatar
Jim Blandy committed
158

159 160 161 162
/* Nonzero means reuse existing frames for displaying buffers.  */

int display_buffer_reuse_frames;

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

Jim Blandy's avatar
Jim Blandy committed
165
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
166 167

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

Jim Blandy's avatar
Jim Blandy committed
169 170
Lisp_Object Vdisplay_buffer_function;

171 172 173 174
/* Non-nil means that Fdisplay_buffer should even the heights of windows.  */

Lisp_Object Veven_window_heights;

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

177 178 179
Lisp_Object Vspecial_display_buffer_names;

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

181 182 183
Lisp_Object Vspecial_display_regexps;

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

185 186
Lisp_Object Vspecial_display_function;

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

189 190 191
Lisp_Object Vsame_window_buffer_names;

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

193 194
Lisp_Object Vsame_window_regexps;

195
/* Hook run at end of temp_output_buffer_show.  */
196

197 198
Lisp_Object Qtemp_buffer_show_hook;

199
/* Fdisplay_buffer always splits the largest window
Jim Blandy's avatar
Jim Blandy committed
200
   if that window is more than this high.  */
201

Jim Blandy's avatar
Jim Blandy committed
202 203 204
int split_height_threshold;

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

Jim Blandy's avatar
Jim Blandy committed
206 207 208
int next_screen_context_lines;

/* Incremented for each window created.  */
209

Jim Blandy's avatar
Jim Blandy committed
210 211
static int sequence_number;

212
/* Nonzero after init_window_once has finished.  */
213

214 215
static int window_initialized;

216
/* Hook to run when window config changes.  */
217

218 219 220
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

221 222 223
/* Nonzero means scroll commands try to put point
   at the same screen height as previously.  */

224 225 226
Lisp_Object Vscroll_preserve_screen_position;

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

231 232
extern int scroll_margin;

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

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

Jim Blandy's avatar
Jim Blandy committed
251 252 253
Lisp_Object
make_window ()
{
254
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
255
  register struct window *p;
256

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

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

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

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

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


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

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

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

  return in_window;
Jim Blandy's avatar
Jim Blandy committed
385
}
386

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

395
  CHECK_LIVE_WINDOW (window);
Jim Blandy's avatar
Jim Blandy committed
396 397 398 399
  return XWINDOW (window);
}

DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
400 401
       doc: /* Return the buffer that WINDOW is displaying.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
402 403 404 405 406 407
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

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

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

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

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

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

454 455
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
456 457 458
       doc: /* Return WINDOW's redisplay end trigger value.
See `set-window-redisplay-end-trigger' for more information.  */)
     (window)
459 460 461 462 463 464 465
     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,
466 467 468 469 470 471 472
       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)
473 474 475 476 477 478 479 480 481
     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
482
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
483 484 485 486 487 488
       doc: /* Return a list of the edge coordinates of WINDOW.
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
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
489 490 491 492 493
     Lisp_Object window;
{
  register struct window *w = decode_window (window);

  return Fcons (w->left, Fcons (w->top,
494
           Fcons (make_number (WINDOW_RIGHT_EDGE (w)),
Jim Blandy's avatar
Jim Blandy committed
495 496 497 498 499
		  Fcons (make_number (XFASTINT (w->top)
				      + XFASTINT (w->height)),
			 Qnil))));
}

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

   X and Y are frame relative pixel coordinates.  */

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

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

554 555 556 557 558
  /* 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.  */
559

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

  return part;
Jim Blandy's avatar
Jim Blandy committed
663 664
}

665

Jim Blandy's avatar
Jim Blandy committed
666
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
667 668 669 670 671 672 673 674 675 676
       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
677 678
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.
679 680 681
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
682 683
     register Lisp_Object coordinates, window;
{
684 685
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
686
  int x, y;
687
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
688

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

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

711
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
712
      return Qmode_line;
713

714
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
715
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
716

717
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
718
      return Qheader_line;
719

720 721
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
722
      
723 724
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
725

Jim Blandy's avatar
Jim Blandy committed
726 727 728 729 730
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
731 732

/* Callback for foreach_window, used in window_from_coordinates.
733 734 735 736 737
   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
738
   *CW->part the part of the window under coordinates *X,*Y.  Return
739 740 741 742 743 744 745
   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
746 747

static int
748
check_window_containing (w, user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
749
     struct window *w;
750
     void *user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
751
{
752
  struct check_window_data *cw = (struct check_window_data *) user_data;
753 754
  enum window_part found;
  int continue_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
755

756
  found = coordinates_in_window (w, cw->x, cw->y);
757
  if (found != ON_NOTHING)
Gerd Moellmann's avatar
Gerd Moellmann committed
758
    {
759 760
      *cw->part = found - 1;
      XSETWINDOW (*cw->window, w);
761
      continue_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
762 763
    }
  
764
  return continue_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
765 766 767
}


768 769 770 771 772
/* 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
773 774 775 776 777 778 779 780 781 782
   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.  */
783

Jim Blandy's avatar
Jim Blandy committed
784
Lisp_Object
Gerd Moellmann's avatar
Gerd Moellmann committed
785 786
window_from_coordinates (f, x, y, part, tool_bar_p)
     struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
787
     int x, y;
Jim Blandy's avatar
Jim Blandy committed
788
     int *part;
789
     int tool_bar_p;
Jim Blandy's avatar
Jim Blandy committed
790
{
Gerd Moellmann's avatar
Gerd Moellmann committed
791
  Lisp_Object window;
792
  struct check_window_data cw;
793

Gerd Moellmann's avatar
Gerd Moellmann committed
794
  window = Qnil;
795 796
  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
797 798 799 800 801 802 803
  
  /* 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
804 805
      && (coordinates_in_window (XWINDOW (f->tool_bar_window), &x, &y)
	  != ON_NOTHING))
806 807
    {
      *part = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
808
      window = f->tool_bar_window;
809
    }
810

Gerd Moellmann's avatar
Gerd Moellmann committed
811
  return window;
Jim Blandy's avatar
Jim Blandy committed
812 813
}

814
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
815 816 817 818 819 820
       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
821 822
{
  int part;
823
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
824

Jim Blandy's avatar
Jim Blandy committed
825
  if (NILP (frame))
826
    frame = selected_frame;
827
  CHECK_LIVE_FRAME (frame);
828
  f = XFRAME (frame);
Jim Blandy's avatar
Jim Blandy committed
829

830
  /* Check that arguments are integers or floats.  */
831 832
  CHECK_NUMBER_OR_FLOAT (x);
  CHECK_NUMBER_OR_FLOAT (y);
833 834 835 836 837

  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
838 839 840
}

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

870 871
/* This is text temporarily removed from the doc string below.

872 873 874 875 876 877 878
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)
879 880
      (point))")  */

881
DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
882 883 884 885 886 887 888
       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)
889
     Lisp_Object window, update;
Jim Blandy's avatar
Jim Blandy committed
890 891 892
{
  Lisp_Object value;
  struct window *w = decode_window (window);
893 894 895
  Lisp_Object buf;

  buf = w->buffer;
896
  CHECK_BUFFER (buf);
897

898
#if 0 /* This change broke some things.  We should make it later.  */
899 900 901 902 903 904
  /* 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;
905
#endif
906

907 908 909 910
  if (! NILP (update)
      && ! (! NILP (w->window_end_valid)
	    && XFASTINT (w->last_modified) >= MODIFF))
    {
911 912
      struct text_pos startp;
      struct it it;
913
      struct buffer *old_buffer = NULL, *b = XBUFFER (buf);
914 915 916 917 918

      /* 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
919
         rmail had already narrowed the buffer.  */
920
      if (XMARKER (w->start)->charpos < BEGV)
921
	SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
922
      else if (XMARKER (w->start)->charpos > ZV)
923
	SET_TEXT_POS (startp, ZV, ZV_BYTE);
924
      else
925 926 927 928
	SET_TEXT_POS_FROM_MARKER (startp, w->start);

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

  return value;
}

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

957
  CHECK_NUMBER_COERCE_MARKER (pos);
958 959
  if (w == XWINDOW (selected_window)
      && XBUFFER (w->buffer) == current_buffer)
Jim Blandy's avatar
Jim Blandy committed
960 961 962
    Fgoto_char (pos);
  else
    set_marker_restricted (w->pointm, pos, w->buffer);
963

964 965 966
  /* We have to make sure that redisplay updates the window to show
     the new value of point.  */
  if (!EQ (window, selected_window))
967
    ++windows_or_buffers_changed;
968
  
Jim Blandy's avatar
Jim Blandy committed
969 970 971 972
  return pos;
}

DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
973 974 975 976
       doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
Optional third arg NOFORCE non-nil inhibits next redisplay
from overriding motion of point in order to display at this exact start.  */)
     (window, pos, noforce)
Jim Blandy's avatar
Jim Blandy committed
977 978 979 980
     Lisp_Object window, pos, noforce;
{
  register struct window *w = decode_window (window);

981
  CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
982 983 984
  set_marker_restricted (w->start, pos, w->buffer);
  /* this is not right, but much easier than doing what is right. */
  w->start_at_line_beg = Qnil;
Jim Blandy's avatar
Jim Blandy committed
985
  if (NILP (noforce))
Jim Blandy's avatar
Jim Blandy committed
986 987
    w->force_start = Qt;
  w->update_mode_line = Qt;
988
  XSETFASTINT (w->last_modified, 0);
989
  XSETFASTINT (w->last_overlay_modified, 0);
Jim Blandy's avatar
Jim Blandy committed
990 991
  if (!EQ (window, selected_window))
    windows_or_buffers_changed++;
992

Jim Blandy's avatar
Jim Blandy committed
993 994 995 996 997
  return pos;
}

DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
       1, 1, 0,
998 999 1000
       doc: /* Return WINDOW's dedicated object, usually t or nil.
See also `set-window-dedicated-p'.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
1001 1002 1003 1004 1005
     Lisp_Object window;
{
  return decode_window (window)->dedicated;
}

1006 1007
DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
       Sset_window_dedicated_p, 2, 2, 0,
1008 1009 1010 1011 1012 1013 1014
       doc: /* Control whether WINDOW is dedicated to the buffer it displays.
If it is dedicated, Emacs will not automatically change
which buffer appears in it.
The second argument is the new value for the dedication flag;
non-nil means yes. */)
     (window, arg)
     Lisp_Object window, arg;
Jim Blandy's avatar
Jim Blandy committed
1015 1016 1017
{
  register struct window *w = decode_window (window);

Jim Blandy's avatar
Jim Blandy committed
1018
  if (NILP (arg))
Jim Blandy's avatar
Jim Blandy committed
1019 1020
    w->dedicated = Qnil;
  else
1021
    w->dedicated = Qt;
Jim Blandy's avatar
Jim Blandy committed
1022 1023 1024 1025 1026 1027

  return w->dedicated;
}

DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
       0, 1, 0,
1028 1029
       doc: /* Return the display-table that WINDOW is using.  */)
     (window)
Jim Blandy's avatar
Jim Blandy committed
1030 1031 1032 1033 1034
     Lisp_Object window;
{
  return decode_window (window)->display_table;
}

1035 1036 1037 1038
/* Get the display table for use on window W.  This is either W's
   display table or W's buffer's display table.  Ignore the specified
   tables if they are not valid; if no valid table is specified,
   return 0.  */
Jim Blandy's avatar
Jim Blandy committed
1039

1040
struct Lisp_Cha