window.c 233 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>
24 25
#include <stdio.h>

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

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));
Gerd Moellmann's avatar
Gerd Moellmann committed
66
static int window_min_size_1 P_ ((struct window *, int));
67
static int window_min_size_2 P_ ((struct window *, int));
68
static int window_min_size P_ ((struct window *, 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 215
Lisp_Object Qwindow_configuration_change_hook;
Lisp_Object Vwindow_configuration_change_hook;

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_y;
228

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

234
extern EMACS_INT scroll_margin;
235

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

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

Jim Blandy's avatar
Jim Blandy committed
254 255 256
Lisp_Object
make_window ()
{
257
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
258
  register struct window *p;
259

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

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
302 303 304 305
  return val;
}

DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
306 307
       doc: /* Return the window that the cursor now appears in and commands apply to.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
308 309 310 311
{
  return selected_window;
}

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

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


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

Miles Bader's avatar
Miles Bader committed
364 365 366 367
  w = decode_window (window);
  buf = XBUFFER (w->buffer);
  SET_TEXT_POS_FROM_MARKER (top, w->start);

368 369 370
  if (EQ (pos, Qt))
    posint = -1;
  else if (!NILP (pos))
Jim Blandy's avatar
Jim Blandy committed
371
    {
372
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
373 374
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
375 376 377 378
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
379

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

  if (!NILP (in_window) && !NILP (partially))
391 392 393 394 395 396 397 398 399
    {
      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));
    }

400
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
401
}
402

403
DEFUN ("window-line-height", Fwindow_line_height,
404
       Swindow_line_height, 0, 2, 0,
405 406 407
       doc: /* Return height in pixels of text line LINE in window WINDOW.
If WINDOW is nil or omitted, use selected window.

408 409 410 411
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.
412

413
Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
414
in pixels of the visible part of the line, VPOS and YPOS are the
415
vertical position in lines and pixels of the line, relative to the top
416
of the first text line, and OFFBOT is the number of off-window pixels at
417 418
the bottom of the text line.  If there are off-window pixels at the top
of the (first) text line, YPOS is negative.
419 420 421 422 423

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;
424 425 426 427
{
  register struct window *w;
  register struct buffer *b;
  struct glyph_row *row, *end_row;
428
  int max_y, crop, i, n;
429 430 431 432 433

  w = decode_window (window);

  if (noninteractive
      || w->pseudo_window_p)
434
    return Qnil;
435 436 437 438 439 440 441 442 443 444 445 446

  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;

447 448 449 450 451 452 453 454 455 456
  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;
    }

457
  if (EQ (line, Qheader_line))
458
    {
459 460 461
      if (!WINDOW_WANTS_HEADER_LINE_P (w))
	return Qnil;
      row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
462 463
      if (!row->enabled_p)
	return Qnil;
464 465 466
      return list4 (make_number (row->height),
		    make_number (0), make_number (0),
		    make_number (0));
467
    }
468 469

  if (EQ (line, Qmode_line))
470
    {
471 472 473 474 475 476 477 478 479
      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));
    }
480

481
  CHECK_NUMBER (line);
482
  n = XINT (line);
483 484 485 486

  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);
487
  i = 0;
488 489 490 491 492

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

494 495 496
  if (row > end_row || !row->enabled_p)
    return Qnil;

497
  if (++n < 0)
498 499 500
    {
      if (-n > i)
	return Qnil;
501 502
      row += n;
      i += n;
503 504
    }

505
 found_row:
506 507
  crop = max (0, (row->y + row->height) - max_y);
  return list4 (make_number (row->height + min (0, row->y) - crop),
508
		make_number (i),
509 510
		make_number (row->y),
		make_number (crop));
511 512
}

513

Jim Blandy's avatar
Jim Blandy committed
514 515 516 517 518

static struct window *
decode_window (window)
     register Lisp_Object window;
{
Jim Blandy's avatar
Jim Blandy committed
519
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
520 521
    return XWINDOW (selected_window);

522
  CHECK_LIVE_WINDOW (window);
Jim Blandy's avatar
Jim Blandy committed
523 524 525
  return XWINDOW (window);
}

526 527 528 529 530 531 532 533 534 535 536
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
537
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
538 539
       doc: /* Return the buffer that WINDOW is displaying.
WINDOW defaults to the selected window.  */)
540
     (window)
Jim Blandy's avatar
Jim Blandy committed
541 542 543 544 545 546
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

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

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
556 557 558 559 560
       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
561 562
     Lisp_Object window;
{
563
  return make_number (window_box_text_cols (decode_any_window (window)));
Jim Blandy's avatar
Jim Blandy committed
564 565
}

566 567 568 569 570 571 572 573 574
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
575
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
576 577
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
WINDOW defaults to the selected window.  */)
578
     (window)
Jim Blandy's avatar
Jim Blandy committed
579 580 581 582 583 584
     Lisp_Object window;
{
  return decode_window (window)->hscroll;
}

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

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
589
window so that the location of point moves off-window.  */)
590
     (window, ncol)
591
     Lisp_Object window, ncol;
Jim Blandy's avatar
Jim Blandy committed
592
{
593 594
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
595

596
  CHECK_NUMBER (ncol);
597
  hscroll = max (0, XINT (ncol));
598

599 600
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
601
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
602

603
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
604 605 606
  return ncol;
}

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

649 650 651 652 653
  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
654 655
}

656 657 658 659 660 661 662 663 664 665 666
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;
{
667
  register struct window *w = decode_any_window (window);
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685

  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;
{
686
  register struct window *w = decode_any_window (window);
687 688 689 690 691 692

  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)),
693
		make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
694 695 696 697 698 699 700
			     - 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,
701
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
702 703 704 705 706 707 708 709
\(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;
{
710
  register struct window *w = decode_any_window (window);
711 712 713 714 715 716

  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)),
717
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
718 719 720 721 722 723
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

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

   X and Y are frame relative pixel coordinates.  */

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

761 762
  /* 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.  */
763 764 765
  if (w->pseudo_window_p)
    {
      left_x = 0;
766 767 768
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
      top_y = WINDOW_TOP_EDGE_Y (w);
      bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
769 770 771
    }
  else
    {
772 773 774 775
      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);
776
    }
777

778 779 780 781
  /* Outside any interesting row?  */
  if (*y < top_y || *y >= bottom_y)
    return ON_NOTHING;

782 783 784 785 786
  /* 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.  */
787

788
  if (WINDOW_WANTS_MODELINE_P (w)
789
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
790
    {
791 792 793
      part = ON_MODE_LINE;

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

822 823 824
      if (*x < x0 || *x >= x1)
	return ON_NOTHING;

825 826 827 828
      /* Convert X and Y to window relative coordinates.
	 Mode line starts at left edge of window.  */
      *x -= x0;
      *y -= top_y;
829
      return part;
830
    }
831 832 833

  if (WINDOW_WANTS_HEADER_LINE_P (w)
      && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
834
    {
835 836
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
837
    }
838

839 840 841
  if (*x < x0 || *x >= x1)
    return ON_NOTHING;

842 843
  /* Outside any interesting column?  */
  if (*x < left_x || *x > right_x)
844 845 846 847
    {
      *y -= top_y;
      return ON_SCROLL_BAR;
    }
848 849 850

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

852 853 854 855
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

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

885 886 887 888 889 890
  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)))
891
	{
892
	  *x -= left_x;
893 894 895 896 897
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_LEFT_MARGIN;
	}
898 899 900 901 902 903 904 905 906 907 908 909 910

      /* 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)))
911
	{
912 913 914
	  *x -= right_x - rmargin_width;
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x += WINDOW_RIGHT_FRINGE_WIDTH (w);
915 916 917
	  *y -= top_y;
	  return ON_RIGHT_MARGIN;
	}
918 919 920 921 922 923 924 925

      /* 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 */
926
  *x -= text_left;
927 928
  *y -= top_y;
  return ON_TEXT;
Jim Blandy's avatar
Jim Blandy committed
929 930
}

931

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

957
  CHECK_WINDOW (window);
958 959
  w = XWINDOW (window);
  f = XFRAME (w->frame);
960
  CHECK_CONS (coordinates);
961 962
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
963 964
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
965 966
  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);
967 968

  switch (coordinates_in_window (w, &x, &y))
Jim Blandy's avatar
Jim Blandy committed
969
    {
970
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
971 972
      return Qnil;

973 974 975
    case ON_TEXT:
      /* X and Y are now window relative pixel coordinates.  Convert
	 them to canonical char units before returning them.  */
976 977
      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
978

979
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
980
      return Qmode_line;
981

982
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
983
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
984

985
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
986
      return Qheader_line;
987

988 989
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
990

991 992
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
993

994 995
    case ON_LEFT_MARGIN:
      return Qleft_margin;
996

997 998 999
    case ON_RIGHT_MARGIN:
      return Qright_margin;

1000 1001 1002 1003
    case ON_SCROLL_BAR:
      /* Historically we are supposed to return nil in this case.  */
      return Qnil;