window.c 239 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 5
                 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
6 7 8

This file is part of GNU Emacs.

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

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
20
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
21

22
#include <config.h>
23 24
#include <stdio.h>

Jim Blandy's avatar
Jim Blandy committed
25 26
#include "lisp.h"
#include "buffer.h"
27
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
28
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
29
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
30 31 32 33 34
#include "window.h"
#include "commands.h"
#include "indent.h"
#include "termchar.h"
#include "disptab.h"
Andreas Schwab's avatar
Andreas Schwab committed
35
#include "dispextern.h"
36 37
#include "blockinput.h"
#include "intervals.h"
38
#include "termhooks.h"		/* For FRAME_TERMINAL.  */
39

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


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

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

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

Lisp_Object selected_window;

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

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

Jim Blandy's avatar
Jim Blandy committed
107 108
Lisp_Object minibuf_window;

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

112
Lisp_Object minibuf_selected_window;
113

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

Jim Blandy's avatar
Jim Blandy committed
117 118 119
Lisp_Object Vminibuf_scroll_window;

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

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

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

Jim Blandy's avatar
Jim Blandy committed
125 126
Lisp_Object Vtemp_buffer_show_function;

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

int auto_window_vscroll_p;

132 133 134 135
/* 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;
136

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

139 140
EMACS_INT window_min_height;
EMACS_INT window_min_width;
Jim Blandy's avatar
Jim Blandy committed
141 142

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

Jim Blandy's avatar
Jim Blandy committed
144 145
int pop_up_windows;

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

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

150 151 152 153
/* Nonzero means reuse existing frames for displaying buffers.  */

int display_buffer_reuse_frames;

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

Jim Blandy's avatar
Jim Blandy committed
156
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
157 158

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

Jim Blandy's avatar
Jim Blandy committed
160 161
Lisp_Object Vdisplay_buffer_function;

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

Lisp_Object Veven_window_heights;

166
/* List of buffer *names* for buffers that should have their own frames.  */
167

168 169 170
Lisp_Object Vspecial_display_buffer_names;

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

172 173 174
Lisp_Object Vspecial_display_regexps;

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

176 177
Lisp_Object Vspecial_display_function;

178
/* List of buffer *names* for buffers to appear in selected window.  */
179

180 181 182
Lisp_Object Vsame_window_buffer_names;

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

184 185
Lisp_Object Vsame_window_regexps;

186
/* Hook run at end of temp_output_buffer_show.  */
187

188 189
Lisp_Object Qtemp_buffer_show_hook;

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

193
EMACS_INT split_height_threshold;
Jim Blandy's avatar
Jim Blandy committed
194

195 196 197 198
/* How to split windows (horizontally/vertically/hybrid).  */

Lisp_Object Vsplit_window_preferred_function;

Jim Blandy's avatar
Jim Blandy committed
199
/* Number of lines of continuity in scrolling by screenfuls.  */
200

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

/* 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
static Lisp_Object Qwindow_configuration_change_hook;
static Lisp_Object Vwindow_configuration_change_hook;
215

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

219 220
Lisp_Object Vscroll_preserve_screen_position;

221 222 223 224
/* Incremented by 1 whenever a window is deleted.  */

int window_deletion_count;

225 226
/* Used by the function window_scroll_pixel_based */

227
static int window_scroll_pixel_based_preserve_x;
228
static int window_scroll_pixel_based_preserve_y;
229

230 231 232 233 234
/* Same for window_scroll_line_based.  */

static int window_scroll_preserve_hpos;
static int window_scroll_preserve_vpos;

235
#if 0 /* This isn't used anywhere.  */
236
/* Nonzero means we can split a frame even if it is "unsplittable".  */
237
static int inhibit_frame_unsplittable;
238
#endif /* 0 */
239

240
extern EMACS_INT scroll_margin;
241

242
extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
Jim Blandy's avatar
Jim Blandy committed
243 244

DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
245 246
       doc: /* Returns t if OBJECT is a window.  */)
     (object)
247
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
248
{
249
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
250 251
}

252
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
253
       doc: /* Returns t if OBJECT is a window which is currently visible.  */)
254 255
     (object)
     Lisp_Object object;
256
{
257
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
258 259
}

Jim Blandy's avatar
Jim Blandy committed
260 261 262
Lisp_Object
make_window ()
{
263
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
264
  register struct window *p;
265

266
  p = allocate_window ();
267 268
  ++sequence_number;
  XSETFASTINT (p->sequence_number, sequence_number);
269 270 271 272
  XSETFASTINT (p->left_col, 0);
  XSETFASTINT (p->top_line, 0);
  XSETFASTINT (p->total_lines, 0);
  XSETFASTINT (p->total_cols, 0);
273
  XSETFASTINT (p->hscroll, 0);
274
  XSETFASTINT (p->min_hscroll, 0);
275
  p->orig_top_line = p->orig_total_lines = Qnil;
Jim Blandy's avatar
Jim Blandy committed
276 277
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
278
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
279
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
280 281
  p->display_table = Qnil;
  p->dedicated = Qnil;
282
  p->window_parameters = Qnil;
283 284 285 286 287
  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;
288
  p->nrows_scale_factor = p->ncols_scale_factor = 1;
289
  p->phys_cursor_type = -1;
290
  p->phys_cursor_width = -1;
291 292 293 294 295
  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;
296
  XSETWINDOW (val, p);
297
  XSETFASTINT (p->last_point, 0);
298
  p->frozen_window_start_p = 0;
299
  p->last_cursor_off_p = p->cursor_off_p = 0;
300 301 302 303 304 305 306
  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;
307
  p->resize_proportionally = Qnil;
Gerd Moellmann's avatar
Gerd Moellmann committed
308 309

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
310 311 312 313
  return val;
}

DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
314 315
       doc: /* Return the window that the cursor now appears in and commands apply to.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
316 317 318 319
{
  return selected_window;
}

320
DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
321 322 323 324
       doc: /* Return the window used now for minibuffers.
If the optional argument FRAME is specified, return the minibuffer window
used by that frame.  */)
     (frame)
325
    Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
326
{
327
  if (NILP (frame))
328
    frame = selected_frame;
329
  CHECK_LIVE_FRAME (frame);
330
  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
Jim Blandy's avatar
Jim Blandy committed
331 332
}

333
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
Kenichi Handa's avatar
Kenichi Handa committed
334 335
       doc: /* Returns non-nil if WINDOW is a minibuffer window.
WINDOW defaults to the selected window.  */)
336
     (window)
Jim Blandy's avatar
Jim Blandy committed
337 338 339
     Lisp_Object window;
{
  struct window *w = decode_window (window);
340
  return MINI_WINDOW_P (w) ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
341 342 343
}


Jim Blandy's avatar
Jim Blandy committed
344
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
345
       Spos_visible_in_window_p, 0, 3, 0,
346
       doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
347 348 349
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.
350
If POS is only out of view because of horizontal scrolling, return non-nil.
351
If POS is t, it specifies the position of the last visible glyph in WINDOW.
352 353 354
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,
355 356 357 358
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
359
off-window at the top and bottom of the row, ROWH is the height of the
360
display row, and VPOS is the row number (0-based) containing POS.  */)
361
     (pos, window, partially)
362
     Lisp_Object pos, window, partially;
Jim Blandy's avatar
Jim Blandy committed
363 364 365 366
{
  register struct window *w;
  register int posint;
  register struct buffer *buf;
367
  struct text_pos top;
368
  Lisp_Object in_window = Qnil;
369
  int rtop, rbot, rowh, vpos, fully_p = 1;
370
  int x, y;
Jim Blandy's avatar
Jim Blandy committed
371

Miles Bader's avatar
Miles Bader committed
372 373 374 375
  w = decode_window (window);
  buf = XBUFFER (w->buffer);
  SET_TEXT_POS_FROM_MARKER (top, w->start);

376 377 378
  if (EQ (pos, Qt))
    posint = -1;
  else if (!NILP (pos))
Jim Blandy's avatar
Jim Blandy committed
379
    {
380
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
381 382
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
383 384 385 386
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
387

388 389
  /* If position is above window start or outside buffer boundaries,
     or if window start is out of range, position is not visible.  */
390 391
  if ((EQ (pos, Qt)
       || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
392 393
      && CHARPOS (top) >= BUF_BEGV (buf)
      && CHARPOS (top) <= BUF_ZV (buf)
394
      && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
395
      && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
396 397 398
    in_window = Qt;

  if (!NILP (in_window) && !NILP (partially))
399 400 401 402 403 404 405 406 407
    {
      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));
    }

408
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
409
}
410

411
DEFUN ("window-line-height", Fwindow_line_height,
412
       Swindow_line_height, 0, 2, 0,
413 414 415
       doc: /* Return height in pixels of text line LINE in window WINDOW.
If WINDOW is nil or omitted, use selected window.

416 417 418 419
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.
420

421
Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
422
in pixels of the visible part of the line, VPOS and YPOS are the
423
vertical position in lines and pixels of the line, relative to the top
424
of the first text line, and OFFBOT is the number of off-window pixels at
425 426
the bottom of the text line.  If there are off-window pixels at the top
of the (first) text line, YPOS is negative.
427 428 429 430 431

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;
432 433 434 435
{
  register struct window *w;
  register struct buffer *b;
  struct glyph_row *row, *end_row;
436
  int max_y, crop, i, n;
437 438 439 440 441

  w = decode_window (window);

  if (noninteractive
      || w->pseudo_window_p)
442
    return Qnil;
443 444 445 446 447 448 449 450 451 452 453 454

  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;

455 456 457 458 459 460 461 462 463 464
  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;
    }

465
  if (EQ (line, Qheader_line))
466
    {
467 468 469
      if (!WINDOW_WANTS_HEADER_LINE_P (w))
	return Qnil;
      row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
470 471
      if (!row->enabled_p)
	return Qnil;
472 473 474
      return list4 (make_number (row->height),
		    make_number (0), make_number (0),
		    make_number (0));
475
    }
476 477

  if (EQ (line, Qmode_line))
478
    {
479 480 481 482 483 484 485 486 487
      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));
    }
488

489
  CHECK_NUMBER (line);
490
  n = XINT (line);
491 492 493 494

  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);
495
  i = 0;
496 497 498 499 500

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

502 503 504
  if (row > end_row || !row->enabled_p)
    return Qnil;

505
  if (++n < 0)
506 507 508
    {
      if (-n > i)
	return Qnil;
509 510
      row += n;
      i += n;
511 512
    }

513
 found_row:
514 515
  crop = max (0, (row->y + row->height) - max_y);
  return list4 (make_number (row->height + min (0, row->y) - crop),
516
		make_number (i),
517 518
		make_number (row->y),
		make_number (crop));
519 520
}

521

Jim Blandy's avatar
Jim Blandy committed
522 523 524 525 526

static struct window *
decode_window (window)
     register Lisp_Object window;
{
Jim Blandy's avatar
Jim Blandy committed
527
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
528 529
    return XWINDOW (selected_window);

530
  CHECK_LIVE_WINDOW (window);
Jim Blandy's avatar
Jim Blandy committed
531 532 533
  return XWINDOW (window);
}

Kenichi Handa's avatar
Kenichi Handa committed
534 535 536 537 538 539 540 541 542 543 544
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
545
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
546 547
       doc: /* Return the buffer that WINDOW is displaying.
WINDOW defaults to the selected window.  */)
548
     (window)
Jim Blandy's avatar
Jim Blandy committed
549 550 551 552 553 554
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
555 556
       doc: /* Return the number of lines in WINDOW (including its mode line).
WINDOW defaults to the selected window.  */)
557
     (window)
Jim Blandy's avatar
Jim Blandy committed
558 559
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
560
  return decode_any_window (window)->total_lines;
Jim Blandy's avatar
Jim Blandy committed
561 562 563
}

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
564 565 566 567 568
       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
569 570
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
571
  return make_number (window_box_text_cols (decode_any_window (window)));
Jim Blandy's avatar
Jim Blandy committed
572 573
}

574 575 576 577 578 579 580 581 582
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
583
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
584 585
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
WINDOW defaults to the selected window.  */)
586
     (window)
Jim Blandy's avatar
Jim Blandy committed
587 588 589 590 591 592
     Lisp_Object window;
{
  return decode_window (window)->hscroll;
}

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

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
597
window so that the location of point moves off-window.  */)
598
     (window, ncol)
599
     Lisp_Object window, ncol;
Jim Blandy's avatar
Jim Blandy committed
600
{
601 602
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
603

604
  CHECK_NUMBER (ncol);
605
  hscroll = max (0, XINT (ncol));
606

607 608
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
609
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
610

611
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
612 613 614
  return ncol;
}

615 616
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
617
       doc: /* Return WINDOW's redisplay end trigger value.
618
WINDOW defaults to the selected window.
619 620
See `set-window-redisplay-end-trigger' for more information.  */)
     (window)
621 622 623 624 625 626 627
     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,
628 629 630 631 632 633 634
       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)
635 636 637 638 639 640 641 642 643
     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
644
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
645 646
       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.
647 648 649 650 651
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'.  */)
652
     (window)
Jim Blandy's avatar
Jim Blandy committed
653 654
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
655
  register struct window *w = decode_any_window (window);
Jim Blandy's avatar
Jim Blandy committed
656

657 658 659 660 661
  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
662 663
}

664 665 666 667 668 669 670 671 672 673 674
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;
{
Kenichi Handa's avatar
Kenichi Handa committed
675
  register struct window *w = decode_any_window (window);
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693

  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;
{
Kenichi Handa's avatar
Kenichi Handa committed
694
  register struct window *w = decode_any_window (window);
695 696 697 698 699 700

  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)),
701
		make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
702 703 704 705 706 707 708
			     - 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,
709
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
710 711 712 713 714 715 716 717
\(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;
{
Kenichi Handa's avatar
Kenichi Handa committed
718
  register struct window *w = decode_any_window (window);
719 720 721 722 723 724

  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)),
725
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
726 727 728 729 730 731
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

732
/* Test if the character at column *X, row *Y is within window W.
733
   If it is not, return ON_NOTHING;
Jim Blandy's avatar
Jim Blandy committed
734 735 736
   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
737 738
      return ON_TEXT;
   if it is on the window's modeline, return ON_MODE_LINE;
Jim Blandy's avatar
Jim Blandy committed
739
   if it is on the border between the window and its right sibling,
740
      return ON_VERTICAL_BORDER.
741 742
   if it is on a scroll bar,
      return ON_SCROLL_BAR.
743
   if it is on the window's top line, return ON_HEADER_LINE;
Kim F. Storm's avatar
Kim F. Storm committed
744
   if it is in left or right fringe of the window,
745 746
      return ON_LEFT_FRINGE or ON_RIGHT_FRINGE, and convert *X and *Y
      to window-relative coordinates;
747
   if it is in the marginal area to the left/right of the window,
748 749
      return ON_LEFT_MARGIN or ON_RIGHT_MARGIN, and convert *X and *Y
      to window-relative coordinates.
750 751 752

   X and Y are frame relative pixel coordinates.  */

753
static enum window_part
Jim Blandy's avatar
Jim Blandy committed
754 755 756 757
coordinates_in_window (w, x, y)
     register struct window *w;
     register int *x, *y;
{
758 759
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  int left_x, right_x, top_y, bottom_y;
760
  enum window_part part;
761 762 763
  int ux = FRAME_COLUMN_WIDTH (f);
  int x0 = WINDOW_LEFT_EDGE_X (w);
  int x1 = WINDOW_RIGHT_EDGE_X (w);
764 765 766
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
767
  int lmargin_width, rmargin_width, text_left, text_right;
768

769 770
  /* 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.  */
771 772 773
  if (w->pseudo_window_p)
    {
      left_x = 0;
774 775 776
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
      top_y = WINDOW_TOP_EDGE_Y (w);
      bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
777 778 779
    }
  else
    {
780 781 782 783
      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);
784
    }
785

786 787 788 789
  /* Outside any interesting row?  */
  if (*y < top_y || *y >= bottom_y)
    return ON_NOTHING;

790 791 792 793 794
  /* 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.  */
795

796
  if (WINDOW_WANTS_MODELINE_P (w)
Kenichi Handa's avatar
Kenichi Handa committed
797
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
798
    {
799 800 801
      part = ON_MODE_LINE;

    header_vertical_border_check:
802 803
      /* We're somewhere on the mode line.  We consider the place
	 between mode lines of horizontally adjacent mode lines
804
	 as the vertical border.  If scroll bars on the left,
805
	 return the right window.  */
806 807
      if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
	  || WINDOW_RIGHTMOST_P (w))
808
	{
Eli Zaretskii's avatar
Eli Zaretskii committed
809
	  if (!WINDOW_LEFTMOST_P (w) && eabs (*x - x0) < grabbable_width)
810
	    {
811 812
	      /* Convert X and Y to window relative coordinates.
		 Vertical border is at the left edge of window.  */
813 814 815 816
	      *x = max (0, *x - x0);
	      *y -= top_y;
	      return ON_VERTICAL_BORDER;
	    }
817
	}
818
      else
819
	{
Eli Zaretskii's avatar
Eli Zaretskii committed
820
	  if (eabs (*x - x1) < grabbable_width)
821
	    {
822 823
	      /* Convert X and Y to window relative coordinates.
		 Vertical border is at the right edge of window.  */
824 825 826 827
	      *x = min (x1, *x) - x0;
	      *y -= top_y;
	      return ON_VERTICAL_BORDER;
	    }
828
	}
829

830 831 832
      if (*x < x0 || *x >= x1)
	return ON_NOTHING;

833 834 835 836
      /* Convert X and Y to window relative coordinates.
	 Mode line starts at left edge of window.  */
      *x -= x0;
      *y -= top_y;
837
      return part;
838
    }
839 840 841

  if (WINDOW_WANTS_HEADER_LINE_P (w)
      && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
842
    {
843 844
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
845
    }
846

847 848 849
  if (*x < x0 || *x >= x1)
    return ON_NOTHING;

850 851
  /* Outside any interesting column?  */
  if (*x < left_x || *x > right_x)
852 853 854 855
    {
      *y -= top_y;
      return ON_SCROLL_BAR;
    }
856 857 858

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

860 861 862 863
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

  if (FRAME_WINDOW_P (f))
864
    {
865
      if (!w->pseudo_window_p
866
	  && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
867
	  && !WINDOW_RIGHTMOST_P (w)
Eli Zaretskii's avatar
Eli Zaretskii committed
868
	  && (eabs (*x - right_x) < grabbable_width))
869
	{
870 871
	  /* Convert X and Y to window relative coordinates.
	     Vertical border is at the right edge of window.  */
872 873 874 875
	  *x = min (right_x, *x) - left_x;
	  *y -= top_y;
	  return ON_VERTICAL_BORDER;
	}
876
    }
877 878 879 880
  else
    {
      /* Need to say "*x > right_x" rather than >=, since on character
	 terminals, the vertical line's x coordinate is right_x.  */
881 882 883
      if (!w->pseudo_window_p
	  && !WINDOW_RIGHTMOST_P (w)
	  && *x > right_x - ux)
884 885 886
	{
	  /* On the border on the right side of the window?  Assume that
	     this area begins at RIGHT_X minus a canonical char width.  */
887 888
	  *x = min (right_x, *x) - left_x;
	  *y -= top_y;
889
	  return ON_VERTICAL_BORDER;
890
	}
891
    }
892

893 894 895 896 897 898
  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)))
899
	{
Kenichi Handa's avatar
Kenichi Handa committed
900
	  *x -= left_x;
901 902 903 904 905
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_LEFT_MARGIN;
	}
906 907 908 909 910 911 912 913 914 915 916 917 918

      /* 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)))
919
	{
920 921 922
	  *x -= right_x - rmargin_width;
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x += WINDOW_RIGHT_FRINGE_WIDTH (w);
923 924 925
	  *y -= top_y;
	  return ON_RIGHT_MARGIN;
	}
926 927 928 929 930 931 932 933

      /* 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 */
934
  *x -= text_left;
935 936
  *y -= top_y;
  return ON_TEXT;
Jim Blandy's avatar
Jim Blandy committed
937 938
}

939

Jim Blandy's avatar
Jim Blandy committed
940
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
941 942 943 944 945 946 947 948 949 950
       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
951 952
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.
953
If they are on the border between WINDOW and its right sibling,
954 955 956
  `vertical-line' is returned.
If they are in the windows's left or right marginal areas, `left-margin'\n\
  or `right-margin' is returned.  */)
957
     (coordinates, window)
Jim Blandy's avatar
Jim Blandy committed
958 959
     register Lisp_Object coordinates, window;
{
960 961
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
962
  int x, y;
963
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
964

Kenichi Handa's avatar
Kenichi Handa committed
965
  CHECK_WINDOW (window);
966 967
  w = XWINDOW (window);
  f = XFRAME (w->frame);
968
  CHECK_CONS (coordinates);
969 970
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
971 972
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
973 974
  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);
975 976

  switch (coordinates_in_window (w, &x, &y))
Jim Blandy's avatar
Jim Blandy committed
977
    {
978
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
979 980
      return Qnil;

981 982 983
    case ON_TEXT:
      /* X and Y are now window relative pixel coordinates.  Convert
	 them to canonical char units before returning them.  */
984 985
      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
986

987
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
988
      return Qmode_line;
989

990
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
991
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
992

993
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
994
      return Qheader_line;
995

996 997
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
Juanma Barranquero's avatar