window.c 232 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
/* Window creation, deletion and examination for GNU Emacs.
   Does not include redisplay.
3
   Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 2000,
Glenn Morris's avatar
Glenn Morris committed
4
                 2001, 2002, 2003, 2004, 2005, 2006, 2007 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
10
the Free Software Foundation; either version 3, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
any later version.

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

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

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

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


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

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

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

Lisp_Object selected_window;

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

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

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

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

110
Lisp_Object minibuf_selected_window;
111

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

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

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

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

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

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

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

int auto_window_vscroll_p;

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

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

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

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

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

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

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

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

int display_buffer_reuse_frames;

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

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

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

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

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

Lisp_Object Veven_window_heights;

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

166 167 168
Lisp_Object Vspecial_display_buffer_names;

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

170 171 172
Lisp_Object Vspecial_display_regexps;

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

174 175
Lisp_Object Vspecial_display_function;

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

178 179 180
Lisp_Object Vsame_window_buffer_names;

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

182 183
Lisp_Object Vsame_window_regexps;

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

186 187
Lisp_Object Qtemp_buffer_show_hook;

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

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

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

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

/* Incremented for each window created.  */
198

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

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

203 204
static int window_initialized;

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

207 208 209
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

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

213 214
Lisp_Object Vscroll_preserve_screen_position;

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

int window_deletion_count;

219 220
/* Used by the function window_scroll_pixel_based */

221
static int window_scroll_pixel_based_preserve_y;
222

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

228
extern EMACS_INT scroll_margin;
229

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

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

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

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

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

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

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

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


Jim Blandy's avatar
Jim Blandy committed
330
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
331
       Spos_visible_in_window_p, 0, 3, 0,
332
       doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
333 334 335
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.
336
If POS is only out of view because of horizontal scrolling, return non-nil.
337
If POS is t, it specifies the position of the last visible glyph in WINDOW.
338 339 340
POS defaults to point in WINDOW; WINDOW defaults to the selected window.

If POS is visible, return t if PARTIALLY is nil; if PARTIALLY is non-nil,
341 342 343 344
return value is a list of 2 or 6 elements (X Y [RTOP RBOT ROWH VPOS]),
where X and Y are the pixel coordinates relative to the top left corner
of the window.  The remaining elements are omitted if the character after
POS is fully visible; otherwise, RTOP and RBOT are the number of pixels
345
off-window at the top and bottom of the row, ROWH is the height of the
346
display row, and VPOS is the row number (0-based) containing POS.  */)
347
     (pos, window, partially)
348
     Lisp_Object pos, window, partially;
Jim Blandy's avatar
Jim Blandy committed
349 350 351 352
{
  register struct window *w;
  register int posint;
  register struct buffer *buf;
353
  struct text_pos top;
354
  Lisp_Object in_window = Qnil;
355
  int rtop, rbot, rowh, vpos, fully_p = 1;
356
  int x, y;
Jim Blandy's avatar
Jim Blandy committed
357

Miles Bader's avatar
Miles Bader committed
358 359 360 361
  w = decode_window (window);
  buf = XBUFFER (w->buffer);
  SET_TEXT_POS_FROM_MARKER (top, w->start);

362 363 364
  if (EQ (pos, Qt))
    posint = -1;
  else if (!NILP (pos))
Jim Blandy's avatar
Jim Blandy committed
365
    {
366
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
367 368
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
369 370 371 372
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
373

374 375
  /* If position is above window start or outside buffer boundaries,
     or if window start is out of range, position is not visible.  */
376 377
  if ((EQ (pos, Qt)
       || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
378 379
      && CHARPOS (top) >= BUF_BEGV (buf)
      && CHARPOS (top) <= BUF_ZV (buf)
380
      && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
381
      && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
382 383 384
    in_window = Qt;

  if (!NILP (in_window) && !NILP (partially))
385 386 387 388 389 390 391 392 393
    {
      Lisp_Object part = Qnil;
      if (!fully_p)
	part = list4 (make_number (rtop), make_number (rbot),
			make_number (rowh), make_number (vpos));
      in_window = Fcons (make_number (x),
			 Fcons (make_number (y), part));
    }

394
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
395
}
396

397
DEFUN ("window-line-height", Fwindow_line_height,
398
       Swindow_line_height, 0, 2, 0,
399 400 401
       doc: /* Return height in pixels of text line LINE in window WINDOW.
If WINDOW is nil or omitted, use selected window.

402 403 404 405
Return height of current line if LINE is omitted or nil.  Return height of
header or mode line if LINE is `header-line' and `mode-line'.
Otherwise, LINE is a text line number starting from 0.  A negative number
counts from the end of the window.
406

407
Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
408
in pixels of the visible part of the line, VPOS and YPOS are the
409
vertical position in lines and pixels of the line, relative to the top
410
of the first text line, and OFFBOT is the number of off-window pixels at
411 412
the bottom of the text line.  If there are off-window pixels at the top
of the (first) text line, YPOS is negative.
413 414 415 416 417

Return nil if window display is not up-to-date.  In that case, use
`pos-visible-in-window-p' to obtain the information.  */)
     (line, window)
     Lisp_Object line, window;
418 419 420 421
{
  register struct window *w;
  register struct buffer *b;
  struct glyph_row *row, *end_row;
422
  int max_y, crop, i, n;
423 424 425 426 427

  w = decode_window (window);

  if (noninteractive
      || w->pseudo_window_p)
428
    return Qnil;
429 430 431 432 433 434 435 436 437 438 439 440

  CHECK_BUFFER (w->buffer);
  b = XBUFFER (w->buffer);

  /* Fail if current matrix is not up-to-date.  */
  if (NILP (w->window_end_valid)
      || current_buffer->clip_changed
      || current_buffer->prevent_redisplay_optimizations_p
      || XFASTINT (w->last_modified) < BUF_MODIFF (b)
      || XFASTINT (w->last_overlay_modified) < BUF_OVERLAY_MODIFF (b))
    return Qnil;

441 442 443 444 445 446 447 448 449 450
  if (NILP (line))
    {
      i = w->cursor.vpos;
      if (i < 0 || i >= w->current_matrix->nrows
	  || (row = MATRIX_ROW (w->current_matrix, i), !row->enabled_p))
	return Qnil;
      max_y = window_text_bottom_y (w);
      goto found_row;
    }

451
  if (EQ (line, Qheader_line))
452
    {
453 454 455
      if (!WINDOW_WANTS_HEADER_LINE_P (w))
	return Qnil;
      row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
456 457
      if (!row->enabled_p)
	return Qnil;
458 459 460
      return list4 (make_number (row->height),
		    make_number (0), make_number (0),
		    make_number (0));
461
    }
462 463

  if (EQ (line, Qmode_line))
464
    {
465 466 467 468 469 470 471 472 473
      row = MATRIX_MODE_LINE_ROW (w->current_matrix);
      if (!row->enabled_p)
	return Qnil;
      return list4 (make_number (row->height),
		    make_number (0), /* not accurate */
		    make_number (WINDOW_HEADER_LINE_HEIGHT (w)
				 + window_text_bottom_y (w)),
		    make_number (0));
    }
474

475
  CHECK_NUMBER (line);
476
  n = XINT (line);
477 478 479 480

  row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
  end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
  max_y = window_text_bottom_y (w);
481
  i = 0;
482 483 484 485 486

  while ((n < 0 || i < n)
	 && row <= end_row && row->enabled_p
	 && row->y + row->height < max_y)
    row++, i++;
487

488 489 490
  if (row > end_row || !row->enabled_p)
    return Qnil;

491
  if (++n < 0)
492 493 494
    {
      if (-n > i)
	return Qnil;
495 496
      row += n;
      i += n;
497 498
    }

499
 found_row:
500 501
  crop = max (0, (row->y + row->height) - max_y);
  return list4 (make_number (row->height + min (0, row->y) - crop),
502
		make_number (i),
503 504
		make_number (row->y),
		make_number (crop));
505 506
}

507

Jim Blandy's avatar
Jim Blandy committed
508 509 510 511 512

static struct window *
decode_window (window)
     register Lisp_Object window;
{
Jim Blandy's avatar
Jim Blandy committed
513
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
514 515
    return XWINDOW (selected_window);

516
  CHECK_LIVE_WINDOW (window);
Jim Blandy's avatar
Jim Blandy committed
517 518 519
  return XWINDOW (window);
}

520 521 522 523 524 525 526 527 528 529 530
static struct window *
decode_any_window (window)
     register Lisp_Object window;
{
  if (NILP (window))
    return XWINDOW (selected_window);

  CHECK_WINDOW (window);
  return XWINDOW (window);
}

Jim Blandy's avatar
Jim Blandy committed
531
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
532 533
       doc: /* Return the buffer that WINDOW is displaying.
WINDOW defaults to the selected window.  */)
534
     (window)
Jim Blandy's avatar
Jim Blandy committed
535 536 537 538 539 540
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
541 542
       doc: /* Return the number of lines in WINDOW (including its mode line).
WINDOW defaults to the selected window.  */)
543
     (window)
Jim Blandy's avatar
Jim Blandy committed
544 545
     Lisp_Object window;
{
546
  return decode_any_window (window)->total_lines;
Jim Blandy's avatar
Jim Blandy committed
547 548 549
}

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
550 551 552 553 554
       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
555 556
     Lisp_Object window;
{
557
  return make_number (window_box_text_cols (decode_any_window (window)));
Jim Blandy's avatar
Jim Blandy committed
558 559
}

560 561 562 563 564 565 566 567 568
DEFUN ("window-full-width-p", Fwindow_full_width_p, Swindow_full_width_p, 0, 1, 0,
       doc: /* Return t if WINDOW is as wide as its frame.
WINDOW defaults to the selected window.  */)
     (window)
     Lisp_Object window;
{
  return WINDOW_FULL_WIDTH_P (decode_any_window (window)) ? Qt : Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
569
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
570 571
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
WINDOW defaults to the selected window.  */)
572
     (window)
Jim Blandy's avatar
Jim Blandy committed
573 574 575 576 577 578
     Lisp_Object window;
{
  return decode_window (window)->hscroll;
}

DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
579
       doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
580
Return NCOL.  NCOL should be zero or positive.
581 582

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
583
window so that the location of point moves off-window.  */)
584
     (window, ncol)
585
     Lisp_Object window, ncol;
Jim Blandy's avatar
Jim Blandy committed
586
{
587 588
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
589

590
  CHECK_NUMBER (ncol);
591
  hscroll = max (0, XINT (ncol));
592

593 594
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
595
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
596

597
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
598 599 600
  return ncol;
}

601 602
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
603
       doc: /* Return WINDOW's redisplay end trigger value.
604
WINDOW defaults to the selected window.
605 606
See `set-window-redisplay-end-trigger' for more information.  */)
     (window)
607 608 609 610 611 612 613
     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,
614 615 616 617 618 619 620
       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)
621 622 623 624 625 626 627 628 629
     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
630
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
631 632
       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.
633 634 635 636 637
RIGHT is one more than the rightmost column occupied by WINDOW,
and BOTTOM is one more than the bottommost row occupied by WINDOW.
The edges include the space used by the window's scroll bar,
display margins, fringes, header line, and mode line, if it has them.
To get the edges of the actual text area, use `window-inside-edges'.  */)
638
     (window)
Jim Blandy's avatar
Jim Blandy committed
639 640
     Lisp_Object window;
{
641
  register struct window *w = decode_any_window (window);
Jim Blandy's avatar
Jim Blandy committed
642

643 644 645 646 647
  return Fcons (make_number (WINDOW_LEFT_EDGE_COL (w)),
	 Fcons (make_number (WINDOW_TOP_EDGE_LINE (w)),
	 Fcons (make_number (WINDOW_RIGHT_EDGE_COL (w)),
	 Fcons (make_number (WINDOW_BOTTOM_EDGE_LINE (w)),
		Qnil))));
Jim Blandy's avatar
Jim Blandy committed
648 649
}

650 651 652 653 654 655 656 657 658 659 660
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
RIGHT is one more than the rightmost x position occupied by WINDOW,
and BOTTOM is one more than the bottommost y position occupied by WINDOW.
The pixel edges include the space used by the window's scroll bar,
display margins, fringes, header line, and mode line, if it has them.
To get the edges of the actual text area, use `window-inside-pixel-edges'.  */)
     (window)
     Lisp_Object window;
{
661
  register struct window *w = decode_any_window (window);
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679

  return Fcons (make_number (WINDOW_LEFT_EDGE_X (w)),
	 Fcons (make_number (WINDOW_TOP_EDGE_Y (w)),
	 Fcons (make_number (WINDOW_RIGHT_EDGE_X (w)),
	 Fcons (make_number (WINDOW_BOTTOM_EDGE_Y (w)),
		Qnil))));
}

DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
       doc: /* Return a list of the edge coordinates of WINDOW.
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
RIGHT is one more than the rightmost column used by text in WINDOW,
and BOTTOM is one more than the bottommost row used by text in WINDOW.
The inside edges do not include the space used by the window's scroll bar,
display margins, fringes, header line, and/or mode line.  */)
     (window)
     Lisp_Object window;
{
680
  register struct window *w = decode_any_window (window);
681 682 683 684 685 686

  return list4 (make_number (WINDOW_BOX_LEFT_EDGE_COL (w)
			     + WINDOW_LEFT_MARGIN_COLS (w)
			     + WINDOW_LEFT_FRINGE_COLS (w)),
		make_number (WINDOW_TOP_EDGE_LINE (w)
			     + WINDOW_HEADER_LINE_LINES (w)),
687
		make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
688 689 690 691 692 693 694
			     - WINDOW_RIGHT_MARGIN_COLS (w)
			     - WINDOW_RIGHT_FRINGE_COLS (w)),
		make_number (WINDOW_BOTTOM_EDGE_LINE (w)
			     - WINDOW_MODE_LINE_LINES (w)));
}

DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0,
695
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
696 697 698 699 700 701 702 703
\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
RIGHT is one more than the rightmost x position used by text in WINDOW,
and BOTTOM is one more than the bottommost y position used by text in WINDOW.
The inside edges do not include the space used by the window's scroll bar,
display margins, fringes, header line, and/or mode line.  */)
     (window)
     Lisp_Object window;
{
704
  register struct window *w = decode_any_window (window);
705 706 707 708 709 710

  return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
			     + WINDOW_LEFT_MARGIN_WIDTH (w)
			     + WINDOW_LEFT_FRINGE_WIDTH (w)),
		make_number (WINDOW_TOP_EDGE_Y (w)
			     + WINDOW_HEADER_LINE_HEIGHT (w)),
711
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
712 713 714 715 716 717
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

718
/* Test if the character at column *X, row *Y is within window W.
719
   If it is not, return ON_NOTHING;
Jim Blandy's avatar
Jim Blandy committed
720 721 722
   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
723 724
      return ON_TEXT;
   if it is on the window's modeline, return ON_MODE_LINE;
Jim Blandy's avatar
Jim Blandy committed
725
   if it is on the border between the window and its right sibling,
726
      return ON_VERTICAL_BORDER.
727 728
   if it is on a scroll bar,
      return ON_SCROLL_BAR.
729
   if it is on the window's top line, return ON_HEADER_LINE;
Kim F. Storm's avatar
Kim F. Storm committed
730
   if it is in left or right fringe of the window,
731 732
      return ON_LEFT_FRINGE or ON_RIGHT_FRINGE, and convert *X and *Y
      to window-relative coordinates;
733
   if it is in the marginal area to the left/right of the window,
734 735
      return ON_LEFT_MARGIN or ON_RIGHT_MARGIN, and convert *X and *Y
      to window-relative coordinates.
736 737 738

   X and Y are frame relative pixel coordinates.  */

739
static enum window_part
Jim Blandy's avatar
Jim Blandy committed
740 741 742 743
coordinates_in_window (w, x, y)
     register struct window *w;
     register int *x, *y;
{
744 745
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  int left_x, right_x, top_y, bottom_y;
746
  enum window_part part;
747 748 749
  int ux = FRAME_COLUMN_WIDTH (f);
  int x0 = WINDOW_LEFT_EDGE_X (w);
  int x1 = WINDOW_RIGHT_EDGE_X (w);
750 751 752
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
753
  int lmargin_width, rmargin_width, text_left, text_right;
754

755 756
  /* 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.  */
757 758 759
  if (w->pseudo_window_p)
    {
      left_x = 0;
760 761 762
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
      top_y = WINDOW_TOP_EDGE_Y (w);
      bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
763 764 765
    }
  else
    {
766 767 768 769
      left_x = WINDOW_BOX_LEFT_EDGE_X (w);
      right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
      top_y = WINDOW_TOP_EDGE_Y (w);
      bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
770
    }
771

772 773 774 775
  /* Outside any interesting row?  */
  if (*y < top_y || *y >= bottom_y)
    return ON_NOTHING;

776 777 778 779 780
  /* 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.  */
781

782
  if (WINDOW_WANTS_MODELINE_P (w)
783
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
784
    {
785 786 787
      part = ON_MODE_LINE;

    header_vertical_border_check:
788 789 790 791
      /* 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.  */
792 793
      if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
	  || WINDOW_RIGHTMOST_P (w))
794
	{
795
	  if (!WINDOW_LEFTMOST_P (w) && abs (*x - x0) < grabbable_width)
796
	    {
797 798
	      /* Convert X and Y to window relative coordinates.
		 Vertical border is at the left edge of window.  */
799 800 801 802
	      *x = max (0, *x - x0);
	      *y -= top_y;
	      return ON_VERTICAL_BORDER;
	    }
803
	}
804
      else
805
	{
806
	  if (abs (*x - x1) < grabbable_width)
807
	    {
808 809
	      /* Convert X and Y to window relative coordinates.
		 Vertical border is at the right edge of window.  */
810 811 812 813
	      *x = min (x1, *x) - x0;
	      *y -= top_y;
	      return ON_VERTICAL_BORDER;
	    }
814
	}
815

816 817 818
      if (*x < x0 || *x >= x1)
	return ON_NOTHING;

819 820 821 822
      /* Convert X and Y to window relative coordinates.
	 Mode line starts at left edge of window.  */
      *x -= x0;
      *y -= top_y;
823
      return part;
824
    }
825 826 827

  if (WINDOW_WANTS_HEADER_LINE_P (w)
      && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
828
    {
829 830
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
831
    }
832

833 834 835
  if (*x < x0 || *x >= x1)
    return ON_NOTHING;

836 837
  /* Outside any interesting column?  */
  if (*x < left_x || *x > right_x)
838 839 840 841
    {
      *y -= top_y;
      return ON_SCROLL_BAR;
    }
842 843 844

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

846 847 848 849
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

  if (FRAME_WINDOW_P (f))
850
    {
851
      if (!w->pseudo_window_p
852
	  && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
853
	  && !WINDOW_RIGHTMOST_P (w)
854
	  && (abs (*x - right_x) < grabbable_width))
855
	{
856 857
	  /* Convert X and Y to window relative coordinates.
	     Vertical border is at the right edge of window.  */
858 859 860 861
	  *x = min (right_x, *x) - left_x;
	  *y -= top_y;
	  return ON_VERTICAL_BORDER;
	}
862
    }
863 864 865 866
  else
    {
      /* Need to say "*x > right_x" rather than >=, since on character
	 terminals, the vertical line's x coordinate is right_x.  */
867 868 869
      if (!w->pseudo_window_p
	  && !WINDOW_RIGHTMOST_P (w)
	  && *x > right_x - ux)
870 871 872
	{
	  /* On the border on the right side of the window?  Assume that
	     this area begins at RIGHT_X minus a canonical char width.  */
873 874
	  *x = min (right_x, *x) - left_x;
	  *y -= top_y;
875
	  return ON_VERTICAL_BORDER;
876
	}
877
    }
878

879 880 881 882 883 884
  if (*x < text_left)
    {
      if (lmargin_width > 0
	  && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
	      ? (*x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
	      : (*x < left_x + lmargin_width)))
885
	{
886
	  *x -= left_x;
887 888 889 890 891
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_LEFT_MARGIN;
	}
892 893 894 895 896 897 898 899 900 901 902 903 904

      /* Convert X and Y to window-relative pixel coordinates.  */
      *x -= left_x;
      *y -= top_y;
      return ON_LEFT_FRINGE;
    }

  if (*x >= text_right)
    {
      if (rmargin_width > 0
	  && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
	      ? (*x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
	      : (*x >= right_x - rmargin_width)))
905
	{
906 907 908
	  *x -= right_x - rmargin_width;
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x += WINDOW_RIGHT_FRINGE_WIDTH (w);
909 910 911
	  *y -= top_y;
	  return ON_RIGHT_MARGIN;
	}
912 913 914 915 916 917 918 919

      /* Convert X and Y to window-relative pixel coordinates.  */
      *x -= left_x + WINDOW_LEFT_FRINGE_WIDTH (w);
      *y -= top_y;
      return ON_RIGHT_FRINGE;
    }

  /* Everything special ruled out - must be on text area */
920
  *x -= text_left;
921 922
  *y -= top_y;
  return ON_TEXT;
Jim Blandy's avatar
Jim Blandy committed
923 924
}

925

Jim Blandy's avatar
Jim Blandy committed
926
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
927 928 929 930 931 932 933 934 935 936
       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
937 938
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.
939
If they are on the border between WINDOW and its right sibling,
940 941 942
  `vertical-line' is returned.
If they are in the windows's left or right marginal areas, `left-margin'\n\
  or `right-margin' is returned.  */)
943
     (coordinates, window)
Jim Blandy's avatar
Jim Blandy committed
944 945
     register Lisp_Object coordinates, window;
{
946 947
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
948
  int x, y;
949
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
950

951
  CHECK_WINDOW (window);
952 953
  w = XWINDOW (window);
  f = XFRAME (w->frame);
954
  CHECK_CONS (coordinates);
955 956
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
957 958
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
959 960
  x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
  y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
961 962

  switch (coordinates_in_window (w, &x, &y))
Jim Blandy's avatar
Jim Blandy committed
963
    {
964
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
965 966
      return Qnil;

967 968 969
    case ON_TEXT:
      /* X and Y are now window relative pixel coordinates.  Convert
	 them to canonical char units before returning them.  */
970 971
      return Fcons (FRAME_CANON_X_FROM_PIXEL_X (f, x),
		    FRAME_CANON_Y_FROM_PIXEL_Y (f, y));
Jim Blandy's avatar
Jim Blandy committed
972

973
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
974
      return Qmode_line;
975

976
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
977
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
978

979
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
980
      return Qheader_line;
981

982 983
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
984

985 986
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
987

988 989
    case ON_LEFT_MARGIN:
      return Qleft_margin;
990

991 992 993
    case ON_RIGHT_MARGIN:
      return Qright_margin;

994 995 996 997
    case ON_SCROLL_BAR:
      /* Historically we are supposed to return nil in this case.  */
      return Qnil;

Jim Blandy's avatar
Jim Blandy committed
998 999 1000 1001 1002
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
1003 1004

/* Callback for foreach_window, used in window_from_coordinates.
1005 1006 1007 1008