window.c 226 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, 2010
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
#include <stdio.h>
24
#include <setjmp.h>
25

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
#include "blockinput.h"
#include "intervals.h"
39
#include "termhooks.h"		/* For FRAME_TERMINAL.  */
40

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


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

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

62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
static int displayed_window_lines (struct window *);
static struct window *decode_window (Lisp_Object);
static int count_windows (struct window *);
static int get_leaf_windows (struct window *, struct window **, int);
static void window_scroll (Lisp_Object, int, int, int);
static void window_scroll_pixel_based (Lisp_Object, int, int, int);
static void window_scroll_line_based (Lisp_Object, int, int, int);
static int window_min_size_1 (struct window *, int, int);
static int window_min_size_2 (struct window *, int, int);
static int window_min_size (struct window *, int, int, int, int *);
static void size_window (Lisp_Object, int, int, int, int, int);
static int freeze_window_start (struct window *, void *);
static int window_fixed_size_p (struct window *, int, int);
static void enlarge_window (Lisp_Object, int, int);
static Lisp_Object window_list (void);
static int add_window_to_list (struct window *, void *);
static int candidate_window_p (Lisp_Object, Lisp_Object, Lisp_Object,
                               Lisp_Object);
static Lisp_Object next_window (Lisp_Object, Lisp_Object,
                                Lisp_Object, int);
static void decode_next_window_args (Lisp_Object *, Lisp_Object *,
                                     Lisp_Object *);
static int foreach_window_1 (struct window *,
                             int (* fn) (struct window *, void *),
                             void *);
static Lisp_Object window_list_1 (Lisp_Object, Lisp_Object, Lisp_Object);
88

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

Lisp_Object selected_window;

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

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

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

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

115
Lisp_Object minibuf_selected_window;
116

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

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

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

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

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

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

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

int auto_window_vscroll_p;

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

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

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

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

147 148
Lisp_Object Qtemp_buffer_show_hook;

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

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

/* Incremented for each window created.  */
154

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

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

159 160
static int window_initialized;

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

163 164
static Lisp_Object Qwindow_configuration_change_hook;
static Lisp_Object Vwindow_configuration_change_hook;
165

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

169 170
Lisp_Object Vscroll_preserve_screen_position;

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

Lisp_Object Vwindow_point_insertion_type;

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

int window_deletion_count;

179 180
/* Used by the function window_scroll_pixel_based */

181
static int window_scroll_pixel_based_preserve_x;
182
static int window_scroll_pixel_based_preserve_y;
183

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

static int window_scroll_preserve_hpos;
static int window_scroll_preserve_vpos;

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

194
extern EMACS_INT scroll_margin;
195

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

  w = decode_window (window);

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

  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;

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

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

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

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

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

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

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

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

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

483

Jim Blandy's avatar
Jim Blandy committed
484 485

static struct window *
486
decode_window (register Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
487
{
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
static struct window *
496
decode_any_window (register Lisp_Object window)
Kenichi Handa's avatar
Kenichi Handa committed
497 498 499 500 501 502 503 504
{
  if (NILP (window))
    return XWINDOW (selected_window);

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

Jim Blandy's avatar
Jim Blandy committed
505
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
506 507
       doc: /* Return the buffer that WINDOW is displaying.
WINDOW defaults to the selected window.  */)
508
     (window)
Jim Blandy's avatar
Jim Blandy committed
509 510 511 512 513 514
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
515 516 517 518
       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.  */)
519
     (window)
Jim Blandy's avatar
Jim Blandy committed
520 521
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
522
  return decode_any_window (window)->total_lines;
Jim Blandy's avatar
Jim Blandy committed
523 524 525
}

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
526
       doc: /* Return the number of display columns in WINDOW.
527 528 529 530 531
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))).  */)
532
     (window)
Jim Blandy's avatar
Jim Blandy committed
533 534
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
535
  return make_number (window_box_text_cols (decode_any_window (window)));
Jim Blandy's avatar
Jim Blandy committed
536 537
}

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

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

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

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

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

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

579 580
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
581
       doc: /* Return WINDOW's redisplay end trigger value.
582
WINDOW defaults to the selected window.
583 584
See `set-window-redisplay-end-trigger' for more information.  */)
     (window)
585 586 587 588 589 590 591
     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,
592 593 594 595 596 597 598
       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)
599 600 601 602 603 604 605 606 607
     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
608
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
609
       doc: /* Return a list of the edge coordinates of WINDOW.
610 611 612 613 614 615 616 617 618
The list has the form (LEFT TOP RIGHT BOTTOM).
TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
all relative to 0, 0 at top left corner of frame.

RIGHT is one more than the rightmost column occupied by WINDOW.
BOTTOM is one more than the bottommost row occupied by WINDOW.
The edges include the space used by WINDOW's scroll bar, display
margins, fringes, header line, and/or mode line.  For the edges of
just the text area, use `window-inside-edges'.  */)
619
     (window)
Jim Blandy's avatar
Jim Blandy committed
620 621
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
622
  register struct window *w = decode_any_window (window);
Jim Blandy's avatar
Jim Blandy committed
623

624 625 626 627 628
  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
629 630
}

631 632
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
633 634 635 636 637 638 639 640
The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
the top left corner of the frame.

RIGHT is one more than the rightmost x position occupied by WINDOW.
BOTTOM is one more than the bottommost y position occupied by WINDOW.
The pixel edges include the space used by WINDOW's scroll bar, display
margins, fringes, header line, and/or mode line.  For the pixel edges
of just the text area, use `window-inside-pixel-edges'.  */)
641 642 643
     (window)
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
644
  register struct window *w = decode_any_window (window);
645 646 647 648 649 650 651 652

  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))));
}

653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
static void
calc_absolute_offset(struct window *w, int *add_x, int *add_y)
{
  struct frame *f = XFRAME (w->frame);
  *add_y = f->top_pos;
#ifdef FRAME_MENUBAR_HEIGHT
  *add_y += FRAME_MENUBAR_HEIGHT (f);
#endif
#ifdef FRAME_TOOLBAR_HEIGHT
  *add_y += FRAME_TOOLBAR_HEIGHT (f);
#endif
#ifdef FRAME_NS_TITLEBAR_HEIGHT
  *add_y += FRAME_NS_TITLEBAR_HEIGHT (f);
#endif
  *add_x = f->left_pos;
}

DEFUN ("window-absolute-pixel-edges", Fwindow_absolute_pixel_edges,
       Swindow_absolute_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
the top left corner of the display.

RIGHT is one more than the rightmost x position occupied by WINDOW.
BOTTOM is one more than the bottommost y position occupied by WINDOW.
The pixel edges include the space used by WINDOW's scroll bar, display
margins, fringes, header line, and/or mode line.  For the pixel edges
680
of just the text area, use `window-inside-absolute-pixel-edges'.  */)
681 682 683 684 685 686 687 688 689 690 691 692 693 694
     (window)
     Lisp_Object window;
{
  register struct window *w = decode_any_window (window);
  int add_x, add_y;
  calc_absolute_offset(w, &add_x, &add_y);

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

695 696
DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
       doc: /* Return a list of the edge coordinates of WINDOW.
697 698 699 700 701 702 703 704
The list has the form (LEFT TOP RIGHT BOTTOM).
TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns,
all relative to 0, 0 at top left corner of frame.

RIGHT is one more than the rightmost column of WINDOW's text area.
BOTTOM is one more than the bottommost row of WINDOW's text area.
The inside edges do not include the space used by the WINDOW's scroll
bar, display margins, fringes, header line, and/or mode line.  */)
705 706 707
     (window)
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
708
  register struct window *w = decode_any_window (window);
709 710 711 712 713 714

  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)),
715
		make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
716 717 718 719 720 721 722
			     - 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,
723
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
724 725 726 727 728 729
The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
the top left corner of the frame.

RIGHT is one more than the rightmost x position of WINDOW's text area.
BOTTOM is one more than the bottommost y position of WINDOW's text area.
The inside edges do not include the space used by WINDOW's scroll bar,
730 731 732 733
display margins, fringes, header line, and/or mode line.  */)
     (window)
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
734
  register struct window *w = decode_any_window (window);
735 736 737 738 739 740

  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)),
741
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
742 743 744 745 746 747
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
DEFUN ("window-inside-absolute-pixel-edges",
       Fwindow_inside_absolute_pixel_edges,
       Swindow_inside_absolute_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at
the top left corner of the display.

RIGHT is one more than the rightmost x position of WINDOW's text area.
BOTTOM is one more than the bottommost y position of WINDOW's text area.
The inside edges do not include the space used by WINDOW's scroll bar,
display margins, fringes, header line, and/or mode line.  */)
     (window)
     Lisp_Object window;
{
  register struct window *w = decode_any_window (window);
  int add_x, add_y;
  calc_absolute_offset(w, &add_x, &add_y);

  return list4 (make_number (WINDOW_BOX_LEFT_EDGE_X (w)
			     + WINDOW_LEFT_MARGIN_WIDTH (w)
			     + WINDOW_LEFT_FRINGE_WIDTH (w) + add_x),
		make_number (WINDOW_TOP_EDGE_Y (w)
			     + WINDOW_HEADER_LINE_HEIGHT (w) + add_y),
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w) + add_x),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w) + add_y));
}

778
/* Test if the character at column *X, row *Y is within window W.
779
   If it is not, return ON_NOTHING;
Jim Blandy's avatar
Jim Blandy committed
780 781 782
   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
783 784
      return ON_TEXT;
   if it is on the window's modeline, return ON_MODE_LINE;
Jim Blandy's avatar
Jim Blandy committed
785
   if it is on the border between the window and its right sibling,
786
      return ON_VERTICAL_BORDER.
787 788
   if it is on a scroll bar,
      return ON_SCROLL_BAR.
789
   if it is on the window's top line, return ON_HEADER_LINE;
Kim F. Storm's avatar
Kim F. Storm committed
790
   if it is in left or right fringe of the window,
791 792
      return ON_LEFT_FRINGE or ON_RIGHT_FRINGE, and convert *X and *Y
      to window-relative coordinates;
793
   if it is in the marginal area to the left/right of the window,
794 795
      return ON_LEFT_MARGIN or ON_RIGHT_MARGIN, and convert *X and *Y
      to window-relative coordinates.
796 797 798

   X and Y are frame relative pixel coordinates.  */

799
static enum window_part
800
coordinates_in_window (register struct window *w, register int *x, register int *y)
Jim Blandy's avatar
Jim Blandy committed
801
{
802 803
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  int left_x, right_x, top_y, bottom_y;
804
  enum window_part part;
805 806 807
  int ux = FRAME_COLUMN_WIDTH (f);
  int x0 = WINDOW_LEFT_EDGE_X (w);
  int x1 = WINDOW_RIGHT_EDGE_X (w);
808 809 810
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
811
  int lmargin_width, rmargin_width, text_left, text_right;
812

813 814
  /* 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.  */
815 816 817
  if (w->pseudo_window_p)
    {
      left_x = 0;
818 819 820
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
      top_y = WINDOW_TOP_EDGE_Y (w);
      bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
821 822 823
    }
  else
    {
824 825 826 827
      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);
828
    }
829

830 831 832 833
  /* Outside any interesting row?  */
  if (*y < top_y || *y >= bottom_y)
    return ON_NOTHING;

834 835 836 837 838
  /* 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.  */
839

840
  if (WINDOW_WANTS_MODELINE_P (w)
Kenichi Handa's avatar
Kenichi Handa committed
841
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
842
    {
843 844 845
      part = ON_MODE_LINE;

    header_vertical_border_check:
846 847
      /* We're somewhere on the mode line.  We consider the place
	 between mode lines of horizontally adjacent mode lines
848
	 as the vertical border.  If scroll bars on the left,
849
	 return the right window.  */
850 851
      if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
	  || WINDOW_RIGHTMOST_P (w))
852
	{
Eli Zaretskii's avatar
Eli Zaretskii committed
853
	  if (!WINDOW_LEFTMOST_P (w) && eabs (*x - x0) < grabbable_width)
854
	    {
855 856
	      /* Convert X and Y to window relative coordinates.
		 Vertical border is at the left edge of window.  */
857 858 859 860
	      *x = max (0, *x - x0);
	      *y -= top_y;
	      return ON_VERTICAL_BORDER;
	    }
861
	}
862
      else
863
	{
864 865 866 867 868
	  /* 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)
869
	    {
870 871
	      /* Convert X and Y to window relative coordinates.
		 Vertical border is at the right edge of window.  */
872 873 874 875
	      *x = min (x1, *x) - x0;
	      *y -= top_y;
	      return ON_VERTICAL_BORDER;
	    }
876
	}
877

878 879 880
      if (*x < x0 || *x >= x1)
	return ON_NOTHING;

881 882 883 884
      /* Convert X and Y to window relative coordinates.
	 Mode line starts at left edge of window.  */
      *x -= x0;
      *y -= top_y;
885
      return part;
886
    }
887 888 889

  if (WINDOW_WANTS_HEADER_LINE_P (w)
      && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
890
    {
891 892
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
893
    }
894

895 896 897
  if (*x < x0 || *x >= x1)
    return ON_NOTHING;

898 899
  /* Outside any interesting column?  */
  if (*x < left_x || *x > right_x)
900 901 902 903
    {
      *y -= top_y;
      return ON_SCROLL_BAR;
    }
904 905 906

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

908 909 910 911
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

  if (FRAME_WINDOW_P (f))
912
    {
913
      if (!w->pseudo_window_p
914
	  && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
915
	  && !WINDOW_RIGHTMOST_P (w)
Eli Zaretskii's avatar
Eli Zaretskii committed
916
	  && (eabs (*x - right_x) < grabbable_width))
917
	{
918 919
	  /* Convert X and Y to window relative coordinates.
	     Vertical border is at the right edge of window.  */
920 921 922 923
	  *x = min (right_x, *x) - left_x;
	  *y -= top_y;
	  return ON_VERTICAL_BORDER;
	}
924
    }
925 926 927 928
  else
    {
      /* Need to say "*x > right_x" rather than >=, since on character
	 terminals, the vertical line's x coordinate is right_x.  */
929 930 931
      if (!w->pseudo_window_p
	  && !WINDOW_RIGHTMOST_P (w)
	  && *x > right_x - ux)
932 933 934
	{
	  /* On the border on the right side of the window?  Assume that
	     this area begins at RIGHT_X minus a canonical char width.  */
935 936
	  *x = min (right_x, *x) - left_x;
	  *y -= top_y;
937
	  return ON_VERTICAL_BORDER;
938
	}
939
    }
940

941 942 943 944 945 946
  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)))
947
	{
Kenichi Handa's avatar
Kenichi Handa committed
948
	  *x -= left_x;
949 950 951 952 953
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_LEFT_MARGIN;
	}
954 955 956 957 958 959 960 961 962 963 964 965 966

      /* 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)))
967
	{
968 969 970
	  *x -= right_x - rmargin_width;
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x += WINDOW_RIGHT_FRINGE_WIDTH (w);
971 972 973
	  *y -= top_y;
	  return ON_RIGHT_MARGIN;
	}
974 975 976 977 978 979 980 981

      /* 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 */