window.c 224 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, 2008, 2009
Glenn Morris's avatar
Glenn Morris committed
5
                 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 50 51
#ifdef HAVE_NS
#include "nsterm.h"
#endif
52 53


54
Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
55
Lisp_Object Qdisplay_buffer;
56
Lisp_Object Qscroll_up, Qscroll_down;
57
Lisp_Object Qwindow_size_fixed;
58

59
extern Lisp_Object Qleft_margin, Qright_margin;
Jim Blandy's avatar
Jim Blandy committed
60

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

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

Lisp_Object selected_window;

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

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

Jim Blandy's avatar
Jim Blandy committed
109 110
Lisp_Object minibuf_window;

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

114
Lisp_Object minibuf_selected_window;
115

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

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

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

Jim Blandy's avatar
Jim Blandy committed
123 124 125
Lisp_Object Vother_window_scroll_buffer;

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

Jim Blandy's avatar
Jim Blandy committed
127 128
Lisp_Object Vtemp_buffer_show_function;

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

int auto_window_vscroll_p;

134 135 136 137
/* 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;
138

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

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

144
/* Hook run at end of temp_output_buffer_show.  */
145

146 147
Lisp_Object Qtemp_buffer_show_hook;

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

150
EMACS_INT next_screen_context_lines;
Jim Blandy's avatar
Jim Blandy committed
151 152

/* Incremented for each window created.  */
153

Jim Blandy's avatar
Jim Blandy committed
154 155
static int sequence_number;

156
/* Nonzero after init_window_once has finished.  */
157

158 159
static int window_initialized;

160
/* Hook to run when window config changes.  */
161

162 163
static Lisp_Object Qwindow_configuration_change_hook;
static Lisp_Object Vwindow_configuration_change_hook;
164

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

168 169
Lisp_Object Vscroll_preserve_screen_position;

170 171 172 173
/* Non-nil means that text is inserted before window's markers.  */

Lisp_Object Vwindow_point_insertion_type;

174 175 176 177
/* Incremented by 1 whenever a window is deleted.  */

int window_deletion_count;

178 179
/* Used by the function window_scroll_pixel_based */

180
static int window_scroll_pixel_based_preserve_x;
181
static int window_scroll_pixel_based_preserve_y;
182

183 184 185 186 187
/* Same for window_scroll_line_based.  */

static int window_scroll_preserve_hpos;
static int window_scroll_preserve_vpos;

188
#if 0 /* This isn't used anywhere.  */
189
/* Nonzero means we can split a frame even if it is "unsplittable".  */
190
static int inhibit_frame_unsplittable;
191
#endif /* 0 */
192

193
extern EMACS_INT scroll_margin;
194

195
extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
196 197 198 199 200 201 202 203

/* If non-nil, then the `recenter' command with a nil argument
   the entire frame to be redrawn; the special value `tty' causes the
   frame to be redrawn only if it is a tty frame.  */

static Lisp_Object Vrecenter_redisplay;
extern Lisp_Object Qtty;

Jim Blandy's avatar
Jim Blandy committed
204 205

DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
206
       doc: /* Return t if OBJECT is a window.  */)
207
     (object)
208
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
209
{
210
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
211 212
}

213
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
214
       doc: /* Return t if OBJECT is a window which is currently visible.  */)
215 216
     (object)
     Lisp_Object object;
217
{
218
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
219 220
}

Jim Blandy's avatar
Jim Blandy committed
221 222 223
Lisp_Object
make_window ()
{
224
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
225
  register struct window *p;
226

227
  p = allocate_window ();
228 229
  ++sequence_number;
  XSETFASTINT (p->sequence_number, sequence_number);
230 231 232 233
  XSETFASTINT (p->left_col, 0);
  XSETFASTINT (p->top_line, 0);
  XSETFASTINT (p->total_lines, 0);
  XSETFASTINT (p->total_cols, 0);
234
  XSETFASTINT (p->hscroll, 0);
235
  XSETFASTINT (p->min_hscroll, 0);
236
  p->orig_top_line = p->orig_total_lines = Qnil;
Jim Blandy's avatar
Jim Blandy committed
237 238
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
239
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
240
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
241 242
  p->display_table = Qnil;
  p->dedicated = Qnil;
243
  p->window_parameters = Qnil;
244 245 246 247 248
  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;
249
  p->nrows_scale_factor = p->ncols_scale_factor = 1;
250
  p->phys_cursor_type = -1;
251
  p->phys_cursor_width = -1;
252 253 254 255 256
  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;
257
  XSETWINDOW (val, p);
258
  XSETFASTINT (p->last_point, 0);
259
  p->frozen_window_start_p = 0;
260
  p->last_cursor_off_p = p->cursor_off_p = 0;
261 262 263 264 265 266 267
  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;
268
  p->resize_proportionally = Qnil;
Gerd Moellmann's avatar
Gerd Moellmann committed
269 270

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
271 272 273 274
  return val;
}

DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
275 276
       doc: /* Return the window that the cursor now appears in and commands apply to.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
277 278 279 280
{
  return selected_window;
}

281
DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
282 283 284 285
       doc: /* Return the window used now for minibuffers.
If the optional argument FRAME is specified, return the minibuffer window
used by that frame.  */)
     (frame)
286
    Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
287
{
288
  if (NILP (frame))
289
    frame = selected_frame;
290
  CHECK_LIVE_FRAME (frame);
291
  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
Jim Blandy's avatar
Jim Blandy committed
292 293
}

294
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
295
       doc: /* Return non-nil if WINDOW is a minibuffer window.
Kenichi Handa's avatar
Kenichi Handa committed
296
WINDOW defaults to the selected window.  */)
297
     (window)
Jim Blandy's avatar
Jim Blandy committed
298 299 300
     Lisp_Object window;
{
  struct window *w = decode_window (window);
301
  return MINI_WINDOW_P (w) ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
302 303 304
}


Jim Blandy's avatar
Jim Blandy committed
305
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
306
       Spos_visible_in_window_p, 0, 3, 0,
307
       doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
308 309 310
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.
311
If POS is only out of view because of horizontal scrolling, return non-nil.
312
If POS is t, it specifies the position of the last visible glyph in WINDOW.
313 314 315
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,
316 317 318 319
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
320
off-window at the top and bottom of the row, ROWH is the height of the
321
display row, and VPOS is the row number (0-based) containing POS.  */)
322
     (pos, window, partially)
323
     Lisp_Object pos, window, partially;
Jim Blandy's avatar
Jim Blandy committed
324 325 326 327
{
  register struct window *w;
  register int posint;
  register struct buffer *buf;
328
  struct text_pos top;
329
  Lisp_Object in_window = Qnil;
330
  int rtop, rbot, rowh, vpos, fully_p = 1;
331
  int x, y;
Jim Blandy's avatar
Jim Blandy committed
332

Miles Bader's avatar
Miles Bader committed
333 334 335 336
  w = decode_window (window);
  buf = XBUFFER (w->buffer);
  SET_TEXT_POS_FROM_MARKER (top, w->start);

337 338 339
  if (EQ (pos, Qt))
    posint = -1;
  else if (!NILP (pos))
Jim Blandy's avatar
Jim Blandy committed
340
    {
341
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
342 343
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
344 345 346 347
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
348

349 350
  /* If position is above window start or outside buffer boundaries,
     or if window start is out of range, position is not visible.  */
351 352
  if ((EQ (pos, Qt)
       || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
353 354
      && CHARPOS (top) >= BUF_BEGV (buf)
      && CHARPOS (top) <= BUF_ZV (buf)
355
      && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
356
      && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
357 358 359
    in_window = Qt;

  if (!NILP (in_window) && !NILP (partially))
360 361 362 363 364 365 366 367 368
    {
      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));
    }

369
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
370
}
371

372
DEFUN ("window-line-height", Fwindow_line_height,
373
       Swindow_line_height, 0, 2, 0,
374 375 376
       doc: /* Return height in pixels of text line LINE in window WINDOW.
If WINDOW is nil or omitted, use selected window.

377 378 379 380
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.
381

382
Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
383
in pixels of the visible part of the line, VPOS and YPOS are the
384
vertical position in lines and pixels of the line, relative to the top
385
of the first text line, and OFFBOT is the number of off-window pixels at
386 387
the bottom of the text line.  If there are off-window pixels at the top
of the (first) text line, YPOS is negative.
388 389 390 391 392

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;
393 394 395 396
{
  register struct window *w;
  register struct buffer *b;
  struct glyph_row *row, *end_row;
397
  int max_y, crop, i, n;
398 399 400 401 402

  w = decode_window (window);

  if (noninteractive
      || w->pseudo_window_p)
403
    return Qnil;
404 405 406 407 408 409 410 411 412 413 414 415

  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;

416 417 418 419 420 421 422 423 424 425
  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;
    }

426
  if (EQ (line, Qheader_line))
427
    {
428 429 430
      if (!WINDOW_WANTS_HEADER_LINE_P (w))
	return Qnil;
      row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
431 432
      if (!row->enabled_p)
	return Qnil;
433 434 435
      return list4 (make_number (row->height),
		    make_number (0), make_number (0),
		    make_number (0));
436
    }
437 438

  if (EQ (line, Qmode_line))
439
    {
440 441 442 443 444 445 446 447 448
      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));
    }
449

450
  CHECK_NUMBER (line);
451
  n = XINT (line);
452 453 454 455

  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);
456
  i = 0;
457 458 459 460 461

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

463 464 465
  if (row > end_row || !row->enabled_p)
    return Qnil;

466
  if (++n < 0)
467 468 469
    {
      if (-n > i)
	return Qnil;
470 471
      row += n;
      i += n;
472 473
    }

474
 found_row:
475 476
  crop = max (0, (row->y + row->height) - max_y);
  return list4 (make_number (row->height + min (0, row->y) - crop),
477
		make_number (i),
478 479
		make_number (row->y),
		make_number (crop));
480 481
}

482

Jim Blandy's avatar
Jim Blandy committed
483 484 485 486 487

static struct window *
decode_window (window)
     register Lisp_Object window;
{
Jim Blandy's avatar
Jim Blandy committed
488
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
489 490
    return XWINDOW (selected_window);

491
  CHECK_LIVE_WINDOW (window);
Jim Blandy's avatar
Jim Blandy committed
492 493 494
  return XWINDOW (window);
}

Kenichi Handa's avatar
Kenichi Handa committed
495 496 497 498 499 500 501 502 503 504 505
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
506
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
507 508
       doc: /* Return the buffer that WINDOW is displaying.
WINDOW defaults to the selected window.  */)
509
     (window)
Jim Blandy's avatar
Jim Blandy committed
510 511 512 513 514 515
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
516 517 518 519
       doc: /* Return the number of lines in WINDOW.
WINDOW defaults to the selected window.

The return value includes WINDOW's mode line and header line, if any.  */)
520
     (window)
Jim Blandy's avatar
Jim Blandy committed
521 522
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
523
  return decode_any_window (window)->total_lines;
Jim Blandy's avatar
Jim Blandy committed
524 525 526
}

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
527
       doc: /* Return the number of display columns in WINDOW.
528 529 530 531 532
WINDOW defaults to the selected window.

Note: The return value is the number of 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))).  */)
533
     (window)
Jim Blandy's avatar
Jim Blandy committed
534 535
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
536
  return make_number (window_box_text_cols (decode_any_window (window)));
Jim Blandy's avatar
Jim Blandy committed
537 538
}

539 540 541 542 543 544 545 546 547
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
548
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
549 550
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
WINDOW defaults to the selected window.  */)
551
     (window)
Jim Blandy's avatar
Jim Blandy committed
552 553 554 555 556 557
     Lisp_Object window;
{
  return decode_window (window)->hscroll;
}

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

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
562
window so that the location of point moves off-window.  */)
563
     (window, ncol)
564
     Lisp_Object window, ncol;
Jim Blandy's avatar
Jim Blandy committed
565
{
566 567
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
568

569
  CHECK_NUMBER (ncol);
570
  hscroll = max (0, XINT (ncol));
571

572 573
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
574
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
575

576
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
577 578 579
  return ncol;
}

580 581
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
582
       doc: /* Return WINDOW's redisplay end trigger value.
583
WINDOW defaults to the selected window.
584 585
See `set-window-redisplay-end-trigger' for more information.  */)
     (window)
586 587 588 589 590 591 592
     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,
593 594 595 596 597 598 599
       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)
600 601 602 603 604 605 606 607 608
     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
609
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
610 611
       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.
612 613 614 615 616
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'.  */)
617
     (window)
Jim Blandy's avatar
Jim Blandy committed
618 619
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
620
  register struct window *w = decode_any_window (window);
Jim Blandy's avatar
Jim Blandy committed
621

622 623 624 625 626
  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
627 628
}

629 630 631 632 633 634 635 636 637 638 639
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
640
  register struct window *w = decode_any_window (window);
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658

  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
659
  register struct window *w = decode_any_window (window);
660 661 662 663 664 665

  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)),
666
		make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
667 668 669 670 671 672 673
			     - 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,
674
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
675 676 677 678 679 680 681 682
\(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
683
  register struct window *w = decode_any_window (window);
684 685 686 687 688 689

  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)),
690
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
691 692 693 694 695 696
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

697
/* Test if the character at column *X, row *Y is within window W.
698
   If it is not, return ON_NOTHING;
Jim Blandy's avatar
Jim Blandy committed
699 700 701
   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
702 703
      return ON_TEXT;
   if it is on the window's modeline, return ON_MODE_LINE;
Jim Blandy's avatar
Jim Blandy committed
704
   if it is on the border between the window and its right sibling,
705
      return ON_VERTICAL_BORDER.
706 707
   if it is on a scroll bar,
      return ON_SCROLL_BAR.
708
   if it is on the window's top line, return ON_HEADER_LINE;
Kim F. Storm's avatar
Kim F. Storm committed
709
   if it is in left or right fringe of the window,
710 711
      return ON_LEFT_FRINGE or ON_RIGHT_FRINGE, and convert *X and *Y
      to window-relative coordinates;
712
   if it is in the marginal area to the left/right of the window,
713 714
      return ON_LEFT_MARGIN or ON_RIGHT_MARGIN, and convert *X and *Y
      to window-relative coordinates.
715 716 717

   X and Y are frame relative pixel coordinates.  */

718
static enum window_part
Jim Blandy's avatar
Jim Blandy committed
719 720 721 722
coordinates_in_window (w, x, y)
     register struct window *w;
     register int *x, *y;
{
723 724
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  int left_x, right_x, top_y, bottom_y;
725
  enum window_part part;
726 727 728
  int ux = FRAME_COLUMN_WIDTH (f);
  int x0 = WINDOW_LEFT_EDGE_X (w);
  int x1 = WINDOW_RIGHT_EDGE_X (w);
729 730 731
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
732
  int lmargin_width, rmargin_width, text_left, text_right;
733

734 735
  /* 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.  */
736 737 738
  if (w->pseudo_window_p)
    {
      left_x = 0;
739 740 741
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
      top_y = WINDOW_TOP_EDGE_Y (w);
      bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
742 743 744
    }
  else
    {
745 746 747 748
      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);
749
    }
750

751 752 753 754
  /* Outside any interesting row?  */
  if (*y < top_y || *y >= bottom_y)
    return ON_NOTHING;

755 756 757 758 759
  /* 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.  */
760

761
  if (WINDOW_WANTS_MODELINE_P (w)
Kenichi Handa's avatar
Kenichi Handa committed
762
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
763
    {
764 765 766
      part = ON_MODE_LINE;

    header_vertical_border_check:
767 768
      /* We're somewhere on the mode line.  We consider the place
	 between mode lines of horizontally adjacent mode lines
769
	 as the vertical border.  If scroll bars on the left,
770
	 return the right window.  */
771 772
      if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
	  || WINDOW_RIGHTMOST_P (w))
773
	{
Eli Zaretskii's avatar
Eli Zaretskii committed
774
	  if (!WINDOW_LEFTMOST_P (w) && eabs (*x - x0) < grabbable_width)
775
	    {
776 777
	      /* Convert X and Y to window relative coordinates.
		 Vertical border is at the left edge of window.  */
778 779 780 781
	      *x = max (0, *x - x0);
	      *y -= top_y;
	      return ON_VERTICAL_BORDER;
	    }
782
	}
783
      else
784
	{
785 786 787 788 789
	  /* Make sure we're not at the rightmost position of a
	     mode-/header-line and there's yet another window on
	     the right.  (Bug#1372)  */
	  if ((WINDOW_RIGHTMOST_P (w) || *x < x1)
	      && eabs (*x - x1) < grabbable_width)
790
	    {
791 792
	      /* Convert X and Y to window relative coordinates.
		 Vertical border is at the right edge of window.  */
793 794 795 796
	      *x = min (x1, *x) - x0;
	      *y -= top_y;
	      return ON_VERTICAL_BORDER;
	    }
797
	}
798

799 800 801
      if (*x < x0 || *x >= x1)
	return ON_NOTHING;

802 803 804 805
      /* Convert X and Y to window relative coordinates.
	 Mode line starts at left edge of window.  */
      *x -= x0;
      *y -= top_y;
806
      return part;
807
    }
808 809 810

  if (WINDOW_WANTS_HEADER_LINE_P (w)
      && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
811
    {
812 813
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
814
    }
815

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

819 820
  /* Outside any interesting column?  */
  if (*x < left_x || *x > right_x)
821 822 823 824
    {
      *y -= top_y;
      return ON_SCROLL_BAR;
    }
825 826 827

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

829 830 831 832
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

  if (FRAME_WINDOW_P (f))
833
    {
834
      if (!w->pseudo_window_p
835
	  && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
836
	  && !WINDOW_RIGHTMOST_P (w)
Eli Zaretskii's avatar
Eli Zaretskii committed
837
	  && (eabs (*x - right_x) < grabbable_width))
838
	{
839 840
	  /* Convert X and Y to window relative coordinates.
	     Vertical border is at the right edge of window.  */
841 842 843 844
	  *x = min (right_x, *x) - left_x;
	  *y -= top_y;
	  return ON_VERTICAL_BORDER;
	}
845
    }
846 847 848 849
  else
    {
      /* Need to say "*x > right_x" rather than >=, since on character
	 terminals, the vertical line's x coordinate is right_x.  */
850 851 852
      if (!w->pseudo_window_p
	  && !WINDOW_RIGHTMOST_P (w)
	  && *x > right_x - ux)
853 854 855
	{
	  /* On the border on the right side of the window?  Assume that
	     this area begins at RIGHT_X minus a canonical char width.  */
856 857
	  *x = min (right_x, *x) - left_x;
	  *y -= top_y;
858
	  return ON_VERTICAL_BORDER;
859
	}
860
    }
861

862 863 864 865 866 867
  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)))
868
	{
Kenichi Handa's avatar
Kenichi Handa committed
869
	  *x -= left_x;
870 871 872 873 874
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_LEFT_MARGIN;
	}
875 876 877 878 879 880 881 882 883 884 885 886 887

      /* 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)))
888
	{
889 890 891
	  *x -= right_x - rmargin_width;
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x += WINDOW_RIGHT_FRINGE_WIDTH (w);
892 893 894
	  *y -= top_y;
	  return ON_RIGHT_MARGIN;
	}
895 896 897 898 899 900 901 902

      /* 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 */
903
  *x -= text_left;
904 905
  *y -= top_y;
  return ON_TEXT;
Jim Blandy's avatar
Jim Blandy committed
906 907
}

908

Jim Blandy's avatar
Jim Blandy committed
909
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
910 911 912 913
       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.
914
\(0 . 0) denotes the character in the upper left corner of the
915 916 917 918 919
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
920 921
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.
922
If they are on the border between WINDOW and its right sibling,
923 924 925
  `vertical-line' is returned.
If they are in the windows's left or right marginal areas, `left-margin'\n\
  or `right-margin' is returned.  */)
926
     (coordinates, window)
Jim Blandy's avatar
Jim Blandy committed
927 928
     register Lisp_Object coordinates, window;
{
929 930
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
931
  int x, y;
932
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
933

Kenichi Handa's avatar
Kenichi Handa committed
934
  CHECK_WINDOW (window);
935 936
  w = XWINDOW (window);
  f = XFRAME (w->frame);
937
  CHECK_CONS (coordinates);
938 939
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
940 941
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
942 943
  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);
944 945

  switch (coordinates_in_window (w, &x, &y))
Jim Blandy's avatar
Jim Blandy committed
946
    {
947
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
948 949
      return Qnil;

950 951 952
    case ON_TEXT:
      /* X and Y are now window relative pixel coordinates.  Convert
	 them to canonical char units before returning them.  */
953 954
      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
955

956
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
957
      return Qmode_line;
958

959
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
960
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
961

962
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
963
      return Qheader_line;
964

965 966
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
967

968 969
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
970

971 972
    case ON_LEFT_MARGIN:
      return Qleft_margin;
973

974 975 976
    case ON_RIGHT_MARGIN:
      return Qright_margin;

977 978 979 980
    case ON_SCROLL_BAR:
      /* Historically we are supposed to return nil in this case.  */
      return Qnil;

Jim Blandy's avatar
Jim Blandy committed
981 982 983 984 985
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
986 987

/* Callback for foreach_window, used in window_from_coordinates.
988 989 990 991 992
   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
993
   *CW->part the part of the window under coordinates *X,*Y.  Return
994 995 996 997 998
   zero from this function to stop iterating over windows.  */

struct check_window_data
{
  Lisp_Object *window;
999 1000
  int *x, *y;
  enum window_part *part;
1001
};
Gerd Moellmann's avatar
Gerd Moellmann committed
1002 1003

static int
1004
check_window_containing (w, user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
1005
     struct window *w;
1006
     void *user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
1007
{