window.c 224 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
/* Window creation, deletion and examination for GNU Emacs.
   Does not include redisplay.
3
   Copyright (C) 1985-1987, 1993-1998, 2000-2011
Glenn Morris's avatar
Glenn Morris committed
4
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

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

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

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

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

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
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 *);
Andreas Schwab's avatar
Andreas Schwab committed
81
static void foreach_window (struct frame *,
82
				 int (* fn) (struct window *, void *),
Andreas Schwab's avatar
Andreas Schwab committed
83
                            void *);
84 85 86 87
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);
Glenn Morris's avatar
Glenn Morris committed
88
static Lisp_Object select_window (Lisp_Object, Lisp_Object, int);
89

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

Lisp_Object selected_window;

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

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

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

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

116
Lisp_Object minibuf_selected_window;
117

118
/* Hook run at end of temp_output_buffer_show.  */
119

120
static Lisp_Object Qtemp_buffer_show_hook;
121

Jim Blandy's avatar
Jim Blandy committed
122
/* Incremented for each window created.  */
123

Jim Blandy's avatar
Jim Blandy committed
124 125
static int sequence_number;

126
/* Nonzero after init_window_once has finished.  */
127

128 129
static int window_initialized;

130
/* Hook to run when window config changes.  */
131

132
static Lisp_Object Qwindow_configuration_change_hook;
133 134
/* Incremented by 1 whenever a window is deleted.  */

135
static int window_deletion_count;
136

137 138
/* Used by the function window_scroll_pixel_based */

139
static int window_scroll_pixel_based_preserve_x;
140
static int window_scroll_pixel_based_preserve_y;
141

142 143 144 145 146
/* Same for window_scroll_line_based.  */

static int window_scroll_preserve_hpos;
static int window_scroll_preserve_vpos;

147
#if 0 /* This isn't used anywhere.  */
148
/* Nonzero means we can split a frame even if it is "unsplittable".  */
149
static int inhibit_frame_unsplittable;
150
#endif
151

Jim Blandy's avatar
Jim Blandy committed
152 153

DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
154
       doc: /* Return t if OBJECT is a window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
155
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
156
{
157
  return WINDOWP (object) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
158 159
}

160
DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
161
       doc: /* Return t if OBJECT is a window which is currently visible.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
162
  (Lisp_Object object)
163
{
164
  return WINDOW_LIVE_P (object) ? Qt : Qnil;
165 166
}

Jim Blandy's avatar
Jim Blandy committed
167
Lisp_Object
168
make_window (void)
Jim Blandy's avatar
Jim Blandy committed
169
{
170
  Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
171
  register struct window *p;
172

173
  p = allocate_window ();
174 175
  ++sequence_number;
  XSETFASTINT (p->sequence_number, sequence_number);
176 177 178 179
  XSETFASTINT (p->left_col, 0);
  XSETFASTINT (p->top_line, 0);
  XSETFASTINT (p->total_lines, 0);
  XSETFASTINT (p->total_cols, 0);
180
  XSETFASTINT (p->hscroll, 0);
181
  XSETFASTINT (p->min_hscroll, 0);
182
  p->orig_top_line = p->orig_total_lines = Qnil;
Jim Blandy's avatar
Jim Blandy committed
183 184
  p->start = Fmake_marker ();
  p->pointm = Fmake_marker ();
185
  XSETFASTINT (p->use_time, 0);
Jim Blandy's avatar
Jim Blandy committed
186
  p->frame = Qnil;
Jim Blandy's avatar
Jim Blandy committed
187 188
  p->display_table = Qnil;
  p->dedicated = Qnil;
189
  p->window_parameters = Qnil;
190
  p->pseudo_window_p = 0;
191 192 193
  memset (&p->cursor, 0, sizeof (p->cursor));
  memset (&p->last_cursor, 0, sizeof (p->last_cursor));
  memset (&p->phys_cursor, 0, sizeof (p->phys_cursor));
194
  p->desired_matrix = p->current_matrix = 0;
195
  p->nrows_scale_factor = p->ncols_scale_factor = 1;
196
  p->phys_cursor_type = -1;
197
  p->phys_cursor_width = -1;
198 199 200 201 202
  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;
203
  XSETWINDOW (val, p);
204
  XSETFASTINT (p->last_point, 0);
205
  p->frozen_window_start_p = 0;
206
  p->last_cursor_off_p = p->cursor_off_p = 0;
207 208 209 210 211 212 213
  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;
214
  p->resize_proportionally = Qnil;
Gerd Moellmann's avatar
Gerd Moellmann committed
215 216

  Vwindow_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
217 218 219
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
220
DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
221
       doc: /* Return the window that the cursor now appears in and commands apply to.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
222
  (void)
Jim Blandy's avatar
Jim Blandy committed
223 224 225 226
{
  return selected_window;
}

227
DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
228 229 230
       doc: /* Return the window used now for minibuffers.
If the optional argument FRAME is specified, return the minibuffer window
used by that frame.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
231
  (Lisp_Object frame)
Jim Blandy's avatar
Jim Blandy committed
232
{
233
  if (NILP (frame))
234
    frame = selected_frame;
235
  CHECK_LIVE_FRAME (frame);
236
  return FRAME_MINIBUF_WINDOW (XFRAME (frame));
Jim Blandy's avatar
Jim Blandy committed
237 238
}

Paul Eggert's avatar
Paul Eggert committed
239
DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p,
240
       Swindow_minibuffer_p, 0, 1, 0,
241
       doc: /* Return non-nil if WINDOW is a minibuffer window.
Kenichi Handa's avatar
Kenichi Handa committed
242
WINDOW defaults to the selected window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
243
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
244 245
{
  struct window *w = decode_window (window);
246
  return MINI_WINDOW_P (w) ? Qt : Qnil;
Miles Bader's avatar
Miles Bader committed
247 248 249
}


Paul Eggert's avatar
Paul Eggert committed
250
DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
251
       Spos_visible_in_window_p, 0, 3, 0,
252
       doc: /* Return non-nil if position POS is currently on the frame in WINDOW.
253 254 255
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.
256
If POS is only out of view because of horizontal scrolling, return non-nil.
257
If POS is t, it specifies the position of the last visible glyph in WINDOW.
258 259 260
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,
261 262 263 264
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
265
off-window at the top and bottom of the row, ROWH is the height of the
266
display row, and VPOS is the row number (0-based) containing POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
267
  (Lisp_Object pos, Lisp_Object window, Lisp_Object partially)
Jim Blandy's avatar
Jim Blandy committed
268 269
{
  register struct window *w;
270
  register EMACS_INT posint;
Jim Blandy's avatar
Jim Blandy committed
271
  register struct buffer *buf;
272
  struct text_pos top;
273
  Lisp_Object in_window = Qnil;
274
  int rtop, rbot, rowh, vpos, fully_p = 1;
275
  int x, y;
Jim Blandy's avatar
Jim Blandy committed
276

Miles Bader's avatar
Miles Bader committed
277 278 279 280
  w = decode_window (window);
  buf = XBUFFER (w->buffer);
  SET_TEXT_POS_FROM_MARKER (top, w->start);

281 282 283
  if (EQ (pos, Qt))
    posint = -1;
  else if (!NILP (pos))
Jim Blandy's avatar
Jim Blandy committed
284
    {
285
      CHECK_NUMBER_COERCE_MARKER (pos);
Jim Blandy's avatar
Jim Blandy committed
286 287
      posint = XINT (pos);
    }
Miles Bader's avatar
Miles Bader committed
288 289 290 291
  else if (w == XWINDOW (selected_window))
    posint = PT;
  else
    posint = XMARKER (w->pointm)->charpos;
Jim Blandy's avatar
Jim Blandy committed
292

293 294
  /* If position is above window start or outside buffer boundaries,
     or if window start is out of range, position is not visible.  */
295 296
  if ((EQ (pos, Qt)
       || (posint >= CHARPOS (top) && posint <= BUF_ZV (buf)))
297 298
      && CHARPOS (top) >= BUF_BEGV (buf)
      && CHARPOS (top) <= BUF_ZV (buf)
299
      && pos_visible_p (w, posint, &x, &y, &rtop, &rbot, &rowh, &vpos)
300
      && (fully_p = !rtop && !rbot, (!NILP (partially) || fully_p)))
301 302 303
    in_window = Qt;

  if (!NILP (in_window) && !NILP (partially))
304 305 306 307 308 309 310 311 312
    {
      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));
    }

313
  return in_window;
Jim Blandy's avatar
Jim Blandy committed
314
}
315

316
DEFUN ("window-line-height", Fwindow_line_height,
317
       Swindow_line_height, 0, 2, 0,
318 319 320
       doc: /* Return height in pixels of text line LINE in window WINDOW.
If WINDOW is nil or omitted, use selected window.

321 322 323 324
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.
325

326
Value is a list (HEIGHT VPOS YPOS OFFBOT), where HEIGHT is the height
327
in pixels of the visible part of the line, VPOS and YPOS are the
328
vertical position in lines and pixels of the line, relative to the top
329
of the first text line, and OFFBOT is the number of off-window pixels at
330 331
the bottom of the text line.  If there are off-window pixels at the top
of the (first) text line, YPOS is negative.
332 333 334

Return nil if window display is not up-to-date.  In that case, use
`pos-visible-in-window-p' to obtain the information.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
335
  (Lisp_Object line, Lisp_Object window)
336 337 338 339
{
  register struct window *w;
  register struct buffer *b;
  struct glyph_row *row, *end_row;
340
  int max_y, crop, i, n;
341 342 343 344 345

  w = decode_window (window);

  if (noninteractive
      || w->pseudo_window_p)
346
    return Qnil;
347 348 349 350 351 352 353 354 355 356 357 358

  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;

359 360 361 362 363 364 365 366 367 368
  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;
    }

369
  if (EQ (line, Qheader_line))
370
    {
371 372 373
      if (!WINDOW_WANTS_HEADER_LINE_P (w))
	return Qnil;
      row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
374 375
      if (!row->enabled_p)
	return Qnil;
376 377 378
      return list4 (make_number (row->height),
		    make_number (0), make_number (0),
		    make_number (0));
379
    }
380 381

  if (EQ (line, Qmode_line))
382
    {
383 384 385 386 387 388 389 390 391
      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));
    }
392

393
  CHECK_NUMBER (line);
394
  n = XINT (line);
395 396 397 398

  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);
399
  i = 0;
400 401 402 403 404

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

406 407 408
  if (row > end_row || !row->enabled_p)
    return Qnil;

409
  if (++n < 0)
410 411 412
    {
      if (-n > i)
	return Qnil;
413 414
      row += n;
      i += n;
415 416
    }

417
 found_row:
418 419
  crop = max (0, (row->y + row->height) - max_y);
  return list4 (make_number (row->height + min (0, row->y) - crop),
420
		make_number (i),
421 422
		make_number (row->y),
		make_number (crop));
423 424
}

425

Jim Blandy's avatar
Jim Blandy committed
426 427

static struct window *
428
decode_window (register Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
429
{
Jim Blandy's avatar
Jim Blandy committed
430
  if (NILP (window))
Jim Blandy's avatar
Jim Blandy committed
431 432
    return XWINDOW (selected_window);

433
  CHECK_LIVE_WINDOW (window);
Jim Blandy's avatar
Jim Blandy committed
434 435 436
  return XWINDOW (window);
}

Kenichi Handa's avatar
Kenichi Handa committed
437
static struct window *
438
decode_any_window (register Lisp_Object window)
Kenichi Handa's avatar
Kenichi Handa committed
439 440 441 442 443 444 445 446
{
  if (NILP (window))
    return XWINDOW (selected_window);

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

Paul Eggert's avatar
Paul Eggert committed
447
DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
448 449
       doc: /* Return the buffer that WINDOW is displaying.
WINDOW defaults to the selected window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
450
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
451 452 453 454 455
{
  return decode_window (window)->buffer;
}

DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
456 457 458
       doc: /* Return the number of lines in WINDOW.
WINDOW defaults to the selected window.

459 460 461 462
The return value includes WINDOW's mode line and header line, if any.

Note: The function does not take into account the value of `line-spacing'
when calculating the number of lines in WINDOW.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
463
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
464
{
Kenichi Handa's avatar
Kenichi Handa committed
465
  return decode_any_window (window)->total_lines;
Jim Blandy's avatar
Jim Blandy committed
466 467 468
}

DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
469
       doc: /* Return the number of display columns in WINDOW.
470 471 472 473 474
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))).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
475
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
476
{
Kenichi Handa's avatar
Kenichi Handa committed
477
  return make_number (window_box_text_cols (decode_any_window (window)));
Jim Blandy's avatar
Jim Blandy committed
478 479
}

480 481 482
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
483
  (Lisp_Object window)
484 485 486 487
{
  return WINDOW_FULL_WIDTH_P (decode_any_window (window)) ? Qt : Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
488
DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
489 490
       doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
WINDOW defaults to the selected window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
491
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
492 493 494 495 496
{
  return decode_window (window)->hscroll;
}

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

Note that if `automatic-hscrolling' is non-nil, you cannot scroll the
501
window so that the location of point moves off-window.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
502
  (Lisp_Object window, Lisp_Object ncol)
Jim Blandy's avatar
Jim Blandy committed
503
{
504 505
  struct window *w = decode_window (window);
  int hscroll;
Jim Blandy's avatar
Jim Blandy committed
506

507
  CHECK_NUMBER (ncol);
508
  hscroll = max (0, XINT (ncol));
509

510 511
  /* Prevent redisplay shortcuts when changing the hscroll.  */
  if (XINT (w->hscroll) != hscroll)
Gerd Moellmann's avatar
Gerd Moellmann committed
512
    XBUFFER (w->buffer)->prevent_redisplay_optimizations_p = 1;
513

514
  w->hscroll = make_number (hscroll);
Jim Blandy's avatar
Jim Blandy committed
515 516 517
  return ncol;
}

518 519
DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
       Swindow_redisplay_end_trigger, 0, 1, 0,
520
       doc: /* Return WINDOW's redisplay end trigger value.
521
WINDOW defaults to the selected window.
522
See `set-window-redisplay-end-trigger' for more information.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
523
  (Lisp_Object window)
524 525 526 527 528 529
{
  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,
530 531 532 533 534 535
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
536
  (register Lisp_Object window, Lisp_Object value)
537 538 539 540 541 542 543 544
{
  register struct window *w;

  w = decode_window (window);
  w->redisplay_end_trigger = value;
  return value;
}

Jim Blandy's avatar
Jim Blandy committed
545
DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
546
       doc: /* Return a list of the edge coordinates of WINDOW.
547 548 549 550 551 552 553 554 555
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'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
556
  (Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
557
{
Kenichi Handa's avatar
Kenichi Handa committed
558
  register struct window *w = decode_any_window (window);
Jim Blandy's avatar
Jim Blandy committed
559

560 561 562 563 564
  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
565 566
}

567 568
DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0,
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
569 570 571 572 573 574 575 576
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'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
577
  (Lisp_Object window)
578
{
Kenichi Handa's avatar
Kenichi Handa committed
579
  register struct window *w = decode_any_window (window);
580 581 582 583 584 585 586 587

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

588 589 590 591 592 593 594 595
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
596 597 598
#ifdef FRAME_TOOLBAR_TOP_HEIGHT
  *add_y += FRAME_TOOLBAR_TOP_HEIGHT (f);
#elif FRAME_TOOLBAR_HEIGHT
599 600 601 602 603 604
  *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;
605 606 607
#ifdef FRAME_TOOLBAR_LEFT_WIDTH
  *add_x += FRAME_TOOLBAR_LEFT_WIDTH (f);
#endif
608 609 610 611 612 613 614 615 616 617 618 619
}

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
620
of just the text area, use `window-inside-absolute-pixel-edges'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
621
  (Lisp_Object window)
622 623 624
{
  register struct window *w = decode_any_window (window);
  int add_x, add_y;
625
  calc_absolute_offset (w, &add_x, &add_y);
626 627 628 629 630 631 632 633

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

634 635
DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0,
       doc: /* Return a list of the edge coordinates of WINDOW.
636 637 638 639 640 641 642 643
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
644
  (Lisp_Object window)
645
{
Kenichi Handa's avatar
Kenichi Handa committed
646
  register struct window *w = decode_any_window (window);
647 648 649 650 651 652

  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)),
653
		make_number (WINDOW_BOX_RIGHT_EDGE_COL (w)
654 655 656 657 658 659 660
			     - 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,
661
       doc: /* Return a list of the edge pixel coordinates of WINDOW.
662 663 664 665 666 667
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,
668
display margins, fringes, header line, and/or mode line.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
669
  (Lisp_Object window)
670
{
Kenichi Handa's avatar
Kenichi Handa committed
671
  register struct window *w = decode_any_window (window);
672 673 674 675 676 677

  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)),
678
		make_number (WINDOW_BOX_RIGHT_EDGE_X (w)
679 680 681 682 683 684
			     - WINDOW_RIGHT_MARGIN_WIDTH (w)
			     - WINDOW_RIGHT_FRINGE_WIDTH (w)),
		make_number (WINDOW_BOTTOM_EDGE_Y (w)
			     - WINDOW_MODE_LINE_HEIGHT (w)));
}

685 686 687 688 689 690 691 692 693 694 695
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
696
  (Lisp_Object window)
697 698 699
{
  register struct window *w = decode_any_window (window);
  int add_x, add_y;
700
  calc_absolute_offset (w, &add_x, &add_y);
701 702 703 704 705 706 707 708 709 710 711 712 713

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

714
/* Test if the character at column X, row Y is within window W.
715
   If it is not, return ON_NOTHING;
716
   if it is in the window's text area, return ON_TEXT;
717
   if it is on the window's modeline, return ON_MODE_LINE;
Jim Blandy's avatar
Jim Blandy committed
718
   if it is on the border between the window and its right sibling,
719
      return ON_VERTICAL_BORDER.
720
   if it is on a scroll bar, return ON_SCROLL_BAR.
721
   if it is on the window's top line, return ON_HEADER_LINE;
Kim F. Storm's avatar
Kim F. Storm committed
722
   if it is in left or right fringe of the window,
723
      return ON_LEFT_FRINGE or ON_RIGHT_FRINGE;
724
   if it is in the marginal area to the left/right of the window,
725
      return ON_LEFT_MARGIN or ON_RIGHT_MARGIN.
726 727 728

   X and Y are frame relative pixel coordinates.  */

729
static enum window_part
730
coordinates_in_window (register struct window *w, int x, int y)
Jim Blandy's avatar
Jim Blandy committed
731
{
732
  struct frame *f = XFRAME (WINDOW_FRAME (w));
733
  int left_x, right_x;
734
  enum window_part part;
735 736 737
  int ux = FRAME_COLUMN_WIDTH (f);
  int x0 = WINDOW_LEFT_EDGE_X (w);
  int x1 = WINDOW_RIGHT_EDGE_X (w);
738 739 740
  /* The width of the area where the vertical line can be dragged.
     (Between mode lines for instance.  */
  int grabbable_width = ux;
741
  int lmargin_width, rmargin_width, text_left, text_right;
742 743 744 745 746 747
  int top_y = WINDOW_TOP_EDGE_Y (w);
  int bottom_y = WINDOW_BOTTOM_EDGE_Y (w);

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

749 750
  /* 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.  */
751 752 753
  if (w->pseudo_window_p)
    {
      left_x = 0;
754
      right_x = WINDOW_TOTAL_WIDTH (w) - 1;
755 756 757
    }
  else
    {
758 759
      left_x = WINDOW_BOX_LEFT_EDGE_X (w);
      right_x = WINDOW_BOX_RIGHT_EDGE_X (w) - 1;
760
    }
761

762 763 764 765 766
  /* 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.  */
767

768
  if (WINDOW_WANTS_MODELINE_P (w)
769
      && y >= bottom_y - CURRENT_MODE_LINE_HEIGHT (w))
770
    {
771 772 773
      part = ON_MODE_LINE;

    header_vertical_border_check:
774 775
      /* We're somewhere on the mode line.  We consider the place
	 between mode lines of horizontally adjacent mode lines
776
	 as the vertical border.  If scroll bars on the left,
777
	 return the right window.  */
778 779 780 781 782 783 784 785 786 787 788 789 790 791
      if ((WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
	   || WINDOW_RIGHTMOST_P (w))
	  && !WINDOW_LEFTMOST_P (w)
	  && eabs (x - x0) < grabbable_width)
	return ON_VERTICAL_BORDER;

      /* 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)  */
      else if ((WINDOW_RIGHTMOST_P (w) || x < x1)
	       && eabs (x - x1) < grabbable_width)
	return ON_VERTICAL_BORDER;

      if (x < x0 || x >= x1)
792 793
	return ON_NOTHING;

794
      return part;
795
    }
796 797

  if (WINDOW_WANTS_HEADER_LINE_P (w)
798
      && y < top_y + CURRENT_HEADER_LINE_HEIGHT (w))
799
    {
800 801
      part = ON_HEADER_LINE;
      goto header_vertical_border_check;
802
    }
803

804
  if (x < x0 || x >= x1) return ON_NOTHING;
805

806
  /* Outside any interesting column?  */
807 808
  if (x < left_x || x > right_x)
    return ON_SCROLL_BAR;
809 810 811

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

813 814 815 816
  text_left = window_box_left (w, TEXT_AREA);
  text_right = text_left + window_box_width (w, TEXT_AREA);

  if (FRAME_WINDOW_P (f))
817
    {
818
      if (!w->pseudo_window_p
819
	  && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
820
	  && !WINDOW_RIGHTMOST_P (w)
821 822
	  && (eabs (x - right_x) < grabbable_width))
	return ON_VERTICAL_BORDER;
823
    }
824 825 826 827 828 829 830 831
  /* Need to say "x > right_x" rather than >=, since on character
     terminals, the vertical line's x coordinate is right_x.  */
  else if (!w->pseudo_window_p
	   && !WINDOW_RIGHTMOST_P (w)
	   && x > right_x - ux)
    return ON_VERTICAL_BORDER;

  if (x < text_left)
832 833 834
    {
      if (lmargin_width > 0
	  && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
835 836 837 838
	      ? (x >= left_x + WINDOW_LEFT_FRINGE_WIDTH (w))
	      : (x < left_x + lmargin_width)))
	return ON_LEFT_MARGIN;

839 840 841
      return ON_LEFT_FRINGE;
    }

842
  if (x >= text_right)
843 844 845
    {
      if (rmargin_width > 0
	  && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
846 847 848 849
	      ? (x < right_x - WINDOW_RIGHT_FRINGE_WIDTH (w))
	      : (x >= right_x - rmargin_width)))
	return ON_RIGHT_MARGIN;

850 851 852 853 854
      return ON_RIGHT_FRINGE;
    }

  /* Everything special ruled out - must be on text area */
  return ON_TEXT;
Jim Blandy's avatar
Jim Blandy committed
855 856
}

857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
/* Take X is the frame-relative pixel x-coordinate, and return the
   x-coordinate relative to part PART of window W. */
int
window_relative_x_coord (struct window *w, enum window_part part, int x)
{
  int left_x = (w->pseudo_window_p) ? 0 : WINDOW_BOX_LEFT_EDGE_X (w);

  switch (part)
    {
    case ON_TEXT:
      return x - window_box_left (w, TEXT_AREA);

    case ON_LEFT_FRINGE:
      return x - left_x;

    case ON_RIGHT_FRINGE:
      return x - left_x - WINDOW_LEFT_FRINGE_WIDTH (w);

    case ON_LEFT_MARGIN:
      return (x - left_x
	      - ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
		 ? WINDOW_LEFT_FRINGE_WIDTH (w) : 0));

    case ON_RIGHT_MARGIN:
      return (x + 1
	      - ((w->pseudo_window_p)
		 ? WINDOW_TOTAL_WIDTH (w)
		 : WINDOW_BOX_RIGHT_EDGE_X (w))
	      + window_box_width (w, RIGHT_MARGIN_AREA)
	      + ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
		 ? WINDOW_RIGHT_FRINGE_WIDTH (w) : 0));
    }

  /* ON_SCROLL_BAR, ON_NOTHING, and ON_VERTICAL_BORDER:  */
  return 0;
}

894

Jim Blandy's avatar
Jim Blandy committed
895
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
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.
900
\(0 . 0) denotes the character in the upper left corner of the
901 902 903 904 905
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
906 907
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.
908
If they are on the border between WINDOW and its right sibling,
909 910 911
  `vertical-line' is returned.
If they are in the windows's left or right marginal areas, `left-margin'\n\
  or `right-margin' is returned.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
912
  (register Lisp_Object coordinates, Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
913
{
914 915
  struct window *w;
  struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
916
  int x, y;
917
  Lisp_Object lx, ly;
Jim Blandy's avatar
Jim Blandy committed
918

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

930
  switch (coordinates_in_window (w, x, y))
Jim Blandy's avatar
Jim Blandy committed
931
    {
932
    case ON_NOTHING:
Jim Blandy's avatar
Jim Blandy committed
933 934
      return Qnil;

935
    case ON_TEXT:
936 937 938 939
      /* Convert X and Y to window relative pixel coordinates, and
	 return the canonical char units.  */
      x -= window_box_left (w, TEXT_AREA);
      y -= WINDOW_TOP_EDGE_Y (w);
940 941
      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
942

943
    case ON_MODE_LINE:
Jim Blandy's avatar