(Vafter_change_functions, Vbefore_change_functions): Declared.
[bpt/emacs.git] / src / indent.c
CommitLineData
993b6404 1/* Indentation functions.
c6c5df7f 2 Copyright (C) 1985, 1986, 1987, 1988, 1993 Free Software Foundation, Inc.
993b6404
JB
3
4This file is part of GNU Emacs.
5
6GNU Emacs is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
8the Free Software Foundation; either version 1, or (at your option)
9any later version.
10
11GNU Emacs is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Emacs; see the file COPYING. If not, write to
18the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
19
20
18160b98 21#include <config.h>
993b6404
JB
22#include "lisp.h"
23#include "buffer.h"
24#include "indent.h"
502b9b64 25#include "frame.h"
993b6404
JB
26#include "window.h"
27#include "termchar.h"
28#include "termopts.h"
29#include "disptab.h"
5a05d3d2 30#include "intervals.h"
993b6404
JB
31
32/* Indentation can insert tabs if this is non-zero;
33 otherwise always uses spaces */
34int indent_tabs_mode;
35
36#define min(a, b) ((a) < (b) ? (a) : (b))
37#define max(a, b) ((a) > (b) ? (a) : (b))
38
39#define CR 015
40
41/* These three values memoize the current column to avoid recalculation */
42/* Some things in set last_known_column_point to -1
43 to mark the memoized value as invalid */
44/* Last value returned by current_column */
45int last_known_column;
46/* Value of point when current_column was called */
47int last_known_column_point;
48/* Value of MODIFF when current_column was called */
49int last_known_column_modified;
50
993b6404
JB
51/* Get the display table to use for the current buffer. */
52
53struct Lisp_Vector *
54buffer_display_table ()
55{
56 Lisp_Object thisbuf;
57
58 thisbuf = current_buffer->display_table;
59 if (XTYPE (thisbuf) == Lisp_Vector
60 && XVECTOR (thisbuf)->size == DISP_TABLE_SIZE)
61 return XVECTOR (thisbuf);
62 if (XTYPE (Vstandard_display_table) == Lisp_Vector
63 && XVECTOR (Vstandard_display_table)->size == DISP_TABLE_SIZE)
64 return XVECTOR (Vstandard_display_table);
65 return 0;
66}
67\f
68DEFUN ("current-column", Fcurrent_column, Scurrent_column, 0, 0, 0,
69 "Return the horizontal position of point. Beginning of line is column 0.\n\
70This is calculated by adding together the widths of all the displayed\n\
71representations of the character between the start of the previous line\n\
72and point. (eg control characters will have a width of 2 or 4, tabs\n\
73will have a variable width)\n\
502b9b64
JB
74Ignores finite width of frame, which means that this function may return\n\
75values greater than (frame-width).\n\
993b6404
JB
76Whether the line is visible (if `selective-display' is t) has no effect;\n\
77however, ^M is treated as end of line when `selective-display' is t.")
78 ()
79{
80 Lisp_Object temp;
81 XFASTINT (temp) = current_column ();
82 return temp;
83}
84
e74928fc
JB
85/* Cancel any recorded value of the horizontal position. */
86
87invalidate_current_column ()
88{
89 last_known_column_point = 0;
90}
91
993b6404
JB
92int
93current_column ()
94{
95 register int col;
96 register unsigned char *ptr, *stop;
97 register int tab_seen;
98 int post_tab;
99 register int c;
100 register int tab_width = XINT (current_buffer->tab_width);
56a98455 101 int ctl_arrow = !NILP (current_buffer->ctl_arrow);
993b6404
JB
102 register struct Lisp_Vector *dp = buffer_display_table ();
103 int stopchar;
104
105 if (point == last_known_column_point
106 && MODIFF == last_known_column_modified)
107 return last_known_column;
108
109 /* Make a pointer for decrementing through the chars before point. */
110 ptr = &FETCH_CHAR (point - 1) + 1;
111 /* Make a pointer to where consecutive chars leave off,
112 going backwards from point. */
113 if (point == BEGV)
114 stop = ptr;
115 else if (point <= GPT || BEGV > GPT)
116 stop = BEGV_ADDR;
117 else
118 stop = GAP_END_ADDR;
119
ccdcf1f5 120 if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
993b6404
JB
121
122 col = 0, tab_seen = 0, post_tab = 0;
123
124 while (1)
125 {
126 if (ptr == stop)
127 {
128 /* We stopped either for the beginning of the buffer
129 or for the gap. */
130 if (ptr == BEGV_ADDR)
131 break;
132 /* It was the gap. Jump back over it. */
133 stop = BEGV_ADDR;
134 ptr = GPT_ADDR;
135 /* Check whether that brings us to beginning of buffer. */
136 if (BEGV >= GPT) break;
137 }
138
139 c = *--ptr;
140 if (c >= 040 && c < 0177
dea4d2e6 141 && (dp == 0 || XTYPE (DISP_CHAR_VECTOR (dp, c)) != Lisp_Vector))
993b6404
JB
142 {
143 col++;
144 }
145 else if (c == '\n')
146 break;
147 else if (c == '\r' && EQ (current_buffer->selective_display, Qt))
148 break;
149 else if (c == '\t')
150 {
151 if (tab_seen)
152 col = ((col + tab_width) / tab_width) * tab_width;
153
154 post_tab += col;
155 col = 0;
156 tab_seen = 1;
157 }
dea4d2e6
RS
158 else if (dp != 0 && XTYPE (DISP_CHAR_VECTOR (dp, c)) == Lisp_Vector)
159 col += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
993b6404
JB
160 else
161 col += (ctl_arrow && c < 0200) ? 2 : 4;
162 }
163
164 if (tab_seen)
165 {
166 col = ((col + tab_width) / tab_width) * tab_width;
167 col += post_tab;
168 }
169
170 last_known_column = col;
171 last_known_column_point = point;
172 last_known_column_modified = MODIFF;
173
174 return col;
175}
176\f
177
178DEFUN ("indent-to", Findent_to, Sindent_to, 1, 2, "NIndent to column: ",
179 "Indent from point with tabs and spaces until COLUMN is reached.\n\
180Optional second argument MIN says always do at least MIN spaces\n\
181even if that goes past COLUMN; by default, MIN is zero.")
182 (col, minimum)
183 Lisp_Object col, minimum;
184{
185 int mincol;
186 register int fromcol;
187 register int tab_width = XINT (current_buffer->tab_width);
188
189 CHECK_NUMBER (col, 0);
56a98455 190 if (NILP (minimum))
993b6404
JB
191 XFASTINT (minimum) = 0;
192 CHECK_NUMBER (minimum, 1);
193
194 fromcol = current_column ();
195 mincol = fromcol + XINT (minimum);
196 if (mincol < XINT (col)) mincol = XINT (col);
197
198 if (fromcol == mincol)
199 return make_number (mincol);
200
ccdcf1f5 201 if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
993b6404
JB
202
203 if (indent_tabs_mode)
204 {
205 Lisp_Object n;
206 XFASTINT (n) = mincol / tab_width - fromcol / tab_width;
207 if (XFASTINT (n) != 0)
208 {
209 Finsert_char (make_number ('\t'), n);
210
211 fromcol = (mincol / tab_width) * tab_width;
212 }
213 }
214
215 XFASTINT (col) = mincol - fromcol;
216 Finsert_char (make_number (' '), col);
217
218 last_known_column = mincol;
219 last_known_column_point = point;
220 last_known_column_modified = MODIFF;
221
222 XSETINT (col, mincol);
223 return col;
224}
225\f
226DEFUN ("current-indentation", Fcurrent_indentation, Scurrent_indentation,
227 0, 0, 0,
228 "Return the indentation of the current line.\n\
229This is the horizontal position of the character\n\
230following any initial whitespace.")
231 ()
232{
233 Lisp_Object val;
234
235 XFASTINT (val) = position_indentation (find_next_newline (point, -1));
236 return val;
237}
238
239position_indentation (pos)
240 register int pos;
241{
242 register int column = 0;
243 register int tab_width = XINT (current_buffer->tab_width);
244 register unsigned char *p;
245 register unsigned char *stop;
246
ccdcf1f5 247 if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
993b6404
JB
248
249 stop = &FETCH_CHAR (BUFFER_CEILING_OF (pos)) + 1;
250 p = &FETCH_CHAR (pos);
251 while (1)
252 {
253 while (p == stop)
254 {
255 if (pos == ZV)
256 return column;
257 pos += p - &FETCH_CHAR (pos);
258 p = &FETCH_CHAR (pos);
259 stop = &FETCH_CHAR (BUFFER_CEILING_OF (pos)) + 1;
260 }
261 switch (*p++)
262 {
263 case ' ':
264 column++;
265 break;
266 case '\t':
267 column += tab_width - column % tab_width;
268 break;
269 default:
270 return column;
271 }
272 }
273}
1b15e576
KH
274
275/* Test whether the line beginning at POS is indented beyond COLUMN.
276 Blank lines are treated as if they had the same indentation as the
277 preceding line. */
278int
279indented_beyond_p (pos, column)
280 int pos, column;
281{
282 while (pos > BEGV && FETCH_CHAR (pos) == '\n')
283 pos = find_next_newline (pos - 1, -1);
284 return (position_indentation (pos) >= column);
285}
993b6404
JB
286\f
287DEFUN ("move-to-column", Fmove_to_column, Smove_to_column, 1, 2, 0,
288 "Move point to column COLUMN in the current line.\n\
289The column of a character is calculated by adding together the widths\n\
290as displayed of the previous characters in the line.\n\
291This function ignores line-continuation;\n\
292there is no upper limit on the column number a character can have\n\
230a4cbd
JB
293and horizontal scrolling has no effect.\n\
294\n\
993b6404
JB
295If specified column is within a character, point goes after that character.\n\
296If it's past end of line, point goes to end of line.\n\n\
297A non-nil second (optional) argument FORCE means, if the line\n\
298is too short to reach column COLUMN then add spaces/tabs to get there,\n\
299and if COLUMN is in the middle of a tab character, change it to spaces.")
300 (column, force)
301 Lisp_Object column, force;
302{
303 register int pos;
304 register int col = current_column ();
305 register int goal;
306 register int end;
307 register int tab_width = XINT (current_buffer->tab_width);
56a98455 308 register int ctl_arrow = !NILP (current_buffer->ctl_arrow);
993b6404
JB
309 register struct Lisp_Vector *dp = buffer_display_table ();
310
311 Lisp_Object val;
312 int prev_col;
313 int c;
314
ccdcf1f5 315 if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
993b6404
JB
316 CHECK_NATNUM (column, 0);
317 goal = XINT (column);
318
319 retry:
320 pos = point;
321 end = ZV;
322
323 /* If we're starting past the desired column,
324 back up to beginning of line and scan from there. */
325 if (col > goal)
326 {
327 pos = find_next_newline (pos, -1);
328 col = 0;
329 }
330
331 while (col < goal && pos < end)
332 {
333 c = FETCH_CHAR (pos);
334 if (c == '\n')
335 break;
336 if (c == '\r' && EQ (current_buffer->selective_display, Qt))
337 break;
338 pos++;
339 if (c == '\t')
340 {
341 prev_col = col;
342 col += tab_width;
343 col = col / tab_width * tab_width;
344 }
dea4d2e6
RS
345 else if (dp != 0 && XTYPE (DISP_CHAR_VECTOR (dp, c)) == Lisp_Vector)
346 col += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
993b6404 347 else if (ctl_arrow && (c < 040 || c == 0177))
bbc2998f 348 col += 2;
993b6404 349 else if (c < 040 || c >= 0177)
bbc2998f 350 col += 4;
993b6404
JB
351 else
352 col++;
353 }
354
355 SET_PT (pos);
356
357 /* If a tab char made us overshoot, change it to spaces
358 and scan through it again. */
56a98455 359 if (!NILP (force) && col > goal && c == '\t' && prev_col < goal)
993b6404 360 {
70ee42f7
JB
361 int old_point;
362
993b6404 363 del_range (point - 1, point);
70ee42f7
JB
364 Findent_to (make_number (goal), Qnil);
365 old_point = point;
366 Findent_to (make_number (col), Qnil);
367 SET_PT (old_point);
5a05d3d2
RS
368 /* Set the last_known... vars consistently. */
369 col = goal;
993b6404
JB
370 }
371
372 /* If line ends prematurely, add space to the end. */
56a98455 373 if (col < goal && !NILP (force))
230a4cbd 374 Findent_to (make_number (col = goal), Qnil);
993b6404
JB
375
376 last_known_column = col;
377 last_known_column_point = point;
378 last_known_column_modified = MODIFF;
379
380 XFASTINT (val) = col;
381 return val;
382}
383\f
384struct position val_compute_motion;
385
386/* Scan the current buffer forward from offset FROM, pretending that
387 this is at line FROMVPOS, column FROMHPOS, until reaching buffer
388 offset TO or line TOVPOS, column TOHPOS (whichever comes first),
389 and return the ending buffer position and screen location.
390
391 WIDTH is the number of columns available to display text;
392 compute_motion uses this to handle continuation lines and such.
393 HSCROLL is the number of columns not being displayed at the left
394 margin; this is usually taken from a window's hscroll member.
a9764248
JB
395 TAB_OFFSET is the number of columns of the first tab that aren't
396 being displayed, perhaps because of a continuation line or
397 something.
993b6404
JB
398
399 compute_motion returns a pointer to a struct position. The bufpos
400 member gives the buffer position at the end of the scan, and hpos
401 and vpos give its cartesian location. I'm not clear on what the
402 other members are.
403
1827d036
KH
404 Note that FROMHPOS and TOHPOS should be expressed in real screen
405 columns, taking HSCROLL and the truncation glyph at the left margin
406 into account. That is, beginning-of-line moves you to the hpos
407 -HSCROLL + (HSCROLL > 0).
408
993b6404
JB
409 For example, to find the buffer position of column COL of line LINE
410 of a certain window, pass the window's starting location as FROM
411 and the window's upper-left coordinates as FROMVPOS and FROMHPOS.
412 Pass the buffer's ZV as TO, to limit the scan to the end of the
413 visible section of the buffer, and pass LINE and COL as TOVPOS and
414 TOHPOS.
415
416 When displaying in window w, a typical formula for WIDTH is:
417
418 window_width - 1
a3c87d4e
JB
419 - (has_vertical_scroll_bars
420 ? VERTICAL_SCROLL_BAR_WIDTH
fa61c701 421 : (window_width + window_left != frame_width))
993b6404
JB
422
423 where
424 window_width is XFASTINT (w->width),
425 window_left is XFASTINT (w->left),
a3c87d4e
JB
426 has_vertical_scroll_bars is
427 FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (WINDOW_FRAME (window)))
fa61c701 428 and frame_width = FRAME_WIDTH (XFRAME (window->frame))
993b6404 429
1827d036
KH
430 Or you can let window_internal_width do this all for you, and write:
431 window_internal_width (w) - 1
fa61c701
JB
432
433 The `-1' accounts for the continuation-line backslashes; the rest
7e7a76b5 434 accounts for window borders if the window is split horizontally, and
1827d036 435 the scroll bars if they are turned on. */
993b6404
JB
436
437struct position *
88af3af4 438compute_motion (from, fromvpos, fromhpos, to, tovpos, tohpos, width, hscroll, tab_offset, win)
993b6404
JB
439 int from, fromvpos, fromhpos, to, tovpos, tohpos;
440 register int width;
441 int hscroll, tab_offset;
88af3af4 442 struct window *win;
993b6404 443{
cde9337b
JB
444 register int hpos = fromhpos;
445 register int vpos = fromvpos;
446
993b6404
JB
447 register int pos;
448 register int c;
449 register int tab_width = XFASTINT (current_buffer->tab_width);
56a98455 450 register int ctl_arrow = !NILP (current_buffer->ctl_arrow);
88af3af4 451 register struct Lisp_Vector *dp = window_display_table (win);
993b6404
JB
452 int selective
453 = XTYPE (current_buffer->selective_display) == Lisp_Int
454 ? XINT (current_buffer->selective_display)
56a98455 455 : !NILP (current_buffer->selective_display) ? -1 : 0;
42918ba5 456 int prev_vpos, prev_hpos = 0;
993b6404 457 int selective_rlen
dea4d2e6
RS
458 = (selective && dp && XTYPE (DISP_INVIS_VECTOR (dp)) == Lisp_Vector
459 ? XVECTOR (DISP_INVIS_VECTOR (dp))->size : 0);
5a05d3d2
RS
460#ifdef USE_TEXT_PROPERTIES
461 /* The next location where the `invisible' property changes */
462 int next_invisible = from;
463 Lisp_Object prop, position;
464#endif
993b6404 465
88af3af4
KH
466 if (! BUFFERP (win->buffer) || XBUFFER (win->buffer) != current_buffer)
467 abort ();
468
ccdcf1f5 469 if (tab_width <= 0 || tab_width > 1000) tab_width = 8;
cde9337b 470 for (pos = from; pos < to; pos++)
993b6404 471 {
cde9337b
JB
472 /* Stop if past the target screen position. */
473 if (vpos > tovpos
474 || (vpos == tovpos && hpos >= tohpos))
475 break;
476
477 prev_vpos = vpos;
478 prev_hpos = hpos;
479
5a05d3d2
RS
480#ifdef USE_TEXT_PROPERTIES
481 /* if the `invisible' property is set, we can skip to
482 the next property change */
483 while (pos == next_invisible && pos < to)
f75c0f8a
RS
484 {
485 XFASTINT (position) = pos;
67406ef4 486 prop = Fget_char_property (position,
f75c0f8a
RS
487 Qinvisible,
488 Fcurrent_buffer ());
489 {
490 Lisp_Object end, limit;
491
492 /* This is just an estimate to give reasonable
493 performance; nothing should go wrong if it is too small. */
7ea9c020
KH
494 limit = Fnext_overlay_change (position);
495 if (XFASTINT (limit) > pos + 100)
496 XFASTINT (limit) = pos + 100;
f75c0f8a
RS
497 end = Fnext_single_property_change (position, Qinvisible,
498 Fcurrent_buffer (), limit);
499 if (INTEGERP (end))
500 next_invisible = XINT (end);
501 else
502 next_invisible = to;
503 if (! NILP (prop))
504 pos = next_invisible;
505 }
506 }
5a05d3d2
RS
507 if (pos >= to)
508 break;
509#endif
993b6404
JB
510 c = FETCH_CHAR (pos);
511 if (c >= 040 && c < 0177
dea4d2e6 512 && (dp == 0 || XTYPE (DISP_CHAR_VECTOR (dp, c)) != Lisp_Vector))
cde9337b 513 hpos++;
993b6404
JB
514 else if (c == '\t')
515 {
cde9337b
JB
516 hpos += tab_width - ((hpos + tab_offset + hscroll - (hscroll > 0)
517 /* Add tab_width here to make sure positive.
518 hpos can be negative after continuation
519 but can't be less than -tab_width. */
520 + tab_width)
521 % tab_width);
993b6404
JB
522 }
523 else if (c == '\n')
524 {
1b15e576 525 if (selective > 0 && indented_beyond_p (pos + 1, selective))
993b6404
JB
526 {
527 /* Skip any number of invisible lines all at once */
528 do
529 {
cde9337b 530 while (++pos < to && FETCH_CHAR (pos) != '\n');
993b6404 531 }
1b15e576 532 while (pos < to && indented_beyond_p (pos + 1, selective));
7e7a76b5 533 pos--; /* Reread the newline on the next pass. */
993b6404
JB
534 /* Allow for the " ..." that is displayed for them. */
535 if (selective_rlen)
536 {
cde9337b
JB
537 hpos += selective_rlen;
538 if (hpos >= width)
539 hpos = width;
993b6404 540 }
e51eab7c 541 /* We have skipped the invis text, but not the newline after. */
993b6404
JB
542 }
543 else
cde9337b
JB
544 {
545 /* A visible line. */
546 vpos++;
547 hpos = 0;
525a87de 548 hpos -= hscroll;
1827d036 549 if (hscroll > 0) hpos++; /* Truncation glyph on column 0 */
525a87de
KH
550 tab_offset = 0;
551 }
993b6404
JB
552 }
553 else if (c == CR && selective < 0)
554 {
555 /* In selective display mode,
556 everything from a ^M to the end of the line is invisible */
cde9337b
JB
557 while (pos < to && FETCH_CHAR (pos) != '\n') pos++;
558 /* Stop *before* the real newline. */
993b6404
JB
559 pos--;
560 /* Allow for the " ..." that is displayed for them. */
561 if (selective_rlen)
562 {
cde9337b
JB
563 hpos += selective_rlen;
564 if (hpos >= width)
565 hpos = width;
993b6404
JB
566 }
567 }
dea4d2e6
RS
568 else if (dp != 0 && XTYPE (DISP_CHAR_VECTOR (dp, c)) == Lisp_Vector)
569 hpos += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size;
993b6404 570 else
cde9337b 571 hpos += (ctl_arrow && c < 0200) ? 2 : 4;
993b6404 572
cde9337b
JB
573 /* Handle right margin. */
574 if (hpos >= width
575 && (hpos > width
576 || (pos < ZV - 1
993b6404
JB
577 && FETCH_CHAR (pos + 1) != '\n')))
578 {
cde9337b
JB
579 if (vpos > tovpos
580 || (vpos == tovpos && hpos >= tohpos))
993b6404
JB
581 break;
582 if (hscroll
583 || (truncate_partial_width_windows
502b9b64 584 && width + 1 < FRAME_WIDTH (selected_frame))
56a98455 585 || !NILP (current_buffer->truncate_lines))
993b6404 586 {
cde9337b
JB
587 /* Truncating: skip to newline. */
588 while (pos < to && FETCH_CHAR (pos) != '\n') pos++;
993b6404 589 pos--;
e51eab7c 590 hpos = width;
993b6404
JB
591 }
592 else
593 {
cde9337b
JB
594 /* Continuing. */
595 vpos++;
596 hpos -= width;
993b6404
JB
597 tab_offset += width;
598 }
599
600 }
601 }
602
603 val_compute_motion.bufpos = pos;
cde9337b
JB
604 val_compute_motion.hpos = hpos;
605 val_compute_motion.vpos = vpos;
606 val_compute_motion.prevhpos = prev_hpos;
993b6404
JB
607
608 /* Nonzero if have just continued a line */
609 val_compute_motion.contin
cde9337b
JB
610 = (pos != from
611 && (val_compute_motion.vpos != prev_vpos)
612 && c != '\n');
993b6404
JB
613
614 return &val_compute_motion;
615}
993b6404 616
992371ca
KH
617#if 0 /* The doc string is too long for some compilers,
618 but make-docfile can find it in this comment. */
88af3af4 619DEFUN ("compute-motion", Ffoo, Sfoo, 7, 7, 0,
42918ba5
RS
620 "Scan through the current buffer, calculating screen position.\n\
621Scan the current buffer forward from offset FROM,\n\
622assuming it is at position FROMPOS--a cons of the form (HPOS . VPOS)--\n\
623to position TO or position TOPOS--another cons of the form (HPOS . VPOS)--\n\
624and return the ending buffer position and screen location.\n\
625\n\
88af3af4 626There are three additional arguments:\n\
42918ba5
RS
627\n\
628WIDTH is the number of columns available to display text;\n\
629this affects handling of continuation lines.\n\
992371ca
KH
630This is usually the value returned by `window-width', less one (to allow\n\
631for the continuation glyph).\n\
42918ba5
RS
632\n\
633OFFSETS is either nil or a cons cell (HSCROLL . TAB-OFFSET).\n\
634HSCROLL is the number of columns not being displayed at the left\n\
635margin; this is usually taken from a window's hscroll member.\n\
636TAB-OFFSET is the number of columns of the first tab that aren't\n\
637being displayed, perhaps because the line was continued within it.\n\
4fb76787 638If OFFSETS is nil, HSCROLL and TAB-OFFSET are assumed to be zero.\n\
88af3af4
KH
639WINDOW is the window to operate on. Currently this is used only to\n\
640find the buffer and the display table.\n\
42918ba5
RS
641\n\
642The value is a list of five elements:\n\
faa5c515 643 (POS HPOS VPOS PREVHPOS CONTIN)\n\
42918ba5
RS
644POS is the buffer position where the scan stopped.\n\
645VPOS is the vertical position where the scan stopped.\n\
646HPOS is the horizontal position where the scan stopped.\n\
647\n\
648PREVHPOS is the horizontal position one character back from POS.\n\
649CONTIN is t if a line was continued after (or within) the previous character.\n\
650\n\
651For example, to find the buffer position of column COL of line LINE\n\
652of a certain window, pass the window's starting location as FROM\n\
653and the window's upper-left coordinates as FROMPOS.\n\
654Pass the buffer's (point-max) as TO, to limit the scan to the end of the\n\
655visible section of the buffer, and pass LINE and COL as TOPOS.")
992371ca
KH
656#endif
657
88af3af4 658DEFUN ("compute-motion", Fcompute_motion, Scompute_motion, 7, 7, 0,
992371ca 659 0)
88af3af4 660 (from, frompos, to, topos, width, offsets, window)
42918ba5 661 Lisp_Object from, frompos, to, topos;
88af3af4 662 Lisp_Object width, offsets, window;
42918ba5
RS
663{
664 Lisp_Object bufpos, hpos, vpos, prevhpos, contin;
665 struct position *pos;
666 int hscroll, tab_offset;
88af3af4 667 struct buffer *old_buffer;
42918ba5 668
26a8d14b 669 CHECK_NUMBER_COERCE_MARKER (from, 0);
42918ba5 670 CHECK_CONS (frompos, 0);
26a8d14b
KH
671 CHECK_NUMBER (XCONS (frompos)->car, 0);
672 CHECK_NUMBER (XCONS (frompos)->cdr, 0);
673 CHECK_NUMBER_COERCE_MARKER (to, 0);
42918ba5 674 CHECK_CONS (topos, 0);
26a8d14b
KH
675 CHECK_NUMBER (XCONS (topos)->car, 0);
676 CHECK_NUMBER (XCONS (topos)->cdr, 0);
677 CHECK_NUMBER (width, 0);
42918ba5
RS
678 if (!NILP (offsets))
679 {
680 CHECK_CONS (offsets, 0);
26a8d14b
KH
681 CHECK_NUMBER (XCONS (offsets)->car, 0);
682 CHECK_NUMBER (XCONS (offsets)->cdr, 0);
42918ba5
RS
683 hscroll = XINT (XCONS (offsets)->car);
684 tab_offset = XINT (XCONS (offsets)->cdr);
685 }
686 else
687 hscroll = tab_offset = 0;
688
88af3af4
KH
689 if (NILP (window))
690 window = Fselected_window ();
691 else
692 CHECK_LIVE_WINDOW (window, 0);
693
694 /* Might as well use the buffer on the specified window, rather than
695 generating an error. */
696 old_buffer = current_buffer;
697 current_buffer = XBUFFER (XWINDOW (window)->buffer);
42918ba5
RS
698 pos = compute_motion (XINT (from), XINT (XCONS (frompos)->cdr),
699 XINT (XCONS (frompos)->car),
700 XINT (to), XINT (XCONS (topos)->cdr),
701 XINT (XCONS (topos)->car),
88af3af4
KH
702 XINT (width), hscroll, tab_offset,
703 XWINDOW (window));
704 current_buffer = old_buffer;
42918ba5
RS
705
706 XFASTINT (bufpos) = pos->bufpos;
faa5c515 707 XSET (hpos, Lisp_Int, pos->hpos);
42918ba5 708 XSET (vpos, Lisp_Int, pos->vpos);
faa5c515 709 XSET (prevhpos, Lisp_Int, pos->prevhpos);
42918ba5
RS
710
711 return Fcons (bufpos,
712 Fcons (hpos,
713 Fcons (vpos,
714 Fcons (prevhpos,
715 Fcons (pos->contin ? Qt : Qnil, Qnil)))));
716
717}
993b6404
JB
718\f
719/* Return the column of position POS in window W's buffer,
720 rounded down to a multiple of the internal width of W.
721 This is the amount of indentation of position POS
722 that is not visible in its horizontal position in the window. */
723
724int
725pos_tab_offset (w, pos)
726 struct window *w;
727 register int pos;
728{
729 int opoint = point;
730 int col;
fa61c701 731 int width = window_internal_width (w) - 1;
993b6404
JB
732
733 if (pos == BEGV || FETCH_CHAR (pos - 1) == '\n')
734 return 0;
735 SET_PT (pos);
736 col = current_column ();
737 SET_PT (opoint);
738 return col - (col % width);
739}
740
741/* start_hpos is the hpos of the first character of the buffer:
742 zero except for the minibuffer window,
743 where it is the width of the prompt. */
744
745struct position val_vmotion;
746
747struct position *
748vmotion (from, vtarget, width, hscroll, window)
749 register int from, vtarget, width;
750 int hscroll;
751 Lisp_Object window;
752{
753 struct position pos;
754 /* vpos is cumulative vertical position, changed as from is changed */
755 register int vpos = 0;
756 register int prevline;
757 register int first;
758 int lmargin = hscroll > 0 ? 1 - hscroll : 0;
759 int selective
760 = XTYPE (current_buffer->selective_display) == Lisp_Int
761 ? XINT (current_buffer->selective_display)
56a98455 762 : !NILP (current_buffer->selective_display) ? -1 : 0;
44d1c535
KH
763 int start_hpos = (EQ (window, minibuf_window) && XWINDOW (window)->start == 1
764 ? minibuf_prompt_width : 0);
993b6404
JB
765
766 retry:
767 if (vtarget > vpos)
768 {
769 /* Moving downward is simple, but must calculate from beg of line
770 to determine hpos of starting point */
771 if (from > BEGV && FETCH_CHAR (from - 1) != '\n')
772 {
773 prevline = find_next_newline (from, -1);
5a05d3d2
RS
774 while (prevline > BEGV
775 && ((selective > 0
1b15e576 776 && indented_beyond_p (prevline, selective))
5a05d3d2
RS
777#ifdef USE_TEXT_PROPERTIES
778 /* watch out for newlines with `invisible' property */
67406ef4 779 || ! NILP (Fget_char_property (XFASTINT (prevline),
5a05d3d2 780 Qinvisible,
67406ef4 781 window))
5a05d3d2
RS
782#endif
783 ))
993b6404
JB
784 prevline = find_next_newline (prevline - 1, -1);
785 pos = *compute_motion (prevline, 0,
786 lmargin + (prevline == 1 ? start_hpos : 0),
cde9337b 787 from, 1 << (INTBITS - 2), 0,
88af3af4 788 width, hscroll, 0, XWINDOW (window));
993b6404
JB
789 }
790 else
791 {
792 pos.hpos = lmargin + (from == 1 ? start_hpos : 0);
793 pos.vpos = 0;
794 }
795 return compute_motion (from, vpos, pos.hpos,
cde9337b 796 ZV, vtarget, - (1 << (INTBITS - 2)),
88af3af4
KH
797 width, hscroll, pos.vpos * width,
798 XWINDOW (window));
993b6404
JB
799 }
800
801 /* To move upward, go a line at a time until
802 we have gone at least far enough */
803
804 first = 1;
805
806 while ((vpos > vtarget || first) && from > BEGV)
807 {
808 prevline = from;
809 while (1)
810 {
811 prevline = find_next_newline (prevline - 1, -1);
812 if (prevline == BEGV
5a05d3d2 813 || ((selective <= 0
1b15e576 814 || ! indented_beyond_p (prevline, selective))
5a05d3d2
RS
815#ifdef USE_TEXT_PROPERTIES
816 /* watch out for newlines with `invisible' property */
67406ef4 817 && NILP (Fget_char_property (XFASTINT (prevline),
5a05d3d2 818 Qinvisible,
67406ef4 819 window))
5a05d3d2
RS
820#endif
821 ))
993b6404
JB
822 break;
823 }
824 pos = *compute_motion (prevline, 0,
825 lmargin + (prevline == 1 ? start_hpos : 0),
cde9337b 826 from, 1 << (INTBITS - 2), 0,
88af3af4 827 width, hscroll, 0, XWINDOW (window));
993b6404
JB
828 vpos -= pos.vpos;
829 first = 0;
830 from = prevline;
831 }
832
833 /* If we made exactly the desired vertical distance,
834 or if we hit beginning of buffer,
835 return point found */
836 if (vpos >= vtarget)
837 {
838 val_vmotion.bufpos = from;
839 val_vmotion.vpos = vpos;
840 val_vmotion.hpos = lmargin;
841 val_vmotion.contin = 0;
842 val_vmotion.prevhpos = 0;
843 return &val_vmotion;
844 }
845
846 /* Otherwise find the correct spot by moving down */
847 goto retry;
848}
849
f1ecfe9b 850DEFUN ("vertical-motion", Fvertical_motion, Svertical_motion, 1, 2, 0,
993b6404
JB
851 "Move to start of screen line LINES lines down.\n\
852If LINES is negative, this is moving up.\n\
f1ecfe9b
RS
853The optional second argument WINDOW specifies the window\n\
854 to use for computations.\n\
993b6404
JB
855Sets point to position found; this may be start of line\n\
856 or just the start of a continuation line.\n\
857Returns number of lines moved; may be closer to zero than LINES\n\
858 if beginning or end of buffer was reached.")
f1ecfe9b
RS
859 (lines, window)
860 Lisp_Object lines, window;
993b6404
JB
861{
862 struct position pos;
230a75fc 863 register struct window *w;
993b6404
JB
864
865 CHECK_NUMBER (lines, 0);
f1ecfe9b
RS
866 if (! NILP (window))
867 CHECK_WINDOW (window, 0);
868 else
869 XSET (window, Lisp_Window, selected_window);
993b6404 870
230a75fc
KH
871 w = XWINDOW (window);
872 pos = *vmotion (point, XINT (lines), window_internal_width (w) - 1,
993b6404 873 /* Not XFASTINT since perhaps could be negative */
f1ecfe9b 874 XINT (w->hscroll), window);
993b6404
JB
875
876 SET_PT (pos.bufpos);
877 return make_number (pos.vpos);
878}
879\f
880syms_of_indent ()
881{
882 DEFVAR_BOOL ("indent-tabs-mode", &indent_tabs_mode,
883 "*Indentation can insert tabs if this is non-nil.\n\
884Setting this variable automatically makes it local to the current buffer.");
885 indent_tabs_mode = 1;
886
887 defsubr (&Scurrent_indentation);
888 defsubr (&Sindent_to);
889 defsubr (&Scurrent_column);
890 defsubr (&Smove_to_column);
891 defsubr (&Svertical_motion);
42918ba5 892 defsubr (&Scompute_motion);
993b6404 893}