window.c 219 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
/* Window creation, deletion and examination for GNU Emacs.
   Does not include redisplay.
3
   Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 2000,
Glenn Morris's avatar
Glenn Morris committed
4 5
                 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
6 7 8

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
20
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
21

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

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

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


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

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

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

Jim Blandy's avatar
Jim Blandy committed
88 89 90 91 92 93
/* This is the window in which the terminal's cursor should
   be left when nothing is being done with it.  This must
   always be a leaf window, and its buffer is selected by
   the top level editing loop at the end of each command.

   This value is always the same as
Jim Blandy's avatar
Jim Blandy committed
94
   FRAME_SELECTED_WINDOW (selected_frame).  */
Jim Blandy's avatar
Jim Blandy committed
95 96 97

Lisp_Object selected_window;

Gerd Moellmann's avatar
Gerd Moellmann committed
98 99 100 101 102 103
/* A list of all windows for use by next_window and Fwindow_list.
   Functions creating or deleting windows should invalidate this cache
   by setting it to nil.  */

Lisp_Object Vwindow_list;

104 105 106
/* The mini-buffer window of the selected frame.
   Note that you cannot test for mini-bufferness of an arbitrary window
   by comparing against this; but you can test for mini-bufferness of
Jim Blandy's avatar
Jim Blandy committed
107
   the selected window.  */
108

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

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

114
Lisp_Object minibuf_selected_window;
115

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

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

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

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

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

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

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

int auto_window_vscroll_p;

134 135 136 137
/* Non-zero means to use mode-line-inactive face in all windows but the
   selected-window and the minibuffer-scroll-window when the
   minibuffer is active.  */
int mode_line_in_non_selected_windows;
138

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

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

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

146 147
Lisp_Object Qtemp_buffer_show_hook;

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

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

/* Incremented for each window created.  */
153

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

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

158 159
static int window_initialized;

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

162 163
static Lisp_Object Qwindow_configuration_change_hook;
static Lisp_Object Vwindow_configuration_change_hook;
164

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

168 169
Lisp_Object Vscroll_preserve_screen_position;

170 171 172 173
/* Incremented by 1 whenever a window is deleted.  */

int window_deletion_count;

174 175
/* Used by the function window_scroll_pixel_based */

176
static int window_scroll_pixel_based_preserve_x;
177
static int window_scroll_pixel_based_preserve_y;
178

179 180 181 182 183
/* Same for window_scroll_line_based.  */

static int window_scroll_preserve_hpos;
static int window_scroll_preserve_vpos;

184
#if 0 /* This isn't used anywhere.  */
185
/* Nonzero means we can split a frame even if it is "unsplittable".  */
186
static int inhibit_frame_unsplittable;
187
#endif /* 0 */
188

189
extern EMACS_INT scroll_margin;
190

191
extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
Jim Blandy's avatar
Jim Blandy committed
192 193

DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
194 195
       doc: /* Returns t if OBJECT is a window.  */)
     (object)
196
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
197
{
198
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
199 200
}

201
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
202
       doc: /* Returns t if OBJECT is a window which is currently visible.  */)
203 204
     (object)
     Lisp_Object object;
205
{
206
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
207 208
}

Jim Blandy's avatar
Jim Blandy committed
209 210 211
Lisp_Object
make_window ()
{
212
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
213
  register struct window *p;
214

215
  p = allocate_window ();
216 217
  ++sequence_number;
  XSETFASTINT (p->sequence_number, sequence_number);
218 219 220 221
  XSETFASTINT (p->left_col, 0);
  XSETFASTINT (p->top_line, 0);
  XSETFASTINT (p->total_lines, 0);
  XSETFASTINT (p->total_cols, 0);
222
  XSETFASTINT (p->hscroll, 0);
223
  XSETFASTINT (p->min_hscroll, 0);
224
  p->orig_top_line = p->orig_total_lines = Qnil;
Jim Blandy's avatar
Jim Blandy committed
225 226
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
227
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
228
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
229 230
  p->display_table = Qnil;
  p->dedicated = Qnil;
231
  p->window_parameters = Qnil;
232 233 234 235 236
  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;
237
  p->nrows_scale_factor = p->ncols_scale_factor = 1;
238
  p->phys_cursor_type = -1;
239
  p->phys_cursor_width = -1;
240 241 242 243 244
  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;
245
  XSETWINDOW (val, p);
246
  XSETFASTINT (p->last_point, 0);
247
  p->frozen_window_start_p = 0;
248
  p->last_cursor_off_p = p->cursor_off_p = 0;
249 250 251 252 253 254 255
  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;
256
  p->resize_proportionally = Qnil;
Gerd Moellmann's avatar
Gerd Moellmann committed
257 258

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
259 260 261 262
  return val;
}

DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
263 264
       doc: /* Return the window that the cursor now appears in and commands apply to.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
265 266 267 268
{
  return selected_window;
}

269
DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
270 271 272 273
       doc: /* Return the window used now for minibuffers.
If the optional argument FRAME is specified, return the minibuffer window
used by that frame.  */)
     (frame)
274
    Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
275
{
276
  if (NILP (frame))
277
    frame = selected_frame;
278
  CHECK_LIVE_FRAME (frame);
279
  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
Jim Blandy's avatar
Jim Blandy committed
280 281
}

282
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
Kenichi Handa's avatar
Kenichi Handa committed
283 284
       doc: /* Returns non-nil if WINDOW is a minibuffer window.
WINDOW defaults to the selected window.  */)
285
     (window)
Jim Blandy's avatar
Jim Blandy committed
286 287 288
     Lisp_Object window;
{
  struct window *w = decode_window (window);
289
  return MINI_WINDOW_P (w) ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
290 291 292
}


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

Miles Bader's avatar
Miles Bader committed
321 322 323 324
  w = decode_window (window);
  buf = XBUFFER (w->buffer);
  SET_TEXT_POS_FROM_MARKER (top, w->start);

325 326 327
  if (EQ (pos, Qt))
    posint = -1;
  else if (!NILP (pos))
Jim Blandy's avatar
Jim Blandy committed
328
    {
329
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
330 331
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
332 333 334 335
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
336

337 338
  /* If position is above window start or outside buffer boundaries,
     or if window start is out of range, position is not visible.  */
339 340
  if ((EQ (pos, Qt)
       || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
341 342
      && CHARPOS (top) >= BUF_BEGV (buf)
      && CHARPOS (top) <= BUF_ZV (buf)
343
      && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
344
      && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
345 346 347
    in_window = Qt;

  if (!NILP (in_window) && !NILP (partially))
348 349 350 351 352 353 354 355 356
    {
      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));
    }

357
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
358
}
359

360
DEFUN ("window-line-height", Fwindow_line_height,
361
       Swindow_line_height, 0, 2, 0,
362 363 364
       doc: /* Return height in pixels of text line LINE in window WINDOW.
If WINDOW is nil or omitted, use selected window.

365 366 367 368
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.
369

370
Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
371
in pixels of the visible part of the line, VPOS and YPOS are the
372
vertical position in lines and pixels of the line, relative to the top
373
of the first text line, and OFFBOT is the number of off-window pixels at
374 375
the bottom of the text line.  If there are off-window pixels at the top
of the (first) text line, YPOS is negative.
376 377 378 379 380

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;
381 382 383 384
{
  register struct window *w;
  register struct buffer *b;
  struct glyph_row *row, *end_row;
385
  int max_y, crop, i, n;
386 387 388 389 390

  w = decode_window (window);

  if (noninteractive
      || w->pseudo_window_p)
391
    return Qnil;
392 393 394 395 396 397 398 399 400 401 402 403

  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;

404 405 406 407 408 409 410 411 412 413
  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;
    }

414
  if (EQ (line, Qheader_line))
415
    {
416 417 418
      if (!WINDOW_WANTS_HEADER_LINE_P (w))
	return Qnil;
      row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
419 420
      if (!row->enabled_p)
	return Qnil;
421 422 423
      return list4 (make_number (row->height),
		    make_number (0), make_number (0),
		    make_number (0));
424
    }
425 426

  if (EQ (line, Qmode_line))
427
    {
428 429 430 431 432 433 434 435 436
      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));
    }
437

438
  CHECK_NUMBER (line);
439
  n = XINT (line);
440 441 442 443

  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);
444
  i = 0;
445 446 447 448 449

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

451 452 453
  if (row > end_row || !row->enabled_p)
    return Qnil;

454
  if (++n < 0)
455 456 457
    {
      if (-n > i)
	return Qnil;
458 459
      row += n;
      i += n;
460 461
    }

462
 found_row:
463 464
  crop = max (0, (row->y + row->height) - max_y);
  return list4 (make_number (row->height + min (0, row->y) - crop),
465
		make_number (i),
466 467
		make_number (row->y),
		make_number (crop));
468 469
}

470

Jim Blandy's avatar
Jim Blandy committed
471 472 473 474 475

static struct window *
decode_window (window)
     register Lisp_Object window;
{
Jim Blandy's avatar
Jim Blandy committed
476
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
477 478
    return XWINDOW (selected_window);

479
  CHECK_LIVE_WINDOW (window);
Jim Blandy's avatar
Jim Blandy committed
480 481 482
  return XWINDOW (window);
}

Kenichi Handa's avatar
Kenichi Handa committed
483 484 485 486 487 488 489 490 491 492 493
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
494
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
495 496
       doc: /* Return the buffer that WINDOW is displaying.
WINDOW defaults to the selected window.  */)
497
     (window)
Jim Blandy's avatar
Jim Blandy committed
498 499 500 501 502 503
     Lisp_Object window;
{
  return decode_window (window)->buffer;
}

DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
504 505
       doc: /* Return the number of lines in WINDOW (including its mode line).
WINDOW defaults to the selected window.  */)
506
     (window)
Jim Blandy's avatar
Jim Blandy committed
507 508
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
509
  return decode_any_window (window)->total_lines;
Jim Blandy's avatar
Jim Blandy committed
510 511 512
}

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
513 514 515 516 517
       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
518 519
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
520
  return make_number (window_box_text_cols (decode_any_window (window)));
Jim Blandy's avatar
Jim Blandy committed
521 522
}

523 524 525 526 527 528 529 530 531
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
532
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
533 534
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
WINDOW defaults to the selected window.  */)
535
     (window)
Jim Blandy's avatar
Jim Blandy committed
536 537 538 539 540 541
     Lisp_Object window;
{
  return decode_window (window)->hscroll;
}

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

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
546
window so that the location of point moves off-window.  */)
547
     (window, ncol)
548
     Lisp_Object window, ncol;
Jim Blandy's avatar
Jim Blandy committed
549
{
550 551
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
552

553
  CHECK_NUMBER (ncol);
554
  hscroll = max (0, XINT (ncol));
555

556 557
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
558
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
559

560
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
561 562 563
  return ncol;
}

564 565
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
566
       doc: /* Return WINDOW's redisplay end trigger value.
567
WINDOW defaults to the selected window.
568 569
See `set-window-redisplay-end-trigger' for more information.  */)
     (window)
570 571 572 573 574 575 576
     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,
577 578 579 580 581 582 583
       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)
584 585 586 587 588 589 590 591 592
     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
593
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
594 595
       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.
596 597 598 599 600
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'.  */)
601
     (window)
Jim Blandy's avatar
Jim Blandy committed
602 603
     Lisp_Object window;
{
Kenichi Handa's avatar
Kenichi Handa committed
604
  register struct window *w = decode_any_window (window);
Jim Blandy's avatar
Jim Blandy committed
605

606 607 608 609 610
  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
611 612
}

613 614 615 616 617 618 619 620 621 622 623
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
624
  register struct window *w = decode_any_window (window);
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642

  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
643
  register struct window *w = decode_any_window (window);
644 645 646 647 648 649

  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)),
650
		make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
651 652 653 654 655 656 657
			     - 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,
658
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
659 660 661 662 663 664 665 666
\(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
667
  register struct window *w = decode_any_window (window);
668 669 670 671 672 673

  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)),
674
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
675 676 677 678 679 680
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

681
/* Test if the character at column *X, row *Y is within window W.
682
   If it is not, return ON_NOTHING;
Jim Blandy's avatar
Jim Blandy committed
683 684 685
   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
686 687
      return ON_TEXT;
   if it is on the window's modeline, return ON_MODE_LINE;
Jim Blandy's avatar
Jim Blandy committed
688
   if it is on the border between the window and its right sibling,
689
      return ON_VERTICAL_BORDER.
690 691
   if it is on a scroll bar,
      return ON_SCROLL_BAR.
692
   if it is on the window's top line, return ON_HEADER_LINE;
Kim F. Storm's avatar
Kim F. Storm committed
693
   if it is in left or right fringe of the window,
694 695
      return ON_LEFT_FRINGE or ON_RIGHT_FRINGE, and convert *X and *Y
      to window-relative coordinates;
696
   if it is in the marginal area to the left/right of the window,
697 698
      return ON_LEFT_MARGIN or ON_RIGHT_MARGIN, and convert *X and *Y
      to window-relative coordinates.
699 700 701

   X and Y are frame relative pixel coordinates.  */

702
static enum window_part
Jim Blandy's avatar
Jim Blandy committed
703 704 705 706
coordinates_in_window (w, x, y)
     register struct window *w;
     register int *x, *y;
{
707 708
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  int left_x, right_x, top_y, bottom_y;
709
  enum window_part part;
710 711 712
  int ux = FRAME_COLUMN_WIDTH (f);
  int x0 = WINDOW_LEFT_EDGE_X (w);
  int x1 = WINDOW_RIGHT_EDGE_X (w);
713 714 715
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
716
  int lmargin_width, rmargin_width, text_left, text_right;
717

718 719
  /* 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.  */
720 721 722
  if (w->pseudo_window_p)
    {
      left_x = 0;
723 724 725
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
      top_y = WINDOW_TOP_EDGE_Y (w);
      bottom_y = WINDOW_BOTTOM_EDGE_Y (w);
726 727 728
    }
  else
    {
729 730 731 732
      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);
733
    }
734

735 736 737 738
  /* Outside any interesting row?  */
  if (*y < top_y || *y >= bottom_y)
    return ON_NOTHING;

739 740 741 742 743
  /* 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.  */
744

745
  if (WINDOW_WANTS_MODELINE_P (w)
Kenichi Handa's avatar
Kenichi Handa committed
746
      && *y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
747
    {
748 749 750
      part = ON_MODE_LINE;

    header_vertical_border_check:
751 752
      /* We're somewhere on the mode line.  We consider the place
	 between mode lines of horizontally adjacent mode lines
753
	 as the vertical border.  If scroll bars on the left,
754
	 return the right window.  */
755 756
      if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
	  || WINDOW_RIGHTMOST_P (w))
757
	{
Eli Zaretskii's avatar
Eli Zaretskii committed
758
	  if (!WINDOW_LEFTMOST_P (w) && eabs (*x - x0) < grabbable_width)
759
	    {
760 761
	      /* Convert X and Y to window relative coordinates.
		 Vertical border is at the left edge of window.  */
762 763 764 765
	      *x = max (0, *x - x0);
	      *y -= top_y;
	      return ON_VERTICAL_BORDER;
	    }
766
	}
767
      else
768
	{
Eli Zaretskii's avatar
Eli Zaretskii committed
769
	  if (eabs (*x - x1) < grabbable_width)
770
	    {
771 772
	      /* Convert X and Y to window relative coordinates.
		 Vertical border is at the right edge of window.  */
773 774 775 776
	      *x = min (x1, *x) - x0;
	      *y -= top_y;
	      return ON_VERTICAL_BORDER;
	    }
777
	}
778

779 780 781
      if (*x < x0 || *x >= x1)
	return ON_NOTHING;

782 783 784 785
      /* Convert X and Y to window relative coordinates.
	 Mode line starts at left edge of window.  */
      *x -= x0;
      *y -= top_y;
786
      return part;
787
    }
788 789 790

  if (WINDOW_WANTS_HEADER_LINE_P (w)
      && *y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
791
    {
792 793
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
794
    }
795

796 797 798
  if (*x < x0 || *x >= x1)
    return ON_NOTHING;

799 800
  /* Outside any interesting column?  */
  if (*x < left_x || *x > right_x)
801 802 803 804
    {
      *y -= top_y;
      return ON_SCROLL_BAR;
    }
805 806 807

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

809 810 811 812
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

  if (FRAME_WINDOW_P (f))
813
    {
814
      if (!w->pseudo_window_p
815
	  && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
816
	  && !WINDOW_RIGHTMOST_P (w)
Eli Zaretskii's avatar
Eli Zaretskii committed
817
	  && (eabs (*x - right_x) < grabbable_width))
818
	{
819 820
	  /* Convert X and Y to window relative coordinates.
	     Vertical border is at the right edge of window.  */
821 822 823 824
	  *x = min (right_x, *x) - left_x;
	  *y -= top_y;
	  return ON_VERTICAL_BORDER;
	}
825
    }
826 827 828 829
  else
    {
      /* Need to say "*x > right_x" rather than >=, since on character
	 terminals, the vertical line's x coordinate is right_x.  */
830 831 832
      if (!w->pseudo_window_p
	  && !WINDOW_RIGHTMOST_P (w)
	  && *x > right_x - ux)
833 834 835
	{
	  /* On the border on the right side of the window?  Assume that
	     this area begins at RIGHT_X minus a canonical char width.  */
836 837
	  *x = min (right_x, *x) - left_x;
	  *y -= top_y;
838
	  return ON_VERTICAL_BORDER;
839
	}
840
    }
841

842 843 844 845 846 847
  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)))
848
	{
Kenichi Handa's avatar
Kenichi Handa committed
849
	  *x -= left_x;
850 851 852 853 854
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x -= WINDOW_LEFT_FRINGE_WIDTH (w);
	  *y -= top_y;
	  return ON_LEFT_MARGIN;
	}
855 856 857 858 859 860 861 862 863 864 865 866 867

      /* 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)))
868
	{
869 870 871
	  *x -= right_x - rmargin_width;
	  if (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
	    *x += WINDOW_RIGHT_FRINGE_WIDTH (w);
872 873 874
	  *y -= top_y;
	  return ON_RIGHT_MARGIN;
	}
875 876 877 878 879 880 881 882

      /* 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 */
883
  *x -= text_left;
884 885
  *y -= top_y;
  return ON_TEXT;
Jim Blandy's avatar
Jim Blandy committed
886 887
}

888

Jim Blandy's avatar
Jim Blandy committed
889
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
890 891 892 893 894 895 896 897 898 899
       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
900 901
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.
902
If they are on the border between WINDOW and its right sibling,
903 904 905
  `vertical-line' is returned.
If they are in the windows's left or right marginal areas, `left-margin'\n\
  or `right-margin' is returned.  */)
906
     (coordinates, window)
Jim Blandy's avatar
Jim Blandy committed
907 908
     register Lisp_Object coordinates, window;
{
909 910
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
911
  int x, y;
912
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
913

Kenichi Handa's avatar
Kenichi Handa committed
914
  CHECK_WINDOW (window);
915 916
  w = XWINDOW (window);
  f = XFRAME (w->frame);
917
  CHECK_CONS (coordinates);
918 919
  lx = Fcar (coordinates);
  ly = Fcdr (coordinates);
920 921
  CHECK_NUMBER_OR_FLOAT (lx);
  CHECK_NUMBER_OR_FLOAT (ly);
922 923
  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);
924 925

  switch (coordinates_in_window (w, &x, &y))
Jim Blandy's avatar
Jim Blandy committed
926
    {
927
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
928 929
      return Qnil;

930 931 932
    case ON_TEXT:
      /* X and Y are now window relative pixel coordinates.  Convert
	 them to canonical char units before returning them.  */
933 934
      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
935

936
    case ON_MODE_LINE:
Jim Blandy's avatar
Jim Blandy committed
937
      return Qmode_line;
938

939
    case ON_VERTICAL_BORDER:
Jim Blandy's avatar
Jim Blandy committed
940
      return Qvertical_line;
Jim Blandy's avatar
Jim Blandy committed
941

942
    case ON_HEADER_LINE:
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
943
      return Qheader_line;
944

945 946
    case ON_LEFT_FRINGE:
      return Qleft_fringe;
947

948 949
    case ON_RIGHT_FRINGE:
      return Qright_fringe;
950

951 952
    case ON_LEFT_MARGIN:
      return Qleft_margin;
953

954 955 956
    case ON_RIGHT_MARGIN:
      return Qright_margin;

957 958 959 960
    case ON_SCROLL_BAR:
      /* Historically we are supposed to return nil in this case.  */
      return Qnil;

Jim Blandy's avatar
Jim Blandy committed
961 962 963 964 965
    default:
      abort ();
    }
}

Gerd Moellmann's avatar
Gerd Moellmann committed
966 967

/* Callback for foreach_window, used in window_from_coordinates.
968 969 970 971 972
   Check if window W contains coordinates specified by USER_DATA which
   is actually a pointer to a struct check_window_data CW.

   Check if window W contains coordinates *CW->x and *CW->y.  If it
   does, return W in *CW->window, as Lisp_Object, and return in
Dave Love's avatar
Dave Love committed
973
   *CW->part the part of the window under coordinates *X,*Y.  Return
974 975 976 977 978
   zero from this function to stop iterating over windows.  */

struct check_window_data
{
  Lisp_Object *window;
979 980
  int *x, *y;
  enum window_part *part;
981
};
Gerd Moellmann's avatar
Gerd Moellmann committed
982 983

static int
984
check_window_containing (w, user_data)
Gerd Moellmann's avatar
Gerd Moellmann committed
985
     struct window *w;
986
     void *user_data;
Gerd Moellmann's avatar
Gerd Moellmann committed
987
{
988
  struct check_window_data *cw = (struct check_window_data *) user_data;
989 990
  enum window_part found;
  int continue_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
991

992
  found = coordinates_in_window (w, cw->x, cw->y);
993
  if (found != ON_NOTHING)
Gerd Moellmann's avatar
Gerd Moellmann committed
994
    {
995
      *cw->part = found;
996
      XSETWINDOW (*cw->window, w);
997
      continue_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
998
    }
Juanma Barranquero's avatar