indent.c 36.8 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
      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;
}

277 278 279 280 281
/* Return the width in columns of the part of STRING from BEG to END.
   If BEG is nil, that stands for the beginning of STRING.
   If END is nil, that stands for the end of STRING.  */

static int
282
string_display_width (string, beg, end)
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
     Lisp_Object string, beg, end;
{
  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);
  int ctl_arrow = !NILP (current_buffer->ctl_arrow);
  register struct Lisp_Vector *dp = buffer_display_table ();
  int b, e;

  if (NILP (end))
    e = XSTRING (string)->size;
  else
    {
      CHECK_NUMBER (end, 0);
      e = XINT (end);
    }

  if (NILP (beg))
    b = 0;
  else
    {
      CHECK_NUMBER (beg, 0);
      b = XINT (beg);
    }

  /* Make a pointer for decrementing through the chars before point.  */
  ptr = XSTRING (string)->data + e;
  /* Make a pointer to where consecutive chars leave off,
     going backwards from point.  */
  stop = XSTRING (string)->data + b;

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

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

  while (1)
    {
      if (ptr == stop)
	break;

      c = *--ptr;
      if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c)))
	col += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
      else if (c >= 040 && c < 0177)
	col++;
      else if (c == '\n')
	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;
    }

  return col;
}

Jim Blandy's avatar
Jim Blandy committed
355 356 357 358 359 360 361 362 363 364 365 366
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
367
  if (NILP (minimum))
368
    XSETFASTINT (minimum, 0);
Jim Blandy's avatar
Jim Blandy committed
369 370 371 372 373 374 375 376 377
  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);

378
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
379 380 381 382

  if (indent_tabs_mode)
    {
      Lisp_Object n;
383
      XSETFASTINT (n, mincol / tab_width - fromcol / tab_width);
Jim Blandy's avatar
Jim Blandy committed
384 385
      if (XFASTINT (n) != 0)
	{
386
	  Finsert_char (make_number ('\t'), n, Qt);
Jim Blandy's avatar
Jim Blandy committed
387 388 389 390 391

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

392
  XSETFASTINT (col, mincol - fromcol);
393
  Finsert_char (make_number (' '), col, Qt);
Jim Blandy's avatar
Jim Blandy committed
394 395 396 397 398 399 400 401

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

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

Jim Blandy's avatar
Jim Blandy committed
403 404 405 406 407 408 409 410 411 412

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;

413
  XSETFASTINT (val, position_indentation (find_next_newline (point, -1)));
Jim Blandy's avatar
Jim Blandy committed
414 415 416 417 418 419 420 421 422 423
  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;
424

425
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
426

Jim Blandy's avatar
Jim Blandy committed
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
  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;
	}
    }
}
452 453 454 455 456 457 458 459 460

/* 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')
461
    pos = find_next_newline_no_quit (pos - 1, -1);
462 463
  return (position_indentation (pos) >= column);
}
464

Jim Blandy's avatar
Jim Blandy committed
465 466 467 468 469 470 471

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\
472 473
and horizontal scrolling has no effect.\n\
\n\
Jim Blandy's avatar
Jim Blandy committed
474 475 476 477 478 479 480 481 482 483 484 485 486
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
487
  register int ctl_arrow = !NILP (current_buffer->ctl_arrow);
Jim Blandy's avatar
Jim Blandy committed
488 489 490 491 492 493
  register struct Lisp_Vector *dp = buffer_display_table ();

  Lisp_Object val;
  int prev_col;
  int c;

494
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
  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);
513 514 515 516
      if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c)))
	{
	  col += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
	  pos++;
517
	  continue;
518
	}
Jim Blandy's avatar
Jim Blandy committed
519 520 521 522 523 524 525 526 527 528 529 530
      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))
531
        col += 2;
Jim Blandy's avatar
Jim Blandy committed
532
      else if (c < 040 || c >= 0177)
533
        col += 4;
Jim Blandy's avatar
Jim Blandy committed
534 535 536 537 538 539 540 541
      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
542
  if (!NILP (force) && col > goal && c == '\t' && prev_col < goal)
Jim Blandy's avatar
Jim Blandy committed
543
    {
Jim Blandy's avatar
Jim Blandy committed
544 545
      int old_point;

Jim Blandy's avatar
Jim Blandy committed
546
      del_range (point - 1, point);
Jim Blandy's avatar
Jim Blandy committed
547 548 549 550
      Findent_to (make_number (goal), Qnil);
      old_point = point;
      Findent_to (make_number (col), Qnil);
      SET_PT (old_point);
551 552
      /* Set the last_known... vars consistently.  */
      col = goal;
Jim Blandy's avatar
Jim Blandy committed
553 554 555
    }

  /* If line ends prematurely, add space to the end.  */
Jim Blandy's avatar
Jim Blandy committed
556
  if (col < goal && !NILP (force))
557
    Findent_to (make_number (col = goal), Qnil);
Jim Blandy's avatar
Jim Blandy committed
558 559 560 561 562

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

563
  XSETFASTINT (val, col);
Jim Blandy's avatar
Jim Blandy committed
564 565
  return val;
}
566

Jim Blandy's avatar
Jim Blandy committed
567

568 569
/* compute_motion: compute buffer posn given screen posn and vice versa */

Jim Blandy's avatar
Jim Blandy committed
570 571 572 573 574
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),
575 576 577
   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
578

579 580 581 582 583 584
   DID_MOTION is 1 if FROMHPOS has already accounted for overlay strings
   at FROM.  This is the case if FROMVPOS and FROMVPOS came from an
   earlier call to compute_motion.  The other common case is that FROMHPOS
   is zero and FROM is a position that "belongs" at column zero, but might
   be shifted by overlay strings; in this case DID_MOTION should be 0.

Jim Blandy's avatar
Jim Blandy committed
585 586 587 588
   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
589 590 591
   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
592 593 594

   compute_motion returns a pointer to a struct position.  The bufpos
   member gives the buffer position at the end of the scan, and hpos
595 596 597 598 599 600 601 602
   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
603

Karl Heuer's avatar
Karl Heuer committed
604 605 606 607 608
   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
609 610 611 612 613
   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
614
   TOHPOS.
Jim Blandy's avatar
Jim Blandy committed
615 616 617 618

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

	window_width - 1
619
	 - (has_vertical_scroll_bars
Karl Heuer's avatar
Karl Heuer committed
620
	    ? FRAME_SCROLL_BAR_COLS (XFRAME (window->frame))
621
	    : (window_width + window_left != frame_width))
Jim Blandy's avatar
Jim Blandy committed
622 623 624 625

	where
	  window_width is XFASTINT (w->width),
	  window_left is XFASTINT (w->left),
626 627
	  has_vertical_scroll_bars is
	    FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (WINDOW_FRAME (window)))
628
	  and frame_width = FRAME_WIDTH (XFRAME (window->frame))
Jim Blandy's avatar
Jim Blandy committed
629

Karl Heuer's avatar
Karl Heuer committed
630 631
   Or you can let window_internal_width do this all for you, and write:
	window_internal_width (w) - 1
632 633

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

struct position *
638
compute_motion (from, fromvpos, fromhpos, did_motion, to, tovpos, tohpos, width, hscroll, tab_offset, win)
Jim Blandy's avatar
Jim Blandy committed
639
     int from, fromvpos, fromhpos, to, tovpos, tohpos;
640
     int did_motion;
Jim Blandy's avatar
Jim Blandy committed
641 642
     register int width;
     int hscroll, tab_offset;
643
     struct window *win;
Jim Blandy's avatar
Jim Blandy committed
644
{
Jim Blandy's avatar
Jim Blandy committed
645 646 647
  register int hpos = fromhpos;
  register int vpos = fromvpos;

Jim Blandy's avatar
Jim Blandy committed
648 649 650
  register int pos;
  register int c;
  register int tab_width = XFASTINT (current_buffer->tab_width);
Jim Blandy's avatar
Jim Blandy committed
651
  register int ctl_arrow = !NILP (current_buffer->ctl_arrow);
652
  register struct Lisp_Vector *dp = window_display_table (win);
Jim Blandy's avatar
Jim Blandy committed
653
  int selective
654
    = (INTEGERP (current_buffer->selective_display)
655 656
       ? XINT (current_buffer->selective_display)
       : !NILP (current_buffer->selective_display) ? -1 : 0);
657
  int prev_vpos = vpos, prev_hpos = 0;
Jim Blandy's avatar
Jim Blandy committed
658
  int selective_rlen
659
    = (selective && dp && VECTORP (DISP_INVIS_VECTOR (dp))
660
       ? XVECTOR (DISP_INVIS_VECTOR (dp))->size : 0);
661 662 663
  /* The next location where the `invisible' property changes, or an
     overlay starts or ends.  */
  int next_boundary = from;
Jim Blandy's avatar
Jim Blandy committed
664

665 666
  /* For computing runs of characters with similar widths.
     Invariant: width_run_width is zero, or all the characters
667
     from width_run_start to width_run_end have a fixed width of
668 669 670 671 672
     width_run_width.  */
  int width_run_start = from;
  int width_run_end   = from;
  int width_run_width = 0;
  Lisp_Object *width_table;
673
  Lisp_Object buffer;
674 675 676 677

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

678 679
  XSETBUFFER (buffer, current_buffer);

680 681 682 683 684 685 686 687 688 689
  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;

690
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
691

692 693 694 695
  pos = from;
  while (1)
    {
      while (pos == next_boundary)
696
	{
697 698 699 700 701 702 703 704 705 706 707 708 709 710
	  /* If the caller says that the screen position came from an earlier
	     call to compute_motion, then we've already accounted for the
	     overlay strings at point.  This is only true the first time
	     through, so clear the flag after testing it.  */
	  if (!did_motion)
	    /* We need to skip past the overlay strings.  Currently those
	       strings must contain single-column printing characters;
	       if we want to relax that restriction, something will have
	       to be changed here.  */
	    hpos += overlay_strings (pos, win, (char **)0);
	  did_motion = 0;

	  if (pos >= to)
	    break;
711

712
	  {
713 714 715 716 717 718
	    Lisp_Object prop, position, end, limit, proplimit;

	    XSETFASTINT (position, pos);

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

720 721
	    /* We must not advance farther than the next overlay change.
	       The overlay change might change the invisible property;
722
	       or there might be overlay strings to be displayed there.  */
723
	    limit = Fnext_overlay_change (position);
724 725
	    /* As for text properties, this gives a lower bound
	       for where the invisible text property could change.  */
726
	    proplimit = Fnext_property_change (position, buffer, Qt);
727 728 729
	    if (XFASTINT (limit) < XFASTINT (proplimit))
	      proplimit = limit;
	    /* PROPLIMIT is now a lower bound for the next change
730 731
	       in invisible status.  If that is plenty far away,
	       use that lower bound.  */
732
	    if (XFASTINT (proplimit) > pos + 100 || XFASTINT (proplimit) >= to)
733
	      next_boundary = XFASTINT (proplimit);
734
	    /* Otherwise, scan for the next `invisible' property change.  */
735
	    else
736 737
	      {
		/* Don't scan terribly far.  */
738 739 740 741
		XSETFASTINT (proplimit, min (pos + 100, to));
		/* No matter what. don't go past next overlay change.  */
		if (XFASTINT (limit) < XFASTINT (proplimit))
		  proplimit = limit;
742
		end = Fnext_single_property_change (position, Qinvisible,
743
						    buffer, proplimit);
744
		next_boundary = XFASTINT (end);
745
	      }
746 747 748 749
	    /* if the `invisible' property is set, we can skip to
	       the next property change */
	    prop = Fget_char_property (position, Qinvisible,
				       Fcurrent_buffer ());
750
	    if (TEXT_PROP_MEANS_INVISIBLE (prop))
751
	      pos = next_boundary;
752 753
	  }
	}
754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778

      /* Handle right margin.  */
      if (hpos >= width
	  && (hpos > width
	      || (pos < ZV && FETCH_CHAR (pos) != '\n')))
	{
	  if (hscroll
	      || (truncate_partial_width_windows
		  && width + 1 < FRAME_WIDTH (XFRAME (WINDOW_FRAME (win))))
	      || !NILP (current_buffer->truncate_lines))
	    {
	      /* Truncating: skip to newline.  */
	      pos = find_before_next_newline (pos, to, 1);
	      hpos = width;
	    }
	  else
	    {
	      /* Continuing.  */
	      vpos += hpos / width;
	      tab_offset += hpos - hpos % width;
	      hpos %= width;
	    }
	}

      /* Stop if past the target buffer position or screen position.  */
779 780
      if (pos >= to)
	break;
781 782 783 784 785
      if (vpos > tovpos || (vpos == tovpos && hpos >= tohpos))
	break;

      prev_vpos = vpos;
      prev_hpos = hpos;
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 816 817

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

819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
              /* 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
836
      else
837 838 839
	{
	  c = FETCH_CHAR (pos);
	  pos++;
840

841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
	  /* 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?
		     (Currently, we only cache runs of width == 1).  */
		  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);

		  /* Start recording a new width run.  */
		  width_run_width = width_table[c];
		  width_run_start = pos - 1;
		  width_run_end = pos;
		}
	    }
Jim Blandy's avatar
Jim Blandy committed
868

869 870 871 872 873
	  if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c)))
	    hpos += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
	  else if (c >= 040 && c < 0177)
	    hpos++;
	  else if (c == '\t')
Jim Blandy's avatar
Jim Blandy committed
874
	    {
875 876 877 878
	      int tem = (hpos + tab_offset + hscroll - (hscroll > 0)) % tab_width;
	      if (tem < 0)
		tem += tab_width;
	      hpos += tab_width - tem;
Jim Blandy's avatar
Jim Blandy committed
879
	    }
880
	  else if (c == '\n')
Jim Blandy's avatar
Jim Blandy committed
881
	    {
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
	      if (selective > 0 && indented_beyond_p (pos, selective))
		{
		  /* Skip any number of invisible lines all at once */
		  do
		    pos = find_before_next_newline (pos, to, 1) + 1;
		  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;
		    }
		  --pos;
		  /* 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;
		}
Jim Blandy's avatar
Jim Blandy committed
911
	    }
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
	  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
928 929 930
	}
    }

931 932 933 934 935 936 937
  /* 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
938
  val_compute_motion.bufpos = pos;
Jim Blandy's avatar
Jim Blandy committed
939 940 941
  val_compute_motion.hpos = hpos;
  val_compute_motion.vpos = vpos;
  val_compute_motion.prevhpos = prev_hpos;
Jim Blandy's avatar
Jim Blandy committed
942 943 944

  /* Nonzero if have just continued a line */
  val_compute_motion.contin
Jim Blandy's avatar
Jim Blandy committed
945 946 947
    = (pos != from
       && (val_compute_motion.vpos != prev_vpos)
       && c != '\n');
Jim Blandy's avatar
Jim Blandy committed
948 949 950 951

  return &val_compute_motion;
}

Karl Heuer's avatar
Karl Heuer committed
952 953
#if 0 /* The doc string is too long for some compilers,
	 but make-docfile can find it in this comment.  */
954
DEFUN ("compute-motion", Ffoo, Sfoo, 7, 7, 0,
955 956 957 958 959 960
  "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\
961
There are three additional arguments:\n\
962 963 964
\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
965 966
This is usually the value returned by `window-width', less one (to allow\n\
for the continuation glyph).\n\
967 968 969 970 971 972
\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
973
If OFFSETS is nil, HSCROLL and TAB-OFFSET are assumed to be zero.\n\
974
\n\
975
WINDOW is the window to operate on.  Currently this is used only to\n\
976 977
find the display table.  It does not matter what buffer WINDOW displays;\n\
`compute-motion' always operates on the current buffer.\n\
978 979
\n\
The value is a list of five elements:\n\
980
  (POS HPOS VPOS PREVHPOS CONTIN)\n\
981 982 983 984 985 986 987 988 989 990 991 992
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.")
993
  (from, frompos, to, topos, width, offsets, window)
Karl Heuer's avatar
Karl Heuer committed
994 995
#endif

996
DEFUN ("compute-motion", Fcompute_motion, Scompute_motion, 7, 7, 0,
Karl Heuer's avatar
Karl Heuer committed
997
  0)
998
  (from, frompos, to, topos, width, offsets, window)
999
     Lisp_Object from, frompos, to, topos;
1000
     Lisp_Object width, offsets, window;
1001 1002 1003 1004 1005
{
  Lisp_Object bufpos, hpos, vpos, prevhpos, contin;
  struct position *pos;
  int hscroll, tab_offset;

Karl Heuer's avatar
Karl Heuer committed
1006
  CHECK_NUMBER_COERCE_MARKER (from, 0);
1007
  CHECK_CONS (frompos, 0);
Karl Heuer's avatar
Karl Heuer committed
1008 1009 1010
  CHECK_NUMBER (XCONS (frompos)->car, 0);
  CHECK_NUMBER (XCONS (frompos)->cdr, 0);
  CHECK_NUMBER_COERCE_MARKER (to, 0);
1011
  CHECK_CONS (topos, 0);
Karl Heuer's avatar
Karl Heuer committed
1012 1013 1014
  CHECK_NUMBER (XCONS (topos)->car, 0);
  CHECK_NUMBER (XCONS (topos)->cdr, 0);
  CHECK_NUMBER (width, 0);
1015 1016 1017
  if (!NILP (offsets))
    {
      CHECK_CONS (offsets, 0);
Karl Heuer's avatar
Karl Heuer committed
1018 1019
      CHECK_NUMBER (XCONS (offsets)->car, 0);
      CHECK_NUMBER (XCONS (offsets)->cdr, 0);
1020 1021 1022 1023 1024 1025
      hscroll = XINT (XCONS (offsets)->car);
      tab_offset = XINT (XCONS (offsets)->cdr);
    }
  else
    hscroll = tab_offset = 0;

1026 1027 1028 1029 1030
  if (NILP (window))
    window = Fselected_window ();
  else
    CHECK_LIVE_WINDOW (window, 0);

1031
  pos = compute_motion (XINT (from), XINT (XCONS (frompos)->cdr),
1032
			XINT (XCONS (frompos)->car), 0,
1033 1034
			XINT (to), XINT (XCONS (topos)->cdr),
			XINT (XCONS (topos)->car),
1035 1036
			XINT (width), hscroll, tab_offset,
			XWINDOW (window));
1037

1038
  XSETFASTINT (bufpos, pos->bufpos);
1039 1040 1041
  XSETINT (hpos, pos->hpos);
  XSETINT (vpos, pos->vpos);
  XSETINT (prevhpos, pos->prevhpos);
1042 1043 1044 1045 1046 1047 1048 1049

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

}
Jim Blandy's avatar
Jim Blandy committed
1050

1051 1052
/* 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
1053 1054 1055 1056 1057 1058 1059 1060
   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;
{
1061
  int opoint = PT;
Jim Blandy's avatar
Jim Blandy committed
1062
  int col;
1063
  int width = window_internal_width (w) - 1;
Jim Blandy's avatar
Jim Blandy committed
1064 1065 1066

  if (pos == BEGV || FETCH_CHAR (pos - 1) == '\n')
    return 0;
1067
  TEMP_SET_PT (pos);
Jim Blandy's avatar
Jim Blandy committed
1068
  col = current_column ();
1069
  TEMP_SET_PT (opoint);
Jim Blandy's avatar
Jim Blandy committed
1070 1071 1072
  return col - (col % width);
}

1073 1074

/* Fvertical_motion and vmotion */
Jim Blandy's avatar
Jim Blandy committed
1075 1076 1077
struct position val_vmotion;

struct position *
1078 1079 1080
vmotion (from, vtarget, w)
     register int from, vtarget;
     struct window *w;
Jim Blandy's avatar
Jim Blandy committed
1081
{
1082 1083
  int width = window_internal_width (w) - 1;
  int hscroll = XINT (w->hscroll);
Jim Blandy's avatar
Jim Blandy committed
1084 1085 1086
  struct position pos;
  /* vpos is cumulative vertical position, changed as from is changed */
  register int vpos = 0;
1087
  Lisp_Object prevline;
Jim Blandy's avatar
Jim Blandy committed
1088 1089 1090
  register int first;
  int lmargin = hscroll > 0 ? 1 - hscroll : 0;
  int selective
1091 1092 1093
    = (INTEGERP (current_buffer->selective_display)
       ? XINT (current_buffer->selective_display)
       : !NILP (current_buffer->selective_display) ? -1 : 0);
1094 1095
  Lisp_Object window;
  int start_hpos = 0;
1096
  int did_motion;
1097 1098 1099

  XSETWINDOW (window, w);

1100
  /* The omission of the clause
1101
         && marker_position (w->start) == BEG
1102 1103
     here is deliberate; I think we want to measure from the prompt
     position even if the minibuffer window has scrolled.  */
1104 1105
  if (EQ (window, minibuf_window))
    {
1106
      if (minibuf_prompt_width == 0 && STRINGP (minibuf_prompt))
1107 1108
	minibuf_prompt_width
	  = string_display_width (minibuf_prompt, Qnil, Qnil);
1109 1110 1111

      start_hpos = minibuf_prompt_width;
    }
Jim Blandy's avatar
Jim Blandy committed
1112

1113
  if (vpos >= vtarget)
Jim Blandy's avatar
Jim Blandy committed
1114
    {
1115 1116 1117 1118 1119 1120
      /* 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)
Jim Blandy's avatar
Jim Blandy committed
1121
	{
1122 1123
	  Lisp_Object propval;

1124
	  XSETFASTINT (prevline, find_next_newline_no_quit (from - 1, -1));
1125
	  while (XFASTINT (prevline) > BEGV
1126
		 && ((selective > 0
1127
		      && indented_beyond_p (XFASTINT (prevline), selective))
1128 1129
#ifdef USE_TEXT_PROPERTIES
		     /* watch out for newlines with `invisible' property */
1130 1131 1132 1133
		     || (propval = Fget_char_property (prevline,
						       Qinvisible,
						       window),
			 TEXT_PROP_MEANS_INVISIBLE (propval))
1134
#endif
1135
		     ))
1136 1137 1138
	    XSETFASTINT (prevline,
			 find_next_newline_no_quit (XFASTINT (prevline) - 1,
						    -1));
1139
	  pos = *compute_motion (XFASTINT (prevline), 0,
1140
				 lmargin + (XFASTINT (prevline) == BEG
1141
					    ? start_hpos : 0),
1142
				 0,
Jim Blandy's avatar
Jim Blandy committed
1143
				 from, 1 << (INTBITS - 2), 0,
1144 1145 1146 1147
				 width, hscroll, 0, w);
	  vpos -= pos.vpos;
	  first = 0;
	  from = XFASTINT (prevline);
Jim Blandy's avatar
Jim Blandy committed
1148
	}
1149 1150 1151 1152 1153

      /* If we made exactly the desired vertical distance,
	 or if we hit beginning of buffer,
	 return point found */
      if (vpos >= vtarget)
Jim Blandy's avatar
Jim Blandy committed
1154
	{
1155 1156 1157 1158 1159 1160
	  val_vmotion.bufpos = from;
	  val_vmotion.vpos = vpos;
	  val_vmotion.hpos = lmargin;
	  val_vmotion.contin = 0;
	  val_vmotion.prevhpos = 0;
	  return &val_vmotion;
Jim Blandy's avatar
Jim Blandy committed
1161 1162
	}

1163 1164 1165 1166 1167
      /* Otherwise find the correct spot by moving down */
    }
  /* Moving downward is simple, but must calculate from beg of line
     to determine hpos of starting point */
  if (from > BEGV && FETCH_CHAR (from - 1) != '\n')
Jim Blandy's avatar
Jim Blandy committed
1168
    {
1169
      Lisp_Object propval;
1170

1171 1172 1173 1174
      XSETFASTINT (prevline, find_next_newline_no_quit (from, -1));
      while (XFASTINT (prevline) > BEGV
	     && ((selective > 0
		  && indented_beyond_p (XFASTINT (prevline), selective))
1175
#ifdef USE_TEXT_PROPERTIES
1176 1177 1178 1179
		 /* watch out for newlines with `invisible' property */