indent.c 25.4 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Indentation functions.
Jim Blandy's avatar
Jim Blandy committed
2
   Copyright (C) 1985, 1986, 1987, 1988, 1993 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"
Jim Blandy's avatar
Jim Blandy committed
31 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 60 61 62 63 64 65 66 67 68 69 70 71 72 73

/* 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;
  if (XTYPE (thisbuf) == Lisp_Vector
      && XVECTOR (thisbuf)->size == DISP_TABLE_SIZE)
    return XVECTOR (thisbuf);
  if (XTYPE (Vstandard_display_table) == Lisp_Vector
      && XVECTOR (Vstandard_display_table)->size == DISP_TABLE_SIZE)
    return XVECTOR (Vstandard_display_table);
  return 0;
}

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
74 75
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
76 77 78 79 80 81 82 83 84
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;
  XFASTINT (temp) = current_column ();
  return temp;
}

Jim Blandy's avatar
Jim Blandy committed
85 86 87 88 89 90 91
/* Cancel any recorded value of the horizontal position.  */

invalidate_current_column ()
{
  last_known_column_point = 0;
}

Jim Blandy's avatar
Jim Blandy committed
92 93 94 95 96 97 98 99 100
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
101
  int ctl_arrow = !NILP (current_buffer->ctl_arrow);
Jim Blandy's avatar
Jim Blandy committed
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
  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;

120
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140

  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
141
	  && (dp == 0 || XTYPE (DISP_CHAR_VECTOR (dp, c)) != Lisp_Vector))
Jim Blandy's avatar
Jim Blandy committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
	{
	  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;
	}
158 159
      else if (dp != 0 && XTYPE (DISP_CHAR_VECTOR (dp, c)) == Lisp_Vector)
	col += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
Jim Blandy's avatar
Jim Blandy committed
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
      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
190
  if (NILP (minimum))
Jim Blandy's avatar
Jim Blandy committed
191 192 193 194 195 196 197 198 199 200
    XFASTINT (minimum) = 0;
  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);

201
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
202 203 204 205 206 207 208 209 210 211 212 213 214 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 244 245 246

  if (indent_tabs_mode)
    {
      Lisp_Object n;
      XFASTINT (n) = mincol / tab_width - fromcol / tab_width;
      if (XFASTINT (n) != 0)
	{
	  Finsert_char (make_number ('\t'), n);

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

  XFASTINT (col) = mincol - fromcol;
  Finsert_char (make_number (' '), col);

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

  XSETINT (col, mincol);
  return col;
}

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;

  XFASTINT (val) = position_indentation (find_next_newline (point, -1));
  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;
  
247
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
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
  
  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;
	}
    }
}
274 275 276 277 278 279 280 281 282 283 284 285

/* 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')
    pos = find_next_newline (pos - 1, -1);
  return (position_indentation (pos) >= column);
}
Jim Blandy's avatar
Jim Blandy committed
286 287 288 289 290 291 292

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\
293 294
and horizontal scrolling has no effect.\n\
\n\
Jim Blandy's avatar
Jim Blandy committed
295 296 297 298 299 300 301 302 303 304 305 306 307
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
308
  register int ctl_arrow = !NILP (current_buffer->ctl_arrow);
Jim Blandy's avatar
Jim Blandy committed
309 310 311 312 313 314
  register struct Lisp_Vector *dp = buffer_display_table ();

  Lisp_Object val;
  int prev_col;
  int c;

315
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
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
  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;
	}
345 346
      else if (dp != 0 && XTYPE (DISP_CHAR_VECTOR (dp, c)) == Lisp_Vector)
	col += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
Jim Blandy's avatar
Jim Blandy committed
347
      else if (ctl_arrow && (c < 040 || c == 0177))
348
        col += 2;
Jim Blandy's avatar
Jim Blandy committed
349
      else if (c < 040 || c >= 0177)
350
        col += 4;
Jim Blandy's avatar
Jim Blandy committed
351 352 353 354 355 356 357 358
      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
359
  if (!NILP (force) && col > goal && c == '\t' && prev_col < goal)
Jim Blandy's avatar
Jim Blandy committed
360
    {
Jim Blandy's avatar
Jim Blandy committed
361 362
      int old_point;

Jim Blandy's avatar
Jim Blandy committed
363
      del_range (point - 1, point);
Jim Blandy's avatar
Jim Blandy committed
364 365 366 367
      Findent_to (make_number (goal), Qnil);
      old_point = point;
      Findent_to (make_number (col), Qnil);
      SET_PT (old_point);
368 369
      /* Set the last_known... vars consistently.  */
      col = goal;
Jim Blandy's avatar
Jim Blandy committed
370 371 372
    }

  /* If line ends prematurely, add space to the end.  */
Jim Blandy's avatar
Jim Blandy committed
373
  if (col < goal && !NILP (force))
374
    Findent_to (make_number (col = goal), Qnil);
Jim Blandy's avatar
Jim Blandy committed
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394

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

  XFASTINT (val) = col;
  return val;
}

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),
   and return the ending buffer position and screen location.

   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
395 396 397
   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
398 399 400 401 402 403

   compute_motion returns a pointer to a struct position.  The bufpos
   member gives the buffer position at the end of the scan, and hpos
   and vpos give its cartesian location.  I'm not clear on what the
   other members are.

Karl Heuer's avatar
Karl Heuer committed
404 405 406 407 408
   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
409 410 411 412 413 414 415 416 417 418
   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
   TOHPOS.  

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

	window_width - 1
419 420
	 - (has_vertical_scroll_bars
	    ? VERTICAL_SCROLL_BAR_WIDTH
421
	    : (window_width + window_left != frame_width))
Jim Blandy's avatar
Jim Blandy committed
422 423 424 425

	where
	  window_width is XFASTINT (w->width),
	  window_left is XFASTINT (w->left),
426 427
	  has_vertical_scroll_bars is
	    FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (WINDOW_FRAME (window)))
428
	  and frame_width = FRAME_WIDTH (XFRAME (window->frame))
Jim Blandy's avatar
Jim Blandy committed
429

Karl Heuer's avatar
Karl Heuer committed
430 431
   Or you can let window_internal_width do this all for you, and write:
	window_internal_width (w) - 1
432 433

   The `-1' accounts for the continuation-line backslashes; the rest
Karl Heuer's avatar
Karl Heuer committed
434
   accounts for window borders if the window is split horizontally, and
Karl Heuer's avatar
Karl Heuer committed
435
   the scroll bars if they are turned on.  */
Jim Blandy's avatar
Jim Blandy committed
436 437 438 439 440 441 442

struct position *
compute_motion (from, fromvpos, fromhpos, to, tovpos, tohpos, width, hscroll, tab_offset)
     int from, fromvpos, fromhpos, to, tovpos, tohpos;
     register int width;
     int hscroll, tab_offset;
{
Jim Blandy's avatar
Jim Blandy committed
443 444 445
  register int hpos = fromhpos;
  register int vpos = fromvpos;

Jim Blandy's avatar
Jim Blandy committed
446 447 448
  register int pos;
  register int c;
  register int tab_width = XFASTINT (current_buffer->tab_width);
Jim Blandy's avatar
Jim Blandy committed
449
  register int ctl_arrow = !NILP (current_buffer->ctl_arrow);
Jim Blandy's avatar
Jim Blandy committed
450 451 452 453
  register struct Lisp_Vector *dp = buffer_display_table ();
  int selective
    = XTYPE (current_buffer->selective_display) == Lisp_Int
      ? XINT (current_buffer->selective_display)
Jim Blandy's avatar
Jim Blandy committed
454
	: !NILP (current_buffer->selective_display) ? -1 : 0;
455
  int prev_vpos, prev_hpos = 0;
Jim Blandy's avatar
Jim Blandy committed
456
  int selective_rlen
457 458
    = (selective && dp && XTYPE (DISP_INVIS_VECTOR (dp)) == Lisp_Vector
       ? XVECTOR (DISP_INVIS_VECTOR (dp))->size : 0);
459 460 461 462 463
#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
464

465
  if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
Jim Blandy's avatar
Jim Blandy committed
466
  for (pos = from; pos < to; pos++)
Jim Blandy's avatar
Jim Blandy committed
467
    {
Jim Blandy's avatar
Jim Blandy committed
468 469 470 471 472 473 474 475
      /* Stop if past the target screen position.  */
      if (vpos > tovpos
	  || (vpos == tovpos && hpos >= tohpos))
	break;

      prev_vpos = vpos;
      prev_hpos = hpos;

476 477 478 479
#ifdef USE_TEXT_PROPERTIES
      /* if the `invisible' property is set, we can skip to
	 the next property change */
      while (pos == next_invisible && pos < to)
480 481
	{
	  XFASTINT (position) = pos;
482
	  prop = Fget_char_property (position,
483 484 485 486 487 488 489
				     Qinvisible,
				     Fcurrent_buffer ());
	  {
	    Lisp_Object end, limit;

	    /* This is just an estimate to give reasonable
	       performance; nothing should go wrong if it is too small.  */
490 491 492
	    limit = Fnext_overlay_change (position);
	    if (XFASTINT (limit) > pos + 100)
	      XFASTINT (limit) = pos + 100;
493 494 495 496 497 498 499 500 501 502
	    end = Fnext_single_property_change (position, Qinvisible,
						Fcurrent_buffer (), limit);
	    if (INTEGERP (end))
	      next_invisible = XINT (end);
	    else
	      next_invisible = to;
	    if (! NILP (prop))
	      pos = next_invisible;
	  }
	}
503 504 505
      if (pos >= to)
	break;
#endif
Jim Blandy's avatar
Jim Blandy committed
506 507
      c = FETCH_CHAR (pos);
      if (c >= 040 && c < 0177
508
	  && (dp == 0 || XTYPE (DISP_CHAR_VECTOR (dp, c)) != Lisp_Vector))
Jim Blandy's avatar
Jim Blandy committed
509
	hpos++;
Jim Blandy's avatar
Jim Blandy committed
510 511
      else if (c == '\t')
	{
Jim Blandy's avatar
Jim Blandy committed
512 513 514 515 516 517
	  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);
Jim Blandy's avatar
Jim Blandy committed
518 519 520
	}
      else if (c == '\n')
	{
521
	  if (selective > 0 && indented_beyond_p (pos + 1, selective))
Jim Blandy's avatar
Jim Blandy committed
522 523 524 525
	    {
	      /* Skip any number of invisible lines all at once */
	      do
		{
Jim Blandy's avatar
Jim Blandy committed
526
		  while (++pos < to && FETCH_CHAR (pos) != '\n');
Jim Blandy's avatar
Jim Blandy committed
527
		}
528
	      while (pos < to && indented_beyond_p (pos + 1, selective));
Karl Heuer's avatar
Karl Heuer committed
529
	      pos--;		/* Reread the newline on the next pass.  */
Jim Blandy's avatar
Jim Blandy committed
530 531 532
	      /* Allow for the " ..." that is displayed for them. */
	      if (selective_rlen)
		{
Jim Blandy's avatar
Jim Blandy committed
533 534 535
		  hpos += selective_rlen;
		  if (hpos >= width)
		    hpos = width;
Jim Blandy's avatar
Jim Blandy committed
536
		}
537
	      /* We have skipped the invis text, but not the newline after.  */
Jim Blandy's avatar
Jim Blandy committed
538 539
	    }
	  else
Jim Blandy's avatar
Jim Blandy committed
540 541 542 543
	    {
	      /* A visible line.  */
	      vpos++;
	      hpos = 0;
544
	      hpos -= hscroll;
Karl Heuer's avatar
Karl Heuer committed
545
	      if (hscroll > 0) hpos++; /* Truncation glyph on column 0 */
546 547
	      tab_offset = 0;
	    }
Jim Blandy's avatar
Jim Blandy committed
548 549 550 551 552
	}
      else if (c == CR && selective < 0)
	{
	  /* In selective display mode,
	     everything from a ^M to the end of the line is invisible */
Jim Blandy's avatar
Jim Blandy committed
553 554
	  while (pos < to && FETCH_CHAR (pos) != '\n') pos++;
	  /* Stop *before* the real newline.  */
Jim Blandy's avatar
Jim Blandy committed
555 556 557 558
	  pos--;
	  /* Allow for the " ..." that is displayed for them. */
	  if (selective_rlen)
	    {
Jim Blandy's avatar
Jim Blandy committed
559 560 561
	      hpos += selective_rlen;
	      if (hpos >= width)
		hpos = width;
Jim Blandy's avatar
Jim Blandy committed
562 563
	    }
	}
564 565
      else if (dp != 0 && XTYPE (DISP_CHAR_VECTOR (dp, c)) == Lisp_Vector)
	hpos += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
Jim Blandy's avatar
Jim Blandy committed
566
      else
Jim Blandy's avatar
Jim Blandy committed
567
	hpos += (ctl_arrow && c < 0200) ? 2 : 4;
Jim Blandy's avatar
Jim Blandy committed
568

Jim Blandy's avatar
Jim Blandy committed
569 570 571 572
      /* Handle right margin.  */
      if (hpos >= width
	  && (hpos > width
	      || (pos < ZV - 1
Jim Blandy's avatar
Jim Blandy committed
573 574
		  && FETCH_CHAR (pos + 1) != '\n')))
	{
Jim Blandy's avatar
Jim Blandy committed
575 576
	  if (vpos > tovpos
	      || (vpos == tovpos && hpos >= tohpos))
Jim Blandy's avatar
Jim Blandy committed
577 578 579
	    break;
	  if (hscroll
	      || (truncate_partial_width_windows
Jim Blandy's avatar
Jim Blandy committed
580
		  && width + 1 < FRAME_WIDTH (selected_frame))
Jim Blandy's avatar
Jim Blandy committed
581
	      || !NILP (current_buffer->truncate_lines))
Jim Blandy's avatar
Jim Blandy committed
582
	    {
Jim Blandy's avatar
Jim Blandy committed
583 584
	      /* Truncating: skip to newline.  */
	      while (pos < to && FETCH_CHAR (pos) != '\n') pos++;
Jim Blandy's avatar
Jim Blandy committed
585
	      pos--;
586
	      hpos = width;
Jim Blandy's avatar
Jim Blandy committed
587 588 589
	    }
	  else
	    {
Jim Blandy's avatar
Jim Blandy committed
590 591 592
	      /* Continuing.  */
	      vpos++;
	      hpos -= width;
Jim Blandy's avatar
Jim Blandy committed
593 594 595 596 597 598 599
	      tab_offset += width;
	    }

	}
    }

  val_compute_motion.bufpos = pos;
Jim Blandy's avatar
Jim Blandy committed
600 601 602
  val_compute_motion.hpos = hpos;
  val_compute_motion.vpos = vpos;
  val_compute_motion.prevhpos = prev_hpos;
Jim Blandy's avatar
Jim Blandy committed
603 604 605

  /* Nonzero if have just continued a line */
  val_compute_motion.contin
Jim Blandy's avatar
Jim Blandy committed
606 607 608
    = (pos != from
       && (val_compute_motion.vpos != prev_vpos)
       && c != '\n');
Jim Blandy's avatar
Jim Blandy committed
609 610 611 612

  return &val_compute_motion;
}

Karl Heuer's avatar
Karl Heuer committed
613 614 615
#if 0 /* The doc string is too long for some compilers,
	 but make-docfile can find it in this comment.  */
DEFUN ("compute-motion", Ffoo, Sfoo, 6, 6, 0,
616 617 618 619 620 621 622 623 624 625
  "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\
There are two additional arguments:\n\
\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
626 627
This is usually the value returned by `window-width', less one (to allow\n\
for the continuation glyph).\n\
628 629 630 631 632 633
\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
634
If OFFSETS is nil, HSCROLL and TAB-OFFSET are assumed to be zero.\n\
635 636
\n\
The value is a list of five elements:\n\
637
  (POS HPOS VPOS PREVHPOS CONTIN)\n\
638 639 640 641 642 643 644 645 646 647 648 649
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.")
Karl Heuer's avatar
Karl Heuer committed
650 651
#endif

652
DEFUN ("compute-motion", Fcompute_motion, Scompute_motion, 6, 6, 0,
Karl Heuer's avatar
Karl Heuer committed
653
  0)
654 655 656 657 658 659 660 661
  (from, frompos, to, topos, width, offsets)
     Lisp_Object from, frompos, to, topos;
     Lisp_Object width, offsets;
{
  Lisp_Object bufpos, hpos, vpos, prevhpos, contin;
  struct position *pos;
  int hscroll, tab_offset;

Karl Heuer's avatar
Karl Heuer committed
662
  CHECK_NUMBER_COERCE_MARKER (from, 0);
663
  CHECK_CONS (frompos, 0);
Karl Heuer's avatar
Karl Heuer committed
664 665 666
  CHECK_NUMBER (XCONS (frompos)->car, 0);
  CHECK_NUMBER (XCONS (frompos)->cdr, 0);
  CHECK_NUMBER_COERCE_MARKER (to, 0);
667
  CHECK_CONS (topos, 0);
Karl Heuer's avatar
Karl Heuer committed
668 669 670
  CHECK_NUMBER (XCONS (topos)->car, 0);
  CHECK_NUMBER (XCONS (topos)->cdr, 0);
  CHECK_NUMBER (width, 0);
671 672 673
  if (!NILP (offsets))
    {
      CHECK_CONS (offsets, 0);
Karl Heuer's avatar
Karl Heuer committed
674 675
      CHECK_NUMBER (XCONS (offsets)->car, 0);
      CHECK_NUMBER (XCONS (offsets)->cdr, 0);
676 677 678 679 680 681 682 683 684 685 686 687 688
      hscroll = XINT (XCONS (offsets)->car);
      tab_offset = XINT (XCONS (offsets)->cdr);
    }
  else
    hscroll = tab_offset = 0;

  pos = compute_motion (XINT (from), XINT (XCONS (frompos)->cdr),
			XINT (XCONS (frompos)->car),
			XINT (to), XINT (XCONS (topos)->cdr),
			XINT (XCONS (topos)->car),
			XINT (width), hscroll, tab_offset);

  XFASTINT (bufpos) = pos->bufpos;
689
  XSET (hpos, Lisp_Int, pos->hpos);
690
  XSET (vpos, Lisp_Int, pos->vpos);
691
  XSET (prevhpos, Lisp_Int, pos->prevhpos);
692 693 694 695 696 697 698 699

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

}
Jim Blandy's avatar
Jim Blandy committed
700 701 702 703 704 705 706 707 708 709 710 711 712

/* Return the column of position POS in window W's buffer,
   rounded down to a multiple of the internal width of W.
   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;
{
  int opoint = point;
  int col;
713
  int width = window_internal_width (w) - 1;
Jim Blandy's avatar
Jim Blandy committed
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743

  if (pos == BEGV || FETCH_CHAR (pos - 1) == '\n')
    return 0;
  SET_PT (pos);
  col = current_column ();
  SET_PT (opoint);
  return col - (col % width);
}

/* start_hpos is the hpos of the first character of the buffer:
   zero except for the minibuffer window,
   where it is the width of the prompt.  */

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;
  register int prevline;
  register int first;
  int lmargin = hscroll > 0 ? 1 - hscroll : 0;
  int selective
    = XTYPE (current_buffer->selective_display) == Lisp_Int
      ? XINT (current_buffer->selective_display)
Jim Blandy's avatar
Jim Blandy committed
744
	: !NILP (current_buffer->selective_display) ? -1 : 0;
Jim Blandy's avatar
Jim Blandy committed
745 746 747 748 749 750 751 752 753 754
  int start_hpos = (EQ (window, minibuf_window) ? minibuf_prompt_width : 0);

 retry:
  if (vtarget > vpos)
    {
      /* 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')
	{
	  prevline = find_next_newline (from, -1);
755 756
	  while (prevline > BEGV
		 && ((selective > 0
757
		      && indented_beyond_p (prevline, selective))
758 759
#ifdef USE_TEXT_PROPERTIES
		     /* watch out for newlines with `invisible' property */
760
		     || ! NILP (Fget_char_property (XFASTINT (prevline),
761
						    Qinvisible,
762
						    window))
763 764
#endif
		 ))
Jim Blandy's avatar
Jim Blandy committed
765 766 767
	    prevline = find_next_newline (prevline - 1, -1);
	  pos = *compute_motion (prevline, 0,
				 lmargin + (prevline == 1 ? start_hpos : 0),
Jim Blandy's avatar
Jim Blandy committed
768
				 from, 1 << (INTBITS - 2), 0,
Jim Blandy's avatar
Jim Blandy committed
769 770 771 772 773 774 775 776
				 width, hscroll, 0);
	}
      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
777
			     ZV, vtarget, - (1 << (INTBITS - 2)),
Jim Blandy's avatar
Jim Blandy committed
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
			     width, hscroll, pos.vpos * width);
    }

  /* 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)
    {
      prevline = from;
      while (1)
	{
	  prevline = find_next_newline (prevline - 1, -1);
	  if (prevline == BEGV
793
	      || ((selective <= 0
794
		   || ! indented_beyond_p (prevline, selective))
795 796
#ifdef USE_TEXT_PROPERTIES
		  /* watch out for newlines with `invisible' property */
797
		  && NILP (Fget_char_property (XFASTINT (prevline),
798
					       Qinvisible,
799
					       window))
800 801
#endif
		  ))
Jim Blandy's avatar
Jim Blandy committed
802 803 804 805
	    break;
	}
      pos = *compute_motion (prevline, 0,
			     lmargin + (prevline == 1 ? start_hpos : 0),
Jim Blandy's avatar
Jim Blandy committed
806
			     from, 1 << (INTBITS - 2), 0,
Jim Blandy's avatar
Jim Blandy committed
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
			     width, hscroll, 0);
      vpos -= pos.vpos;
      first = 0;
      from = prevline;
    }

  /* 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;
    }
  
  /* Otherwise find the correct spot by moving down */
  goto retry;
}

830
DEFUN ("vertical-motion", Fvertical_motion, Svertical_motion, 1, 2, 0,
Jim Blandy's avatar
Jim Blandy committed
831 832
  "Move to start of screen line LINES lines down.\n\
If LINES is negative, this is moving up.\n\
833 834
The optional second argument WINDOW specifies the window\n\
 to use for computations.\n\
Jim Blandy's avatar
Jim Blandy committed
835 836 837 838
Sets point to position found; this may be start of line\n\
 or just the start of a continuation line.\n\
Returns number of lines moved; may be closer to zero than LINES\n\
 if beginning or end of buffer was reached.")
839 840
  (lines, window)
     Lisp_Object lines, window;
Jim Blandy's avatar
Jim Blandy committed
841 842 843
{
  struct position pos;
  register struct window *w = XWINDOW (selected_window);
844
  int width = window_internal_width (w) - 1;
Jim Blandy's avatar
Jim Blandy committed
845 846

  CHECK_NUMBER (lines, 0);
847 848 849 850
  if (! NILP (window))
    CHECK_WINDOW (window, 0);
  else
    XSET (window, Lisp_Window, selected_window);
Jim Blandy's avatar
Jim Blandy committed
851 852 853

  pos = *vmotion (point, XINT (lines), width,
		  /* Not XFASTINT since perhaps could be negative */
854
		  XINT (w->hscroll), window);
Jim Blandy's avatar
Jim Blandy committed
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871

  SET_PT (pos.bufpos);
  return make_number (pos.vpos);
}

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);
872
  defsubr (&Scompute_motion);
Jim Blandy's avatar
Jim Blandy committed
873
}