indent.c 35.4 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Indentation functions.
2
   Copyright (C) 1985,86,87,88,93,94,95 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 1, or (at your option)
any later version.

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

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */


21
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
22 23 24
#include "lisp.h"
#include "buffer.h"
#include "indent.h"
Jim Blandy's avatar
Jim Blandy committed
25
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
26 27 28 29
#include "window.h"
#include "termchar.h"
#include "termopts.h"
#include "disptab.h"
30
#include "intervals.h"
31
#include "region-cache.h"
Jim Blandy's avatar
Jim Blandy committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

/* Indentation can insert tabs if this is non-zero;
   otherwise always uses spaces */
int indent_tabs_mode;

#define min(a, b) ((a) < (b) ? (a) : (b))
#define max(a, b) ((a) > (b) ? (a) : (b))

#define CR 015

/* These three values memoize the current column to avoid recalculation */
/* Some things in set last_known_column_point to -1
  to mark the memoized value as invalid */
/* Last value returned by current_column */
int last_known_column;
/* Value of point when current_column was called */
int last_known_column_point;
/* Value of MODIFF when current_column was called */
int last_known_column_modified;

/* Get the display table to use for the current buffer.  */

struct Lisp_Vector *
buffer_display_table ()
{
  Lisp_Object thisbuf;

  thisbuf = current_buffer->display_table;
60
  if (VECTORP (thisbuf) && XVECTOR (thisbuf)->size == DISP_TABLE_SIZE)
Jim Blandy's avatar
Jim Blandy committed
61
    return XVECTOR (thisbuf);
62
  if (VECTORP (Vstandard_display_table)
Jim Blandy's avatar
Jim Blandy committed
63 64 65 66
      && XVECTOR (Vstandard_display_table)->size == DISP_TABLE_SIZE)
    return XVECTOR (Vstandard_display_table);
  return 0;
}
67 68 69 70

/* Width run cache considerations.  */

/* Return the width of character C under display table DP.  */
71

72 73 74 75 76 77 78 79 80 81
static int
character_width (c, dp)
     int c;
     struct Lisp_Vector *dp;
{
  Lisp_Object elt;

  /* These width computations were determined by examining the cases
     in display_text_line.  */

82
  /* Everything can be handled by the display table, if it's
83
     present and the element is right.  */
84
  if (dp && (elt = DISP_CHAR_VECTOR (dp, c), VECTORP (elt)))
85 86
    return XVECTOR (elt)->size;

87 88 89 90 91
  /* Some characters are special.  */
  if (c == '\n' || c == '\t' || c == '\015')
    return 0;

  /* Printing characters have width 1.  */
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
  else if (c >= 040 && c < 0177)
    return 1;

  /* Everybody else (control characters, metacharacters) has other
     widths.  We could return their actual widths here, but they
     depend on things like ctl_arrow and crud like that, and they're
     not very common at all.  So we'll just claim we don't know their
     widths.  */
  else
    return 0;
}

/* Return true iff the display table DISPTAB specifies the same widths
   for characters as WIDTHTAB.  We use this to decide when to
   invalidate the buffer's width_run_cache.  */
int
disptab_matches_widthtab (disptab, widthtab)
     struct Lisp_Vector *disptab;
     struct Lisp_Vector *widthtab;
{
  int i;

  if (widthtab->size != 256)
    abort ();

  for (i = 0; i < 256; i++)
    if (character_width (i, disptab)
        != XFASTINT (widthtab->contents[i]))
      return 0;

  return 1;
123
}
124 125 126 127 128 129 130 131

/* Recompute BUF's width table, using the display table DISPTAB.  */
void
recompute_width_table (buf, disptab)
     struct buffer *buf;
     struct Lisp_Vector *disptab;
{
  int i;
132
  struct Lisp_Vector *widthtab;
133

134 135 136
  if (!VECTORP (buf->width_table))
    buf->width_table = Fmake_vector (make_number (256), make_number (0));
  widthtab = XVECTOR (buf->width_table);
137 138 139 140
  if (widthtab->size != 256)
    abort ();

  for (i = 0; i < 256; i++)
141
    XSETFASTINT (widthtab->contents[i], character_width (i, disptab));
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
}

/* Allocate or free the width run cache, as requested by the current
   state of current_buffer's cache_long_line_scans variable.  */
static void
width_run_cache_on_off ()
{
  if (NILP (current_buffer->cache_long_line_scans))
    {
      /* It should be off.  */
      if (current_buffer->width_run_cache)
        {
          free_region_cache (current_buffer->width_run_cache);
          current_buffer->width_run_cache = 0;
          current_buffer->width_table = Qnil;
        }
    }
  else
    {
      /* It should be on.  */
      if (current_buffer->width_run_cache == 0)
163
        {
164 165 166 167 168 169
          current_buffer->width_run_cache = new_region_cache ();
          recompute_width_table (current_buffer, buffer_display_table ());
        }
    }
}

Jim Blandy's avatar
Jim Blandy committed
170 171 172 173 174 175 176

DEFUN ("current-column", Fcurrent_column, Scurrent_column, 0, 0, 0,
  "Return the horizontal position of point.  Beginning of line is column 0.\n\
This is calculated by adding together the widths of all the displayed\n\
representations of the character between the start of the previous line\n\
and point.  (eg control characters will have a width of 2 or 4, tabs\n\
will have a variable width)\n\
Jim Blandy's avatar
Jim Blandy committed
177 178
Ignores finite width of frame, which means that this function may return\n\
values greater than (frame-width).\n\
Jim Blandy's avatar
Jim Blandy committed
179 180 181 182 183
Whether the line is visible (if `selective-display' is t) has no effect;\n\
however, ^M is treated as end of line when `selective-display' is t.")
  ()
{
  Lisp_Object temp;
184
  XSETFASTINT (temp, current_column ());
Jim Blandy's avatar
Jim Blandy committed
185 186 187
  return temp;
}

Jim Blandy's avatar
Jim Blandy committed
188 189 190 191 192 193 194
/* Cancel any recorded value of the horizontal position.  */

invalidate_current_column ()
{
  last_known_column_point = 0;
}

Jim Blandy's avatar
Jim Blandy committed
195 196 197 198 199 200 201 202 203
int
current_column ()
{
  register int col;
  register unsigned char *ptr, *stop;
  register int tab_seen;
  int post_tab;
  register int c;
  register int tab_width = XINT (current_buffer->tab_width);
Jim Blandy's avatar
Jim Blandy committed
204
  int ctl_arrow = !NILP (current_buffer->ctl_arrow);
Jim Blandy's avatar
Jim Blandy committed
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
  register struct Lisp_Vector *dp = buffer_display_table ();
  int stopchar;

  if (point == last_known_column_point
      && MODIFF == last_known_column_modified)
    return last_known_column;

  /* Make a pointer for decrementing through the chars before point.  */
  ptr = &FETCH_CHAR (point - 1) + 1;
  /* Make a pointer to where consecutive chars leave off,
     going backwards from point.  */
  if (point == BEGV)
    stop = ptr;
  else if (point <= GPT || BEGV > GPT)
    stop = BEGV_ADDR;
  else
    stop = GAP_END_ADDR;

223
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242

  col = 0, tab_seen = 0, post_tab = 0;

  while (1)
    {
      if (ptr == stop)
	{
	  /* We stopped either for the beginning of the buffer
	     or for the gap.  */
	  if (ptr == BEGV_ADDR)
	    break;
	  /* It was the gap.  Jump back over it.  */
	  stop = BEGV_ADDR;
	  ptr = GPT_ADDR;
	  /* Check whether that brings us to beginning of buffer.  */
	  if (BEGV >= GPT) break;
	}

      c = *--ptr;
243 244 245 246
      if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c)))
	col += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
      else if (c >= 040 && c < 0177)
	col++;
Jim Blandy's avatar
Jim Blandy committed
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
      else if (c == '\n')
	break;
      else if (c == '\r' && EQ (current_buffer->selective_display, Qt))
	break;
      else if (c == '\t')
	{
	  if (tab_seen)
	    col = ((col + tab_width) / tab_width) * tab_width;

	  post_tab += col;
	  col = 0;
	  tab_seen = 1;
	}
      else
	col += (ctl_arrow && c < 0200) ? 2 : 4;
    }

  if (tab_seen)
    {
      col = ((col + tab_width) / tab_width) * tab_width;
      col += post_tab;
    }

  last_known_column = col;
  last_known_column_point = point;
  last_known_column_modified = MODIFF;

  return col;
}

DEFUN ("indent-to", Findent_to, Sindent_to, 1, 2, "NIndent to column: ",
  "Indent from point with tabs and spaces until COLUMN is reached.\n\
Optional second argument MIN says always do at least MIN spaces\n\
even if that goes past COLUMN; by default, MIN is zero.")
  (col, minimum)
     Lisp_Object col, minimum;
{
  int mincol;
  register int fromcol;
  register int tab_width = XINT (current_buffer->tab_width);

  CHECK_NUMBER (col, 0);
Jim Blandy's avatar
Jim Blandy committed
289
  if (NILP (minimum))
290
    XSETFASTINT (minimum, 0);
Jim Blandy's avatar
Jim Blandy committed
291 292 293 294 295 296 297 298 299
  CHECK_NUMBER (minimum, 1);

  fromcol = current_column ();
  mincol = fromcol + XINT (minimum);
  if (mincol < XINT (col)) mincol = XINT (col);

  if (fromcol == mincol)
    return make_number (mincol);

300
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
301 302 303 304

  if (indent_tabs_mode)
    {
      Lisp_Object n;
305
      XSETFASTINT (n, mincol / tab_width - fromcol / tab_width);
Jim Blandy's avatar
Jim Blandy committed
306 307
      if (XFASTINT (n) != 0)
	{
308
	  Finsert_char (make_number ('\t'), n, Qt);
Jim Blandy's avatar
Jim Blandy committed
309 310 311 312 313

	  fromcol = (mincol / tab_width) * tab_width;
	}
    }

314
  XSETFASTINT (col, mincol - fromcol);
315
  Finsert_char (make_number (' '), col, Qt);
Jim Blandy's avatar
Jim Blandy committed
316 317 318 319 320 321 322 323

  last_known_column = mincol;
  last_known_column_point = point;
  last_known_column_modified = MODIFF;

  XSETINT (col, mincol);
  return col;
}
324

Jim Blandy's avatar
Jim Blandy committed
325 326 327 328 329 330 331 332 333 334

DEFUN ("current-indentation", Fcurrent_indentation, Scurrent_indentation,
  0, 0, 0,
  "Return the indentation of the current line.\n\
This is the horizontal position of the character\n\
following any initial whitespace.")
  ()
{
  Lisp_Object val;

335
  XSETFASTINT (val, position_indentation (find_next_newline (point, -1)));
Jim Blandy's avatar
Jim Blandy committed
336 337 338 339 340 341 342 343 344 345
  return val;
}

position_indentation (pos)
     register int pos;
{
  register int column = 0;
  register int tab_width = XINT (current_buffer->tab_width);
  register unsigned char *p;
  register unsigned char *stop;
346

347
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
348

Jim Blandy's avatar
Jim Blandy committed
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
  stop = &FETCH_CHAR (BUFFER_CEILING_OF (pos)) + 1;
  p = &FETCH_CHAR (pos);
  while (1)
    {
      while (p == stop)
	{
	  if (pos == ZV)
	    return column;
	  pos += p - &FETCH_CHAR (pos);
	  p = &FETCH_CHAR (pos);
	  stop = &FETCH_CHAR (BUFFER_CEILING_OF (pos)) + 1;
	}
      switch (*p++)
	{
	case ' ':
	  column++;
	  break;
	case '\t':
	  column += tab_width - column % tab_width;
	  break;
	default:
	  return column;
	}
    }
}
374 375 376 377 378 379 380 381 382

/* Test whether the line beginning at POS is indented beyond COLUMN.
   Blank lines are treated as if they had the same indentation as the
   preceding line.  */
int
indented_beyond_p (pos, column)
     int pos, column;
{
  while (pos > BEGV && FETCH_CHAR (pos) == '\n')
383
    pos = find_next_newline_no_quit (pos - 1, -1);
384 385
  return (position_indentation (pos) >= column);
}
386

Jim Blandy's avatar
Jim Blandy committed
387 388 389 390 391 392 393

DEFUN ("move-to-column", Fmove_to_column, Smove_to_column, 1, 2, 0,
  "Move point to column COLUMN in the current line.\n\
The column of a character is calculated by adding together the widths\n\
as displayed of the previous characters in the line.\n\
This function ignores line-continuation;\n\
there is no upper limit on the column number a character can have\n\
394 395
and horizontal scrolling has no effect.\n\
\n\
Jim Blandy's avatar
Jim Blandy committed
396 397 398 399 400 401 402 403 404 405 406 407 408
If specified column is within a character, point goes after that character.\n\
If it's past end of line, point goes to end of line.\n\n\
A non-nil second (optional) argument FORCE means, if the line\n\
is too short to reach column COLUMN then add spaces/tabs to get there,\n\
and if COLUMN is in the middle of a tab character, change it to spaces.")
  (column, force)
     Lisp_Object column, force;
{
  register int pos;
  register int col = current_column ();
  register int goal;
  register int end;
  register int tab_width = XINT (current_buffer->tab_width);
Jim Blandy's avatar
Jim Blandy committed
409
  register int ctl_arrow = !NILP (current_buffer->ctl_arrow);
Jim Blandy's avatar
Jim Blandy committed
410 411 412 413 414 415
  register struct Lisp_Vector *dp = buffer_display_table ();

  Lisp_Object val;
  int prev_col;
  int c;

416
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
  CHECK_NATNUM (column, 0);
  goal = XINT (column);

 retry:
  pos = point;
  end = ZV;

  /* If we're starting past the desired column,
     back up to beginning of line and scan from there.  */
  if (col > goal)
    {
      pos = find_next_newline (pos, -1);
      col = 0;
    }

  while (col < goal && pos < end)
    {
      c = FETCH_CHAR (pos);
435 436 437 438 439 440
      if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c)))
	{
	  col += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
	  pos++;
	  break;
	}
Jim Blandy's avatar
Jim Blandy committed
441 442 443 444 445 446 447 448 449 450 451 452
      if (c == '\n')
	break;
      if (c == '\r' && EQ (current_buffer->selective_display, Qt))
	break;
      pos++;
      if (c == '\t')
	{
	  prev_col = col;
	  col += tab_width;
	  col = col / tab_width * tab_width;
	}
      else if (ctl_arrow && (c < 040 || c == 0177))
453
        col += 2;
Jim Blandy's avatar
Jim Blandy committed
454
      else if (c < 040 || c >= 0177)
455
        col += 4;
Jim Blandy's avatar
Jim Blandy committed
456 457 458 459 460 461 462 463
      else
	col++;
    }

  SET_PT (pos);

  /* If a tab char made us overshoot, change it to spaces
     and scan through it again.  */
Jim Blandy's avatar
Jim Blandy committed
464
  if (!NILP (force) && col > goal && c == '\t' && prev_col < goal)
Jim Blandy's avatar
Jim Blandy committed
465
    {
Jim Blandy's avatar
Jim Blandy committed
466 467
      int old_point;

Jim Blandy's avatar
Jim Blandy committed
468
      del_range (point - 1, point);
Jim Blandy's avatar
Jim Blandy committed
469 470 471 472
      Findent_to (make_number (goal), Qnil);
      old_point = point;
      Findent_to (make_number (col), Qnil);
      SET_PT (old_point);
473 474
      /* Set the last_known... vars consistently.  */
      col = goal;
Jim Blandy's avatar
Jim Blandy committed
475 476 477
    }

  /* If line ends prematurely, add space to the end.  */
Jim Blandy's avatar
Jim Blandy committed
478
  if (col < goal && !NILP (force))
479
    Findent_to (make_number (col = goal), Qnil);
Jim Blandy's avatar
Jim Blandy committed
480 481 482 483 484

  last_known_column = col;
  last_known_column_point = point;
  last_known_column_modified = MODIFF;

485
  XSETFASTINT (val, col);
Jim Blandy's avatar
Jim Blandy committed
486 487
  return val;
}
488

Jim Blandy's avatar
Jim Blandy committed
489

490 491
/* compute_motion: compute buffer posn given screen posn and vice versa */

Jim Blandy's avatar
Jim Blandy committed
492 493 494 495 496
struct position val_compute_motion;

/* Scan the current buffer forward from offset FROM, pretending that
   this is at line FROMVPOS, column FROMHPOS, until reaching buffer
   offset TO or line TOVPOS, column TOHPOS (whichever comes first),
497 498 499
   and return the ending buffer position and screen location.  If we
   can't hit the requested column exactly (because of a tab or other
   multi-column character), overshoot.
Jim Blandy's avatar
Jim Blandy committed
500 501 502 503 504

   WIDTH is the number of columns available to display text;
   compute_motion uses this to handle continuation lines and such.
   HSCROLL is the number of columns not being displayed at the left
   margin; this is usually taken from a window's hscroll member.
Jim Blandy's avatar
Jim Blandy committed
505 506 507
   TAB_OFFSET is the number of columns of the first tab that aren't
   being displayed, perhaps because of a continuation line or
   something.
Jim Blandy's avatar
Jim Blandy committed
508 509 510

   compute_motion returns a pointer to a struct position.  The bufpos
   member gives the buffer position at the end of the scan, and hpos
511 512 513 514 515 516 517 518
   and vpos give its cartesian location.  prevhpos is the column at
   which the character before bufpos started, and contin is non-zero
   if we reached the current line by continuing the previous.

   Note that FROMHPOS and TOHPOS should be expressed in real screen
   columns, taking HSCROLL and the truncation glyph at the left margin
   into account.  That is, beginning-of-line moves you to the hpos
   -HSCROLL + (HSCROLL > 0).
Jim Blandy's avatar
Jim Blandy committed
519

Karl Heuer's avatar
Karl Heuer committed
520 521 522 523 524
   Note that FROMHPOS and TOHPOS should be expressed in real screen
   columns, taking HSCROLL and the truncation glyph at the left margin
   into account.  That is, beginning-of-line moves you to the hpos
   -HSCROLL + (HSCROLL > 0).

Jim Blandy's avatar
Jim Blandy committed
525 526 527 528 529
   For example, to find the buffer position of column COL of line LINE
   of a certain window, pass the window's starting location as FROM
   and the window's upper-left coordinates as FROMVPOS and FROMHPOS.
   Pass the buffer's ZV as TO, to limit the scan to the end of the
   visible section of the buffer, and pass LINE and COL as TOVPOS and
530
   TOHPOS.
Jim Blandy's avatar
Jim Blandy committed
531 532 533 534

   When displaying in window w, a typical formula for WIDTH is:

	window_width - 1
535
	 - (has_vertical_scroll_bars
Karl Heuer's avatar
Karl Heuer committed
536
	    ? FRAME_SCROLL_BAR_COLS (XFRAME (window->frame))
537
	    : (window_width + window_left != frame_width))
Jim Blandy's avatar
Jim Blandy committed
538 539 540 541

	where
	  window_width is XFASTINT (w->width),
	  window_left is XFASTINT (w->left),
542 543
	  has_vertical_scroll_bars is
	    FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (WINDOW_FRAME (window)))
544
	  and frame_width = FRAME_WIDTH (XFRAME (window->frame))
Jim Blandy's avatar
Jim Blandy committed
545

Karl Heuer's avatar
Karl Heuer committed
546 547
   Or you can let window_internal_width do this all for you, and write:
	window_internal_width (w) - 1
548 549

   The `-1' accounts for the continuation-line backslashes; the rest
Karl Heuer's avatar
Karl Heuer committed
550
   accounts for window borders if the window is split horizontally, and
Karl Heuer's avatar
Karl Heuer committed
551
   the scroll bars if they are turned on.  */
Jim Blandy's avatar
Jim Blandy committed
552 553

struct position *
554
compute_motion (from, fromvpos, fromhpos, to, tovpos, tohpos, width, hscroll, tab_offset, win)
Jim Blandy's avatar
Jim Blandy committed
555 556 557
     int from, fromvpos, fromhpos, to, tovpos, tohpos;
     register int width;
     int hscroll, tab_offset;
558
     struct window *win;
Jim Blandy's avatar
Jim Blandy committed
559
{
Jim Blandy's avatar
Jim Blandy committed
560 561 562
  register int hpos = fromhpos;
  register int vpos = fromvpos;

Jim Blandy's avatar
Jim Blandy committed
563 564 565
  register int pos;
  register int c;
  register int tab_width = XFASTINT (current_buffer->tab_width);
Jim Blandy's avatar
Jim Blandy committed
566
  register int ctl_arrow = !NILP (current_buffer->ctl_arrow);
567
  register struct Lisp_Vector *dp = window_display_table (win);
Jim Blandy's avatar
Jim Blandy committed
568
  int selective
569
    = (INTEGERP (current_buffer->selective_display)
570 571
       ? XINT (current_buffer->selective_display)
       : !NILP (current_buffer->selective_display) ? -1 : 0);
572
  int prev_vpos = vpos, prev_hpos = 0;
Jim Blandy's avatar
Jim Blandy committed
573
  int selective_rlen
574
    = (selective && dp && VECTORP (DISP_INVIS_VECTOR (dp))
575
       ? XVECTOR (DISP_INVIS_VECTOR (dp))->size : 0);
576 577 578 579 580
#ifdef USE_TEXT_PROPERTIES
  /* The next location where the `invisible' property changes */
  int next_invisible = from;
  Lisp_Object prop, position;
#endif
Jim Blandy's avatar
Jim Blandy committed
581

582 583
  /* For computing runs of characters with similar widths.
     Invariant: width_run_width is zero, or all the characters
584
     from width_run_start to width_run_end have a fixed width of
585 586 587 588 589
     width_run_width.  */
  int width_run_start = from;
  int width_run_end   = from;
  int width_run_width = 0;
  Lisp_Object *width_table;
590
  Lisp_Object buffer;
591 592 593 594

  /* The next buffer pos where we should consult the width run cache. */
  int next_width_run = from;

595 596
  XSETBUFFER (buffer, current_buffer);

597 598 599 600 601 602 603 604 605 606
  width_run_cache_on_off ();
  if (dp == buffer_display_table ())
    width_table = (VECTORP (current_buffer->width_table)
                   ? XVECTOR (current_buffer->width_table)->contents
                   : 0);
  else
    /* If the window has its own display table, we can't use the width
       run cache, because that's based on the buffer's display table.  */
    width_table = 0;

607
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
608
  for (pos = from; pos < to; )
Jim Blandy's avatar
Jim Blandy committed
609
    {
Jim Blandy's avatar
Jim Blandy committed
610 611 612 613 614 615 616 617
      /* Stop if past the target screen position.  */
      if (vpos > tovpos
	  || (vpos == tovpos && hpos >= tohpos))
	break;

      prev_vpos = vpos;
      prev_hpos = hpos;

618 619 620 621
#ifdef USE_TEXT_PROPERTIES
      /* if the `invisible' property is set, we can skip to
	 the next property change */
      while (pos == next_invisible && pos < to)
622
	{
623
	  XSETFASTINT (position, pos);
624 625 626 627

	  /* Give faster response for overlay lookup near POS.  */
	  recenter_overlay_lists (current_buffer, pos);

628
	  prop = Fget_char_property (position,
629 630 631
				     Qinvisible,
				     Fcurrent_buffer ());
	  {
632
	    Lisp_Object end, limit, proplimit;
633

634 635 636
	    /* We must not advance farther than the next overlay change.
	       The overlay change might change the invisible property;
	       we have no way of telling.  */
637
	    limit = Fnext_overlay_change (position);
638 639
	    /* As for text properties, this gives a lower bound
	       for where the invisible text property could change.  */
640
	    proplimit = Fnext_property_change (position, buffer, Qt);
641 642 643
	    if (XFASTINT (limit) < XFASTINT (proplimit))
	      proplimit = limit;
	    /* PROPLIMIT is now a lower bound for the next change
644 645
	       in invisible status.  If that is plenty far away,
	       use that lower bound.  */
646 647
	    if (XFASTINT (proplimit) > pos + 100 || XFASTINT (proplimit) >= to)
	      next_invisible = XINT (proplimit);
648
	    /* Otherwise, scan for the next `invisible' property change.  */
649
	    else
650 651
	      {
		/* Don't scan terribly far.  */
652 653 654 655
		XSETFASTINT (proplimit, min (pos + 100, to));
		/* No matter what. don't go past next overlay change.  */
		if (XFASTINT (limit) < XFASTINT (proplimit))
		  proplimit = limit;
656
		end = Fnext_single_property_change (position, Qinvisible,
657
						    buffer, proplimit);
658 659 660 661 662 663
		if (INTEGERP (end) && XINT (end) < to)
		  next_invisible = XINT (end);
		else
		  next_invisible = to;
	      }
	    if (TEXT_PROP_MEANS_INVISIBLE (prop))
664 665 666
	      pos = next_invisible;
	  }
	}
667 668 669
      if (pos >= to)
	break;
#endif
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701

      /* Consult the width run cache to see if we can avoid inspecting
         the text character-by-character.  */
      if (current_buffer->width_run_cache && pos >= next_width_run)
        {
          int run_end;
          int common_width
            = region_cache_forward (current_buffer,
                                    current_buffer->width_run_cache,
                                    pos, &run_end);

          /* A width of zero means the character's width varies (like
             a tab), is meaningless (like a newline), or we just don't
             want to skip over it for some other reason.  */
          if (common_width != 0)
            {
              int run_end_hpos;

              /* Don't go past the final buffer posn the user
                 requested.  */
              if (run_end > to)
                run_end = to;

              run_end_hpos = hpos + (run_end - pos) * common_width;

              /* Don't go past the final horizontal position the user
                 requested.  */
              if (vpos == tovpos && run_end_hpos > tohpos)
                {
                  run_end      = pos + (tohpos - hpos) / common_width;
                  run_end_hpos = hpos + (run_end - pos) * common_width;
                }
702

703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
              /* Don't go past the margin.  */
              if (run_end_hpos >= width)
                {
                  run_end      = pos + (width  - hpos) / common_width;
                  run_end_hpos = hpos + (run_end - pos) * common_width;
                }

              hpos = run_end_hpos;
              if (run_end > pos)
                prev_hpos = hpos - common_width;
              pos = run_end;
            }

          next_width_run = run_end + 1;
        }

      /* We have to scan the text character-by-character.  */
Jim Blandy's avatar
Jim Blandy committed
720
      else
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
        {
          c = FETCH_CHAR (pos);
          pos++;

          /* Perhaps add some info to the width_run_cache.  */
          if (current_buffer->width_run_cache)
            {
              /* Is this character part of the current run?  If so, extend
                 the run.  */
              if (pos - 1 == width_run_end
                  && width_table[c] == width_run_width)
                width_run_end = pos;

              /* The previous run is over, since this is a character at a
                 different position, or a different width.  */
              else
                {
                  /* Have we accumulated a run to put in the cache?
739
                     (Currently, we only cache runs of width == 1).  */
740 741 742 743 744
                  if (width_run_start < width_run_end
                      && width_run_width == 1)
                    know_region_cache (current_buffer,
                                       current_buffer->width_run_cache,
                                       width_run_start, width_run_end);
745

746 747 748 749 750 751 752
                  /* Start recording a new width run.  */
                  width_run_width = width_table[c];
                  width_run_start = pos - 1;
                  width_run_end = pos;
                }
            }

753 754 755
          if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c)))
            hpos += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
          else if (c >= 040 && c < 0177)
756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
            hpos++;
          else if (c == '\t')
            {
              hpos += tab_width - ((hpos + tab_offset + hscroll - (hscroll > 0)
                                    /* Add tab_width here to make sure
                                       positive.  hpos can be negative
                                       after continuation but can't be
                                       less than -tab_width.  */
                                    + tab_width)
                                   % tab_width);
            }
          else if (c == '\n')
            {
              if (selective > 0 && indented_beyond_p (pos, selective))
                {
                  /* Skip any number of invisible lines all at once */
                  do
773
                    pos = find_before_next_newline (pos, to, 1) + 1;
774 775 776 777 778 779 780 781 782
                  while (pos < to
                         && indented_beyond_p (pos, selective));
                  /* Allow for the " ..." that is displayed for them. */
                  if (selective_rlen)
                    {
                      hpos += selective_rlen;
                      if (hpos >= width)
                        hpos = width;
                    }
783
		  --pos;
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
                  /* We have skipped the invis text, but not the
                     newline after.  */
                }
              else
                {
                  /* A visible line.  */
                  vpos++;
                  hpos = 0;
                  hpos -= hscroll;
                  /* Count the truncation glyph on column 0 */
                  if (hscroll > 0)
                    hpos++;
                  tab_offset = 0;
                }
            }
          else if (c == CR && selective < 0)
            {
              /* In selective display mode,
                 everything from a ^M to the end of the line is invisible.
                 Stop *before* the real newline.  */
              pos = find_before_next_newline (pos, to, 1);
              /* Allow for the " ..." that is displayed for them. */
              if (selective_rlen)
                {
                  hpos += selective_rlen;
                  if (hpos >= width)
                    hpos = width;
                }
            }
          else
            hpos += (ctl_arrow && c < 0200) ? 2 : 4;
        }
Jim Blandy's avatar
Jim Blandy committed
816

Jim Blandy's avatar
Jim Blandy committed
817 818 819
      /* Handle right margin.  */
      if (hpos >= width
	  && (hpos > width
820 821
	      || (pos < ZV
		  && FETCH_CHAR (pos) != '\n')))
Jim Blandy's avatar
Jim Blandy committed
822
	{
Jim Blandy's avatar
Jim Blandy committed
823 824
	  if (vpos > tovpos
	      || (vpos == tovpos && hpos >= tohpos))
Jim Blandy's avatar
Jim Blandy committed
825 826 827
	    break;
	  if (hscroll
	      || (truncate_partial_width_windows
828
		  && width + 1 < FRAME_WIDTH (XFRAME (WINDOW_FRAME (win))))
Jim Blandy's avatar
Jim Blandy committed
829
	      || !NILP (current_buffer->truncate_lines))
Jim Blandy's avatar
Jim Blandy committed
830
	    {
Jim Blandy's avatar
Jim Blandy committed
831
	      /* Truncating: skip to newline.  */
832
              pos = find_before_next_newline (pos, to, 1);
833
	      hpos = width;
Jim Blandy's avatar
Jim Blandy committed
834 835 836
	    }
	  else
	    {
Jim Blandy's avatar
Jim Blandy committed
837 838 839
	      /* Continuing.  */
	      vpos++;
	      hpos -= width;
Jim Blandy's avatar
Jim Blandy committed
840 841 842 843 844 845
	      tab_offset += width;
	    }

	}
    }

846 847 848 849 850 851 852
  /* Remember any final width run in the cache.  */
  if (current_buffer->width_run_cache
      && width_run_width == 1
      && width_run_start < width_run_end)
    know_region_cache (current_buffer, current_buffer->width_run_cache,
                       width_run_start, width_run_end);

Jim Blandy's avatar
Jim Blandy committed
853
  val_compute_motion.bufpos = pos;
Jim Blandy's avatar
Jim Blandy committed
854 855 856
  val_compute_motion.hpos = hpos;
  val_compute_motion.vpos = vpos;
  val_compute_motion.prevhpos = prev_hpos;
Jim Blandy's avatar
Jim Blandy committed
857 858 859

  /* Nonzero if have just continued a line */
  val_compute_motion.contin
Jim Blandy's avatar
Jim Blandy committed
860 861 862
    = (pos != from
       && (val_compute_motion.vpos != prev_vpos)
       && c != '\n');
Jim Blandy's avatar
Jim Blandy committed
863 864 865 866

  return &val_compute_motion;
}

Karl Heuer's avatar
Karl Heuer committed
867 868
#if 0 /* The doc string is too long for some compilers,
	 but make-docfile can find it in this comment.  */
869
DEFUN ("compute-motion", Ffoo, Sfoo, 7, 7, 0,
870 871 872 873 874 875
  "Scan through the current buffer, calculating screen position.\n\
Scan the current buffer forward from offset FROM,\n\
assuming it is at position FROMPOS--a cons of the form (HPOS . VPOS)--\n\
to position TO or position TOPOS--another cons of the form (HPOS . VPOS)--\n\
and return the ending buffer position and screen location.\n\
\n\
876
There are three additional arguments:\n\
877 878 879
\n\
WIDTH is the number of columns available to display text;\n\
this affects handling of continuation lines.\n\
Karl Heuer's avatar
Karl Heuer committed
880 881
This is usually the value returned by `window-width', less one (to allow\n\
for the continuation glyph).\n\
882 883 884 885 886 887
\n\
OFFSETS is either nil or a cons cell (HSCROLL . TAB-OFFSET).\n\
HSCROLL is the number of columns not being displayed at the left\n\
margin; this is usually taken from a window's hscroll member.\n\
TAB-OFFSET is the number of columns of the first tab that aren't\n\
being displayed, perhaps because the line was continued within it.\n\
Karl Heuer's avatar
Karl Heuer committed
888
If OFFSETS is nil, HSCROLL and TAB-OFFSET are assumed to be zero.\n\
889
\n\
890
WINDOW is the window to operate on.  Currently this is used only to\n\
891 892
find the display table.  It does not matter what buffer WINDOW displays;\n\
`compute-motion' always operates on the current buffer.\n\
893 894
\n\
The value is a list of five elements:\n\
895
  (POS HPOS VPOS PREVHPOS CONTIN)\n\
896 897 898 899 900 901 902 903 904 905 906 907
POS is the buffer position where the scan stopped.\n\
VPOS is the vertical position where the scan stopped.\n\
HPOS is the horizontal position where the scan stopped.\n\
\n\
PREVHPOS is the horizontal position one character back from POS.\n\
CONTIN is t if a line was continued after (or within) the previous character.\n\
\n\
For example, to find the buffer position of column COL of line LINE\n\
of a certain window, pass the window's starting location as FROM\n\
and the window's upper-left coordinates as FROMPOS.\n\
Pass the buffer's (point-max) as TO, to limit the scan to the end of the\n\
visible section of the buffer, and pass LINE and COL as TOPOS.")
908
  (from, frompos, to, topos, width, offsets, window)
Karl Heuer's avatar
Karl Heuer committed
909 910
#endif

911
DEFUN ("compute-motion", Fcompute_motion, Scompute_motion, 7, 7, 0,
Karl Heuer's avatar
Karl Heuer committed
912
  0)
913
  (from, frompos, to, topos, width, offsets, window)
914
     Lisp_Object from, frompos, to, topos;
915
     Lisp_Object width, offsets, window;
916 917 918 919 920
{
  Lisp_Object bufpos, hpos, vpos, prevhpos, contin;
  struct position *pos;
  int hscroll, tab_offset;

Karl Heuer's avatar
Karl Heuer committed
921
  CHECK_NUMBER_COERCE_MARKER (from, 0);
922
  CHECK_CONS (frompos, 0);
Karl Heuer's avatar
Karl Heuer committed
923 924 925
  CHECK_NUMBER (XCONS (frompos)->car, 0);
  CHECK_NUMBER (XCONS (frompos)->cdr, 0);
  CHECK_NUMBER_COERCE_MARKER (to, 0);
926
  CHECK_CONS (topos, 0);
Karl Heuer's avatar
Karl Heuer committed
927 928 929
  CHECK_NUMBER (XCONS (topos)->car, 0);
  CHECK_NUMBER (XCONS (topos)->cdr, 0);
  CHECK_NUMBER (width, 0);
930 931 932
  if (!NILP (offsets))
    {
      CHECK_CONS (offsets, 0);
Karl Heuer's avatar
Karl Heuer committed
933 934
      CHECK_NUMBER (XCONS (offsets)->car, 0);
      CHECK_NUMBER (XCONS (offsets)->cdr, 0);
935 936 937 938 939 940
      hscroll = XINT (XCONS (offsets)->car);
      tab_offset = XINT (XCONS (offsets)->cdr);
    }
  else
    hscroll = tab_offset = 0;

941 942 943 944 945
  if (NILP (window))
    window = Fselected_window ();
  else
    CHECK_LIVE_WINDOW (window, 0);

946 947 948 949
  pos = compute_motion (XINT (from), XINT (XCONS (frompos)->cdr),
			XINT (XCONS (frompos)->car),
			XINT (to), XINT (XCONS (topos)->cdr),
			XINT (XCONS (topos)->car),
950 951
			XINT (width), hscroll, tab_offset,
			XWINDOW (window));
952

953
  XSETFASTINT (bufpos, pos->bufpos);
954 955 956
  XSETINT (hpos, pos->hpos);
  XSETINT (vpos, pos->vpos);
  XSETINT (prevhpos, pos->prevhpos);
957 958 959 960 961 962 963 964

  return Fcons (bufpos,
		Fcons (hpos,
		       Fcons (vpos,
			      Fcons (prevhpos,
				     Fcons (pos->contin ? Qt : Qnil, Qnil)))));

}
Jim Blandy's avatar
Jim Blandy committed
965

966 967
/* Return the column of position POS in window W's buffer.
   The result is rounded down to a multiple of the internal width of W.
Jim Blandy's avatar
Jim Blandy committed
968 969 970 971 972 973 974 975
   This is the amount of indentation of position POS
   that is not visible in its horizontal position in the window.  */

int
pos_tab_offset (w, pos)
     struct window *w;
     register int pos;
{
976
  int opoint = PT;
Jim Blandy's avatar
Jim Blandy committed
977
  int col;
978
  int width = window_internal_width (w) - 1;
Jim Blandy's avatar
Jim Blandy committed
979 980 981

  if (pos == BEGV || FETCH_CHAR (pos - 1) == '\n')
    return 0;
982
  TEMP_SET_PT (pos);
Jim Blandy's avatar
Jim Blandy committed
983
  col = current_column ();
984
  TEMP_SET_PT (opoint);
Jim Blandy's avatar
Jim Blandy committed
985 986 987
  return col - (col % width);
}

988 989

/* Fvertical_motion and vmotion */
Jim Blandy's avatar
Jim Blandy committed
990 991 992 993 994 995 996 997 998 999 1000
struct position val_vmotion;

struct position *
vmotion (from, vtarget, width, hscroll, window)
     register int from, vtarget, width;
     int hscroll;
     Lisp_Object window;
{
  struct position pos;
  /* vpos is cumulative vertical position, changed as from is changed */
  register int vpos = 0;
1001
  Lisp_Object prevline;
Jim Blandy's avatar
Jim Blandy committed
1002 1003 1004
  register int first;
  int lmargin = hscroll > 0 ? 1 - hscroll : 0;
  int selective
1005 1006 1007
    = (INTEGERP (current_buffer->selective_display)
       ? XINT (current_buffer->selective_display)
       : !NILP (current_buffer->selective_display) ? -1 : 0);
1008 1009 1010 1011 1012
  /* The omission of the clause
         && marker_position (XWINDOW (window)->start) == BEG
     here is deliberate; I think we want to measure from the prompt
     position even if the minibuffer window has scrolled.  */
  int start_hpos = (EQ (window, minibuf_window) ? minibuf_prompt_width : 0);
Jim Blandy's avatar
Jim Blandy committed
1013 1014 1015 1016

 retry:
  if (vtarget > vpos)
    {
1017
      /* Moving downward is simple, but must calculate from beg of line
Jim Blandy's avatar
Jim Blandy committed
1018 1019 1020
	 to determine hpos of starting point */
      if (from > BEGV && FETCH_CHAR (from - 1) != '\n')
	{
1021 1022
	  Lisp_Object propval;

1023
	  XSETFASTINT (prevline, find_next_newline_no_quit (from, -1));
1024
	  while (XFASTINT (prevline) > BEGV
1025
		 && ((selective > 0
1026
		      && indented_beyond_p (XFASTINT (prevline), selective))
1027 1028
#ifdef USE_TEXT_PROPERTIES
		     /* watch out for newlines with `invisible' property */
1029 1030 1031 1032
		     || (propval = Fget_char_property (prevline,
						       Qinvisible,
						       window),
			 TEXT_PROP_MEANS_INVISIBLE (propval))
1033 1034
#endif
		 ))
1035 1036 1037
	    XSETFASTINT (prevline,
			 find_next_newline_no_quit (XFASTINT (prevline) - 1,
						    -1));
1038 1039 1040
	  pos = *compute_motion (XFASTINT (prevline), 0,
				 lmargin + (XFASTINT (prevline) == 1
					    ? start_hpos : 0),
Jim Blandy's avatar
Jim Blandy committed
1041
				 from, 1 << (INTBITS - 2), 0,
1042
				 width, hscroll, 0, XWINDOW (window));
Jim Blandy's avatar
Jim Blandy committed
1043 1044 1045 1046 1047 1048 1049
	}
      else
	{
	  pos.hpos = lmargin + (from == 1 ? start_hpos : 0);
	  pos.vpos = 0;
	}
      return compute_motion (from, vpos, pos.hpos,
Jim Blandy's avatar
Jim Blandy committed
1050
			     ZV, vtarget, - (1 << (INTBITS - 2)),
1051 1052
			     width, hscroll, pos.vpos * width,
			     XWINDOW (window));
Jim Blandy's avatar
Jim Blandy committed
1053 1054 1055 1056 1057 1058 1059 1060 1061
    }

  /* To move upward, go a line at a time until
     we have gone at least far enough */

  first = 1;

  while ((vpos > vtarget || first) && from > BEGV)
    {
1062
      XSETFASTINT (prevline, from);
Jim Blandy's avatar
Jim Blandy committed
1063 1064
      while (1)
	{
1065 1066
	  Lisp_Object propval;

1067 1068 1069
	  XSETFASTINT (prevline,
		       find_next_newline_no_quit (XFASTINT (prevline) - 1,
						  -1));
1070
	  if (XFASTINT (prevline) == BEGV
1071
	      || ((selective <= 0
1072
		   || ! indented_beyond_p (XFASTINT (prevline), selective))
1073 1074
#ifdef USE_TEXT_PROPERTIES
		  /* watch out for newlines with `invisible' property */
1075 1076 1077
		  && (propval = Fget_char_property (prevline, Qinvisible,
						    window),
		      ! TEXT_PROP_MEANS_INVISIBLE (propval))
1078 1079
#endif
		  ))
Jim Blandy's avatar
Jim Blandy committed
1080 1081
	    break;
	}
1082 1083 1084
      pos = *compute_motion (XFASTINT (prevline), 0,
			     lmargin + (XFASTINT (prevline) == 1
					? start_hpos : 0),
Jim Blandy's avatar
Jim Blandy committed
1085
			     from, 1 << (INTBITS - 2), 0,
1086
			     width, hscroll, 0, XWINDOW (window));
Jim Blandy's avatar
Jim Blandy committed
1087 1088
      vpos -= pos.vpos;
      first = 0;
1089
      from = XFASTINT (prevline);
Jim Blandy's avatar
Jim Blandy committed
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
    }

  /* If we made exactly the desired vertical distance,
     or if we hit beginning of buffer,
     return point found */
  if (vpos >= vtarget)
    {
      val_vmotion.bufpos = from;
      val_vmotion.vpos = vpos;
      val_vmotion.hpos = lmargin;
      val_vmotion.contin = 0;
      val_vmotion.prevhpos = 0;
      return &val_vmotion;
    }
1104

Jim Blandy's avatar
Jim Blandy committed
1105 1106 1107 1108
  /* Otherwise find the correct spot by moving down */
  goto retry;
}

1109
DEFUN ("vertical-motion", Fvertical_motion, Svertical_motion, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
1110 1111
  "Move to start of screen line LINES lines down.\n\
If LINES is negative, this is moving up.\n\
1112 1113 1114 1115 1116 1117 1118
\n\
The optional second argument WINDOW specifies the window to use for\n\
parameters such as width, horizontal scrolling, and so on.\n\
the default is the selected window.\n\
It does not matter what buffer is displayed in WINDOW.\n\
`vertical-motion' always uses the current buffer.\n\
\n\
Jim Blandy's avatar
Jim Blandy committed
1119
Sets point to position found; this may be start of line\n\
1120
or just the start of a continuation line.\n\
Jim Blandy's avatar
Jim Blandy committed
1121
Returns number of lines moved; may be closer to zero than LINES\n\
1122
if beginning or end of buffer was reached.")
1123 1124
  (lines, window)
     Lisp_Object lines, window;
Jim Blandy's avatar
Jim Blandy committed
1125 1126
{
  struct position pos;
1127
  register struct window *w;
Jim Blandy's avatar
Jim Blandy committed
1128 1129

  CHECK_NUMBER (lines, 0);
1130 1131 1132
  if (! NILP (window))
    CHECK_WINDOW (window, 0);
  else
1133
    window = selected_window;
Jim Blandy's avatar
Jim Blandy committed
1134

1135
  w = XWINDOW (window);
1136

1137
  pos = *vmotion (point, XINT (lines), window_internal_width (w) - 1,
Jim Blandy's avatar
Jim Blandy committed
1138
		  /* Not XFASTINT since perhaps could be negative */
1139
		  XINT (w->hscroll), window);
Jim Blandy's avatar
Jim Blandy committed
1140 1141 1142 1143 1144

  SET_PT (pos.bufpos);
  return make_number (pos.vpos);
}

1145 1146
/* file's initialization.  */