1 /* Indentation functions.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1998, 2000, 2001,
3 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
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.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
34 #include "intervals.h"
35 #include "region-cache.h"
37 /* Indentation can insert tabs if this is non-zero;
38 otherwise always uses spaces. */
44 /* These three values memorize the current column to avoid recalculation. */
46 /* Last value returned by current_column.
47 Some things in set last_known_column_point to -1
48 to mark the memorized value as invalid. */
50 double last_known_column
;
52 /* Value of point when current_column was called. */
54 int last_known_column_point
;
56 /* Value of MODIFF when current_column was called. */
58 int last_known_column_modified
;
60 static double current_column_1
P_ ((void));
61 static double position_indentation
P_ ((int));
63 /* Cache of beginning of line found by the last call of
66 int current_column_bol_cache
;
68 /* Get the display table to use for the current buffer. */
70 struct Lisp_Char_Table
*
71 buffer_display_table ()
75 thisbuf
= current_buffer
->display_table
;
76 if (DISP_TABLE_P (thisbuf
))
77 return XCHAR_TABLE (thisbuf
);
78 if (DISP_TABLE_P (Vstandard_display_table
))
79 return XCHAR_TABLE (Vstandard_display_table
);
83 /* Width run cache considerations. */
85 /* Return the width of character C under display table DP. */
88 character_width (c
, dp
)
90 struct Lisp_Char_Table
*dp
;
94 /* These width computations were determined by examining the cases
95 in display_text_line. */
97 /* Everything can be handled by the display table, if it's
98 present and the element is right. */
99 if (dp
&& (elt
= DISP_CHAR_VECTOR (dp
, c
), VECTORP (elt
)))
100 return XVECTOR (elt
)->size
;
102 /* Some characters are special. */
103 if (c
== '\n' || c
== '\t' || c
== '\015')
106 /* Printing characters have width 1. */
107 else if (c
>= 040 && c
< 0177)
110 /* Everybody else (control characters, metacharacters) has other
111 widths. We could return their actual widths here, but they
112 depend on things like ctl_arrow and crud like that, and they're
113 not very common at all. So we'll just claim we don't know their
119 /* Return true iff the display table DISPTAB specifies the same widths
120 for characters as WIDTHTAB. We use this to decide when to
121 invalidate the buffer's width_run_cache. */
124 disptab_matches_widthtab (disptab
, widthtab
)
125 struct Lisp_Char_Table
*disptab
;
126 struct Lisp_Vector
*widthtab
;
130 if (widthtab
->size
!= 256)
133 for (i
= 0; i
< 256; i
++)
134 if (character_width (i
, disptab
)
135 != XFASTINT (widthtab
->contents
[i
]))
141 /* Recompute BUF's width table, using the display table DISPTAB. */
144 recompute_width_table (buf
, disptab
)
146 struct Lisp_Char_Table
*disptab
;
149 struct Lisp_Vector
*widthtab
;
151 if (!VECTORP (buf
->width_table
))
152 buf
->width_table
= Fmake_vector (make_number (256), make_number (0));
153 widthtab
= XVECTOR (buf
->width_table
);
154 if (widthtab
->size
!= 256)
157 for (i
= 0; i
< 256; i
++)
158 XSETFASTINT (widthtab
->contents
[i
], character_width (i
, disptab
));
161 /* Allocate or free the width run cache, as requested by the current
162 state of current_buffer's cache_long_line_scans variable. */
165 width_run_cache_on_off ()
167 if (NILP (current_buffer
->cache_long_line_scans
)
168 /* And, for the moment, this feature doesn't work on multibyte
170 || !NILP (current_buffer
->enable_multibyte_characters
))
172 /* It should be off. */
173 if (current_buffer
->width_run_cache
)
175 free_region_cache (current_buffer
->width_run_cache
);
176 current_buffer
->width_run_cache
= 0;
177 current_buffer
->width_table
= Qnil
;
182 /* It should be on. */
183 if (current_buffer
->width_run_cache
== 0)
185 current_buffer
->width_run_cache
= new_region_cache ();
186 recompute_width_table (current_buffer
, buffer_display_table ());
192 /* Skip some invisible characters starting from POS.
193 This includes characters invisible because of text properties
194 and characters invisible because of overlays.
196 If position POS is followed by invisible characters,
197 skip some of them and return the position after them.
198 Otherwise return POS itself.
200 Set *NEXT_BOUNDARY_P to the next position at which
201 it will be necessary to call this function again.
203 Don't scan past TO, and don't set *NEXT_BOUNDARY_P
204 to a value greater than TO.
206 If WINDOW is non-nil, and this buffer is displayed in WINDOW,
207 take account of overlays that apply only in WINDOW.
209 We don't necessarily skip all the invisible characters after POS
210 because that could take a long time. We skip a reasonable number
211 which can be skipped quickly. If there might be more invisible
212 characters immediately following, then *NEXT_BOUNDARY_P
213 will equal the return value. */
216 skip_invisible (pos
, next_boundary_p
, to
, window
)
218 int *next_boundary_p
;
222 Lisp_Object prop
, position
, overlay_limit
, proplimit
;
223 Lisp_Object buffer
, tmp
;
226 XSETFASTINT (position
, pos
);
227 XSETBUFFER (buffer
, current_buffer
);
229 /* Give faster response for overlay lookup near POS. */
230 recenter_overlay_lists (current_buffer
, pos
);
232 /* We must not advance farther than the next overlay change.
233 The overlay change might change the invisible property;
234 or there might be overlay strings to be displayed there. */
235 overlay_limit
= Fnext_overlay_change (position
);
236 /* As for text properties, this gives a lower bound
237 for where the invisible text property could change. */
238 proplimit
= Fnext_property_change (position
, buffer
, Qt
);
239 if (XFASTINT (overlay_limit
) < XFASTINT (proplimit
))
240 proplimit
= overlay_limit
;
241 /* PROPLIMIT is now a lower bound for the next change
242 in invisible status. If that is plenty far away,
243 use that lower bound. */
244 if (XFASTINT (proplimit
) > pos
+ 100 || XFASTINT (proplimit
) >= to
)
245 *next_boundary_p
= XFASTINT (proplimit
);
246 /* Otherwise, scan for the next `invisible' property change. */
249 /* Don't scan terribly far. */
250 XSETFASTINT (proplimit
, min (pos
+ 100, to
));
251 /* No matter what. don't go past next overlay change. */
252 if (XFASTINT (overlay_limit
) < XFASTINT (proplimit
))
253 proplimit
= overlay_limit
;
254 tmp
= Fnext_single_property_change (position
, Qinvisible
,
256 end
= XFASTINT (tmp
);
258 /* Don't put the boundary in the middle of multibyte form if
259 there is no actual property change. */
261 && !NILP (current_buffer
->enable_multibyte_characters
)
263 while (pos
< end
&& !CHAR_HEAD_P (POS_ADDR (end
)))
266 *next_boundary_p
= end
;
268 /* if the `invisible' property is set, we can skip to
269 the next property change */
270 prop
= Fget_char_property (position
, Qinvisible
,
272 && EQ (XWINDOW (window
)->buffer
, buffer
))
274 inv_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
275 /* When counting columns (window == nil), don't skip over ellipsis text. */
276 if (NILP (window
) ? inv_p
== 1 : inv_p
)
277 return *next_boundary_p
;
281 /* If a composition starts at POS/POS_BYTE and it doesn't stride over
282 POINT, set *LEN / *LEN_BYTE to the character and byte lengths, *WIDTH
283 to the width, and return 1. Otherwise, return 0. */
286 check_composition (pos
, pos_byte
, point
, len
, len_byte
, width
)
287 int pos
, pos_byte
, point
;
288 int *len
, *len_byte
, *width
;
294 if (! find_composition (pos
, -1, &start
, &end
, &prop
, Qnil
)
295 || pos
!= start
|| point
< end
296 || !COMPOSITION_VALID_P (start
, end
, prop
))
298 if ((id
= get_composition_id (pos
, pos_byte
, end
- pos
, prop
, Qnil
)) < 0)
301 *len
= COMPOSITION_LENGTH (prop
);
302 *len_byte
= CHAR_TO_BYTE (end
) - pos_byte
;
303 *width
= composition_table
[id
]->width
;
307 /* Set variables WIDTH and BYTES for a multibyte sequence starting at P.
309 DP is a display table or NULL.
311 This macro is used in current_column_1, Fmove_to_column, and
314 #define MULTIBYTE_BYTES_WIDTH(p, dp) \
319 c = STRING_CHAR_AND_LENGTH (p, MAX_MULTIBYTE_LENGTH, bytes); \
320 if (BYTES_BY_CHAR_HEAD (*p) != bytes) \
324 if (dp != 0 && VECTORP (DISP_CHAR_VECTOR (dp, c))) \
325 width = XVECTOR (DISP_CHAR_VECTOR (dp, c))->size; \
327 width = WIDTH_BY_CHAR_HEAD (*p); \
329 wide_column = width; \
334 DEFUN ("current-column", Fcurrent_column
, Scurrent_column
, 0, 0, 0,
335 doc
: /* Return the horizontal position of point. Beginning of line is column 0.
336 This is calculated by adding together the widths of all the displayed
337 representations of the character between the start of the previous line
338 and point. (eg control characters will have a width of 2 or 4, tabs
339 will have a variable width)
340 Ignores finite width of frame, which means that this function may return
341 values greater than (frame-width).
342 Whether the line is visible (if `selective-display' is t) has no effect;
343 however, ^M is treated as end of line when `selective-display' is t.
344 Text that has an invisible property is considered as having width 0, unless
345 `buffer-invisibility-spec' specifies that it is replaced by an ellipsis. */)
349 XSETFASTINT (temp
, (int) current_column ()); /* iftc */
353 /* Cancel any recorded value of the horizontal position. */
356 invalidate_current_column ()
358 last_known_column_point
= 0;
365 register unsigned char *ptr
, *stop
;
366 register int tab_seen
;
369 register int tab_width
= XINT (current_buffer
->tab_width
);
370 int ctl_arrow
= !NILP (current_buffer
->ctl_arrow
);
371 register struct Lisp_Char_Table
*dp
= buffer_display_table ();
373 if (PT
== last_known_column_point
374 && MODIFF
== last_known_column_modified
)
375 return last_known_column
;
377 /* If the buffer has overlays, text properties,
378 or multibyte characters, use a more general algorithm. */
379 if (BUF_INTERVALS (current_buffer
)
380 || current_buffer
->overlays_before
381 || current_buffer
->overlays_after
383 return current_column_1 ();
385 /* Scan backwards from point to the previous newline,
386 counting width. Tab characters are the only complicated case. */
388 /* Make a pointer for decrementing through the chars before point. */
389 ptr
= BYTE_POS_ADDR (PT_BYTE
- 1) + 1;
390 /* Make a pointer to where consecutive chars leave off,
391 going backwards from point. */
394 else if (PT
<= GPT
|| BEGV
> GPT
)
399 if (tab_width
<= 0 || tab_width
> 1000)
402 col
= 0, tab_seen
= 0, post_tab
= 0;
411 /* We stopped either for the beginning of the buffer
413 if (ptr
== BEGV_ADDR
)
416 /* It was the gap. Jump back over it. */
420 /* Check whether that brings us to beginning of buffer. */
427 if (dp
&& VECTORP (DISP_CHAR_VECTOR (dp
, c
)))
429 charvec
= DISP_CHAR_VECTOR (dp
, c
);
438 for (i
= n
- 1; i
>= 0; --i
)
440 if (VECTORP (charvec
))
442 /* This should be handled the same as
443 next_element_from_display_vector does it. */
444 Lisp_Object entry
= AREF (charvec
, i
);
447 && GLYPH_CHAR_VALID_P (XFASTINT (entry
)))
448 c
= FAST_GLYPH_CHAR (XFASTINT (entry
));
453 if (c
>= 040 && c
< 0177)
457 && EQ (current_buffer
->selective_display
, Qt
)))
460 goto start_of_line_found
;
465 col
= ((col
+ tab_width
) / tab_width
) * tab_width
;
471 else if (VECTORP (charvec
))
472 /* With a display table entry, C is displayed as is, and
473 not displayed as \NNN or as ^N. If C is a single-byte
474 character, it takes one column. If C is multi-byte in
475 an unibyte buffer, it's translated to unibyte, so it
476 also takes one column. */
479 col
+= (ctl_arrow
&& c
< 0200) ? 2 : 4;
487 col
= ((col
+ tab_width
) / tab_width
) * tab_width
;
491 if (ptr
== BEGV_ADDR
)
492 current_column_bol_cache
= BEGV
;
494 current_column_bol_cache
= BYTE_TO_CHAR (PTR_BYTE_POS (ptr
));
496 last_known_column
= col
;
497 last_known_column_point
= PT
;
498 last_known_column_modified
= MODIFF
;
503 /* Return the column number of position POS
504 by scanning forward from the beginning of the line.
505 This function handles characters that are invisible
506 due to text properties or overlays. */
511 register int tab_width
= XINT (current_buffer
->tab_width
);
512 register int ctl_arrow
= !NILP (current_buffer
->ctl_arrow
);
513 register struct Lisp_Char_Table
*dp
= buffer_display_table ();
514 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
516 /* Start the scan at the beginning of this line with column number 0. */
517 register int col
= 0;
520 int opoint
= PT
, opoint_byte
= PT_BYTE
;
522 scan_newline (PT
, PT_BYTE
, BEGV
, BEGV_BYTE
, -1, 1);
523 current_column_bol_cache
= PT
;
524 scan
= PT
, scan_byte
= PT_BYTE
;
525 SET_PT_BOTH (opoint
, opoint_byte
);
526 next_boundary
= scan
;
528 if (tab_width
<= 0 || tab_width
> 1000) tab_width
= 8;
530 /* Scan forward to the target position. */
531 while (scan
< opoint
)
535 /* Occasionally we may need to skip invisible text. */
536 while (scan
== next_boundary
)
539 /* This updates NEXT_BOUNDARY to the next place
540 where we might need to skip more invisible text. */
541 scan
= skip_invisible (scan
, &next_boundary
, opoint
, Qnil
);
544 if (scan
!= old_scan
)
545 scan_byte
= CHAR_TO_BYTE (scan
);
548 /* Check composition sequence. */
550 int len
, len_byte
, width
;
552 if (check_composition (scan
, scan_byte
, opoint
,
553 &len
, &len_byte
, &width
))
556 scan_byte
+= len_byte
;
563 c
= FETCH_BYTE (scan_byte
);
566 && ! (multibyte
&& BASE_LEADING_CODE_P (c
))
567 && VECTORP (DISP_CHAR_VECTOR (dp
, c
)))
572 /* This character is displayed using a vector of glyphs.
573 Update the column based on those glyphs. */
575 charvec
= DISP_CHAR_VECTOR (dp
, c
);
578 for (i
= 0; i
< n
; i
++)
580 /* This should be handled the same as
581 next_element_from_display_vector does it. */
583 entry
= AREF (charvec
, i
);
586 && GLYPH_CHAR_VALID_P (XFASTINT (entry
)))
587 c
= FAST_GLYPH_CHAR (XFASTINT (entry
));
593 if (c
== '\r' && EQ (current_buffer
->selective_display
, Qt
))
598 col
= col
/ tab_width
* tab_width
;
606 /* The display table says nothing for this character.
607 Display it as itself. */
611 if (c
== '\r' && EQ (current_buffer
->selective_display
, Qt
))
616 col
= col
/ tab_width
* tab_width
;
618 else if (multibyte
&& BASE_LEADING_CODE_P (c
))
621 int bytes
, width
, wide_column
;
623 ptr
= BYTE_POS_ADDR (scan_byte
);
624 MULTIBYTE_BYTES_WIDTH (ptr
, dp
);
626 /* Subtract one to compensate for the increment
627 that is going to happen below. */
631 else if (ctl_arrow
&& (c
< 040 || c
== 0177))
633 else if (c
< 040 || c
>= 0177)
644 last_known_column
= col
;
645 last_known_column_point
= PT
;
646 last_known_column_modified
= MODIFF
;
652 #if 0 /* Not used. */
654 /* Return the width in columns of the part of STRING from BEG to END.
655 If BEG is nil, that stands for the beginning of STRING.
656 If END is nil, that stands for the end of STRING. */
659 string_display_width (string
, beg
, end
)
660 Lisp_Object string
, beg
, end
;
663 register unsigned char *ptr
, *stop
;
664 register int tab_seen
;
667 register int tab_width
= XINT (current_buffer
->tab_width
);
668 int ctl_arrow
= !NILP (current_buffer
->ctl_arrow
);
669 register struct Lisp_Char_Table
*dp
= buffer_display_table ();
688 /* Make a pointer for decrementing through the chars before point. */
689 ptr
= SDATA (string
) + e
;
690 /* Make a pointer to where consecutive chars leave off,
691 going backwards from point. */
692 stop
= SDATA (string
) + b
;
694 if (tab_width
<= 0 || tab_width
> 1000) tab_width
= 8;
696 col
= 0, tab_seen
= 0, post_tab
= 0;
704 if (dp
!= 0 && VECTORP (DISP_CHAR_VECTOR (dp
, c
)))
705 col
+= XVECTOR (DISP_CHAR_VECTOR (dp
, c
))->size
;
706 else if (c
>= 040 && c
< 0177)
713 col
= ((col
+ tab_width
) / tab_width
) * tab_width
;
720 col
+= (ctl_arrow
&& c
< 0200) ? 2 : 4;
725 col
= ((col
+ tab_width
) / tab_width
) * tab_width
;
735 DEFUN ("indent-to", Findent_to
, Sindent_to
, 1, 2, "NIndent to column: ",
736 doc
: /* Indent from point with tabs and spaces until COLUMN is reached.
737 Optional second argument MININUM says always do at least MININUM spaces
738 even if that goes past COLUMN; by default, MININUM is zero. */)
740 Lisp_Object column
, minimum
;
743 register int fromcol
;
744 register int tab_width
= XINT (current_buffer
->tab_width
);
746 CHECK_NUMBER (column
);
748 XSETFASTINT (minimum
, 0);
749 CHECK_NUMBER (minimum
);
751 fromcol
= current_column ();
752 mincol
= fromcol
+ XINT (minimum
);
753 if (mincol
< XINT (column
)) mincol
= XINT (column
);
755 if (fromcol
== mincol
)
756 return make_number (mincol
);
758 if (tab_width
<= 0 || tab_width
> 1000) tab_width
= 8;
760 if (indent_tabs_mode
)
763 XSETFASTINT (n
, mincol
/ tab_width
- fromcol
/ tab_width
);
764 if (XFASTINT (n
) != 0)
766 Finsert_char (make_number ('\t'), n
, Qt
);
768 fromcol
= (mincol
/ tab_width
) * tab_width
;
772 XSETFASTINT (column
, mincol
- fromcol
);
773 Finsert_char (make_number (' '), column
, Qt
);
775 last_known_column
= mincol
;
776 last_known_column_point
= PT
;
777 last_known_column_modified
= MODIFF
;
779 XSETINT (column
, mincol
);
784 static double position_indentation
P_ ((int));
786 DEFUN ("current-indentation", Fcurrent_indentation
, Scurrent_indentation
,
788 doc
: /* Return the indentation of the current line.
789 This is the horizontal position of the character
790 following any initial whitespace. */)
794 int opoint
= PT
, opoint_byte
= PT_BYTE
;
796 scan_newline (PT
, PT_BYTE
, BEGV
, BEGV_BYTE
, -1, 1);
798 XSETFASTINT (val
, (int) position_indentation (PT_BYTE
)); /* iftc */
799 SET_PT_BOTH (opoint
, opoint_byte
);
804 position_indentation (pos_byte
)
805 register int pos_byte
;
807 register int column
= 0;
808 register int tab_width
= XINT (current_buffer
->tab_width
);
809 register unsigned char *p
;
810 register unsigned char *stop
;
811 unsigned char *start
;
812 int next_boundary_byte
= pos_byte
;
813 int ceiling
= next_boundary_byte
;
815 if (tab_width
<= 0 || tab_width
> 1000) tab_width
= 8;
817 p
= BYTE_POS_ADDR (pos_byte
);
818 /* STOP records the value of P at which we will need
819 to think about the gap, or about invisible text,
820 or about the end of the buffer. */
822 /* START records the starting value of P. */
830 /* If we have updated P, set POS_BYTE to match.
831 The first time we enter the loop, POS_BYTE is already right. */
833 pos_byte
= PTR_BYTE_POS (p
);
834 /* Consider the various reasons STOP might have been set here. */
835 if (pos_byte
== ZV_BYTE
)
837 if (pos_byte
== next_boundary_byte
)
840 int pos
= BYTE_TO_CHAR (pos_byte
);
841 pos
= skip_invisible (pos
, &next_boundary
, ZV
, Qnil
);
842 pos_byte
= CHAR_TO_BYTE (pos
);
843 next_boundary_byte
= CHAR_TO_BYTE (next_boundary
);
845 if (pos_byte
>= ceiling
)
846 ceiling
= BUFFER_CEILING_OF (pos_byte
) + 1;
847 /* Compute the next place we need to stop and think,
848 and set STOP accordingly. */
849 stop_pos_byte
= min (ceiling
, next_boundary_byte
);
850 /* The -1 and +1 arrange to point at the first byte of gap
851 (if STOP_POS_BYTE is the position of the gap)
852 rather than at the data after the gap. */
854 stop
= BYTE_POS_ADDR (stop_pos_byte
- 1) + 1;
855 p
= BYTE_POS_ADDR (pos_byte
);
860 if (! NILP (current_buffer
->enable_multibyte_characters
))
866 column
+= tab_width
- column
% tab_width
;
869 if (ASCII_BYTE_P (p
[-1])
870 || NILP (current_buffer
->enable_multibyte_characters
))
874 pos_byte
= PTR_BYTE_POS (p
- 1);
875 c
= FETCH_MULTIBYTE_CHAR (pos_byte
);
876 if (CHAR_HAS_CATEGORY (c
, ' '))
880 p
= BYTE_POS_ADDR (pos_byte
);
889 /* Test whether the line beginning at POS is indented beyond COLUMN.
890 Blank lines are treated as if they had the same indentation as the
894 indented_beyond_p (pos
, pos_byte
, column
)
899 int opoint
= PT
, opoint_byte
= PT_BYTE
;
901 SET_PT_BOTH (pos
, pos_byte
);
902 while (PT
> BEGV
&& FETCH_BYTE (PT_BYTE
) == '\n')
903 scan_newline (PT
- 1, PT_BYTE
- 1, BEGV
, BEGV_BYTE
, -1, 0);
905 val
= position_indentation (PT_BYTE
);
906 SET_PT_BOTH (opoint
, opoint_byte
);
907 return val
>= column
; /* hmm, float comparison */
910 DEFUN ("move-to-column", Fmove_to_column
, Smove_to_column
, 1, 2, "p",
911 doc
: /* Move point to column COLUMN in the current line.
912 The column of a character is calculated by adding together the widths
913 as displayed of the previous characters in the line.
914 This function ignores line-continuation;
915 there is no upper limit on the column number a character can have
916 and horizontal scrolling has no effect.
918 If specified column is within a character, point goes after that character.
919 If it's past end of line, point goes to end of line.
921 A non-nil second (optional) argument FORCE means,
922 if COLUMN is in the middle of a tab character, change it to spaces.
923 In addition, if FORCE is t, and the line is too short
924 to reach column COLUMN, add spaces/tabs to get there.
926 The return value is the current column. */)
928 Lisp_Object column
, force
;
931 register int col
= current_column ();
934 register int tab_width
= XINT (current_buffer
->tab_width
);
935 register int ctl_arrow
= !NILP (current_buffer
->ctl_arrow
);
936 register struct Lisp_Char_Table
*dp
= buffer_display_table ();
937 register int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
942 int next_boundary
, pos_byte
;
944 if (tab_width
<= 0 || tab_width
> 1000) tab_width
= 8;
945 CHECK_NATNUM (column
);
946 goal
= XINT (column
);
953 /* If we're starting past the desired column,
954 back up to beginning of line and scan from there. */
958 pos
= current_column_bol_cache
;
959 pos_byte
= CHAR_TO_BYTE (pos
);
965 while (pos
== next_boundary
)
968 pos
= skip_invisible (pos
, &next_boundary
, end
, Qnil
);
970 pos_byte
= CHAR_TO_BYTE (pos
);
975 /* Test reaching the goal column. We do this after skipping
976 invisible characters, so that we put point before the
977 character on which the cursor will appear. */
981 /* Check composition sequence. */
983 int len
, len_byte
, width
;
985 if (check_composition (pos
, pos_byte
, Z
, &len
, &len_byte
, &width
))
988 pos_byte
+= len_byte
;
994 c
= FETCH_BYTE (pos_byte
);
996 /* See if there is a display table and it relates
997 to this character. */
1000 && ! (multibyte
&& BASE_LEADING_CODE_P (c
))
1001 && VECTORP (DISP_CHAR_VECTOR (dp
, c
)))
1003 Lisp_Object charvec
;
1006 /* This character is displayed using a vector of glyphs.
1007 Update the position based on those glyphs. */
1009 charvec
= DISP_CHAR_VECTOR (dp
, c
);
1010 n
= ASIZE (charvec
);
1012 for (i
= 0; i
< n
; i
++)
1014 /* This should be handled the same as
1015 next_element_from_display_vector does it. */
1018 entry
= AREF (charvec
, i
);
1020 if (INTEGERP (entry
)
1021 && GLYPH_CHAR_VALID_P (XFASTINT (entry
)))
1022 c
= FAST_GLYPH_CHAR (XFASTINT (entry
));
1028 if (c
== '\r' && EQ (current_buffer
->selective_display
, Qt
))
1034 col
= col
/ tab_width
* tab_width
;
1042 /* The display table doesn't affect this character;
1043 it displays as itself. */
1047 if (c
== '\r' && EQ (current_buffer
->selective_display
, Qt
))
1053 col
= col
/ tab_width
* tab_width
;
1055 else if (ctl_arrow
&& (c
< 040 || c
== 0177))
1057 else if (c
< 040 || c
== 0177)
1061 else if (multibyte
&& BASE_LEADING_CODE_P (c
))
1063 /* Start of multi-byte form. */
1065 int bytes
, width
, wide_column
;
1067 ptr
= BYTE_POS_ADDR (pos_byte
);
1068 MULTIBYTE_BYTES_WIDTH (ptr
, dp
);
1069 pos_byte
+= bytes
- 1;
1081 SET_PT_BOTH (pos
, pos_byte
);
1083 /* If a tab char made us overshoot, change it to spaces
1084 and scan through it again. */
1085 if (!NILP (force
) && col
> goal
&& c
== '\t' && prev_col
< goal
)
1087 int goal_pt
, goal_pt_byte
;
1089 /* Insert spaces in front of the tab to reach GOAL. Do this
1090 first so that a marker at the end of the tab gets
1092 SET_PT_BOTH (PT
- 1, PT_BYTE
- 1);
1093 Finsert_char (make_number (' '), make_number (goal
- prev_col
), Qt
);
1095 /* Now delete the tab, and indent to COL. */
1096 del_range (PT
, PT
+ 1);
1098 goal_pt_byte
= PT_BYTE
;
1099 Findent_to (make_number (col
), Qnil
);
1100 SET_PT_BOTH (goal_pt
, goal_pt_byte
);
1102 /* Set the last_known... vars consistently. */
1106 /* If line ends prematurely, add space to the end. */
1107 if (col
< goal
&& EQ (force
, Qt
))
1108 Findent_to (make_number (col
= goal
), Qnil
);
1110 last_known_column
= col
;
1111 last_known_column_point
= PT
;
1112 last_known_column_modified
= MODIFF
;
1114 XSETFASTINT (val
, col
);
1118 /* compute_motion: compute buffer posn given screen posn and vice versa */
1120 struct position val_compute_motion
;
1122 /* Scan the current buffer forward from offset FROM, pretending that
1123 this is at line FROMVPOS, column FROMHPOS, until reaching buffer
1124 offset TO or line TOVPOS, column TOHPOS (whichever comes first),
1125 and return the ending buffer position and screen location. If we
1126 can't hit the requested column exactly (because of a tab or other
1127 multi-column character), overshoot.
1129 DID_MOTION is 1 if FROMHPOS has already accounted for overlay strings
1130 at FROM. This is the case if FROMVPOS and FROMVPOS came from an
1131 earlier call to compute_motion. The other common case is that FROMHPOS
1132 is zero and FROM is a position that "belongs" at column zero, but might
1133 be shifted by overlay strings; in this case DID_MOTION should be 0.
1135 WIDTH is the number of columns available to display text;
1136 compute_motion uses this to handle continuation lines and such.
1137 If WIDTH is -1, use width of window's text area adjusted for
1138 continuation glyph when needed.
1140 HSCROLL is the number of columns not being displayed at the left
1141 margin; this is usually taken from a window's hscroll member.
1142 TAB_OFFSET is the number of columns of the first tab that aren't
1143 being displayed, perhaps because of a continuation line or
1146 compute_motion returns a pointer to a struct position. The bufpos
1147 member gives the buffer position at the end of the scan, and hpos
1148 and vpos give its cartesian location. prevhpos is the column at
1149 which the character before bufpos started, and contin is non-zero
1150 if we reached the current line by continuing the previous.
1152 Note that FROMHPOS and TOHPOS should be expressed in real screen
1153 columns, taking HSCROLL and the truncation glyph at the left margin
1154 into account. That is, beginning-of-line moves you to the hpos
1155 -HSCROLL + (HSCROLL > 0).
1157 For example, to find the buffer position of column COL of line LINE
1158 of a certain window, pass the window's starting location as FROM
1159 and the window's upper-left coordinates as FROMVPOS and FROMHPOS.
1160 Pass the buffer's ZV as TO, to limit the scan to the end of the
1161 visible section of the buffer, and pass LINE and COL as TOVPOS and
1164 When displaying in window w, a typical formula for WIDTH is:
1167 - (has_vertical_scroll_bars
1168 ? WINDOW_CONFIG_SCROLL_BAR_COLS (window)
1169 : (window_width + window_left != frame_cols))
1172 window_width is XFASTINT (w->total_cols),
1173 window_left is XFASTINT (w->left_col),
1174 has_vertical_scroll_bars is
1175 WINDOW_HAS_VERTICAL_SCROLL_BAR (window)
1176 and frame_cols = FRAME_COLS (XFRAME (window->frame))
1178 Or you can let window_box_text_cols do this all for you, and write:
1179 window_box_text_cols (w) - 1
1181 The `-1' accounts for the continuation-line backslashes; the rest
1182 accounts for window borders if the window is split horizontally, and
1183 the scroll bars if they are turned on. */
1186 compute_motion (from
, fromvpos
, fromhpos
, did_motion
, to
, tovpos
, tohpos
, width
, hscroll
, tab_offset
, win
)
1187 int from
, fromvpos
, fromhpos
, to
, tovpos
, tohpos
;
1190 int hscroll
, tab_offset
;
1193 register int hpos
= fromhpos
;
1194 register int vpos
= fromvpos
;
1199 register int tab_width
= XFASTINT (current_buffer
->tab_width
);
1200 register int ctl_arrow
= !NILP (current_buffer
->ctl_arrow
);
1201 register struct Lisp_Char_Table
*dp
= window_display_table (win
);
1203 = (INTEGERP (current_buffer
->selective_display
)
1204 ? XINT (current_buffer
->selective_display
)
1205 : !NILP (current_buffer
->selective_display
) ? -1 : 0);
1207 = (selective
&& dp
&& VECTORP (DISP_INVIS_VECTOR (dp
))
1208 ? XVECTOR (DISP_INVIS_VECTOR (dp
))->size
: 0);
1209 /* The next location where the `invisible' property changes, or an
1210 overlay starts or ends. */
1211 int next_boundary
= from
;
1213 /* For computing runs of characters with similar widths.
1214 Invariant: width_run_width is zero, or all the characters
1215 from width_run_start to width_run_end have a fixed width of
1217 int width_run_start
= from
;
1218 int width_run_end
= from
;
1219 int width_run_width
= 0;
1220 Lisp_Object
*width_table
;
1223 /* The next buffer pos where we should consult the width run cache. */
1224 int next_width_run
= from
;
1227 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
1228 /* If previous char scanned was a wide character,
1229 this is the column where it ended. Otherwise, this is 0. */
1230 int wide_column_end_hpos
= 0;
1231 int prev_pos
; /* Previous buffer position. */
1232 int prev_pos_byte
; /* Previous buffer position. */
1235 int contin_hpos
; /* HPOS of last column of continued line. */
1236 int prev_tab_offset
; /* Previous tab offset. */
1237 int continuation_glyph_width
;
1239 XSETBUFFER (buffer
, current_buffer
);
1240 XSETWINDOW (window
, win
);
1242 width_run_cache_on_off ();
1243 if (dp
== buffer_display_table ())
1244 width_table
= (VECTORP (current_buffer
->width_table
)
1245 ? XVECTOR (current_buffer
->width_table
)->contents
1248 /* If the window has its own display table, we can't use the width
1249 run cache, because that's based on the buffer's display table. */
1252 if (tab_width
<= 0 || tab_width
> 1000)
1255 /* Negative width means use all available text columns. */
1258 width
= window_box_text_cols (win
);
1259 /* We must make room for continuation marks if we don't have fringes. */
1260 #ifdef HAVE_WINDOW_SYSTEM
1261 if (!FRAME_WINDOW_P (XFRAME (win
->frame
)))
1266 continuation_glyph_width
= 1;
1267 #ifdef HAVE_WINDOW_SYSTEM
1268 if (FRAME_WINDOW_P (XFRAME (win
->frame
)))
1269 continuation_glyph_width
= 0; /* In the fringe. */
1275 pos
= prev_pos
= from
;
1276 pos_byte
= prev_pos_byte
= CHAR_TO_BYTE (from
);
1278 prev_tab_offset
= tab_offset
;
1281 while (pos
== next_boundary
)
1286 /* Don't skip invisible if we are already at the margin. */
1287 if (vpos
> tovpos
|| (vpos
== tovpos
&& hpos
>= tohpos
))
1289 if (contin_hpos
&& prev_hpos
== 0
1291 && (contin_hpos
== width
|| wide_column_end_hpos
> width
))
1292 { /* Line breaks because we can't put the character at the
1293 previous line any more. It is not the multi-column
1294 character continued in middle. Go back to previous
1295 buffer position, screen position, and set tab offset
1296 to previous value. It's the beginning of the
1299 pos_byte
= prev_pos_byte
;
1302 tab_offset
= prev_tab_offset
;
1307 /* If the caller says that the screen position came from an earlier
1308 call to compute_motion, then we've already accounted for the
1309 overlay strings at point. This is only true the first time
1310 through, so clear the flag after testing it. */
1312 /* We need to skip past the overlay strings. Currently those
1313 strings must not contain TAB;
1314 if we want to relax that restriction, something will have
1315 to be changed here. */
1317 unsigned char *ovstr
;
1318 int ovlen
= overlay_strings (pos
, win
, &ovstr
);
1319 hpos
+= ((multibyte
&& ovlen
> 0)
1320 ? strwidth (ovstr
, ovlen
) : ovlen
);
1327 /* Advance POS past invisible characters
1328 (but not necessarily all that there are here),
1329 and store in next_boundary the next position where
1330 we need to call skip_invisible. */
1331 newpos
= skip_invisible (pos
, &next_boundary
, to
, window
);
1335 pos
= min (to
, newpos
);
1336 pos_byte
= CHAR_TO_BYTE (pos
);
1340 if (newpos
!= pos_here
)
1343 pos_byte
= CHAR_TO_BYTE (pos
);
1347 /* Handle right margin. */
1348 /* Note on a wide-column character.
1350 Characters are classified into the following three categories
1351 according to the width (columns occupied on screen).
1353 (1) single-column character: ex. `a'
1354 (2) multi-column character: ex. `^A', TAB, `\033'
1355 (3) wide-column character: ex. Japanese character, Chinese character
1356 (In the following example, `W_' stands for them.)
1358 Multi-column characters can be divided around the right margin,
1359 but wide-column characters cannot.
1363 (*) The cursor is placed on the next character after the point.
1367 j ^---- next after the point
1368 ^--- next char. after the point.
1370 In case of sigle-column character
1374 033 ^---- next after the point, next char. after the point.
1376 In case of multi-column character
1380 W_ ^---- next after the point
1381 ^---- next char. after the point.
1383 In case of wide-column character
1385 The problem here is continuation at a wide-column character.
1386 In this case, the line may shorter less than WIDTH.
1387 And we find the continuation AFTER it occurs.
1394 || (truncate_partial_width_windows
1395 && ((width
+ continuation_glyph_width
)
1396 < FRAME_COLS (XFRAME (WINDOW_FRAME (win
)))))
1397 || !NILP (current_buffer
->truncate_lines
))
1399 /* Truncating: skip to newline, unless we are already past
1400 TO (we need to go back below). */
1403 pos
= find_before_next_newline (pos
, to
, 1);
1404 pos_byte
= CHAR_TO_BYTE (pos
);
1406 /* If we just skipped next_boundary,
1407 loop around in the main while
1409 if (pos
>= next_boundary
)
1410 next_boundary
= pos
+ 1;
1413 prev_tab_offset
= tab_offset
;
1419 /* Remember the previous value. */
1420 prev_tab_offset
= tab_offset
;
1422 if (wide_column_end_hpos
> width
)
1425 tab_offset
+= prev_hpos
;
1429 tab_offset
+= width
;
1433 contin_hpos
= prev_hpos
;
1439 /* Stop if past the target buffer position or screen position. */
1442 /* Go back to the previous position. */
1444 pos_byte
= prev_pos_byte
;
1447 tab_offset
= prev_tab_offset
;
1449 /* NOTE on contin_hpos, hpos, and prev_hpos.
1453 W_ ^---- contin_hpos
1459 if (contin_hpos
&& prev_hpos
== 0
1460 && contin_hpos
< width
&& !wide_column_end_hpos
)
1462 /* Line breaking occurs in the middle of multi-column
1463 character. Go back to previous line. */
1470 if (vpos
> tovpos
|| (vpos
== tovpos
&& hpos
>= tohpos
))
1472 if (contin_hpos
&& prev_hpos
== 0
1474 && (contin_hpos
== width
|| wide_column_end_hpos
> width
))
1475 { /* Line breaks because we can't put the character at the
1476 previous line any more. It is not the multi-column
1477 character continued in middle. Go back to previous
1478 buffer position, screen position, and set tab offset
1479 to previous value. It's the beginning of the
1482 pos_byte
= prev_pos_byte
;
1485 tab_offset
= prev_tab_offset
;
1489 if (pos
== ZV
) /* We cannot go beyond ZV. Stop here. */
1495 prev_pos_byte
= pos_byte
;
1496 wide_column_end_hpos
= 0;
1498 /* Consult the width run cache to see if we can avoid inspecting
1499 the text character-by-character. */
1500 if (current_buffer
->width_run_cache
&& pos
>= next_width_run
)
1504 = region_cache_forward (current_buffer
,
1505 current_buffer
->width_run_cache
,
1508 /* A width of zero means the character's width varies (like
1509 a tab), is meaningless (like a newline), or we just don't
1510 want to skip over it for some other reason. */
1511 if (common_width
!= 0)
1515 /* Don't go past the final buffer posn the user
1520 run_end_hpos
= hpos
+ (run_end
- pos
) * common_width
;
1522 /* Don't go past the final horizontal position the user
1524 if (vpos
== tovpos
&& run_end_hpos
> tohpos
)
1526 run_end
= pos
+ (tohpos
- hpos
) / common_width
;
1527 run_end_hpos
= hpos
+ (run_end
- pos
) * common_width
;
1530 /* Don't go past the margin. */
1531 if (run_end_hpos
>= width
)
1533 run_end
= pos
+ (width
- hpos
) / common_width
;
1534 run_end_hpos
= hpos
+ (run_end
- pos
) * common_width
;
1537 hpos
= run_end_hpos
;
1539 prev_hpos
= hpos
- common_width
;
1543 pos_byte
= CHAR_TO_BYTE (pos
);
1547 next_width_run
= run_end
+ 1;
1550 /* We have to scan the text character-by-character. */
1554 Lisp_Object charvec
;
1556 c
= FETCH_BYTE (pos_byte
);
1558 /* Check composition sequence. */
1560 int len
, len_byte
, width
;
1562 if (check_composition (pos
, pos_byte
, to
, &len
, &len_byte
, &width
))
1565 pos_byte
+= len_byte
;
1573 /* Perhaps add some info to the width_run_cache. */
1574 if (current_buffer
->width_run_cache
)
1576 /* Is this character part of the current run? If so, extend
1578 if (pos
- 1 == width_run_end
1579 && XFASTINT (width_table
[c
]) == width_run_width
)
1580 width_run_end
= pos
;
1582 /* The previous run is over, since this is a character at a
1583 different position, or a different width. */
1586 /* Have we accumulated a run to put in the cache?
1587 (Currently, we only cache runs of width == 1). */
1588 if (width_run_start
< width_run_end
1589 && width_run_width
== 1)
1590 know_region_cache (current_buffer
,
1591 current_buffer
->width_run_cache
,
1592 width_run_start
, width_run_end
);
1594 /* Start recording a new width run. */
1595 width_run_width
= XFASTINT (width_table
[c
]);
1596 width_run_start
= pos
- 1;
1597 width_run_end
= pos
;
1602 && ! (multibyte
&& BASE_LEADING_CODE_P (c
))
1603 && VECTORP (DISP_CHAR_VECTOR (dp
, c
)))
1605 charvec
= DISP_CHAR_VECTOR (dp
, c
);
1606 n
= ASIZE (charvec
);
1614 for (i
= n
- 1; i
>= 0; --i
)
1616 if (VECTORP (charvec
))
1618 /* This should be handled the same as
1619 next_element_from_display_vector does it. */
1620 Lisp_Object entry
= AREF (charvec
, i
);
1622 if (INTEGERP (entry
)
1623 && GLYPH_CHAR_VALID_P (XFASTINT (entry
)))
1624 c
= FAST_GLYPH_CHAR (XFASTINT (entry
));
1629 if (c
>= 040 && c
< 0177)
1633 int tem
= ((hpos
+ tab_offset
+ hscroll
- (hscroll
> 0))
1637 hpos
+= tab_width
- tem
;
1642 && indented_beyond_p (pos
, pos_byte
,
1643 (double) selective
)) /* iftc */
1645 /* If (pos == to), we don't have to take care of
1646 selective display. */
1649 /* Skip any number of invisible lines all at once */
1652 pos
= find_before_next_newline (pos
, to
, 1);
1655 pos_byte
= CHAR_TO_BYTE (pos
);
1658 && indented_beyond_p (pos
, pos_byte
,
1659 (double) selective
)); /* iftc */
1660 /* Allow for the " ..." that is displayed for them. */
1663 hpos
+= selective_rlen
;
1667 DEC_BOTH (pos
, pos_byte
);
1668 /* We have skipped the invis text, but not the
1674 /* A visible line. */
1678 /* Count the truncation glyph on column 0 */
1680 hpos
+= continuation_glyph_width
;
1685 else if (c
== CR
&& selective
< 0)
1687 /* In selective display mode,
1688 everything from a ^M to the end of the line is invisible.
1689 Stop *before* the real newline. */
1692 pos
= find_before_next_newline (pos
, to
, 1);
1693 pos_byte
= CHAR_TO_BYTE (pos
);
1695 /* If we just skipped next_boundary,
1696 loop around in the main while
1698 if (pos
> next_boundary
)
1699 next_boundary
= pos
;
1700 /* Allow for the " ..." that is displayed for them. */
1703 hpos
+= selective_rlen
;
1708 else if (multibyte
&& BASE_LEADING_CODE_P (c
))
1710 /* Start of multi-byte form. */
1712 int bytes
, width
, wide_column
;
1714 pos_byte
--; /* rewind POS_BYTE */
1715 ptr
= BYTE_POS_ADDR (pos_byte
);
1716 MULTIBYTE_BYTES_WIDTH (ptr
, dp
);
1719 wide_column_end_hpos
= hpos
+ wide_column
;
1722 else if (VECTORP (charvec
))
1725 hpos
+= (ctl_arrow
&& c
< 0200) ? 2 : 4;
1732 /* Remember any final width run in the cache. */
1733 if (current_buffer
->width_run_cache
1734 && width_run_width
== 1
1735 && width_run_start
< width_run_end
)
1736 know_region_cache (current_buffer
, current_buffer
->width_run_cache
,
1737 width_run_start
, width_run_end
);
1739 val_compute_motion
.bufpos
= pos
;
1740 val_compute_motion
.bytepos
= pos_byte
;
1741 val_compute_motion
.hpos
= hpos
;
1742 val_compute_motion
.vpos
= vpos
;
1743 if (contin_hpos
&& prev_hpos
== 0)
1744 val_compute_motion
.prevhpos
= contin_hpos
;
1746 val_compute_motion
.prevhpos
= prev_hpos
;
1747 /* We alalways handle all of them here; none of them remain to do. */
1748 val_compute_motion
.ovstring_chars_done
= 0;
1750 /* Nonzero if have just continued a line */
1751 val_compute_motion
.contin
= (contin_hpos
&& prev_hpos
== 0);
1754 return &val_compute_motion
;
1758 DEFUN ("compute-motion", Fcompute_motion
, Scompute_motion
, 7, 7, 0,
1759 doc
: /* Scan through the current buffer, calculating screen position.
1760 Scan the current buffer forward from offset FROM,
1761 assuming it is at position FROMPOS--a cons of the form (HPOS . VPOS)--
1762 to position TO or position TOPOS--another cons of the form (HPOS . VPOS)--
1763 and return the ending buffer position and screen location.
1765 If TOPOS is nil, the actual width and height of the window's
1768 There are three additional arguments:
1770 WIDTH is the number of columns available to display text;
1771 this affects handling of continuation lines. A value of nil
1772 corresponds to the actual number of available text columns.
1774 OFFSETS is either nil or a cons cell (HSCROLL . TAB-OFFSET).
1775 HSCROLL is the number of columns not being displayed at the left
1776 margin; this is usually taken from a window's hscroll member.
1777 TAB-OFFSET is the number of columns of the first tab that aren't
1778 being displayed, perhaps because the line was continued within it.
1779 If OFFSETS is nil, HSCROLL and TAB-OFFSET are assumed to be zero.
1781 WINDOW is the window to operate on. It is used to choose the display table;
1782 if it is showing the current buffer, it is used also for
1783 deciding which overlay properties apply.
1784 Note that `compute-motion' always operates on the current buffer.
1786 The value is a list of five elements:
1787 (POS HPOS VPOS PREVHPOS CONTIN)
1788 POS is the buffer position where the scan stopped.
1789 VPOS is the vertical position where the scan stopped.
1790 HPOS is the horizontal position where the scan stopped.
1792 PREVHPOS is the horizontal position one character back from POS.
1793 CONTIN is t if a line was continued after (or within) the previous character.
1795 For example, to find the buffer position of column COL of line LINE
1796 of a certain window, pass the window's starting location as FROM
1797 and the window's upper-left coordinates as FROMPOS.
1798 Pass the buffer's (point-max) as TO, to limit the scan to the end of the
1799 visible section of the buffer, and pass LINE and COL as TOPOS. */)
1800 (from
, frompos
, to
, topos
, width
, offsets
, window
)
1801 Lisp_Object from
, frompos
, to
, topos
;
1802 Lisp_Object width
, offsets
, window
;
1805 Lisp_Object bufpos
, hpos
, vpos
, prevhpos
;
1806 struct position
*pos
;
1807 int hscroll
, tab_offset
;
1809 CHECK_NUMBER_COERCE_MARKER (from
);
1810 CHECK_CONS (frompos
);
1811 CHECK_NUMBER_CAR (frompos
);
1812 CHECK_NUMBER_CDR (frompos
);
1813 CHECK_NUMBER_COERCE_MARKER (to
);
1817 CHECK_NUMBER_CAR (topos
);
1818 CHECK_NUMBER_CDR (topos
);
1821 CHECK_NUMBER (width
);
1823 if (!NILP (offsets
))
1825 CHECK_CONS (offsets
);
1826 CHECK_NUMBER_CAR (offsets
);
1827 CHECK_NUMBER_CDR (offsets
);
1828 hscroll
= XINT (XCAR (offsets
));
1829 tab_offset
= XINT (XCDR (offsets
));
1832 hscroll
= tab_offset
= 0;
1835 window
= Fselected_window ();
1837 CHECK_LIVE_WINDOW (window
);
1838 w
= XWINDOW (window
);
1840 if (XINT (from
) < BEGV
|| XINT (from
) > ZV
)
1841 args_out_of_range_3 (from
, make_number (BEGV
), make_number (ZV
));
1842 if (XINT (to
) < BEGV
|| XINT (to
) > ZV
)
1843 args_out_of_range_3 (to
, make_number (BEGV
), make_number (ZV
));
1845 pos
= compute_motion (XINT (from
), XINT (XCDR (frompos
)),
1846 XINT (XCAR (frompos
)), 0,
1849 ? window_internal_height (w
)
1850 : XINT (XCDR (topos
))),
1852 ? (window_box_text_cols (w
)
1854 #ifdef HAVE_WINDOW_SYSTEM
1855 FRAME_WINDOW_P (XFRAME (w
->frame
)) ? 0 :
1858 : XINT (XCAR (topos
))),
1859 (NILP (width
) ? -1 : XINT (width
)),
1860 hscroll
, tab_offset
,
1863 XSETFASTINT (bufpos
, pos
->bufpos
);
1864 XSETINT (hpos
, pos
->hpos
);
1865 XSETINT (vpos
, pos
->vpos
);
1866 XSETINT (prevhpos
, pos
->prevhpos
);
1868 return Fcons (bufpos
,
1872 Fcons (pos
->contin
? Qt
: Qnil
, Qnil
)))));
1876 /* Fvertical_motion and vmotion */
1878 struct position val_vmotion
;
1881 vmotion (from
, vtarget
, w
)
1882 register int from
, vtarget
;
1885 int hscroll
= XINT (w
->hscroll
);
1886 struct position pos
;
1887 /* vpos is cumulative vertical position, changed as from is changed */
1888 register int vpos
= 0;
1892 int lmargin
= hscroll
> 0 ? 1 - hscroll
: 0;
1894 = (INTEGERP (current_buffer
->selective_display
)
1895 ? XINT (current_buffer
->selective_display
)
1896 : !NILP (current_buffer
->selective_display
) ? -1 : 0);
1900 /* This is the object we use for fetching character properties. */
1901 Lisp_Object text_prop_object
;
1903 XSETWINDOW (window
, w
);
1905 /* If the window contains this buffer, use it for getting text properties.
1906 Otherwise use the current buffer as arg for doing that. */
1907 if (EQ (w
->buffer
, Fcurrent_buffer ()))
1908 text_prop_object
= window
;
1910 text_prop_object
= Fcurrent_buffer ();
1912 if (vpos
>= vtarget
)
1914 /* To move upward, go a line at a time until
1915 we have gone at least far enough. */
1919 while ((vpos
> vtarget
|| first
) && from
> BEGV
)
1921 Lisp_Object propval
;
1923 prevline
= find_next_newline_no_quit (from
- 1, -1);
1924 while (prevline
> BEGV
1926 && indented_beyond_p (prevline
,
1927 CHAR_TO_BYTE (prevline
),
1928 (double) selective
)) /* iftc */
1929 /* Watch out for newlines with `invisible' property.
1930 When moving upward, check the newline before. */
1931 || (propval
= Fget_char_property (make_number (prevline
- 1),
1934 TEXT_PROP_MEANS_INVISIBLE (propval
))))
1935 prevline
= find_next_newline_no_quit (prevline
- 1, -1);
1936 pos
= *compute_motion (prevline
, 0,
1937 lmargin
+ (prevline
== BEG
? start_hpos
: 0),
1940 /* Don't care for VPOS... */
1941 1 << (BITS_PER_SHORT
- 1),
1943 1 << (BITS_PER_SHORT
- 1),
1945 /* This compensates for start_hpos
1946 so that a tab as first character
1947 still occupies 8 columns. */
1948 (prevline
== BEG
? -start_hpos
: 0),
1955 /* If we made exactly the desired vertical distance,
1956 or if we hit beginning of buffer,
1957 return point found */
1958 if (vpos
>= vtarget
)
1960 val_vmotion
.bufpos
= from
;
1961 val_vmotion
.bytepos
= CHAR_TO_BYTE (from
);
1962 val_vmotion
.vpos
= vpos
;
1963 val_vmotion
.hpos
= lmargin
;
1964 val_vmotion
.contin
= 0;
1965 val_vmotion
.prevhpos
= 0;
1966 val_vmotion
.ovstring_chars_done
= 0;
1967 val_vmotion
.tab_offset
= 0; /* For accumulating tab offset. */
1968 return &val_vmotion
;
1971 /* Otherwise find the correct spot by moving down */
1973 /* Moving downward is simple, but must calculate from beg of line
1974 to determine hpos of starting point */
1975 from_byte
= CHAR_TO_BYTE (from
);
1976 if (from
> BEGV
&& FETCH_BYTE (from_byte
- 1) != '\n')
1978 Lisp_Object propval
;
1980 prevline
= find_next_newline_no_quit (from
, -1);
1981 while (prevline
> BEGV
1983 && indented_beyond_p (prevline
,
1984 CHAR_TO_BYTE (prevline
),
1985 (double) selective
)) /* iftc */
1986 /* Watch out for newlines with `invisible' property.
1987 When moving downward, check the newline after. */
1988 || (propval
= Fget_char_property (make_number (prevline
),
1991 TEXT_PROP_MEANS_INVISIBLE (propval
))))
1992 prevline
= find_next_newline_no_quit (prevline
- 1, -1);
1993 pos
= *compute_motion (prevline
, 0,
1994 lmargin
+ (prevline
== BEG
1998 /* Don't care for VPOS... */
1999 1 << (BITS_PER_SHORT
- 1),
2001 1 << (BITS_PER_SHORT
- 1),
2003 (prevline
== BEG
? -start_hpos
: 0),
2009 pos
.hpos
= lmargin
+ (from
== BEG
? start_hpos
: 0);
2014 return compute_motion (from
, vpos
, pos
.hpos
, did_motion
,
2015 ZV
, vtarget
, - (1 << (BITS_PER_SHORT
- 1)),
2017 pos
.tab_offset
- (from
== BEG
? start_hpos
: 0),
2021 DEFUN ("vertical-motion", Fvertical_motion
, Svertical_motion
, 1, 2, 0,
2022 doc
: /* Move point to start of the screen line LINES lines down.
2023 If LINES is negative, this means moving up.
2025 This function is an ordinary cursor motion function
2026 which calculates the new position based on how text would be displayed.
2027 The new position may be the start of a line,
2028 or just the start of a continuation line.
2029 The function returns number of screen lines moved over;
2030 that usually equals LINES, but may be closer to zero
2031 if beginning or end of buffer was reached.
2033 The optional second argument WINDOW specifies the window to use for
2034 parameters such as width, horizontal scrolling, and so on.
2035 The default is to use the selected window's parameters.
2037 `vertical-motion' always uses the current buffer,
2038 regardless of which buffer is displayed in WINDOW.
2039 This is consistent with other cursor motion functions
2040 and makes it possible to use `vertical-motion' in any buffer,
2041 whether or not it is currently displayed in some window. */)
2043 Lisp_Object lines
, window
;
2048 Lisp_Object old_buffer
;
2049 struct gcpro gcpro1
;
2051 CHECK_NUMBER (lines
);
2052 if (! NILP (window
))
2053 CHECK_WINDOW (window
);
2055 window
= selected_window
;
2056 w
= XWINDOW (window
);
2059 GCPRO1 (old_buffer
);
2060 if (XBUFFER (w
->buffer
) != current_buffer
)
2062 /* Set the window's buffer temporarily to the current buffer. */
2063 old_buffer
= w
->buffer
;
2064 XSETBUFFER (w
->buffer
, current_buffer
);
2069 struct position pos
;
2070 pos
= *vmotion (PT
, XINT (lines
), w
);
2071 SET_PT_BOTH (pos
.bufpos
, pos
.bytepos
);
2077 int start_on_image_or_stretch_p
;
2079 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
2080 start_display (&it
, w
, pt
);
2082 /* Scan from the start of the line containing PT. If we don't
2083 do this, we start moving with IT->current_x == 0, while PT is
2084 really at some x > 0. The effect is, in continuation lines, that
2085 we end up with the iterator placed at where it thinks X is 0,
2086 while the end position is really at some X > 0, the same X that
2088 it_start
= IT_CHARPOS (it
);
2089 start_on_image_or_stretch_p
= (it
.method
== GET_FROM_IMAGE
2090 || it
.method
== GET_FROM_STRETCH
);
2091 reseat_at_previous_visible_line_start (&it
);
2092 it
.current_x
= it
.hpos
= 0;
2093 /* Temporarily disable selective display so we don't move too far */
2094 oselective
= it
.selective
;
2096 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
2097 it
.selective
= oselective
;
2099 /* Move back if we got too far. This may happen if
2100 truncate-lines is on and PT is beyond right margin.
2101 It may also happen if it_start is on an image or a stretch
2102 glyph -- in that case, don't go back. */
2103 if (IT_CHARPOS (it
) > it_start
&& XINT (lines
) > 0
2104 && !start_on_image_or_stretch_p
)
2105 move_it_by_lines (&it
, -1, 0);
2108 /* Do this even if LINES is 0, so that we move back
2109 to the beginning of the current line as we ought. */
2110 if (XINT (lines
) >= 0 || IT_CHARPOS (it
) > 0)
2111 move_it_by_lines (&it
, XINT (lines
), 0);
2113 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
2116 if (BUFFERP (old_buffer
))
2117 w
->buffer
= old_buffer
;
2119 RETURN_UNGCPRO (make_number (it
.vpos
));
2124 /* File's initialization. */
2129 DEFVAR_BOOL ("indent-tabs-mode", &indent_tabs_mode
,
2130 doc
: /* *Indentation can insert tabs if this is non-nil.
2131 Setting this variable automatically makes it local to the current buffer. */);
2132 indent_tabs_mode
= 1;
2134 defsubr (&Scurrent_indentation
);
2135 defsubr (&Sindent_to
);
2136 defsubr (&Scurrent_column
);
2137 defsubr (&Smove_to_column
);
2138 defsubr (&Svertical_motion
);
2139 defsubr (&Scompute_motion
);
2142 /* arch-tag: 9adfea44-71f7-4988-8ee3-96da15c502cc
2143 (do not change this comment) */