indent.c 35.3 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 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 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 123

/* Width run cache considerations.  */

/* Return the width of character C under display table DP.  */
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.  */

  /* Some characters are never handled by the display table.  */
  if (c == '\n' || c == '\t' || c == '\015')
    return 0;

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

  /* In the absence of display table perversities, printing characters
     have width 1.  */
  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;
124
}
125 126 127 128 129 130 131 132

/* 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;
133
  struct Lisp_Vector *widthtab;
134

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

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

/* 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)
164
        {
165 166 167 168 169 170
          current_buffer->width_run_cache = new_region_cache ();
          recompute_width_table (current_buffer, buffer_display_table ());
        }
    }
}

Jim Blandy's avatar
Jim Blandy committed
171 172 173 174 175 176 177

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
178 179
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
180 181 182 183 184
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;
185
  XSETFASTINT (temp, current_column ());
Jim Blandy's avatar
Jim Blandy committed
186 187 188
  return temp;
}

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

invalidate_current_column ()
{
  last_known_column_point = 0;
}

Jim Blandy's avatar
Jim Blandy committed
196 197 198 199 200 201 202 203 204
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
205
  int ctl_arrow = !NILP (current_buffer->ctl_arrow);
Jim Blandy's avatar
Jim Blandy committed
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
  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;

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

  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;
      if (c >= 040 && c < 0177
245
	  && (dp == 0 || !VECTORP (DISP_CHAR_VECTOR (dp, c))))
Jim Blandy's avatar
Jim Blandy committed
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
	{
	  col++;
	}
      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;
	}
262
      else if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c)))
263
	col += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
Jim Blandy's avatar
Jim Blandy committed
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 289 290 291 292
      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
293
  if (NILP (minimum))
294
    XSETFASTINT (minimum, 0);
Jim Blandy's avatar
Jim Blandy committed
295 296 297 298 299 300 301 302 303
  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);

304
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
305 306 307 308

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

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

318
  XSETFASTINT (col, mincol - fromcol);
319
  Finsert_char (make_number (' '), col, Qt);
Jim Blandy's avatar
Jim Blandy committed
320 321 322 323 324 325 326 327

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

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

Jim Blandy's avatar
Jim Blandy committed
329 330 331 332 333 334 335 336 337 338

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;

339
  XSETFASTINT (val, position_indentation (find_next_newline (point, -1)));
Jim Blandy's avatar
Jim Blandy committed
340 341 342 343 344 345 346 347 348 349
  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;
350

351
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
352

Jim Blandy's avatar
Jim Blandy committed
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
  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;
	}
    }
}
378 379 380 381 382 383 384 385 386

/* 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')
387
    pos = find_next_newline_no_quit (pos - 1, -1);
388 389
  return (position_indentation (pos) >= column);
}
390

Jim Blandy's avatar
Jim Blandy committed
391 392 393 394 395 396 397

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\
398 399
and horizontal scrolling has no effect.\n\
\n\
Jim Blandy's avatar
Jim Blandy committed
400 401 402 403 404 405 406 407 408 409 410 411 412
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
413
  register int ctl_arrow = !NILP (current_buffer->ctl_arrow);
Jim Blandy's avatar
Jim Blandy committed
414 415 416 417 418 419
  register struct Lisp_Vector *dp = buffer_display_table ();

  Lisp_Object val;
  int prev_col;
  int c;

420
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
  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);
      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;
	}
450
      else if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c)))
451
	col += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
Jim Blandy's avatar
Jim Blandy committed
452
      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
	    /* Get a quit lower bound for how soon property might change.  */
635
	    limit = Fnext_overlay_change (position);
636 637 638 639 640 641 642 643 644
	    proplimit = Fnext_property_change (position, buffer, Qt);
	    if (XFASTINT (proplimit) < XFASTINT (limit))
	      limit = proplimit;
	    /* LIMIT is now a lower bound for the next change
	       in invisible status.  If that is plenty far away,
	       use that lower bound.  */
	    if (XFASTINT (limit) > pos + 100 || XFASTINT (limit) >= to)
	      next_invisible = XINT (limit);
	    /* Otherwise, scan for the next `invisible' property change.  */
645
	    else
646 647 648 649 650 651 652 653 654 655 656
	      {
		/* Don't scan terribly far.  */
		XSETFASTINT (limit, min (pos + 100, to));
		end = Fnext_single_property_change (position, Qinvisible,
						    buffer, limit);
		if (INTEGERP (end) && XINT (end) < to)
		  next_invisible = XINT (end);
		else
		  next_invisible = to;
	      }
	    if (TEXT_PROP_MEANS_INVISIBLE (prop))
657 658 659
	      pos = next_invisible;
	  }
	}
660 661 662
      if (pos >= to)
	break;
#endif
663 664 665 666 667 668 669 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

      /* 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;
                }
695

696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
              /* 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
713
      else
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
        {
          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?
732
                     (Currently, we only cache runs of width == 1).  */
733 734 735 736 737
                  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);
738

739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
                  /* Start recording a new width run.  */
                  width_run_width = width_table[c];
                  width_run_start = pos - 1;
                  width_run_end = pos;
                }
            }

          if (c >= 040 && c < 0177
              && (dp == 0 || ! VECTORP (DISP_CHAR_VECTOR (dp, c))))
            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
765
                    pos = find_before_next_newline (pos, to, 1) + 1;
766 767 768 769 770 771 772 773 774
                  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;
                    }
775
		  --pos;
776 777 778 779 780 781 782 783 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
                  /* 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 if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c)))
            hpos += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
          else
            hpos += (ctl_arrow && c < 0200) ? 2 : 4;
        }
Jim Blandy's avatar
Jim Blandy committed
810

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

	}
    }

840 841 842 843 844 845 846
  /* 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
847
  val_compute_motion.bufpos = pos;
Jim Blandy's avatar
Jim Blandy committed
848 849 850
  val_compute_motion.hpos = hpos;
  val_compute_motion.vpos = vpos;
  val_compute_motion.prevhpos = prev_hpos;
Jim Blandy's avatar
Jim Blandy committed
851 852 853

  /* Nonzero if have just continued a line */
  val_compute_motion.contin
Jim Blandy's avatar
Jim Blandy committed
854 855 856
    = (pos != from
       && (val_compute_motion.vpos != prev_vpos)
       && c != '\n');
Jim Blandy's avatar
Jim Blandy committed
857 858 859 860

  return &val_compute_motion;
}

Karl Heuer's avatar
Karl Heuer committed
861 862
#if 0 /* The doc string is too long for some compilers,
	 but make-docfile can find it in this comment.  */
863
DEFUN ("compute-motion", Ffoo, Sfoo, 7, 7, 0,
864 865 866 867 868 869
  "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\
870
There are three additional arguments:\n\
871 872 873
\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
874 875
This is usually the value returned by `window-width', less one (to allow\n\
for the continuation glyph).\n\
876 877 878 879 880 881
\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
882
If OFFSETS is nil, HSCROLL and TAB-OFFSET are assumed to be zero.\n\
883
\n\
884
WINDOW is the window to operate on.  Currently this is used only to\n\
885 886
find the display table.  It does not matter what buffer WINDOW displays;\n\
`compute-motion' always operates on the current buffer.\n\
887 888
\n\
The value is a list of five elements:\n\
889
  (POS HPOS VPOS PREVHPOS CONTIN)\n\
890 891 892 893 894 895 896 897 898 899 900 901
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.")
902
  (from, frompos, to, topos, width, offsets, window)
Karl Heuer's avatar
Karl Heuer committed
903 904
#endif

905
DEFUN ("compute-motion", Fcompute_motion, Scompute_motion, 7, 7, 0,
Karl Heuer's avatar
Karl Heuer committed
906
  0)
907
  (from, frompos, to, topos, width, offsets, window)
908
     Lisp_Object from, frompos, to, topos;
909
     Lisp_Object width, offsets, window;
910 911 912 913 914
{
  Lisp_Object bufpos, hpos, vpos, prevhpos, contin;
  struct position *pos;
  int hscroll, tab_offset;

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

935 936 937 938 939
  if (NILP (window))
    window = Fselected_window ();
  else
    CHECK_LIVE_WINDOW (window, 0);

940 941 942 943
  pos = compute_motion (XINT (from), XINT (XCONS (frompos)->cdr),
			XINT (XCONS (frompos)->car),
			XINT (to), XINT (XCONS (topos)->cdr),
			XINT (XCONS (topos)->car),
944 945
			XINT (width), hscroll, tab_offset,
			XWINDOW (window));
946

947
  XSETFASTINT (bufpos, pos->bufpos);
948 949 950
  XSETINT (hpos, pos->hpos);
  XSETINT (vpos, pos->vpos);
  XSETINT (prevhpos, pos->prevhpos);
951 952 953 954 955 956 957 958

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

}
Jim Blandy's avatar
Jim Blandy committed
959

960 961
/* 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
962 963 964 965 966 967 968 969
   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;
{
970
  int opoint = PT;
Jim Blandy's avatar
Jim Blandy committed
971
  int col;
972
  int width = window_internal_width (w) - 1;
Jim Blandy's avatar
Jim Blandy committed
973 974 975

  if (pos == BEGV || FETCH_CHAR (pos - 1) == '\n')
    return 0;
976
  TEMP_SET_PT (pos);
Jim Blandy's avatar
Jim Blandy committed
977
  col = current_column ();
978
  TEMP_SET_PT (opoint);
Jim Blandy's avatar
Jim Blandy committed
979 980 981
  return col - (col % width);
}

982 983

/* Fvertical_motion and vmotion */
Jim Blandy's avatar
Jim Blandy committed
984 985 986 987 988 989 990 991 992 993 994
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;
995
  Lisp_Object prevline;
Jim Blandy's avatar
Jim Blandy committed
996 997 998
  register int first;
  int lmargin = hscroll > 0 ? 1 - hscroll : 0;
  int selective
999 1000 1001
    = (INTEGERP (current_buffer->selective_display)
       ? XINT (current_buffer->selective_display)
       : !NILP (current_buffer->selective_display) ? -1 : 0);
1002 1003 1004 1005 1006
  /* 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
1007 1008 1009 1010

 retry:
  if (vtarget > vpos)
    {
1011
      /* Moving downward is simple, but must calculate from beg of line
Jim Blandy's avatar
Jim Blandy committed
1012 1013 1014
	 to determine hpos of starting point */
      if (from > BEGV && FETCH_CHAR (from - 1) != '\n')
	{
1015 1016
	  Lisp_Object propval;

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

  /* 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)
    {
1056
      XSETFASTINT (prevline, from);
Jim Blandy's avatar
Jim Blandy committed
1057 1058
      while (1)
	{
1059 1060
	  Lisp_Object propval;

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

  /* 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;
    }
1098

Jim Blandy's avatar
Jim Blandy committed
1099 1100 1101 1102
  /* Otherwise find the correct spot by moving down */
  goto retry;
}

1103
DEFUN ("vertical-motion", Fvertical_motion, Svertical_motion, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
1104 1105
  "Move to start of screen line LINES lines down.\n\
If LINES is negative, this is moving up.\n\
1106 1107 1108 1109 1110 1111 1112
\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
1113
Sets point to position found; this may be start of line\n\
1114
or just the start of a continuation line.\n\
Jim Blandy's avatar
Jim Blandy committed
1115
Returns number of lines moved; may be closer to zero than LINES\n\
1116
if beginning or end of buffer was reached.")
1117 1118
  (lines, window)
     Lisp_Object lines, window;
Jim Blandy's avatar
Jim Blandy committed
1119 1120
{
  struct position pos;
1121
  register struct window *w;
Jim Blandy's avatar
Jim Blandy committed
1122 1123

  CHECK_NUMBER (lines, 0);
1124 1125 1126
  if (! NILP (window))
    CHECK_WINDOW (window, 0);
  else
1127
    window = selected_window;
Jim Blandy's avatar
Jim Blandy committed
1128

1129
  w = XWINDOW (window);
1130

1131
  pos = *vmotion (point, XINT (lines), window_internal_width (w) - 1,
Jim Blandy's avatar
Jim Blandy committed
1132
		  /* Not XFASTINT since perhaps could be negative */
1133
		  XINT (w->hscroll), window);
Jim Blandy's avatar
Jim Blandy committed
1134 1135 1136 1137 1138

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

Jim Blandy's avatar
Jim Blandy committed
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
syms_of_indent ()
{
  DEFVAR_BOOL ("indent-tabs-mode", &indent_tabs_mode,
    "*Indentation can insert tabs if this is non-nil.\n\
Setting this variable automatically makes it local to the current buffer.");
  indent_tabs_mode = 1;

  defsubr (&Scurrent_indentation);
  defsubr (&Sindent_to);
  defsubr (&Scurrent_column);
  defsubr (&Smove_to_column);
  defsubr (&Svertical_motion);
1153
  defsubr (&Scompute_motion);
Jim Blandy's avatar
Jim Blandy committed
1154
}