indent.c 51 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

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
Karl Heuer's avatar
Karl Heuer committed
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


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

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

55 56
static int current_column_1 ();

57 58 59 60
/* Cache of beginning of line found by the last call of
   current_column. */
int current_column_bol_cache;

Jim Blandy's avatar
Jim Blandy committed
61 62
/* Get the display table to use for the current buffer.  */

63
struct Lisp_Char_Table *
Jim Blandy's avatar
Jim Blandy committed
64 65 66 67 68
buffer_display_table ()
{
  Lisp_Object thisbuf;

  thisbuf = current_buffer->display_table;
69 70 71 72
  if (DISP_TABLE_P (thisbuf))
    return XCHAR_TABLE (thisbuf);
  if (DISP_TABLE_P (Vstandard_display_table))
    return XCHAR_TABLE (Vstandard_display_table);
Jim Blandy's avatar
Jim Blandy committed
73 74
  return 0;
}
75 76 77 78

/* Width run cache considerations.  */

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

80 81 82
static int
character_width (c, dp)
     int c;
83
     struct Lisp_Char_Table *dp;
84 85 86 87 88 89
{
  Lisp_Object elt;

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

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

95 96 97 98 99
  /* Some characters are special.  */
  if (c == '\n' || c == '\t' || c == '\015')
    return 0;

  /* Printing characters have width 1.  */
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
  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)
117
     struct Lisp_Char_Table *disptab;
118 119 120 121 122 123 124 125 126 127 128 129 130
     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;
131
}
132 133 134 135 136

/* Recompute BUF's width table, using the display table DISPTAB.  */
void
recompute_width_table (buf, disptab)
     struct buffer *buf;
137
     struct Lisp_Char_Table *disptab;
138 139
{
  int i;
140
  struct Lisp_Vector *widthtab;
141

142 143 144
  if (!VECTORP (buf->width_table))
    buf->width_table = Fmake_vector (make_number (256), make_number (0));
  widthtab = XVECTOR (buf->width_table);
145 146 147 148
  if (widthtab->size != 256)
    abort ();

  for (i = 0; i < 256; i++)
149
    XSETFASTINT (widthtab->contents[i], character_width (i, disptab));
150 151 152 153 154 155 156
}

/* 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 ()
{
157 158 159 160
  if (NILP (current_buffer->cache_long_line_scans)
      /* And, for the moment, this feature doesn't work on multibyte
         characters.  */
      || !NILP (current_buffer->enable_multibyte_characters))
161 162 163 164 165 166 167 168 169 170 171 172 173
    {
      /* 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)
174
        {
175 176 177 178 179 180
          current_buffer->width_run_cache = new_region_cache ();
          recompute_width_table (current_buffer, buffer_display_table ());
        }
    }
}

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211

/* Skip some invisible characters starting from POS.
   This includes characters invisible because of text properties
   and characters invisible because of overlays.

   If position POS is followed by invisible characters,
   skip some of them and return the position after them.
   Otherwise return POS itself.

   Set *NEXT_BOUNDARY_P to the next position at which
   it will be necessary to call this function again.

   Don't scan past TO, and don't set *NEXT_BOUNDARY_P
   to a value greater than TO.

   If WINDOW is non-nil, and this buffer is displayed in WINDOW,
   take account of overlays that apply only in WINDOW.

   We don't necessarily skip all the invisible characters after POS
   because that could take a long time.  We skip a reasonable number
   which can be skipped quickly.  If there might be more invisible
   characters immediately following, then *NEXT_BOUNDARY_P
   will equal the return value.  */

static int
skip_invisible (pos, next_boundary_p, to, window)
     int pos;
     int *next_boundary_p;
     int to;
     Lisp_Object window;
{
212
  Lisp_Object prop, position, overlay_limit, proplimit;
213
  Lisp_Object buffer;
214
  int end;
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243

  XSETFASTINT (position, pos);
  XSETBUFFER (buffer, current_buffer);

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

  /* We must not advance farther than the next overlay change.
     The overlay change might change the invisible property;
     or there might be overlay strings to be displayed there.  */
  overlay_limit = Fnext_overlay_change (position);
  /* As for text properties, this gives a lower bound
     for where the invisible text property could change.  */
  proplimit = Fnext_property_change (position, buffer, Qt);
  if (XFASTINT (overlay_limit) < XFASTINT (proplimit))
    proplimit = overlay_limit;
  /* PROPLIMIT is now a lower bound for the next change
     in invisible status.  If that is plenty far away,
     use that lower bound.  */
  if (XFASTINT (proplimit) > pos + 100 || XFASTINT (proplimit) >= to)
    *next_boundary_p = XFASTINT (proplimit);
  /* Otherwise, scan for the next `invisible' property change.  */
  else
    {
      /* Don't scan terribly far.  */
      XSETFASTINT (proplimit, min (pos + 100, to));
      /* No matter what. don't go past next overlay change.  */
      if (XFASTINT (overlay_limit) < XFASTINT (proplimit))
	proplimit = overlay_limit;
244 245
      end = XFASTINT (Fnext_single_property_change (position, Qinvisible,
						    buffer, proplimit));
246 247 248 249 250 251 252
      /* Don't put the boundary in the middle of multibyte form if
         there is no actual property change.  */
      if (end == pos + 100
	  && !NILP (current_buffer->enable_multibyte_characters)
	  && end < ZV)
	while (pos < end && !CHAR_HEAD_P (POS_ADDR (end)))
	  end--;
253
      *next_boundary_p = end;
254 255 256 257 258 259 260 261 262 263 264
    }
  /* if the `invisible' property is set, we can skip to
     the next property change */
  if (!NILP (window) && EQ (XWINDOW (window)->buffer, buffer))
    prop = Fget_char_property (position, Qinvisible, window);
  else
    prop = Fget_char_property (position, Qinvisible, buffer);
  if (TEXT_PROP_MEANS_INVISIBLE (prop))
    return *next_boundary_p;
  return pos;
}
Jim Blandy's avatar
Jim Blandy committed
265 266 267 268 269 270 271

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
272 273
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
274 275 276 277 278
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;
279
  XSETFASTINT (temp, current_column ());
Jim Blandy's avatar
Jim Blandy committed
280 281 282
  return temp;
}

Jim Blandy's avatar
Jim Blandy committed
283 284
/* Cancel any recorded value of the horizontal position.  */

285
void
Jim Blandy's avatar
Jim Blandy committed
286 287 288 289 290
invalidate_current_column ()
{
  last_known_column_point = 0;
}

Jim Blandy's avatar
Jim Blandy committed
291 292 293 294 295 296 297 298 299
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
300
  int ctl_arrow = !NILP (current_buffer->ctl_arrow);
301
  register struct Lisp_Char_Table *dp = buffer_display_table ();
Jim Blandy's avatar
Jim Blandy committed
302 303
  int stopchar;

304
  if (PT == last_known_column_point
Jim Blandy's avatar
Jim Blandy committed
305 306 307
      && MODIFF == last_known_column_modified)
    return last_known_column;

308
  /* If the buffer has overlays, text properties, or multibyte, 
309 310 311
     use a more general algorithm.  */
  if (BUF_INTERVALS (current_buffer)
      || !NILP (current_buffer->overlays_before)
312 313
      || !NILP (current_buffer->overlays_after)
      || !NILP (current_buffer->enable_multibyte_characters))
314
    return current_column_1 (PT);
315 316 317 318

  /* Scan backwards from point to the previous newline,
     counting width.  Tab characters are the only complicated case.  */

Jim Blandy's avatar
Jim Blandy committed
319
  /* Make a pointer for decrementing through the chars before point.  */
320
  ptr = POS_ADDR (PT - 1) + 1;
Jim Blandy's avatar
Jim Blandy committed
321 322
  /* Make a pointer to where consecutive chars leave off,
     going backwards from point.  */
323
  if (PT == BEGV)
Jim Blandy's avatar
Jim Blandy committed
324
    stop = ptr;
325
  else if (PT <= GPT || BEGV > GPT)
Jim Blandy's avatar
Jim Blandy committed
326 327 328 329
    stop = BEGV_ADDR;
  else
    stop = GAP_END_ADDR;

330
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349

  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;
350 351 352 353
      if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c)))
	col += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
      else if (c >= 040 && c < 0177)
	col++;
354 355 356 357 358 359
      else if (c == '\n'
	       || (c == '\r' && EQ (current_buffer->selective_display, Qt)))
	{
	  ptr++;
	  break;
	}
Jim Blandy's avatar
Jim Blandy committed
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
      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;
    }

379 380 381
  if (ptr == BEGV_ADDR)
    current_column_bol_cache = BEGV;
  else
382
    current_column_bol_cache = PTR_CHAR_POS (ptr);
Jim Blandy's avatar
Jim Blandy committed
383
  last_known_column = col;
384
  last_known_column_point = PT;
Jim Blandy's avatar
Jim Blandy committed
385 386 387 388 389
  last_known_column_modified = MODIFF;

  return col;
}

390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
/* Return the column number of position POS
   by scanning forward from the beginning of the line.
   This function handles characters that are invisible
   due to text properties or overlays.  */

static int
current_column_1 (pos)
     int pos;
{
  register int tab_width = XINT (current_buffer->tab_width);
  register int ctl_arrow = !NILP (current_buffer->ctl_arrow);
  register struct Lisp_Char_Table *dp = buffer_display_table ();

  /* Start the scan at the beginning of this line with column number 0.  */
  register int col = 0;
405
  int scan = current_column_bol_cache = find_next_newline (pos, -1);
406
  int next_boundary = scan;
407
  int multibyte = !NILP (current_buffer->enable_multibyte_characters);
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425

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

  /* Scan forward to the target position.  */
  while (scan < pos)
    {
      int c;

      /* Occasionally we may need to skip invisible text.  */
      while (scan == next_boundary)
	{
	  /* This updates NEXT_BOUNDARY to the next place
	     where we might need to skip more invisible text.  */
	  scan = skip_invisible (scan, &next_boundary, pos, Qnil);
	  if (scan >= pos)
	    goto endloop;
	}

426
      c = FETCH_BYTE (scan);
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
      if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c)))
	{
	  col += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
	  scan++;
	  continue;
	}
      if (c == '\n')
	break;
      if (c == '\r' && EQ (current_buffer->selective_display, Qt))
	break;
      scan++;
      if (c == '\t')
	{
	  int prev_col = col;
	  col += tab_width;
	  col = col / tab_width * tab_width;
	}
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
      else if (multibyte && BASE_LEADING_CODE_P (c))
	{
	  scan--;
	  /* Start of multi-byte form.  */
	  if (c == LEADING_CODE_COMPOSITION)
	    {
	      unsigned char *ptr = POS_ADDR (scan);

	      int cmpchar_id = str_cmpchar_id (ptr, next_boundary - scan);
	      if (cmpchar_id >= 0)
		{
		  scan += cmpchar_table[cmpchar_id]->len,
		  col += cmpchar_table[cmpchar_id]->width;
		}
	      else
		{		/* invalid composite character */
		  scan++;
		  col += 4;
		}
	    }
	  else
	    {
	      /* Here, we check that the following bytes are valid
		 constituents of multi-byte form.  */
	      int len = BYTES_BY_CHAR_HEAD (c), i;

	      for (i = 1, scan++; i < len; i++, scan++)
		/* We don't need range checking for PTR because there
		   are anchors (`\0') at GAP and Z.  */
		if (CHAR_HEAD_P (POS_ADDR (scan))) break;
	      if (i < len)
		col += 4, scan -= i - 1;
	      else
		col += WIDTH_BY_CHAR_HEAD (c);
	    }
	}
480 481 482 483 484 485 486 487 488 489
      else if (ctl_arrow && (c < 040 || c == 0177))
        col += 2;
      else if (c < 040 || c >= 0177)
        col += 4;
      else
	col++;
    }
 endloop:

  last_known_column = col;
490
  last_known_column_point = PT;
491 492 493 494 495
  last_known_column_modified = MODIFF;

  return col;
}

496 497 498 499 500
/* 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
501
string_display_width (string, beg, end)
502 503 504 505 506 507 508 509 510
     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);
511
  register struct Lisp_Char_Table *dp = buffer_display_table ();
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
  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
574 575
DEFUN ("indent-to", Findent_to, Sindent_to, 1, 2, "NIndent to column: ",
  "Indent from point with tabs and spaces until COLUMN is reached.\n\
576 577 578 579
Optional second argument MININUM says always do at least MININUM spaces\n\
even if that goes past COLUMN; by default, MININUM is zero.")
  (column, minimum)
     Lisp_Object column, minimum;
Jim Blandy's avatar
Jim Blandy committed
580 581 582 583 584
{
  int mincol;
  register int fromcol;
  register int tab_width = XINT (current_buffer->tab_width);

585
  CHECK_NUMBER (column, 0);
Jim Blandy's avatar
Jim Blandy committed
586
  if (NILP (minimum))
587
    XSETFASTINT (minimum, 0);
Jim Blandy's avatar
Jim Blandy committed
588 589 590 591
  CHECK_NUMBER (minimum, 1);

  fromcol = current_column ();
  mincol = fromcol + XINT (minimum);
592
  if (mincol < XINT (column)) mincol = XINT (column);
Jim Blandy's avatar
Jim Blandy committed
593 594 595 596

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

597
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
598 599 600 601

  if (indent_tabs_mode)
    {
      Lisp_Object n;
602
      XSETFASTINT (n, mincol / tab_width - fromcol / tab_width);
Jim Blandy's avatar
Jim Blandy committed
603 604
      if (XFASTINT (n) != 0)
	{
605
	  Finsert_char (make_number ('\t'), n, Qt);
Jim Blandy's avatar
Jim Blandy committed
606 607 608 609 610

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

611 612
  XSETFASTINT (column, mincol - fromcol);
  Finsert_char (make_number (' '), column, Qt);
Jim Blandy's avatar
Jim Blandy committed
613 614

  last_known_column = mincol;
615
  last_known_column_point = PT;
Jim Blandy's avatar
Jim Blandy committed
616 617
  last_known_column_modified = MODIFF;

618 619
  XSETINT (column, mincol);
  return column;
Jim Blandy's avatar
Jim Blandy committed
620
}
621

Jim Blandy's avatar
Jim Blandy committed
622 623 624 625 626 627 628 629 630 631

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;

632
  XSETFASTINT (val, position_indentation (find_next_newline (PT, -1)));
Jim Blandy's avatar
Jim Blandy committed
633 634 635 636 637 638 639 640 641 642
  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;
643 644 645
  unsigned char *start;
  int next_boundary = pos;
  int ceiling = pos;
646

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

649
  p = POS_ADDR (pos);
650 651 652 653 654 655
  /* STOP records the value of P at which we will need
     to think about the gap, or about invisible text,
     or about the end of the buffer.  */
  stop = p;
  /* START records the starting value of P.  */
  start = p;
Jim Blandy's avatar
Jim Blandy committed
656 657 658 659
  while (1)
    {
      while (p == stop)
	{
660 661 662 663 664 665 666
	  int stop_pos;

	  /* If we have updated P, set POS to match.
	     The first time we enter the loop, POS is already right.  */
	  if (p != start)
	    pos = PTR_CHAR_POS (p);
	  /* Consider the various reasons STOP might have been set here.  */
Jim Blandy's avatar
Jim Blandy committed
667 668
	  if (pos == ZV)
	    return column;
669 670 671 672 673 674 675 676 677 678 679
	  if (pos == next_boundary)
	    pos = skip_invisible (pos, &next_boundary, ZV, Qnil);
	  if (pos >= ceiling)
	    ceiling = BUFFER_CEILING_OF (pos) + 1;
	  /* Compute the next place we need to stop and think,
	     and set STOP accordingly.  */
	  stop_pos = min (ceiling, next_boundary);
	  /* The -1 and +1 arrange to point at the first byte of gap
	     (if STOP_POS is the position of the gap)
	     rather than at the data after the gap.  */
	     
680 681
	  stop = POS_ADDR (stop_pos - 1) + 1;
	  p = POS_ADDR (pos);
Jim Blandy's avatar
Jim Blandy committed
682 683 684
	}
      switch (*p++)
	{
685 686 687
	case 0240:
	  if (! NILP (current_buffer->enable_multibyte_characters))
	    return column;
Jim Blandy's avatar
Jim Blandy committed
688 689 690 691 692 693 694
	case ' ':
	  column++;
	  break;
	case '\t':
	  column += tab_width - column % tab_width;
	  break;
	default:
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
	  if (ASCII_BYTE_P (p[-1])
	      || NILP (current_buffer->enable_multibyte_characters))
	    return column;
	  {
	    int pos = PTR_CHAR_POS (p - 1);
	    int c = FETCH_MULTIBYTE_CHAR (pos);
	    if (CHAR_HAS_CATEGORY (c, ' '))
	      {
		column++;
		INC_POS (pos);
		p = POS_ADDR (pos);
	      }
	    else
	      return column;
	  }
Jim Blandy's avatar
Jim Blandy committed
710 711 712
	}
    }
}
713 714 715 716 717 718 719 720

/* 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;
{
721
  while (pos > BEGV && FETCH_BYTE (pos) == '\n')
722
    pos = find_next_newline_no_quit (pos - 1, -1);
723 724
  return (position_indentation (pos) >= column);
}
Jim Blandy's avatar
Jim Blandy committed
725

726
DEFUN ("move-to-column", Fmove_to_column, Smove_to_column, 1, 2, "p",
Jim Blandy's avatar
Jim Blandy committed
727 728 729 730 731
  "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\
732 733
and horizontal scrolling has no effect.\n\
\n\
Jim Blandy's avatar
Jim Blandy committed
734 735 736 737
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\
738 739 740
and if COLUMN is in the middle of a tab character, change it to spaces.\n\
\n\
The return value is the current column.")
Jim Blandy's avatar
Jim Blandy committed
741 742 743 744 745 746 747 748
  (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
749
  register int ctl_arrow = !NILP (current_buffer->ctl_arrow);
750
  register struct Lisp_Char_Table *dp = buffer_display_table ();
751
  register int multibyte = !NILP (current_buffer->enable_multibyte_characters);
Jim Blandy's avatar
Jim Blandy committed
752 753 754 755 756

  Lisp_Object val;
  int prev_col;
  int c;

757 758
  int next_boundary;

759
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
760 761 762
  CHECK_NATNUM (column, 0);
  goal = XINT (column);

763
  pos = PT;
Jim Blandy's avatar
Jim Blandy committed
764
  end = ZV;
765
  next_boundary = pos;
Jim Blandy's avatar
Jim Blandy committed
766 767 768 769 770

  /* If we're starting past the desired column,
     back up to beginning of line and scan from there.  */
  if (col > goal)
    {
771
      end = pos;
772
      pos = current_column_bol_cache;
Jim Blandy's avatar
Jim Blandy committed
773 774 775
      col = 0;
    }

776
  while (pos < end)
Jim Blandy's avatar
Jim Blandy committed
777
    {
778 779 780 781 782 783 784
      while (pos == next_boundary)
	{
	  pos = skip_invisible (pos, &next_boundary, end, Qnil);
	  if (pos >= end)
	    goto endloop;
	}

785 786 787 788 789 790
      /* Test reaching the goal column.  We do this after skipping
	 invisible characters, so that we put point before the
	 character on which the cursor will appear.  */
      if (col >= goal)
	break;

791
      c = FETCH_BYTE (pos);
792 793 794 795
      if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c)))
	{
	  col += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
	  pos++;
796
	  continue;
797
	}
Jim Blandy's avatar
Jim Blandy committed
798 799 800 801 802 803 804 805 806 807 808 809
      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))
810
        col += 2;
811
      else if (c < 040 || c == 0177)
812
        col += 4;
813
      else if (c < 0177)
Jim Blandy's avatar
Jim Blandy committed
814
	col++;
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
      else if (multibyte && BASE_LEADING_CODE_P (c))
	{
	  /* Start of multi-byte form.  */
	  unsigned char *ptr;

	  pos--;		/* rewind to the character head */
	  ptr = POS_ADDR (pos);
	  if (c == LEADING_CODE_COMPOSITION)
	    {
	      int cmpchar_id = str_cmpchar_id (ptr, end - pos);

	      if (cmpchar_id >= 0)
		{
		  col += cmpchar_table[cmpchar_id]->width;
		  pos += cmpchar_table[cmpchar_id]->len;
		}
	      else
		{		/* invalid composite character */
		  col += 4;
		  pos++;
		}
	    }
	  else
	    {
	      /* Here, we check that the following bytes are valid
		 constituents of multi-byte form.  */
	      int len = BYTES_BY_CHAR_HEAD (c), i;

	      for (i = 1, ptr++; i < len; i++, ptr++)
		/* We don't need range checking for PTR because there
		   are anchors (`\0') both at GPT and Z.  */
		if (CHAR_HEAD_P (ptr)) break;
	      if (i < len)
		col += 4, pos++;
	      else
		col += WIDTH_BY_CHAR_HEAD (c), pos += i;
	    }
	}
      else
	col += 4;
Jim Blandy's avatar
Jim Blandy committed
855
    }
856
 endloop:
Jim Blandy's avatar
Jim Blandy committed
857 858 859 860 861

  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
862
  if (!NILP (force) && col > goal && c == '\t' && prev_col < goal)
Jim Blandy's avatar
Jim Blandy committed
863
    {
Jim Blandy's avatar
Jim Blandy committed
864 865
      int old_point;

866
      del_range (PT - 1, PT);
Jim Blandy's avatar
Jim Blandy committed
867
      Findent_to (make_number (goal), Qnil);
868
      old_point = PT;
Jim Blandy's avatar
Jim Blandy committed
869 870
      Findent_to (make_number (col), Qnil);
      SET_PT (old_point);
871 872
      /* Set the last_known... vars consistently.  */
      col = goal;
Jim Blandy's avatar
Jim Blandy committed
873 874 875
    }

  /* If line ends prematurely, add space to the end.  */
Jim Blandy's avatar
Jim Blandy committed
876
  if (col < goal && !NILP (force))
877
    Findent_to (make_number (col = goal), Qnil);
Jim Blandy's avatar
Jim Blandy committed
878 879

  last_known_column = col;
880
  last_known_column_point = PT;
Jim Blandy's avatar
Jim Blandy committed
881 882
  last_known_column_modified = MODIFF;

883
  XSETFASTINT (val, col);
Jim Blandy's avatar
Jim Blandy committed
884 885 886
  return val;
}

887 888
/* compute_motion: compute buffer posn given screen posn and vice versa */

Jim Blandy's avatar
Jim Blandy committed
889 890 891 892 893
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),
894 895 896
   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
897

898 899 900 901 902 903
   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
904 905 906 907
   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
908 909 910
   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
911 912 913

   compute_motion returns a pointer to a struct position.  The bufpos
   member gives the buffer position at the end of the scan, and hpos
914 915 916 917 918 919 920 921
   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
922 923 924 925 926 927

   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
928
   TOHPOS.
Jim Blandy's avatar
Jim Blandy committed
929 930 931 932

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

	window_width - 1
933
	 - (has_vertical_scroll_bars
Karl Heuer's avatar
Karl Heuer committed
934
	    ? FRAME_SCROLL_BAR_COLS (XFRAME (window->frame))
935
	    : (window_width + window_left != frame_width))
Jim Blandy's avatar
Jim Blandy committed
936 937 938 939

	where
	  window_width is XFASTINT (w->width),
	  window_left is XFASTINT (w->left),
940 941
	  has_vertical_scroll_bars is
	    FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (WINDOW_FRAME (window)))
942
	  and frame_width = FRAME_WIDTH (XFRAME (window->frame))
Jim Blandy's avatar
Jim Blandy committed
943

Karl Heuer's avatar
Karl Heuer committed
944 945
   Or you can let window_internal_width do this all for you, and write:
	window_internal_width (w) - 1
946 947

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

struct position *
952
compute_motion (from, fromvpos, fromhpos, did_motion, to, tovpos, tohpos, width, hscroll, tab_offset, win)
Jim Blandy's avatar
Jim Blandy committed
953
     int from, fromvpos, fromhpos, to, tovpos, tohpos;
954
     int did_motion;
Jim Blandy's avatar
Jim Blandy committed
955 956
     register int width;
     int hscroll, tab_offset;
957
     struct window *win;
Jim Blandy's avatar
Jim Blandy committed
958
{
Jim Blandy's avatar
Jim Blandy committed
959 960 961
  register int hpos = fromhpos;
  register int vpos = fromvpos;

Jim Blandy's avatar
Jim Blandy committed
962 963 964
  register int pos;
  register int c;
  register int tab_width = XFASTINT (current_buffer->tab_width);
Jim Blandy's avatar
Jim Blandy committed
965
  register int ctl_arrow = !NILP (current_buffer->ctl_arrow);
966
  register struct Lisp_Char_Table *dp = window_display_table (win);
Jim Blandy's avatar
Jim Blandy committed
967
  int selective
968
    = (INTEGERP (current_buffer->selective_display)
969 970
       ? XINT (current_buffer->selective_display)
       : !NILP (current_buffer->selective_display) ? -1 : 0);
971
  int prev_hpos = 0;
Jim Blandy's avatar
Jim Blandy committed
972
  int selective_rlen
973
    = (selective && dp && VECTORP (DISP_INVIS_VECTOR (dp))
974
       ? XVECTOR (DISP_INVIS_VECTOR (dp))->size : 0);
975 976 977
  /* 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
978

979 980
  /* For computing runs of characters with similar widths.
     Invariant: width_run_width is zero, or all the characters
981
     from width_run_start to width_run_end have a fixed width of
982 983 984 985 986
     width_run_width.  */
  int width_run_start = from;
  int width_run_end   = from;
  int width_run_width = 0;
  Lisp_Object *width_table;
987
  Lisp_Object buffer;
988 989 990

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

993 994 995 996 997 998 999
  int multibyte = !NILP (current_buffer->enable_multibyte_characters);
  int wide_column = 0;		/* Set to 1 when a previous character
				   is wide-colomn.  */
  int prev_pos;			/* Previous buffer position.  */
  int contin_hpos;		/* HPOS of last column of continued line.  */
  int prev_tab_offset;		/* Previous tab offset.  */

1000
  XSETBUFFER (buffer, current_buffer);
1001
  XSETWINDOW (window, win);
1002

1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
  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;

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

1015 1016 1017
  pos = prev_pos = from;
  contin_hpos = 0;
  prev_tab_offset = tab_offset;
1018 1019 1020
  while (1)
    {
      while (pos == next_boundary)
1021
	{
1022 1023
	  int newpos;

1024 1025 1026 1027 1028 1029
	  /* 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
1030
	       strings must not contain TAB;
1031 1032
	       if we want to relax that restriction, something will have
	       to be changed here.  */
1033 1034 1035 1036 1037
	    {
	      unsigned char *ovstr;
	      int ovlen = overlay_strings (pos, win, &ovstr);
	      hpos += (multibyte ? strwidth (ovstr, ovlen) : ovlen);
	    }
1038 1039 1040 1041
	  did_motion = 0;

	  if (pos >= to)
	    break;
1042

1043 1044 1045 1046
	  /* Advance POS past invisible characters
	     (but not necessarily all that there are here),
	     and store in next_boundary the next position where
	     we need to call skip_invisible.  */
1047 1048 1049 1050 1051 1052
	  newpos = skip_invisible (pos, &next_boundary, to, window);

	  if (newpos >= to)
	    goto after_loop;

	  pos = newpos;
1053
	}
1054 1055

      /* Handle right margin.  */
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
      /* Note on a wide-column character.

	 Characters are classified into the following three categories
	 according to the width (columns occupied on screen).

	 (1) single-column character: ex. `a'
	 (2) multi-column character: ex. `^A', TAB, `\033'
	 (3) wide-column character: ex. Japanese character, Chinese character
	     (In the following example, `W_' stands for them.)

	 Multi-column characters can be divided around the right margin,
	 but wide-column characters cannot.

	 NOTE:

	 (*) The cursor is placed on the next character after the point.

	     ----------
	     abcdefghi\
	     j        ^---- next after the point
	     ^---  next char. after the point.
	     ----------
	              In case of sigle-column character

	     ----------
	     abcdefgh\\
	     033     ^----  next after the point, next char. after the point.
	     ----------
	              In case of multi-column character

	     ----------
	     abcdefgh\\
	     W_      ^---- next after the point
	     ^----  next char. after the point.
	     ----------
	              In case of wide-column character 

	 The problem here is continuation at a wide-column character.
	 In this case, the line may shorter less than WIDTH.
	 And we find the continuation AFTER it occurs.

       */

      if (hpos > width)
1100 1101 1102 1103 1104 1105 1106
	{
	  if (hscroll
	      || (truncate_partial_width_windows
		  && width + 1 < FRAME_WIDTH (XFRAME (WINDOW_FRAME (win))))
	      || !NILP (current_buffer->truncate_lines))
	    {
	      /* Truncating: skip to newline.  */
1107 1108
	      if (pos <= to)  /* This IF is needed because we may past TO */
		pos = find_before_next_newline (pos, to, 1);
1109
	      hpos = width;
1110 1111 1112 1113 1114
	      /* If we just skipped next_boundary,
		 loop around in the main while
		 and handle it.  */
	      if (pos >= next_boundary)
		next_boundary = pos + 1;
1115 1116
	      prev_hpos = width;
	      prev_tab_offset = tab_offset;
1117 1118 1119 1120
	    }
	  else
	    {
	      /* Continuing.  */
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
	      /* Remember the previous value.  */
	      prev_tab_offset = tab_offset;

	      if (wide_column)
		{
		  hpos -= prev_hpos;
		  tab_offset += prev_hpos;
		}
	      else
		{
		  tab_offset += width;
		  hpos -= width;
		}
	      vpos++;
	      contin_hpos = prev_hpos;
	      prev_hpos = 0;
1137 1138 1139 1140
	    }
	}

      /* Stop if past the target buffer position or screen position.  */
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
      if (pos > to)
	{
	  /* Go back to the previous position.  */
	  pos = prev_pos;
	  hpos = prev_hpos;
	  tab_offset = prev_tab_offset;

	  /* NOTE on contin_hpos, hpos, and prev_hpos.

	     ----------
	     abcdefgh\\
	     W_      ^----  contin_hpos
	     | ^-----  hpos
	     \---- prev_hpos
	     ----------
	   */

	  if (contin_hpos && prev_hpos == 0
	      && contin_hpos < width && !wide_column)
	    {
	      /* Line breaking occurs in the middle of multi-column
		 character.  Go back to previous line.  */
	      hpos = contin_hpos;
	      vpos = vpos - 1;
	    }
	  else if (c == '\n')
	    /* If previous character is NEWLINE,
	       set VPOS back to previous line */
	    vpos = vpos - 1;
	  break;
	}

      if (vpos > tovpos || vpos == tovpos && hpos >= tohpos)
	{
	  if (contin_hpos && prev_hpos == 0
1176
	      && ((hpos > tohpos && contin_hpos == width) || wide_column))
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
	    { /* Line breaks because we can't put the character at the
		 previous line any more.  It is not the multi-column
		 character continued in middle.  Go back to previous
		 buffer position, screen position, and set tab offset
		 to previous value.  It's the beginning of the
		 line.  */
	      pos = prev_pos;
	      hpos = prev_hpos;
	      tab_offset = prev_tab_offset;
	    }
	  break;
	}
      if (pos == ZV) /* We cannot go beyond ZV.  Stop here. */
1190 1191 1192
	break;

      prev_hpos = hpos;
1193 1194
      prev_pos = pos;
      wide_column = 0;
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226

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

1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
              /* 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;
                }
<