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