window.c 236 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 9 10

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
11
the Free Software Foundation; either version 3, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18 19 20
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
21 22
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
23

24
#include <config.h>
25 26
#include <stdio.h>

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

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


56
Lisp_Object Qwindowp, Qwindow_live_p, Qwindow_configuration_p;
57
Lisp_Object Qscroll_up, Qscroll_down;
58
Lisp_Object Qwindow_size_fixed;
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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
150
int pop_up_frames;
Jim Blandy's avatar
Jim Blandy committed
151

152 153 154 155
/* Nonzero means reuse existing frames for displaying buffers.  */

int display_buffer_reuse_frames;

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

Jim Blandy's avatar
Jim Blandy committed
158
Lisp_Object Vpop_up_frame_function;
Jim Blandy's avatar
Jim Blandy committed
159 160

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

Jim Blandy's avatar
Jim Blandy committed
162 163
Lisp_Object Vdisplay_buffer_function;

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

Lisp_Object Veven_window_heights;

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

170 171 172
Lisp_Object Vspecial_display_buffer_names;

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

174 175 176
Lisp_Object Vspecial_display_regexps;

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

178 179
Lisp_Object Vspecial_display_function;

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

182 183 184
Lisp_Object Vsame_window_buffer_names;

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

186 187
Lisp_Object Vsame_window_regexps;

188
/* Hook run at end of temp_output_buffer_show.  */
189

190 191
Lisp_Object Qtemp_buffer_show_hook;

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

195
EMACS_INT split_height_threshold;
Jim Blandy's avatar
Jim Blandy committed
196

197 198 199 200
/* How to split windows (horizontally/vertically/hybrid).  */

Lisp_Object Vsplit_window_preferred_function;

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

203
EMACS_INT next_screen_context_lines;
Jim Blandy's avatar
Jim Blandy committed
204 205

/* Incremented for each window created.  */
206

Jim Blandy's avatar
Jim Blandy committed
207 208
static int sequence_number;

209
/* Nonzero after init_window_once has finished.  */
210

211 212
static int window_initialized;

213
/* Hook to run when window config changes.  */
214

215 216
static Lisp_Object Qwindow_configuration_change_hook;
static Lisp_Object Vwindow_configuration_change_hook;
217

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

221 222
Lisp_Object Vscroll_preserve_screen_position;

223 224 225 226
/* Incremented by 1 whenever a window is deleted.  */

int window_deletion_count;

227 228
/* Used by the function window_scroll_pixel_based */

229
static int window_scroll_pixel_based_preserve_y;
230

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

236
extern EMACS_INT scroll_margin;
237

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

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

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

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

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
305 306 307 308
  return val;
}

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

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

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


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

Miles Bader's avatar
Miles Bader committed
367 368 369 370
  w = decode_window (window);
  buf = XBUFFER (w->buffer);
  SET_TEXT_POS_FROM_MARKER (top, w->start);

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

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

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

403
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
404
}
405

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

411 412 413 414
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.
415

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

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

  w = decode_window (window);

  if (noninteractive
      || w->pseudo_window_p)
437
    return Qnil;
438 439 440 441 442 443 444 445 446 447 448 449

  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;

450 451 452 453 454 455 456 457 458 459
  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;
    }

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

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

484
  CHECK_NUMBER (line);
485
  n = XINT (line);
486 487 488 489

  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);
490
  i = 0;
491 492 493 494 495

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

497 498 499
  if (row > end_row || !row->enabled_p)
    return Qnil;

500
  if (++n < 0)
501 502 503
    {
      if (-n > i)
	return Qnil;
504 505
      row += n;
      i += n;
506 507
    }

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

516

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

525
  CHECK_LIVE_WINDOW (window);
Jim Blandy's avatar
Jim Blandy committed
526 527 528
  return XWINDOW (window);
}

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

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

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

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

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

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

599
  CHECK_NUMBER (ncol);
600
  hscroll = max (0, XINT (ncol));
601

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

606
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
607 608 609
  return ncol;
}

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

652 653 654 655 656
  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
657 658
}

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

  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
689
  register struct window *w = decode_any_window (window);
690 691 692 693 694 695

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

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

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

   X and Y are frame relative pixel coordinates.  */

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

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

781 782 783 784
  /* Outside any interesting row?  */
  if (*y < top_y || *y >= bottom_y)
    return ON_NOTHING;

785 786 787 788 789
  /* 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.  */
790

791
  if (WINDOW_WANTS_MODELINE_P (w)
Kenichi Handa's avatar
Kenichi Handa committed
792
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
793
    {
794 795 796
      part = ON_MODE_LINE;

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

825 826 827
      if (*x < x0 || *x >= x1)
	return ON_NOTHING;

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

  if (WINDOW_WANTS_HEADER_LINE_P (w)
      && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
837
    {
838 839
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
840
    }
841

842 843 844
  if (*x < x0 || *x >= x1)
    return ON_NOTHING;

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

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

855 856 857 858
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

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

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

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

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

934

Jim Blandy's avatar
Jim Blandy committed
935
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,