Commit | Line | Data |
---|---|---|
993b6404 | 1 | /* Indentation functions. |
e01732fa | 2 | Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1998, 2000, 2001, |
8cabe764 GM |
3 | 2002, 2003, 2004, 2005, 2006, 2007, 2008 |
4 | Free Software Foundation, Inc. | |
993b6404 JB |
5 | |
6 | This file is part of GNU Emacs. | |
7 | ||
9ec0b715 | 8 | GNU Emacs is free software: you can redistribute it and/or modify |
993b6404 | 9 | it under the terms of the GNU General Public License as published by |
9ec0b715 GM |
10 | the Free Software Foundation, either version 3 of the License, or |
11 | (at your option) any later version. | |
993b6404 JB |
12 | |
13 | GNU Emacs is distributed in the hope that it will be useful, | |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
17 | ||
18 | You should have received a copy of the GNU General Public License | |
9ec0b715 | 19 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
993b6404 | 20 | |
18160b98 | 21 | #include <config.h> |
4d553a13 KL |
22 | #include <stdio.h> |
23 | ||
993b6404 JB |
24 | #include "lisp.h" |
25 | #include "buffer.h" | |
f6ed712f | 26 | #include "character.h" |
fb911777 | 27 | #include "category.h" |
993b6404 | 28 | #include "indent.h" |
2538fae4 | 29 | #include "keyboard.h" |
502b9b64 | 30 | #include "frame.h" |
993b6404 JB |
31 | #include "window.h" |
32 | #include "termchar.h" | |
33 | #include "termopts.h" | |
34 | #include "disptab.h" | |
5a05d3d2 | 35 | #include "intervals.h" |
0aa01123 | 36 | #include "region-cache.h" |
993b6404 JB |
37 | |
38 | /* Indentation can insert tabs if this is non-zero; | |
88c6e37e GM |
39 | otherwise always uses spaces. */ |
40 | ||
c86f7377 | 41 | static int indent_tabs_mode; |
993b6404 | 42 | |
993b6404 JB |
43 | #define CR 015 |
44 | ||
79c2a4fc | 45 | /* These three values memorize the current column to avoid recalculation. */ |
88c6e37e GM |
46 | |
47 | /* Last value returned by current_column. | |
48 | Some things in set last_known_column_point to -1 | |
79c2a4fc | 49 | to mark the memorized value as invalid. */ |
88c6e37e | 50 | |
c86f7377 | 51 | static double last_known_column; |
88c6e37e GM |
52 | |
53 | /* Value of point when current_column was called. */ | |
54 | ||
83155776 | 55 | EMACS_INT last_known_column_point; |
88c6e37e GM |
56 | |
57 | /* Value of MODIFF when current_column was called. */ | |
58 | ||
c86f7377 | 59 | static int last_known_column_modified; |
993b6404 | 60 | |
76e20cb0 RS |
61 | static double current_column_1 P_ ((void)); |
62 | static double position_indentation P_ ((int)); | |
82d593eb | 63 | |
a997a7ca KH |
64 | /* Cache of beginning of line found by the last call of |
65 | current_column. */ | |
88c6e37e | 66 | |
83155776 | 67 | static EMACS_INT current_column_bol_cache; |
a997a7ca | 68 | |
993b6404 JB |
69 | /* Get the display table to use for the current buffer. */ |
70 | ||
d44f12b4 | 71 | struct Lisp_Char_Table * |
993b6404 JB |
72 | buffer_display_table () |
73 | { | |
74 | Lisp_Object thisbuf; | |
75 | ||
76 | thisbuf = current_buffer->display_table; | |
d44f12b4 RS |
77 | if (DISP_TABLE_P (thisbuf)) |
78 | return XCHAR_TABLE (thisbuf); | |
79 | if (DISP_TABLE_P (Vstandard_display_table)) | |
80 | return XCHAR_TABLE (Vstandard_display_table); | |
993b6404 JB |
81 | return 0; |
82 | } | |
83 | \f | |
0aa01123 JB |
84 | /* Width run cache considerations. */ |
85 | ||
86 | /* Return the width of character C under display table DP. */ | |
f845b8b2 | 87 | |
0aa01123 JB |
88 | static int |
89 | character_width (c, dp) | |
90 | int c; | |
d44f12b4 | 91 | struct Lisp_Char_Table *dp; |
0aa01123 JB |
92 | { |
93 | Lisp_Object elt; | |
94 | ||
95 | /* These width computations were determined by examining the cases | |
96 | in display_text_line. */ | |
97 | ||
f845b8b2 | 98 | /* Everything can be handled by the display table, if it's |
0aa01123 | 99 | present and the element is right. */ |
f845b8b2 | 100 | if (dp && (elt = DISP_CHAR_VECTOR (dp, c), VECTORP (elt))) |
0aa01123 JB |
101 | return XVECTOR (elt)->size; |
102 | ||
f845b8b2 RS |
103 | /* Some characters are special. */ |
104 | if (c == '\n' || c == '\t' || c == '\015') | |
105 | return 0; | |
106 | ||
107 | /* Printing characters have width 1. */ | |
0aa01123 JB |
108 | else if (c >= 040 && c < 0177) |
109 | return 1; | |
110 | ||
111 | /* Everybody else (control characters, metacharacters) has other | |
112 | widths. We could return their actual widths here, but they | |
113 | depend on things like ctl_arrow and crud like that, and they're | |
114 | not very common at all. So we'll just claim we don't know their | |
115 | widths. */ | |
116 | else | |
117 | return 0; | |
118 | } | |
119 | ||
e0f24100 | 120 | /* Return true if the display table DISPTAB specifies the same widths |
0aa01123 JB |
121 | for characters as WIDTHTAB. We use this to decide when to |
122 | invalidate the buffer's width_run_cache. */ | |
88c6e37e | 123 | |
0aa01123 JB |
124 | int |
125 | disptab_matches_widthtab (disptab, widthtab) | |
d44f12b4 | 126 | struct Lisp_Char_Table *disptab; |
0aa01123 JB |
127 | struct Lisp_Vector *widthtab; |
128 | { | |
129 | int i; | |
130 | ||
131 | if (widthtab->size != 256) | |
132 | abort (); | |
133 | ||
134 | for (i = 0; i < 256; i++) | |
135 | if (character_width (i, disptab) | |
136 | != XFASTINT (widthtab->contents[i])) | |
137 | return 0; | |
138 | ||
139 | return 1; | |
2ff4775b | 140 | } |
0aa01123 JB |
141 | |
142 | /* Recompute BUF's width table, using the display table DISPTAB. */ | |
88c6e37e | 143 | |
0aa01123 JB |
144 | void |
145 | recompute_width_table (buf, disptab) | |
146 | struct buffer *buf; | |
d44f12b4 | 147 | struct Lisp_Char_Table *disptab; |
0aa01123 JB |
148 | { |
149 | int i; | |
228a2e1a | 150 | struct Lisp_Vector *widthtab; |
0aa01123 | 151 | |
228a2e1a KH |
152 | if (!VECTORP (buf->width_table)) |
153 | buf->width_table = Fmake_vector (make_number (256), make_number (0)); | |
154 | widthtab = XVECTOR (buf->width_table); | |
0aa01123 JB |
155 | if (widthtab->size != 256) |
156 | abort (); | |
157 | ||
158 | for (i = 0; i < 256; i++) | |
228a2e1a | 159 | XSETFASTINT (widthtab->contents[i], character_width (i, disptab)); |
0aa01123 JB |
160 | } |
161 | ||
162 | /* Allocate or free the width run cache, as requested by the current | |
163 | state of current_buffer's cache_long_line_scans variable. */ | |
88c6e37e | 164 | |
0aa01123 JB |
165 | static void |
166 | width_run_cache_on_off () | |
167 | { | |
a997a7ca KH |
168 | if (NILP (current_buffer->cache_long_line_scans) |
169 | /* And, for the moment, this feature doesn't work on multibyte | |
170 | characters. */ | |
171 | || !NILP (current_buffer->enable_multibyte_characters)) | |
0aa01123 JB |
172 | { |
173 | /* It should be off. */ | |
174 | if (current_buffer->width_run_cache) | |
175 | { | |
176 | free_region_cache (current_buffer->width_run_cache); | |
177 | current_buffer->width_run_cache = 0; | |
178 | current_buffer->width_table = Qnil; | |
179 | } | |
180 | } | |
181 | else | |
182 | { | |
183 | /* It should be on. */ | |
184 | if (current_buffer->width_run_cache == 0) | |
2ff4775b | 185 | { |
0aa01123 | 186 | current_buffer->width_run_cache = new_region_cache (); |
0aa01123 JB |
187 | recompute_width_table (current_buffer, buffer_display_table ()); |
188 | } | |
189 | } | |
190 | } | |
191 | ||
192 | \f | |
9a21bb64 RS |
193 | /* Skip some invisible characters starting from POS. |
194 | This includes characters invisible because of text properties | |
195 | and characters invisible because of overlays. | |
196 | ||
197 | If position POS is followed by invisible characters, | |
198 | skip some of them and return the position after them. | |
199 | Otherwise return POS itself. | |
200 | ||
201 | Set *NEXT_BOUNDARY_P to the next position at which | |
202 | it will be necessary to call this function again. | |
203 | ||
204 | Don't scan past TO, and don't set *NEXT_BOUNDARY_P | |
205 | to a value greater than TO. | |
206 | ||
207 | If WINDOW is non-nil, and this buffer is displayed in WINDOW, | |
208 | take account of overlays that apply only in WINDOW. | |
209 | ||
210 | We don't necessarily skip all the invisible characters after POS | |
211 | because that could take a long time. We skip a reasonable number | |
212 | which can be skipped quickly. If there might be more invisible | |
213 | characters immediately following, then *NEXT_BOUNDARY_P | |
214 | will equal the return value. */ | |
215 | ||
83155776 | 216 | EMACS_INT |
9a21bb64 | 217 | skip_invisible (pos, next_boundary_p, to, window) |
83155776 SM |
218 | EMACS_INT pos; |
219 | EMACS_INT *next_boundary_p; | |
220 | EMACS_INT to; | |
9a21bb64 RS |
221 | Lisp_Object window; |
222 | { | |
2e34157c | 223 | Lisp_Object prop, position, overlay_limit, proplimit; |
2ca8b6c2 | 224 | Lisp_Object buffer, tmp; |
83155776 SM |
225 | EMACS_INT end; |
226 | int inv_p; | |
9a21bb64 RS |
227 | |
228 | XSETFASTINT (position, pos); | |
229 | XSETBUFFER (buffer, current_buffer); | |
230 | ||
231 | /* Give faster response for overlay lookup near POS. */ | |
232 | recenter_overlay_lists (current_buffer, pos); | |
233 | ||
234 | /* We must not advance farther than the next overlay change. | |
235 | The overlay change might change the invisible property; | |
236 | or there might be overlay strings to be displayed there. */ | |
237 | overlay_limit = Fnext_overlay_change (position); | |
238 | /* As for text properties, this gives a lower bound | |
239 | for where the invisible text property could change. */ | |
240 | proplimit = Fnext_property_change (position, buffer, Qt); | |
241 | if (XFASTINT (overlay_limit) < XFASTINT (proplimit)) | |
242 | proplimit = overlay_limit; | |
243 | /* PROPLIMIT is now a lower bound for the next change | |
244 | in invisible status. If that is plenty far away, | |
245 | use that lower bound. */ | |
246 | if (XFASTINT (proplimit) > pos + 100 || XFASTINT (proplimit) >= to) | |
247 | *next_boundary_p = XFASTINT (proplimit); | |
248 | /* Otherwise, scan for the next `invisible' property change. */ | |
249 | else | |
250 | { | |
251 | /* Don't scan terribly far. */ | |
252 | XSETFASTINT (proplimit, min (pos + 100, to)); | |
253 | /* No matter what. don't go past next overlay change. */ | |
254 | if (XFASTINT (overlay_limit) < XFASTINT (proplimit)) | |
255 | proplimit = overlay_limit; | |
2ca8b6c2 SM |
256 | tmp = Fnext_single_property_change (position, Qinvisible, |
257 | buffer, proplimit); | |
258 | end = XFASTINT (tmp); | |
fe0066f5 | 259 | #if 0 |
a997a7ca KH |
260 | /* Don't put the boundary in the middle of multibyte form if |
261 | there is no actual property change. */ | |
262 | if (end == pos + 100 | |
263 | && !NILP (current_buffer->enable_multibyte_characters) | |
264 | && end < ZV) | |
265 | while (pos < end && !CHAR_HEAD_P (POS_ADDR (end))) | |
266 | end--; | |
fe0066f5 | 267 | #endif |
2e34157c | 268 | *next_boundary_p = end; |
9a21bb64 RS |
269 | } |
270 | /* if the `invisible' property is set, we can skip to | |
271 | the next property change */ | |
662152dd SM |
272 | prop = Fget_char_property (position, Qinvisible, |
273 | (!NILP (window) | |
274 | && EQ (XWINDOW (window)->buffer, buffer)) | |
275 | ? window : buffer); | |
276 | inv_p = TEXT_PROP_MEANS_INVISIBLE (prop); | |
277 | /* When counting columns (window == nil), don't skip over ellipsis text. */ | |
278 | if (NILP (window) ? inv_p == 1 : inv_p) | |
9a21bb64 RS |
279 | return *next_boundary_p; |
280 | return pos; | |
281 | } | |
282 | \f | |
012fd715 | 283 | /* If a composition starts at POS/POS_BYTE and it doesn't stride over |
703af3d5 | 284 | POINT, set *LEN / *LEN_BYTE to the character and byte lengths, *WIDTH |
012fd715 KH |
285 | to the width, and return 1. Otherwise, return 0. */ |
286 | ||
287 | static int | |
288 | check_composition (pos, pos_byte, point, len, len_byte, width) | |
289 | int pos, pos_byte, point; | |
290 | int *len, *len_byte, *width; | |
291 | { | |
292 | Lisp_Object prop; | |
6ff56356 | 293 | EMACS_INT start, end; |
012fd715 KH |
294 | int id; |
295 | ||
296 | if (! find_composition (pos, -1, &start, &end, &prop, Qnil) | |
9ee6df62 KH |
297 | || pos != start || point < end |
298 | || !COMPOSITION_VALID_P (start, end, prop)) | |
012fd715 KH |
299 | return 0; |
300 | if ((id = get_composition_id (pos, pos_byte, end - pos, prop, Qnil)) < 0) | |
301 | return 0; | |
302 | ||
303 | *len = COMPOSITION_LENGTH (prop); | |
304 | *len_byte = CHAR_TO_BYTE (end) - pos_byte; | |
305 | *width = composition_table[id]->width; | |
306 | return 1; | |
307 | } | |
308 | \f | |
c9c0f7cf KH |
309 | /* Set variables WIDTH and BYTES for a multibyte sequence starting at P. |
310 | ||
c9c0f7cf KH |
311 | DP is a display table or NULL. |
312 | ||
313 | This macro is used in current_column_1, Fmove_to_column, and | |
314 | compute_motion. */ | |
315 | ||
012fd715 KH |
316 | #define MULTIBYTE_BYTES_WIDTH(p, dp) \ |
317 | do { \ | |
318 | int c; \ | |
319 | \ | |
320 | wide_column = 0; \ | |
321 | c = STRING_CHAR_AND_LENGTH (p, MAX_MULTIBYTE_LENGTH, bytes); \ | |
322 | if (BYTES_BY_CHAR_HEAD (*p) != bytes) \ | |
323 | width = bytes * 4; \ | |
324 | else \ | |
325 | { \ | |
326 | if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c))) \ | |
327 | width = XVECTOR (DISP_CHAR_VECTOR (dp, c))->size; \ | |
328 | else \ | |
f6ed712f | 329 | width = CHAR_WIDTH (c); \ |
012fd715 KH |
330 | if (width > 1) \ |
331 | wide_column = width; \ | |
332 | } \ | |
c9c0f7cf KH |
333 | } while (0) |
334 | ||
097812fb | 335 | |
993b6404 | 336 | DEFUN ("current-column", Fcurrent_column, Scurrent_column, 0, 0, 0, |
8c1a1077 PJ |
337 | doc: /* Return the horizontal position of point. Beginning of line is column 0. |
338 | This is calculated by adding together the widths of all the displayed | |
339 | representations of the character between the start of the previous line | |
7bf120f1 JB |
340 | and point (eg. control characters will have a width of 2 or 4, tabs |
341 | will have a variable width). | |
8c1a1077 PJ |
342 | Ignores finite width of frame, which means that this function may return |
343 | values greater than (frame-width). | |
344 | Whether the line is visible (if `selective-display' is t) has no effect; | |
e01732fa SM |
345 | however, ^M is treated as end of line when `selective-display' is t. |
346 | Text that has an invisible property is considered as having width 0, unless | |
347 | `buffer-invisibility-spec' specifies that it is replaced by an ellipsis. */) | |
8c1a1077 | 348 | () |
993b6404 JB |
349 | { |
350 | Lisp_Object temp; | |
097812fb | 351 | XSETFASTINT (temp, (int) current_column ()); /* iftc */ |
993b6404 JB |
352 | return temp; |
353 | } | |
354 | ||
e74928fc JB |
355 | /* Cancel any recorded value of the horizontal position. */ |
356 | ||
c9667ae1 | 357 | void |
e74928fc JB |
358 | invalidate_current_column () |
359 | { | |
360 | last_known_column_point = 0; | |
361 | } | |
362 | ||
76e20cb0 | 363 | double |
993b6404 JB |
364 | current_column () |
365 | { | |
366 | register int col; | |
367 | register unsigned char *ptr, *stop; | |
368 | register int tab_seen; | |
369 | int post_tab; | |
370 | register int c; | |
371 | register int tab_width = XINT (current_buffer->tab_width); | |
56a98455 | 372 | int ctl_arrow = !NILP (current_buffer->ctl_arrow); |
d44f12b4 | 373 | register struct Lisp_Char_Table *dp = buffer_display_table (); |
993b6404 | 374 | |
6ec8bbd2 | 375 | if (PT == last_known_column_point |
993b6404 JB |
376 | && MODIFF == last_known_column_modified) |
377 | return last_known_column; | |
378 | ||
813b81b3 RS |
379 | /* If the buffer has overlays, text properties, |
380 | or multibyte characters, use a more general algorithm. */ | |
9a21bb64 | 381 | if (BUF_INTERVALS (current_buffer) |
3ea2f6f3 SM |
382 | || current_buffer->overlays_before |
383 | || current_buffer->overlays_after | |
813b81b3 RS |
384 | || Z != Z_BYTE) |
385 | return current_column_1 (); | |
9a21bb64 RS |
386 | |
387 | /* Scan backwards from point to the previous newline, | |
388 | counting width. Tab characters are the only complicated case. */ | |
389 | ||
993b6404 | 390 | /* Make a pointer for decrementing through the chars before point. */ |
fe0066f5 | 391 | ptr = BYTE_POS_ADDR (PT_BYTE - 1) + 1; |
993b6404 JB |
392 | /* Make a pointer to where consecutive chars leave off, |
393 | going backwards from point. */ | |
6ec8bbd2 | 394 | if (PT == BEGV) |
993b6404 | 395 | stop = ptr; |
6ec8bbd2 | 396 | else if (PT <= GPT || BEGV > GPT) |
993b6404 JB |
397 | stop = BEGV_ADDR; |
398 | else | |
399 | stop = GAP_END_ADDR; | |
400 | ||
88c6e37e GM |
401 | if (tab_width <= 0 || tab_width > 1000) |
402 | tab_width = 8; | |
993b6404 JB |
403 | |
404 | col = 0, tab_seen = 0, post_tab = 0; | |
405 | ||
406 | while (1) | |
407 | { | |
88c6e37e GM |
408 | EMACS_INT i, n; |
409 | Lisp_Object charvec; | |
097812fb | 410 | |
993b6404 JB |
411 | if (ptr == stop) |
412 | { | |
413 | /* We stopped either for the beginning of the buffer | |
414 | or for the gap. */ | |
415 | if (ptr == BEGV_ADDR) | |
416 | break; | |
097812fb | 417 | |
993b6404 JB |
418 | /* It was the gap. Jump back over it. */ |
419 | stop = BEGV_ADDR; | |
420 | ptr = GPT_ADDR; | |
097812fb | 421 | |
993b6404 | 422 | /* Check whether that brings us to beginning of buffer. */ |
88c6e37e GM |
423 | if (BEGV >= GPT) |
424 | break; | |
993b6404 JB |
425 | } |
426 | ||
427 | c = *--ptr; | |
097812fb | 428 | |
88c6e37e | 429 | if (dp && VECTORP (DISP_CHAR_VECTOR (dp, c))) |
7050d530 | 430 | { |
88c6e37e GM |
431 | charvec = DISP_CHAR_VECTOR (dp, c); |
432 | n = ASIZE (charvec); | |
7050d530 | 433 | } |
88c6e37e | 434 | else |
993b6404 | 435 | { |
88c6e37e GM |
436 | charvec = Qnil; |
437 | n = 1; | |
438 | } | |
097812fb | 439 | |
88c6e37e GM |
440 | for (i = n - 1; i >= 0; --i) |
441 | { | |
442 | if (VECTORP (charvec)) | |
443 | { | |
444 | /* This should be handled the same as | |
445 | next_element_from_display_vector does it. */ | |
446 | Lisp_Object entry = AREF (charvec, i); | |
097812fb | 447 | |
f59836fe KS |
448 | if (GLYPH_CODE_P (entry) |
449 | && GLYPH_CODE_CHAR_VALID_P (entry)) | |
450 | c = GLYPH_CODE_CHAR (entry); | |
88c6e37e GM |
451 | else |
452 | c = ' '; | |
453 | } | |
097812fb | 454 | |
88c6e37e GM |
455 | if (c >= 040 && c < 0177) |
456 | col++; | |
457 | else if (c == '\n' | |
458 | || (c == '\r' | |
459 | && EQ (current_buffer->selective_display, Qt))) | |
460 | { | |
461 | ptr++; | |
462 | goto start_of_line_found; | |
463 | } | |
464 | else if (c == '\t') | |
465 | { | |
466 | if (tab_seen) | |
467 | col = ((col + tab_width) / tab_width) * tab_width; | |
097812fb | 468 | |
88c6e37e GM |
469 | post_tab += col; |
470 | col = 0; | |
471 | tab_seen = 1; | |
472 | } | |
f1004faf GM |
473 | else if (VECTORP (charvec)) |
474 | /* With a display table entry, C is displayed as is, and | |
475 | not displayed as \NNN or as ^N. If C is a single-byte | |
476 | character, it takes one column. If C is multi-byte in | |
477 | an unibyte buffer, it's translated to unibyte, so it | |
478 | also takes one column. */ | |
479 | ++col; | |
88c6e37e GM |
480 | else |
481 | col += (ctl_arrow && c < 0200) ? 2 : 4; | |
993b6404 | 482 | } |
993b6404 JB |
483 | } |
484 | ||
88c6e37e GM |
485 | start_of_line_found: |
486 | ||
993b6404 JB |
487 | if (tab_seen) |
488 | { | |
489 | col = ((col + tab_width) / tab_width) * tab_width; | |
490 | col += post_tab; | |
491 | } | |
492 | ||
a997a7ca KH |
493 | if (ptr == BEGV_ADDR) |
494 | current_column_bol_cache = BEGV; | |
495 | else | |
fe0066f5 RS |
496 | current_column_bol_cache = BYTE_TO_CHAR (PTR_BYTE_POS (ptr)); |
497 | ||
993b6404 | 498 | last_known_column = col; |
6ec8bbd2 | 499 | last_known_column_point = PT; |
993b6404 JB |
500 | last_known_column_modified = MODIFF; |
501 | ||
502 | return col; | |
503 | } | |
504 | \f | |
80e3db56 SM |
505 | extern Lisp_Object Qspace, QCwidth, QCalign_to; |
506 | ||
507 | /* Check the presence of a display property and compute its width. | |
508 | If a property was found and its width was found as well, return | |
509 | its width (>= 0) and set the position of the end of the property | |
510 | in ENDPOS. | |
511 | Otherwise just return -1. */ | |
512 | static int | |
513 | check_display_width (EMACS_INT pos, EMACS_INT col, EMACS_INT *endpos) | |
514 | { | |
515 | Lisp_Object val, overlay; | |
516 | ||
517 | if (CONSP (val = get_char_property_and_overlay | |
518 | (make_number (pos), Qdisplay, Qnil, &overlay)) | |
519 | && EQ (Qspace, XCAR (val))) | |
520 | { /* FIXME: Use calc_pixel_width_or_height, as in term.c. */ | |
521 | Lisp_Object plist = XCDR (val), prop; | |
522 | int width = -1; | |
523 | ||
524 | if ((prop = Fplist_get (plist, QCwidth), NATNUMP (prop))) | |
525 | width = XINT (prop); | |
526 | else if (FLOATP (prop)) | |
527 | width = (int)(XFLOAT_DATA (prop) + 0.5); | |
528 | else if ((prop = Fplist_get (plist, QCalign_to), NATNUMP (prop))) | |
529 | width = XINT (prop) - col; | |
530 | else if (FLOATP (prop)) | |
531 | width = (int)(XFLOAT_DATA (prop) + 0.5) - col; | |
532 | ||
533 | if (width >= 0) | |
534 | { | |
535 | EMACS_INT start; | |
536 | if (OVERLAYP (overlay)) | |
537 | *endpos = OVERLAY_POSITION (OVERLAY_END (overlay)); | |
538 | else | |
539 | get_property_and_range (pos, Qdisplay, &val, &start, endpos, Qnil); | |
540 | return width; | |
541 | } | |
542 | } | |
543 | return -1; | |
544 | } | |
545 | ||
ef6f5c0e SM |
546 | /* Scanning from the beginning of the current line, stop at the buffer |
547 | position ENDPOS or at the column GOALCOL or at the end of line, whichever | |
548 | comes first. | |
549 | Return the resulting buffer position and column in ENDPOS and GOALCOL. | |
550 | PREVCOL gets set to the column of the previous position (it's always | |
551 | strictly smaller than the goal column). */ | |
552 | static void | |
553 | scan_for_column (EMACS_INT *endpos, EMACS_INT *goalcol, EMACS_INT *prevcol) | |
9a21bb64 | 554 | { |
83155776 | 555 | register EMACS_INT tab_width = XINT (current_buffer->tab_width); |
9a21bb64 RS |
556 | register int ctl_arrow = !NILP (current_buffer->ctl_arrow); |
557 | register struct Lisp_Char_Table *dp = buffer_display_table (); | |
fe0066f5 | 558 | int multibyte = !NILP (current_buffer->enable_multibyte_characters); |
9a21bb64 RS |
559 | |
560 | /* Start the scan at the beginning of this line with column number 0. */ | |
ef6f5c0e SM |
561 | register EMACS_INT col = 0, prev_col = 0; |
562 | EMACS_INT goal = goalcol ? *goalcol : MOST_POSITIVE_FIXNUM; | |
563 | EMACS_INT end = endpos ? *endpos : PT; | |
83155776 SM |
564 | EMACS_INT scan, scan_byte; |
565 | EMACS_INT next_boundary; | |
ef6f5c0e | 566 | { |
83155776 | 567 | EMACS_INT opoint = PT, opoint_byte = PT_BYTE; |
813b81b3 | 568 | scan_newline (PT, PT_BYTE, BEGV, BEGV_BYTE, -1, 1); |
fe0066f5 RS |
569 | current_column_bol_cache = PT; |
570 | scan = PT, scan_byte = PT_BYTE; | |
571 | SET_PT_BOTH (opoint, opoint_byte); | |
572 | next_boundary = scan; | |
ef6f5c0e | 573 | } |
9a21bb64 RS |
574 | |
575 | if (tab_width <= 0 || tab_width > 1000) tab_width = 8; | |
576 | ||
577 | /* Scan forward to the target position. */ | |
ef6f5c0e | 578 | while (scan < end) |
9a21bb64 RS |
579 | { |
580 | int c; | |
581 | ||
582 | /* Occasionally we may need to skip invisible text. */ | |
583 | while (scan == next_boundary) | |
584 | { | |
ef6f5c0e | 585 | EMACS_INT old_scan = scan; |
9a21bb64 RS |
586 | /* This updates NEXT_BOUNDARY to the next place |
587 | where we might need to skip more invisible text. */ | |
ef6f5c0e | 588 | scan = skip_invisible (scan, &next_boundary, end, Qnil); |
fe0066f5 RS |
589 | if (scan != old_scan) |
590 | scan_byte = CHAR_TO_BYTE (scan); | |
ef6f5c0e SM |
591 | if (scan >= end) |
592 | goto endloop; | |
9a21bb64 RS |
593 | } |
594 | ||
ef6f5c0e SM |
595 | /* Test reaching the goal column. We do this after skipping |
596 | invisible characters, so that we put point before the | |
597 | character on which the cursor will appear. */ | |
598 | if (col >= goal) | |
599 | break; | |
600 | prev_col = col; | |
601 | ||
80e3db56 | 602 | { /* Check composition sequence. */ |
012fd715 KH |
603 | int len, len_byte, width; |
604 | ||
ef6f5c0e | 605 | if (check_composition (scan, scan_byte, end, |
012fd715 KH |
606 | &len, &len_byte, &width)) |
607 | { | |
608 | scan += len; | |
609 | scan_byte += len_byte; | |
ef6f5c0e | 610 | if (scan <= end) |
012fd715 KH |
611 | col += width; |
612 | continue; | |
613 | } | |
614 | } | |
615 | ||
80e3db56 SM |
616 | { /* Check display property. */ |
617 | EMACS_INT end; | |
618 | int width = check_display_width (scan, col, &end); | |
619 | if (width >= 0) | |
620 | { | |
621 | col += width; | |
622 | if (end > scan) /* Avoid infinite loops with 0-width overlays. */ | |
623 | { | |
624 | scan = end; scan_byte = charpos_to_bytepos (scan); | |
625 | continue; | |
626 | } | |
627 | } | |
628 | } | |
629 | ||
813b81b3 | 630 | c = FETCH_BYTE (scan_byte); |
88c6e37e | 631 | |
ef6f5c0e SM |
632 | /* See if there is a display table and it relates |
633 | to this character. */ | |
634 | ||
c9c0f7cf KH |
635 | if (dp != 0 |
636 | && ! (multibyte && BASE_LEADING_CODE_P (c)) | |
637 | && VECTORP (DISP_CHAR_VECTOR (dp, c))) | |
9a21bb64 | 638 | { |
d6e483a4 RS |
639 | Lisp_Object charvec; |
640 | EMACS_INT i, n; | |
641 | ||
642 | /* This character is displayed using a vector of glyphs. | |
ef6f5c0e | 643 | Update the column/position based on those glyphs. */ |
d6e483a4 | 644 | |
88c6e37e GM |
645 | charvec = DISP_CHAR_VECTOR (dp, c); |
646 | n = ASIZE (charvec); | |
88c6e37e | 647 | |
d6e483a4 | 648 | for (i = 0; i < n; i++) |
88c6e37e GM |
649 | { |
650 | /* This should be handled the same as | |
651 | next_element_from_display_vector does it. */ | |
f59836fe | 652 | Lisp_Object entry = AREF (charvec, i); |
d6e483a4 | 653 | |
f59836fe KS |
654 | if (GLYPH_CODE_P (entry) |
655 | && GLYPH_CODE_CHAR_VALID_P (entry)) | |
656 | c = GLYPH_CODE_CHAR (entry); | |
88c6e37e GM |
657 | else |
658 | c = ' '; | |
d6e483a4 RS |
659 | |
660 | if (c == '\n') | |
661 | goto endloop; | |
662 | if (c == '\r' && EQ (current_buffer->selective_display, Qt)) | |
663 | goto endloop; | |
664 | if (c == '\t') | |
665 | { | |
d6e483a4 RS |
666 | col += tab_width; |
667 | col = col / tab_width * tab_width; | |
668 | } | |
669 | else | |
670 | ++col; | |
88c6e37e | 671 | } |
d6e483a4 RS |
672 | } |
673 | else | |
674 | { | |
ef6f5c0e SM |
675 | /* The display table doesn't affect this character; |
676 | it displays as itself. */ | |
d6e483a4 | 677 | |
88c6e37e GM |
678 | if (c == '\n') |
679 | goto endloop; | |
680 | if (c == '\r' && EQ (current_buffer->selective_display, Qt)) | |
681 | goto endloop; | |
88c6e37e GM |
682 | if (c == '\t') |
683 | { | |
88c6e37e GM |
684 | col += tab_width; |
685 | col = col / tab_width * tab_width; | |
686 | } | |
687 | else if (multibyte && BASE_LEADING_CODE_P (c)) | |
688 | { | |
ef6f5c0e | 689 | /* Start of multi-byte form. */ |
88c6e37e GM |
690 | unsigned char *ptr; |
691 | int bytes, width, wide_column; | |
097812fb | 692 | |
88c6e37e GM |
693 | ptr = BYTE_POS_ADDR (scan_byte); |
694 | MULTIBYTE_BYTES_WIDTH (ptr, dp); | |
36974b5e RS |
695 | /* Subtract one to compensate for the increment |
696 | that is going to happen below. */ | |
ef6f5c0e | 697 | scan_byte += bytes - 1; |
88c6e37e GM |
698 | col += width; |
699 | } | |
700 | else if (ctl_arrow && (c < 040 || c == 0177)) | |
701 | col += 2; | |
702 | else if (c < 040 || c >= 0177) | |
703 | col += 4; | |
704 | else | |
705 | col++; | |
a997a7ca | 706 | } |
d6e483a4 RS |
707 | scan++; |
708 | scan_byte++; | |
709 | ||
9a21bb64 RS |
710 | } |
711 | endloop: | |
712 | ||
713 | last_known_column = col; | |
6ec8bbd2 | 714 | last_known_column_point = PT; |
9a21bb64 RS |
715 | last_known_column_modified = MODIFF; |
716 | ||
ef6f5c0e SM |
717 | if (goalcol) |
718 | *goalcol = col; | |
719 | if (endpos) | |
720 | *endpos = scan; | |
721 | if (prevcol) | |
722 | *prevcol = prev_col; | |
723 | } | |
724 | ||
725 | /* Return the column number of position POS | |
726 | by scanning forward from the beginning of the line. | |
727 | This function handles characters that are invisible | |
728 | due to text properties or overlays. */ | |
729 | ||
730 | static double | |
731 | current_column_1 () | |
732 | { | |
733 | EMACS_INT col = MOST_POSITIVE_FIXNUM; | |
734 | EMACS_INT opoint = PT; | |
735 | ||
736 | scan_for_column (&opoint, &col, NULL); | |
9a21bb64 RS |
737 | return col; |
738 | } | |
739 | \f | |
f4a6687d GM |
740 | |
741 | #if 0 /* Not used. */ | |
742 | ||
c412c808 RS |
743 | /* Return the width in columns of the part of STRING from BEG to END. |
744 | If BEG is nil, that stands for the beginning of STRING. | |
745 | If END is nil, that stands for the end of STRING. */ | |
746 | ||
76e20cb0 | 747 | static double |
382ac0bd | 748 | string_display_width (string, beg, end) |
c412c808 RS |
749 | Lisp_Object string, beg, end; |
750 | { | |
751 | register int col; | |
752 | register unsigned char *ptr, *stop; | |
753 | register int tab_seen; | |
754 | int post_tab; | |
755 | register int c; | |
756 | register int tab_width = XINT (current_buffer->tab_width); | |
757 | int ctl_arrow = !NILP (current_buffer->ctl_arrow); | |
d44f12b4 | 758 | register struct Lisp_Char_Table *dp = buffer_display_table (); |
c412c808 RS |
759 | int b, e; |
760 | ||
761 | if (NILP (end)) | |
d5db4077 | 762 | e = SCHARS (string); |
c412c808 RS |
763 | else |
764 | { | |
b7826503 | 765 | CHECK_NUMBER (end); |
c412c808 RS |
766 | e = XINT (end); |
767 | } | |
768 | ||
769 | if (NILP (beg)) | |
770 | b = 0; | |
771 | else | |
772 | { | |
b7826503 | 773 | CHECK_NUMBER (beg); |
c412c808 RS |
774 | b = XINT (beg); |
775 | } | |
776 | ||
777 | /* Make a pointer for decrementing through the chars before point. */ | |
d5db4077 | 778 | ptr = SDATA (string) + e; |
c412c808 RS |
779 | /* Make a pointer to where consecutive chars leave off, |
780 | going backwards from point. */ | |
d5db4077 | 781 | stop = SDATA (string) + b; |
c412c808 RS |
782 | |
783 | if (tab_width <= 0 || tab_width > 1000) tab_width = 8; | |
784 | ||
785 | col = 0, tab_seen = 0, post_tab = 0; | |
786 | ||
787 | while (1) | |
788 | { | |
789 | if (ptr == stop) | |
790 | break; | |
791 | ||
792 | c = *--ptr; | |
793 | if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c))) | |
794 | col += XVECTOR (DISP_CHAR_VECTOR (dp, c))->size; | |
795 | else if (c >= 040 && c < 0177) | |
796 | col++; | |
797 | else if (c == '\n') | |
798 | break; | |
799 | else if (c == '\t') | |
800 | { | |
801 | if (tab_seen) | |
802 | col = ((col + tab_width) / tab_width) * tab_width; | |
803 | ||
804 | post_tab += col; | |
805 | col = 0; | |
806 | tab_seen = 1; | |
807 | } | |
808 | else | |
809 | col += (ctl_arrow && c < 0200) ? 2 : 4; | |
810 | } | |
811 | ||
812 | if (tab_seen) | |
813 | { | |
814 | col = ((col + tab_width) / tab_width) * tab_width; | |
815 | col += post_tab; | |
816 | } | |
817 | ||
818 | return col; | |
819 | } | |
f4a6687d GM |
820 | |
821 | #endif /* 0 */ | |
822 | ||
c412c808 | 823 | \f |
993b6404 | 824 | DEFUN ("indent-to", Findent_to, Sindent_to, 1, 2, "NIndent to column: ", |
8c1a1077 | 825 | doc: /* Indent from point with tabs and spaces until COLUMN is reached. |
7bf120f1 | 826 | Optional second argument MINIMUM says always do at least MINIMUM spaces |
f64f035e EZ |
827 | even if that goes past COLUMN; by default, MINIMUM is zero. |
828 | ||
829 | The return value is COLUMN. */) | |
8c1a1077 | 830 | (column, minimum) |
04c98432 | 831 | Lisp_Object column, minimum; |
993b6404 JB |
832 | { |
833 | int mincol; | |
834 | register int fromcol; | |
835 | register int tab_width = XINT (current_buffer->tab_width); | |
836 | ||
b7826503 | 837 | CHECK_NUMBER (column); |
56a98455 | 838 | if (NILP (minimum)) |
94d92e9c | 839 | XSETFASTINT (minimum, 0); |
b7826503 | 840 | CHECK_NUMBER (minimum); |
993b6404 JB |
841 | |
842 | fromcol = current_column (); | |
843 | mincol = fromcol + XINT (minimum); | |
04c98432 | 844 | if (mincol < XINT (column)) mincol = XINT (column); |
993b6404 JB |
845 | |
846 | if (fromcol == mincol) | |
847 | return make_number (mincol); | |
848 | ||
ccdcf1f5 | 849 | if (tab_width <= 0 || tab_width > 1000) tab_width = 8; |
993b6404 JB |
850 | |
851 | if (indent_tabs_mode) | |
852 | { | |
853 | Lisp_Object n; | |
94d92e9c | 854 | XSETFASTINT (n, mincol / tab_width - fromcol / tab_width); |
993b6404 JB |
855 | if (XFASTINT (n) != 0) |
856 | { | |
6d1bd1a5 | 857 | Finsert_char (make_number ('\t'), n, Qt); |
993b6404 JB |
858 | |
859 | fromcol = (mincol / tab_width) * tab_width; | |
860 | } | |
861 | } | |
862 | ||
04c98432 EN |
863 | XSETFASTINT (column, mincol - fromcol); |
864 | Finsert_char (make_number (' '), column, Qt); | |
993b6404 JB |
865 | |
866 | last_known_column = mincol; | |
6ec8bbd2 | 867 | last_known_column_point = PT; |
993b6404 JB |
868 | last_known_column_modified = MODIFF; |
869 | ||
04c98432 EN |
870 | XSETINT (column, mincol); |
871 | return column; | |
993b6404 | 872 | } |
0aa01123 | 873 | |
993b6404 | 874 | \f |
76e20cb0 | 875 | static double position_indentation P_ ((int)); |
dfcf069d | 876 | |
993b6404 | 877 | DEFUN ("current-indentation", Fcurrent_indentation, Scurrent_indentation, |
8c1a1077 PJ |
878 | 0, 0, 0, |
879 | doc: /* Return the indentation of the current line. | |
880 | This is the horizontal position of the character | |
881 | following any initial whitespace. */) | |
882 | () | |
993b6404 JB |
883 | { |
884 | Lisp_Object val; | |
fe0066f5 RS |
885 | int opoint = PT, opoint_byte = PT_BYTE; |
886 | ||
887 | scan_newline (PT, PT_BYTE, BEGV, BEGV_BYTE, -1, 1); | |
993b6404 | 888 | |
097812fb | 889 | XSETFASTINT (val, (int) position_indentation (PT_BYTE)); /* iftc */ |
fe0066f5 | 890 | SET_PT_BOTH (opoint, opoint_byte); |
993b6404 JB |
891 | return val; |
892 | } | |
893 | ||
76e20cb0 | 894 | static double |
fe0066f5 RS |
895 | position_indentation (pos_byte) |
896 | register int pos_byte; | |
993b6404 | 897 | { |
83155776 SM |
898 | register EMACS_INT column = 0; |
899 | register EMACS_INT tab_width = XINT (current_buffer->tab_width); | |
993b6404 JB |
900 | register unsigned char *p; |
901 | register unsigned char *stop; | |
9a21bb64 | 902 | unsigned char *start; |
83155776 SM |
903 | EMACS_INT next_boundary_byte = pos_byte; |
904 | EMACS_INT ceiling = next_boundary_byte; | |
2ff4775b | 905 | |
ccdcf1f5 | 906 | if (tab_width <= 0 || tab_width > 1000) tab_width = 8; |
2ff4775b | 907 | |
fe0066f5 | 908 | p = BYTE_POS_ADDR (pos_byte); |
9a21bb64 RS |
909 | /* STOP records the value of P at which we will need |
910 | to think about the gap, or about invisible text, | |
911 | or about the end of the buffer. */ | |
912 | stop = p; | |
913 | /* START records the starting value of P. */ | |
914 | start = p; | |
993b6404 JB |
915 | while (1) |
916 | { | |
917 | while (p == stop) | |
918 | { | |
83155776 | 919 | EMACS_INT stop_pos_byte; |
9a21bb64 | 920 | |
fe0066f5 RS |
921 | /* If we have updated P, set POS_BYTE to match. |
922 | The first time we enter the loop, POS_BYTE is already right. */ | |
9a21bb64 | 923 | if (p != start) |
fe0066f5 | 924 | pos_byte = PTR_BYTE_POS (p); |
9a21bb64 | 925 | /* Consider the various reasons STOP might have been set here. */ |
fe0066f5 | 926 | if (pos_byte == ZV_BYTE) |
993b6404 | 927 | return column; |
fe0066f5 RS |
928 | if (pos_byte == next_boundary_byte) |
929 | { | |
83155776 SM |
930 | EMACS_INT next_boundary; |
931 | EMACS_INT pos = BYTE_TO_CHAR (pos_byte); | |
fe0066f5 RS |
932 | pos = skip_invisible (pos, &next_boundary, ZV, Qnil); |
933 | pos_byte = CHAR_TO_BYTE (pos); | |
934 | next_boundary_byte = CHAR_TO_BYTE (next_boundary); | |
935 | } | |
936 | if (pos_byte >= ceiling) | |
937 | ceiling = BUFFER_CEILING_OF (pos_byte) + 1; | |
9a21bb64 RS |
938 | /* Compute the next place we need to stop and think, |
939 | and set STOP accordingly. */ | |
fe0066f5 | 940 | stop_pos_byte = min (ceiling, next_boundary_byte); |
9a21bb64 | 941 | /* The -1 and +1 arrange to point at the first byte of gap |
fe0066f5 | 942 | (if STOP_POS_BYTE is the position of the gap) |
9a21bb64 | 943 | rather than at the data after the gap. */ |
097812fb | 944 | |
fe0066f5 RS |
945 | stop = BYTE_POS_ADDR (stop_pos_byte - 1) + 1; |
946 | p = BYTE_POS_ADDR (pos_byte); | |
993b6404 JB |
947 | } |
948 | switch (*p++) | |
949 | { | |
fb911777 KH |
950 | case 0240: |
951 | if (! NILP (current_buffer->enable_multibyte_characters)) | |
952 | return column; | |
993b6404 JB |
953 | case ' ': |
954 | column++; | |
955 | break; | |
956 | case '\t': | |
957 | column += tab_width - column % tab_width; | |
958 | break; | |
959 | default: | |
fb911777 KH |
960 | if (ASCII_BYTE_P (p[-1]) |
961 | || NILP (current_buffer->enable_multibyte_characters)) | |
962 | return column; | |
963 | { | |
fe0066f5 RS |
964 | int c; |
965 | pos_byte = PTR_BYTE_POS (p - 1); | |
966 | c = FETCH_MULTIBYTE_CHAR (pos_byte); | |
fb911777 KH |
967 | if (CHAR_HAS_CATEGORY (c, ' ')) |
968 | { | |
969 | column++; | |
fe0066f5 RS |
970 | INC_POS (pos_byte); |
971 | p = BYTE_POS_ADDR (pos_byte); | |
fb911777 KH |
972 | } |
973 | else | |
974 | return column; | |
975 | } | |
993b6404 JB |
976 | } |
977 | } | |
978 | } | |
1b15e576 KH |
979 | |
980 | /* Test whether the line beginning at POS is indented beyond COLUMN. | |
981 | Blank lines are treated as if they had the same indentation as the | |
982 | preceding line. */ | |
fe0066f5 | 983 | |
1b15e576 | 984 | int |
fe0066f5 | 985 | indented_beyond_p (pos, pos_byte, column) |
097812fb | 986 | int pos, pos_byte; |
76e20cb0 | 987 | double column; |
1b15e576 | 988 | { |
76e20cb0 | 989 | double val; |
fe0066f5 RS |
990 | int opoint = PT, opoint_byte = PT_BYTE; |
991 | ||
992 | SET_PT_BOTH (pos, pos_byte); | |
993 | while (PT > BEGV && FETCH_BYTE (PT_BYTE) == '\n') | |
994 | scan_newline (PT - 1, PT_BYTE - 1, BEGV, BEGV_BYTE, -1, 0); | |
995 | ||
d5d6f706 | 996 | val = position_indentation (PT_BYTE); |
fe0066f5 | 997 | SET_PT_BOTH (opoint, opoint_byte); |
097812fb | 998 | return val >= column; /* hmm, float comparison */ |
1b15e576 | 999 | } |
993b6404 | 1000 | \f |
782d260e | 1001 | DEFUN ("move-to-column", Fmove_to_column, Smove_to_column, 1, 2, "p", |
8c1a1077 | 1002 | doc: /* Move point to column COLUMN in the current line. |
3c860543 | 1003 | Interactively, COLUMN is the value of prefix numeric argument. |
8c1a1077 PJ |
1004 | The column of a character is calculated by adding together the widths |
1005 | as displayed of the previous characters in the line. | |
1006 | This function ignores line-continuation; | |
1007 | there is no upper limit on the column number a character can have | |
1008 | and horizontal scrolling has no effect. | |
1009 | ||
1010 | If specified column is within a character, point goes after that character. | |
1011 | If it's past end of line, point goes to end of line. | |
1012 | ||
3c860543 EZ |
1013 | Optional second argument FORCE non-nil means if COLUMN is in the |
1014 | middle of a tab character, change it to spaces. | |
1015 | In addition, if FORCE is t, and the line is too short to reach | |
1016 | COLUMN, add spaces/tabs to get there. | |
8c1a1077 PJ |
1017 | |
1018 | The return value is the current column. */) | |
1019 | (column, force) | |
993b6404 JB |
1020 | Lisp_Object column, force; |
1021 | { | |
ef6f5c0e SM |
1022 | EMACS_INT pos; |
1023 | EMACS_INT col, prev_col; | |
1024 | EMACS_INT goal; | |
fe0066f5 | 1025 | |
b7826503 | 1026 | CHECK_NATNUM (column); |
993b6404 JB |
1027 | goal = XINT (column); |
1028 | ||
ef6f5c0e SM |
1029 | col = goal; |
1030 | pos = ZV; | |
1031 | scan_for_column (&pos, &col, &prev_col); | |
993b6404 | 1032 | |
ef6f5c0e | 1033 | SET_PT (pos); |
4c669c09 | 1034 | |
ef6f5c0e SM |
1035 | /* If a tab char made us overshoot, change it to spaces |
1036 | and scan through it again. */ | |
1037 | if (!NILP (force) && col > goal) | |
993b6404 | 1038 | { |
4c92f429 | 1039 | int c; |
ef6f5c0e | 1040 | EMACS_INT pos_byte = PT_BYTE; |
d6e483a4 | 1041 | |
4c92f429 AS |
1042 | DEC_POS (pos_byte); |
1043 | c = FETCH_CHAR (pos_byte); | |
ef6f5c0e | 1044 | if (c == '\t' && prev_col < goal) |
d6e483a4 | 1045 | { |
ef6f5c0e SM |
1046 | EMACS_INT goal_pt, goal_pt_byte; |
1047 | ||
1048 | /* Insert spaces in front of the tab to reach GOAL. Do this | |
1049 | first so that a marker at the end of the tab gets | |
1050 | adjusted. */ | |
1051 | SET_PT_BOTH (PT - 1, PT_BYTE - 1); | |
1052 | Finsert_char (make_number (' '), make_number (goal - prev_col), Qt); | |
1053 | ||
1054 | /* Now delete the tab, and indent to COL. */ | |
1055 | del_range (PT, PT + 1); | |
1056 | goal_pt = PT; | |
1057 | goal_pt_byte = PT_BYTE; | |
1058 | Findent_to (make_number (col), Qnil); | |
1059 | SET_PT_BOTH (goal_pt, goal_pt_byte); | |
1060 | ||
1061 | /* Set the last_known... vars consistently. */ | |
1062 | col = goal; | |
a997a7ca | 1063 | } |
993b6404 JB |
1064 | } |
1065 | ||
1066 | /* If line ends prematurely, add space to the end. */ | |
de4075cf | 1067 | if (col < goal && EQ (force, Qt)) |
230a4cbd | 1068 | Findent_to (make_number (col = goal), Qnil); |
993b6404 JB |
1069 | |
1070 | last_known_column = col; | |
6ec8bbd2 | 1071 | last_known_column_point = PT; |
993b6404 JB |
1072 | last_known_column_modified = MODIFF; |
1073 | ||
ef6f5c0e | 1074 | return make_number (col); |
993b6404 JB |
1075 | } |
1076 | \f | |
0aa01123 JB |
1077 | /* compute_motion: compute buffer posn given screen posn and vice versa */ |
1078 | ||
993b6404 JB |
1079 | struct position val_compute_motion; |
1080 | ||
1081 | /* Scan the current buffer forward from offset FROM, pretending that | |
1082 | this is at line FROMVPOS, column FROMHPOS, until reaching buffer | |
1083 | offset TO or line TOVPOS, column TOHPOS (whichever comes first), | |
0aa01123 JB |
1084 | and return the ending buffer position and screen location. If we |
1085 | can't hit the requested column exactly (because of a tab or other | |
1086 | multi-column character), overshoot. | |
993b6404 | 1087 | |
2ab90d49 KH |
1088 | DID_MOTION is 1 if FROMHPOS has already accounted for overlay strings |
1089 | at FROM. This is the case if FROMVPOS and FROMVPOS came from an | |
1090 | earlier call to compute_motion. The other common case is that FROMHPOS | |
1091 | is zero and FROM is a position that "belongs" at column zero, but might | |
1092 | be shifted by overlay strings; in this case DID_MOTION should be 0. | |
1093 | ||
993b6404 JB |
1094 | WIDTH is the number of columns available to display text; |
1095 | compute_motion uses this to handle continuation lines and such. | |
361f14bf KS |
1096 | If WIDTH is -1, use width of window's text area adjusted for |
1097 | continuation glyph when needed. | |
1098 | ||
993b6404 JB |
1099 | HSCROLL is the number of columns not being displayed at the left |
1100 | margin; this is usually taken from a window's hscroll member. | |
a9764248 JB |
1101 | TAB_OFFSET is the number of columns of the first tab that aren't |
1102 | being displayed, perhaps because of a continuation line or | |
1103 | something. | |
993b6404 JB |
1104 | |
1105 | compute_motion returns a pointer to a struct position. The bufpos | |
1106 | member gives the buffer position at the end of the scan, and hpos | |
0aa01123 JB |
1107 | and vpos give its cartesian location. prevhpos is the column at |
1108 | which the character before bufpos started, and contin is non-zero | |
1109 | if we reached the current line by continuing the previous. | |
1110 | ||
1111 | Note that FROMHPOS and TOHPOS should be expressed in real screen | |
1112 | columns, taking HSCROLL and the truncation glyph at the left margin | |
1113 | into account. That is, beginning-of-line moves you to the hpos | |
1114 | -HSCROLL + (HSCROLL > 0). | |
993b6404 JB |
1115 | |
1116 | For example, to find the buffer position of column COL of line LINE | |
1117 | of a certain window, pass the window's starting location as FROM | |
1118 | and the window's upper-left coordinates as FROMVPOS and FROMHPOS. | |
1119 | Pass the buffer's ZV as TO, to limit the scan to the end of the | |
1120 | visible section of the buffer, and pass LINE and COL as TOVPOS and | |
2ff4775b | 1121 | TOHPOS. |
993b6404 JB |
1122 | |
1123 | When displaying in window w, a typical formula for WIDTH is: | |
1124 | ||
1125 | window_width - 1 | |
a3c87d4e | 1126 | - (has_vertical_scroll_bars |
90022f5a KS |
1127 | ? WINDOW_CONFIG_SCROLL_BAR_COLS (window) |
1128 | : (window_width + window_left != frame_cols)) | |
993b6404 JB |
1129 | |
1130 | where | |
90022f5a KS |
1131 | window_width is XFASTINT (w->total_cols), |
1132 | window_left is XFASTINT (w->left_col), | |
a3c87d4e | 1133 | has_vertical_scroll_bars is |
90022f5a KS |
1134 | WINDOW_HAS_VERTICAL_SCROLL_BAR (window) |
1135 | and frame_cols = FRAME_COLS (XFRAME (window->frame)) | |
993b6404 | 1136 | |
90022f5a KS |
1137 | Or you can let window_box_text_cols do this all for you, and write: |
1138 | window_box_text_cols (w) - 1 | |
fa61c701 JB |
1139 | |
1140 | The `-1' accounts for the continuation-line backslashes; the rest | |
7e7a76b5 | 1141 | accounts for window borders if the window is split horizontally, and |
1827d036 | 1142 | the scroll bars if they are turned on. */ |
993b6404 JB |
1143 | |
1144 | struct position * | |
2ab90d49 | 1145 | compute_motion (from, fromvpos, fromhpos, did_motion, to, tovpos, tohpos, width, hscroll, tab_offset, win) |
83155776 | 1146 | EMACS_INT from, fromvpos, fromhpos, to, tovpos, tohpos; |
2ab90d49 | 1147 | int did_motion; |
83155776 SM |
1148 | EMACS_INT width; |
1149 | EMACS_INT hscroll, tab_offset; | |
88af3af4 | 1150 | struct window *win; |
993b6404 | 1151 | { |
83155776 SM |
1152 | register EMACS_INT hpos = fromhpos; |
1153 | register EMACS_INT vpos = fromvpos; | |
cde9337b | 1154 | |
83155776 SM |
1155 | register EMACS_INT pos; |
1156 | EMACS_INT pos_byte; | |
6bbd7a29 | 1157 | register int c = 0; |
83155776 | 1158 | register EMACS_INT tab_width = XFASTINT (current_buffer->tab_width); |
56a98455 | 1159 | register int ctl_arrow = !NILP (current_buffer->ctl_arrow); |
d44f12b4 | 1160 | register struct Lisp_Char_Table *dp = window_display_table (win); |
993b6404 | 1161 | int selective |
eeaafd4f | 1162 | = (INTEGERP (current_buffer->selective_display) |
69eaf10d RS |
1163 | ? XINT (current_buffer->selective_display) |
1164 | : !NILP (current_buffer->selective_display) ? -1 : 0); | |
993b6404 | 1165 | int selective_rlen |
eeaafd4f | 1166 | = (selective && dp && VECTORP (DISP_INVIS_VECTOR (dp)) |
dea4d2e6 | 1167 | ? XVECTOR (DISP_INVIS_VECTOR (dp))->size : 0); |
2ab90d49 KH |
1168 | /* The next location where the `invisible' property changes, or an |
1169 | overlay starts or ends. */ | |
83155776 | 1170 | EMACS_INT next_boundary = from; |
993b6404 | 1171 | |
0aa01123 JB |
1172 | /* For computing runs of characters with similar widths. |
1173 | Invariant: width_run_width is zero, or all the characters | |
2ff4775b | 1174 | from width_run_start to width_run_end have a fixed width of |
0aa01123 | 1175 | width_run_width. */ |
83155776 SM |
1176 | EMACS_INT width_run_start = from; |
1177 | EMACS_INT width_run_end = from; | |
1178 | EMACS_INT width_run_width = 0; | |
0aa01123 | 1179 | Lisp_Object *width_table; |
66c75ca5 | 1180 | Lisp_Object buffer; |
0aa01123 JB |
1181 | |
1182 | /* The next buffer pos where we should consult the width run cache. */ | |
83155776 | 1183 | EMACS_INT next_width_run = from; |
0e435804 | 1184 | Lisp_Object window; |
0aa01123 | 1185 | |
a997a7ca | 1186 | int multibyte = !NILP (current_buffer->enable_multibyte_characters); |
c71c19f4 RS |
1187 | /* If previous char scanned was a wide character, |
1188 | this is the column where it ended. Otherwise, this is 0. */ | |
83155776 SM |
1189 | EMACS_INT wide_column_end_hpos = 0; |
1190 | EMACS_INT prev_pos; /* Previous buffer position. */ | |
1191 | EMACS_INT prev_pos_byte; /* Previous buffer position. */ | |
1192 | EMACS_INT prev_hpos = 0; | |
1193 | EMACS_INT prev_vpos = 0; | |
1194 | EMACS_INT contin_hpos; /* HPOS of last column of continued line. */ | |
1195 | EMACS_INT prev_tab_offset; /* Previous tab offset. */ | |
1196 | EMACS_INT continuation_glyph_width; | |
a997a7ca | 1197 | |
66c75ca5 | 1198 | XSETBUFFER (buffer, current_buffer); |
0e435804 | 1199 | XSETWINDOW (window, win); |
66c75ca5 | 1200 | |
0aa01123 JB |
1201 | width_run_cache_on_off (); |
1202 | if (dp == buffer_display_table ()) | |
1203 | width_table = (VECTORP (current_buffer->width_table) | |
1204 | ? XVECTOR (current_buffer->width_table)->contents | |
1205 | : 0); | |
1206 | else | |
1207 | /* If the window has its own display table, we can't use the width | |
1208 | run cache, because that's based on the buffer's display table. */ | |
1209 | width_table = 0; | |
1210 | ||
e4500116 GM |
1211 | if (tab_width <= 0 || tab_width > 1000) |
1212 | tab_width = 8; | |
1213 | ||
361f14bf KS |
1214 | /* Negative width means use all available text columns. */ |
1215 | if (width < 0) | |
1216 | { | |
1217 | width = window_box_text_cols (win); | |
1218 | /* We must make room for continuation marks if we don't have fringes. */ | |
1219 | #ifdef HAVE_WINDOW_SYSTEM | |
1220 | if (!FRAME_WINDOW_P (XFRAME (win->frame))) | |
1221 | #endif | |
1222 | width -= 1; | |
1223 | } | |
1224 | ||
8cc08515 | 1225 | continuation_glyph_width = 1; |
ed5c373c | 1226 | #ifdef HAVE_WINDOW_SYSTEM |
8cc08515 KS |
1227 | if (FRAME_WINDOW_P (XFRAME (win->frame))) |
1228 | continuation_glyph_width = 0; /* In the fringe. */ | |
ed5c373c KS |
1229 | #endif |
1230 | ||
e4500116 GM |
1231 | immediate_quit = 1; |
1232 | QUIT; | |
cde9337b | 1233 | |
a997a7ca | 1234 | pos = prev_pos = from; |
fe0066f5 | 1235 | pos_byte = prev_pos_byte = CHAR_TO_BYTE (from); |
a997a7ca KH |
1236 | contin_hpos = 0; |
1237 | prev_tab_offset = tab_offset; | |
2ab90d49 KH |
1238 | while (1) |
1239 | { | |
1240 | while (pos == next_boundary) | |
f75c0f8a | 1241 | { |
83155776 SM |
1242 | EMACS_INT pos_here = pos; |
1243 | EMACS_INT newpos; | |
98136db3 | 1244 | |
f9ba10b0 | 1245 | /* Don't skip invisible if we are already at the margin. */ |
8a00d895 | 1246 | if (vpos > tovpos || (vpos == tovpos && hpos >= tohpos)) |
f9ba10b0 RS |
1247 | { |
1248 | if (contin_hpos && prev_hpos == 0 | |
1249 | && hpos > tohpos | |
1250 | && (contin_hpos == width || wide_column_end_hpos > width)) | |
1251 | { /* Line breaks because we can't put the character at the | |
1252 | previous line any more. It is not the multi-column | |
1253 | character continued in middle. Go back to previous | |
1254 | buffer position, screen position, and set tab offset | |
1255 | to previous value. It's the beginning of the | |
1256 | line. */ | |
1257 | pos = prev_pos; | |
1258 | pos_byte = prev_pos_byte; | |
1259 | hpos = prev_hpos; | |
6b61353c | 1260 | vpos = prev_vpos; |
f9ba10b0 RS |
1261 | tab_offset = prev_tab_offset; |
1262 | } | |
1263 | break; | |
1264 | } | |
1265 | ||
2ab90d49 KH |
1266 | /* If the caller says that the screen position came from an earlier |
1267 | call to compute_motion, then we've already accounted for the | |
1268 | overlay strings at point. This is only true the first time | |
1269 | through, so clear the flag after testing it. */ | |
1270 | if (!did_motion) | |
1271 | /* We need to skip past the overlay strings. Currently those | |
a997a7ca | 1272 | strings must not contain TAB; |
2ab90d49 KH |
1273 | if we want to relax that restriction, something will have |
1274 | to be changed here. */ | |
a997a7ca KH |
1275 | { |
1276 | unsigned char *ovstr; | |
1277 | int ovlen = overlay_strings (pos, win, &ovstr); | |
4116deee KH |
1278 | hpos += ((multibyte && ovlen > 0) |
1279 | ? strwidth (ovstr, ovlen) : ovlen); | |
a997a7ca | 1280 | } |
2ab90d49 KH |
1281 | did_motion = 0; |
1282 | ||
1283 | if (pos >= to) | |
1284 | break; | |
66c75ca5 | 1285 | |
9a21bb64 RS |
1286 | /* Advance POS past invisible characters |
1287 | (but not necessarily all that there are here), | |
1288 | and store in next_boundary the next position where | |
1289 | we need to call skip_invisible. */ | |
98136db3 RS |
1290 | newpos = skip_invisible (pos, &next_boundary, to, window); |
1291 | ||
1292 | if (newpos >= to) | |
e8cb089b RS |
1293 | { |
1294 | pos = min (to, newpos); | |
bcfbd63d | 1295 | pos_byte = CHAR_TO_BYTE (pos); |
e8cb089b RS |
1296 | goto after_loop; |
1297 | } | |
98136db3 | 1298 | |
fe0066f5 RS |
1299 | if (newpos != pos_here) |
1300 | { | |
1301 | pos = newpos; | |
1302 | pos_byte = CHAR_TO_BYTE (pos); | |
1303 | } | |
f75c0f8a | 1304 | } |
2ab90d49 KH |
1305 | |
1306 | /* Handle right margin. */ | |
a997a7ca KH |
1307 | /* Note on a wide-column character. |
1308 | ||
1309 | Characters are classified into the following three categories | |
1310 | according to the width (columns occupied on screen). | |
1311 | ||
1312 | (1) single-column character: ex. `a' | |
1313 | (2) multi-column character: ex. `^A', TAB, `\033' | |
1314 | (3) wide-column character: ex. Japanese character, Chinese character | |
1315 | (In the following example, `W_' stands for them.) | |
1316 | ||
1317 | Multi-column characters can be divided around the right margin, | |
1318 | but wide-column characters cannot. | |
1319 | ||
1320 | NOTE: | |
1321 | ||
1322 | (*) The cursor is placed on the next character after the point. | |
1323 | ||
1324 | ---------- | |
1325 | abcdefghi\ | |
1326 | j ^---- next after the point | |
1327 | ^--- next char. after the point. | |
1328 | ---------- | |
1329 | In case of sigle-column character | |
1330 | ||
1331 | ---------- | |
1332 | abcdefgh\\ | |
1333 | 033 ^---- next after the point, next char. after the point. | |
1334 | ---------- | |
1335 | In case of multi-column character | |
1336 | ||
1337 | ---------- | |
1338 | abcdefgh\\ | |
1339 | W_ ^---- next after the point | |
1340 | ^---- next char. after the point. | |
1341 | ---------- | |
097812fb | 1342 | In case of wide-column character |
a997a7ca KH |
1343 | |
1344 | The problem here is continuation at a wide-column character. | |
1345 | In this case, the line may shorter less than WIDTH. | |
1346 | And we find the continuation AFTER it occurs. | |
1347 | ||
1348 | */ | |
1349 | ||
1350 | if (hpos > width) | |
2ab90d49 | 1351 | { |
81b6a665 CY |
1352 | int total_width = width + continuation_glyph_width; |
1353 | int truncate = 0; | |
1354 | ||
1355 | if (!NILP (Vtruncate_partial_width_windows) | |
1356 | && (total_width < FRAME_COLS (XFRAME (WINDOW_FRAME (win))))) | |
1357 | { | |
1358 | if (INTEGERP (Vtruncate_partial_width_windows)) | |
1359 | truncate | |
1360 | = total_width < XFASTINT (Vtruncate_partial_width_windows); | |
1361 | else | |
1362 | truncate = 1; | |
1363 | } | |
1364 | ||
1365 | if (hscroll || truncate | |
2ab90d49 KH |
1366 | || !NILP (current_buffer->truncate_lines)) |
1367 | { | |
529724fe AS |
1368 | /* Truncating: skip to newline, unless we are already past |
1369 | TO (we need to go back below). */ | |
1370 | if (pos <= to) | |
fe0066f5 RS |
1371 | { |
1372 | pos = find_before_next_newline (pos, to, 1); | |
1373 | pos_byte = CHAR_TO_BYTE (pos); | |
529724fe AS |
1374 | hpos = width; |
1375 | /* If we just skipped next_boundary, | |
1376 | loop around in the main while | |
1377 | and handle it. */ | |
1378 | if (pos >= next_boundary) | |
1379 | next_boundary = pos + 1; | |
1380 | prev_hpos = width; | |
6b61353c | 1381 | prev_vpos = vpos; |
529724fe | 1382 | prev_tab_offset = tab_offset; |
fe0066f5 | 1383 | } |
2ab90d49 KH |
1384 | } |
1385 | else | |
1386 | { | |
1387 | /* Continuing. */ | |
a997a7ca KH |
1388 | /* Remember the previous value. */ |
1389 | prev_tab_offset = tab_offset; | |
1390 | ||
c9c0f7cf | 1391 | if (wide_column_end_hpos > width) |
a997a7ca KH |
1392 | { |
1393 | hpos -= prev_hpos; | |
1394 | tab_offset += prev_hpos; | |
1395 | } | |
1396 | else | |
1397 | { | |
1398 | tab_offset += width; | |
1399 | hpos -= width; | |
1400 | } | |
1401 | vpos++; | |
1402 | contin_hpos = prev_hpos; | |
1403 | prev_hpos = 0; | |
6cbc951e | 1404 | prev_vpos = vpos; |
2ab90d49 KH |
1405 | } |
1406 | } | |
1407 | ||
1408 | /* Stop if past the target buffer position or screen position. */ | |
33fe7d20 | 1409 | if (pos > to) |
a997a7ca KH |
1410 | { |
1411 | /* Go back to the previous position. */ | |
1412 | pos = prev_pos; | |
fe0066f5 | 1413 | pos_byte = prev_pos_byte; |
a997a7ca | 1414 | hpos = prev_hpos; |
6b61353c | 1415 | vpos = prev_vpos; |
a997a7ca KH |
1416 | tab_offset = prev_tab_offset; |
1417 | ||
1418 | /* NOTE on contin_hpos, hpos, and prev_hpos. | |
1419 | ||
1420 | ---------- | |
1421 | abcdefgh\\ | |
1422 | W_ ^---- contin_hpos | |
1423 | | ^----- hpos | |
1424 | \---- prev_hpos | |
1425 | ---------- | |
1426 | */ | |
1427 | ||
1428 | if (contin_hpos && prev_hpos == 0 | |
c9c0f7cf | 1429 | && contin_hpos < width && !wide_column_end_hpos) |
a997a7ca KH |
1430 | { |
1431 | /* Line breaking occurs in the middle of multi-column | |
1432 | character. Go back to previous line. */ | |
1433 | hpos = contin_hpos; | |
1434 | vpos = vpos - 1; | |
1435 | } | |
a997a7ca KH |
1436 | break; |
1437 | } | |
1438 | ||
8a00d895 | 1439 | if (vpos > tovpos || (vpos == tovpos && hpos >= tohpos)) |
33fe7d20 RS |
1440 | { |
1441 | if (contin_hpos && prev_hpos == 0 | |
9129bcc3 KH |
1442 | && hpos > tohpos |
1443 | && (contin_hpos == width || wide_column_end_hpos > width)) | |
33fe7d20 RS |
1444 | { /* Line breaks because we can't put the character at the |
1445 | previous line any more. It is not the multi-column | |
1446 | character continued in middle. Go back to previous | |
1447 | buffer position, screen position, and set tab offset | |
1448 | to previous value. It's the beginning of the | |
1449 | line. */ | |
1450 | pos = prev_pos; | |
1451 | pos_byte = prev_pos_byte; | |
1452 | hpos = prev_hpos; | |
6b61353c | 1453 | vpos = prev_vpos; |
33fe7d20 RS |
1454 | tab_offset = prev_tab_offset; |
1455 | } | |
1456 | break; | |
1457 | } | |
a997a7ca | 1458 | if (pos == ZV) /* We cannot go beyond ZV. Stop here. */ |
2ab90d49 KH |
1459 | break; |
1460 | ||
2ab90d49 | 1461 | prev_hpos = hpos; |
6b61353c | 1462 | prev_vpos = vpos; |
a997a7ca | 1463 | prev_pos = pos; |
fe0066f5 | 1464 | prev_pos_byte = pos_byte; |
c9c0f7cf | 1465 | wide_column_end_hpos = 0; |
0aa01123 JB |
1466 | |
1467 | /* Consult the width run cache to see if we can avoid inspecting | |
1468 | the text character-by-character. */ | |
1469 | if (current_buffer->width_run_cache && pos >= next_width_run) | |
1470 | { | |
1471 | int run_end; | |
1472 | int common_width | |
1473 | = region_cache_forward (current_buffer, | |
1474 | current_buffer->width_run_cache, | |
1475 | pos, &run_end); | |
1476 | ||
1477 | /* A width of zero means the character's width varies (like | |
1478 | a tab), is meaningless (like a newline), or we just don't | |
1479 | want to skip over it for some other reason. */ | |
1480 | if (common_width != 0) | |
1481 | { | |
1482 | int run_end_hpos; | |
1483 | ||
1484 | /* Don't go past the final buffer posn the user | |
1485 | requested. */ | |
1486 | if (run_end > to) | |
1487 | run_end = to; | |
1488 | ||
1489 | run_end_hpos = hpos + (run_end - pos) * common_width; | |
1490 | ||
1491 | /* Don't go past the final horizontal position the user | |
1492 | requested. */ | |
1493 | if (vpos == tovpos && run_end_hpos > tohpos) | |
1494 | { | |
1495 | run_end = pos + (tohpos - hpos) / common_width; | |
1496 | run_end_hpos = hpos + (run_end - pos) * common_width; | |
1497 | } | |
2ff4775b | 1498 | |
0aa01123 JB |
1499 | /* Don't go past the margin. */ |
1500 | if (run_end_hpos >= width) | |
1501 | { | |
1502 | run_end = pos + (width - hpos) / common_width; | |
1503 | run_end_hpos = hpos + (run_end - pos) * common_width; | |
1504 | } | |
1505 | ||
1506 | hpos = run_end_hpos; | |
1507 | if (run_end > pos) | |
1508 | prev_hpos = hpos - common_width; | |
fe0066f5 RS |
1509 | if (pos != run_end) |
1510 | { | |
1511 | pos = run_end; | |
1512 | pos_byte = CHAR_TO_BYTE (pos); | |
1513 | } | |
0aa01123 JB |
1514 | } |
1515 | ||
1516 | next_width_run = run_end + 1; | |
1517 | } | |
1518 | ||
1519 | /* We have to scan the text character-by-character. */ | |
993b6404 | 1520 | else |
2ab90d49 | 1521 | { |
88c6e37e GM |
1522 | EMACS_INT i, n; |
1523 | Lisp_Object charvec; | |
097812fb | 1524 | |
fe0066f5 | 1525 | c = FETCH_BYTE (pos_byte); |
012fd715 KH |
1526 | |
1527 | /* Check composition sequence. */ | |
1528 | { | |
1529 | int len, len_byte, width; | |
1530 | ||
1531 | if (check_composition (pos, pos_byte, to, &len, &len_byte, &width)) | |
1532 | { | |
1533 | pos += len; | |
1534 | pos_byte += len_byte; | |
1535 | hpos += width; | |
1536 | continue; | |
1537 | } | |
1538 | } | |
1539 | ||
fe0066f5 | 1540 | pos++, pos_byte++; |
0aa01123 | 1541 | |
2ab90d49 KH |
1542 | /* Perhaps add some info to the width_run_cache. */ |
1543 | if (current_buffer->width_run_cache) | |
1544 | { | |
1545 | /* Is this character part of the current run? If so, extend | |
1546 | the run. */ | |
1547 | if (pos - 1 == width_run_end | |
5db0afb7 | 1548 | && XFASTINT (width_table[c]) == width_run_width) |
2ab90d49 KH |
1549 | width_run_end = pos; |
1550 | ||
1551 | /* The previous run is over, since this is a character at a | |
1552 | different position, or a different width. */ | |
1553 | else | |
1554 | { | |
1555 | /* Have we accumulated a run to put in the cache? | |
1556 | (Currently, we only cache runs of width == 1). */ | |
1557 | if (width_run_start < width_run_end | |
1558 | && width_run_width == 1) | |
1559 | know_region_cache (current_buffer, | |
1560 | current_buffer->width_run_cache, | |
1561 | width_run_start, width_run_end); | |
1562 | ||
1563 | /* Start recording a new width run. */ | |
5db0afb7 | 1564 | width_run_width = XFASTINT (width_table[c]); |
2ab90d49 KH |
1565 | width_run_start = pos - 1; |
1566 | width_run_end = pos; | |
1567 | } | |
1568 | } | |
993b6404 | 1569 | |
c9c0f7cf KH |
1570 | if (dp != 0 |
1571 | && ! (multibyte && BASE_LEADING_CODE_P (c)) | |
1572 | && VECTORP (DISP_CHAR_VECTOR (dp, c))) | |
993b6404 | 1573 | { |
88c6e37e GM |
1574 | charvec = DISP_CHAR_VECTOR (dp, c); |
1575 | n = ASIZE (charvec); | |
993b6404 | 1576 | } |
88c6e37e | 1577 | else |
993b6404 | 1578 | { |
88c6e37e GM |
1579 | charvec = Qnil; |
1580 | n = 1; | |
1581 | } | |
1582 | ||
1583 | for (i = n - 1; i >= 0; --i) | |
1584 | { | |
1585 | if (VECTORP (charvec)) | |
2ab90d49 | 1586 | { |
88c6e37e GM |
1587 | /* This should be handled the same as |
1588 | next_element_from_display_vector does it. */ | |
1589 | Lisp_Object entry = AREF (charvec, i); | |
097812fb | 1590 | |
f59836fe KS |
1591 | if (GLYPH_CODE_P (entry) |
1592 | && GLYPH_CODE_CHAR_VALID_P (entry)) | |
1593 | c = GLYPH_CODE_CHAR (entry); | |
88c6e37e GM |
1594 | else |
1595 | c = ' '; | |
1596 | } | |
097812fb | 1597 | |
88c6e37e GM |
1598 | if (c >= 040 && c < 0177) |
1599 | hpos++; | |
1600 | else if (c == '\t') | |
1601 | { | |
1602 | int tem = ((hpos + tab_offset + hscroll - (hscroll > 0)) | |
1603 | % tab_width); | |
1604 | if (tem < 0) | |
1605 | tem += tab_width; | |
1606 | hpos += tab_width - tem; | |
1607 | } | |
1608 | else if (c == '\n') | |
1609 | { | |
1610 | if (selective > 0 | |
097812fb | 1611 | && indented_beyond_p (pos, pos_byte, |
76e20cb0 | 1612 | (double) selective)) /* iftc */ |
2ab90d49 | 1613 | { |
88c6e37e GM |
1614 | /* If (pos == to), we don't have to take care of |
1615 | selective display. */ | |
1616 | if (pos < to) | |
fe0066f5 | 1617 | { |
88c6e37e GM |
1618 | /* Skip any number of invisible lines all at once */ |
1619 | do | |
1620 | { | |
1621 | pos = find_before_next_newline (pos, to, 1); | |
1622 | if (pos < to) | |
1623 | pos++; | |
1624 | pos_byte = CHAR_TO_BYTE (pos); | |
1625 | } | |
1626 | while (pos < to | |
097812fb | 1627 | && indented_beyond_p (pos, pos_byte, |
76e20cb0 | 1628 | (double) selective)); /* iftc */ |
88c6e37e GM |
1629 | /* Allow for the " ..." that is displayed for them. */ |
1630 | if (selective_rlen) | |
1631 | { | |
1632 | hpos += selective_rlen; | |
1633 | if (hpos >= width) | |
1634 | hpos = width; | |
1635 | } | |
1636 | DEC_BOTH (pos, pos_byte); | |
1637 | /* We have skipped the invis text, but not the | |
1638 | newline after. */ | |
fe0066f5 | 1639 | } |
2ab90d49 | 1640 | } |
88c6e37e GM |
1641 | else |
1642 | { | |
1643 | /* A visible line. */ | |
1644 | vpos++; | |
1645 | hpos = 0; | |
1646 | hpos -= hscroll; | |
1647 | /* Count the truncation glyph on column 0 */ | |
1648 | if (hscroll > 0) | |
ed5c373c | 1649 | hpos += continuation_glyph_width; |
88c6e37e GM |
1650 | tab_offset = 0; |
1651 | } | |
1652 | contin_hpos = 0; | |
2ab90d49 | 1653 | } |
88c6e37e | 1654 | else if (c == CR && selective < 0) |
fe0066f5 | 1655 | { |
88c6e37e GM |
1656 | /* In selective display mode, |
1657 | everything from a ^M to the end of the line is invisible. | |
1658 | Stop *before* the real newline. */ | |
1659 | if (pos < to) | |
1660 | { | |
1661 | pos = find_before_next_newline (pos, to, 1); | |
1662 | pos_byte = CHAR_TO_BYTE (pos); | |
1663 | } | |
1664 | /* If we just skipped next_boundary, | |
1665 | loop around in the main while | |
1666 | and handle it. */ | |
1667 | if (pos > next_boundary) | |
1668 | next_boundary = pos; | |
1669 | /* Allow for the " ..." that is displayed for them. */ | |
1670 | if (selective_rlen) | |
1671 | { | |
1672 | hpos += selective_rlen; | |
1673 | if (hpos >= width) | |
1674 | hpos = width; | |
1675 | } | |
fe0066f5 | 1676 | } |
88c6e37e | 1677 | else if (multibyte && BASE_LEADING_CODE_P (c)) |
2ab90d49 | 1678 | { |
88c6e37e GM |
1679 | /* Start of multi-byte form. */ |
1680 | unsigned char *ptr; | |
1681 | int bytes, width, wide_column; | |
1682 | ||
1683 | pos_byte--; /* rewind POS_BYTE */ | |
1684 | ptr = BYTE_POS_ADDR (pos_byte); | |
1685 | MULTIBYTE_BYTES_WIDTH (ptr, dp); | |
1686 | pos_byte += bytes; | |
1687 | if (wide_column) | |
1688 | wide_column_end_hpos = hpos + wide_column; | |
1689 | hpos += width; | |
2ab90d49 | 1690 | } |
f1004faf GM |
1691 | else if (VECTORP (charvec)) |
1692 | ++hpos; | |
88c6e37e GM |
1693 | else |
1694 | hpos += (ctl_arrow && c < 0200) ? 2 : 4; | |
2ab90d49 | 1695 | } |
993b6404 JB |
1696 | } |
1697 | } | |
1698 | ||
98136db3 RS |
1699 | after_loop: |
1700 | ||
0aa01123 JB |
1701 | /* Remember any final width run in the cache. */ |
1702 | if (current_buffer->width_run_cache | |
1703 | && width_run_width == 1 | |
1704 | && width_run_start < width_run_end) | |
1705 | know_region_cache (current_buffer, current_buffer->width_run_cache, | |
1706 | width_run_start, width_run_end); | |
1707 | ||
993b6404 | 1708 | val_compute_motion.bufpos = pos; |
fe0066f5 | 1709 | val_compute_motion.bytepos = pos_byte; |
cde9337b JB |
1710 | val_compute_motion.hpos = hpos; |
1711 | val_compute_motion.vpos = vpos; | |
ef3af330 AS |
1712 | if (contin_hpos && prev_hpos == 0) |
1713 | val_compute_motion.prevhpos = contin_hpos; | |
1714 | else | |
1715 | val_compute_motion.prevhpos = prev_hpos; | |
927b5a55 RS |
1716 | /* We alalways handle all of them here; none of them remain to do. */ |
1717 | val_compute_motion.ovstring_chars_done = 0; | |
993b6404 JB |
1718 | |
1719 | /* Nonzero if have just continued a line */ | |
a997a7ca | 1720 | val_compute_motion.contin = (contin_hpos && prev_hpos == 0); |
993b6404 | 1721 | |
e4500116 | 1722 | immediate_quit = 0; |
993b6404 JB |
1723 | return &val_compute_motion; |
1724 | } | |
993b6404 | 1725 | |
8720a429 | 1726 | |
88af3af4 | 1727 | DEFUN ("compute-motion", Fcompute_motion, Scompute_motion, 7, 7, 0, |
8c1a1077 PJ |
1728 | doc: /* Scan through the current buffer, calculating screen position. |
1729 | Scan the current buffer forward from offset FROM, | |
1730 | assuming it is at position FROMPOS--a cons of the form (HPOS . VPOS)-- | |
1731 | to position TO or position TOPOS--another cons of the form (HPOS . VPOS)-- | |
1732 | and return the ending buffer position and screen location. | |
1733 | ||
361f14bf KS |
1734 | If TOPOS is nil, the actual width and height of the window's |
1735 | text area are used. | |
1736 | ||
8c1a1077 PJ |
1737 | There are three additional arguments: |
1738 | ||
1739 | WIDTH is the number of columns available to display text; | |
361f14bf KS |
1740 | this affects handling of continuation lines. A value of nil |
1741 | corresponds to the actual number of available text columns. | |
8c1a1077 PJ |
1742 | |
1743 | OFFSETS is either nil or a cons cell (HSCROLL . TAB-OFFSET). | |
1744 | HSCROLL is the number of columns not being displayed at the left | |
1745 | margin; this is usually taken from a window's hscroll member. | |
1746 | TAB-OFFSET is the number of columns of the first tab that aren't | |
1747 | being displayed, perhaps because the line was continued within it. | |
1748 | If OFFSETS is nil, HSCROLL and TAB-OFFSET are assumed to be zero. | |
1749 | ||
1750 | WINDOW is the window to operate on. It is used to choose the display table; | |
1751 | if it is showing the current buffer, it is used also for | |
1752 | deciding which overlay properties apply. | |
1753 | Note that `compute-motion' always operates on the current buffer. | |
1754 | ||
1755 | The value is a list of five elements: | |
1756 | (POS HPOS VPOS PREVHPOS CONTIN) | |
1757 | POS is the buffer position where the scan stopped. | |
1758 | VPOS is the vertical position where the scan stopped. | |
1759 | HPOS is the horizontal position where the scan stopped. | |
1760 | ||
1761 | PREVHPOS is the horizontal position one character back from POS. | |
1762 | CONTIN is t if a line was continued after (or within) the previous character. | |
1763 | ||
1764 | For example, to find the buffer position of column COL of line LINE | |
1765 | of a certain window, pass the window's starting location as FROM | |
1766 | and the window's upper-left coordinates as FROMPOS. | |
1767 | Pass the buffer's (point-max) as TO, to limit the scan to the end of the | |
1768 | visible section of the buffer, and pass LINE and COL as TOPOS. */) | |
1769 | (from, frompos, to, topos, width, offsets, window) | |
42918ba5 | 1770 | Lisp_Object from, frompos, to, topos; |
88af3af4 | 1771 | Lisp_Object width, offsets, window; |
42918ba5 | 1772 | { |
361f14bf | 1773 | struct window *w; |
8798a92b | 1774 | Lisp_Object bufpos, hpos, vpos, prevhpos; |
42918ba5 RS |
1775 | struct position *pos; |
1776 | int hscroll, tab_offset; | |
1777 | ||
b7826503 PJ |
1778 | CHECK_NUMBER_COERCE_MARKER (from); |
1779 | CHECK_CONS (frompos); | |
1780 | CHECK_NUMBER_CAR (frompos); | |
1781 | CHECK_NUMBER_CDR (frompos); | |
1782 | CHECK_NUMBER_COERCE_MARKER (to); | |
361f14bf KS |
1783 | if (!NILP (topos)) |
1784 | { | |
1785 | CHECK_CONS (topos); | |
1786 | CHECK_NUMBER_CAR (topos); | |
1787 | CHECK_NUMBER_CDR (topos); | |
1788 | } | |
1789 | if (!NILP (width)) | |
1790 | CHECK_NUMBER (width); | |
1791 | ||
42918ba5 RS |
1792 | if (!NILP (offsets)) |
1793 | { | |
b7826503 PJ |
1794 | CHECK_CONS (offsets); |
1795 | CHECK_NUMBER_CAR (offsets); | |
1796 | CHECK_NUMBER_CDR (offsets); | |
70949dac KR |
1797 | hscroll = XINT (XCAR (offsets)); |
1798 | tab_offset = XINT (XCDR (offsets)); | |
42918ba5 RS |
1799 | } |
1800 | else | |
1801 | hscroll = tab_offset = 0; | |
1802 | ||
88af3af4 KH |
1803 | if (NILP (window)) |
1804 | window = Fselected_window (); | |
1805 | else | |
b7826503 | 1806 | CHECK_LIVE_WINDOW (window); |
361f14bf | 1807 | w = XWINDOW (window); |
88af3af4 | 1808 | |
9fdae274 KH |
1809 | if (XINT (from) < BEGV || XINT (from) > ZV) |
1810 | args_out_of_range_3 (from, make_number (BEGV), make_number (ZV)); | |
1811 | if (XINT (to) < BEGV || XINT (to) > ZV) | |
1812 | args_out_of_range_3 (to, make_number (BEGV), make_number (ZV)); | |
1813 | ||
70949dac KR |
1814 | pos = compute_motion (XINT (from), XINT (XCDR (frompos)), |
1815 | XINT (XCAR (frompos)), 0, | |
361f14bf KS |
1816 | XINT (to), |
1817 | (NILP (topos) | |
1818 | ? window_internal_height (w) | |
1819 | : XINT (XCDR (topos))), | |
1820 | (NILP (topos) | |
1821 | ? (window_box_text_cols (w) | |
1822 | - ( | |
1823 | #ifdef HAVE_WINDOW_SYSTEM | |
1824 | FRAME_WINDOW_P (XFRAME (w->frame)) ? 0 : | |
1825 | #endif | |
1826 | 1)) | |
1827 | : XINT (XCAR (topos))), | |
1828 | (NILP (width) ? -1 : XINT (width)), | |
1829 | hscroll, tab_offset, | |
88af3af4 | 1830 | XWINDOW (window)); |
42918ba5 | 1831 | |
94d92e9c | 1832 | XSETFASTINT (bufpos, pos->bufpos); |
f8f645a1 KH |
1833 | XSETINT (hpos, pos->hpos); |
1834 | XSETINT (vpos, pos->vpos); | |
1835 | XSETINT (prevhpos, pos->prevhpos); | |
42918ba5 RS |
1836 | |
1837 | return Fcons (bufpos, | |
1838 | Fcons (hpos, | |
1839 | Fcons (vpos, | |
1840 | Fcons (prevhpos, | |
1841 | Fcons (pos->contin ? Qt : Qnil, Qnil))))); | |
1842 | ||
1843 | } | |
993b6404 | 1844 | \f |
0aa01123 | 1845 | /* Fvertical_motion and vmotion */ |
88c6e37e | 1846 | |
993b6404 JB |
1847 | struct position val_vmotion; |
1848 | ||
1849 | struct position * | |
99ce22d5 | 1850 | vmotion (from, vtarget, w) |
83155776 | 1851 | register EMACS_INT from, vtarget; |
99ce22d5 | 1852 | struct window *w; |
993b6404 | 1853 | { |
83155776 | 1854 | EMACS_INT hscroll = XINT (w->hscroll); |
993b6404 JB |
1855 | struct position pos; |
1856 | /* vpos is cumulative vertical position, changed as from is changed */ | |
1857 | register int vpos = 0; | |
83155776 SM |
1858 | EMACS_INT prevline; |
1859 | register EMACS_INT first; | |
1860 | EMACS_INT from_byte; | |
1861 | EMACS_INT lmargin = hscroll > 0 ? 1 - hscroll : 0; | |
993b6404 | 1862 | int selective |
eeaafd4f KH |
1863 | = (INTEGERP (current_buffer->selective_display) |
1864 | ? XINT (current_buffer->selective_display) | |
1865 | : !NILP (current_buffer->selective_display) ? -1 : 0); | |
99ce22d5 | 1866 | Lisp_Object window; |
83155776 | 1867 | EMACS_INT start_hpos = 0; |
2ab90d49 | 1868 | int did_motion; |
7ac57cb3 RS |
1869 | /* This is the object we use for fetching character properties. */ |
1870 | Lisp_Object text_prop_object; | |
99ce22d5 KH |
1871 | |
1872 | XSETWINDOW (window, w); | |
1873 | ||
7ac57cb3 RS |
1874 | /* If the window contains this buffer, use it for getting text properties. |
1875 | Otherwise use the current buffer as arg for doing that. */ | |
1876 | if (EQ (w->buffer, Fcurrent_buffer ())) | |
1877 | text_prop_object = window; | |
1878 | else | |
1879 | text_prop_object = Fcurrent_buffer (); | |
1880 | ||
99ce22d5 | 1881 | if (vpos >= vtarget) |
993b6404 | 1882 | { |
99ce22d5 | 1883 | /* To move upward, go a line at a time until |
fe0066f5 | 1884 | we have gone at least far enough. */ |
99ce22d5 KH |
1885 | |
1886 | first = 1; | |
1887 | ||
1888 | while ((vpos > vtarget || first) && from > BEGV) | |
993b6404 | 1889 | { |
66c75ca5 RS |
1890 | Lisp_Object propval; |
1891 | ||
2965dff9 RS |
1892 | prevline = find_next_newline_no_quit (from - 1, -1); |
1893 | while (prevline > BEGV | |
5a05d3d2 | 1894 | && ((selective > 0 |
2965dff9 RS |
1895 | && indented_beyond_p (prevline, |
1896 | CHAR_TO_BYTE (prevline), | |
76e20cb0 | 1897 | (double) selective)) /* iftc */ |
2965dff9 RS |
1898 | /* Watch out for newlines with `invisible' property. |
1899 | When moving upward, check the newline before. */ | |
1900 | || (propval = Fget_char_property (make_number (prevline - 1), | |
66c75ca5 | 1901 | Qinvisible, |
7ac57cb3 | 1902 | text_prop_object), |
339ee979 | 1903 | TEXT_PROP_MEANS_INVISIBLE (propval)))) |
2965dff9 RS |
1904 | prevline = find_next_newline_no_quit (prevline - 1, -1); |
1905 | pos = *compute_motion (prevline, 0, | |
1906 | lmargin + (prevline == BEG ? start_hpos : 0), | |
2ab90d49 | 1907 | 0, |
097812fb | 1908 | from, |
a997a7ca KH |
1909 | /* Don't care for VPOS... */ |
1910 | 1 << (BITS_PER_SHORT - 1), | |
1911 | /* ... nor HPOS. */ | |
1912 | 1 << (BITS_PER_SHORT - 1), | |
361f14bf | 1913 | -1, hscroll, |
2dd4e608 RS |
1914 | /* This compensates for start_hpos |
1915 | so that a tab as first character | |
1916 | still occupies 8 columns. */ | |
2965dff9 | 1917 | (prevline == BEG ? -start_hpos : 0), |
2dd4e608 | 1918 | w); |
99ce22d5 KH |
1919 | vpos -= pos.vpos; |
1920 | first = 0; | |
2965dff9 | 1921 | from = prevline; |
993b6404 | 1922 | } |
99ce22d5 KH |
1923 | |
1924 | /* If we made exactly the desired vertical distance, | |
1925 | or if we hit beginning of buffer, | |
1926 | return point found */ | |
1927 | if (vpos >= vtarget) | |
993b6404 | 1928 | { |
99ce22d5 | 1929 | val_vmotion.bufpos = from; |
fe0066f5 | 1930 | val_vmotion.bytepos = CHAR_TO_BYTE (from); |
99ce22d5 KH |
1931 | val_vmotion.vpos = vpos; |
1932 | val_vmotion.hpos = lmargin; | |
1933 | val_vmotion.contin = 0; | |
1934 | val_vmotion.prevhpos = 0; | |
927b5a55 | 1935 | val_vmotion.ovstring_chars_done = 0; |
a997a7ca | 1936 | val_vmotion.tab_offset = 0; /* For accumulating tab offset. */ |
99ce22d5 | 1937 | return &val_vmotion; |
993b6404 | 1938 | } |
993b6404 | 1939 | |
99ce22d5 KH |
1940 | /* Otherwise find the correct spot by moving down */ |
1941 | } | |
1942 | /* Moving downward is simple, but must calculate from beg of line | |
1943 | to determine hpos of starting point */ | |
fe0066f5 RS |
1944 | from_byte = CHAR_TO_BYTE (from); |
1945 | if (from > BEGV && FETCH_BYTE (from_byte - 1) != '\n') | |
993b6404 | 1946 | { |
2ab90d49 | 1947 | Lisp_Object propval; |
66c75ca5 | 1948 | |
2965dff9 RS |
1949 | prevline = find_next_newline_no_quit (from, -1); |
1950 | while (prevline > BEGV | |
99ce22d5 | 1951 | && ((selective > 0 |
2965dff9 RS |
1952 | && indented_beyond_p (prevline, |
1953 | CHAR_TO_BYTE (prevline), | |
76e20cb0 | 1954 | (double) selective)) /* iftc */ |
2965dff9 RS |
1955 | /* Watch out for newlines with `invisible' property. |
1956 | When moving downward, check the newline after. */ | |
1957 | || (propval = Fget_char_property (make_number (prevline), | |
1958 | Qinvisible, | |
7ac57cb3 | 1959 | text_prop_object), |
339ee979 | 1960 | TEXT_PROP_MEANS_INVISIBLE (propval)))) |
2965dff9 RS |
1961 | prevline = find_next_newline_no_quit (prevline - 1, -1); |
1962 | pos = *compute_motion (prevline, 0, | |
1963 | lmargin + (prevline == BEG | |
92992c7e | 1964 | ? start_hpos : 0), |
2ab90d49 | 1965 | 0, |
097812fb | 1966 | from, |
a997a7ca KH |
1967 | /* Don't care for VPOS... */ |
1968 | 1 << (BITS_PER_SHORT - 1), | |
1969 | /* ... nor HPOS. */ | |
1970 | 1 << (BITS_PER_SHORT - 1), | |
361f14bf | 1971 | -1, hscroll, |
2965dff9 | 1972 | (prevline == BEG ? -start_hpos : 0), |
2dd4e608 | 1973 | w); |
2ab90d49 | 1974 | did_motion = 1; |
993b6404 | 1975 | } |
99ce22d5 | 1976 | else |
993b6404 | 1977 | { |
99ce22d5 KH |
1978 | pos.hpos = lmargin + (from == BEG ? start_hpos : 0); |
1979 | pos.vpos = 0; | |
a997a7ca | 1980 | pos.tab_offset = 0; |
2ab90d49 | 1981 | did_motion = 0; |
993b6404 | 1982 | } |
2ab90d49 | 1983 | return compute_motion (from, vpos, pos.hpos, did_motion, |
a997a7ca | 1984 | ZV, vtarget, - (1 << (BITS_PER_SHORT - 1)), |
361f14bf | 1985 | -1, hscroll, |
a997a7ca | 1986 | pos.tab_offset - (from == BEG ? start_hpos : 0), |
2dd4e608 | 1987 | w); |
993b6404 JB |
1988 | } |
1989 | ||
f1ecfe9b | 1990 | DEFUN ("vertical-motion", Fvertical_motion, Svertical_motion, 1, 2, 0, |
8c1a1077 PJ |
1991 | doc: /* Move point to start of the screen line LINES lines down. |
1992 | If LINES is negative, this means moving up. | |
1993 | ||
1994 | This function is an ordinary cursor motion function | |
1995 | which calculates the new position based on how text would be displayed. | |
1996 | The new position may be the start of a line, | |
1997 | or just the start of a continuation line. | |
1998 | The function returns number of screen lines moved over; | |
1999 | that usually equals LINES, but may be closer to zero | |
2000 | if beginning or end of buffer was reached. | |
2001 | ||
2002 | The optional second argument WINDOW specifies the window to use for | |
2003 | parameters such as width, horizontal scrolling, and so on. | |
2004 | The default is to use the selected window's parameters. | |
2005 | ||
c876b227 SM |
2006 | LINES can optionally take the form (COLS . LINES), in which case |
2007 | the motion will not stop at the start of a screen line but on | |
2008 | its column COLS (if such exists on that line, that is). | |
2009 | ||
8c1a1077 PJ |
2010 | `vertical-motion' always uses the current buffer, |
2011 | regardless of which buffer is displayed in WINDOW. | |
2012 | This is consistent with other cursor motion functions | |
2013 | and makes it possible to use `vertical-motion' in any buffer, | |
2014 | whether or not it is currently displayed in some window. */) | |
2015 | (lines, window) | |
f1ecfe9b | 2016 | Lisp_Object lines, window; |
993b6404 | 2017 | { |
8720a429 GM |
2018 | struct it it; |
2019 | struct text_pos pt; | |
8720a429 | 2020 | struct window *w; |
39210e90 GM |
2021 | Lisp_Object old_buffer; |
2022 | struct gcpro gcpro1; | |
baed8445 SM |
2023 | Lisp_Object lcols = Qnil; |
2024 | double cols; | |
c876b227 SM |
2025 | |
2026 | /* Allow LINES to be of the form (HPOS . VPOS) aka (COLUMNS . LINES). */ | |
2027 | if (CONSP (lines) && (NUMBERP (XCAR (lines)))) | |
2028 | { | |
baed8445 SM |
2029 | lcols = XCAR (lines); |
2030 | cols = INTEGERP (lcols) ? (double) XINT (lcols) : XFLOAT_DATA (lcols); | |
c876b227 SM |
2031 | lines = XCDR (lines); |
2032 | } | |
993b6404 | 2033 | |
b7826503 | 2034 | CHECK_NUMBER (lines); |
f1ecfe9b | 2035 | if (! NILP (window)) |
b7826503 | 2036 | CHECK_WINDOW (window); |
f1ecfe9b | 2037 | else |
92992c7e | 2038 | window = selected_window; |
8720a429 | 2039 | w = XWINDOW (window); |
39210e90 GM |
2040 | |
2041 | old_buffer = Qnil; | |
2042 | GCPRO1 (old_buffer); | |
2043 | if (XBUFFER (w->buffer) != current_buffer) | |
8720a429 | 2044 | { |
39210e90 GM |
2045 | /* Set the window's buffer temporarily to the current buffer. */ |
2046 | old_buffer = w->buffer; | |
2047 | XSETBUFFER (w->buffer, current_buffer); | |
8720a429 | 2048 | } |
097812fb | 2049 | |
6df71429 | 2050 | if (noninteractive) |
9305b0e7 | 2051 | { |
6df71429 RS |
2052 | struct position pos; |
2053 | pos = *vmotion (PT, XINT (lines), w); | |
2054 | SET_PT_BOTH (pos.bufpos, pos.bytepos); | |
9305b0e7 KS |
2055 | } |
2056 | else | |
6df71429 | 2057 | { |
2f4ec7ce | 2058 | int it_start, oselective, it_overshoot_expected, first_x; |
24a06d04 | 2059 | |
6df71429 RS |
2060 | SET_TEXT_POS (pt, PT, PT_BYTE); |
2061 | start_display (&it, w, pt); | |
2f4ec7ce | 2062 | first_x = it.first_visible_x; |
6df71429 RS |
2063 | |
2064 | /* Scan from the start of the line containing PT. If we don't | |
2065 | do this, we start moving with IT->current_x == 0, while PT is | |
2066 | really at some x > 0. The effect is, in continuation lines, that | |
2067 | we end up with the iterator placed at where it thinks X is 0, | |
2068 | while the end position is really at some X > 0, the same X that | |
2069 | PT had. */ | |
24a06d04 | 2070 | it_start = IT_CHARPOS (it); |
14a7cabf CY |
2071 | |
2072 | /* We expect the call to move_it_to, further down, to overshoot | |
cec726f6 KH |
2073 | if the starting point is on an image, stretch glyph, |
2074 | composition, or Lisp string. We won't need to backtrack in | |
2075 | this situation, except for one corner case: when the Lisp | |
2076 | string contains a newline. */ | |
14a7cabf CY |
2077 | if (it.method == GET_FROM_STRING) |
2078 | { | |
2079 | const char *s = SDATA (it.string); | |
2080 | const char *e = s + SBYTES (it.string); | |
2081 | ||
2082 | while (s < e && *s != '\n') | |
2083 | ++s; | |
2084 | ||
9e313cc1 KS |
2085 | /* If there is no newline in the string, we need to check |
2086 | whether there is a newline immediately after the string | |
2087 | in move_it_to below. This may happen if there is an | |
2088 | overlay with an after-string just before the newline. */ | |
2089 | it_overshoot_expected = (s == e) ? -1 : 0; | |
14a7cabf CY |
2090 | } |
2091 | else | |
9e313cc1 KS |
2092 | it_overshoot_expected = (it.method == GET_FROM_IMAGE |
2093 | || it.method == GET_FROM_STRETCH | |
2094 | || it.method == GET_FROM_COMPOSITION); | |
14a7cabf | 2095 | |
b54a7539 KS |
2096 | reseat_at_previous_visible_line_start (&it); |
2097 | it.current_x = it.hpos = 0; | |
8fd7aa51 KS |
2098 | /* Temporarily disable selective display so we don't move too far */ |
2099 | oselective = it.selective; | |
2100 | it.selective = 0; | |
b54a7539 | 2101 | move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS); |
8fd7aa51 | 2102 | it.selective = oselective; |
b54a7539 KS |
2103 | |
2104 | /* Move back if we got too far. This may happen if | |
0163a0d5 | 2105 | truncate-lines is on and PT is beyond right margin. |
14a7cabf | 2106 | Don't go back if the overshoot is expected (see above). */ |
e2de7999 | 2107 | if (IT_CHARPOS (it) > it_start && XINT (lines) > 0 |
9e313cc1 KS |
2108 | && (!it_overshoot_expected |
2109 | || (it_overshoot_expected < 0 | |
2110 | && it.method == GET_FROM_BUFFER | |
2111 | && it.c == '\n'))) | |
b54a7539 | 2112 | move_it_by_lines (&it, -1, 0); |
3a46a5de | 2113 | |
b54a7539 | 2114 | it.vpos = 0; |
5bf3adc1 RS |
2115 | /* Do this even if LINES is 0, so that we move back |
2116 | to the beginning of the current line as we ought. */ | |
78744fc3 KS |
2117 | if (XINT (lines) >= 0 || IT_CHARPOS (it) > 0) |
2118 | move_it_by_lines (&it, XINT (lines), 0); | |
097812fb | 2119 | |
2f4ec7ce | 2120 | /* Move to the goal column, if one was specified. */ |
baed8445 | 2121 | if (!NILP (lcols)) |
2f4ec7ce CY |
2122 | { |
2123 | /* If the window was originally hscrolled, move forward by | |
2124 | the hscrolled amount first. */ | |
2125 | if (first_x > 0) | |
2126 | { | |
2127 | move_it_in_display_line (&it, ZV, first_x, MOVE_TO_X); | |
2128 | it.current_x = 0; | |
2129 | } | |
2130 | move_it_in_display_line | |
2131 | (&it, ZV, | |
2132 | (int)(cols * FRAME_COLUMN_WIDTH (XFRAME (w->frame)) + 0.5), | |
2133 | MOVE_TO_X); | |
2134 | } | |
c876b227 | 2135 | |
6df71429 RS |
2136 | SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it)); |
2137 | } | |
8720a429 | 2138 | |
39210e90 GM |
2139 | if (BUFFERP (old_buffer)) |
2140 | w->buffer = old_buffer; | |
097812fb | 2141 | |
39210e90 | 2142 | RETURN_UNGCPRO (make_number (it.vpos)); |
993b6404 | 2143 | } |
8720a429 GM |
2144 | |
2145 | ||
993b6404 | 2146 | \f |
88c6e37e | 2147 | /* File's initialization. */ |
0aa01123 | 2148 | |
dfcf069d | 2149 | void |
993b6404 JB |
2150 | syms_of_indent () |
2151 | { | |
2152 | DEFVAR_BOOL ("indent-tabs-mode", &indent_tabs_mode, | |
c86f7377 | 2153 | doc: /* *Indentation can insert tabs if this is non-nil. */); |
993b6404 JB |
2154 | indent_tabs_mode = 1; |
2155 | ||
2156 | defsubr (&Scurrent_indentation); | |
2157 | defsubr (&Sindent_to); | |
2158 | defsubr (&Scurrent_column); | |
2159 | defsubr (&Smove_to_column); | |
2160 | defsubr (&Svertical_motion); | |
42918ba5 | 2161 | defsubr (&Scompute_motion); |
993b6404 | 2162 | } |
6b61353c KH |
2163 | |
2164 | /* arch-tag: 9adfea44-71f7-4988-8ee3-96da15c502cc | |
2165 | (do not change this comment) */ |