1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2015 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code.
36 The following diagram shows how redisplay code is invoked. As you
37 can see, Lisp calls redisplay and vice versa. Under window systems
38 like X, some portions of the redisplay code are also called
39 asynchronously during mouse movement or expose events. It is very
40 important that these code parts do NOT use the C library (malloc,
41 free) because many C libraries under Unix are not reentrant. They
42 may also NOT call functions of the Lisp interpreter which could
43 change the interpreter's state. If you don't follow these rules,
44 you will encounter bugs which are very hard to explain.
46 +--------------+ redisplay +----------------+
47 | Lisp machine |---------------->| Redisplay code |<--+
48 +--------------+ (xdisp.c) +----------------+ |
50 +----------------------------------+ |
51 Don't use this path when called |
54 expose_window (asynchronous) |
56 X expose events -----+
58 What does redisplay do? Obviously, it has to figure out somehow what
59 has been changed since the last time the display has been updated,
60 and to make these changes visible. Preferably it would do that in
61 a moderately intelligent way, i.e. fast.
63 Changes in buffer text can be deduced from window and buffer
64 structures, and from some global variables like `beg_unchanged' and
65 `end_unchanged'. The contents of the display are additionally
66 recorded in a `glyph matrix', a two-dimensional matrix of glyph
67 structures. Each row in such a matrix corresponds to a line on the
68 display, and each glyph in a row corresponds to a column displaying
69 a character, an image, or what else. This matrix is called the
70 `current glyph matrix' or `current matrix' in redisplay
73 For buffer parts that have been changed since the last update, a
74 second glyph matrix is constructed, the so called `desired glyph
75 matrix' or short `desired matrix'. Current and desired matrix are
76 then compared to find a cheap way to update the display, e.g. by
77 reusing part of the display by scrolling lines.
79 You will find a lot of redisplay optimizations when you start
80 looking at the innards of redisplay. The overall goal of all these
81 optimizations is to make redisplay fast because it is done
82 frequently. Some of these optimizations are implemented by the
87 This function tries to update the display if the text in the
88 window did not change and did not scroll, only point moved, and
89 it did not move off the displayed portion of the text.
91 . try_window_reusing_current_matrix
93 This function reuses the current matrix of a window when text
94 has not changed, but the window start changed (e.g., due to
99 This function attempts to redisplay a window by reusing parts of
100 its existing display. It finds and reuses the part that was not
101 changed, and redraws the rest. (The "id" part in the function's
102 name stands for "insert/delete", not for "identification" or
107 This function performs the full redisplay of a single window
108 assuming that its fonts were not changed and that the cursor
109 will not end up in the scroll margins. (Loading fonts requires
110 re-adjustment of dimensions of glyph matrices, which makes this
111 method impossible to use.)
113 These optimizations are tried in sequence (some can be skipped if
114 it is known that they are not applicable). If none of the
115 optimizations were successful, redisplay calls redisplay_windows,
116 which performs a full redisplay of all windows.
118 Note that there's one more important optimization up Emacs's
119 sleeve, but it is related to actually redrawing the potentially
120 changed portions of the window/frame, not to reproducing the
121 desired matrices of those potentially changed portions. Namely,
122 the function update_frame and its subroutines, which you will find
123 in dispnew.c, compare the desired matrices with the current
124 matrices, and only redraw the portions that changed. So it could
125 happen that the functions in this file for some reason decide that
126 the entire desired matrix needs to be regenerated from scratch, and
127 still only parts of the Emacs display, or even nothing at all, will
128 be actually delivered to the glass, because update_frame has found
129 that the new and the old screen contents are similar or identical.
133 Desired matrices are always built per Emacs window. The function
134 `display_line' is the central function to look at if you are
135 interested. It constructs one row in a desired matrix given an
136 iterator structure containing both a buffer position and a
137 description of the environment in which the text is to be
138 displayed. But this is too early, read on.
140 Characters and pixmaps displayed for a range of buffer text depend
141 on various settings of buffers and windows, on overlays and text
142 properties, on display tables, on selective display. The good news
143 is that all this hairy stuff is hidden behind a small set of
144 interface functions taking an iterator structure (struct it)
147 Iteration over things to be displayed is then simple. It is
148 started by initializing an iterator with a call to init_iterator,
149 passing it the buffer position where to start iteration. For
150 iteration over strings, pass -1 as the position to init_iterator,
151 and call reseat_to_string when the string is ready, to initialize
152 the iterator for that string. Thereafter, calls to
153 get_next_display_element fill the iterator structure with relevant
154 information about the next thing to display. Calls to
155 set_iterator_to_next move the iterator to the next thing.
157 Besides this, an iterator also contains information about the
158 display environment in which glyphs for display elements are to be
159 produced. It has fields for the width and height of the display,
160 the information whether long lines are truncated or continued, a
161 current X and Y position, and lots of other stuff you can better
164 Glyphs in a desired matrix are normally constructed in a loop
165 calling get_next_display_element and then PRODUCE_GLYPHS. The call
166 to PRODUCE_GLYPHS will fill the iterator structure with pixel
167 information about the element being displayed and at the same time
168 produce glyphs for it. If the display element fits on the line
169 being displayed, set_iterator_to_next is called next, otherwise the
170 glyphs produced are discarded. The function display_line is the
171 workhorse of filling glyph rows in the desired matrix with glyphs.
172 In addition to producing glyphs, it also handles line truncation
173 and continuation, word wrap, and cursor positioning (for the
174 latter, see also set_cursor_from_row).
178 That just couldn't be all, could it? What about terminal types not
179 supporting operations on sub-windows of the screen? To update the
180 display on such a terminal, window-based glyph matrices are not
181 well suited. To be able to reuse part of the display (scrolling
182 lines up and down), we must instead have a view of the whole
183 screen. This is what `frame matrices' are for. They are a trick.
185 Frames on terminals like above have a glyph pool. Windows on such
186 a frame sub-allocate their glyph memory from their frame's glyph
187 pool. The frame itself is given its own glyph matrices. By
188 coincidence---or maybe something else---rows in window glyph
189 matrices are slices of corresponding rows in frame matrices. Thus
190 writing to window matrices implicitly updates a frame matrix which
191 provides us with the view of the whole screen that we originally
192 wanted to have without having to move many bytes around. To be
193 honest, there is a little bit more done, but not much more. If you
194 plan to extend that code, take a look at dispnew.c. The function
195 build_frame_matrix is a good starting point.
197 Bidirectional display.
199 Bidirectional display adds quite some hair to this already complex
200 design. The good news are that a large portion of that hairy stuff
201 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
202 reordering engine which is called by set_iterator_to_next and
203 returns the next character to display in the visual order. See
204 commentary on bidi.c for more details. As far as redisplay is
205 concerned, the effect of calling bidi_move_to_visually_next, the
206 main interface of the reordering engine, is that the iterator gets
207 magically placed on the buffer or string position that is to be
208 displayed next. In other words, a linear iteration through the
209 buffer/string is replaced with a non-linear one. All the rest of
210 the redisplay is oblivious to the bidi reordering.
212 Well, almost oblivious---there are still complications, most of
213 them due to the fact that buffer and string positions no longer
214 change monotonously with glyph indices in a glyph row. Moreover,
215 for continued lines, the buffer positions may not even be
216 monotonously changing with vertical positions. Also, accounting
217 for face changes, overlays, etc. becomes more complex because
218 non-linear iteration could potentially skip many positions with
219 changes, and then cross them again on the way back...
221 One other prominent effect of bidirectional display is that some
222 paragraphs of text need to be displayed starting at the right
223 margin of the window---the so-called right-to-left, or R2L
224 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
225 which have their reversed_p flag set. The bidi reordering engine
226 produces characters in such rows starting from the character which
227 should be the rightmost on display. PRODUCE_GLYPHS then reverses
228 the order, when it fills up the glyph row whose reversed_p flag is
229 set, by prepending each new glyph to what is already there, instead
230 of appending it. When the glyph row is complete, the function
231 extend_face_to_end_of_line fills the empty space to the left of the
232 leftmost character with special glyphs, which will display as,
233 well, empty. On text terminals, these special glyphs are simply
234 blank characters. On graphics terminals, there's a single stretch
235 glyph of a suitably computed width. Both the blanks and the
236 stretch glyph are given the face of the background of the line.
237 This way, the terminal-specific back-end can still draw the glyphs
238 left to right, even for R2L lines.
240 Bidirectional display and character compositions
242 Some scripts cannot be displayed by drawing each character
243 individually, because adjacent characters change each other's shape
244 on display. For example, Arabic and Indic scripts belong to this
247 Emacs display supports this by providing "character compositions",
248 most of which is implemented in composite.c. During the buffer
249 scan that delivers characters to PRODUCE_GLYPHS, if the next
250 character to be delivered is a composed character, the iteration
251 calls composition_reseat_it and next_element_from_composition. If
252 they succeed to compose the character with one or more of the
253 following characters, the whole sequence of characters that where
254 composed is recorded in the `struct composition_it' object that is
255 part of the buffer iterator. The composed sequence could produce
256 one or more font glyphs (called "grapheme clusters") on the screen.
257 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
258 in the direction corresponding to the current bidi scan direction
259 (recorded in the scan_dir member of the `struct bidi_it' object
260 that is part of the buffer iterator). In particular, if the bidi
261 iterator currently scans the buffer backwards, the grapheme
262 clusters are delivered back to front. This reorders the grapheme
263 clusters as appropriate for the current bidi context. Note that
264 this means that the grapheme clusters are always stored in the
265 LGSTRING object (see composite.c) in the logical order.
267 Moving an iterator in bidirectional text
268 without producing glyphs
270 Note one important detail mentioned above: that the bidi reordering
271 engine, driven by the iterator, produces characters in R2L rows
272 starting at the character that will be the rightmost on display.
273 As far as the iterator is concerned, the geometry of such rows is
274 still left to right, i.e. the iterator "thinks" the first character
275 is at the leftmost pixel position. The iterator does not know that
276 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
277 delivers. This is important when functions from the move_it_*
278 family are used to get to certain screen position or to match
279 screen coordinates with buffer coordinates: these functions use the
280 iterator geometry, which is left to right even in R2L paragraphs.
281 This works well with most callers of move_it_*, because they need
282 to get to a specific column, and columns are still numbered in the
283 reading order, i.e. the rightmost character in a R2L paragraph is
284 still column zero. But some callers do not get well with this; a
285 notable example is mouse clicks that need to find the character
286 that corresponds to certain pixel coordinates. See
287 buffer_posn_from_coords in dispnew.c for how this is handled. */
295 #include "keyboard.h"
298 #include "termchar.h"
299 #include "dispextern.h"
300 #include "character.h"
304 #include "commands.h"
308 #include "termhooks.h"
309 #include "termopts.h"
310 #include "intervals.h"
313 #include "region-cache.h"
316 #include "blockinput.h"
317 #ifdef HAVE_WINDOW_SYSTEM
319 #endif /* HAVE_WINDOW_SYSTEM */
321 #ifndef FRAME_X_OUTPUT
322 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
325 #define INFINITY 10000000
327 /* Holds the list (error). */
328 static Lisp_Object list_of_error
;
330 #ifdef HAVE_WINDOW_SYSTEM
332 /* Test if overflow newline into fringe. Called with iterator IT
333 at or past right window margin, and with IT->current_x set. */
335 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
336 (!NILP (Voverflow_newline_into_fringe) \
337 && FRAME_WINDOW_P ((IT)->f) \
338 && ((IT)->bidi_it.paragraph_dir == R2L \
339 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
340 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
341 && (IT)->current_x == (IT)->last_visible_x)
343 #else /* !HAVE_WINDOW_SYSTEM */
344 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) false
345 #endif /* HAVE_WINDOW_SYSTEM */
347 /* Test if the display element loaded in IT, or the underlying buffer
348 or string character, is a space or a TAB character. This is used
349 to determine where word wrapping can occur. */
351 #define IT_DISPLAYING_WHITESPACE(it) \
352 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
353 || ((STRINGP (it->string) \
354 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
355 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
357 && (it->s[IT_BYTEPOS (*it)] == ' ' \
358 || it->s[IT_BYTEPOS (*it)] == '\t')) \
359 || (IT_BYTEPOS (*it) < ZV_BYTE \
360 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
361 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
363 /* True means print newline to stdout before next mini-buffer message. */
365 bool noninteractive_need_newline
;
367 /* True means print newline to message log before next message. */
369 static bool message_log_need_newline
;
371 /* Three markers that message_dolog uses.
372 It could allocate them itself, but that causes trouble
373 in handling memory-full errors. */
374 static Lisp_Object message_dolog_marker1
;
375 static Lisp_Object message_dolog_marker2
;
376 static Lisp_Object message_dolog_marker3
;
378 /* The buffer position of the first character appearing entirely or
379 partially on the line of the selected window which contains the
380 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
381 redisplay optimization in redisplay_internal. */
383 static struct text_pos this_line_start_pos
;
385 /* Number of characters past the end of the line above, including the
386 terminating newline. */
388 static struct text_pos this_line_end_pos
;
390 /* The vertical positions and the height of this line. */
392 static int this_line_vpos
;
393 static int this_line_y
;
394 static int this_line_pixel_height
;
396 /* X position at which this display line starts. Usually zero;
397 negative if first character is partially visible. */
399 static int this_line_start_x
;
401 /* The smallest character position seen by move_it_* functions as they
402 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
403 hscrolled lines, see display_line. */
405 static struct text_pos this_line_min_pos
;
407 /* Buffer that this_line_.* variables are referring to. */
409 static struct buffer
*this_line_buffer
;
411 /* True if an overlay arrow has been displayed in this window. */
413 static bool overlay_arrow_seen
;
415 /* Vector containing glyphs for an ellipsis `...'. */
417 static Lisp_Object default_invis_vector
[3];
419 /* This is the window where the echo area message was displayed. It
420 is always a mini-buffer window, but it may not be the same window
421 currently active as a mini-buffer. */
423 Lisp_Object echo_area_window
;
425 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
426 pushes the current message and the value of
427 message_enable_multibyte on the stack, the function restore_message
428 pops the stack and displays MESSAGE again. */
430 static Lisp_Object Vmessage_stack
;
432 /* True means multibyte characters were enabled when the echo area
433 message was specified. */
435 static bool message_enable_multibyte
;
437 /* Nonzero if we should redraw the mode lines on the next redisplay.
438 If it has value REDISPLAY_SOME, then only redisplay the mode lines where
439 the `redisplay' bit has been set. Otherwise, redisplay all mode lines
440 (the number used is then only used to track down the cause for this
443 int update_mode_lines
;
445 /* Nonzero if window sizes or contents other than selected-window have changed
446 since last redisplay that finished.
447 If it has value REDISPLAY_SOME, then only redisplay the windows where
448 the `redisplay' bit has been set. Otherwise, redisplay all windows
449 (the number used is then only used to track down the cause for this
452 int windows_or_buffers_changed
;
454 /* True after display_mode_line if %l was used and it displayed a
457 static bool line_number_displayed
;
459 /* The name of the *Messages* buffer, a string. */
461 static Lisp_Object Vmessages_buffer_name
;
463 /* Current, index 0, and last displayed echo area message. Either
464 buffers from echo_buffers, or nil to indicate no message. */
466 Lisp_Object echo_area_buffer
[2];
468 /* The buffers referenced from echo_area_buffer. */
470 static Lisp_Object echo_buffer
[2];
472 /* A vector saved used in with_area_buffer to reduce consing. */
474 static Lisp_Object Vwith_echo_area_save_vector
;
476 /* True means display_echo_area should display the last echo area
477 message again. Set by redisplay_preserve_echo_area. */
479 static bool display_last_displayed_message_p
;
481 /* True if echo area is being used by print; false if being used by
484 static bool message_buf_print
;
486 /* Set to true in clear_message to make redisplay_internal aware
487 of an emptied echo area. */
489 static bool message_cleared_p
;
491 /* A scratch glyph row with contents used for generating truncation
492 glyphs. Also used in direct_output_for_insert. */
494 #define MAX_SCRATCH_GLYPHS 100
495 static struct glyph_row scratch_glyph_row
;
496 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
498 /* Ascent and height of the last line processed by move_it_to. */
500 static int last_height
;
502 /* True if there's a help-echo in the echo area. */
504 bool help_echo_showing_p
;
506 /* The maximum distance to look ahead for text properties. Values
507 that are too small let us call compute_char_face and similar
508 functions too often which is expensive. Values that are too large
509 let us call compute_char_face and alike too often because we
510 might not be interested in text properties that far away. */
512 #define TEXT_PROP_DISTANCE_LIMIT 100
514 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
515 iterator state and later restore it. This is needed because the
516 bidi iterator on bidi.c keeps a stacked cache of its states, which
517 is really a singleton. When we use scratch iterator objects to
518 move around the buffer, we can cause the bidi cache to be pushed or
519 popped, and therefore we need to restore the cache state when we
520 return to the original iterator. */
521 #define SAVE_IT(ITCOPY, ITORIG, CACHE) \
524 bidi_unshelve_cache (CACHE, true); \
526 CACHE = bidi_shelve_cache (); \
529 #define RESTORE_IT(pITORIG, pITCOPY, CACHE) \
531 if (pITORIG != pITCOPY) \
532 *(pITORIG) = *(pITCOPY); \
533 bidi_unshelve_cache (CACHE, false); \
537 /* Functions to mark elements as needing redisplay. */
538 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
541 redisplay_other_windows (void)
543 if (!windows_or_buffers_changed
)
544 windows_or_buffers_changed
= REDISPLAY_SOME
;
548 wset_redisplay (struct window
*w
)
550 /* Beware: selected_window can be nil during early stages. */
551 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
552 redisplay_other_windows ();
557 fset_redisplay (struct frame
*f
)
559 redisplay_other_windows ();
564 bset_redisplay (struct buffer
*b
)
566 int count
= buffer_window_count (b
);
569 /* ... it's visible in other window than selected, */
570 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
571 redisplay_other_windows ();
572 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
573 so that if we later set windows_or_buffers_changed, this buffer will
575 b
->text
->redisplay
= true;
580 bset_update_mode_line (struct buffer
*b
)
582 if (!update_mode_lines
)
583 update_mode_lines
= REDISPLAY_SOME
;
584 b
->text
->redisplay
= true;
589 /* True means print traces of redisplay if compiled with
590 GLYPH_DEBUG defined. */
592 bool trace_redisplay_p
;
594 #endif /* GLYPH_DEBUG */
596 #ifdef DEBUG_TRACE_MOVE
597 /* True means trace with TRACE_MOVE to stderr. */
598 static bool trace_move
;
600 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
602 #define TRACE_MOVE(x) (void) 0
605 /* Buffer being redisplayed -- for redisplay_window_error. */
607 static struct buffer
*displayed_buffer
;
609 /* Value returned from text property handlers (see below). */
614 HANDLED_RECOMPUTE_PROPS
,
615 HANDLED_OVERLAY_STRING_CONSUMED
,
619 /* A description of text properties that redisplay is interested
624 /* The symbol index of the name of the property. */
627 /* A unique index for the property. */
630 /* A handler function called to set up iterator IT from the property
631 at IT's current position. Value is used to steer handle_stop. */
632 enum prop_handled (*handler
) (struct it
*it
);
635 static enum prop_handled
handle_face_prop (struct it
*);
636 static enum prop_handled
handle_invisible_prop (struct it
*);
637 static enum prop_handled
handle_display_prop (struct it
*);
638 static enum prop_handled
handle_composition_prop (struct it
*);
639 static enum prop_handled
handle_overlay_change (struct it
*);
640 static enum prop_handled
handle_fontified_prop (struct it
*);
642 /* Properties handled by iterators. */
644 static struct props it_props
[] =
646 {SYMBOL_INDEX (Qfontified
), FONTIFIED_PROP_IDX
, handle_fontified_prop
},
647 /* Handle `face' before `display' because some sub-properties of
648 `display' need to know the face. */
649 {SYMBOL_INDEX (Qface
), FACE_PROP_IDX
, handle_face_prop
},
650 {SYMBOL_INDEX (Qdisplay
), DISPLAY_PROP_IDX
, handle_display_prop
},
651 {SYMBOL_INDEX (Qinvisible
), INVISIBLE_PROP_IDX
, handle_invisible_prop
},
652 {SYMBOL_INDEX (Qcomposition
), COMPOSITION_PROP_IDX
, handle_composition_prop
},
656 /* Value is the position described by X. If X is a marker, value is
657 the marker_position of X. Otherwise, value is X. */
659 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
661 /* Enumeration returned by some move_it_.* functions internally. */
665 /* Not used. Undefined value. */
668 /* Move ended at the requested buffer position or ZV. */
669 MOVE_POS_MATCH_OR_ZV
,
671 /* Move ended at the requested X pixel position. */
674 /* Move within a line ended at the end of a line that must be
678 /* Move within a line ended at the end of a line that would
679 be displayed truncated. */
682 /* Move within a line ended at a line end. */
686 /* This counter is used to clear the face cache every once in a while
687 in redisplay_internal. It is incremented for each redisplay.
688 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
691 #define CLEAR_FACE_CACHE_COUNT 500
692 static int clear_face_cache_count
;
694 /* Similarly for the image cache. */
696 #ifdef HAVE_WINDOW_SYSTEM
697 #define CLEAR_IMAGE_CACHE_COUNT 101
698 static int clear_image_cache_count
;
700 /* Null glyph slice */
701 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
704 /* True while redisplay_internal is in progress. */
708 /* If a string, XTread_socket generates an event to display that string.
709 (The display is done in read_char.) */
711 Lisp_Object help_echo_string
;
712 Lisp_Object help_echo_window
;
713 Lisp_Object help_echo_object
;
714 ptrdiff_t help_echo_pos
;
716 /* Temporary variable for XTread_socket. */
718 Lisp_Object previous_help_echo_string
;
720 /* Platform-independent portion of hourglass implementation. */
722 #ifdef HAVE_WINDOW_SYSTEM
724 /* True means an hourglass cursor is currently shown. */
725 static bool hourglass_shown_p
;
727 /* If non-null, an asynchronous timer that, when it expires, displays
728 an hourglass cursor on all frames. */
729 static struct atimer
*hourglass_atimer
;
731 #endif /* HAVE_WINDOW_SYSTEM */
733 /* Default number of seconds to wait before displaying an hourglass
735 #define DEFAULT_HOURGLASS_DELAY 1
737 #ifdef HAVE_WINDOW_SYSTEM
739 /* Default pixel width of `thin-space' display method. */
740 #define THIN_SPACE_WIDTH 1
742 #endif /* HAVE_WINDOW_SYSTEM */
744 /* Function prototypes. */
746 static void setup_for_ellipsis (struct it
*, int);
747 static void set_iterator_to_next (struct it
*, bool);
748 static void mark_window_display_accurate_1 (struct window
*, bool);
749 static bool row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
750 static bool cursor_row_p (struct glyph_row
*);
751 static int redisplay_mode_lines (Lisp_Object
, bool);
753 static void handle_line_prefix (struct it
*);
755 static void handle_stop_backwards (struct it
*, ptrdiff_t);
756 static void unwind_with_echo_area_buffer (Lisp_Object
);
757 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
758 static bool current_message_1 (ptrdiff_t, Lisp_Object
);
759 static bool truncate_message_1 (ptrdiff_t, Lisp_Object
);
760 static void set_message (Lisp_Object
);
761 static bool set_message_1 (ptrdiff_t, Lisp_Object
);
762 static bool display_echo_area_1 (ptrdiff_t, Lisp_Object
);
763 static bool resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
764 static void unwind_redisplay (void);
765 static void extend_face_to_end_of_line (struct it
*);
766 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
767 static void push_it (struct it
*, struct text_pos
*);
768 static void iterate_out_of_display_property (struct it
*);
769 static void pop_it (struct it
*);
770 static void redisplay_internal (void);
771 static void echo_area_display (bool);
772 static void redisplay_windows (Lisp_Object
);
773 static void redisplay_window (Lisp_Object
, bool);
774 static Lisp_Object
redisplay_window_error (Lisp_Object
);
775 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
776 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
777 static bool set_cursor_from_row (struct window
*, struct glyph_row
*,
778 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
780 static bool update_menu_bar (struct frame
*, bool, bool);
781 static bool try_window_reusing_current_matrix (struct window
*);
782 static int try_window_id (struct window
*);
783 static bool display_line (struct it
*);
784 static int display_mode_lines (struct window
*);
785 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
786 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
,
788 static int store_mode_line_string (const char *, Lisp_Object
, bool, int, int,
790 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
791 static void display_menu_bar (struct window
*);
792 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
794 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
795 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
796 static void compute_line_metrics (struct it
*);
797 static void run_redisplay_end_trigger_hook (struct it
*);
798 static bool get_overlay_strings (struct it
*, ptrdiff_t);
799 static bool get_overlay_strings_1 (struct it
*, ptrdiff_t, bool);
800 static void next_overlay_string (struct it
*);
801 static void reseat (struct it
*, struct text_pos
, bool);
802 static void reseat_1 (struct it
*, struct text_pos
, bool);
803 static bool next_element_from_display_vector (struct it
*);
804 static bool next_element_from_string (struct it
*);
805 static bool next_element_from_c_string (struct it
*);
806 static bool next_element_from_buffer (struct it
*);
807 static bool next_element_from_composition (struct it
*);
808 static bool next_element_from_image (struct it
*);
809 static bool next_element_from_stretch (struct it
*);
810 static void load_overlay_strings (struct it
*, ptrdiff_t);
811 static bool get_next_display_element (struct it
*);
812 static enum move_it_result
813 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
814 enum move_operation_enum
);
815 static void get_visually_first_element (struct it
*);
816 static void compute_stop_pos (struct it
*);
817 static int face_before_or_after_it_pos (struct it
*, bool);
818 static ptrdiff_t next_overlay_change (ptrdiff_t);
819 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
820 Lisp_Object
, struct text_pos
*, ptrdiff_t, bool);
821 static int handle_single_display_spec (struct it
*, Lisp_Object
,
822 Lisp_Object
, Lisp_Object
,
823 struct text_pos
*, ptrdiff_t, int, bool);
824 static int underlying_face_id (struct it
*);
826 #define face_before_it_pos(IT) face_before_or_after_it_pos (IT, true)
827 #define face_after_it_pos(IT) face_before_or_after_it_pos (IT, false)
829 #ifdef HAVE_WINDOW_SYSTEM
831 static void update_tool_bar (struct frame
*, bool);
832 static void x_draw_bottom_divider (struct window
*w
);
833 static void notice_overwritten_cursor (struct window
*,
836 static int normal_char_height (struct font
*, int);
837 static void normal_char_ascent_descent (struct font
*, int, int *, int *);
839 static void append_stretch_glyph (struct it
*, Lisp_Object
,
842 static Lisp_Object
get_it_property (struct it
*, Lisp_Object
);
843 static Lisp_Object
calc_line_height_property (struct it
*, Lisp_Object
,
844 struct font
*, int, bool);
846 #endif /* HAVE_WINDOW_SYSTEM */
848 static void produce_special_glyphs (struct it
*, enum display_element_type
);
849 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
850 static bool coords_in_mouse_face_p (struct window
*, int, int);
854 /***********************************************************************
855 Window display dimensions
856 ***********************************************************************/
858 /* Return the bottom boundary y-position for text lines in window W.
859 This is the first y position at which a line cannot start.
860 It is relative to the top of the window.
862 This is the height of W minus the height of a mode line, if any. */
865 window_text_bottom_y (struct window
*w
)
867 int height
= WINDOW_PIXEL_HEIGHT (w
);
869 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
871 if (WINDOW_WANTS_MODELINE_P (w
))
872 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
874 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
879 /* Return the pixel width of display area AREA of window W.
880 ANY_AREA means return the total width of W, not including
881 fringes to the left and right of the window. */
884 window_box_width (struct window
*w
, enum glyph_row_area area
)
886 int width
= w
->pixel_width
;
888 if (!w
->pseudo_window_p
)
890 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
891 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
893 if (area
== TEXT_AREA
)
894 width
-= (WINDOW_MARGINS_WIDTH (w
)
895 + WINDOW_FRINGES_WIDTH (w
));
896 else if (area
== LEFT_MARGIN_AREA
)
897 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
898 else if (area
== RIGHT_MARGIN_AREA
)
899 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
902 /* With wide margins, fringes, etc. we might end up with a negative
903 width, correct that here. */
904 return max (0, width
);
908 /* Return the pixel height of the display area of window W, not
909 including mode lines of W, if any. */
912 window_box_height (struct window
*w
)
914 struct frame
*f
= XFRAME (w
->frame
);
915 int height
= WINDOW_PIXEL_HEIGHT (w
);
917 eassert (height
>= 0);
919 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
920 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
922 /* Note: the code below that determines the mode-line/header-line
923 height is essentially the same as that contained in the macro
924 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
925 the appropriate glyph row has its `mode_line_p' flag set,
926 and if it doesn't, uses estimate_mode_line_height instead. */
928 if (WINDOW_WANTS_MODELINE_P (w
))
930 struct glyph_row
*ml_row
931 = (w
->current_matrix
&& w
->current_matrix
->rows
932 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
934 if (ml_row
&& ml_row
->mode_line_p
)
935 height
-= ml_row
->height
;
937 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
940 if (WINDOW_WANTS_HEADER_LINE_P (w
))
942 struct glyph_row
*hl_row
943 = (w
->current_matrix
&& w
->current_matrix
->rows
944 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
946 if (hl_row
&& hl_row
->mode_line_p
)
947 height
-= hl_row
->height
;
949 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
952 /* With a very small font and a mode-line that's taller than
953 default, we might end up with a negative height. */
954 return max (0, height
);
957 /* Return the window-relative coordinate of the left edge of display
958 area AREA of window W. ANY_AREA means return the left edge of the
959 whole window, to the right of the left fringe of W. */
962 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
966 if (w
->pseudo_window_p
)
969 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
971 if (area
== TEXT_AREA
)
972 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
973 + window_box_width (w
, LEFT_MARGIN_AREA
));
974 else if (area
== RIGHT_MARGIN_AREA
)
975 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
976 + window_box_width (w
, LEFT_MARGIN_AREA
)
977 + window_box_width (w
, TEXT_AREA
)
978 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
980 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
981 else if (area
== LEFT_MARGIN_AREA
982 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
983 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
985 /* Don't return more than the window's pixel width. */
986 return min (x
, w
->pixel_width
);
990 /* Return the window-relative coordinate of the right edge of display
991 area AREA of window W. ANY_AREA means return the right edge of the
992 whole window, to the left of the right fringe of W. */
995 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
997 /* Don't return more than the window's pixel width. */
998 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1002 /* Return the frame-relative coordinate of the left edge of display
1003 area AREA of window W. ANY_AREA means return the left edge of the
1004 whole window, to the right of the left fringe of W. */
1007 window_box_left (struct window
*w
, enum glyph_row_area area
)
1009 struct frame
*f
= XFRAME (w
->frame
);
1012 if (w
->pseudo_window_p
)
1013 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1015 x
= (WINDOW_LEFT_EDGE_X (w
)
1016 + window_box_left_offset (w
, area
));
1022 /* Return the frame-relative coordinate of the right edge of display
1023 area AREA of window W. ANY_AREA means return the right edge of the
1024 whole window, to the left of the right fringe of W. */
1027 window_box_right (struct window
*w
, enum glyph_row_area area
)
1029 return window_box_left (w
, area
) + window_box_width (w
, area
);
1032 /* Get the bounding box of the display area AREA of window W, without
1033 mode lines, in frame-relative coordinates. ANY_AREA means the
1034 whole window, not including the left and right fringes of
1035 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1036 coordinates of the upper-left corner of the box. Return in
1037 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1040 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1041 int *box_y
, int *box_width
, int *box_height
)
1044 *box_width
= window_box_width (w
, area
);
1046 *box_height
= window_box_height (w
);
1048 *box_x
= window_box_left (w
, area
);
1051 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1052 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1053 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1057 #ifdef HAVE_WINDOW_SYSTEM
1059 /* Get the bounding box of the display area AREA of window W, without
1060 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1061 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1062 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1063 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1067 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1068 int *bottom_right_x
, int *bottom_right_y
)
1070 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1071 bottom_right_x
, bottom_right_y
);
1072 *bottom_right_x
+= *top_left_x
;
1073 *bottom_right_y
+= *top_left_y
;
1076 #endif /* HAVE_WINDOW_SYSTEM */
1078 /***********************************************************************
1080 ***********************************************************************/
1082 /* Return the bottom y-position of the line the iterator IT is in.
1083 This can modify IT's settings. */
1086 line_bottom_y (struct it
*it
)
1088 int line_height
= it
->max_ascent
+ it
->max_descent
;
1089 int line_top_y
= it
->current_y
;
1091 if (line_height
== 0)
1094 line_height
= last_height
;
1095 else if (IT_CHARPOS (*it
) < ZV
)
1097 move_it_by_lines (it
, 1);
1098 line_height
= (it
->max_ascent
|| it
->max_descent
1099 ? it
->max_ascent
+ it
->max_descent
1104 struct glyph_row
*row
= it
->glyph_row
;
1106 /* Use the default character height. */
1107 it
->glyph_row
= NULL
;
1108 it
->what
= IT_CHARACTER
;
1111 PRODUCE_GLYPHS (it
);
1112 line_height
= it
->ascent
+ it
->descent
;
1113 it
->glyph_row
= row
;
1117 return line_top_y
+ line_height
;
1120 DEFUN ("line-pixel-height", Fline_pixel_height
,
1121 Sline_pixel_height
, 0, 0, 0,
1122 doc
: /* Return height in pixels of text line in the selected window.
1124 Value is the height in pixels of the line at point. */)
1129 struct window
*w
= XWINDOW (selected_window
);
1130 struct buffer
*old_buffer
= NULL
;
1133 if (XBUFFER (w
->contents
) != current_buffer
)
1135 old_buffer
= current_buffer
;
1136 set_buffer_internal_1 (XBUFFER (w
->contents
));
1138 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1139 start_display (&it
, w
, pt
);
1140 it
.vpos
= it
.current_y
= 0;
1142 result
= make_number (line_bottom_y (&it
));
1144 set_buffer_internal_1 (old_buffer
);
1149 /* Return the default pixel height of text lines in window W. The
1150 value is the canonical height of the W frame's default font, plus
1151 any extra space required by the line-spacing variable or frame
1154 Implementation note: this ignores any line-spacing text properties
1155 put on the newline characters. This is because those properties
1156 only affect the _screen_ line ending in the newline (i.e., in a
1157 continued line, only the last screen line will be affected), which
1158 means only a small number of lines in a buffer can ever use this
1159 feature. Since this function is used to compute the default pixel
1160 equivalent of text lines in a window, we can safely ignore those
1161 few lines. For the same reasons, we ignore the line-height
1164 default_line_pixel_height (struct window
*w
)
1166 struct frame
*f
= WINDOW_XFRAME (w
);
1167 int height
= FRAME_LINE_HEIGHT (f
);
1169 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1171 struct buffer
*b
= XBUFFER (w
->contents
);
1172 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1175 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1178 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1179 height
+= XFASTINT (val
);
1180 else if (FLOATP (val
))
1182 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1189 height
+= f
->extra_line_spacing
;
1195 /* Subroutine of pos_visible_p below. Extracts a display string, if
1196 any, from the display spec given as its argument. */
1198 string_from_display_spec (Lisp_Object spec
)
1202 while (CONSP (spec
))
1204 if (STRINGP (XCAR (spec
)))
1209 else if (VECTORP (spec
))
1213 for (i
= 0; i
< ASIZE (spec
); i
++)
1215 if (STRINGP (AREF (spec
, i
)))
1216 return AREF (spec
, i
);
1225 /* Limit insanely large values of W->hscroll on frame F to the largest
1226 value that will still prevent first_visible_x and last_visible_x of
1227 'struct it' from overflowing an int. */
1229 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1231 ptrdiff_t window_hscroll
= w
->hscroll
;
1232 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1233 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1235 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1236 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1238 return window_hscroll
;
1241 /* Return true if position CHARPOS is visible in window W.
1242 CHARPOS < 0 means return info about WINDOW_END position.
1243 If visible, set *X and *Y to pixel coordinates of top left corner.
1244 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1245 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1248 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1249 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1252 void *itdata
= bidi_shelve_cache ();
1253 struct text_pos top
;
1254 bool visible_p
= false;
1255 struct buffer
*old_buffer
= NULL
;
1258 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1261 if (XBUFFER (w
->contents
) != current_buffer
)
1263 old_buffer
= current_buffer
;
1264 set_buffer_internal_1 (XBUFFER (w
->contents
));
1267 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1268 /* Scrolling a minibuffer window via scroll bar when the echo area
1269 shows long text sometimes resets the minibuffer contents behind
1271 if (CHARPOS (top
) > ZV
)
1272 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1274 /* Compute exact mode line heights. */
1275 if (WINDOW_WANTS_MODELINE_P (w
))
1277 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1278 BVAR (current_buffer
, mode_line_format
));
1280 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1281 w
->header_line_height
1282 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1283 BVAR (current_buffer
, header_line_format
));
1285 start_display (&it
, w
, top
);
1286 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1287 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1290 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1291 && IT_CHARPOS (it
) >= charpos
)
1292 /* When scanning backwards under bidi iteration, move_it_to
1293 stops at or _before_ CHARPOS, because it stops at or to
1294 the _right_ of the character at CHARPOS. */
1295 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1296 && IT_CHARPOS (it
) <= charpos
)))
1298 /* We have reached CHARPOS, or passed it. How the call to
1299 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1300 or covered by a display property, move_it_to stops at the end
1301 of the invisible text, to the right of CHARPOS. (ii) If
1302 CHARPOS is in a display vector, move_it_to stops on its last
1304 int top_x
= it
.current_x
;
1305 int top_y
= it
.current_y
;
1306 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1309 void *save_it_data
= NULL
;
1311 /* Calling line_bottom_y may change it.method, it.position, etc. */
1312 SAVE_IT (save_it
, it
, save_it_data
);
1314 bottom_y
= line_bottom_y (&it
);
1315 if (top_y
< window_top_y
)
1316 visible_p
= bottom_y
> window_top_y
;
1317 else if (top_y
< it
.last_visible_y
)
1319 if (bottom_y
>= it
.last_visible_y
1320 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1321 && IT_CHARPOS (it
) < charpos
)
1323 /* When the last line of the window is scanned backwards
1324 under bidi iteration, we could be duped into thinking
1325 that we have passed CHARPOS, when in fact move_it_to
1326 simply stopped short of CHARPOS because it reached
1327 last_visible_y. To see if that's what happened, we call
1328 move_it_to again with a slightly larger vertical limit,
1329 and see if it actually moved vertically; if it did, we
1330 didn't really reach CHARPOS, which is beyond window end. */
1331 /* Why 10? because we don't know how many canonical lines
1332 will the height of the next line(s) be. So we guess. */
1333 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1335 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1336 MOVE_TO_POS
| MOVE_TO_Y
);
1337 if (it
.current_y
> top_y
)
1341 RESTORE_IT (&it
, &save_it
, save_it_data
);
1344 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1346 /* We stopped on the last glyph of a display vector.
1347 Try and recompute. Hack alert! */
1348 if (charpos
< 2 || top
.charpos
>= charpos
)
1349 top_x
= it
.glyph_row
->x
;
1352 struct it it2
, it2_prev
;
1353 /* The idea is to get to the previous buffer
1354 position, consume the character there, and use
1355 the pixel coordinates we get after that. But if
1356 the previous buffer position is also displayed
1357 from a display vector, we need to consume all of
1358 the glyphs from that display vector. */
1359 start_display (&it2
, w
, top
);
1360 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1361 /* If we didn't get to CHARPOS - 1, there's some
1362 replacing display property at that position, and
1363 we stopped after it. That is exactly the place
1364 whose coordinates we want. */
1365 if (IT_CHARPOS (it2
) != charpos
- 1)
1369 /* Iterate until we get out of the display
1370 vector that displays the character at
1373 get_next_display_element (&it2
);
1374 PRODUCE_GLYPHS (&it2
);
1376 set_iterator_to_next (&it2
, true);
1377 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1378 && IT_CHARPOS (it2
) < charpos
);
1380 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1381 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1382 top_x
= it
.glyph_row
->x
;
1385 top_x
= it2_prev
.current_x
;
1386 top_y
= it2_prev
.current_y
;
1390 else if (IT_CHARPOS (it
) != charpos
)
1392 Lisp_Object cpos
= make_number (charpos
);
1393 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1394 Lisp_Object string
= string_from_display_spec (spec
);
1395 struct text_pos tpos
;
1396 bool newline_in_string
1398 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1400 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1401 bool replacing_spec_p
1403 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1404 charpos
, FRAME_WINDOW_P (it
.f
)));
1405 /* The tricky code below is needed because there's a
1406 discrepancy between move_it_to and how we set cursor
1407 when PT is at the beginning of a portion of text
1408 covered by a display property or an overlay with a
1409 display property, or the display line ends in a
1410 newline from a display string. move_it_to will stop
1411 _after_ such display strings, whereas
1412 set_cursor_from_row conspires with cursor_row_p to
1413 place the cursor on the first glyph produced from the
1416 /* We have overshoot PT because it is covered by a
1417 display property that replaces the text it covers.
1418 If the string includes embedded newlines, we are also
1419 in the wrong display line. Backtrack to the correct
1420 line, where the display property begins. */
1421 if (replacing_spec_p
)
1423 Lisp_Object startpos
, endpos
;
1424 EMACS_INT start
, end
;
1427 /* Find the first and the last buffer positions
1428 covered by the display string. */
1430 Fnext_single_char_property_change (cpos
, Qdisplay
,
1433 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1435 start
= XFASTINT (startpos
);
1436 end
= XFASTINT (endpos
);
1437 /* Move to the last buffer position before the
1438 display property. */
1439 start_display (&it3
, w
, top
);
1440 if (start
> CHARPOS (top
))
1441 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1442 /* Move forward one more line if the position before
1443 the display string is a newline or if it is the
1444 rightmost character on a line that is
1445 continued or word-wrapped. */
1446 if (it3
.method
== GET_FROM_BUFFER
1448 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1449 move_it_by_lines (&it3
, 1);
1450 else if (move_it_in_display_line_to (&it3
, -1,
1454 == MOVE_LINE_CONTINUED
)
1456 move_it_by_lines (&it3
, 1);
1457 /* When we are under word-wrap, the #$@%!
1458 move_it_by_lines moves 2 lines, so we need to
1460 if (it3
.line_wrap
== WORD_WRAP
)
1461 move_it_by_lines (&it3
, -1);
1464 /* Record the vertical coordinate of the display
1465 line where we wound up. */
1466 top_y
= it3
.current_y
;
1469 /* When characters are reordered for display,
1470 the character displayed to the left of the
1471 display string could be _after_ the display
1472 property in the logical order. Use the
1473 smallest vertical position of these two. */
1474 start_display (&it3
, w
, top
);
1475 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1476 if (it3
.current_y
< top_y
)
1477 top_y
= it3
.current_y
;
1479 /* Move from the top of the window to the beginning
1480 of the display line where the display string
1482 start_display (&it3
, w
, top
);
1483 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1484 /* If it3_moved stays false after the 'while' loop
1485 below, that means we already were at a newline
1486 before the loop (e.g., the display string begins
1487 with a newline), so we don't need to (and cannot)
1488 inspect the glyphs of it3.glyph_row, because
1489 PRODUCE_GLYPHS will not produce anything for a
1490 newline, and thus it3.glyph_row stays at its
1491 stale content it got at top of the window. */
1492 bool it3_moved
= false;
1493 /* Finally, advance the iterator until we hit the
1494 first display element whose character position is
1495 CHARPOS, or until the first newline from the
1496 display string, which signals the end of the
1498 while (get_next_display_element (&it3
))
1500 PRODUCE_GLYPHS (&it3
);
1501 if (IT_CHARPOS (it3
) == charpos
1502 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1505 set_iterator_to_next (&it3
, false);
1507 top_x
= it3
.current_x
- it3
.pixel_width
;
1508 /* Normally, we would exit the above loop because we
1509 found the display element whose character
1510 position is CHARPOS. For the contingency that we
1511 didn't, and stopped at the first newline from the
1512 display string, move back over the glyphs
1513 produced from the string, until we find the
1514 rightmost glyph not from the string. */
1516 && newline_in_string
1517 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1519 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1520 + it3
.glyph_row
->used
[TEXT_AREA
];
1522 while (EQ ((g
- 1)->object
, string
))
1525 top_x
-= g
->pixel_width
;
1527 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1528 + it3
.glyph_row
->used
[TEXT_AREA
]);
1534 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1535 *rtop
= max (0, window_top_y
- top_y
);
1536 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1537 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1538 - max (top_y
, window_top_y
)));
1540 if (it
.bidi_it
.paragraph_dir
== R2L
)
1546 /* Either we were asked to provide info about WINDOW_END, or
1547 CHARPOS is in the partially visible glyph row at end of
1550 void *it2data
= NULL
;
1552 SAVE_IT (it2
, it
, it2data
);
1553 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1554 move_it_by_lines (&it
, 1);
1555 if (charpos
< IT_CHARPOS (it
)
1556 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1559 RESTORE_IT (&it2
, &it2
, it2data
);
1560 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1562 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1563 *rtop
= max (0, -it2
.current_y
);
1564 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1565 - it
.last_visible_y
));
1566 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1568 - max (it2
.current_y
,
1569 WINDOW_HEADER_LINE_HEIGHT (w
))));
1571 if (it2
.bidi_it
.paragraph_dir
== R2L
)
1575 bidi_unshelve_cache (it2data
, true);
1577 bidi_unshelve_cache (itdata
, false);
1580 set_buffer_internal_1 (old_buffer
);
1586 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1587 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1588 /* For lines in an R2L paragraph, we need to mirror the X pixel
1589 coordinate wrt the text area. For the reasons, see the
1590 commentary in buffer_posn_from_coords and the explanation of
1591 the geometry used by the move_it_* functions at the end of
1592 the large commentary near the beginning of this file. */
1594 *x
= window_box_width (w
, TEXT_AREA
) - *x
- 1;
1598 /* Debugging code. */
1600 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1601 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1603 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1610 /* Return the next character from STR. Return in *LEN the length of
1611 the character. This is like STRING_CHAR_AND_LENGTH but never
1612 returns an invalid character. If we find one, we return a `?', but
1613 with the length of the invalid character. */
1616 string_char_and_length (const unsigned char *str
, int *len
)
1620 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1621 if (!CHAR_VALID_P (c
))
1622 /* We may not change the length here because other places in Emacs
1623 don't use this function, i.e. they silently accept invalid
1632 /* Given a position POS containing a valid character and byte position
1633 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1635 static struct text_pos
1636 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1638 eassert (STRINGP (string
) && nchars
>= 0);
1640 if (STRING_MULTIBYTE (string
))
1642 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1647 string_char_and_length (p
, &len
);
1650 BYTEPOS (pos
) += len
;
1654 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1660 /* Value is the text position, i.e. character and byte position,
1661 for character position CHARPOS in STRING. */
1663 static struct text_pos
1664 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1666 struct text_pos pos
;
1667 eassert (STRINGP (string
));
1668 eassert (charpos
>= 0);
1669 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1674 /* Value is a text position, i.e. character and byte position, for
1675 character position CHARPOS in C string S. MULTIBYTE_P
1676 means recognize multibyte characters. */
1678 static struct text_pos
1679 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1681 struct text_pos pos
;
1683 eassert (s
!= NULL
);
1684 eassert (charpos
>= 0);
1690 SET_TEXT_POS (pos
, 0, 0);
1693 string_char_and_length ((const unsigned char *) s
, &len
);
1696 BYTEPOS (pos
) += len
;
1700 SET_TEXT_POS (pos
, charpos
, charpos
);
1706 /* Value is the number of characters in C string S. MULTIBYTE_P
1707 means recognize multibyte characters. */
1710 number_of_chars (const char *s
, bool multibyte_p
)
1716 ptrdiff_t rest
= strlen (s
);
1718 const unsigned char *p
= (const unsigned char *) s
;
1720 for (nchars
= 0; rest
> 0; ++nchars
)
1722 string_char_and_length (p
, &len
);
1723 rest
-= len
, p
+= len
;
1727 nchars
= strlen (s
);
1733 /* Compute byte position NEWPOS->bytepos corresponding to
1734 NEWPOS->charpos. POS is a known position in string STRING.
1735 NEWPOS->charpos must be >= POS.charpos. */
1738 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1740 eassert (STRINGP (string
));
1741 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1743 if (STRING_MULTIBYTE (string
))
1744 *newpos
= string_pos_nchars_ahead (pos
, string
,
1745 CHARPOS (*newpos
) - CHARPOS (pos
));
1747 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1751 Return an estimation of the pixel height of mode or header lines on
1752 frame F. FACE_ID specifies what line's height to estimate. */
1755 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1757 #ifdef HAVE_WINDOW_SYSTEM
1758 if (FRAME_WINDOW_P (f
))
1760 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1762 /* This function is called so early when Emacs starts that the face
1763 cache and mode line face are not yet initialized. */
1764 if (FRAME_FACE_CACHE (f
))
1766 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1770 height
= normal_char_height (face
->font
, -1);
1771 if (face
->box_line_width
> 0)
1772 height
+= 2 * face
->box_line_width
;
1783 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1784 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1785 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP, do
1786 not force the value into range. */
1789 pixel_to_glyph_coords (struct frame
*f
, int pix_x
, int pix_y
, int *x
, int *y
,
1790 NativeRectangle
*bounds
, bool noclip
)
1793 #ifdef HAVE_WINDOW_SYSTEM
1794 if (FRAME_WINDOW_P (f
))
1796 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1797 even for negative values. */
1799 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1801 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1803 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1804 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1807 STORE_NATIVE_RECT (*bounds
,
1808 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1809 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1810 FRAME_COLUMN_WIDTH (f
) - 1,
1811 FRAME_LINE_HEIGHT (f
) - 1);
1813 /* PXW: Should we clip pixels before converting to columns/lines? */
1818 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1819 pix_x
= FRAME_TOTAL_COLS (f
);
1823 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1824 pix_y
= FRAME_TOTAL_LINES (f
);
1834 /* Find the glyph under window-relative coordinates X/Y in window W.
1835 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1836 strings. Return in *HPOS and *VPOS the row and column number of
1837 the glyph found. Return in *AREA the glyph area containing X.
1838 Value is a pointer to the glyph found or null if X/Y is not on
1839 text, or we can't tell because W's current matrix is not up to
1842 static struct glyph
*
1843 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1844 int *dx
, int *dy
, int *area
)
1846 struct glyph
*glyph
, *end
;
1847 struct glyph_row
*row
= NULL
;
1850 /* Find row containing Y. Give up if some row is not enabled. */
1851 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1853 row
= MATRIX_ROW (w
->current_matrix
, i
);
1854 if (!row
->enabled_p
)
1856 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1863 /* Give up if Y is not in the window. */
1864 if (i
== w
->current_matrix
->nrows
)
1867 /* Get the glyph area containing X. */
1868 if (w
->pseudo_window_p
)
1875 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1877 *area
= LEFT_MARGIN_AREA
;
1878 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1880 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1883 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1887 *area
= RIGHT_MARGIN_AREA
;
1888 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1892 /* Find glyph containing X. */
1893 glyph
= row
->glyphs
[*area
];
1894 end
= glyph
+ row
->used
[*area
];
1896 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1898 x
-= glyph
->pixel_width
;
1908 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1911 *hpos
= glyph
- row
->glyphs
[*area
];
1915 /* Convert frame-relative x/y to coordinates relative to window W.
1916 Takes pseudo-windows into account. */
1919 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1921 if (w
->pseudo_window_p
)
1923 /* A pseudo-window is always full-width, and starts at the
1924 left edge of the frame, plus a frame border. */
1925 struct frame
*f
= XFRAME (w
->frame
);
1926 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1927 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1931 *x
-= WINDOW_LEFT_EDGE_X (w
);
1932 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1936 #ifdef HAVE_WINDOW_SYSTEM
1939 Return in RECTS[] at most N clipping rectangles for glyph string S.
1940 Return the number of stored rectangles. */
1943 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1950 if (s
->row
->full_width_p
)
1952 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1953 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1954 if (s
->row
->mode_line_p
)
1955 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
1957 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
1959 /* Unless displaying a mode or menu bar line, which are always
1960 fully visible, clip to the visible part of the row. */
1961 if (s
->w
->pseudo_window_p
)
1962 r
.height
= s
->row
->visible_height
;
1964 r
.height
= s
->height
;
1968 /* This is a text line that may be partially visible. */
1969 r
.x
= window_box_left (s
->w
, s
->area
);
1970 r
.width
= window_box_width (s
->w
, s
->area
);
1971 r
.height
= s
->row
->visible_height
;
1975 if (r
.x
< s
->clip_head
->x
)
1977 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1978 r
.width
-= s
->clip_head
->x
- r
.x
;
1981 r
.x
= s
->clip_head
->x
;
1984 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1986 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1987 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1992 /* If S draws overlapping rows, it's sufficient to use the top and
1993 bottom of the window for clipping because this glyph string
1994 intentionally draws over other lines. */
1995 if (s
->for_overlaps
)
1997 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1998 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2000 /* Alas, the above simple strategy does not work for the
2001 environments with anti-aliased text: if the same text is
2002 drawn onto the same place multiple times, it gets thicker.
2003 If the overlap we are processing is for the erased cursor, we
2004 take the intersection with the rectangle of the cursor. */
2005 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2007 XRectangle rc
, r_save
= r
;
2009 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2010 rc
.y
= s
->w
->phys_cursor
.y
;
2011 rc
.width
= s
->w
->phys_cursor_width
;
2012 rc
.height
= s
->w
->phys_cursor_height
;
2014 x_intersect_rectangles (&r_save
, &rc
, &r
);
2019 /* Don't use S->y for clipping because it doesn't take partially
2020 visible lines into account. For example, it can be negative for
2021 partially visible lines at the top of a window. */
2022 if (!s
->row
->full_width_p
2023 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2024 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2026 r
.y
= max (0, s
->row
->y
);
2029 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2031 /* If drawing the cursor, don't let glyph draw outside its
2032 advertised boundaries. Cleartype does this under some circumstances. */
2033 if (s
->hl
== DRAW_CURSOR
)
2035 struct glyph
*glyph
= s
->first_glyph
;
2040 if (r
.width
>= s
->x
- r
.x
)
2041 r
.width
-= s
->x
- r
.x
;
2042 else /* R2L hscrolled row with cursor outside text area */
2046 r
.width
= min (r
.width
, glyph
->pixel_width
);
2048 /* If r.y is below window bottom, ensure that we still see a cursor. */
2049 height
= min (glyph
->ascent
+ glyph
->descent
,
2050 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2051 max_y
= window_text_bottom_y (s
->w
) - height
;
2052 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2053 if (s
->ybase
- glyph
->ascent
> max_y
)
2060 /* Don't draw cursor glyph taller than our actual glyph. */
2061 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2062 if (height
< r
.height
)
2064 max_y
= r
.y
+ r
.height
;
2065 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2066 r
.height
= min (max_y
- r
.y
, height
);
2073 XRectangle r_save
= r
;
2075 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2079 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2080 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2082 #ifdef CONVERT_FROM_XRECT
2083 CONVERT_FROM_XRECT (r
, *rects
);
2091 /* If we are processing overlapping and allowed to return
2092 multiple clipping rectangles, we exclude the row of the glyph
2093 string from the clipping rectangle. This is to avoid drawing
2094 the same text on the environment with anti-aliasing. */
2095 #ifdef CONVERT_FROM_XRECT
2098 XRectangle
*rs
= rects
;
2100 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2102 if (s
->for_overlaps
& OVERLAPS_PRED
)
2105 if (r
.y
+ r
.height
> row_y
)
2108 rs
[i
].height
= row_y
- r
.y
;
2114 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2117 if (r
.y
< row_y
+ s
->row
->visible_height
)
2119 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2121 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2122 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2131 #ifdef CONVERT_FROM_XRECT
2132 for (i
= 0; i
< n
; i
++)
2133 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2140 Return in *NR the clipping rectangle for glyph string S. */
2143 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2145 get_glyph_string_clip_rects (s
, nr
, 1);
2150 Return the position and height of the phys cursor in window W.
2151 Set w->phys_cursor_width to width of phys cursor.
2155 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2156 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2158 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2159 int x
, y
, wd
, h
, h0
, y0
, ascent
;
2161 /* Compute the width of the rectangle to draw. If on a stretch
2162 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2163 rectangle as wide as the glyph, but use a canonical character
2165 wd
= glyph
->pixel_width
;
2167 x
= w
->phys_cursor
.x
;
2174 if (glyph
->type
== STRETCH_GLYPH
2175 && !x_stretch_cursor_p
)
2176 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2177 w
->phys_cursor_width
= wd
;
2179 /* Don't let the hollow cursor glyph descend below the glyph row's
2180 ascent value, lest the hollow cursor looks funny. */
2181 y
= w
->phys_cursor
.y
;
2182 ascent
= row
->ascent
;
2183 if (row
->ascent
< glyph
->ascent
)
2185 y
=- glyph
->ascent
- row
->ascent
;
2186 ascent
= glyph
->ascent
;
2189 /* If y is below window bottom, ensure that we still see a cursor. */
2190 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2192 h
= max (h0
, ascent
+ glyph
->descent
);
2193 h0
= min (h0
, ascent
+ glyph
->descent
);
2195 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2198 h
= max (h
- (y0
- y
) + 1, h0
);
2203 y0
= window_text_bottom_y (w
) - h0
;
2211 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2212 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2217 * Remember which glyph the mouse is over.
2221 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2225 struct glyph_row
*r
, *gr
, *end_row
;
2226 enum window_part part
;
2227 enum glyph_row_area area
;
2228 int x
, y
, width
, height
;
2230 /* Try to determine frame pixel position and size of the glyph under
2231 frame pixel coordinates X/Y on frame F. */
2233 if (window_resize_pixelwise
)
2238 else if (!f
->glyphs_initialized_p
2239 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, false),
2242 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2243 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2247 w
= XWINDOW (window
);
2248 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2249 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2251 x
= window_relative_x_coord (w
, part
, gx
);
2252 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2254 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2255 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2257 if (w
->pseudo_window_p
)
2260 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2266 case ON_LEFT_MARGIN
:
2267 area
= LEFT_MARGIN_AREA
;
2270 case ON_RIGHT_MARGIN
:
2271 area
= RIGHT_MARGIN_AREA
;
2274 case ON_HEADER_LINE
:
2276 gr
= (part
== ON_HEADER_LINE
2277 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2278 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2281 goto text_glyph_row_found
;
2288 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2289 if (r
->y
+ r
->height
> y
)
2295 text_glyph_row_found
:
2298 struct glyph
*g
= gr
->glyphs
[area
];
2299 struct glyph
*end
= g
+ gr
->used
[area
];
2301 height
= gr
->height
;
2302 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2303 if (gx
+ g
->pixel_width
> x
)
2308 if (g
->type
== IMAGE_GLYPH
)
2310 /* Don't remember when mouse is over image, as
2311 image may have hot-spots. */
2312 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2315 width
= g
->pixel_width
;
2319 /* Use nominal char spacing at end of line. */
2321 gx
+= (x
/ width
) * width
;
2324 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2326 gx
+= window_box_left_offset (w
, area
);
2327 /* Don't expand over the modeline to make sure the vertical
2328 drag cursor is shown early enough. */
2329 height
= min (height
,
2330 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2335 /* Use nominal line height at end of window. */
2336 gx
= (x
/ width
) * width
;
2338 gy
+= (y
/ height
) * height
;
2339 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2340 /* See comment above. */
2341 height
= min (height
,
2342 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2346 case ON_LEFT_FRINGE
:
2347 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2348 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2349 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2350 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2353 case ON_RIGHT_FRINGE
:
2354 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2355 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2356 : window_box_right_offset (w
, TEXT_AREA
));
2357 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2358 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2359 && !WINDOW_RIGHTMOST_P (w
))
2360 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2361 /* Make sure the vertical border can get her own glyph to the
2362 right of the one we build here. */
2363 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2365 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2367 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2371 case ON_VERTICAL_BORDER
:
2372 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2375 case ON_VERTICAL_SCROLL_BAR
:
2376 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2378 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2379 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2380 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2382 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2386 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2387 if (r
->y
+ r
->height
> y
)
2394 height
= gr
->height
;
2397 /* Use nominal line height at end of window. */
2399 gy
+= (y
/ height
) * height
;
2403 case ON_RIGHT_DIVIDER
:
2404 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2405 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2407 /* The bottom divider prevails. */
2408 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2411 case ON_BOTTOM_DIVIDER
:
2413 width
= WINDOW_PIXEL_WIDTH (w
);
2414 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2415 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2421 /* If there is no glyph under the mouse, then we divide the screen
2422 into a grid of the smallest glyph in the frame, and use that
2425 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2426 round down even for negative values. */
2432 gx
= (gx
/ width
) * width
;
2433 gy
= (gy
/ height
) * height
;
2439 gx
+= WINDOW_LEFT_EDGE_X (w
);
2440 gy
+= WINDOW_TOP_EDGE_Y (w
);
2443 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2445 /* Visible feedback for debugging. */
2446 #if false && defined HAVE_X_WINDOWS
2447 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2448 f
->output_data
.x
->normal_gc
,
2449 gx
, gy
, width
, height
);
2454 #endif /* HAVE_WINDOW_SYSTEM */
2457 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2460 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2461 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2463 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2466 /***********************************************************************
2467 Lisp form evaluation
2468 ***********************************************************************/
2470 /* Error handler for safe_eval and safe_call. */
2473 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2475 add_to_log ("Error during redisplay: %S signaled %S",
2476 Flist (nargs
, args
), arg
);
2480 /* Call function FUNC with the rest of NARGS - 1 arguments
2481 following. Return the result, or nil if something went
2482 wrong. Prevent redisplay during the evaluation. */
2485 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2489 if (inhibit_eval_during_redisplay
)
2494 ptrdiff_t count
= SPECPDL_INDEX ();
2497 SAFE_ALLOCA_LISP (args
, nargs
);
2500 for (i
= 1; i
< nargs
; i
++)
2501 args
[i
] = va_arg (ap
, Lisp_Object
);
2503 specbind (Qinhibit_redisplay
, Qt
);
2505 specbind (Qinhibit_quit
, Qt
);
2506 /* Use Qt to ensure debugger does not run,
2507 so there is no possibility of wanting to redisplay. */
2508 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2511 val
= unbind_to (count
, val
);
2518 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2523 va_start (ap
, func
);
2524 retval
= safe__call (false, nargs
, func
, ap
);
2529 /* Call function FN with one argument ARG.
2530 Return the result, or nil if something went wrong. */
2533 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2535 return safe_call (2, fn
, arg
);
2539 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2545 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2551 safe_eval (Lisp_Object sexpr
)
2553 return safe__call1 (false, Qeval
, sexpr
);
2557 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2559 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2562 /* Call function FN with two arguments ARG1 and ARG2.
2563 Return the result, or nil if something went wrong. */
2566 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2568 return safe_call (3, fn
, arg1
, arg2
);
2573 /***********************************************************************
2575 ***********************************************************************/
2577 /* Define CHECK_IT to perform sanity checks on iterators.
2578 This is for debugging. It is too slow to do unconditionally. */
2581 CHECK_IT (struct it
*it
)
2584 if (it
->method
== GET_FROM_STRING
)
2586 eassert (STRINGP (it
->string
));
2587 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2591 eassert (IT_STRING_CHARPOS (*it
) < 0);
2592 if (it
->method
== GET_FROM_BUFFER
)
2594 /* Check that character and byte positions agree. */
2595 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2600 eassert (it
->current
.dpvec_index
>= 0);
2602 eassert (it
->current
.dpvec_index
< 0);
2607 /* Check that the window end of window W is what we expect it
2608 to be---the last row in the current matrix displaying text. */
2611 CHECK_WINDOW_END (struct window
*w
)
2613 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2614 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2616 struct glyph_row
*row
;
2617 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2619 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2620 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2625 /***********************************************************************
2626 Iterator initialization
2627 ***********************************************************************/
2629 /* Initialize IT for displaying current_buffer in window W, starting
2630 at character position CHARPOS. CHARPOS < 0 means that no buffer
2631 position is specified which is useful when the iterator is assigned
2632 a position later. BYTEPOS is the byte position corresponding to
2635 If ROW is not null, calls to produce_glyphs with IT as parameter
2636 will produce glyphs in that row.
2638 BASE_FACE_ID is the id of a base face to use. It must be one of
2639 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2640 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2641 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2643 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2644 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2645 will be initialized to use the corresponding mode line glyph row of
2646 the desired matrix of W. */
2649 init_iterator (struct it
*it
, struct window
*w
,
2650 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2651 struct glyph_row
*row
, enum face_id base_face_id
)
2653 enum face_id remapped_base_face_id
= base_face_id
;
2655 /* Some precondition checks. */
2656 eassert (w
!= NULL
&& it
!= NULL
);
2657 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2660 /* If face attributes have been changed since the last redisplay,
2661 free realized faces now because they depend on face definitions
2662 that might have changed. Don't free faces while there might be
2663 desired matrices pending which reference these faces. */
2664 if (face_change
&& !inhibit_free_realized_faces
)
2666 face_change
= false;
2667 free_all_realized_faces (Qnil
);
2670 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2671 if (! NILP (Vface_remapping_alist
))
2672 remapped_base_face_id
2673 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2675 /* Use one of the mode line rows of W's desired matrix if
2679 if (base_face_id
== MODE_LINE_FACE_ID
2680 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2681 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2682 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2683 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2686 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2687 Other parts of redisplay rely on that. */
2688 memclear (it
, sizeof *it
);
2689 it
->current
.overlay_string_index
= -1;
2690 it
->current
.dpvec_index
= -1;
2691 it
->base_face_id
= remapped_base_face_id
;
2692 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2693 it
->paragraph_embedding
= L2R
;
2696 /* The window in which we iterate over current_buffer: */
2697 XSETWINDOW (it
->window
, w
);
2699 it
->f
= XFRAME (w
->frame
);
2703 /* Extra space between lines (on window systems only). */
2704 if (base_face_id
== DEFAULT_FACE_ID
2705 && FRAME_WINDOW_P (it
->f
))
2707 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2708 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2709 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2710 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2711 * FRAME_LINE_HEIGHT (it
->f
));
2712 else if (it
->f
->extra_line_spacing
> 0)
2713 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2716 /* If realized faces have been removed, e.g. because of face
2717 attribute changes of named faces, recompute them. When running
2718 in batch mode, the face cache of the initial frame is null. If
2719 we happen to get called, make a dummy face cache. */
2720 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2721 init_frame_faces (it
->f
);
2722 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2723 recompute_basic_faces (it
->f
);
2725 it
->override_ascent
= -1;
2727 /* Are control characters displayed as `^C'? */
2728 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2730 /* -1 means everything between a CR and the following line end
2731 is invisible. >0 means lines indented more than this value are
2733 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2735 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2737 : (!NILP (BVAR (current_buffer
, selective_display
))
2739 it
->selective_display_ellipsis_p
2740 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2742 /* Display table to use. */
2743 it
->dp
= window_display_table (w
);
2745 /* Are multibyte characters enabled in current_buffer? */
2746 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2748 /* Get the position at which the redisplay_end_trigger hook should
2749 be run, if it is to be run at all. */
2750 if (MARKERP (w
->redisplay_end_trigger
)
2751 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2752 it
->redisplay_end_trigger_charpos
2753 = marker_position (w
->redisplay_end_trigger
);
2754 else if (INTEGERP (w
->redisplay_end_trigger
))
2755 it
->redisplay_end_trigger_charpos
2756 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2759 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2761 /* Are lines in the display truncated? */
2763 it
->line_wrap
= TRUNCATE
;
2764 if (base_face_id
== DEFAULT_FACE_ID
2766 && (WINDOW_FULL_WIDTH_P (it
->w
)
2767 || NILP (Vtruncate_partial_width_windows
)
2768 || (INTEGERP (Vtruncate_partial_width_windows
)
2769 /* PXW: Shall we do something about this? */
2770 && (XINT (Vtruncate_partial_width_windows
)
2771 <= WINDOW_TOTAL_COLS (it
->w
))))
2772 && NILP (BVAR (current_buffer
, truncate_lines
)))
2773 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2774 ? WINDOW_WRAP
: WORD_WRAP
;
2776 /* Get dimensions of truncation and continuation glyphs. These are
2777 displayed as fringe bitmaps under X, but we need them for such
2778 frames when the fringes are turned off. But leave the dimensions
2779 zero for tooltip frames, as these glyphs look ugly there and also
2780 sabotage calculations of tooltip dimensions in x-show-tip. */
2781 #ifdef HAVE_WINDOW_SYSTEM
2782 if (!(FRAME_WINDOW_P (it
->f
)
2783 && FRAMEP (tip_frame
)
2784 && it
->f
== XFRAME (tip_frame
)))
2787 if (it
->line_wrap
== TRUNCATE
)
2789 /* We will need the truncation glyph. */
2790 eassert (it
->glyph_row
== NULL
);
2791 produce_special_glyphs (it
, IT_TRUNCATION
);
2792 it
->truncation_pixel_width
= it
->pixel_width
;
2796 /* We will need the continuation glyph. */
2797 eassert (it
->glyph_row
== NULL
);
2798 produce_special_glyphs (it
, IT_CONTINUATION
);
2799 it
->continuation_pixel_width
= it
->pixel_width
;
2803 /* Reset these values to zero because the produce_special_glyphs
2804 above has changed them. */
2805 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2806 it
->phys_ascent
= it
->phys_descent
= 0;
2808 /* Set this after getting the dimensions of truncation and
2809 continuation glyphs, so that we don't produce glyphs when calling
2810 produce_special_glyphs, above. */
2811 it
->glyph_row
= row
;
2812 it
->area
= TEXT_AREA
;
2814 /* Get the dimensions of the display area. The display area
2815 consists of the visible window area plus a horizontally scrolled
2816 part to the left of the window. All x-values are relative to the
2817 start of this total display area. */
2818 if (base_face_id
!= DEFAULT_FACE_ID
)
2820 /* Mode lines, menu bar in terminal frames. */
2821 it
->first_visible_x
= 0;
2822 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2827 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2828 it
->last_visible_x
= (it
->first_visible_x
2829 + window_box_width (w
, TEXT_AREA
));
2831 /* If we truncate lines, leave room for the truncation glyph(s) at
2832 the right margin. Otherwise, leave room for the continuation
2833 glyph(s). Done only if the window has no right fringe. */
2834 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2836 if (it
->line_wrap
== TRUNCATE
)
2837 it
->last_visible_x
-= it
->truncation_pixel_width
;
2839 it
->last_visible_x
-= it
->continuation_pixel_width
;
2842 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2843 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2846 /* Leave room for a border glyph. */
2847 if (!FRAME_WINDOW_P (it
->f
)
2848 && !WINDOW_RIGHTMOST_P (it
->w
))
2849 it
->last_visible_x
-= 1;
2851 it
->last_visible_y
= window_text_bottom_y (w
);
2853 /* For mode lines and alike, arrange for the first glyph having a
2854 left box line if the face specifies a box. */
2855 if (base_face_id
!= DEFAULT_FACE_ID
)
2859 it
->face_id
= remapped_base_face_id
;
2861 /* If we have a boxed mode line, make the first character appear
2862 with a left box line. */
2863 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2864 if (face
&& face
->box
!= FACE_NO_BOX
)
2865 it
->start_of_box_run_p
= true;
2868 /* If a buffer position was specified, set the iterator there,
2869 getting overlays and face properties from that position. */
2870 if (charpos
>= BUF_BEG (current_buffer
))
2872 it
->stop_charpos
= charpos
;
2873 it
->end_charpos
= ZV
;
2874 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2875 IT_CHARPOS (*it
) = charpos
;
2876 IT_BYTEPOS (*it
) = bytepos
;
2878 /* We will rely on `reseat' to set this up properly, via
2879 handle_face_prop. */
2880 it
->face_id
= it
->base_face_id
;
2882 it
->start
= it
->current
;
2883 /* Do we need to reorder bidirectional text? Not if this is a
2884 unibyte buffer: by definition, none of the single-byte
2885 characters are strong R2L, so no reordering is needed. And
2886 bidi.c doesn't support unibyte buffers anyway. Also, don't
2887 reorder while we are loading loadup.el, since the tables of
2888 character properties needed for reordering are not yet
2892 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2895 /* If we are to reorder bidirectional text, init the bidi
2899 /* Since we don't know at this point whether there will be
2900 any R2L lines in the window, we reserve space for
2901 truncation/continuation glyphs even if only the left
2902 fringe is absent. */
2903 if (base_face_id
== DEFAULT_FACE_ID
2904 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2905 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2907 if (it
->line_wrap
== TRUNCATE
)
2908 it
->last_visible_x
-= it
->truncation_pixel_width
;
2910 it
->last_visible_x
-= it
->continuation_pixel_width
;
2912 /* Note the paragraph direction that this buffer wants to
2914 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2916 it
->paragraph_embedding
= L2R
;
2917 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2919 it
->paragraph_embedding
= R2L
;
2921 it
->paragraph_embedding
= NEUTRAL_DIR
;
2922 bidi_unshelve_cache (NULL
, false);
2923 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2927 /* Compute faces etc. */
2928 reseat (it
, it
->current
.pos
, true);
2935 /* Initialize IT for the display of window W with window start POS. */
2938 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2940 struct glyph_row
*row
;
2941 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
2943 row
= w
->desired_matrix
->rows
+ first_vpos
;
2944 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2945 it
->first_vpos
= first_vpos
;
2947 /* Don't reseat to previous visible line start if current start
2948 position is in a string or image. */
2949 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2951 int first_y
= it
->current_y
;
2953 /* If window start is not at a line start, skip forward to POS to
2954 get the correct continuation lines width. */
2955 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2956 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2957 if (!start_at_line_beg_p
)
2961 reseat_at_previous_visible_line_start (it
);
2962 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2964 new_x
= it
->current_x
+ it
->pixel_width
;
2966 /* If lines are continued, this line may end in the middle
2967 of a multi-glyph character (e.g. a control character
2968 displayed as \003, or in the middle of an overlay
2969 string). In this case move_it_to above will not have
2970 taken us to the start of the continuation line but to the
2971 end of the continued line. */
2972 if (it
->current_x
> 0
2973 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2974 && (/* And glyph doesn't fit on the line. */
2975 new_x
> it
->last_visible_x
2976 /* Or it fits exactly and we're on a window
2978 || (new_x
== it
->last_visible_x
2979 && FRAME_WINDOW_P (it
->f
)
2980 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2981 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2982 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2984 if ((it
->current
.dpvec_index
>= 0
2985 || it
->current
.overlay_string_index
>= 0)
2986 /* If we are on a newline from a display vector or
2987 overlay string, then we are already at the end of
2988 a screen line; no need to go to the next line in
2989 that case, as this line is not really continued.
2990 (If we do go to the next line, C-e will not DTRT.) */
2993 set_iterator_to_next (it
, true);
2994 move_it_in_display_line_to (it
, -1, -1, 0);
2997 it
->continuation_lines_width
+= it
->current_x
;
2999 /* If the character at POS is displayed via a display
3000 vector, move_it_to above stops at the final glyph of
3001 IT->dpvec. To make the caller redisplay that character
3002 again (a.k.a. start at POS), we need to reset the
3003 dpvec_index to the beginning of IT->dpvec. */
3004 else if (it
->current
.dpvec_index
>= 0)
3005 it
->current
.dpvec_index
= 0;
3007 /* We're starting a new display line, not affected by the
3008 height of the continued line, so clear the appropriate
3009 fields in the iterator structure. */
3010 it
->max_ascent
= it
->max_descent
= 0;
3011 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3013 it
->current_y
= first_y
;
3015 it
->current_x
= it
->hpos
= 0;
3021 /* Return true if POS is a position in ellipses displayed for invisible
3022 text. W is the window we display, for text property lookup. */
3025 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3027 Lisp_Object prop
, window
;
3028 bool ellipses_p
= false;
3029 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3031 /* If POS specifies a position in a display vector, this might
3032 be for an ellipsis displayed for invisible text. We won't
3033 get the iterator set up for delivering that ellipsis unless
3034 we make sure that it gets aware of the invisible text. */
3035 if (pos
->dpvec_index
>= 0
3036 && pos
->overlay_string_index
< 0
3037 && CHARPOS (pos
->string_pos
) < 0
3039 && (XSETWINDOW (window
, w
),
3040 prop
= Fget_char_property (make_number (charpos
),
3041 Qinvisible
, window
),
3042 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3044 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3046 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3053 /* Initialize IT for stepping through current_buffer in window W,
3054 starting at position POS that includes overlay string and display
3055 vector/ control character translation position information. Value
3056 is false if there are overlay strings with newlines at POS. */
3059 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3061 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3063 bool overlay_strings_with_newlines
= false;
3065 /* If POS specifies a position in a display vector, this might
3066 be for an ellipsis displayed for invisible text. We won't
3067 get the iterator set up for delivering that ellipsis unless
3068 we make sure that it gets aware of the invisible text. */
3069 if (in_ellipses_for_invisible_text_p (pos
, w
))
3075 /* Keep in mind: the call to reseat in init_iterator skips invisible
3076 text, so we might end up at a position different from POS. This
3077 is only a problem when POS is a row start after a newline and an
3078 overlay starts there with an after-string, and the overlay has an
3079 invisible property. Since we don't skip invisible text in
3080 display_line and elsewhere immediately after consuming the
3081 newline before the row start, such a POS will not be in a string,
3082 but the call to init_iterator below will move us to the
3084 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3086 /* This only scans the current chunk -- it should scan all chunks.
3087 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3088 to 16 in 22.1 to make this a lesser problem. */
3089 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3091 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3092 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3094 while (s
< e
&& *s
!= '\n')
3099 overlay_strings_with_newlines
= true;
3104 /* If position is within an overlay string, set up IT to the right
3106 if (pos
->overlay_string_index
>= 0)
3110 /* If the first overlay string happens to have a `display'
3111 property for an image, the iterator will be set up for that
3112 image, and we have to undo that setup first before we can
3113 correct the overlay string index. */
3114 if (it
->method
== GET_FROM_IMAGE
)
3117 /* We already have the first chunk of overlay strings in
3118 IT->overlay_strings. Load more until the one for
3119 pos->overlay_string_index is in IT->overlay_strings. */
3120 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3122 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3123 it
->current
.overlay_string_index
= 0;
3126 load_overlay_strings (it
, 0);
3127 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3131 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3132 relative_index
= (it
->current
.overlay_string_index
3133 % OVERLAY_STRING_CHUNK_SIZE
);
3134 it
->string
= it
->overlay_strings
[relative_index
];
3135 eassert (STRINGP (it
->string
));
3136 it
->current
.string_pos
= pos
->string_pos
;
3137 it
->method
= GET_FROM_STRING
;
3138 it
->end_charpos
= SCHARS (it
->string
);
3139 /* Set up the bidi iterator for this overlay string. */
3142 it
->bidi_it
.string
.lstring
= it
->string
;
3143 it
->bidi_it
.string
.s
= NULL
;
3144 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3145 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3146 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3147 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3148 it
->bidi_it
.w
= it
->w
;
3149 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3150 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3152 /* Synchronize the state of the bidi iterator with
3153 pos->string_pos. For any string position other than
3154 zero, this will be done automagically when we resume
3155 iteration over the string and get_visually_first_element
3156 is called. But if string_pos is zero, and the string is
3157 to be reordered for display, we need to resync manually,
3158 since it could be that the iteration state recorded in
3159 pos ended at string_pos of 0 moving backwards in string. */
3160 if (CHARPOS (pos
->string_pos
) == 0)
3162 get_visually_first_element (it
);
3163 if (IT_STRING_CHARPOS (*it
) != 0)
3166 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3167 bidi_move_to_visually_next (&it
->bidi_it
);
3168 } while (it
->bidi_it
.charpos
!= 0);
3170 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3171 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3175 if (CHARPOS (pos
->string_pos
) >= 0)
3177 /* Recorded position is not in an overlay string, but in another
3178 string. This can only be a string from a `display' property.
3179 IT should already be filled with that string. */
3180 it
->current
.string_pos
= pos
->string_pos
;
3181 eassert (STRINGP (it
->string
));
3183 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3184 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3187 /* Restore position in display vector translations, control
3188 character translations or ellipses. */
3189 if (pos
->dpvec_index
>= 0)
3191 if (it
->dpvec
== NULL
)
3192 get_next_display_element (it
);
3193 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3194 it
->current
.dpvec_index
= pos
->dpvec_index
;
3198 return !overlay_strings_with_newlines
;
3202 /* Initialize IT for stepping through current_buffer in window W
3203 starting at ROW->start. */
3206 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3208 init_from_display_pos (it
, w
, &row
->start
);
3209 it
->start
= row
->start
;
3210 it
->continuation_lines_width
= row
->continuation_lines_width
;
3215 /* Initialize IT for stepping through current_buffer in window W
3216 starting in the line following ROW, i.e. starting at ROW->end.
3217 Value is false if there are overlay strings with newlines at ROW's
3221 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3223 bool success
= false;
3225 if (init_from_display_pos (it
, w
, &row
->end
))
3227 if (row
->continued_p
)
3228 it
->continuation_lines_width
3229 = row
->continuation_lines_width
+ row
->pixel_width
;
3240 /***********************************************************************
3242 ***********************************************************************/
3244 /* Called when IT reaches IT->stop_charpos. Handle text property and
3245 overlay changes. Set IT->stop_charpos to the next position where
3249 handle_stop (struct it
*it
)
3251 enum prop_handled handled
;
3252 bool handle_overlay_change_p
;
3256 it
->current
.dpvec_index
= -1;
3257 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3258 it
->ellipsis_p
= false;
3260 /* Use face of preceding text for ellipsis (if invisible) */
3261 if (it
->selective_display_ellipsis_p
)
3262 it
->saved_face_id
= it
->face_id
;
3264 /* Here's the description of the semantics of, and the logic behind,
3265 the various HANDLED_* statuses:
3267 HANDLED_NORMALLY means the handler did its job, and the loop
3268 should proceed to calling the next handler in order.
3270 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3271 change in the properties and overlays at current position, so the
3272 loop should be restarted, to re-invoke the handlers that were
3273 already called. This happens when fontification-functions were
3274 called by handle_fontified_prop, and actually fontified
3275 something. Another case where HANDLED_RECOMPUTE_PROPS is
3276 returned is when we discover overlay strings that need to be
3277 displayed right away. The loop below will continue for as long
3278 as the status is HANDLED_RECOMPUTE_PROPS.
3280 HANDLED_RETURN means return immediately to the caller, to
3281 continue iteration without calling any further handlers. This is
3282 used when we need to act on some property right away, for example
3283 when we need to display the ellipsis or a replacing display
3284 property, such as display string or image.
3286 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3287 consumed, and the handler switched to the next overlay string.
3288 This signals the loop below to refrain from looking for more
3289 overlays before all the overlay strings of the current overlay
3292 Some of the handlers called by the loop push the iterator state
3293 onto the stack (see 'push_it'), and arrange for the iteration to
3294 continue with another object, such as an image, a display string,
3295 or an overlay string. In most such cases, it->stop_charpos is
3296 set to the first character of the string, so that when the
3297 iteration resumes, this function will immediately be called
3298 again, to examine the properties at the beginning of the string.
3300 When a display or overlay string is exhausted, the iterator state
3301 is popped (see 'pop_it'), and iteration continues with the
3302 previous object. Again, in many such cases this function is
3303 called again to find the next position where properties might
3308 handled
= HANDLED_NORMALLY
;
3310 /* Call text property handlers. */
3311 for (p
= it_props
; p
->handler
; ++p
)
3313 handled
= p
->handler (it
);
3315 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3317 else if (handled
== HANDLED_RETURN
)
3319 /* We still want to show before and after strings from
3320 overlays even if the actual buffer text is replaced. */
3321 if (!handle_overlay_change_p
3323 /* Don't call get_overlay_strings_1 if we already
3324 have overlay strings loaded, because doing so
3325 will load them again and push the iterator state
3326 onto the stack one more time, which is not
3327 expected by the rest of the code that processes
3329 || (it
->current
.overlay_string_index
< 0
3330 && !get_overlay_strings_1 (it
, 0, false)))
3333 setup_for_ellipsis (it
, 0);
3334 /* When handling a display spec, we might load an
3335 empty string. In that case, discard it here. We
3336 used to discard it in handle_single_display_spec,
3337 but that causes get_overlay_strings_1, above, to
3338 ignore overlay strings that we must check. */
3339 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3343 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3347 it
->string_from_display_prop_p
= false;
3348 it
->from_disp_prop_p
= false;
3349 handle_overlay_change_p
= false;
3351 handled
= HANDLED_RECOMPUTE_PROPS
;
3354 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3355 handle_overlay_change_p
= false;
3358 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3360 /* Don't check for overlay strings below when set to deliver
3361 characters from a display vector. */
3362 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3363 handle_overlay_change_p
= false;
3365 /* Handle overlay changes.
3366 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3367 if it finds overlays. */
3368 if (handle_overlay_change_p
)
3369 handled
= handle_overlay_change (it
);
3374 setup_for_ellipsis (it
, 0);
3378 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3380 /* Determine where to stop next. */
3381 if (handled
== HANDLED_NORMALLY
)
3382 compute_stop_pos (it
);
3386 /* Compute IT->stop_charpos from text property and overlay change
3387 information for IT's current position. */
3390 compute_stop_pos (struct it
*it
)
3392 register INTERVAL iv
, next_iv
;
3393 Lisp_Object object
, limit
, position
;
3394 ptrdiff_t charpos
, bytepos
;
3396 if (STRINGP (it
->string
))
3398 /* Strings are usually short, so don't limit the search for
3400 it
->stop_charpos
= it
->end_charpos
;
3401 object
= it
->string
;
3403 charpos
= IT_STRING_CHARPOS (*it
);
3404 bytepos
= IT_STRING_BYTEPOS (*it
);
3410 /* If end_charpos is out of range for some reason, such as a
3411 misbehaving display function, rationalize it (Bug#5984). */
3412 if (it
->end_charpos
> ZV
)
3413 it
->end_charpos
= ZV
;
3414 it
->stop_charpos
= it
->end_charpos
;
3416 /* If next overlay change is in front of the current stop pos
3417 (which is IT->end_charpos), stop there. Note: value of
3418 next_overlay_change is point-max if no overlay change
3420 charpos
= IT_CHARPOS (*it
);
3421 bytepos
= IT_BYTEPOS (*it
);
3422 pos
= next_overlay_change (charpos
);
3423 if (pos
< it
->stop_charpos
)
3424 it
->stop_charpos
= pos
;
3426 /* Set up variables for computing the stop position from text
3427 property changes. */
3428 XSETBUFFER (object
, current_buffer
);
3429 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3432 /* Get the interval containing IT's position. Value is a null
3433 interval if there isn't such an interval. */
3434 position
= make_number (charpos
);
3435 iv
= validate_interval_range (object
, &position
, &position
, false);
3438 Lisp_Object values_here
[LAST_PROP_IDX
];
3441 /* Get properties here. */
3442 for (p
= it_props
; p
->handler
; ++p
)
3443 values_here
[p
->idx
] = textget (iv
->plist
,
3444 builtin_lisp_symbol (p
->name
));
3446 /* Look for an interval following iv that has different
3448 for (next_iv
= next_interval (iv
);
3451 || XFASTINT (limit
) > next_iv
->position
));
3452 next_iv
= next_interval (next_iv
))
3454 for (p
= it_props
; p
->handler
; ++p
)
3456 Lisp_Object new_value
= textget (next_iv
->plist
,
3457 builtin_lisp_symbol (p
->name
));
3458 if (!EQ (values_here
[p
->idx
], new_value
))
3468 if (INTEGERP (limit
)
3469 && next_iv
->position
>= XFASTINT (limit
))
3470 /* No text property change up to limit. */
3471 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3473 /* Text properties change in next_iv. */
3474 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3478 if (it
->cmp_it
.id
< 0)
3480 ptrdiff_t stoppos
= it
->end_charpos
;
3482 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3484 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3485 stoppos
, it
->string
);
3488 eassert (STRINGP (it
->string
)
3489 || (it
->stop_charpos
>= BEGV
3490 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3494 /* Return the position of the next overlay change after POS in
3495 current_buffer. Value is point-max if no overlay change
3496 follows. This is like `next-overlay-change' but doesn't use
3500 next_overlay_change (ptrdiff_t pos
)
3502 ptrdiff_t i
, noverlays
;
3504 Lisp_Object
*overlays
;
3507 /* Get all overlays at the given position. */
3508 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3510 /* If any of these overlays ends before endpos,
3511 use its ending point instead. */
3512 for (i
= 0; i
< noverlays
; ++i
)
3517 oend
= OVERLAY_END (overlays
[i
]);
3518 oendpos
= OVERLAY_POSITION (oend
);
3519 endpos
= min (endpos
, oendpos
);
3526 /* How many characters forward to search for a display property or
3527 display string. Searching too far forward makes the bidi display
3528 sluggish, especially in small windows. */
3529 #define MAX_DISP_SCAN 250
3531 /* Return the character position of a display string at or after
3532 position specified by POSITION. If no display string exists at or
3533 after POSITION, return ZV. A display string is either an overlay
3534 with `display' property whose value is a string, or a `display'
3535 text property whose value is a string. STRING is data about the
3536 string to iterate; if STRING->lstring is nil, we are iterating a
3537 buffer. FRAME_WINDOW_P is true when we are displaying a window
3538 on a GUI frame. DISP_PROP is set to zero if we searched
3539 MAX_DISP_SCAN characters forward without finding any display
3540 strings, non-zero otherwise. It is set to 2 if the display string
3541 uses any kind of `(space ...)' spec that will produce a stretch of
3542 white space in the text area. */
3544 compute_display_string_pos (struct text_pos
*position
,
3545 struct bidi_string_data
*string
,
3547 bool frame_window_p
, int *disp_prop
)
3549 /* OBJECT = nil means current buffer. */
3550 Lisp_Object object
, object1
;
3551 Lisp_Object pos
, spec
, limpos
;
3552 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3553 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3554 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3555 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3557 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3558 struct text_pos tpos
;
3561 if (string
&& STRINGP (string
->lstring
))
3562 object1
= object
= string
->lstring
;
3563 else if (w
&& !string_p
)
3565 XSETWINDOW (object
, w
);
3569 object1
= object
= Qnil
;
3574 /* We don't support display properties whose values are strings
3575 that have display string properties. */
3576 || string
->from_disp_str
3577 /* C strings cannot have display properties. */
3578 || (string
->s
&& !STRINGP (object
)))
3584 /* If the character at CHARPOS is where the display string begins,
3586 pos
= make_number (charpos
);
3587 if (STRINGP (object
))
3588 bufpos
= string
->bufpos
;
3592 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3594 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3597 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3605 /* Look forward for the first character with a `display' property
3606 that will replace the underlying text when displayed. */
3607 limpos
= make_number (lim
);
3609 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3610 CHARPOS (tpos
) = XFASTINT (pos
);
3611 if (CHARPOS (tpos
) >= lim
)
3616 if (STRINGP (object
))
3617 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3619 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3620 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3621 if (!STRINGP (object
))
3622 bufpos
= CHARPOS (tpos
);
3623 } while (NILP (spec
)
3624 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3625 bufpos
, frame_window_p
)));
3629 return CHARPOS (tpos
);
3632 /* Return the character position of the end of the display string that
3633 started at CHARPOS. If there's no display string at CHARPOS,
3634 return -1. A display string is either an overlay with `display'
3635 property whose value is a string or a `display' text property whose
3636 value is a string. */
3638 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3640 /* OBJECT = nil means current buffer. */
3641 Lisp_Object object
=
3642 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3643 Lisp_Object pos
= make_number (charpos
);
3645 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3647 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3650 /* It could happen that the display property or overlay was removed
3651 since we found it in compute_display_string_pos above. One way
3652 this can happen is if JIT font-lock was called (through
3653 handle_fontified_prop), and jit-lock-functions remove text
3654 properties or overlays from the portion of buffer that includes
3655 CHARPOS. Muse mode is known to do that, for example. In this
3656 case, we return -1 to the caller, to signal that no display
3657 string is actually present at CHARPOS. See bidi_fetch_char for
3658 how this is handled.
3660 An alternative would be to never look for display properties past
3661 it->stop_charpos. But neither compute_display_string_pos nor
3662 bidi_fetch_char that calls it know or care where the next
3664 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3667 /* Look forward for the first character where the `display' property
3669 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3671 return XFASTINT (pos
);
3676 /***********************************************************************
3678 ***********************************************************************/
3680 /* Handle changes in the `fontified' property of the current buffer by
3681 calling hook functions from Qfontification_functions to fontify
3684 static enum prop_handled
3685 handle_fontified_prop (struct it
*it
)
3687 Lisp_Object prop
, pos
;
3688 enum prop_handled handled
= HANDLED_NORMALLY
;
3690 if (!NILP (Vmemory_full
))
3693 /* Get the value of the `fontified' property at IT's current buffer
3694 position. (The `fontified' property doesn't have a special
3695 meaning in strings.) If the value is nil, call functions from
3696 Qfontification_functions. */
3697 if (!STRINGP (it
->string
)
3699 && !NILP (Vfontification_functions
)
3700 && !NILP (Vrun_hooks
)
3701 && (pos
= make_number (IT_CHARPOS (*it
)),
3702 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3703 /* Ignore the special cased nil value always present at EOB since
3704 no amount of fontifying will be able to change it. */
3705 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3707 ptrdiff_t count
= SPECPDL_INDEX ();
3709 struct buffer
*obuf
= current_buffer
;
3710 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3711 bool old_clip_changed
= current_buffer
->clip_changed
;
3713 val
= Vfontification_functions
;
3714 specbind (Qfontification_functions
, Qnil
);
3716 eassert (it
->end_charpos
== ZV
);
3718 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3719 safe_call1 (val
, pos
);
3722 Lisp_Object fns
, fn
;
3726 for (; CONSP (val
); val
= XCDR (val
))
3732 /* A value of t indicates this hook has a local
3733 binding; it means to run the global binding too.
3734 In a global value, t should not occur. If it
3735 does, we must ignore it to avoid an endless
3737 for (fns
= Fdefault_value (Qfontification_functions
);
3743 safe_call1 (fn
, pos
);
3747 safe_call1 (fn
, pos
);
3751 unbind_to (count
, Qnil
);
3753 /* Fontification functions routinely call `save-restriction'.
3754 Normally, this tags clip_changed, which can confuse redisplay
3755 (see discussion in Bug#6671). Since we don't perform any
3756 special handling of fontification changes in the case where
3757 `save-restriction' isn't called, there's no point doing so in
3758 this case either. So, if the buffer's restrictions are
3759 actually left unchanged, reset clip_changed. */
3760 if (obuf
== current_buffer
)
3762 if (begv
== BEGV
&& zv
== ZV
)
3763 current_buffer
->clip_changed
= old_clip_changed
;
3765 /* There isn't much we can reasonably do to protect against
3766 misbehaving fontification, but here's a fig leaf. */
3767 else if (BUFFER_LIVE_P (obuf
))
3768 set_buffer_internal_1 (obuf
);
3770 /* The fontification code may have added/removed text.
3771 It could do even a lot worse, but let's at least protect against
3772 the most obvious case where only the text past `pos' gets changed',
3773 as is/was done in grep.el where some escapes sequences are turned
3774 into face properties (bug#7876). */
3775 it
->end_charpos
= ZV
;
3777 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3778 something. This avoids an endless loop if they failed to
3779 fontify the text for which reason ever. */
3780 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3781 handled
= HANDLED_RECOMPUTE_PROPS
;
3789 /***********************************************************************
3791 ***********************************************************************/
3793 /* Set up iterator IT from face properties at its current position.
3794 Called from handle_stop. */
3796 static enum prop_handled
3797 handle_face_prop (struct it
*it
)
3800 ptrdiff_t next_stop
;
3802 if (!STRINGP (it
->string
))
3805 = face_at_buffer_position (it
->w
,
3809 + TEXT_PROP_DISTANCE_LIMIT
),
3810 false, it
->base_face_id
);
3812 /* Is this a start of a run of characters with box face?
3813 Caveat: this can be called for a freshly initialized
3814 iterator; face_id is -1 in this case. We know that the new
3815 face will not change until limit, i.e. if the new face has a
3816 box, all characters up to limit will have one. But, as
3817 usual, we don't know whether limit is really the end. */
3818 if (new_face_id
!= it
->face_id
)
3820 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3821 /* If it->face_id is -1, old_face below will be NULL, see
3822 the definition of FACE_FROM_ID. This will happen if this
3823 is the initial call that gets the face. */
3824 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3826 /* If the value of face_id of the iterator is -1, we have to
3827 look in front of IT's position and see whether there is a
3828 face there that's different from new_face_id. */
3829 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3831 int prev_face_id
= face_before_it_pos (it
);
3833 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3836 /* If the new face has a box, but the old face does not,
3837 this is the start of a run of characters with box face,
3838 i.e. this character has a shadow on the left side. */
3839 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3840 && (old_face
== NULL
|| !old_face
->box
));
3841 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3849 Lisp_Object from_overlay
3850 = (it
->current
.overlay_string_index
>= 0
3851 ? it
->string_overlays
[it
->current
.overlay_string_index
3852 % OVERLAY_STRING_CHUNK_SIZE
]
3855 /* See if we got to this string directly or indirectly from
3856 an overlay property. That includes the before-string or
3857 after-string of an overlay, strings in display properties
3858 provided by an overlay, their text properties, etc.
3860 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3861 if (! NILP (from_overlay
))
3862 for (i
= it
->sp
- 1; i
>= 0; i
--)
3864 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3866 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3867 % OVERLAY_STRING_CHUNK_SIZE
];
3868 else if (! NILP (it
->stack
[i
].from_overlay
))
3869 from_overlay
= it
->stack
[i
].from_overlay
;
3871 if (!NILP (from_overlay
))
3875 if (! NILP (from_overlay
))
3877 bufpos
= IT_CHARPOS (*it
);
3878 /* For a string from an overlay, the base face depends
3879 only on text properties and ignores overlays. */
3881 = face_for_overlay_string (it
->w
,
3885 + TEXT_PROP_DISTANCE_LIMIT
),
3893 /* For strings from a `display' property, use the face at
3894 IT's current buffer position as the base face to merge
3895 with, so that overlay strings appear in the same face as
3896 surrounding text, unless they specify their own faces.
3897 For strings from wrap-prefix and line-prefix properties,
3898 use the default face, possibly remapped via
3899 Vface_remapping_alist. */
3900 /* Note that the fact that we use the face at _buffer_
3901 position means that a 'display' property on an overlay
3902 string will not inherit the face of that overlay string,
3903 but will instead revert to the face of buffer text
3904 covered by the overlay. This is visible, e.g., when the
3905 overlay specifies a box face, but neither the buffer nor
3906 the display string do. This sounds like a design bug,
3907 but Emacs always did that since v21.1, so changing that
3908 might be a big deal. */
3909 base_face_id
= it
->string_from_prefix_prop_p
3910 ? (!NILP (Vface_remapping_alist
)
3911 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3913 : underlying_face_id (it
);
3916 new_face_id
= face_at_string_position (it
->w
,
3918 IT_STRING_CHARPOS (*it
),
3921 base_face_id
, false);
3923 /* Is this a start of a run of characters with box? Caveat:
3924 this can be called for a freshly allocated iterator; face_id
3925 is -1 is this case. We know that the new face will not
3926 change until the next check pos, i.e. if the new face has a
3927 box, all characters up to that position will have a
3928 box. But, as usual, we don't know whether that position
3929 is really the end. */
3930 if (new_face_id
!= it
->face_id
)
3932 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3933 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3935 /* If new face has a box but old face hasn't, this is the
3936 start of a run of characters with box, i.e. it has a
3937 shadow on the left side. */
3938 it
->start_of_box_run_p
3939 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3940 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3944 it
->face_id
= new_face_id
;
3945 return HANDLED_NORMALLY
;
3949 /* Return the ID of the face ``underlying'' IT's current position,
3950 which is in a string. If the iterator is associated with a
3951 buffer, return the face at IT's current buffer position.
3952 Otherwise, use the iterator's base_face_id. */
3955 underlying_face_id (struct it
*it
)
3957 int face_id
= it
->base_face_id
, i
;
3959 eassert (STRINGP (it
->string
));
3961 for (i
= it
->sp
- 1; i
>= 0; --i
)
3962 if (NILP (it
->stack
[i
].string
))
3963 face_id
= it
->stack
[i
].face_id
;
3969 /* Compute the face one character before or after the current position
3970 of IT, in the visual order. BEFORE_P means get the face
3971 in front (to the left in L2R paragraphs, to the right in R2L
3972 paragraphs) of IT's screen position. Value is the ID of the face. */
3975 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
3978 ptrdiff_t next_check_charpos
;
3980 void *it_copy_data
= NULL
;
3982 eassert (it
->s
== NULL
);
3984 if (STRINGP (it
->string
))
3986 ptrdiff_t bufpos
, charpos
;
3989 /* No face change past the end of the string (for the case
3990 we are padding with spaces). No face change before the
3992 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3993 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3998 /* Set charpos to the position before or after IT's current
3999 position, in the logical order, which in the non-bidi
4000 case is the same as the visual order. */
4002 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4003 else if (it
->what
== IT_COMPOSITION
)
4004 /* For composition, we must check the character after the
4006 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4008 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4014 /* With bidi iteration, the character before the current
4015 in the visual order cannot be found by simple
4016 iteration, because "reverse" reordering is not
4017 supported. Instead, we need to start from the string
4018 beginning and go all the way to the current string
4019 position, remembering the previous position. */
4020 /* Ignore face changes before the first visible
4021 character on this display line. */
4022 if (it
->current_x
<= it
->first_visible_x
)
4024 SAVE_IT (it_copy
, *it
, it_copy_data
);
4025 IT_STRING_CHARPOS (it_copy
) = 0;
4026 bidi_init_it (0, 0, FRAME_WINDOW_P (it_copy
.f
), &it_copy
.bidi_it
);
4030 charpos
= IT_STRING_CHARPOS (it_copy
);
4031 if (charpos
>= SCHARS (it
->string
))
4033 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4035 while (IT_STRING_CHARPOS (it_copy
) != IT_STRING_CHARPOS (*it
));
4037 RESTORE_IT (it
, it
, it_copy_data
);
4041 /* Set charpos to the string position of the character
4042 that comes after IT's current position in the visual
4044 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4048 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4050 charpos
= it_copy
.bidi_it
.charpos
;
4053 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4055 if (it
->current
.overlay_string_index
>= 0)
4056 bufpos
= IT_CHARPOS (*it
);
4060 base_face_id
= underlying_face_id (it
);
4062 /* Get the face for ASCII, or unibyte. */
4063 face_id
= face_at_string_position (it
->w
,
4067 &next_check_charpos
,
4068 base_face_id
, false);
4070 /* Correct the face for charsets different from ASCII. Do it
4071 for the multibyte case only. The face returned above is
4072 suitable for unibyte text if IT->string is unibyte. */
4073 if (STRING_MULTIBYTE (it
->string
))
4075 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4076 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4078 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4080 c
= string_char_and_length (p
, &len
);
4081 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4086 struct text_pos pos
;
4088 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4089 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4092 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4093 pos
= it
->current
.pos
;
4098 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4101 if (it
->what
== IT_COMPOSITION
)
4103 /* For composition, we must check the position after
4105 pos
.charpos
+= it
->cmp_it
.nchars
;
4106 pos
.bytepos
+= it
->len
;
4109 INC_TEXT_POS (pos
, it
->multibyte_p
);
4118 /* With bidi iteration, the character before the current
4119 in the visual order cannot be found by simple
4120 iteration, because "reverse" reordering is not
4121 supported. Instead, we need to use the move_it_*
4122 family of functions, and move to the previous
4123 character starting from the beginning of the visual
4125 /* Ignore face changes before the first visible
4126 character on this display line. */
4127 if (it
->current_x
<= it
->first_visible_x
)
4129 SAVE_IT (it_copy
, *it
, it_copy_data
);
4130 /* Implementation note: Since move_it_in_display_line
4131 works in the iterator geometry, and thinks the first
4132 character is always the leftmost, even in R2L lines,
4133 we don't need to distinguish between the R2L and L2R
4135 current_x
= it_copy
.current_x
;
4136 move_it_vertically_backward (&it_copy
, 0);
4137 move_it_in_display_line (&it_copy
, ZV
, current_x
- 1, MOVE_TO_X
);
4138 pos
= it_copy
.current
.pos
;
4139 RESTORE_IT (it
, it
, it_copy_data
);
4143 /* Set charpos to the buffer position of the character
4144 that comes after IT's current position in the visual
4146 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4150 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4153 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4156 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4158 /* Determine face for CHARSET_ASCII, or unibyte. */
4159 face_id
= face_at_buffer_position (it
->w
,
4161 &next_check_charpos
,
4164 /* Correct the face for charsets different from ASCII. Do it
4165 for the multibyte case only. The face returned above is
4166 suitable for unibyte text if current_buffer is unibyte. */
4167 if (it
->multibyte_p
)
4169 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4170 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4171 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4180 /***********************************************************************
4182 ***********************************************************************/
4184 /* Set up iterator IT from invisible properties at its current
4185 position. Called from handle_stop. */
4187 static enum prop_handled
4188 handle_invisible_prop (struct it
*it
)
4190 enum prop_handled handled
= HANDLED_NORMALLY
;
4194 if (STRINGP (it
->string
))
4196 Lisp_Object end_charpos
, limit
;
4198 /* Get the value of the invisible text property at the
4199 current position. Value will be nil if there is no such
4201 end_charpos
= make_number (IT_STRING_CHARPOS (*it
));
4202 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4203 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4205 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4207 /* Record whether we have to display an ellipsis for the
4209 bool display_ellipsis_p
= (invis
== 2);
4210 ptrdiff_t len
, endpos
;
4212 handled
= HANDLED_RECOMPUTE_PROPS
;
4214 /* Get the position at which the next visible text can be
4215 found in IT->string, if any. */
4216 endpos
= len
= SCHARS (it
->string
);
4217 XSETINT (limit
, len
);
4221 = Fnext_single_property_change (end_charpos
, Qinvisible
,
4223 /* Since LIMIT is always an integer, so should be the
4224 value returned by Fnext_single_property_change. */
4225 eassert (INTEGERP (end_charpos
));
4226 if (INTEGERP (end_charpos
))
4228 endpos
= XFASTINT (end_charpos
);
4229 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4230 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4232 display_ellipsis_p
= true;
4234 else /* Should never happen; but if it does, exit the loop. */
4237 while (invis
!= 0 && endpos
< len
);
4239 if (display_ellipsis_p
)
4240 it
->ellipsis_p
= true;
4244 /* Text at END_CHARPOS is visible. Move IT there. */
4245 struct text_pos old
;
4248 old
= it
->current
.string_pos
;
4249 oldpos
= CHARPOS (old
);
4252 if (it
->bidi_it
.first_elt
4253 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4254 bidi_paragraph_init (it
->paragraph_embedding
,
4255 &it
->bidi_it
, true);
4256 /* Bidi-iterate out of the invisible text. */
4259 bidi_move_to_visually_next (&it
->bidi_it
);
4261 while (oldpos
<= it
->bidi_it
.charpos
4262 && it
->bidi_it
.charpos
< endpos
);
4264 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4265 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4266 if (IT_CHARPOS (*it
) >= endpos
)
4267 it
->prev_stop
= endpos
;
4271 IT_STRING_CHARPOS (*it
) = endpos
;
4272 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4277 /* The rest of the string is invisible. If this is an
4278 overlay string, proceed with the next overlay string
4279 or whatever comes and return a character from there. */
4280 if (it
->current
.overlay_string_index
>= 0
4281 && !display_ellipsis_p
)
4283 next_overlay_string (it
);
4284 /* Don't check for overlay strings when we just
4285 finished processing them. */
4286 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4290 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4291 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4298 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4299 Lisp_Object pos
, overlay
;
4301 /* First of all, is there invisible text at this position? */
4302 tem
= start_charpos
= IT_CHARPOS (*it
);
4303 pos
= make_number (tem
);
4304 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4306 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4308 /* If we are on invisible text, skip over it. */
4309 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4311 /* Record whether we have to display an ellipsis for the
4313 bool display_ellipsis_p
= invis
== 2;
4315 handled
= HANDLED_RECOMPUTE_PROPS
;
4317 /* Loop skipping over invisible text. The loop is left at
4318 ZV or with IT on the first char being visible again. */
4321 /* Try to skip some invisible text. Return value is the
4322 position reached which can be equal to where we start
4323 if there is nothing invisible there. This skips both
4324 over invisible text properties and overlays with
4325 invisible property. */
4326 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4328 /* If we skipped nothing at all we weren't at invisible
4329 text in the first place. If everything to the end of
4330 the buffer was skipped, end the loop. */
4331 if (newpos
== tem
|| newpos
>= ZV
)
4335 /* We skipped some characters but not necessarily
4336 all there are. Check if we ended up on visible
4337 text. Fget_char_property returns the property of
4338 the char before the given position, i.e. if we
4339 get invis = 0, this means that the char at
4340 newpos is visible. */
4341 pos
= make_number (newpos
);
4342 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4343 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4346 /* If we ended up on invisible text, proceed to
4347 skip starting with next_stop. */
4351 /* If there are adjacent invisible texts, don't lose the
4352 second one's ellipsis. */
4354 display_ellipsis_p
= true;
4358 /* The position newpos is now either ZV or on visible text. */
4361 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4363 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4365 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4367 /* If the invisible text ends on a newline or on a
4368 character after a newline, we can avoid the costly,
4369 character by character, bidi iteration to NEWPOS, and
4370 instead simply reseat the iterator there. That's
4371 because all bidi reordering information is tossed at
4372 the newline. This is a big win for modes that hide
4373 complete lines, like Outline, Org, etc. */
4374 if (on_newline
|| after_newline
)
4376 struct text_pos tpos
;
4377 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4379 SET_TEXT_POS (tpos
, newpos
, bpos
);
4380 reseat_1 (it
, tpos
, false);
4381 /* If we reseat on a newline/ZV, we need to prep the
4382 bidi iterator for advancing to the next character
4383 after the newline/EOB, keeping the current paragraph
4384 direction (so that PRODUCE_GLYPHS does TRT wrt
4385 prepending/appending glyphs to a glyph row). */
4388 it
->bidi_it
.first_elt
= false;
4389 it
->bidi_it
.paragraph_dir
= pdir
;
4390 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4391 it
->bidi_it
.nchars
= 1;
4392 it
->bidi_it
.ch_len
= 1;
4395 else /* Must use the slow method. */
4397 /* With bidi iteration, the region of invisible text
4398 could start and/or end in the middle of a
4399 non-base embedding level. Therefore, we need to
4400 skip invisible text using the bidi iterator,
4401 starting at IT's current position, until we find
4402 ourselves outside of the invisible text.
4403 Skipping invisible text _after_ bidi iteration
4404 avoids affecting the visual order of the
4405 displayed text when invisible properties are
4406 added or removed. */
4407 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4409 /* If we were `reseat'ed to a new paragraph,
4410 determine the paragraph base direction. We
4411 need to do it now because
4412 next_element_from_buffer may not have a
4413 chance to do it, if we are going to skip any
4414 text at the beginning, which resets the
4416 bidi_paragraph_init (it
->paragraph_embedding
,
4417 &it
->bidi_it
, true);
4421 bidi_move_to_visually_next (&it
->bidi_it
);
4423 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4424 && it
->bidi_it
.charpos
< newpos
);
4425 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4426 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4427 /* If we overstepped NEWPOS, record its position in
4428 the iterator, so that we skip invisible text if
4429 later the bidi iteration lands us in the
4430 invisible region again. */
4431 if (IT_CHARPOS (*it
) >= newpos
)
4432 it
->prev_stop
= newpos
;
4437 IT_CHARPOS (*it
) = newpos
;
4438 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4441 if (display_ellipsis_p
)
4443 /* Make sure that the glyphs of the ellipsis will get
4444 correct `charpos' values. If we would not update
4445 it->position here, the glyphs would belong to the
4446 last visible character _before_ the invisible
4447 text, which confuses `set_cursor_from_row'.
4449 We use the last invisible position instead of the
4450 first because this way the cursor is always drawn on
4451 the first "." of the ellipsis, whenever PT is inside
4452 the invisible text. Otherwise the cursor would be
4453 placed _after_ the ellipsis when the point is after the
4454 first invisible character. */
4455 if (!STRINGP (it
->object
))
4457 it
->position
.charpos
= newpos
- 1;
4458 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4462 /* If there are before-strings at the start of invisible
4463 text, and the text is invisible because of a text
4464 property, arrange to show before-strings because 20.x did
4465 it that way. (If the text is invisible because of an
4466 overlay property instead of a text property, this is
4467 already handled in the overlay code.) */
4469 && get_overlay_strings (it
, it
->stop_charpos
))
4471 handled
= HANDLED_RECOMPUTE_PROPS
;
4474 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4475 /* The call to get_overlay_strings above recomputes
4476 it->stop_charpos, but it only considers changes
4477 in properties and overlays beyond iterator's
4478 current position. This causes us to miss changes
4479 that happen exactly where the invisible property
4480 ended. So we play it safe here and force the
4481 iterator to check for potential stop positions
4482 immediately after the invisible text. Note that
4483 if get_overlay_strings returns true, it
4484 normally also pushed the iterator stack, so we
4485 need to update the stop position in the slot
4486 below the current one. */
4487 it
->stack
[it
->sp
- 1].stop_charpos
4488 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4491 else if (display_ellipsis_p
)
4493 it
->ellipsis_p
= true;
4494 /* Let the ellipsis display before
4495 considering any properties of the following char.
4496 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4497 handled
= HANDLED_RETURN
;
4506 /* Make iterator IT return `...' next.
4507 Replaces LEN characters from buffer. */
4510 setup_for_ellipsis (struct it
*it
, int len
)
4512 /* Use the display table definition for `...'. Invalid glyphs
4513 will be handled by the method returning elements from dpvec. */
4514 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4516 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4517 it
->dpvec
= v
->contents
;
4518 it
->dpend
= v
->contents
+ v
->header
.size
;
4522 /* Default `...'. */
4523 it
->dpvec
= default_invis_vector
;
4524 it
->dpend
= default_invis_vector
+ 3;
4527 it
->dpvec_char_len
= len
;
4528 it
->current
.dpvec_index
= 0;
4529 it
->dpvec_face_id
= -1;
4531 /* Remember the current face id in case glyphs specify faces.
4532 IT's face is restored in set_iterator_to_next.
4533 saved_face_id was set to preceding char's face in handle_stop. */
4534 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4535 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4537 /* If the ellipsis represents buffer text, it means we advanced in
4538 the buffer, so we should no longer ignore overlay strings. */
4539 if (it
->method
== GET_FROM_BUFFER
)
4540 it
->ignore_overlay_strings_at_pos_p
= false;
4542 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4543 it
->ellipsis_p
= true;
4548 /***********************************************************************
4550 ***********************************************************************/
4552 /* Set up iterator IT from `display' property at its current position.
4553 Called from handle_stop.
4554 We return HANDLED_RETURN if some part of the display property
4555 overrides the display of the buffer text itself.
4556 Otherwise we return HANDLED_NORMALLY. */
4558 static enum prop_handled
4559 handle_display_prop (struct it
*it
)
4561 Lisp_Object propval
, object
, overlay
;
4562 struct text_pos
*position
;
4564 /* Nonzero if some property replaces the display of the text itself. */
4565 int display_replaced
= 0;
4567 if (STRINGP (it
->string
))
4569 object
= it
->string
;
4570 position
= &it
->current
.string_pos
;
4571 bufpos
= CHARPOS (it
->current
.pos
);
4575 XSETWINDOW (object
, it
->w
);
4576 position
= &it
->current
.pos
;
4577 bufpos
= CHARPOS (*position
);
4580 /* Reset those iterator values set from display property values. */
4581 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4582 it
->space_width
= Qnil
;
4583 it
->font_height
= Qnil
;
4586 /* We don't support recursive `display' properties, i.e. string
4587 values that have a string `display' property, that have a string
4588 `display' property etc. */
4589 if (!it
->string_from_display_prop_p
)
4590 it
->area
= TEXT_AREA
;
4592 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4593 Qdisplay
, object
, &overlay
);
4595 return HANDLED_NORMALLY
;
4596 /* Now OVERLAY is the overlay that gave us this property, or nil
4597 if it was a text property. */
4599 if (!STRINGP (it
->string
))
4600 object
= it
->w
->contents
;
4602 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4604 FRAME_WINDOW_P (it
->f
));
4605 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4608 /* Subroutine of handle_display_prop. Returns non-zero if the display
4609 specification in SPEC is a replacing specification, i.e. it would
4610 replace the text covered by `display' property with something else,
4611 such as an image or a display string. If SPEC includes any kind or
4612 `(space ...) specification, the value is 2; this is used by
4613 compute_display_string_pos, which see.
4615 See handle_single_display_spec for documentation of arguments.
4616 FRAME_WINDOW_P is true if the window being redisplayed is on a
4617 GUI frame; this argument is used only if IT is NULL, see below.
4619 IT can be NULL, if this is called by the bidi reordering code
4620 through compute_display_string_pos, which see. In that case, this
4621 function only examines SPEC, but does not otherwise "handle" it, in
4622 the sense that it doesn't set up members of IT from the display
4625 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4626 Lisp_Object overlay
, struct text_pos
*position
,
4627 ptrdiff_t bufpos
, bool frame_window_p
)
4632 /* Simple specifications. */
4633 && !EQ (XCAR (spec
), Qimage
)
4634 && !EQ (XCAR (spec
), Qspace
)
4635 && !EQ (XCAR (spec
), Qwhen
)
4636 && !EQ (XCAR (spec
), Qslice
)
4637 && !EQ (XCAR (spec
), Qspace_width
)
4638 && !EQ (XCAR (spec
), Qheight
)
4639 && !EQ (XCAR (spec
), Qraise
)
4640 /* Marginal area specifications. */
4641 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4642 && !EQ (XCAR (spec
), Qleft_fringe
)
4643 && !EQ (XCAR (spec
), Qright_fringe
)
4644 && !NILP (XCAR (spec
)))
4646 for (; CONSP (spec
); spec
= XCDR (spec
))
4648 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4649 overlay
, position
, bufpos
,
4650 replacing
, frame_window_p
);
4654 /* If some text in a string is replaced, `position' no
4655 longer points to the position of `object'. */
4656 if (!it
|| STRINGP (object
))
4661 else if (VECTORP (spec
))
4664 for (i
= 0; i
< ASIZE (spec
); ++i
)
4666 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4667 overlay
, position
, bufpos
,
4668 replacing
, frame_window_p
);
4672 /* If some text in a string is replaced, `position' no
4673 longer points to the position of `object'. */
4674 if (!it
|| STRINGP (object
))
4680 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4681 bufpos
, 0, frame_window_p
);
4685 /* Value is the position of the end of the `display' property starting
4686 at START_POS in OBJECT. */
4688 static struct text_pos
4689 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4692 struct text_pos end_pos
;
4694 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4695 Qdisplay
, object
, Qnil
);
4696 CHARPOS (end_pos
) = XFASTINT (end
);
4697 if (STRINGP (object
))
4698 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4700 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4706 /* Set up IT from a single `display' property specification SPEC. OBJECT
4707 is the object in which the `display' property was found. *POSITION
4708 is the position in OBJECT at which the `display' property was found.
4709 BUFPOS is the buffer position of OBJECT (different from POSITION if
4710 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4711 previously saw a display specification which already replaced text
4712 display with something else, for example an image; we ignore such
4713 properties after the first one has been processed.
4715 OVERLAY is the overlay this `display' property came from,
4716 or nil if it was a text property.
4718 If SPEC is a `space' or `image' specification, and in some other
4719 cases too, set *POSITION to the position where the `display'
4722 If IT is NULL, only examine the property specification in SPEC, but
4723 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4724 is intended to be displayed in a window on a GUI frame.
4726 Value is non-zero if something was found which replaces the display
4727 of buffer or string text. */
4730 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4731 Lisp_Object overlay
, struct text_pos
*position
,
4732 ptrdiff_t bufpos
, int display_replaced
,
4733 bool frame_window_p
)
4736 Lisp_Object location
, value
;
4737 struct text_pos start_pos
= *position
;
4739 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4740 If the result is non-nil, use VALUE instead of SPEC. */
4742 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4751 if (!NILP (form
) && !EQ (form
, Qt
))
4753 ptrdiff_t count
= SPECPDL_INDEX ();
4755 /* Bind `object' to the object having the `display' property, a
4756 buffer or string. Bind `position' to the position in the
4757 object where the property was found, and `buffer-position'
4758 to the current position in the buffer. */
4761 XSETBUFFER (object
, current_buffer
);
4762 specbind (Qobject
, object
);
4763 specbind (Qposition
, make_number (CHARPOS (*position
)));
4764 specbind (Qbuffer_position
, make_number (bufpos
));
4765 form
= safe_eval (form
);
4766 unbind_to (count
, Qnil
);
4772 /* Handle `(height HEIGHT)' specifications. */
4774 && EQ (XCAR (spec
), Qheight
)
4775 && CONSP (XCDR (spec
)))
4779 if (!FRAME_WINDOW_P (it
->f
))
4782 it
->font_height
= XCAR (XCDR (spec
));
4783 if (!NILP (it
->font_height
))
4785 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4786 int new_height
= -1;
4788 if (CONSP (it
->font_height
)
4789 && (EQ (XCAR (it
->font_height
), Qplus
)
4790 || EQ (XCAR (it
->font_height
), Qminus
))
4791 && CONSP (XCDR (it
->font_height
))
4792 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4794 /* `(+ N)' or `(- N)' where N is an integer. */
4795 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4796 if (EQ (XCAR (it
->font_height
), Qplus
))
4798 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4800 else if (FUNCTIONP (it
->font_height
))
4802 /* Call function with current height as argument.
4803 Value is the new height. */
4805 height
= safe_call1 (it
->font_height
,
4806 face
->lface
[LFACE_HEIGHT_INDEX
]);
4807 if (NUMBERP (height
))
4808 new_height
= XFLOATINT (height
);
4810 else if (NUMBERP (it
->font_height
))
4812 /* Value is a multiple of the canonical char height. */
4815 f
= FACE_FROM_ID (it
->f
,
4816 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4817 new_height
= (XFLOATINT (it
->font_height
)
4818 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4822 /* Evaluate IT->font_height with `height' bound to the
4823 current specified height to get the new height. */
4824 ptrdiff_t count
= SPECPDL_INDEX ();
4826 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4827 value
= safe_eval (it
->font_height
);
4828 unbind_to (count
, Qnil
);
4830 if (NUMBERP (value
))
4831 new_height
= XFLOATINT (value
);
4835 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4842 /* Handle `(space-width WIDTH)'. */
4844 && EQ (XCAR (spec
), Qspace_width
)
4845 && CONSP (XCDR (spec
)))
4849 if (!FRAME_WINDOW_P (it
->f
))
4852 value
= XCAR (XCDR (spec
));
4853 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4854 it
->space_width
= value
;
4860 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4862 && EQ (XCAR (spec
), Qslice
))
4868 if (!FRAME_WINDOW_P (it
->f
))
4871 if (tem
= XCDR (spec
), CONSP (tem
))
4873 it
->slice
.x
= XCAR (tem
);
4874 if (tem
= XCDR (tem
), CONSP (tem
))
4876 it
->slice
.y
= XCAR (tem
);
4877 if (tem
= XCDR (tem
), CONSP (tem
))
4879 it
->slice
.width
= XCAR (tem
);
4880 if (tem
= XCDR (tem
), CONSP (tem
))
4881 it
->slice
.height
= XCAR (tem
);
4890 /* Handle `(raise FACTOR)'. */
4892 && EQ (XCAR (spec
), Qraise
)
4893 && CONSP (XCDR (spec
)))
4897 if (!FRAME_WINDOW_P (it
->f
))
4900 #ifdef HAVE_WINDOW_SYSTEM
4901 value
= XCAR (XCDR (spec
));
4902 if (NUMBERP (value
))
4904 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4905 it
->voffset
= - (XFLOATINT (value
)
4906 * (normal_char_height (face
->font
, -1)));
4908 #endif /* HAVE_WINDOW_SYSTEM */
4914 /* Don't handle the other kinds of display specifications
4915 inside a string that we got from a `display' property. */
4916 if (it
&& it
->string_from_display_prop_p
)
4919 /* Characters having this form of property are not displayed, so
4920 we have to find the end of the property. */
4923 start_pos
= *position
;
4924 *position
= display_prop_end (it
, object
, start_pos
);
4925 /* If the display property comes from an overlay, don't consider
4926 any potential stop_charpos values before the end of that
4927 overlay. Since display_prop_end will happily find another
4928 'display' property coming from some other overlay or text
4929 property on buffer positions before this overlay's end, we
4930 need to ignore them, or else we risk displaying this
4931 overlay's display string/image twice. */
4932 if (!NILP (overlay
))
4934 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4936 if (ovendpos
> CHARPOS (*position
))
4937 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
4942 /* Stop the scan at that end position--we assume that all
4943 text properties change there. */
4945 it
->stop_charpos
= position
->charpos
;
4947 /* Handle `(left-fringe BITMAP [FACE])'
4948 and `(right-fringe BITMAP [FACE])'. */
4950 && (EQ (XCAR (spec
), Qleft_fringe
)
4951 || EQ (XCAR (spec
), Qright_fringe
))
4952 && CONSP (XCDR (spec
)))
4958 if (!FRAME_WINDOW_P (it
->f
))
4959 /* If we return here, POSITION has been advanced
4960 across the text with this property. */
4962 /* Synchronize the bidi iterator with POSITION. This is
4963 needed because we are not going to push the iterator
4964 on behalf of this display property, so there will be
4965 no pop_it call to do this synchronization for us. */
4968 it
->position
= *position
;
4969 iterate_out_of_display_property (it
);
4970 *position
= it
->position
;
4975 else if (!frame_window_p
)
4978 #ifdef HAVE_WINDOW_SYSTEM
4979 value
= XCAR (XCDR (spec
));
4980 if (!SYMBOLP (value
)
4981 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4982 /* If we return here, POSITION has been advanced
4983 across the text with this property. */
4985 if (it
&& it
->bidi_p
)
4987 it
->position
= *position
;
4988 iterate_out_of_display_property (it
);
4989 *position
= it
->position
;
4996 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4998 if (CONSP (XCDR (XCDR (spec
))))
5000 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5001 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5002 FRINGE_FACE_ID
, false);
5007 /* Save current settings of IT so that we can restore them
5008 when we are finished with the glyph property value. */
5009 push_it (it
, position
);
5011 it
->area
= TEXT_AREA
;
5012 it
->what
= IT_IMAGE
;
5013 it
->image_id
= -1; /* no image */
5014 it
->position
= start_pos
;
5015 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5016 it
->method
= GET_FROM_IMAGE
;
5017 it
->from_overlay
= Qnil
;
5018 it
->face_id
= face_id
;
5019 it
->from_disp_prop_p
= true;
5021 /* Say that we haven't consumed the characters with
5022 `display' property yet. The call to pop_it in
5023 set_iterator_to_next will clean this up. */
5024 *position
= start_pos
;
5026 if (EQ (XCAR (spec
), Qleft_fringe
))
5028 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5029 it
->left_user_fringe_face_id
= face_id
;
5033 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5034 it
->right_user_fringe_face_id
= face_id
;
5037 #endif /* HAVE_WINDOW_SYSTEM */
5041 /* Prepare to handle `((margin left-margin) ...)',
5042 `((margin right-margin) ...)' and `((margin nil) ...)'
5043 prefixes for display specifications. */
5044 location
= Qunbound
;
5045 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5049 value
= XCDR (spec
);
5051 value
= XCAR (value
);
5054 if (EQ (XCAR (tem
), Qmargin
)
5055 && (tem
= XCDR (tem
),
5056 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5058 || EQ (tem
, Qleft_margin
)
5059 || EQ (tem
, Qright_margin
))))
5063 if (EQ (location
, Qunbound
))
5069 /* After this point, VALUE is the property after any
5070 margin prefix has been stripped. It must be a string,
5071 an image specification, or `(space ...)'.
5073 LOCATION specifies where to display: `left-margin',
5074 `right-margin' or nil. */
5076 bool valid_p
= (STRINGP (value
)
5077 #ifdef HAVE_WINDOW_SYSTEM
5078 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5079 && valid_image_p (value
))
5080 #endif /* not HAVE_WINDOW_SYSTEM */
5081 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5083 if (valid_p
&& display_replaced
== 0)
5089 /* Callers need to know whether the display spec is any kind
5090 of `(space ...)' spec that is about to affect text-area
5092 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5097 /* Save current settings of IT so that we can restore them
5098 when we are finished with the glyph property value. */
5099 push_it (it
, position
);
5100 it
->from_overlay
= overlay
;
5101 it
->from_disp_prop_p
= true;
5103 if (NILP (location
))
5104 it
->area
= TEXT_AREA
;
5105 else if (EQ (location
, Qleft_margin
))
5106 it
->area
= LEFT_MARGIN_AREA
;
5108 it
->area
= RIGHT_MARGIN_AREA
;
5110 if (STRINGP (value
))
5113 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5114 it
->current
.overlay_string_index
= -1;
5115 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5116 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5117 it
->method
= GET_FROM_STRING
;
5118 it
->stop_charpos
= 0;
5120 it
->base_level_stop
= 0;
5121 it
->string_from_display_prop_p
= true;
5122 /* Say that we haven't consumed the characters with
5123 `display' property yet. The call to pop_it in
5124 set_iterator_to_next will clean this up. */
5125 if (BUFFERP (object
))
5126 *position
= start_pos
;
5128 /* Force paragraph direction to be that of the parent
5129 object. If the parent object's paragraph direction is
5130 not yet determined, default to L2R. */
5131 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5132 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5134 it
->paragraph_embedding
= L2R
;
5136 /* Set up the bidi iterator for this display string. */
5139 it
->bidi_it
.string
.lstring
= it
->string
;
5140 it
->bidi_it
.string
.s
= NULL
;
5141 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5142 it
->bidi_it
.string
.bufpos
= bufpos
;
5143 it
->bidi_it
.string
.from_disp_str
= true;
5144 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5145 it
->bidi_it
.w
= it
->w
;
5146 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5149 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5151 it
->method
= GET_FROM_STRETCH
;
5153 *position
= it
->position
= start_pos
;
5154 retval
= 1 + (it
->area
== TEXT_AREA
);
5156 #ifdef HAVE_WINDOW_SYSTEM
5159 it
->what
= IT_IMAGE
;
5160 it
->image_id
= lookup_image (it
->f
, value
);
5161 it
->position
= start_pos
;
5162 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5163 it
->method
= GET_FROM_IMAGE
;
5165 /* Say that we haven't consumed the characters with
5166 `display' property yet. The call to pop_it in
5167 set_iterator_to_next will clean this up. */
5168 *position
= start_pos
;
5170 #endif /* HAVE_WINDOW_SYSTEM */
5175 /* Invalid property or property not supported. Restore
5176 POSITION to what it was before. */
5177 *position
= start_pos
;
5181 /* Check if PROP is a display property value whose text should be
5182 treated as intangible. OVERLAY is the overlay from which PROP
5183 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5184 specify the buffer position covered by PROP. */
5187 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5188 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5190 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5191 struct text_pos position
;
5193 SET_TEXT_POS (position
, charpos
, bytepos
);
5194 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5195 &position
, charpos
, frame_window_p
)
5200 /* Return true if PROP is a display sub-property value containing STRING.
5202 Implementation note: this and the following function are really
5203 special cases of handle_display_spec and
5204 handle_single_display_spec, and should ideally use the same code.
5205 Until they do, these two pairs must be consistent and must be
5206 modified in sync. */
5209 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5211 if (EQ (string
, prop
))
5214 /* Skip over `when FORM'. */
5215 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5220 /* Actually, the condition following `when' should be eval'ed,
5221 like handle_single_display_spec does, and we should return
5222 false if it evaluates to nil. However, this function is
5223 called only when the buffer was already displayed and some
5224 glyph in the glyph matrix was found to come from a display
5225 string. Therefore, the condition was already evaluated, and
5226 the result was non-nil, otherwise the display string wouldn't
5227 have been displayed and we would have never been called for
5228 this property. Thus, we can skip the evaluation and assume
5229 its result is non-nil. */
5234 /* Skip over `margin LOCATION'. */
5235 if (EQ (XCAR (prop
), Qmargin
))
5246 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5250 /* Return true if STRING appears in the `display' property PROP. */
5253 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5256 && !EQ (XCAR (prop
), Qwhen
)
5257 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5259 /* A list of sub-properties. */
5260 while (CONSP (prop
))
5262 if (single_display_spec_string_p (XCAR (prop
), string
))
5267 else if (VECTORP (prop
))
5269 /* A vector of sub-properties. */
5271 for (i
= 0; i
< ASIZE (prop
); ++i
)
5272 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5276 return single_display_spec_string_p (prop
, string
);
5281 /* Look for STRING in overlays and text properties in the current
5282 buffer, between character positions FROM and TO (excluding TO).
5283 BACK_P means look back (in this case, TO is supposed to be
5285 Value is the first character position where STRING was found, or
5286 zero if it wasn't found before hitting TO.
5288 This function may only use code that doesn't eval because it is
5289 called asynchronously from note_mouse_highlight. */
5292 string_buffer_position_lim (Lisp_Object string
,
5293 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5295 Lisp_Object limit
, prop
, pos
;
5298 pos
= make_number (max (from
, BEGV
));
5300 if (!back_p
) /* looking forward */
5302 limit
= make_number (min (to
, ZV
));
5303 while (!found
&& !EQ (pos
, limit
))
5305 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5306 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5309 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5313 else /* looking back */
5315 limit
= make_number (max (to
, BEGV
));
5316 while (!found
&& !EQ (pos
, limit
))
5318 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5319 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5322 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5327 return found
? XINT (pos
) : 0;
5330 /* Determine which buffer position in current buffer STRING comes from.
5331 AROUND_CHARPOS is an approximate position where it could come from.
5332 Value is the buffer position or 0 if it couldn't be determined.
5334 This function is necessary because we don't record buffer positions
5335 in glyphs generated from strings (to keep struct glyph small).
5336 This function may only use code that doesn't eval because it is
5337 called asynchronously from note_mouse_highlight. */
5340 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5342 const int MAX_DISTANCE
= 1000;
5343 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5344 around_charpos
+ MAX_DISTANCE
,
5348 found
= string_buffer_position_lim (string
, around_charpos
,
5349 around_charpos
- MAX_DISTANCE
, true);
5355 /***********************************************************************
5356 `composition' property
5357 ***********************************************************************/
5359 /* Set up iterator IT from `composition' property at its current
5360 position. Called from handle_stop. */
5362 static enum prop_handled
5363 handle_composition_prop (struct it
*it
)
5365 Lisp_Object prop
, string
;
5366 ptrdiff_t pos
, pos_byte
, start
, end
;
5368 if (STRINGP (it
->string
))
5372 pos
= IT_STRING_CHARPOS (*it
);
5373 pos_byte
= IT_STRING_BYTEPOS (*it
);
5374 string
= it
->string
;
5375 s
= SDATA (string
) + pos_byte
;
5376 it
->c
= STRING_CHAR (s
);
5380 pos
= IT_CHARPOS (*it
);
5381 pos_byte
= IT_BYTEPOS (*it
);
5383 it
->c
= FETCH_CHAR (pos_byte
);
5386 /* If there's a valid composition and point is not inside of the
5387 composition (in the case that the composition is from the current
5388 buffer), draw a glyph composed from the composition components. */
5389 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5390 && composition_valid_p (start
, end
, prop
)
5391 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5394 /* As we can't handle this situation (perhaps font-lock added
5395 a new composition), we just return here hoping that next
5396 redisplay will detect this composition much earlier. */
5397 return HANDLED_NORMALLY
;
5400 if (STRINGP (it
->string
))
5401 pos_byte
= string_char_to_byte (it
->string
, start
);
5403 pos_byte
= CHAR_TO_BYTE (start
);
5405 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5408 if (it
->cmp_it
.id
>= 0)
5411 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5412 it
->cmp_it
.nglyphs
= -1;
5416 return HANDLED_NORMALLY
;
5421 /***********************************************************************
5423 ***********************************************************************/
5425 /* The following structure is used to record overlay strings for
5426 later sorting in load_overlay_strings. */
5428 struct overlay_entry
5430 Lisp_Object overlay
;
5433 bool after_string_p
;
5437 /* Set up iterator IT from overlay strings at its current position.
5438 Called from handle_stop. */
5440 static enum prop_handled
5441 handle_overlay_change (struct it
*it
)
5443 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5444 return HANDLED_RECOMPUTE_PROPS
;
5446 return HANDLED_NORMALLY
;
5450 /* Set up the next overlay string for delivery by IT, if there is an
5451 overlay string to deliver. Called by set_iterator_to_next when the
5452 end of the current overlay string is reached. If there are more
5453 overlay strings to display, IT->string and
5454 IT->current.overlay_string_index are set appropriately here.
5455 Otherwise IT->string is set to nil. */
5458 next_overlay_string (struct it
*it
)
5460 ++it
->current
.overlay_string_index
;
5461 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5463 /* No more overlay strings. Restore IT's settings to what
5464 they were before overlay strings were processed, and
5465 continue to deliver from current_buffer. */
5467 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5470 || (NILP (it
->string
)
5471 && it
->method
== GET_FROM_BUFFER
5472 && it
->stop_charpos
>= BEGV
5473 && it
->stop_charpos
<= it
->end_charpos
));
5474 it
->current
.overlay_string_index
= -1;
5475 it
->n_overlay_strings
= 0;
5476 /* If there's an empty display string on the stack, pop the
5477 stack, to resync the bidi iterator with IT's position. Such
5478 empty strings are pushed onto the stack in
5479 get_overlay_strings_1. */
5480 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5483 /* Since we've exhausted overlay strings at this buffer
5484 position, set the flag to ignore overlays until we move to
5485 another position. The flag is reset in
5486 next_element_from_buffer. */
5487 it
->ignore_overlay_strings_at_pos_p
= true;
5489 /* If we're at the end of the buffer, record that we have
5490 processed the overlay strings there already, so that
5491 next_element_from_buffer doesn't try it again. */
5492 if (NILP (it
->string
)
5493 && IT_CHARPOS (*it
) >= it
->end_charpos
5494 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5495 it
->overlay_strings_at_end_processed_p
= true;
5496 /* Note: we reset overlay_strings_charpos only here, to make
5497 sure the just-processed overlays were indeed at EOB.
5498 Otherwise, overlays on text with invisible text property,
5499 which are processed with IT's position past the invisible
5500 text, might fool us into thinking the overlays at EOB were
5501 already processed (linum-mode can cause this, for
5503 it
->overlay_strings_charpos
= -1;
5507 /* There are more overlay strings to process. If
5508 IT->current.overlay_string_index has advanced to a position
5509 where we must load IT->overlay_strings with more strings, do
5510 it. We must load at the IT->overlay_strings_charpos where
5511 IT->n_overlay_strings was originally computed; when invisible
5512 text is present, this might not be IT_CHARPOS (Bug#7016). */
5513 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5515 if (it
->current
.overlay_string_index
&& i
== 0)
5516 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5518 /* Initialize IT to deliver display elements from the overlay
5520 it
->string
= it
->overlay_strings
[i
];
5521 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5522 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5523 it
->method
= GET_FROM_STRING
;
5524 it
->stop_charpos
= 0;
5525 it
->end_charpos
= SCHARS (it
->string
);
5526 if (it
->cmp_it
.stop_pos
>= 0)
5527 it
->cmp_it
.stop_pos
= 0;
5529 it
->base_level_stop
= 0;
5531 /* Set up the bidi iterator for this overlay string. */
5534 it
->bidi_it
.string
.lstring
= it
->string
;
5535 it
->bidi_it
.string
.s
= NULL
;
5536 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5537 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5538 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5539 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5540 it
->bidi_it
.w
= it
->w
;
5541 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5549 /* Compare two overlay_entry structures E1 and E2. Used as a
5550 comparison function for qsort in load_overlay_strings. Overlay
5551 strings for the same position are sorted so that
5553 1. All after-strings come in front of before-strings, except
5554 when they come from the same overlay.
5556 2. Within after-strings, strings are sorted so that overlay strings
5557 from overlays with higher priorities come first.
5559 2. Within before-strings, strings are sorted so that overlay
5560 strings from overlays with higher priorities come last.
5562 Value is analogous to strcmp. */
5566 compare_overlay_entries (const void *e1
, const void *e2
)
5568 struct overlay_entry
const *entry1
= e1
;
5569 struct overlay_entry
const *entry2
= e2
;
5572 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5574 /* Let after-strings appear in front of before-strings if
5575 they come from different overlays. */
5576 if (EQ (entry1
->overlay
, entry2
->overlay
))
5577 result
= entry1
->after_string_p
? 1 : -1;
5579 result
= entry1
->after_string_p
? -1 : 1;
5581 else if (entry1
->priority
!= entry2
->priority
)
5583 if (entry1
->after_string_p
)
5584 /* After-strings sorted in order of decreasing priority. */
5585 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5587 /* Before-strings sorted in order of increasing priority. */
5588 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5597 /* Load the vector IT->overlay_strings with overlay strings from IT's
5598 current buffer position, or from CHARPOS if that is > 0. Set
5599 IT->n_overlays to the total number of overlay strings found.
5601 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5602 a time. On entry into load_overlay_strings,
5603 IT->current.overlay_string_index gives the number of overlay
5604 strings that have already been loaded by previous calls to this
5607 IT->add_overlay_start contains an additional overlay start
5608 position to consider for taking overlay strings from, if non-zero.
5609 This position comes into play when the overlay has an `invisible'
5610 property, and both before and after-strings. When we've skipped to
5611 the end of the overlay, because of its `invisible' property, we
5612 nevertheless want its before-string to appear.
5613 IT->add_overlay_start will contain the overlay start position
5616 Overlay strings are sorted so that after-string strings come in
5617 front of before-string strings. Within before and after-strings,
5618 strings are sorted by overlay priority. See also function
5619 compare_overlay_entries. */
5622 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5624 Lisp_Object overlay
, window
, str
, invisible
;
5625 struct Lisp_Overlay
*ov
;
5626 ptrdiff_t start
, end
;
5627 ptrdiff_t n
= 0, i
, j
;
5629 struct overlay_entry entriesbuf
[20];
5630 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5631 struct overlay_entry
*entries
= entriesbuf
;
5635 charpos
= IT_CHARPOS (*it
);
5637 /* Append the overlay string STRING of overlay OVERLAY to vector
5638 `entries' which has size `size' and currently contains `n'
5639 elements. AFTER_P means STRING is an after-string of
5641 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5644 Lisp_Object priority; \
5648 struct overlay_entry *old = entries; \
5649 SAFE_NALLOCA (entries, 2, size); \
5650 memcpy (entries, old, size * sizeof *entries); \
5654 entries[n].string = (STRING); \
5655 entries[n].overlay = (OVERLAY); \
5656 priority = Foverlay_get ((OVERLAY), Qpriority); \
5657 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5658 entries[n].after_string_p = (AFTER_P); \
5663 /* Process overlay before the overlay center. */
5664 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5666 XSETMISC (overlay
, ov
);
5667 eassert (OVERLAYP (overlay
));
5668 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5669 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5674 /* Skip this overlay if it doesn't start or end at IT's current
5676 if (end
!= charpos
&& start
!= charpos
)
5679 /* Skip this overlay if it doesn't apply to IT->w. */
5680 window
= Foverlay_get (overlay
, Qwindow
);
5681 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5684 /* If the text ``under'' the overlay is invisible, both before-
5685 and after-strings from this overlay are visible; start and
5686 end position are indistinguishable. */
5687 invisible
= Foverlay_get (overlay
, Qinvisible
);
5688 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5690 /* If overlay has a non-empty before-string, record it. */
5691 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5692 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5694 RECORD_OVERLAY_STRING (overlay
, str
, false);
5696 /* If overlay has a non-empty after-string, record it. */
5697 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5698 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5700 RECORD_OVERLAY_STRING (overlay
, str
, true);
5703 /* Process overlays after the overlay center. */
5704 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5706 XSETMISC (overlay
, ov
);
5707 eassert (OVERLAYP (overlay
));
5708 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5709 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5711 if (start
> charpos
)
5714 /* Skip this overlay if it doesn't start or end at IT's current
5716 if (end
!= charpos
&& start
!= charpos
)
5719 /* Skip this overlay if it doesn't apply to IT->w. */
5720 window
= Foverlay_get (overlay
, Qwindow
);
5721 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5724 /* If the text ``under'' the overlay is invisible, it has a zero
5725 dimension, and both before- and after-strings apply. */
5726 invisible
= Foverlay_get (overlay
, Qinvisible
);
5727 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5729 /* If overlay has a non-empty before-string, record it. */
5730 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5731 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5733 RECORD_OVERLAY_STRING (overlay
, str
, false);
5735 /* If overlay has a non-empty after-string, record it. */
5736 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5737 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5739 RECORD_OVERLAY_STRING (overlay
, str
, true);
5742 #undef RECORD_OVERLAY_STRING
5746 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5748 /* Record number of overlay strings, and where we computed it. */
5749 it
->n_overlay_strings
= n
;
5750 it
->overlay_strings_charpos
= charpos
;
5752 /* IT->current.overlay_string_index is the number of overlay strings
5753 that have already been consumed by IT. Copy some of the
5754 remaining overlay strings to IT->overlay_strings. */
5756 j
= it
->current
.overlay_string_index
;
5757 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5759 it
->overlay_strings
[i
] = entries
[j
].string
;
5760 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5768 /* Get the first chunk of overlay strings at IT's current buffer
5769 position, or at CHARPOS if that is > 0. Value is true if at
5770 least one overlay string was found. */
5773 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5775 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5776 process. This fills IT->overlay_strings with strings, and sets
5777 IT->n_overlay_strings to the total number of strings to process.
5778 IT->pos.overlay_string_index has to be set temporarily to zero
5779 because load_overlay_strings needs this; it must be set to -1
5780 when no overlay strings are found because a zero value would
5781 indicate a position in the first overlay string. */
5782 it
->current
.overlay_string_index
= 0;
5783 load_overlay_strings (it
, charpos
);
5785 /* If we found overlay strings, set up IT to deliver display
5786 elements from the first one. Otherwise set up IT to deliver
5787 from current_buffer. */
5788 if (it
->n_overlay_strings
)
5790 /* Make sure we know settings in current_buffer, so that we can
5791 restore meaningful values when we're done with the overlay
5794 compute_stop_pos (it
);
5795 eassert (it
->face_id
>= 0);
5797 /* Save IT's settings. They are restored after all overlay
5798 strings have been processed. */
5799 eassert (!compute_stop_p
|| it
->sp
== 0);
5801 /* When called from handle_stop, there might be an empty display
5802 string loaded. In that case, don't bother saving it. But
5803 don't use this optimization with the bidi iterator, since we
5804 need the corresponding pop_it call to resync the bidi
5805 iterator's position with IT's position, after we are done
5806 with the overlay strings. (The corresponding call to pop_it
5807 in case of an empty display string is in
5808 next_overlay_string.) */
5810 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5813 /* Set up IT to deliver display elements from the first overlay
5815 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5816 it
->string
= it
->overlay_strings
[0];
5817 it
->from_overlay
= Qnil
;
5818 it
->stop_charpos
= 0;
5819 eassert (STRINGP (it
->string
));
5820 it
->end_charpos
= SCHARS (it
->string
);
5822 it
->base_level_stop
= 0;
5823 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5824 it
->method
= GET_FROM_STRING
;
5825 it
->from_disp_prop_p
= 0;
5827 /* Force paragraph direction to be that of the parent
5829 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5830 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5832 it
->paragraph_embedding
= L2R
;
5834 /* Set up the bidi iterator for this overlay string. */
5837 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5839 it
->bidi_it
.string
.lstring
= it
->string
;
5840 it
->bidi_it
.string
.s
= NULL
;
5841 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5842 it
->bidi_it
.string
.bufpos
= pos
;
5843 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5844 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5845 it
->bidi_it
.w
= it
->w
;
5846 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5851 it
->current
.overlay_string_index
= -1;
5856 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5859 it
->method
= GET_FROM_BUFFER
;
5861 get_overlay_strings_1 (it
, charpos
, true);
5865 /* Value is true if we found at least one overlay string. */
5866 return STRINGP (it
->string
);
5871 /***********************************************************************
5872 Saving and restoring state
5873 ***********************************************************************/
5875 /* Save current settings of IT on IT->stack. Called, for example,
5876 before setting up IT for an overlay string, to be able to restore
5877 IT's settings to what they were after the overlay string has been
5878 processed. If POSITION is non-NULL, it is the position to save on
5879 the stack instead of IT->position. */
5882 push_it (struct it
*it
, struct text_pos
*position
)
5884 struct iterator_stack_entry
*p
;
5886 eassert (it
->sp
< IT_STACK_SIZE
);
5887 p
= it
->stack
+ it
->sp
;
5889 p
->stop_charpos
= it
->stop_charpos
;
5890 p
->prev_stop
= it
->prev_stop
;
5891 p
->base_level_stop
= it
->base_level_stop
;
5892 p
->cmp_it
= it
->cmp_it
;
5893 eassert (it
->face_id
>= 0);
5894 p
->face_id
= it
->face_id
;
5895 p
->string
= it
->string
;
5896 p
->method
= it
->method
;
5897 p
->from_overlay
= it
->from_overlay
;
5900 case GET_FROM_IMAGE
:
5901 p
->u
.image
.object
= it
->object
;
5902 p
->u
.image
.image_id
= it
->image_id
;
5903 p
->u
.image
.slice
= it
->slice
;
5905 case GET_FROM_STRETCH
:
5906 p
->u
.stretch
.object
= it
->object
;
5908 case GET_FROM_BUFFER
:
5909 case GET_FROM_DISPLAY_VECTOR
:
5910 case GET_FROM_STRING
:
5911 case GET_FROM_C_STRING
:
5916 p
->position
= position
? *position
: it
->position
;
5917 p
->current
= it
->current
;
5918 p
->end_charpos
= it
->end_charpos
;
5919 p
->string_nchars
= it
->string_nchars
;
5921 p
->multibyte_p
= it
->multibyte_p
;
5922 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5923 p
->space_width
= it
->space_width
;
5924 p
->font_height
= it
->font_height
;
5925 p
->voffset
= it
->voffset
;
5926 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5927 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5928 p
->display_ellipsis_p
= false;
5929 p
->line_wrap
= it
->line_wrap
;
5930 p
->bidi_p
= it
->bidi_p
;
5931 p
->paragraph_embedding
= it
->paragraph_embedding
;
5932 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5935 /* Save the state of the bidi iterator as well. */
5937 bidi_push_it (&it
->bidi_it
);
5941 iterate_out_of_display_property (struct it
*it
)
5943 bool buffer_p
= !STRINGP (it
->string
);
5944 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5945 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5947 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5949 /* Maybe initialize paragraph direction. If we are at the beginning
5950 of a new paragraph, next_element_from_buffer may not have a
5951 chance to do that. */
5952 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5953 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
5954 /* prev_stop can be zero, so check against BEGV as well. */
5955 while (it
->bidi_it
.charpos
>= bob
5956 && it
->prev_stop
<= it
->bidi_it
.charpos
5957 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5958 && it
->bidi_it
.charpos
< eob
)
5959 bidi_move_to_visually_next (&it
->bidi_it
);
5960 /* Record the stop_pos we just crossed, for when we cross it
5962 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5963 it
->prev_stop
= CHARPOS (it
->position
);
5964 /* If we ended up not where pop_it put us, resync IT's
5965 positional members with the bidi iterator. */
5966 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5967 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5969 it
->current
.pos
= it
->position
;
5971 it
->current
.string_pos
= it
->position
;
5974 /* Restore IT's settings from IT->stack. Called, for example, when no
5975 more overlay strings must be processed, and we return to delivering
5976 display elements from a buffer, or when the end of a string from a
5977 `display' property is reached and we return to delivering display
5978 elements from an overlay string, or from a buffer. */
5981 pop_it (struct it
*it
)
5983 struct iterator_stack_entry
*p
;
5984 bool from_display_prop
= it
->from_disp_prop_p
;
5985 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
5987 eassert (it
->sp
> 0);
5989 p
= it
->stack
+ it
->sp
;
5990 it
->stop_charpos
= p
->stop_charpos
;
5991 it
->prev_stop
= p
->prev_stop
;
5992 it
->base_level_stop
= p
->base_level_stop
;
5993 it
->cmp_it
= p
->cmp_it
;
5994 it
->face_id
= p
->face_id
;
5995 it
->current
= p
->current
;
5996 it
->position
= p
->position
;
5997 it
->string
= p
->string
;
5998 it
->from_overlay
= p
->from_overlay
;
5999 if (NILP (it
->string
))
6000 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6001 it
->method
= p
->method
;
6004 case GET_FROM_IMAGE
:
6005 it
->image_id
= p
->u
.image
.image_id
;
6006 it
->object
= p
->u
.image
.object
;
6007 it
->slice
= p
->u
.image
.slice
;
6009 case GET_FROM_STRETCH
:
6010 it
->object
= p
->u
.stretch
.object
;
6012 case GET_FROM_BUFFER
:
6013 it
->object
= it
->w
->contents
;
6015 case GET_FROM_STRING
:
6017 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6019 /* Restore the face_box_p flag, since it could have been
6020 overwritten by the face of the object that we just finished
6023 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6024 it
->object
= it
->string
;
6027 case GET_FROM_DISPLAY_VECTOR
:
6029 it
->method
= GET_FROM_C_STRING
;
6030 else if (STRINGP (it
->string
))
6031 it
->method
= GET_FROM_STRING
;
6034 it
->method
= GET_FROM_BUFFER
;
6035 it
->object
= it
->w
->contents
;
6038 case GET_FROM_C_STRING
:
6043 it
->end_charpos
= p
->end_charpos
;
6044 it
->string_nchars
= p
->string_nchars
;
6046 it
->multibyte_p
= p
->multibyte_p
;
6047 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6048 it
->space_width
= p
->space_width
;
6049 it
->font_height
= p
->font_height
;
6050 it
->voffset
= p
->voffset
;
6051 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6052 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6053 it
->line_wrap
= p
->line_wrap
;
6054 it
->bidi_p
= p
->bidi_p
;
6055 it
->paragraph_embedding
= p
->paragraph_embedding
;
6056 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6059 bidi_pop_it (&it
->bidi_it
);
6060 /* Bidi-iterate until we get out of the portion of text, if any,
6061 covered by a `display' text property or by an overlay with
6062 `display' property. (We cannot just jump there, because the
6063 internal coherency of the bidi iterator state can not be
6064 preserved across such jumps.) We also must determine the
6065 paragraph base direction if the overlay we just processed is
6066 at the beginning of a new paragraph. */
6067 if (from_display_prop
6068 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6069 iterate_out_of_display_property (it
);
6071 eassert ((BUFFERP (it
->object
)
6072 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6073 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6074 || (STRINGP (it
->object
)
6075 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6076 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6077 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6079 /* If we move the iterator over text covered by a display property
6080 to a new buffer position, any info about previously seen overlays
6081 is no longer valid. */
6082 if (from_display_prop
&& it
->sp
== 0 && CHARPOS (it
->position
) != prev_pos
)
6083 it
->ignore_overlay_strings_at_pos_p
= false;
6088 /***********************************************************************
6090 ***********************************************************************/
6092 /* Set IT's current position to the previous line start. */
6095 back_to_previous_line_start (struct it
*it
)
6097 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6100 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6104 /* Move IT to the next line start.
6106 Value is true if a newline was found. Set *SKIPPED_P to true if
6107 we skipped over part of the text (as opposed to moving the iterator
6108 continuously over the text). Otherwise, don't change the value
6111 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6112 iterator on the newline, if it was found.
6114 Newlines may come from buffer text, overlay strings, or strings
6115 displayed via the `display' property. That's the reason we can't
6116 simply use find_newline_no_quit.
6118 Note that this function may not skip over invisible text that is so
6119 because of text properties and immediately follows a newline. If
6120 it would, function reseat_at_next_visible_line_start, when called
6121 from set_iterator_to_next, would effectively make invisible
6122 characters following a newline part of the wrong glyph row, which
6123 leads to wrong cursor motion. */
6126 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6127 struct bidi_it
*bidi_it_prev
)
6129 ptrdiff_t old_selective
;
6130 bool newline_found_p
= false;
6132 const int MAX_NEWLINE_DISTANCE
= 500;
6134 /* If already on a newline, just consume it to avoid unintended
6135 skipping over invisible text below. */
6136 if (it
->what
== IT_CHARACTER
6138 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6140 if (it
->bidi_p
&& bidi_it_prev
)
6141 *bidi_it_prev
= it
->bidi_it
;
6142 set_iterator_to_next (it
, false);
6147 /* Don't handle selective display in the following. It's (a)
6148 unnecessary because it's done by the caller, and (b) leads to an
6149 infinite recursion because next_element_from_ellipsis indirectly
6150 calls this function. */
6151 old_selective
= it
->selective
;
6154 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6155 from buffer text. */
6157 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6158 n
+= !STRINGP (it
->string
))
6160 if (!get_next_display_element (it
))
6162 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6163 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6164 *bidi_it_prev
= it
->bidi_it
;
6165 set_iterator_to_next (it
, false);
6168 /* If we didn't find a newline near enough, see if we can use a
6170 if (!newline_found_p
)
6172 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6173 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6177 eassert (!STRINGP (it
->string
));
6179 /* If there isn't any `display' property in sight, and no
6180 overlays, we can just use the position of the newline in
6182 if (it
->stop_charpos
>= limit
6183 || ((pos
= Fnext_single_property_change (make_number (start
),
6185 make_number (limit
)),
6187 && next_overlay_change (start
) == ZV
))
6191 IT_CHARPOS (*it
) = limit
;
6192 IT_BYTEPOS (*it
) = bytepos
;
6196 struct bidi_it bprev
;
6198 /* Help bidi.c avoid expensive searches for display
6199 properties and overlays, by telling it that there are
6200 none up to `limit'. */
6201 if (it
->bidi_it
.disp_pos
< limit
)
6203 it
->bidi_it
.disp_pos
= limit
;
6204 it
->bidi_it
.disp_prop
= 0;
6207 bprev
= it
->bidi_it
;
6208 bidi_move_to_visually_next (&it
->bidi_it
);
6209 } while (it
->bidi_it
.charpos
!= limit
);
6210 IT_CHARPOS (*it
) = limit
;
6211 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6213 *bidi_it_prev
= bprev
;
6215 *skipped_p
= newline_found_p
= true;
6219 while (get_next_display_element (it
)
6220 && !newline_found_p
)
6222 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6223 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6224 *bidi_it_prev
= it
->bidi_it
;
6225 set_iterator_to_next (it
, false);
6230 it
->selective
= old_selective
;
6231 return newline_found_p
;
6235 /* Set IT's current position to the previous visible line start. Skip
6236 invisible text that is so either due to text properties or due to
6237 selective display. Caution: this does not change IT->current_x and
6241 back_to_previous_visible_line_start (struct it
*it
)
6243 while (IT_CHARPOS (*it
) > BEGV
)
6245 back_to_previous_line_start (it
);
6247 if (IT_CHARPOS (*it
) <= BEGV
)
6250 /* If selective > 0, then lines indented more than its value are
6252 if (it
->selective
> 0
6253 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6257 /* Check the newline before point for invisibility. */
6260 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6261 Qinvisible
, it
->window
);
6262 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6266 if (IT_CHARPOS (*it
) <= BEGV
)
6271 void *it2data
= NULL
;
6274 Lisp_Object val
, overlay
;
6276 SAVE_IT (it2
, *it
, it2data
);
6278 /* If newline is part of a composition, continue from start of composition */
6279 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6280 && beg
< IT_CHARPOS (*it
))
6283 /* If newline is replaced by a display property, find start of overlay
6284 or interval and continue search from that point. */
6285 pos
= --IT_CHARPOS (it2
);
6288 bidi_unshelve_cache (NULL
, false);
6289 it2
.string_from_display_prop_p
= false;
6290 it2
.from_disp_prop_p
= false;
6291 if (handle_display_prop (&it2
) == HANDLED_RETURN
6292 && !NILP (val
= get_char_property_and_overlay
6293 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6294 && (OVERLAYP (overlay
)
6295 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6296 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6298 RESTORE_IT (it
, it
, it2data
);
6302 /* Newline is not replaced by anything -- so we are done. */
6303 RESTORE_IT (it
, it
, it2data
);
6309 IT_CHARPOS (*it
) = beg
;
6310 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6314 it
->continuation_lines_width
= 0;
6316 eassert (IT_CHARPOS (*it
) >= BEGV
);
6317 eassert (IT_CHARPOS (*it
) == BEGV
6318 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6323 /* Reseat iterator IT at the previous visible line start. Skip
6324 invisible text that is so either due to text properties or due to
6325 selective display. At the end, update IT's overlay information,
6326 face information etc. */
6329 reseat_at_previous_visible_line_start (struct it
*it
)
6331 back_to_previous_visible_line_start (it
);
6332 reseat (it
, it
->current
.pos
, true);
6337 /* Reseat iterator IT on the next visible line start in the current
6338 buffer. ON_NEWLINE_P means position IT on the newline
6339 preceding the line start. Skip over invisible text that is so
6340 because of selective display. Compute faces, overlays etc at the
6341 new position. Note that this function does not skip over text that
6342 is invisible because of text properties. */
6345 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6347 bool skipped_p
= false;
6348 struct bidi_it bidi_it_prev
;
6349 bool newline_found_p
6350 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6352 /* Skip over lines that are invisible because they are indented
6353 more than the value of IT->selective. */
6354 if (it
->selective
> 0)
6355 while (IT_CHARPOS (*it
) < ZV
6356 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6359 eassert (IT_BYTEPOS (*it
) == BEGV
6360 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6362 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6365 /* Position on the newline if that's what's requested. */
6366 if (on_newline_p
&& newline_found_p
)
6368 if (STRINGP (it
->string
))
6370 if (IT_STRING_CHARPOS (*it
) > 0)
6374 --IT_STRING_CHARPOS (*it
);
6375 --IT_STRING_BYTEPOS (*it
);
6379 /* We need to restore the bidi iterator to the state
6380 it had on the newline, and resync the IT's
6381 position with that. */
6382 it
->bidi_it
= bidi_it_prev
;
6383 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6384 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6388 else if (IT_CHARPOS (*it
) > BEGV
)
6397 /* We need to restore the bidi iterator to the state it
6398 had on the newline and resync IT with that. */
6399 it
->bidi_it
= bidi_it_prev
;
6400 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6401 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6403 reseat (it
, it
->current
.pos
, false);
6407 reseat (it
, it
->current
.pos
, false);
6414 /***********************************************************************
6415 Changing an iterator's position
6416 ***********************************************************************/
6418 /* Change IT's current position to POS in current_buffer.
6419 If FORCE_P, always check for text properties at the new position.
6420 Otherwise, text properties are only looked up if POS >=
6421 IT->check_charpos of a property. */
6424 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6426 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6428 reseat_1 (it
, pos
, false);
6430 /* Determine where to check text properties. Avoid doing it
6431 where possible because text property lookup is very expensive. */
6433 || CHARPOS (pos
) > it
->stop_charpos
6434 || CHARPOS (pos
) < original_pos
)
6438 /* For bidi iteration, we need to prime prev_stop and
6439 base_level_stop with our best estimations. */
6440 /* Implementation note: Of course, POS is not necessarily a
6441 stop position, so assigning prev_pos to it is a lie; we
6442 should have called compute_stop_backwards. However, if
6443 the current buffer does not include any R2L characters,
6444 that call would be a waste of cycles, because the
6445 iterator will never move back, and thus never cross this
6446 "fake" stop position. So we delay that backward search
6447 until the time we really need it, in next_element_from_buffer. */
6448 if (CHARPOS (pos
) != it
->prev_stop
)
6449 it
->prev_stop
= CHARPOS (pos
);
6450 if (CHARPOS (pos
) < it
->base_level_stop
)
6451 it
->base_level_stop
= 0; /* meaning it's unknown */
6457 it
->prev_stop
= it
->base_level_stop
= 0;
6466 /* Change IT's buffer position to POS. SET_STOP_P means set
6467 IT->stop_pos to POS, also. */
6470 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6472 /* Don't call this function when scanning a C string. */
6473 eassert (it
->s
== NULL
);
6475 /* POS must be a reasonable value. */
6476 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6478 it
->current
.pos
= it
->position
= pos
;
6479 it
->end_charpos
= ZV
;
6481 it
->current
.dpvec_index
= -1;
6482 it
->current
.overlay_string_index
= -1;
6483 IT_STRING_CHARPOS (*it
) = -1;
6484 IT_STRING_BYTEPOS (*it
) = -1;
6486 it
->method
= GET_FROM_BUFFER
;
6487 it
->object
= it
->w
->contents
;
6488 it
->area
= TEXT_AREA
;
6489 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6491 it
->string_from_display_prop_p
= false;
6492 it
->string_from_prefix_prop_p
= false;
6494 it
->from_disp_prop_p
= false;
6495 it
->face_before_selective_p
= false;
6498 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6500 bidi_unshelve_cache (NULL
, false);
6501 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6502 it
->bidi_it
.string
.s
= NULL
;
6503 it
->bidi_it
.string
.lstring
= Qnil
;
6504 it
->bidi_it
.string
.bufpos
= 0;
6505 it
->bidi_it
.string
.from_disp_str
= false;
6506 it
->bidi_it
.string
.unibyte
= false;
6507 it
->bidi_it
.w
= it
->w
;
6512 it
->stop_charpos
= CHARPOS (pos
);
6513 it
->base_level_stop
= CHARPOS (pos
);
6515 /* This make the information stored in it->cmp_it invalidate. */
6520 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6521 If S is non-null, it is a C string to iterate over. Otherwise,
6522 STRING gives a Lisp string to iterate over.
6524 If PRECISION > 0, don't return more then PRECISION number of
6525 characters from the string.
6527 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6528 characters have been returned. FIELD_WIDTH < 0 means an infinite
6531 MULTIBYTE = 0 means disable processing of multibyte characters,
6532 MULTIBYTE > 0 means enable it,
6533 MULTIBYTE < 0 means use IT->multibyte_p.
6535 IT must be initialized via a prior call to init_iterator before
6536 calling this function. */
6539 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6540 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6543 /* No text property checks performed by default, but see below. */
6544 it
->stop_charpos
= -1;
6546 /* Set iterator position and end position. */
6547 memset (&it
->current
, 0, sizeof it
->current
);
6548 it
->current
.overlay_string_index
= -1;
6549 it
->current
.dpvec_index
= -1;
6550 eassert (charpos
>= 0);
6552 /* If STRING is specified, use its multibyteness, otherwise use the
6553 setting of MULTIBYTE, if specified. */
6555 it
->multibyte_p
= multibyte
> 0;
6557 /* Bidirectional reordering of strings is controlled by the default
6558 value of bidi-display-reordering. Don't try to reorder while
6559 loading loadup.el, as the necessary character property tables are
6560 not yet available. */
6563 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6567 eassert (STRINGP (string
));
6568 it
->string
= string
;
6570 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6571 it
->method
= GET_FROM_STRING
;
6572 it
->current
.string_pos
= string_pos (charpos
, string
);
6576 it
->bidi_it
.string
.lstring
= string
;
6577 it
->bidi_it
.string
.s
= NULL
;
6578 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6579 it
->bidi_it
.string
.bufpos
= 0;
6580 it
->bidi_it
.string
.from_disp_str
= false;
6581 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6582 it
->bidi_it
.w
= it
->w
;
6583 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6584 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6589 it
->s
= (const unsigned char *) s
;
6592 /* Note that we use IT->current.pos, not it->current.string_pos,
6593 for displaying C strings. */
6594 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6595 if (it
->multibyte_p
)
6597 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6598 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6602 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6603 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6608 it
->bidi_it
.string
.lstring
= Qnil
;
6609 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6610 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6611 it
->bidi_it
.string
.bufpos
= 0;
6612 it
->bidi_it
.string
.from_disp_str
= false;
6613 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6614 it
->bidi_it
.w
= it
->w
;
6615 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6618 it
->method
= GET_FROM_C_STRING
;
6621 /* PRECISION > 0 means don't return more than PRECISION characters
6623 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6625 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6627 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6630 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6631 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6632 FIELD_WIDTH < 0 means infinite field width. This is useful for
6633 padding with `-' at the end of a mode line. */
6634 if (field_width
< 0)
6635 field_width
= INFINITY
;
6636 /* Implementation note: We deliberately don't enlarge
6637 it->bidi_it.string.schars here to fit it->end_charpos, because
6638 the bidi iterator cannot produce characters out of thin air. */
6639 if (field_width
> it
->end_charpos
- charpos
)
6640 it
->end_charpos
= charpos
+ field_width
;
6642 /* Use the standard display table for displaying strings. */
6643 if (DISP_TABLE_P (Vstandard_display_table
))
6644 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6646 it
->stop_charpos
= charpos
;
6647 it
->prev_stop
= charpos
;
6648 it
->base_level_stop
= 0;
6651 it
->bidi_it
.first_elt
= true;
6652 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6653 it
->bidi_it
.disp_pos
= -1;
6655 if (s
== NULL
&& it
->multibyte_p
)
6657 ptrdiff_t endpos
= SCHARS (it
->string
);
6658 if (endpos
> it
->end_charpos
)
6659 endpos
= it
->end_charpos
;
6660 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6668 /***********************************************************************
6670 ***********************************************************************/
6672 /* Map enum it_method value to corresponding next_element_from_* function. */
6674 typedef bool (*next_element_function
) (struct it
*);
6676 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6678 next_element_from_buffer
,
6679 next_element_from_display_vector
,
6680 next_element_from_string
,
6681 next_element_from_c_string
,
6682 next_element_from_image
,
6683 next_element_from_stretch
6686 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6689 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6690 (possibly with the following characters). */
6692 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6693 ((IT)->cmp_it.id >= 0 \
6694 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6695 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6696 END_CHARPOS, (IT)->w, \
6697 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6701 /* Lookup the char-table Vglyphless_char_display for character C (-1
6702 if we want information for no-font case), and return the display
6703 method symbol. By side-effect, update it->what and
6704 it->glyphless_method. This function is called from
6705 get_next_display_element for each character element, and from
6706 x_produce_glyphs when no suitable font was found. */
6709 lookup_glyphless_char_display (int c
, struct it
*it
)
6711 Lisp_Object glyphless_method
= Qnil
;
6713 if (CHAR_TABLE_P (Vglyphless_char_display
)
6714 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6718 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6719 if (CONSP (glyphless_method
))
6720 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6721 ? XCAR (glyphless_method
)
6722 : XCDR (glyphless_method
);
6725 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6729 if (NILP (glyphless_method
))
6732 /* The default is to display the character by a proper font. */
6734 /* The default for the no-font case is to display an empty box. */
6735 glyphless_method
= Qempty_box
;
6737 if (EQ (glyphless_method
, Qzero_width
))
6740 return glyphless_method
;
6741 /* This method can't be used for the no-font case. */
6742 glyphless_method
= Qempty_box
;
6744 if (EQ (glyphless_method
, Qthin_space
))
6745 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6746 else if (EQ (glyphless_method
, Qempty_box
))
6747 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6748 else if (EQ (glyphless_method
, Qhex_code
))
6749 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6750 else if (STRINGP (glyphless_method
))
6751 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6754 /* Invalid value. We use the default method. */
6755 glyphless_method
= Qnil
;
6758 it
->what
= IT_GLYPHLESS
;
6759 return glyphless_method
;
6762 /* Merge escape glyph face and cache the result. */
6764 static struct frame
*last_escape_glyph_frame
= NULL
;
6765 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6766 static int last_escape_glyph_merged_face_id
= 0;
6769 merge_escape_glyph_face (struct it
*it
)
6773 if (it
->f
== last_escape_glyph_frame
6774 && it
->face_id
== last_escape_glyph_face_id
)
6775 face_id
= last_escape_glyph_merged_face_id
;
6778 /* Merge the `escape-glyph' face into the current face. */
6779 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6780 last_escape_glyph_frame
= it
->f
;
6781 last_escape_glyph_face_id
= it
->face_id
;
6782 last_escape_glyph_merged_face_id
= face_id
;
6787 /* Likewise for glyphless glyph face. */
6789 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6790 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6791 static int last_glyphless_glyph_merged_face_id
= 0;
6794 merge_glyphless_glyph_face (struct it
*it
)
6798 if (it
->f
== last_glyphless_glyph_frame
6799 && it
->face_id
== last_glyphless_glyph_face_id
)
6800 face_id
= last_glyphless_glyph_merged_face_id
;
6803 /* Merge the `glyphless-char' face into the current face. */
6804 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6805 last_glyphless_glyph_frame
= it
->f
;
6806 last_glyphless_glyph_face_id
= it
->face_id
;
6807 last_glyphless_glyph_merged_face_id
= face_id
;
6812 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6813 be called before redisplaying windows, and when the frame's face
6816 forget_escape_and_glyphless_faces (void)
6818 last_escape_glyph_frame
= NULL
;
6819 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6820 last_glyphless_glyph_frame
= NULL
;
6821 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6824 /* Load IT's display element fields with information about the next
6825 display element from the current position of IT. Value is false if
6826 end of buffer (or C string) is reached. */
6829 get_next_display_element (struct it
*it
)
6831 /* True means that we found a display element. False means that
6832 we hit the end of what we iterate over. Performance note: the
6833 function pointer `method' used here turns out to be faster than
6834 using a sequence of if-statements. */
6838 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6840 if (it
->what
== IT_CHARACTER
)
6842 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6843 and only if (a) the resolved directionality of that character
6845 /* FIXME: Do we need an exception for characters from display
6847 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6848 && !inhibit_bidi_mirroring
)
6849 it
->c
= bidi_mirror_char (it
->c
);
6850 /* Map via display table or translate control characters.
6851 IT->c, IT->len etc. have been set to the next character by
6852 the function call above. If we have a display table, and it
6853 contains an entry for IT->c, translate it. Don't do this if
6854 IT->c itself comes from a display table, otherwise we could
6855 end up in an infinite recursion. (An alternative could be to
6856 count the recursion depth of this function and signal an
6857 error when a certain maximum depth is reached.) Is it worth
6859 if (success_p
&& it
->dpvec
== NULL
)
6862 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6863 bool nonascii_space_p
= false;
6864 bool nonascii_hyphen_p
= false;
6865 int c
= it
->c
; /* This is the character to display. */
6867 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6869 eassert (SINGLE_BYTE_CHAR_P (c
));
6870 if (unibyte_display_via_language_environment
)
6872 c
= DECODE_CHAR (unibyte
, c
);
6874 c
= BYTE8_TO_CHAR (it
->c
);
6877 c
= BYTE8_TO_CHAR (it
->c
);
6881 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6884 struct Lisp_Vector
*v
= XVECTOR (dv
);
6886 /* Return the first character from the display table
6887 entry, if not empty. If empty, don't display the
6888 current character. */
6891 it
->dpvec_char_len
= it
->len
;
6892 it
->dpvec
= v
->contents
;
6893 it
->dpend
= v
->contents
+ v
->header
.size
;
6894 it
->current
.dpvec_index
= 0;
6895 it
->dpvec_face_id
= -1;
6896 it
->saved_face_id
= it
->face_id
;
6897 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6898 it
->ellipsis_p
= false;
6902 set_iterator_to_next (it
, false);
6907 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6909 if (it
->what
== IT_GLYPHLESS
)
6911 /* Don't display this character. */
6912 set_iterator_to_next (it
, false);
6916 /* If `nobreak-char-display' is non-nil, we display
6917 non-ASCII spaces and hyphens specially. */
6918 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6920 if (c
== NO_BREAK_SPACE
)
6921 nonascii_space_p
= true;
6922 else if (c
== SOFT_HYPHEN
|| c
== HYPHEN
6923 || c
== NON_BREAKING_HYPHEN
)
6924 nonascii_hyphen_p
= true;
6927 /* Translate control characters into `\003' or `^C' form.
6928 Control characters coming from a display table entry are
6929 currently not translated because we use IT->dpvec to hold
6930 the translation. This could easily be changed but I
6931 don't believe that it is worth doing.
6933 The characters handled by `nobreak-char-display' must be
6936 Non-printable characters and raw-byte characters are also
6937 translated to octal form. */
6938 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6939 ? (it
->area
!= TEXT_AREA
6940 /* In mode line, treat \n, \t like other crl chars. */
6943 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6944 || (c
!= '\n' && c
!= '\t'))
6946 || nonascii_hyphen_p
6948 || ! CHAR_PRINTABLE_P (c
))))
6950 /* C is a control character, non-ASCII space/hyphen,
6951 raw-byte, or a non-printable character which must be
6952 displayed either as '\003' or as `^C' where the '\\'
6953 and '^' can be defined in the display table. Fill
6954 IT->ctl_chars with glyphs for what we have to
6955 display. Then, set IT->dpvec to these glyphs. */
6962 /* Handle control characters with ^. */
6964 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6968 g
= '^'; /* default glyph for Control */
6969 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6971 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6973 g
= GLYPH_CODE_CHAR (gc
);
6974 lface_id
= GLYPH_CODE_FACE (gc
);
6978 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6979 : merge_escape_glyph_face (it
));
6981 XSETINT (it
->ctl_chars
[0], g
);
6982 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6984 goto display_control
;
6987 /* Handle non-ascii space in the mode where it only gets
6990 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6992 /* Merge `nobreak-space' into the current face. */
6993 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6995 XSETINT (it
->ctl_chars
[0], ' ');
6997 goto display_control
;
7000 /* Handle sequences that start with the "escape glyph". */
7002 /* the default escape glyph is \. */
7003 escape_glyph
= '\\';
7006 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7008 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7009 lface_id
= GLYPH_CODE_FACE (gc
);
7013 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7014 : merge_escape_glyph_face (it
));
7016 /* Draw non-ASCII hyphen with just highlighting: */
7018 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7020 XSETINT (it
->ctl_chars
[0], '-');
7022 goto display_control
;
7025 /* Draw non-ASCII space/hyphen with escape glyph: */
7027 if (nonascii_space_p
|| nonascii_hyphen_p
)
7029 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7030 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7032 goto display_control
;
7039 if (CHAR_BYTE8_P (c
))
7040 /* Display \200 instead of \17777600. */
7041 c
= CHAR_TO_BYTE8 (c
);
7042 len
= sprintf (str
, "%03o", c
+ 0u);
7044 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7045 for (i
= 0; i
< len
; i
++)
7046 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7051 /* Set up IT->dpvec and return first character from it. */
7052 it
->dpvec_char_len
= it
->len
;
7053 it
->dpvec
= it
->ctl_chars
;
7054 it
->dpend
= it
->dpvec
+ ctl_len
;
7055 it
->current
.dpvec_index
= 0;
7056 it
->dpvec_face_id
= face_id
;
7057 it
->saved_face_id
= it
->face_id
;
7058 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7059 it
->ellipsis_p
= false;
7062 it
->char_to_display
= c
;
7066 it
->char_to_display
= it
->c
;
7070 #ifdef HAVE_WINDOW_SYSTEM
7071 /* Adjust face id for a multibyte character. There are no multibyte
7072 character in unibyte text. */
7073 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7076 && FRAME_WINDOW_P (it
->f
))
7078 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7080 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7082 /* Automatic composition with glyph-string. */
7083 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7085 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7089 ptrdiff_t pos
= (it
->s
? -1
7090 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7091 : IT_CHARPOS (*it
));
7094 if (it
->what
== IT_CHARACTER
)
7095 c
= it
->char_to_display
;
7098 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7102 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7103 /* TAB in a composition means display glyphs with
7104 padding space on the left or right. */
7105 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7108 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7111 #endif /* HAVE_WINDOW_SYSTEM */
7114 /* Is this character the last one of a run of characters with
7115 box? If yes, set IT->end_of_box_run_p to true. */
7119 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7121 int face_id
= underlying_face_id (it
);
7122 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7126 if (face
->box
== FACE_NO_BOX
)
7128 /* If the box comes from face properties in a
7129 display string, check faces in that string. */
7130 int string_face_id
= face_after_it_pos (it
);
7131 it
->end_of_box_run_p
7132 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7135 /* Otherwise, the box comes from the underlying face.
7136 If this is the last string character displayed, check
7137 the next buffer location. */
7138 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7139 /* n_overlay_strings is unreliable unless
7140 overlay_string_index is non-negative. */
7141 && ((it
->current
.overlay_string_index
>= 0
7142 && (it
->current
.overlay_string_index
7143 == it
->n_overlay_strings
- 1))
7144 /* A string from display property. */
7145 || it
->from_disp_prop_p
))
7149 struct text_pos pos
= it
->current
.pos
;
7151 /* For a string from a display property, the next
7152 buffer position is stored in the 'position'
7153 member of the iteration stack slot below the
7154 current one, see handle_single_display_spec. By
7155 contrast, it->current.pos was is not yet updated
7156 to point to that buffer position; that will
7157 happen in pop_it, after we finish displaying the
7158 current string. Note that we already checked
7159 above that it->sp is positive, so subtracting one
7161 if (it
->from_disp_prop_p
)
7162 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7164 INC_TEXT_POS (pos
, it
->multibyte_p
);
7166 if (CHARPOS (pos
) >= ZV
)
7167 it
->end_of_box_run_p
= true;
7170 next_face_id
= face_at_buffer_position
7171 (it
->w
, CHARPOS (pos
), &ignore
,
7172 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, false, -1);
7173 it
->end_of_box_run_p
7174 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7180 /* next_element_from_display_vector sets this flag according to
7181 faces of the display vector glyphs, see there. */
7182 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7184 int face_id
= face_after_it_pos (it
);
7185 it
->end_of_box_run_p
7186 = (face_id
!= it
->face_id
7187 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7190 /* If we reached the end of the object we've been iterating (e.g., a
7191 display string or an overlay string), and there's something on
7192 IT->stack, proceed with what's on the stack. It doesn't make
7193 sense to return false if there's unprocessed stuff on the stack,
7194 because otherwise that stuff will never be displayed. */
7195 if (!success_p
&& it
->sp
> 0)
7197 set_iterator_to_next (it
, false);
7198 success_p
= get_next_display_element (it
);
7201 /* Value is false if end of buffer or string reached. */
7206 /* Move IT to the next display element.
7208 RESEAT_P means if called on a newline in buffer text,
7209 skip to the next visible line start.
7211 Functions get_next_display_element and set_iterator_to_next are
7212 separate because I find this arrangement easier to handle than a
7213 get_next_display_element function that also increments IT's
7214 position. The way it is we can first look at an iterator's current
7215 display element, decide whether it fits on a line, and if it does,
7216 increment the iterator position. The other way around we probably
7217 would either need a flag indicating whether the iterator has to be
7218 incremented the next time, or we would have to implement a
7219 decrement position function which would not be easy to write. */
7222 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7224 /* Reset flags indicating start and end of a sequence of characters
7225 with box. Reset them at the start of this function because
7226 moving the iterator to a new position might set them. */
7227 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7231 case GET_FROM_BUFFER
:
7232 /* The current display element of IT is a character from
7233 current_buffer. Advance in the buffer, and maybe skip over
7234 invisible lines that are so because of selective display. */
7235 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7236 reseat_at_next_visible_line_start (it
, false);
7237 else if (it
->cmp_it
.id
>= 0)
7239 /* We are currently getting glyphs from a composition. */
7242 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7243 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7249 /* Update IT's char/byte positions to point to the first
7250 character of the next grapheme cluster, or to the
7251 character visually after the current composition. */
7252 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7253 bidi_move_to_visually_next (&it
->bidi_it
);
7254 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7255 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7258 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7259 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7261 /* Composition created while scanning forward. Proceed
7262 to the next grapheme cluster. */
7263 it
->cmp_it
.from
= it
->cmp_it
.to
;
7265 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7266 && it
->cmp_it
.from
> 0)
7268 /* Composition created while scanning backward. Proceed
7269 to the previous grapheme cluster. */
7270 it
->cmp_it
.to
= it
->cmp_it
.from
;
7274 /* No more grapheme clusters in this composition.
7275 Find the next stop position. */
7276 ptrdiff_t stop
= it
->end_charpos
;
7278 if (it
->bidi_it
.scan_dir
< 0)
7279 /* Now we are scanning backward and don't know
7282 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7283 IT_BYTEPOS (*it
), stop
, Qnil
);
7288 eassert (it
->len
!= 0);
7292 IT_BYTEPOS (*it
) += it
->len
;
7293 IT_CHARPOS (*it
) += 1;
7297 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7298 /* If this is a new paragraph, determine its base
7299 direction (a.k.a. its base embedding level). */
7300 if (it
->bidi_it
.new_paragraph
)
7301 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7303 bidi_move_to_visually_next (&it
->bidi_it
);
7304 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7305 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7306 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7308 /* As the scan direction was changed, we must
7309 re-compute the stop position for composition. */
7310 ptrdiff_t stop
= it
->end_charpos
;
7311 if (it
->bidi_it
.scan_dir
< 0)
7313 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7314 IT_BYTEPOS (*it
), stop
, Qnil
);
7317 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7321 case GET_FROM_C_STRING
:
7322 /* Current display element of IT is from a C string. */
7324 /* If the string position is beyond string's end, it means
7325 next_element_from_c_string is padding the string with
7326 blanks, in which case we bypass the bidi iterator,
7327 because it cannot deal with such virtual characters. */
7328 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7330 IT_BYTEPOS (*it
) += it
->len
;
7331 IT_CHARPOS (*it
) += 1;
7335 bidi_move_to_visually_next (&it
->bidi_it
);
7336 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7337 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7341 case GET_FROM_DISPLAY_VECTOR
:
7342 /* Current display element of IT is from a display table entry.
7343 Advance in the display table definition. Reset it to null if
7344 end reached, and continue with characters from buffers/
7346 ++it
->current
.dpvec_index
;
7348 /* Restore face of the iterator to what they were before the
7349 display vector entry (these entries may contain faces). */
7350 it
->face_id
= it
->saved_face_id
;
7352 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7354 bool recheck_faces
= it
->ellipsis_p
;
7357 it
->method
= GET_FROM_C_STRING
;
7358 else if (STRINGP (it
->string
))
7359 it
->method
= GET_FROM_STRING
;
7362 it
->method
= GET_FROM_BUFFER
;
7363 it
->object
= it
->w
->contents
;
7367 it
->current
.dpvec_index
= -1;
7369 /* Skip over characters which were displayed via IT->dpvec. */
7370 if (it
->dpvec_char_len
< 0)
7371 reseat_at_next_visible_line_start (it
, true);
7372 else if (it
->dpvec_char_len
> 0)
7374 it
->len
= it
->dpvec_char_len
;
7375 set_iterator_to_next (it
, reseat_p
);
7378 /* Maybe recheck faces after display vector. */
7381 if (it
->method
== GET_FROM_STRING
)
7382 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7384 it
->stop_charpos
= IT_CHARPOS (*it
);
7389 case GET_FROM_STRING
:
7390 /* Current display element is a character from a Lisp string. */
7391 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7392 /* Don't advance past string end. These conditions are true
7393 when set_iterator_to_next is called at the end of
7394 get_next_display_element, in which case the Lisp string is
7395 already exhausted, and all we want is pop the iterator
7397 if (it
->current
.overlay_string_index
>= 0)
7399 /* This is an overlay string, so there's no padding with
7400 spaces, and the number of characters in the string is
7401 where the string ends. */
7402 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7403 goto consider_string_end
;
7407 /* Not an overlay string. There could be padding, so test
7408 against it->end_charpos. */
7409 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7410 goto consider_string_end
;
7412 if (it
->cmp_it
.id
>= 0)
7414 /* We are delivering display elements from a composition.
7415 Update the string position past the grapheme cluster
7416 we've just processed. */
7419 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7420 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7426 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7427 bidi_move_to_visually_next (&it
->bidi_it
);
7428 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7429 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7432 /* Did we exhaust all the grapheme clusters of this
7434 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7435 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7437 /* Not all the grapheme clusters were processed yet;
7438 advance to the next cluster. */
7439 it
->cmp_it
.from
= it
->cmp_it
.to
;
7441 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7442 && it
->cmp_it
.from
> 0)
7444 /* Likewise: advance to the next cluster, but going in
7445 the reverse direction. */
7446 it
->cmp_it
.to
= it
->cmp_it
.from
;
7450 /* This composition was fully processed; find the next
7451 candidate place for checking for composed
7453 /* Always limit string searches to the string length;
7454 any padding spaces are not part of the string, and
7455 there cannot be any compositions in that padding. */
7456 ptrdiff_t stop
= SCHARS (it
->string
);
7458 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7460 else if (it
->end_charpos
< stop
)
7462 /* Cf. PRECISION in reseat_to_string: we might be
7463 limited in how many of the string characters we
7465 stop
= it
->end_charpos
;
7467 composition_compute_stop_pos (&it
->cmp_it
,
7468 IT_STRING_CHARPOS (*it
),
7469 IT_STRING_BYTEPOS (*it
), stop
,
7476 /* If the string position is beyond string's end, it
7477 means next_element_from_string is padding the string
7478 with blanks, in which case we bypass the bidi
7479 iterator, because it cannot deal with such virtual
7481 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7483 IT_STRING_BYTEPOS (*it
) += it
->len
;
7484 IT_STRING_CHARPOS (*it
) += 1;
7488 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7490 bidi_move_to_visually_next (&it
->bidi_it
);
7491 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7492 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7493 /* If the scan direction changes, we may need to update
7494 the place where to check for composed characters. */
7495 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7497 ptrdiff_t stop
= SCHARS (it
->string
);
7499 if (it
->bidi_it
.scan_dir
< 0)
7501 else if (it
->end_charpos
< stop
)
7502 stop
= it
->end_charpos
;
7504 composition_compute_stop_pos (&it
->cmp_it
,
7505 IT_STRING_CHARPOS (*it
),
7506 IT_STRING_BYTEPOS (*it
), stop
,
7512 consider_string_end
:
7514 if (it
->current
.overlay_string_index
>= 0)
7516 /* IT->string is an overlay string. Advance to the
7517 next, if there is one. */
7518 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7520 it
->ellipsis_p
= false;
7521 next_overlay_string (it
);
7523 setup_for_ellipsis (it
, 0);
7528 /* IT->string is not an overlay string. If we reached
7529 its end, and there is something on IT->stack, proceed
7530 with what is on the stack. This can be either another
7531 string, this time an overlay string, or a buffer. */
7532 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7536 if (it
->method
== GET_FROM_STRING
)
7537 goto consider_string_end
;
7542 case GET_FROM_IMAGE
:
7543 case GET_FROM_STRETCH
:
7544 /* The position etc with which we have to proceed are on
7545 the stack. The position may be at the end of a string,
7546 if the `display' property takes up the whole string. */
7547 eassert (it
->sp
> 0);
7549 if (it
->method
== GET_FROM_STRING
)
7550 goto consider_string_end
;
7554 /* There are no other methods defined, so this should be a bug. */
7558 eassert (it
->method
!= GET_FROM_STRING
7559 || (STRINGP (it
->string
)
7560 && IT_STRING_CHARPOS (*it
) >= 0));
7563 /* Load IT's display element fields with information about the next
7564 display element which comes from a display table entry or from the
7565 result of translating a control character to one of the forms `^C'
7568 IT->dpvec holds the glyphs to return as characters.
7569 IT->saved_face_id holds the face id before the display vector--it
7570 is restored into IT->face_id in set_iterator_to_next. */
7573 next_element_from_display_vector (struct it
*it
)
7576 int prev_face_id
= it
->face_id
;
7580 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7582 it
->face_id
= it
->saved_face_id
;
7584 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7585 That seemed totally bogus - so I changed it... */
7586 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7588 if (GLYPH_CODE_P (gc
))
7590 struct face
*this_face
, *prev_face
, *next_face
;
7592 it
->c
= GLYPH_CODE_CHAR (gc
);
7593 it
->len
= CHAR_BYTES (it
->c
);
7595 /* The entry may contain a face id to use. Such a face id is
7596 the id of a Lisp face, not a realized face. A face id of
7597 zero means no face is specified. */
7598 if (it
->dpvec_face_id
>= 0)
7599 it
->face_id
= it
->dpvec_face_id
;
7602 int lface_id
= GLYPH_CODE_FACE (gc
);
7604 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7608 /* Glyphs in the display vector could have the box face, so we
7609 need to set the related flags in the iterator, as
7611 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7612 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7614 /* Is this character the first character of a box-face run? */
7615 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7617 || prev_face
->box
== FACE_NO_BOX
));
7619 /* For the last character of the box-face run, we need to look
7620 either at the next glyph from the display vector, or at the
7621 face we saw before the display vector. */
7622 next_face_id
= it
->saved_face_id
;
7623 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7625 if (it
->dpvec_face_id
>= 0)
7626 next_face_id
= it
->dpvec_face_id
;
7630 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7633 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7637 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7638 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7640 || next_face
->box
== FACE_NO_BOX
));
7641 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7644 /* Display table entry is invalid. Return a space. */
7645 it
->c
= ' ', it
->len
= 1;
7647 /* Don't change position and object of the iterator here. They are
7648 still the values of the character that had this display table
7649 entry or was translated, and that's what we want. */
7650 it
->what
= IT_CHARACTER
;
7654 /* Get the first element of string/buffer in the visual order, after
7655 being reseated to a new position in a string or a buffer. */
7657 get_visually_first_element (struct it
*it
)
7659 bool string_p
= STRINGP (it
->string
) || it
->s
;
7660 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7661 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7663 if (STRINGP (it
->string
))
7665 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7666 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7670 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7671 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7674 if (it
->bidi_it
.charpos
== eob
)
7676 /* Nothing to do, but reset the FIRST_ELT flag, like
7677 bidi_paragraph_init does, because we are not going to
7679 it
->bidi_it
.first_elt
= false;
7681 else if (it
->bidi_it
.charpos
== bob
7683 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7684 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7686 /* If we are at the beginning of a line/string, we can produce
7687 the next element right away. */
7688 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7689 bidi_move_to_visually_next (&it
->bidi_it
);
7693 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7695 /* We need to prime the bidi iterator starting at the line's or
7696 string's beginning, before we will be able to produce the
7699 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7701 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7702 IT_BYTEPOS (*it
), -1,
7703 &it
->bidi_it
.bytepos
);
7704 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7707 /* Now return to buffer/string position where we were asked
7708 to get the next display element, and produce that. */
7709 bidi_move_to_visually_next (&it
->bidi_it
);
7711 while (it
->bidi_it
.bytepos
!= orig_bytepos
7712 && it
->bidi_it
.charpos
< eob
);
7715 /* Adjust IT's position information to where we ended up. */
7716 if (STRINGP (it
->string
))
7718 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7719 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7723 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7724 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7727 if (STRINGP (it
->string
) || !it
->s
)
7729 ptrdiff_t stop
, charpos
, bytepos
;
7731 if (STRINGP (it
->string
))
7734 stop
= SCHARS (it
->string
);
7735 if (stop
> it
->end_charpos
)
7736 stop
= it
->end_charpos
;
7737 charpos
= IT_STRING_CHARPOS (*it
);
7738 bytepos
= IT_STRING_BYTEPOS (*it
);
7742 stop
= it
->end_charpos
;
7743 charpos
= IT_CHARPOS (*it
);
7744 bytepos
= IT_BYTEPOS (*it
);
7746 if (it
->bidi_it
.scan_dir
< 0)
7748 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7753 /* Load IT with the next display element from Lisp string IT->string.
7754 IT->current.string_pos is the current position within the string.
7755 If IT->current.overlay_string_index >= 0, the Lisp string is an
7759 next_element_from_string (struct it
*it
)
7761 struct text_pos position
;
7763 eassert (STRINGP (it
->string
));
7764 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7765 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7766 position
= it
->current
.string_pos
;
7768 /* With bidi reordering, the character to display might not be the
7769 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7770 that we were reseat()ed to a new string, whose paragraph
7771 direction is not known. */
7772 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7774 get_visually_first_element (it
);
7775 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7778 /* Time to check for invisible text? */
7779 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7781 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7784 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7785 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7787 /* With bidi non-linear iteration, we could find
7788 ourselves far beyond the last computed stop_charpos,
7789 with several other stop positions in between that we
7790 missed. Scan them all now, in buffer's logical
7791 order, until we find and handle the last stop_charpos
7792 that precedes our current position. */
7793 handle_stop_backwards (it
, it
->stop_charpos
);
7794 return GET_NEXT_DISPLAY_ELEMENT (it
);
7800 /* Take note of the stop position we just moved
7801 across, for when we will move back across it. */
7802 it
->prev_stop
= it
->stop_charpos
;
7803 /* If we are at base paragraph embedding level, take
7804 note of the last stop position seen at this
7806 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7807 it
->base_level_stop
= it
->stop_charpos
;
7811 /* Since a handler may have changed IT->method, we must
7813 return GET_NEXT_DISPLAY_ELEMENT (it
);
7817 /* If we are before prev_stop, we may have overstepped
7818 on our way backwards a stop_pos, and if so, we need
7819 to handle that stop_pos. */
7820 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7821 /* We can sometimes back up for reasons that have nothing
7822 to do with bidi reordering. E.g., compositions. The
7823 code below is only needed when we are above the base
7824 embedding level, so test for that explicitly. */
7825 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7827 /* If we lost track of base_level_stop, we have no better
7828 place for handle_stop_backwards to start from than string
7829 beginning. This happens, e.g., when we were reseated to
7830 the previous screenful of text by vertical-motion. */
7831 if (it
->base_level_stop
<= 0
7832 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7833 it
->base_level_stop
= 0;
7834 handle_stop_backwards (it
, it
->base_level_stop
);
7835 return GET_NEXT_DISPLAY_ELEMENT (it
);
7839 if (it
->current
.overlay_string_index
>= 0)
7841 /* Get the next character from an overlay string. In overlay
7842 strings, there is no field width or padding with spaces to
7844 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7849 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7850 IT_STRING_BYTEPOS (*it
),
7851 it
->bidi_it
.scan_dir
< 0
7853 : SCHARS (it
->string
))
7854 && next_element_from_composition (it
))
7858 else if (STRING_MULTIBYTE (it
->string
))
7860 const unsigned char *s
= (SDATA (it
->string
)
7861 + IT_STRING_BYTEPOS (*it
));
7862 it
->c
= string_char_and_length (s
, &it
->len
);
7866 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7872 /* Get the next character from a Lisp string that is not an
7873 overlay string. Such strings come from the mode line, for
7874 example. We may have to pad with spaces, or truncate the
7875 string. See also next_element_from_c_string. */
7876 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7881 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7883 /* Pad with spaces. */
7884 it
->c
= ' ', it
->len
= 1;
7885 CHARPOS (position
) = BYTEPOS (position
) = -1;
7887 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7888 IT_STRING_BYTEPOS (*it
),
7889 it
->bidi_it
.scan_dir
< 0
7891 : it
->string_nchars
)
7892 && next_element_from_composition (it
))
7896 else if (STRING_MULTIBYTE (it
->string
))
7898 const unsigned char *s
= (SDATA (it
->string
)
7899 + IT_STRING_BYTEPOS (*it
));
7900 it
->c
= string_char_and_length (s
, &it
->len
);
7904 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7909 /* Record what we have and where it came from. */
7910 it
->what
= IT_CHARACTER
;
7911 it
->object
= it
->string
;
7912 it
->position
= position
;
7917 /* Load IT with next display element from C string IT->s.
7918 IT->string_nchars is the maximum number of characters to return
7919 from the string. IT->end_charpos may be greater than
7920 IT->string_nchars when this function is called, in which case we
7921 may have to return padding spaces. Value is false if end of string
7922 reached, including padding spaces. */
7925 next_element_from_c_string (struct it
*it
)
7927 bool success_p
= true;
7930 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7931 it
->what
= IT_CHARACTER
;
7932 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7933 it
->object
= make_number (0);
7935 /* With bidi reordering, the character to display might not be the
7936 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
7937 we were reseated to a new string, whose paragraph direction is
7939 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7940 get_visually_first_element (it
);
7942 /* IT's position can be greater than IT->string_nchars in case a
7943 field width or precision has been specified when the iterator was
7945 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7947 /* End of the game. */
7951 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7953 /* Pad with spaces. */
7954 it
->c
= ' ', it
->len
= 1;
7955 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7957 else if (it
->multibyte_p
)
7958 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7960 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7966 /* Set up IT to return characters from an ellipsis, if appropriate.
7967 The definition of the ellipsis glyphs may come from a display table
7968 entry. This function fills IT with the first glyph from the
7969 ellipsis if an ellipsis is to be displayed. */
7972 next_element_from_ellipsis (struct it
*it
)
7974 if (it
->selective_display_ellipsis_p
)
7975 setup_for_ellipsis (it
, it
->len
);
7978 /* The face at the current position may be different from the
7979 face we find after the invisible text. Remember what it
7980 was in IT->saved_face_id, and signal that it's there by
7981 setting face_before_selective_p. */
7982 it
->saved_face_id
= it
->face_id
;
7983 it
->method
= GET_FROM_BUFFER
;
7984 it
->object
= it
->w
->contents
;
7985 reseat_at_next_visible_line_start (it
, true);
7986 it
->face_before_selective_p
= true;
7989 return GET_NEXT_DISPLAY_ELEMENT (it
);
7993 /* Deliver an image display element. The iterator IT is already
7994 filled with image information (done in handle_display_prop). Value
7999 next_element_from_image (struct it
*it
)
8001 it
->what
= IT_IMAGE
;
8006 /* Fill iterator IT with next display element from a stretch glyph
8007 property. IT->object is the value of the text property. Value is
8011 next_element_from_stretch (struct it
*it
)
8013 it
->what
= IT_STRETCH
;
8017 /* Scan backwards from IT's current position until we find a stop
8018 position, or until BEGV. This is called when we find ourself
8019 before both the last known prev_stop and base_level_stop while
8020 reordering bidirectional text. */
8023 compute_stop_pos_backwards (struct it
*it
)
8025 const int SCAN_BACK_LIMIT
= 1000;
8026 struct text_pos pos
;
8027 struct display_pos save_current
= it
->current
;
8028 struct text_pos save_position
= it
->position
;
8029 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8030 ptrdiff_t where_we_are
= charpos
;
8031 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8032 ptrdiff_t save_end_pos
= it
->end_charpos
;
8034 eassert (NILP (it
->string
) && !it
->s
);
8035 eassert (it
->bidi_p
);
8039 it
->end_charpos
= min (charpos
+ 1, ZV
);
8040 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8041 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8042 reseat_1 (it
, pos
, false);
8043 compute_stop_pos (it
);
8044 /* We must advance forward, right? */
8045 if (it
->stop_charpos
<= charpos
)
8048 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8050 if (it
->stop_charpos
<= where_we_are
)
8051 it
->prev_stop
= it
->stop_charpos
;
8053 it
->prev_stop
= BEGV
;
8055 it
->current
= save_current
;
8056 it
->position
= save_position
;
8057 it
->stop_charpos
= save_stop_pos
;
8058 it
->end_charpos
= save_end_pos
;
8061 /* Scan forward from CHARPOS in the current buffer/string, until we
8062 find a stop position > current IT's position. Then handle the stop
8063 position before that. This is called when we bump into a stop
8064 position while reordering bidirectional text. CHARPOS should be
8065 the last previously processed stop_pos (or BEGV/0, if none were
8066 processed yet) whose position is less that IT's current
8070 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8072 bool bufp
= !STRINGP (it
->string
);
8073 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8074 struct display_pos save_current
= it
->current
;
8075 struct text_pos save_position
= it
->position
;
8076 struct text_pos pos1
;
8077 ptrdiff_t next_stop
;
8079 /* Scan in strict logical order. */
8080 eassert (it
->bidi_p
);
8084 it
->prev_stop
= charpos
;
8087 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8088 reseat_1 (it
, pos1
, false);
8091 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8092 compute_stop_pos (it
);
8093 /* We must advance forward, right? */
8094 if (it
->stop_charpos
<= it
->prev_stop
)
8096 charpos
= it
->stop_charpos
;
8098 while (charpos
<= where_we_are
);
8101 it
->current
= save_current
;
8102 it
->position
= save_position
;
8103 next_stop
= it
->stop_charpos
;
8104 it
->stop_charpos
= it
->prev_stop
;
8106 it
->stop_charpos
= next_stop
;
8109 /* Load IT with the next display element from current_buffer. Value
8110 is false if end of buffer reached. IT->stop_charpos is the next
8111 position at which to stop and check for text properties or buffer
8115 next_element_from_buffer (struct it
*it
)
8117 bool success_p
= true;
8119 eassert (IT_CHARPOS (*it
) >= BEGV
);
8120 eassert (NILP (it
->string
) && !it
->s
);
8121 eassert (!it
->bidi_p
8122 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8123 && it
->bidi_it
.string
.s
== NULL
));
8125 /* With bidi reordering, the character to display might not be the
8126 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8127 we were reseat()ed to a new buffer position, which is potentially
8128 a different paragraph. */
8129 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8131 get_visually_first_element (it
);
8132 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8135 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8137 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8139 bool overlay_strings_follow_p
;
8141 /* End of the game, except when overlay strings follow that
8142 haven't been returned yet. */
8143 if (it
->overlay_strings_at_end_processed_p
)
8144 overlay_strings_follow_p
= false;
8147 it
->overlay_strings_at_end_processed_p
= true;
8148 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8151 if (overlay_strings_follow_p
)
8152 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8156 it
->position
= it
->current
.pos
;
8160 else if (!(!it
->bidi_p
8161 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8162 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8164 /* With bidi non-linear iteration, we could find ourselves
8165 far beyond the last computed stop_charpos, with several
8166 other stop positions in between that we missed. Scan
8167 them all now, in buffer's logical order, until we find
8168 and handle the last stop_charpos that precedes our
8169 current position. */
8170 handle_stop_backwards (it
, it
->stop_charpos
);
8171 it
->ignore_overlay_strings_at_pos_p
= false;
8172 return GET_NEXT_DISPLAY_ELEMENT (it
);
8178 /* Take note of the stop position we just moved across,
8179 for when we will move back across it. */
8180 it
->prev_stop
= it
->stop_charpos
;
8181 /* If we are at base paragraph embedding level, take
8182 note of the last stop position seen at this
8184 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8185 it
->base_level_stop
= it
->stop_charpos
;
8188 it
->ignore_overlay_strings_at_pos_p
= false;
8189 return GET_NEXT_DISPLAY_ELEMENT (it
);
8193 /* If we are before prev_stop, we may have overstepped on
8194 our way backwards a stop_pos, and if so, we need to
8195 handle that stop_pos. */
8196 && IT_CHARPOS (*it
) < it
->prev_stop
8197 /* We can sometimes back up for reasons that have nothing
8198 to do with bidi reordering. E.g., compositions. The
8199 code below is only needed when we are above the base
8200 embedding level, so test for that explicitly. */
8201 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8203 if (it
->base_level_stop
<= 0
8204 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8206 /* If we lost track of base_level_stop, we need to find
8207 prev_stop by looking backwards. This happens, e.g., when
8208 we were reseated to the previous screenful of text by
8210 it
->base_level_stop
= BEGV
;
8211 compute_stop_pos_backwards (it
);
8212 handle_stop_backwards (it
, it
->prev_stop
);
8215 handle_stop_backwards (it
, it
->base_level_stop
);
8216 it
->ignore_overlay_strings_at_pos_p
= false;
8217 return GET_NEXT_DISPLAY_ELEMENT (it
);
8221 /* No face changes, overlays etc. in sight, so just return a
8222 character from current_buffer. */
8226 /* We moved to the next buffer position, so any info about
8227 previously seen overlays is no longer valid. */
8228 it
->ignore_overlay_strings_at_pos_p
= false;
8230 /* Maybe run the redisplay end trigger hook. Performance note:
8231 This doesn't seem to cost measurable time. */
8232 if (it
->redisplay_end_trigger_charpos
8234 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8235 run_redisplay_end_trigger_hook (it
);
8237 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8238 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8240 && next_element_from_composition (it
))
8245 /* Get the next character, maybe multibyte. */
8246 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8247 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8248 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8250 it
->c
= *p
, it
->len
= 1;
8252 /* Record what we have and where it came from. */
8253 it
->what
= IT_CHARACTER
;
8254 it
->object
= it
->w
->contents
;
8255 it
->position
= it
->current
.pos
;
8257 /* Normally we return the character found above, except when we
8258 really want to return an ellipsis for selective display. */
8263 /* A value of selective > 0 means hide lines indented more
8264 than that number of columns. */
8265 if (it
->selective
> 0
8266 && IT_CHARPOS (*it
) + 1 < ZV
8267 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8268 IT_BYTEPOS (*it
) + 1,
8271 success_p
= next_element_from_ellipsis (it
);
8272 it
->dpvec_char_len
= -1;
8275 else if (it
->c
== '\r' && it
->selective
== -1)
8277 /* A value of selective == -1 means that everything from the
8278 CR to the end of the line is invisible, with maybe an
8279 ellipsis displayed for it. */
8280 success_p
= next_element_from_ellipsis (it
);
8281 it
->dpvec_char_len
= -1;
8286 /* Value is false if end of buffer reached. */
8287 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8292 /* Run the redisplay end trigger hook for IT. */
8295 run_redisplay_end_trigger_hook (struct it
*it
)
8297 /* IT->glyph_row should be non-null, i.e. we should be actually
8298 displaying something, or otherwise we should not run the hook. */
8299 eassert (it
->glyph_row
);
8301 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8302 it
->redisplay_end_trigger_charpos
= 0;
8304 /* Since we are *trying* to run these functions, don't try to run
8305 them again, even if they get an error. */
8306 wset_redisplay_end_trigger (it
->w
, Qnil
);
8307 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8308 make_number (charpos
));
8310 /* Notice if it changed the face of the character we are on. */
8311 handle_face_prop (it
);
8315 /* Deliver a composition display element. Unlike the other
8316 next_element_from_XXX, this function is not registered in the array
8317 get_next_element[]. It is called from next_element_from_buffer and
8318 next_element_from_string when necessary. */
8321 next_element_from_composition (struct it
*it
)
8323 it
->what
= IT_COMPOSITION
;
8324 it
->len
= it
->cmp_it
.nbytes
;
8325 if (STRINGP (it
->string
))
8329 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8330 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8333 it
->position
= it
->current
.string_pos
;
8334 it
->object
= it
->string
;
8335 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8336 IT_STRING_BYTEPOS (*it
), it
->string
);
8342 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8343 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8346 if (it
->bidi_it
.new_paragraph
)
8347 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8349 /* Resync the bidi iterator with IT's new position.
8350 FIXME: this doesn't support bidirectional text. */
8351 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8352 bidi_move_to_visually_next (&it
->bidi_it
);
8356 it
->position
= it
->current
.pos
;
8357 it
->object
= it
->w
->contents
;
8358 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8359 IT_BYTEPOS (*it
), Qnil
);
8366 /***********************************************************************
8367 Moving an iterator without producing glyphs
8368 ***********************************************************************/
8370 /* Check if iterator is at a position corresponding to a valid buffer
8371 position after some move_it_ call. */
8373 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8374 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8377 /* Move iterator IT to a specified buffer or X position within one
8378 line on the display without producing glyphs.
8380 OP should be a bit mask including some or all of these bits:
8381 MOVE_TO_X: Stop upon reaching x-position TO_X.
8382 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8383 Regardless of OP's value, stop upon reaching the end of the display line.
8385 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8386 This means, in particular, that TO_X includes window's horizontal
8389 The return value has several possible values that
8390 say what condition caused the scan to stop:
8392 MOVE_POS_MATCH_OR_ZV
8393 - when TO_POS or ZV was reached.
8396 -when TO_X was reached before TO_POS or ZV were reached.
8399 - when we reached the end of the display area and the line must
8403 - when we reached the end of the display area and the line is
8407 - when we stopped at a line end, i.e. a newline or a CR and selective
8410 static enum move_it_result
8411 move_it_in_display_line_to (struct it
*it
,
8412 ptrdiff_t to_charpos
, int to_x
,
8413 enum move_operation_enum op
)
8415 enum move_it_result result
= MOVE_UNDEFINED
;
8416 struct glyph_row
*saved_glyph_row
;
8417 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8418 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8419 void *ppos_data
= NULL
;
8420 bool may_wrap
= false;
8421 enum it_method prev_method
= it
->method
;
8422 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8423 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8425 /* Don't produce glyphs in produce_glyphs. */
8426 saved_glyph_row
= it
->glyph_row
;
8427 it
->glyph_row
= NULL
;
8429 /* Use wrap_it to save a copy of IT wherever a word wrap could
8430 occur. Use atpos_it to save a copy of IT at the desired buffer
8431 position, if found, so that we can scan ahead and check if the
8432 word later overshoots the window edge. Use atx_it similarly, for
8438 /* Use ppos_it under bidi reordering to save a copy of IT for the
8439 initial position. We restore that position in IT when we have
8440 scanned the entire display line without finding a match for
8441 TO_CHARPOS and all the character positions are greater than
8442 TO_CHARPOS. We then restart the scan from the initial position,
8443 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8444 the closest to TO_CHARPOS. */
8447 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8449 SAVE_IT (ppos_it
, *it
, ppos_data
);
8450 closest_pos
= IT_CHARPOS (*it
);
8456 #define BUFFER_POS_REACHED_P() \
8457 ((op & MOVE_TO_POS) != 0 \
8458 && BUFFERP (it->object) \
8459 && (IT_CHARPOS (*it) == to_charpos \
8461 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8462 && IT_CHARPOS (*it) > to_charpos) \
8463 || (it->what == IT_COMPOSITION \
8464 && ((IT_CHARPOS (*it) > to_charpos \
8465 && to_charpos >= it->cmp_it.charpos) \
8466 || (IT_CHARPOS (*it) < to_charpos \
8467 && to_charpos <= it->cmp_it.charpos)))) \
8468 && (it->method == GET_FROM_BUFFER \
8469 || (it->method == GET_FROM_DISPLAY_VECTOR \
8470 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8472 /* If there's a line-/wrap-prefix, handle it. */
8473 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8474 && it
->current_y
< it
->last_visible_y
)
8475 handle_line_prefix (it
);
8477 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8478 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8482 int x
, i
, ascent
= 0, descent
= 0;
8484 /* Utility macro to reset an iterator with x, ascent, and descent. */
8485 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8486 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8487 (IT)->max_descent = descent)
8489 /* Stop if we move beyond TO_CHARPOS (after an image or a
8490 display string or stretch glyph). */
8491 if ((op
& MOVE_TO_POS
) != 0
8492 && BUFFERP (it
->object
)
8493 && it
->method
== GET_FROM_BUFFER
8495 /* When the iterator is at base embedding level, we
8496 are guaranteed that characters are delivered for
8497 display in strictly increasing order of their
8498 buffer positions. */
8499 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8500 && IT_CHARPOS (*it
) > to_charpos
)
8502 && (prev_method
== GET_FROM_IMAGE
8503 || prev_method
== GET_FROM_STRETCH
8504 || prev_method
== GET_FROM_STRING
)
8505 /* Passed TO_CHARPOS from left to right. */
8506 && ((prev_pos
< to_charpos
8507 && IT_CHARPOS (*it
) > to_charpos
)
8508 /* Passed TO_CHARPOS from right to left. */
8509 || (prev_pos
> to_charpos
8510 && IT_CHARPOS (*it
) < to_charpos
)))))
8512 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8514 result
= MOVE_POS_MATCH_OR_ZV
;
8517 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8518 /* If wrap_it is valid, the current position might be in a
8519 word that is wrapped. So, save the iterator in
8520 atpos_it and continue to see if wrapping happens. */
8521 SAVE_IT (atpos_it
, *it
, atpos_data
);
8524 /* Stop when ZV reached.
8525 We used to stop here when TO_CHARPOS reached as well, but that is
8526 too soon if this glyph does not fit on this line. So we handle it
8527 explicitly below. */
8528 if (!get_next_display_element (it
))
8530 result
= MOVE_POS_MATCH_OR_ZV
;
8534 if (it
->line_wrap
== TRUNCATE
)
8536 if (BUFFER_POS_REACHED_P ())
8538 result
= MOVE_POS_MATCH_OR_ZV
;
8544 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8546 if (IT_DISPLAYING_WHITESPACE (it
))
8550 /* We have reached a glyph that follows one or more
8551 whitespace characters. If the position is
8552 already found, we are done. */
8553 if (atpos_it
.sp
>= 0)
8555 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8556 result
= MOVE_POS_MATCH_OR_ZV
;
8561 RESTORE_IT (it
, &atx_it
, atx_data
);
8562 result
= MOVE_X_REACHED
;
8565 /* Otherwise, we can wrap here. */
8566 SAVE_IT (wrap_it
, *it
, wrap_data
);
8572 /* Remember the line height for the current line, in case
8573 the next element doesn't fit on the line. */
8574 ascent
= it
->max_ascent
;
8575 descent
= it
->max_descent
;
8577 /* The call to produce_glyphs will get the metrics of the
8578 display element IT is loaded with. Record the x-position
8579 before this display element, in case it doesn't fit on the
8583 PRODUCE_GLYPHS (it
);
8585 if (it
->area
!= TEXT_AREA
)
8587 prev_method
= it
->method
;
8588 if (it
->method
== GET_FROM_BUFFER
)
8589 prev_pos
= IT_CHARPOS (*it
);
8590 set_iterator_to_next (it
, true);
8591 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8592 SET_TEXT_POS (this_line_min_pos
,
8593 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8595 && (op
& MOVE_TO_POS
)
8596 && IT_CHARPOS (*it
) > to_charpos
8597 && IT_CHARPOS (*it
) < closest_pos
)
8598 closest_pos
= IT_CHARPOS (*it
);
8602 /* The number of glyphs we get back in IT->nglyphs will normally
8603 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8604 character on a terminal frame, or (iii) a line end. For the
8605 second case, IT->nglyphs - 1 padding glyphs will be present.
8606 (On X frames, there is only one glyph produced for a
8607 composite character.)
8609 The behavior implemented below means, for continuation lines,
8610 that as many spaces of a TAB as fit on the current line are
8611 displayed there. For terminal frames, as many glyphs of a
8612 multi-glyph character are displayed in the current line, too.
8613 This is what the old redisplay code did, and we keep it that
8614 way. Under X, the whole shape of a complex character must
8615 fit on the line or it will be completely displayed in the
8618 Note that both for tabs and padding glyphs, all glyphs have
8622 /* More than one glyph or glyph doesn't fit on line. All
8623 glyphs have the same width. */
8624 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8626 int x_before_this_char
= x
;
8627 int hpos_before_this_char
= it
->hpos
;
8629 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8631 new_x
= x
+ single_glyph_width
;
8633 /* We want to leave anything reaching TO_X to the caller. */
8634 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8636 if (BUFFER_POS_REACHED_P ())
8638 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8639 goto buffer_pos_reached
;
8640 if (atpos_it
.sp
< 0)
8642 SAVE_IT (atpos_it
, *it
, atpos_data
);
8643 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8648 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8651 result
= MOVE_X_REACHED
;
8656 SAVE_IT (atx_it
, *it
, atx_data
);
8657 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8662 if (/* Lines are continued. */
8663 it
->line_wrap
!= TRUNCATE
8664 && (/* And glyph doesn't fit on the line. */
8665 new_x
> it
->last_visible_x
8666 /* Or it fits exactly and we're on a window
8668 || (new_x
== it
->last_visible_x
8669 && FRAME_WINDOW_P (it
->f
)
8670 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8671 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8672 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8674 if (/* IT->hpos == 0 means the very first glyph
8675 doesn't fit on the line, e.g. a wide image. */
8677 || (new_x
== it
->last_visible_x
8678 && FRAME_WINDOW_P (it
->f
)))
8681 it
->current_x
= new_x
;
8683 /* The character's last glyph just barely fits
8685 if (i
== it
->nglyphs
- 1)
8687 /* If this is the destination position,
8688 return a position *before* it in this row,
8689 now that we know it fits in this row. */
8690 if (BUFFER_POS_REACHED_P ())
8692 if (it
->line_wrap
!= WORD_WRAP
8694 /* If we've just found whitespace to
8695 wrap, effectively ignore the
8696 previous wrap point -- it is no
8697 longer relevant, but we won't
8698 have an opportunity to update it,
8699 since we've reached the edge of
8700 this screen line. */
8702 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8704 it
->hpos
= hpos_before_this_char
;
8705 it
->current_x
= x_before_this_char
;
8706 result
= MOVE_POS_MATCH_OR_ZV
;
8709 if (it
->line_wrap
== WORD_WRAP
8712 SAVE_IT (atpos_it
, *it
, atpos_data
);
8713 atpos_it
.current_x
= x_before_this_char
;
8714 atpos_it
.hpos
= hpos_before_this_char
;
8718 prev_method
= it
->method
;
8719 if (it
->method
== GET_FROM_BUFFER
)
8720 prev_pos
= IT_CHARPOS (*it
);
8721 set_iterator_to_next (it
, true);
8722 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8723 SET_TEXT_POS (this_line_min_pos
,
8724 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8725 /* On graphical terminals, newlines may
8726 "overflow" into the fringe if
8727 overflow-newline-into-fringe is non-nil.
8728 On text terminals, and on graphical
8729 terminals with no right margin, newlines
8730 may overflow into the last glyph on the
8732 if (!FRAME_WINDOW_P (it
->f
)
8734 && it
->bidi_it
.paragraph_dir
== R2L
)
8735 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8736 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8737 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8739 if (!get_next_display_element (it
))
8741 result
= MOVE_POS_MATCH_OR_ZV
;
8744 if (BUFFER_POS_REACHED_P ())
8746 if (ITERATOR_AT_END_OF_LINE_P (it
))
8747 result
= MOVE_POS_MATCH_OR_ZV
;
8749 result
= MOVE_LINE_CONTINUED
;
8752 if (ITERATOR_AT_END_OF_LINE_P (it
)
8753 && (it
->line_wrap
!= WORD_WRAP
8755 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8757 result
= MOVE_NEWLINE_OR_CR
;
8764 IT_RESET_X_ASCENT_DESCENT (it
);
8766 /* If the screen line ends with whitespace, and we
8767 are under word-wrap, don't use wrap_it: it is no
8768 longer relevant, but we won't have an opportunity
8769 to update it, since we are done with this screen
8771 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8773 /* If we've found TO_X, go back there, as we now
8774 know the last word fits on this screen line. */
8775 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8778 RESTORE_IT (it
, &atx_it
, atx_data
);
8781 result
= MOVE_X_REACHED
;
8785 else if (wrap_it
.sp
>= 0)
8787 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8792 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8794 result
= MOVE_LINE_CONTINUED
;
8798 if (BUFFER_POS_REACHED_P ())
8800 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8801 goto buffer_pos_reached
;
8802 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8804 SAVE_IT (atpos_it
, *it
, atpos_data
);
8805 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8809 if (new_x
> it
->first_visible_x
)
8811 /* Glyph is visible. Increment number of glyphs that
8812 would be displayed. */
8817 if (result
!= MOVE_UNDEFINED
)
8820 else if (BUFFER_POS_REACHED_P ())
8823 IT_RESET_X_ASCENT_DESCENT (it
);
8824 result
= MOVE_POS_MATCH_OR_ZV
;
8827 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8829 /* Stop when TO_X specified and reached. This check is
8830 necessary here because of lines consisting of a line end,
8831 only. The line end will not produce any glyphs and we
8832 would never get MOVE_X_REACHED. */
8833 eassert (it
->nglyphs
== 0);
8834 result
= MOVE_X_REACHED
;
8838 /* Is this a line end? If yes, we're done. */
8839 if (ITERATOR_AT_END_OF_LINE_P (it
))
8841 /* If we are past TO_CHARPOS, but never saw any character
8842 positions smaller than TO_CHARPOS, return
8843 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8845 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8847 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8849 if (closest_pos
< ZV
)
8851 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8852 /* Don't recurse if closest_pos is equal to
8853 to_charpos, since we have just tried that. */
8854 if (closest_pos
!= to_charpos
)
8855 move_it_in_display_line_to (it
, closest_pos
, -1,
8857 result
= MOVE_POS_MATCH_OR_ZV
;
8860 goto buffer_pos_reached
;
8862 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8863 && IT_CHARPOS (*it
) > to_charpos
)
8864 goto buffer_pos_reached
;
8866 result
= MOVE_NEWLINE_OR_CR
;
8869 result
= MOVE_NEWLINE_OR_CR
;
8873 prev_method
= it
->method
;
8874 if (it
->method
== GET_FROM_BUFFER
)
8875 prev_pos
= IT_CHARPOS (*it
);
8876 /* The current display element has been consumed. Advance
8878 set_iterator_to_next (it
, true);
8879 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8880 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8881 if (IT_CHARPOS (*it
) < to_charpos
)
8882 saw_smaller_pos
= true;
8884 && (op
& MOVE_TO_POS
)
8885 && IT_CHARPOS (*it
) >= to_charpos
8886 && IT_CHARPOS (*it
) < closest_pos
)
8887 closest_pos
= IT_CHARPOS (*it
);
8889 /* Stop if lines are truncated and IT's current x-position is
8890 past the right edge of the window now. */
8891 if (it
->line_wrap
== TRUNCATE
8892 && it
->current_x
>= it
->last_visible_x
)
8894 if (!FRAME_WINDOW_P (it
->f
)
8895 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8896 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8897 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8898 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8900 bool at_eob_p
= false;
8902 if ((at_eob_p
= !get_next_display_element (it
))
8903 || BUFFER_POS_REACHED_P ()
8904 /* If we are past TO_CHARPOS, but never saw any
8905 character positions smaller than TO_CHARPOS,
8906 return MOVE_POS_MATCH_OR_ZV, like the
8907 unidirectional display did. */
8908 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8910 && IT_CHARPOS (*it
) > to_charpos
))
8913 && !BUFFER_POS_REACHED_P ()
8914 && !at_eob_p
&& closest_pos
< ZV
)
8916 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8917 if (closest_pos
!= to_charpos
)
8918 move_it_in_display_line_to (it
, closest_pos
, -1,
8921 result
= MOVE_POS_MATCH_OR_ZV
;
8924 if (ITERATOR_AT_END_OF_LINE_P (it
))
8926 result
= MOVE_NEWLINE_OR_CR
;
8930 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8932 && IT_CHARPOS (*it
) > to_charpos
)
8934 if (closest_pos
< ZV
)
8936 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8937 if (closest_pos
!= to_charpos
)
8938 move_it_in_display_line_to (it
, closest_pos
, -1,
8941 result
= MOVE_POS_MATCH_OR_ZV
;
8944 result
= MOVE_LINE_TRUNCATED
;
8947 #undef IT_RESET_X_ASCENT_DESCENT
8950 #undef BUFFER_POS_REACHED_P
8952 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8953 restore the saved iterator. */
8954 if (atpos_it
.sp
>= 0)
8955 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8956 else if (atx_it
.sp
>= 0)
8957 RESTORE_IT (it
, &atx_it
, atx_data
);
8962 bidi_unshelve_cache (atpos_data
, true);
8964 bidi_unshelve_cache (atx_data
, true);
8966 bidi_unshelve_cache (wrap_data
, true);
8968 bidi_unshelve_cache (ppos_data
, true);
8970 /* Restore the iterator settings altered at the beginning of this
8972 it
->glyph_row
= saved_glyph_row
;
8976 /* For external use. */
8978 move_it_in_display_line (struct it
*it
,
8979 ptrdiff_t to_charpos
, int to_x
,
8980 enum move_operation_enum op
)
8982 if (it
->line_wrap
== WORD_WRAP
8983 && (op
& MOVE_TO_X
))
8986 void *save_data
= NULL
;
8989 SAVE_IT (save_it
, *it
, save_data
);
8990 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8991 /* When word-wrap is on, TO_X may lie past the end
8992 of a wrapped line. Then it->current is the
8993 character on the next line, so backtrack to the
8994 space before the wrap point. */
8995 if (skip
== MOVE_LINE_CONTINUED
)
8997 int prev_x
= max (it
->current_x
- 1, 0);
8998 RESTORE_IT (it
, &save_it
, save_data
);
8999 move_it_in_display_line_to
9000 (it
, -1, prev_x
, MOVE_TO_X
);
9003 bidi_unshelve_cache (save_data
, true);
9006 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9010 /* Move IT forward until it satisfies one or more of the criteria in
9011 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9013 OP is a bit-mask that specifies where to stop, and in particular,
9014 which of those four position arguments makes a difference. See the
9015 description of enum move_operation_enum.
9017 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9018 screen line, this function will set IT to the next position that is
9019 displayed to the right of TO_CHARPOS on the screen.
9021 Return the maximum pixel length of any line scanned but never more
9022 than it.last_visible_x. */
9025 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9027 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9028 int line_height
, line_start_x
= 0, reached
= 0;
9029 int max_current_x
= 0;
9030 void *backup_data
= NULL
;
9034 if (op
& MOVE_TO_VPOS
)
9036 /* If no TO_CHARPOS and no TO_X specified, stop at the
9037 start of the line TO_VPOS. */
9038 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9040 if (it
->vpos
== to_vpos
)
9046 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9050 /* TO_VPOS >= 0 means stop at TO_X in the line at
9051 TO_VPOS, or at TO_POS, whichever comes first. */
9052 if (it
->vpos
== to_vpos
)
9058 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9060 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9065 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9067 /* We have reached TO_X but not in the line we want. */
9068 skip
= move_it_in_display_line_to (it
, to_charpos
,
9070 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9078 else if (op
& MOVE_TO_Y
)
9080 struct it it_backup
;
9082 if (it
->line_wrap
== WORD_WRAP
)
9083 SAVE_IT (it_backup
, *it
, backup_data
);
9085 /* TO_Y specified means stop at TO_X in the line containing
9086 TO_Y---or at TO_CHARPOS if this is reached first. The
9087 problem is that we can't really tell whether the line
9088 contains TO_Y before we have completely scanned it, and
9089 this may skip past TO_X. What we do is to first scan to
9092 If TO_X is not specified, use a TO_X of zero. The reason
9093 is to make the outcome of this function more predictable.
9094 If we didn't use TO_X == 0, we would stop at the end of
9095 the line which is probably not what a caller would expect
9097 skip
= move_it_in_display_line_to
9098 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9099 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9101 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9102 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9104 else if (skip
== MOVE_X_REACHED
)
9106 /* If TO_X was reached, we want to know whether TO_Y is
9107 in the line. We know this is the case if the already
9108 scanned glyphs make the line tall enough. Otherwise,
9109 we must check by scanning the rest of the line. */
9110 line_height
= it
->max_ascent
+ it
->max_descent
;
9111 if (to_y
>= it
->current_y
9112 && to_y
< it
->current_y
+ line_height
)
9117 SAVE_IT (it_backup
, *it
, backup_data
);
9118 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9119 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9121 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9122 line_height
= it
->max_ascent
+ it
->max_descent
;
9123 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9125 if (to_y
>= it
->current_y
9126 && to_y
< it
->current_y
+ line_height
)
9128 /* If TO_Y is in this line and TO_X was reached
9129 above, we scanned too far. We have to restore
9130 IT's settings to the ones before skipping. But
9131 keep the more accurate values of max_ascent and
9132 max_descent we've found while skipping the rest
9133 of the line, for the sake of callers, such as
9134 pos_visible_p, that need to know the line
9136 int max_ascent
= it
->max_ascent
;
9137 int max_descent
= it
->max_descent
;
9139 RESTORE_IT (it
, &it_backup
, backup_data
);
9140 it
->max_ascent
= max_ascent
;
9141 it
->max_descent
= max_descent
;
9147 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9153 /* Check whether TO_Y is in this line. */
9154 line_height
= it
->max_ascent
+ it
->max_descent
;
9155 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9157 if (to_y
>= it
->current_y
9158 && to_y
< it
->current_y
+ line_height
)
9160 if (to_y
> it
->current_y
)
9161 max_current_x
= max (it
->current_x
, max_current_x
);
9163 /* When word-wrap is on, TO_X may lie past the end
9164 of a wrapped line. Then it->current is the
9165 character on the next line, so backtrack to the
9166 space before the wrap point. */
9167 if (skip
== MOVE_LINE_CONTINUED
9168 && it
->line_wrap
== WORD_WRAP
)
9170 int prev_x
= max (it
->current_x
- 1, 0);
9171 RESTORE_IT (it
, &it_backup
, backup_data
);
9172 skip
= move_it_in_display_line_to
9173 (it
, -1, prev_x
, MOVE_TO_X
);
9182 max_current_x
= max (it
->current_x
, max_current_x
);
9186 else if (BUFFERP (it
->object
)
9187 && (it
->method
== GET_FROM_BUFFER
9188 || it
->method
== GET_FROM_STRETCH
)
9189 && IT_CHARPOS (*it
) >= to_charpos
9190 /* Under bidi iteration, a call to set_iterator_to_next
9191 can scan far beyond to_charpos if the initial
9192 portion of the next line needs to be reordered. In
9193 that case, give move_it_in_display_line_to another
9196 && it
->bidi_it
.scan_dir
== -1))
9197 skip
= MOVE_POS_MATCH_OR_ZV
;
9199 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9203 case MOVE_POS_MATCH_OR_ZV
:
9204 max_current_x
= max (it
->current_x
, max_current_x
);
9208 case MOVE_NEWLINE_OR_CR
:
9209 max_current_x
= max (it
->current_x
, max_current_x
);
9210 set_iterator_to_next (it
, true);
9211 it
->continuation_lines_width
= 0;
9214 case MOVE_LINE_TRUNCATED
:
9215 max_current_x
= it
->last_visible_x
;
9216 it
->continuation_lines_width
= 0;
9217 reseat_at_next_visible_line_start (it
, false);
9218 if ((op
& MOVE_TO_POS
) != 0
9219 && IT_CHARPOS (*it
) > to_charpos
)
9226 case MOVE_LINE_CONTINUED
:
9227 max_current_x
= it
->last_visible_x
;
9228 /* For continued lines ending in a tab, some of the glyphs
9229 associated with the tab are displayed on the current
9230 line. Since it->current_x does not include these glyphs,
9231 we use it->last_visible_x instead. */
9234 it
->continuation_lines_width
+= it
->last_visible_x
;
9235 /* When moving by vpos, ensure that the iterator really
9236 advances to the next line (bug#847, bug#969). Fixme:
9237 do we need to do this in other circumstances? */
9238 if (it
->current_x
!= it
->last_visible_x
9239 && (op
& MOVE_TO_VPOS
)
9240 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9242 line_start_x
= it
->current_x
+ it
->pixel_width
9243 - it
->last_visible_x
;
9244 if (FRAME_WINDOW_P (it
->f
))
9246 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9247 struct font
*face_font
= face
->font
;
9249 /* When display_line produces a continued line
9250 that ends in a TAB, it skips a tab stop that
9251 is closer than the font's space character
9252 width (see x_produce_glyphs where it produces
9253 the stretch glyph which represents a TAB).
9254 We need to reproduce the same logic here. */
9255 eassert (face_font
);
9258 if (line_start_x
< face_font
->space_width
)
9260 += it
->tab_width
* face_font
->space_width
;
9263 set_iterator_to_next (it
, false);
9267 it
->continuation_lines_width
+= it
->current_x
;
9274 /* Reset/increment for the next run. */
9275 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9276 it
->current_x
= line_start_x
;
9279 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9281 last_height
= it
->max_ascent
+ it
->max_descent
;
9282 it
->max_ascent
= it
->max_descent
= 0;
9287 /* On text terminals, we may stop at the end of a line in the middle
9288 of a multi-character glyph. If the glyph itself is continued,
9289 i.e. it is actually displayed on the next line, don't treat this
9290 stopping point as valid; move to the next line instead (unless
9291 that brings us offscreen). */
9292 if (!FRAME_WINDOW_P (it
->f
)
9294 && IT_CHARPOS (*it
) == to_charpos
9295 && it
->what
== IT_CHARACTER
9297 && it
->line_wrap
== WINDOW_WRAP
9298 && it
->current_x
== it
->last_visible_x
- 1
9301 && it
->w
->window_end_valid
9302 && it
->vpos
< it
->w
->window_end_vpos
)
9304 it
->continuation_lines_width
+= it
->current_x
;
9305 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9306 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9308 last_height
= it
->max_ascent
+ it
->max_descent
;
9312 bidi_unshelve_cache (backup_data
, true);
9314 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9316 return max_current_x
;
9320 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9322 If DY > 0, move IT backward at least that many pixels. DY = 0
9323 means move IT backward to the preceding line start or BEGV. This
9324 function may move over more than DY pixels if IT->current_y - DY
9325 ends up in the middle of a line; in this case IT->current_y will be
9326 set to the top of the line moved to. */
9329 move_it_vertically_backward (struct it
*it
, int dy
)
9333 void *it2data
= NULL
, *it3data
= NULL
;
9334 ptrdiff_t start_pos
;
9336 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9337 ptrdiff_t pos_limit
;
9342 start_pos
= IT_CHARPOS (*it
);
9344 /* Estimate how many newlines we must move back. */
9345 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9346 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9349 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9351 /* Set the iterator's position that many lines back. But don't go
9352 back more than NLINES full screen lines -- this wins a day with
9353 buffers which have very long lines. */
9354 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9355 back_to_previous_visible_line_start (it
);
9357 /* Reseat the iterator here. When moving backward, we don't want
9358 reseat to skip forward over invisible text, set up the iterator
9359 to deliver from overlay strings at the new position etc. So,
9360 use reseat_1 here. */
9361 reseat_1 (it
, it
->current
.pos
, true);
9363 /* We are now surely at a line start. */
9364 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9365 reordering is in effect. */
9366 it
->continuation_lines_width
= 0;
9368 /* Move forward and see what y-distance we moved. First move to the
9369 start of the next line so that we get its height. We need this
9370 height to be able to tell whether we reached the specified
9372 SAVE_IT (it2
, *it
, it2data
);
9373 it2
.max_ascent
= it2
.max_descent
= 0;
9376 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9377 MOVE_TO_POS
| MOVE_TO_VPOS
);
9379 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9380 /* If we are in a display string which starts at START_POS,
9381 and that display string includes a newline, and we are
9382 right after that newline (i.e. at the beginning of a
9383 display line), exit the loop, because otherwise we will
9384 infloop, since move_it_to will see that it is already at
9385 START_POS and will not move. */
9386 || (it2
.method
== GET_FROM_STRING
9387 && IT_CHARPOS (it2
) == start_pos
9388 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9389 eassert (IT_CHARPOS (*it
) >= BEGV
);
9390 SAVE_IT (it3
, it2
, it3data
);
9392 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9393 eassert (IT_CHARPOS (*it
) >= BEGV
);
9394 /* H is the actual vertical distance from the position in *IT
9395 and the starting position. */
9396 h
= it2
.current_y
- it
->current_y
;
9397 /* NLINES is the distance in number of lines. */
9398 nlines
= it2
.vpos
- it
->vpos
;
9400 /* Correct IT's y and vpos position
9401 so that they are relative to the starting point. */
9407 /* DY == 0 means move to the start of the screen line. The
9408 value of nlines is > 0 if continuation lines were involved,
9409 or if the original IT position was at start of a line. */
9410 RESTORE_IT (it
, it
, it2data
);
9412 move_it_by_lines (it
, nlines
);
9413 /* The above code moves us to some position NLINES down,
9414 usually to its first glyph (leftmost in an L2R line), but
9415 that's not necessarily the start of the line, under bidi
9416 reordering. We want to get to the character position
9417 that is immediately after the newline of the previous
9420 && !it
->continuation_lines_width
9421 && !STRINGP (it
->string
)
9422 && IT_CHARPOS (*it
) > BEGV
9423 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9425 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9428 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9429 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9431 bidi_unshelve_cache (it3data
, true);
9435 /* The y-position we try to reach, relative to *IT.
9436 Note that H has been subtracted in front of the if-statement. */
9437 int target_y
= it
->current_y
+ h
- dy
;
9438 int y0
= it3
.current_y
;
9442 RESTORE_IT (&it3
, &it3
, it3data
);
9443 y1
= line_bottom_y (&it3
);
9444 line_height
= y1
- y0
;
9445 RESTORE_IT (it
, it
, it2data
);
9446 /* If we did not reach target_y, try to move further backward if
9447 we can. If we moved too far backward, try to move forward. */
9448 if (target_y
< it
->current_y
9449 /* This is heuristic. In a window that's 3 lines high, with
9450 a line height of 13 pixels each, recentering with point
9451 on the bottom line will try to move -39/2 = 19 pixels
9452 backward. Try to avoid moving into the first line. */
9453 && (it
->current_y
- target_y
9454 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9455 && IT_CHARPOS (*it
) > BEGV
)
9457 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9458 target_y
- it
->current_y
));
9459 dy
= it
->current_y
- target_y
;
9460 goto move_further_back
;
9462 else if (target_y
>= it
->current_y
+ line_height
9463 && IT_CHARPOS (*it
) < ZV
)
9465 /* Should move forward by at least one line, maybe more.
9467 Note: Calling move_it_by_lines can be expensive on
9468 terminal frames, where compute_motion is used (via
9469 vmotion) to do the job, when there are very long lines
9470 and truncate-lines is nil. That's the reason for
9471 treating terminal frames specially here. */
9473 if (!FRAME_WINDOW_P (it
->f
))
9474 move_it_vertically (it
, target_y
- it
->current_y
);
9479 move_it_by_lines (it
, 1);
9481 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9488 /* Move IT by a specified amount of pixel lines DY. DY negative means
9489 move backwards. DY = 0 means move to start of screen line. At the
9490 end, IT will be on the start of a screen line. */
9493 move_it_vertically (struct it
*it
, int dy
)
9496 move_it_vertically_backward (it
, -dy
);
9499 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9500 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9501 MOVE_TO_POS
| MOVE_TO_Y
);
9502 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9504 /* If buffer ends in ZV without a newline, move to the start of
9505 the line to satisfy the post-condition. */
9506 if (IT_CHARPOS (*it
) == ZV
9508 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9509 move_it_by_lines (it
, 0);
9514 /* Move iterator IT past the end of the text line it is in. */
9517 move_it_past_eol (struct it
*it
)
9519 enum move_it_result rc
;
9521 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9522 if (rc
== MOVE_NEWLINE_OR_CR
)
9523 set_iterator_to_next (it
, false);
9527 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9528 negative means move up. DVPOS == 0 means move to the start of the
9531 Optimization idea: If we would know that IT->f doesn't use
9532 a face with proportional font, we could be faster for
9533 truncate-lines nil. */
9536 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9539 /* The commented-out optimization uses vmotion on terminals. This
9540 gives bad results, because elements like it->what, on which
9541 callers such as pos_visible_p rely, aren't updated. */
9542 /* struct position pos;
9543 if (!FRAME_WINDOW_P (it->f))
9545 struct text_pos textpos;
9547 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9548 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9549 reseat (it, textpos, true);
9550 it->vpos += pos.vpos;
9551 it->current_y += pos.vpos;
9557 /* DVPOS == 0 means move to the start of the screen line. */
9558 move_it_vertically_backward (it
, 0);
9559 /* Let next call to line_bottom_y calculate real line height. */
9564 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9565 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9567 /* Only move to the next buffer position if we ended up in a
9568 string from display property, not in an overlay string
9569 (before-string or after-string). That is because the
9570 latter don't conceal the underlying buffer position, so
9571 we can ask to move the iterator to the exact position we
9572 are interested in. Note that, even if we are already at
9573 IT_CHARPOS (*it), the call below is not a no-op, as it
9574 will detect that we are at the end of the string, pop the
9575 iterator, and compute it->current_x and it->hpos
9577 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9578 -1, -1, -1, MOVE_TO_POS
);
9584 void *it2data
= NULL
;
9585 ptrdiff_t start_charpos
, i
;
9587 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9588 bool hit_pos_limit
= false;
9589 ptrdiff_t pos_limit
;
9591 /* Start at the beginning of the screen line containing IT's
9592 position. This may actually move vertically backwards,
9593 in case of overlays, so adjust dvpos accordingly. */
9595 move_it_vertically_backward (it
, 0);
9598 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9599 screen lines, and reseat the iterator there. */
9600 start_charpos
= IT_CHARPOS (*it
);
9601 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9604 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9606 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9607 back_to_previous_visible_line_start (it
);
9608 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9609 hit_pos_limit
= true;
9610 reseat (it
, it
->current
.pos
, true);
9612 /* Move further back if we end up in a string or an image. */
9613 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9615 /* First try to move to start of display line. */
9617 move_it_vertically_backward (it
, 0);
9619 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9621 /* If start of line is still in string or image,
9622 move further back. */
9623 back_to_previous_visible_line_start (it
);
9624 reseat (it
, it
->current
.pos
, true);
9628 it
->current_x
= it
->hpos
= 0;
9630 /* Above call may have moved too far if continuation lines
9631 are involved. Scan forward and see if it did. */
9632 SAVE_IT (it2
, *it
, it2data
);
9633 it2
.vpos
= it2
.current_y
= 0;
9634 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9635 it
->vpos
-= it2
.vpos
;
9636 it
->current_y
-= it2
.current_y
;
9637 it
->current_x
= it
->hpos
= 0;
9639 /* If we moved too far back, move IT some lines forward. */
9640 if (it2
.vpos
> -dvpos
)
9642 int delta
= it2
.vpos
+ dvpos
;
9644 RESTORE_IT (&it2
, &it2
, it2data
);
9645 SAVE_IT (it2
, *it
, it2data
);
9646 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9647 /* Move back again if we got too far ahead. */
9648 if (IT_CHARPOS (*it
) >= start_charpos
)
9649 RESTORE_IT (it
, &it2
, it2data
);
9651 bidi_unshelve_cache (it2data
, true);
9653 else if (hit_pos_limit
&& pos_limit
> BEGV
9654 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9656 /* If we hit the limit, but still didn't make it far enough
9657 back, that means there's a display string with a newline
9658 covering a large chunk of text, and that caused
9659 back_to_previous_visible_line_start try to go too far.
9660 Punish those who commit such atrocities by going back
9661 until we've reached DVPOS, after lifting the limit, which
9662 could make it slow for very long lines. "If it hurts,
9665 RESTORE_IT (it
, it
, it2data
);
9666 for (i
= -dvpos
; i
> 0; --i
)
9668 back_to_previous_visible_line_start (it
);
9671 reseat_1 (it
, it
->current
.pos
, true);
9674 RESTORE_IT (it
, it
, it2data
);
9678 /* Return true if IT points into the middle of a display vector. */
9681 in_display_vector_p (struct it
*it
)
9683 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9684 && it
->current
.dpvec_index
> 0
9685 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9688 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9689 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9690 WINDOW must be a live window and defaults to the selected one. The
9691 return value is a cons of the maximum pixel-width of any text line and
9692 the maximum pixel-height of all text lines.
9694 The optional argument FROM, if non-nil, specifies the first text
9695 position and defaults to the minimum accessible position of the buffer.
9696 If FROM is t, use the minimum accessible position that is not a newline
9697 character. TO, if non-nil, specifies the last text position and
9698 defaults to the maximum accessible position of the buffer. If TO is t,
9699 use the maximum accessible position that is not a newline character.
9701 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9702 width that can be returned. X-LIMIT nil or omitted, means to use the
9703 pixel-width of WINDOW's body; use this if you do not intend to change
9704 the width of WINDOW. Use the maximum width WINDOW may assume if you
9705 intend to change WINDOW's width. In any case, text whose x-coordinate
9706 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9707 can take some time, it's always a good idea to make this argument as
9708 small as possible; in particular, if the buffer contains long lines that
9709 shall be truncated anyway.
9711 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9712 height that can be returned. Text lines whose y-coordinate is beyond
9713 Y-LIMIT are ignored. Since calculating the text height of a large
9714 buffer can take some time, it makes sense to specify this argument if
9715 the size of the buffer is unknown.
9717 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9718 include the height of the mode- or header-line of WINDOW in the return
9719 value. If it is either the symbol `mode-line' or `header-line', include
9720 only the height of that line, if present, in the return value. If t,
9721 include the height of both, if present, in the return value. */)
9722 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9723 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9725 struct window
*w
= decode_live_window (window
);
9726 Lisp_Object buffer
= w
->contents
;
9729 struct buffer
*old_b
= NULL
;
9730 ptrdiff_t start
, end
, pos
;
9731 struct text_pos startp
;
9732 void *itdata
= NULL
;
9733 int c
, max_y
= -1, x
= 0, y
= 0;
9735 CHECK_BUFFER (buffer
);
9736 b
= XBUFFER (buffer
);
9738 if (b
!= current_buffer
)
9740 old_b
= current_buffer
;
9741 set_buffer_internal (b
);
9746 else if (EQ (from
, Qt
))
9749 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9750 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9752 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9757 CHECK_NUMBER_COERCE_MARKER (from
);
9758 start
= min (max (XINT (from
), BEGV
), ZV
);
9763 else if (EQ (to
, Qt
))
9766 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9767 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9769 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9774 CHECK_NUMBER_COERCE_MARKER (to
);
9775 end
= max (start
, min (XINT (to
), ZV
));
9778 if (!NILP (y_limit
))
9780 CHECK_NUMBER (y_limit
);
9781 max_y
= min (XINT (y_limit
), INT_MAX
);
9784 itdata
= bidi_shelve_cache ();
9785 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9786 start_display (&it
, w
, startp
);
9789 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9792 CHECK_NUMBER (x_limit
);
9793 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9794 /* Actually, we never want move_it_to stop at to_x. But to make
9795 sure that move_it_in_display_line_to always moves far enough,
9796 we set it to INT_MAX and specify MOVE_TO_X. */
9797 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9798 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9801 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9803 if (!EQ (mode_and_header_line
, Qheader_line
)
9804 && !EQ (mode_and_header_line
, Qt
))
9805 /* Do not count the header-line which was counted automatically by
9807 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9809 if (EQ (mode_and_header_line
, Qmode_line
)
9810 || EQ (mode_and_header_line
, Qt
))
9811 /* Do count the mode-line which is not included automatically by
9813 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9815 bidi_unshelve_cache (itdata
, false);
9818 set_buffer_internal (old_b
);
9820 return Fcons (make_number (x
), make_number (y
));
9823 /***********************************************************************
9825 ***********************************************************************/
9827 /* Return the number of arguments the format string FORMAT needs. */
9830 format_nargs (char const *format
)
9832 ptrdiff_t nargs
= 0;
9833 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
9841 /* Add a message with format string FORMAT and formatted arguments
9845 add_to_log (const char *format
, ...)
9848 va_start (ap
, format
);
9849 vadd_to_log (format
, ap
);
9854 vadd_to_log (char const *format
, va_list ap
)
9856 ptrdiff_t form_nargs
= format_nargs (format
);
9857 ptrdiff_t nargs
= 1 + form_nargs
;
9858 Lisp_Object args
[10];
9859 eassert (nargs
<= ARRAYELTS (args
));
9860 AUTO_STRING (args0
, format
);
9862 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
9863 args
[i
] = va_arg (ap
, Lisp_Object
);
9864 Lisp_Object msg
= Qnil
;
9865 msg
= Fformat_message (nargs
, args
);
9867 ptrdiff_t len
= SBYTES (msg
) + 1;
9869 char *buffer
= SAFE_ALLOCA (len
);
9870 memcpy (buffer
, SDATA (msg
), len
);
9872 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
9877 /* Output a newline in the *Messages* buffer if "needs" one. */
9880 message_log_maybe_newline (void)
9882 if (message_log_need_newline
)
9883 message_dolog ("", 0, true, false);
9887 /* Add a string M of length NBYTES to the message log, optionally
9888 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9889 true, means interpret the contents of M as multibyte. This
9890 function calls low-level routines in order to bypass text property
9891 hooks, etc. which might not be safe to run.
9893 This may GC (insert may run before/after change hooks),
9894 so the buffer M must NOT point to a Lisp string. */
9897 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9899 const unsigned char *msg
= (const unsigned char *) m
;
9901 if (!NILP (Vmemory_full
))
9904 if (!NILP (Vmessage_log_max
))
9906 struct buffer
*oldbuf
;
9907 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9908 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9909 ptrdiff_t point_at_end
= 0;
9910 ptrdiff_t zv_at_end
= 0;
9911 Lisp_Object old_deactivate_mark
;
9913 old_deactivate_mark
= Vdeactivate_mark
;
9914 oldbuf
= current_buffer
;
9916 /* Ensure the Messages buffer exists, and switch to it.
9917 If we created it, set the major-mode. */
9918 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
9919 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9921 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9922 call0 (intern ("messages-buffer-mode"));
9924 bset_undo_list (current_buffer
, Qt
);
9925 bset_cache_long_scans (current_buffer
, Qnil
);
9927 oldpoint
= message_dolog_marker1
;
9928 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9929 oldbegv
= message_dolog_marker2
;
9930 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9931 oldzv
= message_dolog_marker3
;
9932 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9940 BEGV_BYTE
= BEG_BYTE
;
9943 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9945 /* Insert the string--maybe converting multibyte to single byte
9946 or vice versa, so that all the text fits the buffer. */
9948 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9954 /* Convert a multibyte string to single-byte
9955 for the *Message* buffer. */
9956 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9958 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9959 work
[0] = CHAR_TO_BYTE8 (c
);
9960 insert_1_both (work
, 1, 1, true, false, false);
9963 else if (! multibyte
9964 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9968 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9969 /* Convert a single-byte string to multibyte
9970 for the *Message* buffer. */
9971 for (i
= 0; i
< nbytes
; i
++)
9974 MAKE_CHAR_MULTIBYTE (c
);
9975 char_bytes
= CHAR_STRING (c
, str
);
9976 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
9980 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
9981 true, false, false);
9985 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9988 insert_1_both ("\n", 1, 1, true, false, false);
9990 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
9992 this_bol_byte
= PT_BYTE
;
9994 /* See if this line duplicates the previous one.
9995 If so, combine duplicates. */
9998 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10000 prev_bol_byte
= PT_BYTE
;
10002 dups
= message_log_check_duplicate (prev_bol_byte
,
10006 del_range_both (prev_bol
, prev_bol_byte
,
10007 this_bol
, this_bol_byte
, false);
10010 char dupstr
[sizeof " [ times]"
10011 + INT_STRLEN_BOUND (printmax_t
)];
10013 /* If you change this format, don't forget to also
10014 change message_log_check_duplicate. */
10015 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10016 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10017 insert_1_both (dupstr
, duplen
, duplen
,
10018 true, false, true);
10023 /* If we have more than the desired maximum number of lines
10024 in the *Messages* buffer now, delete the oldest ones.
10025 This is safe because we don't have undo in this buffer. */
10027 if (NATNUMP (Vmessage_log_max
))
10029 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10030 -XFASTINT (Vmessage_log_max
) - 1, false);
10031 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10034 BEGV
= marker_position (oldbegv
);
10035 BEGV_BYTE
= marker_byte_position (oldbegv
);
10044 ZV
= marker_position (oldzv
);
10045 ZV_BYTE
= marker_byte_position (oldzv
);
10049 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10051 /* We can't do Fgoto_char (oldpoint) because it will run some
10053 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10054 marker_byte_position (oldpoint
));
10056 unchain_marker (XMARKER (oldpoint
));
10057 unchain_marker (XMARKER (oldbegv
));
10058 unchain_marker (XMARKER (oldzv
));
10060 /* We called insert_1_both above with its 5th argument (PREPARE)
10061 false, which prevents insert_1_both from calling
10062 prepare_to_modify_buffer, which in turns prevents us from
10063 incrementing windows_or_buffers_changed even if *Messages* is
10064 shown in some window. So we must manually set
10065 windows_or_buffers_changed here to make up for that. */
10066 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10067 bset_redisplay (current_buffer
);
10069 set_buffer_internal (oldbuf
);
10071 message_log_need_newline
= !nlflag
;
10072 Vdeactivate_mark
= old_deactivate_mark
;
10077 /* We are at the end of the buffer after just having inserted a newline.
10078 (Note: We depend on the fact we won't be crossing the gap.)
10079 Check to see if the most recent message looks a lot like the previous one.
10080 Return 0 if different, 1 if the new one should just replace it, or a
10081 value N > 1 if we should also append " [N times]". */
10084 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10087 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10088 bool seen_dots
= false;
10089 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10090 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10092 for (i
= 0; i
< len
; i
++)
10094 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10096 if (p1
[i
] != p2
[i
])
10102 if (*p1
++ == ' ' && *p1
++ == '[')
10105 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10106 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10113 /* Display an echo area message M with a specified length of NBYTES
10114 bytes. The string may include null characters. If M is not a
10115 string, clear out any existing message, and let the mini-buffer
10118 This function cancels echoing. */
10121 message3 (Lisp_Object m
)
10123 clear_message (true, true);
10126 /* First flush out any partial line written with print. */
10127 message_log_maybe_newline ();
10130 ptrdiff_t nbytes
= SBYTES (m
);
10131 bool multibyte
= STRING_MULTIBYTE (m
);
10134 SAFE_ALLOCA_STRING (buffer
, m
);
10135 message_dolog (buffer
, nbytes
, true, multibyte
);
10138 if (! inhibit_message
)
10139 message3_nolog (m
);
10142 /* Log the message M to stderr. Log an empty line if M is not a string. */
10145 message_to_stderr (Lisp_Object m
)
10147 if (noninteractive_need_newline
)
10149 noninteractive_need_newline
= false;
10150 fputc ('\n', stderr
);
10154 Lisp_Object s
= ENCODE_SYSTEM (m
);
10155 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10157 if (!cursor_in_echo_area
)
10158 fputc ('\n', stderr
);
10162 /* The non-logging version of message3.
10163 This does not cancel echoing, because it is used for echoing.
10164 Perhaps we need to make a separate function for echoing
10165 and make this cancel echoing. */
10168 message3_nolog (Lisp_Object m
)
10170 struct frame
*sf
= SELECTED_FRAME ();
10172 if (FRAME_INITIAL_P (sf
))
10173 message_to_stderr (m
);
10174 /* Error messages get reported properly by cmd_error, so this must be just an
10175 informative message; if the frame hasn't really been initialized yet, just
10177 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10179 /* Get the frame containing the mini-buffer
10180 that the selected frame is using. */
10181 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10182 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10183 struct frame
*f
= XFRAME (frame
);
10185 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10186 Fmake_frame_visible (frame
);
10188 if (STRINGP (m
) && SCHARS (m
) > 0)
10191 if (minibuffer_auto_raise
)
10192 Fraise_frame (frame
);
10193 /* Assume we are not echoing.
10194 (If we are, echo_now will override this.) */
10195 echo_message_buffer
= Qnil
;
10198 clear_message (true, true);
10200 do_pending_window_change (false);
10201 echo_area_display (true);
10202 do_pending_window_change (false);
10203 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10204 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10209 /* Display a null-terminated echo area message M. If M is 0, clear
10210 out any existing message, and let the mini-buffer text show through.
10212 The buffer M must continue to exist until after the echo area gets
10213 cleared or some other message gets displayed there. Do not pass
10214 text that is stored in a Lisp string. Do not pass text in a buffer
10215 that was alloca'd. */
10218 message1 (const char *m
)
10220 message3 (m
? build_unibyte_string (m
) : Qnil
);
10224 /* The non-logging counterpart of message1. */
10227 message1_nolog (const char *m
)
10229 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10232 /* Display a message M which contains a single %s
10233 which gets replaced with STRING. */
10236 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10238 CHECK_STRING (string
);
10241 if (noninteractive
)
10242 need_message
= !!m
;
10243 else if (!INTERACTIVE
)
10244 need_message
= false;
10247 /* The frame whose minibuffer we're going to display the message on.
10248 It may be larger than the selected frame, so we need
10249 to use its buffer, not the selected frame's buffer. */
10250 Lisp_Object mini_window
;
10251 struct frame
*f
, *sf
= SELECTED_FRAME ();
10253 /* Get the frame containing the minibuffer
10254 that the selected frame is using. */
10255 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10256 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10258 /* Error messages get reported properly by cmd_error, so this must be
10259 just an informative message; if the frame hasn't really been
10260 initialized yet, just toss it. */
10261 need_message
= f
->glyphs_initialized_p
;
10266 AUTO_STRING (fmt
, m
);
10267 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10269 if (noninteractive
)
10270 message_to_stderr (msg
);
10276 message3_nolog (msg
);
10278 /* Print should start at the beginning of the message
10279 buffer next time. */
10280 message_buf_print
= false;
10286 /* Dump an informative message to the minibuf. If M is 0, clear out
10287 any existing message, and let the mini-buffer text show through.
10289 The message must be safe ASCII and the format must not contain ` or
10290 '. If your message and format do not fit into this category,
10291 convert your arguments to Lisp objects and use Fmessage instead. */
10293 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10294 vmessage (const char *m
, va_list ap
)
10296 if (noninteractive
)
10300 if (noninteractive_need_newline
)
10301 putc ('\n', stderr
);
10302 noninteractive_need_newline
= false;
10303 vfprintf (stderr
, m
, ap
);
10304 if (!cursor_in_echo_area
)
10305 fprintf (stderr
, "\n");
10309 else if (INTERACTIVE
)
10311 /* The frame whose mini-buffer we're going to display the message
10312 on. It may be larger than the selected frame, so we need to
10313 use its buffer, not the selected frame's buffer. */
10314 Lisp_Object mini_window
;
10315 struct frame
*f
, *sf
= SELECTED_FRAME ();
10317 /* Get the frame containing the mini-buffer
10318 that the selected frame is using. */
10319 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10320 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10322 /* Error messages get reported properly by cmd_error, so this must be
10323 just an informative message; if the frame hasn't really been
10324 initialized yet, just toss it. */
10325 if (f
->glyphs_initialized_p
)
10330 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10332 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10334 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10336 message3 (make_string (message_buf
, len
));
10342 /* Print should start at the beginning of the message
10343 buffer next time. */
10344 message_buf_print
= false;
10350 message (const char *m
, ...)
10359 /* Display the current message in the current mini-buffer. This is
10360 only called from error handlers in process.c, and is not time
10364 update_echo_area (void)
10366 if (!NILP (echo_area_buffer
[0]))
10368 Lisp_Object string
;
10369 string
= Fcurrent_message ();
10375 /* Make sure echo area buffers in `echo_buffers' are live.
10376 If they aren't, make new ones. */
10379 ensure_echo_area_buffers (void)
10383 for (i
= 0; i
< 2; ++i
)
10384 if (!BUFFERP (echo_buffer
[i
])
10385 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10388 Lisp_Object old_buffer
;
10391 old_buffer
= echo_buffer
[i
];
10392 echo_buffer
[i
] = Fget_buffer_create
10393 (make_formatted_string (name
, " *Echo Area %d*", i
));
10394 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10395 /* to force word wrap in echo area -
10396 it was decided to postpone this*/
10397 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10399 for (j
= 0; j
< 2; ++j
)
10400 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10401 echo_area_buffer
[j
] = echo_buffer
[i
];
10406 /* Call FN with args A1..A2 with either the current or last displayed
10407 echo_area_buffer as current buffer.
10409 WHICH zero means use the current message buffer
10410 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10411 from echo_buffer[] and clear it.
10413 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10414 suitable buffer from echo_buffer[] and clear it.
10416 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10417 that the current message becomes the last displayed one, make
10418 choose a suitable buffer for echo_area_buffer[0], and clear it.
10420 Value is what FN returns. */
10423 with_echo_area_buffer (struct window
*w
, int which
,
10424 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10425 ptrdiff_t a1
, Lisp_Object a2
)
10427 Lisp_Object buffer
;
10428 bool this_one
, the_other
, clear_buffer_p
, rc
;
10429 ptrdiff_t count
= SPECPDL_INDEX ();
10431 /* If buffers aren't live, make new ones. */
10432 ensure_echo_area_buffers ();
10434 clear_buffer_p
= false;
10437 this_one
= false, the_other
= true;
10438 else if (which
> 0)
10439 this_one
= true, the_other
= false;
10442 this_one
= false, the_other
= true;
10443 clear_buffer_p
= true;
10445 /* We need a fresh one in case the current echo buffer equals
10446 the one containing the last displayed echo area message. */
10447 if (!NILP (echo_area_buffer
[this_one
])
10448 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10449 echo_area_buffer
[this_one
] = Qnil
;
10452 /* Choose a suitable buffer from echo_buffer[] is we don't
10454 if (NILP (echo_area_buffer
[this_one
]))
10456 echo_area_buffer
[this_one
]
10457 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10458 ? echo_buffer
[the_other
]
10459 : echo_buffer
[this_one
]);
10460 clear_buffer_p
= true;
10463 buffer
= echo_area_buffer
[this_one
];
10465 /* Don't get confused by reusing the buffer used for echoing
10466 for a different purpose. */
10467 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10470 record_unwind_protect (unwind_with_echo_area_buffer
,
10471 with_echo_area_buffer_unwind_data (w
));
10473 /* Make the echo area buffer current. Note that for display
10474 purposes, it is not necessary that the displayed window's buffer
10475 == current_buffer, except for text property lookup. So, let's
10476 only set that buffer temporarily here without doing a full
10477 Fset_window_buffer. We must also change w->pointm, though,
10478 because otherwise an assertions in unshow_buffer fails, and Emacs
10480 set_buffer_internal_1 (XBUFFER (buffer
));
10483 wset_buffer (w
, buffer
);
10484 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10485 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10488 bset_undo_list (current_buffer
, Qt
);
10489 bset_read_only (current_buffer
, Qnil
);
10490 specbind (Qinhibit_read_only
, Qt
);
10491 specbind (Qinhibit_modification_hooks
, Qt
);
10493 if (clear_buffer_p
&& Z
> BEG
)
10494 del_range (BEG
, Z
);
10496 eassert (BEGV
>= BEG
);
10497 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10501 eassert (BEGV
>= BEG
);
10502 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10504 unbind_to (count
, Qnil
);
10509 /* Save state that should be preserved around the call to the function
10510 FN called in with_echo_area_buffer. */
10513 with_echo_area_buffer_unwind_data (struct window
*w
)
10516 Lisp_Object vector
, tmp
;
10518 /* Reduce consing by keeping one vector in
10519 Vwith_echo_area_save_vector. */
10520 vector
= Vwith_echo_area_save_vector
;
10521 Vwith_echo_area_save_vector
= Qnil
;
10524 vector
= Fmake_vector (make_number (11), Qnil
);
10526 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10527 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10528 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10532 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10533 ASET (vector
, i
, w
->contents
); ++i
;
10534 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10535 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10536 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10537 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10538 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10539 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10544 for (; i
< end
; ++i
)
10545 ASET (vector
, i
, Qnil
);
10548 eassert (i
== ASIZE (vector
));
10553 /* Restore global state from VECTOR which was created by
10554 with_echo_area_buffer_unwind_data. */
10557 unwind_with_echo_area_buffer (Lisp_Object vector
)
10559 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10560 Vdeactivate_mark
= AREF (vector
, 1);
10561 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10563 if (WINDOWP (AREF (vector
, 3)))
10566 Lisp_Object buffer
;
10568 w
= XWINDOW (AREF (vector
, 3));
10569 buffer
= AREF (vector
, 4);
10571 wset_buffer (w
, buffer
);
10572 set_marker_both (w
->pointm
, buffer
,
10573 XFASTINT (AREF (vector
, 5)),
10574 XFASTINT (AREF (vector
, 6)));
10575 set_marker_both (w
->old_pointm
, buffer
,
10576 XFASTINT (AREF (vector
, 7)),
10577 XFASTINT (AREF (vector
, 8)));
10578 set_marker_both (w
->start
, buffer
,
10579 XFASTINT (AREF (vector
, 9)),
10580 XFASTINT (AREF (vector
, 10)));
10583 Vwith_echo_area_save_vector
= vector
;
10587 /* Set up the echo area for use by print functions. MULTIBYTE_P
10588 means we will print multibyte. */
10591 setup_echo_area_for_printing (bool multibyte_p
)
10593 /* If we can't find an echo area any more, exit. */
10594 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10595 Fkill_emacs (Qnil
);
10597 ensure_echo_area_buffers ();
10599 if (!message_buf_print
)
10601 /* A message has been output since the last time we printed.
10602 Choose a fresh echo area buffer. */
10603 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10604 echo_area_buffer
[0] = echo_buffer
[1];
10606 echo_area_buffer
[0] = echo_buffer
[0];
10608 /* Switch to that buffer and clear it. */
10609 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10610 bset_truncate_lines (current_buffer
, Qnil
);
10614 ptrdiff_t count
= SPECPDL_INDEX ();
10615 specbind (Qinhibit_read_only
, Qt
);
10616 /* Note that undo recording is always disabled. */
10617 del_range (BEG
, Z
);
10618 unbind_to (count
, Qnil
);
10620 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10622 /* Set up the buffer for the multibyteness we need. */
10624 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10625 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10627 /* Raise the frame containing the echo area. */
10628 if (minibuffer_auto_raise
)
10630 struct frame
*sf
= SELECTED_FRAME ();
10631 Lisp_Object mini_window
;
10632 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10633 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10636 message_log_maybe_newline ();
10637 message_buf_print
= true;
10641 if (NILP (echo_area_buffer
[0]))
10643 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10644 echo_area_buffer
[0] = echo_buffer
[1];
10646 echo_area_buffer
[0] = echo_buffer
[0];
10649 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10651 /* Someone switched buffers between print requests. */
10652 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10653 bset_truncate_lines (current_buffer
, Qnil
);
10659 /* Display an echo area message in window W. Value is true if W's
10660 height is changed. If display_last_displayed_message_p,
10661 display the message that was last displayed, otherwise
10662 display the current message. */
10665 display_echo_area (struct window
*w
)
10667 bool no_message_p
, window_height_changed_p
;
10669 /* Temporarily disable garbage collections while displaying the echo
10670 area. This is done because a GC can print a message itself.
10671 That message would modify the echo area buffer's contents while a
10672 redisplay of the buffer is going on, and seriously confuse
10674 ptrdiff_t count
= inhibit_garbage_collection ();
10676 /* If there is no message, we must call display_echo_area_1
10677 nevertheless because it resizes the window. But we will have to
10678 reset the echo_area_buffer in question to nil at the end because
10679 with_echo_area_buffer will sets it to an empty buffer. */
10680 bool i
= display_last_displayed_message_p
;
10681 no_message_p
= NILP (echo_area_buffer
[i
]);
10683 window_height_changed_p
10684 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10685 display_echo_area_1
,
10686 (intptr_t) w
, Qnil
);
10689 echo_area_buffer
[i
] = Qnil
;
10691 unbind_to (count
, Qnil
);
10692 return window_height_changed_p
;
10696 /* Helper for display_echo_area. Display the current buffer which
10697 contains the current echo area message in window W, a mini-window,
10698 a pointer to which is passed in A1. A2..A4 are currently not used.
10699 Change the height of W so that all of the message is displayed.
10700 Value is true if height of W was changed. */
10703 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10706 struct window
*w
= (struct window
*) i1
;
10707 Lisp_Object window
;
10708 struct text_pos start
;
10710 /* We are about to enter redisplay without going through
10711 redisplay_internal, so we need to forget these faces by hand
10713 forget_escape_and_glyphless_faces ();
10715 /* Do this before displaying, so that we have a large enough glyph
10716 matrix for the display. If we can't get enough space for the
10717 whole text, display the last N lines. That works by setting w->start. */
10718 bool window_height_changed_p
= resize_mini_window (w
, false);
10720 /* Use the starting position chosen by resize_mini_window. */
10721 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10724 clear_glyph_matrix (w
->desired_matrix
);
10725 XSETWINDOW (window
, w
);
10726 try_window (window
, start
, 0);
10728 return window_height_changed_p
;
10732 /* Resize the echo area window to exactly the size needed for the
10733 currently displayed message, if there is one. If a mini-buffer
10734 is active, don't shrink it. */
10737 resize_echo_area_exactly (void)
10739 if (BUFFERP (echo_area_buffer
[0])
10740 && WINDOWP (echo_area_window
))
10742 struct window
*w
= XWINDOW (echo_area_window
);
10743 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10744 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10745 (intptr_t) w
, resize_exactly
);
10748 windows_or_buffers_changed
= 42;
10749 update_mode_lines
= 30;
10750 redisplay_internal ();
10756 /* Callback function for with_echo_area_buffer, when used from
10757 resize_echo_area_exactly. A1 contains a pointer to the window to
10758 resize, EXACTLY non-nil means resize the mini-window exactly to the
10759 size of the text displayed. A3 and A4 are not used. Value is what
10760 resize_mini_window returns. */
10763 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10766 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10770 /* Resize mini-window W to fit the size of its contents. EXACT_P
10771 means size the window exactly to the size needed. Otherwise, it's
10772 only enlarged until W's buffer is empty.
10774 Set W->start to the right place to begin display. If the whole
10775 contents fit, start at the beginning. Otherwise, start so as
10776 to make the end of the contents appear. This is particularly
10777 important for y-or-n-p, but seems desirable generally.
10779 Value is true if the window height has been changed. */
10782 resize_mini_window (struct window
*w
, bool exact_p
)
10784 struct frame
*f
= XFRAME (w
->frame
);
10785 bool window_height_changed_p
= false;
10787 eassert (MINI_WINDOW_P (w
));
10789 /* By default, start display at the beginning. */
10790 set_marker_both (w
->start
, w
->contents
,
10791 BUF_BEGV (XBUFFER (w
->contents
)),
10792 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10794 /* Don't resize windows while redisplaying a window; it would
10795 confuse redisplay functions when the size of the window they are
10796 displaying changes from under them. Such a resizing can happen,
10797 for instance, when which-func prints a long message while
10798 we are running fontification-functions. We're running these
10799 functions with safe_call which binds inhibit-redisplay to t. */
10800 if (!NILP (Vinhibit_redisplay
))
10803 /* Nil means don't try to resize. */
10804 if (NILP (Vresize_mini_windows
)
10805 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10808 if (!FRAME_MINIBUF_ONLY_P (f
))
10811 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10812 + WINDOW_PIXEL_HEIGHT (w
));
10813 int unit
= FRAME_LINE_HEIGHT (f
);
10814 int height
, max_height
;
10815 struct text_pos start
;
10816 struct buffer
*old_current_buffer
= NULL
;
10818 if (current_buffer
!= XBUFFER (w
->contents
))
10820 old_current_buffer
= current_buffer
;
10821 set_buffer_internal (XBUFFER (w
->contents
));
10824 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10826 /* Compute the max. number of lines specified by the user. */
10827 if (FLOATP (Vmax_mini_window_height
))
10828 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10829 else if (INTEGERP (Vmax_mini_window_height
))
10830 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10832 max_height
= total_height
/ 4;
10834 /* Correct that max. height if it's bogus. */
10835 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10837 /* Find out the height of the text in the window. */
10838 if (it
.line_wrap
== TRUNCATE
)
10843 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10844 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10845 height
= it
.current_y
+ last_height
;
10847 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10848 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10851 /* Compute a suitable window start. */
10852 if (height
> max_height
)
10854 height
= (max_height
/ unit
) * unit
;
10855 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10856 move_it_vertically_backward (&it
, height
- unit
);
10857 start
= it
.current
.pos
;
10860 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10861 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10863 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10865 /* Let it grow only, until we display an empty message, in which
10866 case the window shrinks again. */
10867 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10869 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10871 FRAME_WINDOWS_FROZEN (f
) = true;
10872 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10873 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10875 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10876 && (exact_p
|| BEGV
== ZV
))
10878 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10880 FRAME_WINDOWS_FROZEN (f
) = false;
10881 shrink_mini_window (w
, true);
10882 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10887 /* Always resize to exact size needed. */
10888 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10890 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10892 FRAME_WINDOWS_FROZEN (f
) = true;
10893 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10894 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10896 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10898 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10900 FRAME_WINDOWS_FROZEN (f
) = false;
10901 shrink_mini_window (w
, true);
10905 FRAME_WINDOWS_FROZEN (f
) = true;
10906 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10909 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10913 if (old_current_buffer
)
10914 set_buffer_internal (old_current_buffer
);
10917 return window_height_changed_p
;
10921 /* Value is the current message, a string, or nil if there is no
10922 current message. */
10925 current_message (void)
10929 if (!BUFFERP (echo_area_buffer
[0]))
10933 with_echo_area_buffer (0, 0, current_message_1
,
10934 (intptr_t) &msg
, Qnil
);
10936 echo_area_buffer
[0] = Qnil
;
10944 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10947 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10950 *msg
= make_buffer_string (BEG
, Z
, true);
10957 /* Push the current message on Vmessage_stack for later restoration
10958 by restore_message. Value is true if the current message isn't
10959 empty. This is a relatively infrequent operation, so it's not
10960 worth optimizing. */
10963 push_message (void)
10965 Lisp_Object msg
= current_message ();
10966 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10967 return STRINGP (msg
);
10971 /* Restore message display from the top of Vmessage_stack. */
10974 restore_message (void)
10976 eassert (CONSP (Vmessage_stack
));
10977 message3_nolog (XCAR (Vmessage_stack
));
10981 /* Handler for unwind-protect calling pop_message. */
10984 pop_message_unwind (void)
10986 /* Pop the top-most entry off Vmessage_stack. */
10987 eassert (CONSP (Vmessage_stack
));
10988 Vmessage_stack
= XCDR (Vmessage_stack
);
10992 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10993 exits. If the stack is not empty, we have a missing pop_message
10997 check_message_stack (void)
10999 if (!NILP (Vmessage_stack
))
11004 /* Truncate to NCHARS what will be displayed in the echo area the next
11005 time we display it---but don't redisplay it now. */
11008 truncate_echo_area (ptrdiff_t nchars
)
11011 echo_area_buffer
[0] = Qnil
;
11012 else if (!noninteractive
11014 && !NILP (echo_area_buffer
[0]))
11016 struct frame
*sf
= SELECTED_FRAME ();
11017 /* Error messages get reported properly by cmd_error, so this must be
11018 just an informative message; if the frame hasn't really been
11019 initialized yet, just toss it. */
11020 if (sf
->glyphs_initialized_p
)
11021 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11026 /* Helper function for truncate_echo_area. Truncate the current
11027 message to at most NCHARS characters. */
11030 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11032 if (BEG
+ nchars
< Z
)
11033 del_range (BEG
+ nchars
, Z
);
11035 echo_area_buffer
[0] = Qnil
;
11039 /* Set the current message to STRING. */
11042 set_message (Lisp_Object string
)
11044 eassert (STRINGP (string
));
11046 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11048 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11049 message_buf_print
= false;
11050 help_echo_showing_p
= false;
11052 if (STRINGP (Vdebug_on_message
)
11053 && STRINGP (string
)
11054 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11055 call_debugger (list2 (Qerror
, string
));
11059 /* Helper function for set_message. First argument is ignored and second
11060 argument has the same meaning as for set_message.
11061 This function is called with the echo area buffer being current. */
11064 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11066 eassert (STRINGP (string
));
11068 /* Change multibyteness of the echo buffer appropriately. */
11069 if (message_enable_multibyte
11070 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11071 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11073 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11074 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11075 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11077 /* Insert new message at BEG. */
11078 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11080 /* This function takes care of single/multibyte conversion.
11081 We just have to ensure that the echo area buffer has the right
11082 setting of enable_multibyte_characters. */
11083 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11089 /* Clear messages. CURRENT_P means clear the current message.
11090 LAST_DISPLAYED_P means clear the message last displayed. */
11093 clear_message (bool current_p
, bool last_displayed_p
)
11097 echo_area_buffer
[0] = Qnil
;
11098 message_cleared_p
= true;
11101 if (last_displayed_p
)
11102 echo_area_buffer
[1] = Qnil
;
11104 message_buf_print
= false;
11107 /* Clear garbaged frames.
11109 This function is used where the old redisplay called
11110 redraw_garbaged_frames which in turn called redraw_frame which in
11111 turn called clear_frame. The call to clear_frame was a source of
11112 flickering. I believe a clear_frame is not necessary. It should
11113 suffice in the new redisplay to invalidate all current matrices,
11114 and ensure a complete redisplay of all windows. */
11117 clear_garbaged_frames (void)
11119 if (frame_garbaged
)
11121 Lisp_Object tail
, frame
;
11123 FOR_EACH_FRAME (tail
, frame
)
11125 struct frame
*f
= XFRAME (frame
);
11127 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11132 clear_current_matrices (f
);
11133 fset_redisplay (f
);
11134 f
->garbaged
= false;
11135 f
->resized_p
= false;
11139 frame_garbaged
= false;
11144 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11148 echo_area_display (bool update_frame_p
)
11150 Lisp_Object mini_window
;
11153 bool window_height_changed_p
= false;
11154 struct frame
*sf
= SELECTED_FRAME ();
11156 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11157 w
= XWINDOW (mini_window
);
11158 f
= XFRAME (WINDOW_FRAME (w
));
11160 /* Don't display if frame is invisible or not yet initialized. */
11161 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11164 #ifdef HAVE_WINDOW_SYSTEM
11165 /* When Emacs starts, selected_frame may be the initial terminal
11166 frame. If we let this through, a message would be displayed on
11168 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11170 #endif /* HAVE_WINDOW_SYSTEM */
11172 /* Redraw garbaged frames. */
11173 clear_garbaged_frames ();
11175 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11177 echo_area_window
= mini_window
;
11178 window_height_changed_p
= display_echo_area (w
);
11179 w
->must_be_updated_p
= true;
11181 /* Update the display, unless called from redisplay_internal.
11182 Also don't update the screen during redisplay itself. The
11183 update will happen at the end of redisplay, and an update
11184 here could cause confusion. */
11185 if (update_frame_p
&& !redisplaying_p
)
11189 /* If the display update has been interrupted by pending
11190 input, update mode lines in the frame. Due to the
11191 pending input, it might have been that redisplay hasn't
11192 been called, so that mode lines above the echo area are
11193 garbaged. This looks odd, so we prevent it here. */
11194 if (!display_completed
)
11195 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11197 if (window_height_changed_p
11198 /* Don't do this if Emacs is shutting down. Redisplay
11199 needs to run hooks. */
11200 && !NILP (Vrun_hooks
))
11202 /* Must update other windows. Likewise as in other
11203 cases, don't let this update be interrupted by
11205 ptrdiff_t count
= SPECPDL_INDEX ();
11206 specbind (Qredisplay_dont_pause
, Qt
);
11207 fset_redisplay (f
);
11208 redisplay_internal ();
11209 unbind_to (count
, Qnil
);
11211 else if (FRAME_WINDOW_P (f
) && n
== 0)
11213 /* Window configuration is the same as before.
11214 Can do with a display update of the echo area,
11215 unless we displayed some mode lines. */
11216 update_single_window (w
);
11220 update_frame (f
, true, true);
11222 /* If cursor is in the echo area, make sure that the next
11223 redisplay displays the minibuffer, so that the cursor will
11224 be replaced with what the minibuffer wants. */
11225 if (cursor_in_echo_area
)
11226 wset_redisplay (XWINDOW (mini_window
));
11229 else if (!EQ (mini_window
, selected_window
))
11230 wset_redisplay (XWINDOW (mini_window
));
11232 /* Last displayed message is now the current message. */
11233 echo_area_buffer
[1] = echo_area_buffer
[0];
11234 /* Inform read_char that we're not echoing. */
11235 echo_message_buffer
= Qnil
;
11237 /* Prevent redisplay optimization in redisplay_internal by resetting
11238 this_line_start_pos. This is done because the mini-buffer now
11239 displays the message instead of its buffer text. */
11240 if (EQ (mini_window
, selected_window
))
11241 CHARPOS (this_line_start_pos
) = 0;
11243 if (window_height_changed_p
)
11245 fset_redisplay (f
);
11247 /* If window configuration was changed, frames may have been
11248 marked garbaged. Clear them or we will experience
11249 surprises wrt scrolling.
11250 FIXME: How/why/when? */
11251 clear_garbaged_frames ();
11255 /* True if W's buffer was changed but not saved. */
11258 window_buffer_changed (struct window
*w
)
11260 struct buffer
*b
= XBUFFER (w
->contents
);
11262 eassert (BUFFER_LIVE_P (b
));
11264 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11267 /* True if W has %c in its mode line and mode line should be updated. */
11270 mode_line_update_needed (struct window
*w
)
11272 return (w
->column_number_displayed
!= -1
11273 && !(PT
== w
->last_point
&& !window_outdated (w
))
11274 && (w
->column_number_displayed
!= current_column ()));
11277 /* True if window start of W is frozen and may not be changed during
11281 window_frozen_p (struct window
*w
)
11283 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11285 Lisp_Object window
;
11287 XSETWINDOW (window
, w
);
11288 if (MINI_WINDOW_P (w
))
11290 else if (EQ (window
, selected_window
))
11292 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11293 && EQ (window
, Vminibuf_scroll_window
))
11294 /* This special window can't be frozen too. */
11302 /***********************************************************************
11303 Mode Lines and Frame Titles
11304 ***********************************************************************/
11306 /* A buffer for constructing non-propertized mode-line strings and
11307 frame titles in it; allocated from the heap in init_xdisp and
11308 resized as needed in store_mode_line_noprop_char. */
11310 static char *mode_line_noprop_buf
;
11312 /* The buffer's end, and a current output position in it. */
11314 static char *mode_line_noprop_buf_end
;
11315 static char *mode_line_noprop_ptr
;
11317 #define MODE_LINE_NOPROP_LEN(start) \
11318 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11321 MODE_LINE_DISPLAY
= 0,
11325 } mode_line_target
;
11327 /* Alist that caches the results of :propertize.
11328 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11329 static Lisp_Object mode_line_proptrans_alist
;
11331 /* List of strings making up the mode-line. */
11332 static Lisp_Object mode_line_string_list
;
11334 /* Base face property when building propertized mode line string. */
11335 static Lisp_Object mode_line_string_face
;
11336 static Lisp_Object mode_line_string_face_prop
;
11339 /* Unwind data for mode line strings */
11341 static Lisp_Object Vmode_line_unwind_vector
;
11344 format_mode_line_unwind_data (struct frame
*target_frame
,
11345 struct buffer
*obuf
,
11347 bool save_proptrans
)
11349 Lisp_Object vector
, tmp
;
11351 /* Reduce consing by keeping one vector in
11352 Vwith_echo_area_save_vector. */
11353 vector
= Vmode_line_unwind_vector
;
11354 Vmode_line_unwind_vector
= Qnil
;
11357 vector
= Fmake_vector (make_number (10), Qnil
);
11359 ASET (vector
, 0, make_number (mode_line_target
));
11360 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11361 ASET (vector
, 2, mode_line_string_list
);
11362 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11363 ASET (vector
, 4, mode_line_string_face
);
11364 ASET (vector
, 5, mode_line_string_face_prop
);
11367 XSETBUFFER (tmp
, obuf
);
11370 ASET (vector
, 6, tmp
);
11371 ASET (vector
, 7, owin
);
11374 /* Similarly to `with-selected-window', if the operation selects
11375 a window on another frame, we must restore that frame's
11376 selected window, and (for a tty) the top-frame. */
11377 ASET (vector
, 8, target_frame
->selected_window
);
11378 if (FRAME_TERMCAP_P (target_frame
))
11379 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11386 unwind_format_mode_line (Lisp_Object vector
)
11388 Lisp_Object old_window
= AREF (vector
, 7);
11389 Lisp_Object target_frame_window
= AREF (vector
, 8);
11390 Lisp_Object old_top_frame
= AREF (vector
, 9);
11392 mode_line_target
= XINT (AREF (vector
, 0));
11393 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11394 mode_line_string_list
= AREF (vector
, 2);
11395 if (! EQ (AREF (vector
, 3), Qt
))
11396 mode_line_proptrans_alist
= AREF (vector
, 3);
11397 mode_line_string_face
= AREF (vector
, 4);
11398 mode_line_string_face_prop
= AREF (vector
, 5);
11400 /* Select window before buffer, since it may change the buffer. */
11401 if (!NILP (old_window
))
11403 /* If the operation that we are unwinding had selected a window
11404 on a different frame, reset its frame-selected-window. For a
11405 text terminal, reset its top-frame if necessary. */
11406 if (!NILP (target_frame_window
))
11409 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11411 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11412 Fselect_window (target_frame_window
, Qt
);
11414 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11415 Fselect_frame (old_top_frame
, Qt
);
11418 Fselect_window (old_window
, Qt
);
11421 if (!NILP (AREF (vector
, 6)))
11423 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11424 ASET (vector
, 6, Qnil
);
11427 Vmode_line_unwind_vector
= vector
;
11431 /* Store a single character C for the frame title in mode_line_noprop_buf.
11432 Re-allocate mode_line_noprop_buf if necessary. */
11435 store_mode_line_noprop_char (char c
)
11437 /* If output position has reached the end of the allocated buffer,
11438 increase the buffer's size. */
11439 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11441 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11442 ptrdiff_t size
= len
;
11443 mode_line_noprop_buf
=
11444 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11445 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11446 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11449 *mode_line_noprop_ptr
++ = c
;
11453 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11454 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11455 characters that yield more columns than PRECISION; PRECISION <= 0
11456 means copy the whole string. Pad with spaces until FIELD_WIDTH
11457 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11458 pad. Called from display_mode_element when it is used to build a
11462 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11464 const unsigned char *str
= (const unsigned char *) string
;
11466 ptrdiff_t dummy
, nbytes
;
11468 /* Copy at most PRECISION chars from STR. */
11469 nbytes
= strlen (string
);
11470 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11472 store_mode_line_noprop_char (*str
++);
11474 /* Fill up with spaces until FIELD_WIDTH reached. */
11475 while (field_width
> 0
11476 && n
< field_width
)
11478 store_mode_line_noprop_char (' ');
11485 /***********************************************************************
11487 ***********************************************************************/
11489 #ifdef HAVE_WINDOW_SYSTEM
11491 /* Set the title of FRAME, if it has changed. The title format is
11492 Vicon_title_format if FRAME is iconified, otherwise it is
11493 frame_title_format. */
11496 x_consider_frame_title (Lisp_Object frame
)
11498 struct frame
*f
= XFRAME (frame
);
11500 if (FRAME_WINDOW_P (f
)
11501 || FRAME_MINIBUF_ONLY_P (f
)
11502 || f
->explicit_name
)
11504 /* Do we have more than one visible frame on this X display? */
11505 Lisp_Object tail
, other_frame
, fmt
;
11506 ptrdiff_t title_start
;
11510 ptrdiff_t count
= SPECPDL_INDEX ();
11512 FOR_EACH_FRAME (tail
, other_frame
)
11514 struct frame
*tf
= XFRAME (other_frame
);
11517 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11518 && !FRAME_MINIBUF_ONLY_P (tf
)
11519 && !EQ (other_frame
, tip_frame
)
11520 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11524 /* Set global variable indicating that multiple frames exist. */
11525 multiple_frames
= CONSP (tail
);
11527 /* Switch to the buffer of selected window of the frame. Set up
11528 mode_line_target so that display_mode_element will output into
11529 mode_line_noprop_buf; then display the title. */
11530 record_unwind_protect (unwind_format_mode_line
,
11531 format_mode_line_unwind_data
11532 (f
, current_buffer
, selected_window
, false));
11534 Fselect_window (f
->selected_window
, Qt
);
11535 set_buffer_internal_1
11536 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11537 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11539 mode_line_target
= MODE_LINE_TITLE
;
11540 title_start
= MODE_LINE_NOPROP_LEN (0);
11541 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11542 NULL
, DEFAULT_FACE_ID
);
11543 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11544 len
= MODE_LINE_NOPROP_LEN (title_start
);
11545 title
= mode_line_noprop_buf
+ title_start
;
11546 unbind_to (count
, Qnil
);
11548 /* Set the title only if it's changed. This avoids consing in
11549 the common case where it hasn't. (If it turns out that we've
11550 already wasted too much time by walking through the list with
11551 display_mode_element, then we might need to optimize at a
11552 higher level than this.) */
11553 if (! STRINGP (f
->name
)
11554 || SBYTES (f
->name
) != len
11555 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11556 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11560 #endif /* not HAVE_WINDOW_SYSTEM */
11563 /***********************************************************************
11565 ***********************************************************************/
11567 /* True if we will not redisplay all visible windows. */
11568 #define REDISPLAY_SOME_P() \
11569 ((windows_or_buffers_changed == 0 \
11570 || windows_or_buffers_changed == REDISPLAY_SOME) \
11571 && (update_mode_lines == 0 \
11572 || update_mode_lines == REDISPLAY_SOME))
11574 /* Prepare for redisplay by updating menu-bar item lists when
11575 appropriate. This can call eval. */
11578 prepare_menu_bars (void)
11580 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11581 bool some_windows
= REDISPLAY_SOME_P ();
11582 Lisp_Object tooltip_frame
;
11584 #ifdef HAVE_WINDOW_SYSTEM
11585 tooltip_frame
= tip_frame
;
11587 tooltip_frame
= Qnil
;
11590 if (FUNCTIONP (Vpre_redisplay_function
))
11592 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11593 if (all_windows
&& some_windows
)
11595 Lisp_Object ws
= window_list ();
11596 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11598 Lisp_Object
this = XCAR (ws
);
11599 struct window
*w
= XWINDOW (this);
11601 || XFRAME (w
->frame
)->redisplay
11602 || XBUFFER (w
->contents
)->text
->redisplay
)
11604 windows
= Fcons (this, windows
);
11608 safe__call1 (true, Vpre_redisplay_function
, windows
);
11611 /* Update all frame titles based on their buffer names, etc. We do
11612 this before the menu bars so that the buffer-menu will show the
11613 up-to-date frame titles. */
11614 #ifdef HAVE_WINDOW_SYSTEM
11617 Lisp_Object tail
, frame
;
11619 FOR_EACH_FRAME (tail
, frame
)
11621 struct frame
*f
= XFRAME (frame
);
11622 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11626 && !XBUFFER (w
->contents
)->text
->redisplay
)
11629 if (!EQ (frame
, tooltip_frame
)
11630 && (FRAME_ICONIFIED_P (f
)
11631 || FRAME_VISIBLE_P (f
) == 1
11632 /* Exclude TTY frames that are obscured because they
11633 are not the top frame on their console. This is
11634 because x_consider_frame_title actually switches
11635 to the frame, which for TTY frames means it is
11636 marked as garbaged, and will be completely
11637 redrawn on the next redisplay cycle. This causes
11638 TTY frames to be completely redrawn, when there
11639 are more than one of them, even though nothing
11640 should be changed on display. */
11641 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11642 x_consider_frame_title (frame
);
11645 #endif /* HAVE_WINDOW_SYSTEM */
11647 /* Update the menu bar item lists, if appropriate. This has to be
11648 done before any actual redisplay or generation of display lines. */
11652 Lisp_Object tail
, frame
;
11653 ptrdiff_t count
= SPECPDL_INDEX ();
11654 /* True means that update_menu_bar has run its hooks
11655 so any further calls to update_menu_bar shouldn't do so again. */
11656 bool menu_bar_hooks_run
= false;
11658 record_unwind_save_match_data ();
11660 FOR_EACH_FRAME (tail
, frame
)
11662 struct frame
*f
= XFRAME (frame
);
11663 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11665 /* Ignore tooltip frame. */
11666 if (EQ (frame
, tooltip_frame
))
11672 && !XBUFFER (w
->contents
)->text
->redisplay
)
11675 /* If a window on this frame changed size, report that to
11676 the user and clear the size-change flag. */
11677 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11679 Lisp_Object functions
;
11681 /* Clear flag first in case we get an error below. */
11682 FRAME_WINDOW_SIZES_CHANGED (f
) = false;
11683 functions
= Vwindow_size_change_functions
;
11685 while (CONSP (functions
))
11687 if (!EQ (XCAR (functions
), Qt
))
11688 call1 (XCAR (functions
), frame
);
11689 functions
= XCDR (functions
);
11693 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11694 #ifdef HAVE_WINDOW_SYSTEM
11695 update_tool_bar (f
, false);
11699 unbind_to (count
, Qnil
);
11703 struct frame
*sf
= SELECTED_FRAME ();
11704 update_menu_bar (sf
, true, false);
11705 #ifdef HAVE_WINDOW_SYSTEM
11706 update_tool_bar (sf
, true);
11712 /* Update the menu bar item list for frame F. This has to be done
11713 before we start to fill in any display lines, because it can call
11716 If SAVE_MATCH_DATA, we must save and restore it here.
11718 If HOOKS_RUN, a previous call to update_menu_bar
11719 already ran the menu bar hooks for this redisplay, so there
11720 is no need to run them again. The return value is the
11721 updated value of this flag, to pass to the next call. */
11724 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11726 Lisp_Object window
;
11729 /* If called recursively during a menu update, do nothing. This can
11730 happen when, for instance, an activate-menubar-hook causes a
11732 if (inhibit_menubar_update
)
11735 window
= FRAME_SELECTED_WINDOW (f
);
11736 w
= XWINDOW (window
);
11738 if (FRAME_WINDOW_P (f
)
11740 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11741 || defined (HAVE_NS) || defined (USE_GTK)
11742 FRAME_EXTERNAL_MENU_BAR (f
)
11744 FRAME_MENU_BAR_LINES (f
) > 0
11746 : FRAME_MENU_BAR_LINES (f
) > 0)
11748 /* If the user has switched buffers or windows, we need to
11749 recompute to reflect the new bindings. But we'll
11750 recompute when update_mode_lines is set too; that means
11751 that people can use force-mode-line-update to request
11752 that the menu bar be recomputed. The adverse effect on
11753 the rest of the redisplay algorithm is about the same as
11754 windows_or_buffers_changed anyway. */
11755 if (windows_or_buffers_changed
11756 /* This used to test w->update_mode_line, but we believe
11757 there is no need to recompute the menu in that case. */
11758 || update_mode_lines
11759 || window_buffer_changed (w
))
11761 struct buffer
*prev
= current_buffer
;
11762 ptrdiff_t count
= SPECPDL_INDEX ();
11764 specbind (Qinhibit_menubar_update
, Qt
);
11766 set_buffer_internal_1 (XBUFFER (w
->contents
));
11767 if (save_match_data
)
11768 record_unwind_save_match_data ();
11769 if (NILP (Voverriding_local_map_menu_flag
))
11771 specbind (Qoverriding_terminal_local_map
, Qnil
);
11772 specbind (Qoverriding_local_map
, Qnil
);
11777 /* Run the Lucid hook. */
11778 safe_run_hooks (Qactivate_menubar_hook
);
11780 /* If it has changed current-menubar from previous value,
11781 really recompute the menu-bar from the value. */
11782 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11783 call0 (Qrecompute_lucid_menubar
);
11785 safe_run_hooks (Qmenu_bar_update_hook
);
11790 XSETFRAME (Vmenu_updating_frame
, f
);
11791 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11793 /* Redisplay the menu bar in case we changed it. */
11794 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11795 || defined (HAVE_NS) || defined (USE_GTK)
11796 if (FRAME_WINDOW_P (f
))
11798 #if defined (HAVE_NS)
11799 /* All frames on Mac OS share the same menubar. So only
11800 the selected frame should be allowed to set it. */
11801 if (f
== SELECTED_FRAME ())
11803 set_frame_menubar (f
, false, false);
11806 /* On a terminal screen, the menu bar is an ordinary screen
11807 line, and this makes it get updated. */
11808 w
->update_mode_line
= true;
11809 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11810 /* In the non-toolkit version, the menu bar is an ordinary screen
11811 line, and this makes it get updated. */
11812 w
->update_mode_line
= true;
11813 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11815 unbind_to (count
, Qnil
);
11816 set_buffer_internal_1 (prev
);
11823 /***********************************************************************
11825 ***********************************************************************/
11827 #ifdef HAVE_WINDOW_SYSTEM
11829 /* Select `frame' temporarily without running all the code in
11831 FIXME: Maybe do_switch_frame should be trimmed down similarly
11832 when `norecord' is set. */
11834 fast_set_selected_frame (Lisp_Object frame
)
11836 if (!EQ (selected_frame
, frame
))
11838 selected_frame
= frame
;
11839 selected_window
= XFRAME (frame
)->selected_window
;
11843 /* Update the tool-bar item list for frame F. This has to be done
11844 before we start to fill in any display lines. Called from
11845 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11846 and restore it here. */
11849 update_tool_bar (struct frame
*f
, bool save_match_data
)
11851 #if defined (USE_GTK) || defined (HAVE_NS)
11852 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11854 bool do_update
= (WINDOWP (f
->tool_bar_window
)
11855 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11860 Lisp_Object window
;
11863 window
= FRAME_SELECTED_WINDOW (f
);
11864 w
= XWINDOW (window
);
11866 /* If the user has switched buffers or windows, we need to
11867 recompute to reflect the new bindings. But we'll
11868 recompute when update_mode_lines is set too; that means
11869 that people can use force-mode-line-update to request
11870 that the menu bar be recomputed. The adverse effect on
11871 the rest of the redisplay algorithm is about the same as
11872 windows_or_buffers_changed anyway. */
11873 if (windows_or_buffers_changed
11874 || w
->update_mode_line
11875 || update_mode_lines
11876 || window_buffer_changed (w
))
11878 struct buffer
*prev
= current_buffer
;
11879 ptrdiff_t count
= SPECPDL_INDEX ();
11880 Lisp_Object frame
, new_tool_bar
;
11881 int new_n_tool_bar
;
11883 /* Set current_buffer to the buffer of the selected
11884 window of the frame, so that we get the right local
11886 set_buffer_internal_1 (XBUFFER (w
->contents
));
11888 /* Save match data, if we must. */
11889 if (save_match_data
)
11890 record_unwind_save_match_data ();
11892 /* Make sure that we don't accidentally use bogus keymaps. */
11893 if (NILP (Voverriding_local_map_menu_flag
))
11895 specbind (Qoverriding_terminal_local_map
, Qnil
);
11896 specbind (Qoverriding_local_map
, Qnil
);
11899 /* We must temporarily set the selected frame to this frame
11900 before calling tool_bar_items, because the calculation of
11901 the tool-bar keymap uses the selected frame (see
11902 `tool-bar-make-keymap' in tool-bar.el). */
11903 eassert (EQ (selected_window
,
11904 /* Since we only explicitly preserve selected_frame,
11905 check that selected_window would be redundant. */
11906 XFRAME (selected_frame
)->selected_window
));
11907 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11908 XSETFRAME (frame
, f
);
11909 fast_set_selected_frame (frame
);
11911 /* Build desired tool-bar items from keymaps. */
11913 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11916 /* Redisplay the tool-bar if we changed it. */
11917 if (new_n_tool_bar
!= f
->n_tool_bar_items
11918 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11920 /* Redisplay that happens asynchronously due to an expose event
11921 may access f->tool_bar_items. Make sure we update both
11922 variables within BLOCK_INPUT so no such event interrupts. */
11924 fset_tool_bar_items (f
, new_tool_bar
);
11925 f
->n_tool_bar_items
= new_n_tool_bar
;
11926 w
->update_mode_line
= true;
11930 unbind_to (count
, Qnil
);
11931 set_buffer_internal_1 (prev
);
11936 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11938 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11939 F's desired tool-bar contents. F->tool_bar_items must have
11940 been set up previously by calling prepare_menu_bars. */
11943 build_desired_tool_bar_string (struct frame
*f
)
11945 int i
, size
, size_needed
;
11946 Lisp_Object image
, plist
;
11948 image
= plist
= Qnil
;
11950 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11951 Otherwise, make a new string. */
11953 /* The size of the string we might be able to reuse. */
11954 size
= (STRINGP (f
->desired_tool_bar_string
)
11955 ? SCHARS (f
->desired_tool_bar_string
)
11958 /* We need one space in the string for each image. */
11959 size_needed
= f
->n_tool_bar_items
;
11961 /* Reuse f->desired_tool_bar_string, if possible. */
11962 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11963 fset_desired_tool_bar_string
11964 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11967 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11968 Fremove_text_properties (make_number (0), make_number (size
),
11969 props
, f
->desired_tool_bar_string
);
11972 /* Put a `display' property on the string for the images to display,
11973 put a `menu_item' property on tool-bar items with a value that
11974 is the index of the item in F's tool-bar item vector. */
11975 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11977 #define PROP(IDX) \
11978 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11980 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11981 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11982 int hmargin
, vmargin
, relief
, idx
, end
;
11984 /* If image is a vector, choose the image according to the
11986 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11987 if (VECTORP (image
))
11991 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11992 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11995 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11996 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11998 eassert (ASIZE (image
) >= idx
);
11999 image
= AREF (image
, idx
);
12004 /* Ignore invalid image specifications. */
12005 if (!valid_image_p (image
))
12008 /* Display the tool-bar button pressed, or depressed. */
12009 plist
= Fcopy_sequence (XCDR (image
));
12011 /* Compute margin and relief to draw. */
12012 relief
= (tool_bar_button_relief
>= 0
12013 ? tool_bar_button_relief
12014 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12015 hmargin
= vmargin
= relief
;
12017 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12018 INT_MAX
- max (hmargin
, vmargin
)))
12020 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12021 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12023 else if (CONSP (Vtool_bar_button_margin
))
12025 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12026 INT_MAX
- hmargin
))
12027 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12029 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12030 INT_MAX
- vmargin
))
12031 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12034 if (auto_raise_tool_bar_buttons_p
)
12036 /* Add a `:relief' property to the image spec if the item is
12040 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12047 /* If image is selected, display it pressed, i.e. with a
12048 negative relief. If it's not selected, display it with a
12050 plist
= Fplist_put (plist
, QCrelief
,
12052 ? make_number (-relief
)
12053 : make_number (relief
)));
12058 /* Put a margin around the image. */
12059 if (hmargin
|| vmargin
)
12061 if (hmargin
== vmargin
)
12062 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12064 plist
= Fplist_put (plist
, QCmargin
,
12065 Fcons (make_number (hmargin
),
12066 make_number (vmargin
)));
12069 /* If button is not enabled, and we don't have special images
12070 for the disabled state, make the image appear disabled by
12071 applying an appropriate algorithm to it. */
12072 if (!enabled_p
&& idx
< 0)
12073 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12075 /* Put a `display' text property on the string for the image to
12076 display. Put a `menu-item' property on the string that gives
12077 the start of this item's properties in the tool-bar items
12079 image
= Fcons (Qimage
, plist
);
12080 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12081 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12083 /* Let the last image hide all remaining spaces in the tool bar
12084 string. The string can be longer than needed when we reuse a
12085 previous string. */
12086 if (i
+ 1 == f
->n_tool_bar_items
)
12087 end
= SCHARS (f
->desired_tool_bar_string
);
12090 Fadd_text_properties (make_number (i
), make_number (end
),
12091 props
, f
->desired_tool_bar_string
);
12097 /* Display one line of the tool-bar of frame IT->f.
12099 HEIGHT specifies the desired height of the tool-bar line.
12100 If the actual height of the glyph row is less than HEIGHT, the
12101 row's height is increased to HEIGHT, and the icons are centered
12102 vertically in the new height.
12104 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12105 count a final empty row in case the tool-bar width exactly matches
12110 display_tool_bar_line (struct it
*it
, int height
)
12112 struct glyph_row
*row
= it
->glyph_row
;
12113 int max_x
= it
->last_visible_x
;
12114 struct glyph
*last
;
12116 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12117 clear_glyph_row (row
);
12118 row
->enabled_p
= true;
12119 row
->y
= it
->current_y
;
12121 /* Note that this isn't made use of if the face hasn't a box,
12122 so there's no need to check the face here. */
12123 it
->start_of_box_run_p
= true;
12125 while (it
->current_x
< max_x
)
12127 int x
, n_glyphs_before
, i
, nglyphs
;
12128 struct it it_before
;
12130 /* Get the next display element. */
12131 if (!get_next_display_element (it
))
12133 /* Don't count empty row if we are counting needed tool-bar lines. */
12134 if (height
< 0 && !it
->hpos
)
12139 /* Produce glyphs. */
12140 n_glyphs_before
= row
->used
[TEXT_AREA
];
12143 PRODUCE_GLYPHS (it
);
12145 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12147 x
= it_before
.current_x
;
12148 while (i
< nglyphs
)
12150 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12152 if (x
+ glyph
->pixel_width
> max_x
)
12154 /* Glyph doesn't fit on line. Backtrack. */
12155 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12157 /* If this is the only glyph on this line, it will never fit on the
12158 tool-bar, so skip it. But ensure there is at least one glyph,
12159 so we don't accidentally disable the tool-bar. */
12160 if (n_glyphs_before
== 0
12161 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12167 x
+= glyph
->pixel_width
;
12171 /* Stop at line end. */
12172 if (ITERATOR_AT_END_OF_LINE_P (it
))
12175 set_iterator_to_next (it
, true);
12180 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12182 /* Use default face for the border below the tool bar.
12184 FIXME: When auto-resize-tool-bars is grow-only, there is
12185 no additional border below the possibly empty tool-bar lines.
12186 So to make the extra empty lines look "normal", we have to
12187 use the tool-bar face for the border too. */
12188 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12189 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12190 it
->face_id
= DEFAULT_FACE_ID
;
12192 extend_face_to_end_of_line (it
);
12193 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12194 last
->right_box_line_p
= true;
12195 if (last
== row
->glyphs
[TEXT_AREA
])
12196 last
->left_box_line_p
= true;
12198 /* Make line the desired height and center it vertically. */
12199 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12201 /* Don't add more than one line height. */
12202 height
%= FRAME_LINE_HEIGHT (it
->f
);
12203 it
->max_ascent
+= height
/ 2;
12204 it
->max_descent
+= (height
+ 1) / 2;
12207 compute_line_metrics (it
);
12209 /* If line is empty, make it occupy the rest of the tool-bar. */
12210 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12212 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12213 row
->visible_height
= row
->height
;
12214 row
->ascent
= row
->phys_ascent
= 0;
12215 row
->extra_line_spacing
= 0;
12218 row
->full_width_p
= true;
12219 row
->continued_p
= false;
12220 row
->truncated_on_left_p
= false;
12221 row
->truncated_on_right_p
= false;
12223 it
->current_x
= it
->hpos
= 0;
12224 it
->current_y
+= row
->height
;
12230 /* Value is the number of pixels needed to make all tool-bar items of
12231 frame F visible. The actual number of glyph rows needed is
12232 returned in *N_ROWS if non-NULL. */
12234 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12236 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12238 /* tool_bar_height is called from redisplay_tool_bar after building
12239 the desired matrix, so use (unused) mode-line row as temporary row to
12240 avoid destroying the first tool-bar row. */
12241 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12243 /* Initialize an iterator for iteration over
12244 F->desired_tool_bar_string in the tool-bar window of frame F. */
12245 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12246 temp_row
->reversed_p
= false;
12247 it
.first_visible_x
= 0;
12248 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12249 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12250 it
.paragraph_embedding
= L2R
;
12252 while (!ITERATOR_AT_END_P (&it
))
12254 clear_glyph_row (temp_row
);
12255 it
.glyph_row
= temp_row
;
12256 display_tool_bar_line (&it
, -1);
12258 clear_glyph_row (temp_row
);
12260 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12262 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12265 return it
.current_y
;
12267 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12270 #endif /* !USE_GTK && !HAVE_NS */
12272 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12274 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12275 If FRAME is nil or omitted, use the selected frame. Optional argument
12276 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12277 (Lisp_Object frame
, Lisp_Object pixelwise
)
12281 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12282 struct frame
*f
= decode_any_frame (frame
);
12284 if (WINDOWP (f
->tool_bar_window
)
12285 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12287 update_tool_bar (f
, true);
12288 if (f
->n_tool_bar_items
)
12290 build_desired_tool_bar_string (f
);
12291 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12296 return make_number (height
);
12300 /* Display the tool-bar of frame F. Value is true if tool-bar's
12301 height should be changed. */
12303 redisplay_tool_bar (struct frame
*f
)
12305 #if defined (USE_GTK) || defined (HAVE_NS)
12307 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12308 update_frame_tool_bar (f
);
12311 #else /* !USE_GTK && !HAVE_NS */
12315 struct glyph_row
*row
;
12317 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12318 do anything. This means you must start with tool-bar-lines
12319 non-zero to get the auto-sizing effect. Or in other words, you
12320 can turn off tool-bars by specifying tool-bar-lines zero. */
12321 if (!WINDOWP (f
->tool_bar_window
)
12322 || (w
= XWINDOW (f
->tool_bar_window
),
12323 WINDOW_TOTAL_LINES (w
) == 0))
12326 /* Set up an iterator for the tool-bar window. */
12327 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12328 it
.first_visible_x
= 0;
12329 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12330 row
= it
.glyph_row
;
12331 row
->reversed_p
= false;
12333 /* Build a string that represents the contents of the tool-bar. */
12334 build_desired_tool_bar_string (f
);
12335 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12336 /* FIXME: This should be controlled by a user option. But it
12337 doesn't make sense to have an R2L tool bar if the menu bar cannot
12338 be drawn also R2L, and making the menu bar R2L is tricky due
12339 toolkit-specific code that implements it. If an R2L tool bar is
12340 ever supported, display_tool_bar_line should also be augmented to
12341 call unproduce_glyphs like display_line and display_string
12343 it
.paragraph_embedding
= L2R
;
12345 if (f
->n_tool_bar_rows
== 0)
12347 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12349 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12351 x_change_tool_bar_height (f
, new_height
);
12352 frame_default_tool_bar_height
= new_height
;
12353 /* Always do that now. */
12354 clear_glyph_matrix (w
->desired_matrix
);
12355 f
->fonts_changed
= true;
12360 /* Display as many lines as needed to display all tool-bar items. */
12362 if (f
->n_tool_bar_rows
> 0)
12364 int border
, rows
, height
, extra
;
12366 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12367 border
= XINT (Vtool_bar_border
);
12368 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12369 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12370 else if (EQ (Vtool_bar_border
, Qborder_width
))
12371 border
= f
->border_width
;
12377 rows
= f
->n_tool_bar_rows
;
12378 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12379 extra
= it
.last_visible_y
- border
- height
* rows
;
12381 while (it
.current_y
< it
.last_visible_y
)
12384 if (extra
> 0 && rows
-- > 0)
12386 h
= (extra
+ rows
- 1) / rows
;
12389 display_tool_bar_line (&it
, height
+ h
);
12394 while (it
.current_y
< it
.last_visible_y
)
12395 display_tool_bar_line (&it
, 0);
12398 /* It doesn't make much sense to try scrolling in the tool-bar
12399 window, so don't do it. */
12400 w
->desired_matrix
->no_scrolling_p
= true;
12401 w
->must_be_updated_p
= true;
12403 if (!NILP (Vauto_resize_tool_bars
))
12405 bool change_height_p
= true;
12407 /* If we couldn't display everything, change the tool-bar's
12408 height if there is room for more. */
12409 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12410 change_height_p
= true;
12412 /* We subtract 1 because display_tool_bar_line advances the
12413 glyph_row pointer before returning to its caller. We want to
12414 examine the last glyph row produced by
12415 display_tool_bar_line. */
12416 row
= it
.glyph_row
- 1;
12418 /* If there are blank lines at the end, except for a partially
12419 visible blank line at the end that is smaller than
12420 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12421 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12422 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12423 change_height_p
= true;
12425 /* If row displays tool-bar items, but is partially visible,
12426 change the tool-bar's height. */
12427 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12428 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12429 change_height_p
= true;
12431 /* Resize windows as needed by changing the `tool-bar-lines'
12432 frame parameter. */
12433 if (change_height_p
)
12436 int new_height
= tool_bar_height (f
, &nrows
, true);
12438 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12439 && !f
->minimize_tool_bar_window_p
)
12440 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12441 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12442 f
->minimize_tool_bar_window_p
= false;
12444 if (change_height_p
)
12446 x_change_tool_bar_height (f
, new_height
);
12447 frame_default_tool_bar_height
= new_height
;
12448 clear_glyph_matrix (w
->desired_matrix
);
12449 f
->n_tool_bar_rows
= nrows
;
12450 f
->fonts_changed
= true;
12457 f
->minimize_tool_bar_window_p
= false;
12460 #endif /* USE_GTK || HAVE_NS */
12463 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12465 /* Get information about the tool-bar item which is displayed in GLYPH
12466 on frame F. Return in *PROP_IDX the index where tool-bar item
12467 properties start in F->tool_bar_items. Value is false if
12468 GLYPH doesn't display a tool-bar item. */
12471 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12476 /* This function can be called asynchronously, which means we must
12477 exclude any possibility that Fget_text_property signals an
12479 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12480 charpos
= max (0, charpos
);
12482 /* Get the text property `menu-item' at pos. The value of that
12483 property is the start index of this item's properties in
12484 F->tool_bar_items. */
12485 prop
= Fget_text_property (make_number (charpos
),
12486 Qmenu_item
, f
->current_tool_bar_string
);
12487 if (! INTEGERP (prop
))
12489 *prop_idx
= XINT (prop
);
12494 /* Get information about the tool-bar item at position X/Y on frame F.
12495 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12496 the current matrix of the tool-bar window of F, or NULL if not
12497 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12498 item in F->tool_bar_items. Value is
12500 -1 if X/Y is not on a tool-bar item
12501 0 if X/Y is on the same item that was highlighted before.
12505 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12506 int *hpos
, int *vpos
, int *prop_idx
)
12508 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12509 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12512 /* Find the glyph under X/Y. */
12513 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12514 if (*glyph
== NULL
)
12517 /* Get the start of this tool-bar item's properties in
12518 f->tool_bar_items. */
12519 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12522 /* Is mouse on the highlighted item? */
12523 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12524 && *vpos
>= hlinfo
->mouse_face_beg_row
12525 && *vpos
<= hlinfo
->mouse_face_end_row
12526 && (*vpos
> hlinfo
->mouse_face_beg_row
12527 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12528 && (*vpos
< hlinfo
->mouse_face_end_row
12529 || *hpos
< hlinfo
->mouse_face_end_col
12530 || hlinfo
->mouse_face_past_end
))
12538 Handle mouse button event on the tool-bar of frame F, at
12539 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12540 false for button release. MODIFIERS is event modifiers for button
12544 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12547 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12548 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12549 int hpos
, vpos
, prop_idx
;
12550 struct glyph
*glyph
;
12551 Lisp_Object enabled_p
;
12554 /* If not on the highlighted tool-bar item, and mouse-highlight is
12555 non-nil, return. This is so we generate the tool-bar button
12556 click only when the mouse button is released on the same item as
12557 where it was pressed. However, when mouse-highlight is disabled,
12558 generate the click when the button is released regardless of the
12559 highlight, since tool-bar items are not highlighted in that
12561 frame_to_window_pixel_xy (w
, &x
, &y
);
12562 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12564 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12567 /* When mouse-highlight is off, generate the click for the item
12568 where the button was pressed, disregarding where it was
12570 if (NILP (Vmouse_highlight
) && !down_p
)
12571 prop_idx
= f
->last_tool_bar_item
;
12573 /* If item is disabled, do nothing. */
12574 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12575 if (NILP (enabled_p
))
12580 /* Show item in pressed state. */
12581 if (!NILP (Vmouse_highlight
))
12582 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12583 f
->last_tool_bar_item
= prop_idx
;
12587 Lisp_Object key
, frame
;
12588 struct input_event event
;
12589 EVENT_INIT (event
);
12591 /* Show item in released state. */
12592 if (!NILP (Vmouse_highlight
))
12593 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12595 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12597 XSETFRAME (frame
, f
);
12598 event
.kind
= TOOL_BAR_EVENT
;
12599 event
.frame_or_window
= frame
;
12601 kbd_buffer_store_event (&event
);
12603 event
.kind
= TOOL_BAR_EVENT
;
12604 event
.frame_or_window
= frame
;
12606 event
.modifiers
= modifiers
;
12607 kbd_buffer_store_event (&event
);
12608 f
->last_tool_bar_item
= -1;
12613 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12614 tool-bar window-relative coordinates X/Y. Called from
12615 note_mouse_highlight. */
12618 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12620 Lisp_Object window
= f
->tool_bar_window
;
12621 struct window
*w
= XWINDOW (window
);
12622 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12623 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12625 struct glyph
*glyph
;
12626 struct glyph_row
*row
;
12628 Lisp_Object enabled_p
;
12630 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12634 /* Function note_mouse_highlight is called with negative X/Y
12635 values when mouse moves outside of the frame. */
12636 if (x
<= 0 || y
<= 0)
12638 clear_mouse_face (hlinfo
);
12642 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12645 /* Not on tool-bar item. */
12646 clear_mouse_face (hlinfo
);
12650 /* On same tool-bar item as before. */
12651 goto set_help_echo
;
12653 clear_mouse_face (hlinfo
);
12655 /* Mouse is down, but on different tool-bar item? */
12656 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12657 && f
== dpyinfo
->last_mouse_frame
);
12659 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12662 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12664 /* If tool-bar item is not enabled, don't highlight it. */
12665 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12666 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12668 /* Compute the x-position of the glyph. In front and past the
12669 image is a space. We include this in the highlighted area. */
12670 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12671 for (i
= x
= 0; i
< hpos
; ++i
)
12672 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12674 /* Record this as the current active region. */
12675 hlinfo
->mouse_face_beg_col
= hpos
;
12676 hlinfo
->mouse_face_beg_row
= vpos
;
12677 hlinfo
->mouse_face_beg_x
= x
;
12678 hlinfo
->mouse_face_past_end
= false;
12680 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12681 hlinfo
->mouse_face_end_row
= vpos
;
12682 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12683 hlinfo
->mouse_face_window
= window
;
12684 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12686 /* Display it as active. */
12687 show_mouse_face (hlinfo
, draw
);
12692 /* Set help_echo_string to a help string to display for this tool-bar item.
12693 XTread_socket does the rest. */
12694 help_echo_object
= help_echo_window
= Qnil
;
12695 help_echo_pos
= -1;
12696 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12697 if (NILP (help_echo_string
))
12698 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12701 #endif /* !USE_GTK && !HAVE_NS */
12703 #endif /* HAVE_WINDOW_SYSTEM */
12707 /************************************************************************
12708 Horizontal scrolling
12709 ************************************************************************/
12711 /* For all leaf windows in the window tree rooted at WINDOW, set their
12712 hscroll value so that PT is (i) visible in the window, and (ii) so
12713 that it is not within a certain margin at the window's left and
12714 right border. Value is true if any window's hscroll has been
12718 hscroll_window_tree (Lisp_Object window
)
12720 bool hscrolled_p
= false;
12721 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12722 int hscroll_step_abs
= 0;
12723 double hscroll_step_rel
= 0;
12725 if (hscroll_relative_p
)
12727 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12728 if (hscroll_step_rel
< 0)
12730 hscroll_relative_p
= false;
12731 hscroll_step_abs
= 0;
12734 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12736 hscroll_step_abs
= XINT (Vhscroll_step
);
12737 if (hscroll_step_abs
< 0)
12738 hscroll_step_abs
= 0;
12741 hscroll_step_abs
= 0;
12743 while (WINDOWP (window
))
12745 struct window
*w
= XWINDOW (window
);
12747 if (WINDOWP (w
->contents
))
12748 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12749 else if (w
->cursor
.vpos
>= 0)
12752 int text_area_width
;
12753 struct glyph_row
*cursor_row
;
12754 struct glyph_row
*bottom_row
;
12756 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12757 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12758 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12760 cursor_row
= bottom_row
- 1;
12762 if (!cursor_row
->enabled_p
)
12764 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12765 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12766 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12768 cursor_row
= bottom_row
- 1;
12770 bool row_r2l_p
= cursor_row
->reversed_p
;
12772 text_area_width
= window_box_width (w
, TEXT_AREA
);
12774 /* Scroll when cursor is inside this scroll margin. */
12775 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12777 /* If the position of this window's point has explicitly
12778 changed, no more suspend auto hscrolling. */
12779 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12780 w
->suspend_auto_hscroll
= false;
12782 /* Remember window point. */
12783 Fset_marker (w
->old_pointm
,
12784 ((w
== XWINDOW (selected_window
))
12785 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12786 : Fmarker_position (w
->pointm
)),
12789 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12790 && !w
->suspend_auto_hscroll
12791 /* In some pathological cases, like restoring a window
12792 configuration into a frame that is much smaller than
12793 the one from which the configuration was saved, we
12794 get glyph rows whose start and end have zero buffer
12795 positions, which we cannot handle below. Just skip
12797 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12798 /* For left-to-right rows, hscroll when cursor is either
12799 (i) inside the right hscroll margin, or (ii) if it is
12800 inside the left margin and the window is already
12803 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12804 || (cursor_row
->enabled_p
12805 && cursor_row
->truncated_on_right_p
12806 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12807 /* For right-to-left rows, the logic is similar,
12808 except that rules for scrolling to left and right
12809 are reversed. E.g., if cursor.x <= h_margin, we
12810 need to hscroll "to the right" unconditionally,
12811 and that will scroll the screen to the left so as
12812 to reveal the next portion of the row. */
12814 && ((cursor_row
->enabled_p
12815 /* FIXME: It is confusing to set the
12816 truncated_on_right_p flag when R2L rows
12817 are actually truncated on the left. */
12818 && cursor_row
->truncated_on_right_p
12819 && w
->cursor
.x
<= h_margin
)
12821 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12825 struct buffer
*saved_current_buffer
;
12829 /* Find point in a display of infinite width. */
12830 saved_current_buffer
= current_buffer
;
12831 current_buffer
= XBUFFER (w
->contents
);
12833 if (w
== XWINDOW (selected_window
))
12836 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12838 /* Move iterator to pt starting at cursor_row->start in
12839 a line with infinite width. */
12840 init_to_row_start (&it
, w
, cursor_row
);
12841 it
.last_visible_x
= INFINITY
;
12842 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12843 current_buffer
= saved_current_buffer
;
12845 /* Position cursor in window. */
12846 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12847 hscroll
= max (0, (it
.current_x
12848 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12849 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12850 : (text_area_width
/ 2))))
12851 / FRAME_COLUMN_WIDTH (it
.f
);
12852 else if ((!row_r2l_p
12853 && w
->cursor
.x
>= text_area_width
- h_margin
)
12854 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12856 if (hscroll_relative_p
)
12857 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12860 wanted_x
= text_area_width
12861 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12864 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12868 if (hscroll_relative_p
)
12869 wanted_x
= text_area_width
* hscroll_step_rel
12872 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12875 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12877 hscroll
= max (hscroll
, w
->min_hscroll
);
12879 /* Don't prevent redisplay optimizations if hscroll
12880 hasn't changed, as it will unnecessarily slow down
12882 if (w
->hscroll
!= hscroll
)
12884 struct buffer
*b
= XBUFFER (w
->contents
);
12885 b
->prevent_redisplay_optimizations_p
= true;
12886 w
->hscroll
= hscroll
;
12887 hscrolled_p
= true;
12895 /* Value is true if hscroll of any leaf window has been changed. */
12896 return hscrolled_p
;
12900 /* Set hscroll so that cursor is visible and not inside horizontal
12901 scroll margins for all windows in the tree rooted at WINDOW. See
12902 also hscroll_window_tree above. Value is true if any window's
12903 hscroll has been changed. If it has, desired matrices on the frame
12904 of WINDOW are cleared. */
12907 hscroll_windows (Lisp_Object window
)
12909 bool hscrolled_p
= hscroll_window_tree (window
);
12911 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12912 return hscrolled_p
;
12917 /************************************************************************
12919 ************************************************************************/
12921 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
12922 This is sometimes handy to have in a debugger session. */
12926 /* First and last unchanged row for try_window_id. */
12928 static int debug_first_unchanged_at_end_vpos
;
12929 static int debug_last_unchanged_at_beg_vpos
;
12931 /* Delta vpos and y. */
12933 static int debug_dvpos
, debug_dy
;
12935 /* Delta in characters and bytes for try_window_id. */
12937 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12939 /* Values of window_end_pos and window_end_vpos at the end of
12942 static ptrdiff_t debug_end_vpos
;
12944 /* Append a string to W->desired_matrix->method. FMT is a printf
12945 format string. If trace_redisplay_p is true also printf the
12946 resulting string to stderr. */
12948 static void debug_method_add (struct window
*, char const *, ...)
12949 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12952 debug_method_add (struct window
*w
, char const *fmt
, ...)
12955 char *method
= w
->desired_matrix
->method
;
12956 int len
= strlen (method
);
12957 int size
= sizeof w
->desired_matrix
->method
;
12958 int remaining
= size
- len
- 1;
12961 if (len
&& remaining
)
12964 --remaining
, ++len
;
12967 va_start (ap
, fmt
);
12968 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12971 if (trace_redisplay_p
)
12972 fprintf (stderr
, "%p (%s): %s\n",
12974 ((BUFFERP (w
->contents
)
12975 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
12976 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
12981 #endif /* GLYPH_DEBUG */
12984 /* Value is true if all changes in window W, which displays
12985 current_buffer, are in the text between START and END. START is a
12986 buffer position, END is given as a distance from Z. Used in
12987 redisplay_internal for display optimization. */
12990 text_outside_line_unchanged_p (struct window
*w
,
12991 ptrdiff_t start
, ptrdiff_t end
)
12993 bool unchanged_p
= true;
12995 /* If text or overlays have changed, see where. */
12996 if (window_outdated (w
))
12998 /* Gap in the line? */
12999 if (GPT
< start
|| Z
- GPT
< end
)
13000 unchanged_p
= false;
13002 /* Changes start in front of the line, or end after it? */
13004 && (BEG_UNCHANGED
< start
- 1
13005 || END_UNCHANGED
< end
))
13006 unchanged_p
= false;
13008 /* If selective display, can't optimize if changes start at the
13009 beginning of the line. */
13011 && INTEGERP (BVAR (current_buffer
, selective_display
))
13012 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13013 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13014 unchanged_p
= false;
13016 /* If there are overlays at the start or end of the line, these
13017 may have overlay strings with newlines in them. A change at
13018 START, for instance, may actually concern the display of such
13019 overlay strings as well, and they are displayed on different
13020 lines. So, quickly rule out this case. (For the future, it
13021 might be desirable to implement something more telling than
13022 just BEG/END_UNCHANGED.) */
13025 if (BEG
+ BEG_UNCHANGED
== start
13026 && overlay_touches_p (start
))
13027 unchanged_p
= false;
13028 if (END_UNCHANGED
== end
13029 && overlay_touches_p (Z
- end
))
13030 unchanged_p
= false;
13033 /* Under bidi reordering, adding or deleting a character in the
13034 beginning of a paragraph, before the first strong directional
13035 character, can change the base direction of the paragraph (unless
13036 the buffer specifies a fixed paragraph direction), which will
13037 require to redisplay the whole paragraph. It might be worthwhile
13038 to find the paragraph limits and widen the range of redisplayed
13039 lines to that, but for now just give up this optimization. */
13040 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13041 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13042 unchanged_p
= false;
13045 return unchanged_p
;
13049 /* Do a frame update, taking possible shortcuts into account. This is
13050 the main external entry point for redisplay.
13052 If the last redisplay displayed an echo area message and that message
13053 is no longer requested, we clear the echo area or bring back the
13054 mini-buffer if that is in use. */
13059 redisplay_internal ();
13064 overlay_arrow_string_or_property (Lisp_Object var
)
13068 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13071 return Voverlay_arrow_string
;
13074 /* Return true if there are any overlay-arrows in current_buffer. */
13076 overlay_arrow_in_current_buffer_p (void)
13080 for (vlist
= Voverlay_arrow_variable_list
;
13082 vlist
= XCDR (vlist
))
13084 Lisp_Object var
= XCAR (vlist
);
13087 if (!SYMBOLP (var
))
13089 val
= find_symbol_value (var
);
13091 && current_buffer
== XMARKER (val
)->buffer
)
13098 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13102 overlay_arrows_changed_p (void)
13106 for (vlist
= Voverlay_arrow_variable_list
;
13108 vlist
= XCDR (vlist
))
13110 Lisp_Object var
= XCAR (vlist
);
13111 Lisp_Object val
, pstr
;
13113 if (!SYMBOLP (var
))
13115 val
= find_symbol_value (var
);
13116 if (!MARKERP (val
))
13118 if (! EQ (COERCE_MARKER (val
),
13119 Fget (var
, Qlast_arrow_position
))
13120 || ! (pstr
= overlay_arrow_string_or_property (var
),
13121 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13127 /* Mark overlay arrows to be updated on next redisplay. */
13130 update_overlay_arrows (int up_to_date
)
13134 for (vlist
= Voverlay_arrow_variable_list
;
13136 vlist
= XCDR (vlist
))
13138 Lisp_Object var
= XCAR (vlist
);
13140 if (!SYMBOLP (var
))
13143 if (up_to_date
> 0)
13145 Lisp_Object val
= find_symbol_value (var
);
13146 Fput (var
, Qlast_arrow_position
,
13147 COERCE_MARKER (val
));
13148 Fput (var
, Qlast_arrow_string
,
13149 overlay_arrow_string_or_property (var
));
13151 else if (up_to_date
< 0
13152 || !NILP (Fget (var
, Qlast_arrow_position
)))
13154 Fput (var
, Qlast_arrow_position
, Qt
);
13155 Fput (var
, Qlast_arrow_string
, Qt
);
13161 /* Return overlay arrow string to display at row.
13162 Return integer (bitmap number) for arrow bitmap in left fringe.
13163 Return nil if no overlay arrow. */
13166 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13170 for (vlist
= Voverlay_arrow_variable_list
;
13172 vlist
= XCDR (vlist
))
13174 Lisp_Object var
= XCAR (vlist
);
13177 if (!SYMBOLP (var
))
13180 val
= find_symbol_value (var
);
13183 && current_buffer
== XMARKER (val
)->buffer
13184 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13186 if (FRAME_WINDOW_P (it
->f
)
13187 /* FIXME: if ROW->reversed_p is set, this should test
13188 the right fringe, not the left one. */
13189 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13191 #ifdef HAVE_WINDOW_SYSTEM
13192 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13194 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13195 if (fringe_bitmap
!= 0)
13196 return make_number (fringe_bitmap
);
13199 return make_number (-1); /* Use default arrow bitmap. */
13201 return overlay_arrow_string_or_property (var
);
13208 /* Return true if point moved out of or into a composition. Otherwise
13209 return false. PREV_BUF and PREV_PT are the last point buffer and
13210 position. BUF and PT are the current point buffer and position. */
13213 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13214 struct buffer
*buf
, ptrdiff_t pt
)
13216 ptrdiff_t start
, end
;
13218 Lisp_Object buffer
;
13220 XSETBUFFER (buffer
, buf
);
13221 /* Check a composition at the last point if point moved within the
13223 if (prev_buf
== buf
)
13226 /* Point didn't move. */
13229 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13230 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13231 && composition_valid_p (start
, end
, prop
)
13232 && start
< prev_pt
&& end
> prev_pt
)
13233 /* The last point was within the composition. Return true iff
13234 point moved out of the composition. */
13235 return (pt
<= start
|| pt
>= end
);
13238 /* Check a composition at the current point. */
13239 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13240 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13241 && composition_valid_p (start
, end
, prop
)
13242 && start
< pt
&& end
> pt
);
13245 /* Reconsider the clip changes of buffer which is displayed in W. */
13248 reconsider_clip_changes (struct window
*w
)
13250 struct buffer
*b
= XBUFFER (w
->contents
);
13252 if (b
->clip_changed
13253 && w
->window_end_valid
13254 && w
->current_matrix
->buffer
== b
13255 && w
->current_matrix
->zv
== BUF_ZV (b
)
13256 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13257 b
->clip_changed
= false;
13259 /* If display wasn't paused, and W is not a tool bar window, see if
13260 point has been moved into or out of a composition. In that case,
13261 set b->clip_changed to force updating the screen. If
13262 b->clip_changed has already been set, skip this check. */
13263 if (!b
->clip_changed
&& w
->window_end_valid
)
13265 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13266 ? PT
: marker_position (w
->pointm
));
13268 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13269 && check_point_in_composition (w
->current_matrix
->buffer
,
13270 w
->last_point
, b
, pt
))
13271 b
->clip_changed
= true;
13276 propagate_buffer_redisplay (void)
13277 { /* Resetting b->text->redisplay is problematic!
13278 We can't just reset it in the case that some window that displays
13279 it has not been redisplayed; and such a window can stay
13280 unredisplayed for a long time if it's currently invisible.
13281 But we do want to reset it at the end of redisplay otherwise
13282 its displayed windows will keep being redisplayed over and over
13284 So we copy all b->text->redisplay flags up to their windows here,
13285 such that mark_window_display_accurate can safely reset
13286 b->text->redisplay. */
13287 Lisp_Object ws
= window_list ();
13288 for (; CONSP (ws
); ws
= XCDR (ws
))
13290 struct window
*thisw
= XWINDOW (XCAR (ws
));
13291 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13292 if (thisb
->text
->redisplay
)
13293 thisw
->redisplay
= true;
13297 #define STOP_POLLING \
13298 do { if (! polling_stopped_here) stop_polling (); \
13299 polling_stopped_here = true; } while (false)
13301 #define RESUME_POLLING \
13302 do { if (polling_stopped_here) start_polling (); \
13303 polling_stopped_here = false; } while (false)
13306 /* Perhaps in the future avoid recentering windows if it
13307 is not necessary; currently that causes some problems. */
13310 redisplay_internal (void)
13312 struct window
*w
= XWINDOW (selected_window
);
13316 bool must_finish
= false, match_p
;
13317 struct text_pos tlbufpos
, tlendpos
;
13318 int number_of_visible_frames
;
13321 bool polling_stopped_here
= false;
13322 Lisp_Object tail
, frame
;
13324 /* True means redisplay has to consider all windows on all
13325 frames. False, only selected_window is considered. */
13326 bool consider_all_windows_p
;
13328 /* True means redisplay has to redisplay the miniwindow. */
13329 bool update_miniwindow_p
= false;
13331 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13333 /* No redisplay if running in batch mode or frame is not yet fully
13334 initialized, or redisplay is explicitly turned off by setting
13335 Vinhibit_redisplay. */
13336 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13337 || !NILP (Vinhibit_redisplay
))
13340 /* Don't examine these until after testing Vinhibit_redisplay.
13341 When Emacs is shutting down, perhaps because its connection to
13342 X has dropped, we should not look at them at all. */
13343 fr
= XFRAME (w
->frame
);
13344 sf
= SELECTED_FRAME ();
13346 if (!fr
->glyphs_initialized_p
)
13349 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13350 if (popup_activated ())
13354 /* I don't think this happens but let's be paranoid. */
13355 if (redisplaying_p
)
13358 /* Record a function that clears redisplaying_p
13359 when we leave this function. */
13360 count
= SPECPDL_INDEX ();
13361 record_unwind_protect_void (unwind_redisplay
);
13362 redisplaying_p
= true;
13363 specbind (Qinhibit_free_realized_faces
, Qnil
);
13365 /* Record this function, so it appears on the profiler's backtraces. */
13366 record_in_backtrace (Qredisplay_internal
, 0, 0);
13368 FOR_EACH_FRAME (tail
, frame
)
13369 XFRAME (frame
)->already_hscrolled_p
= false;
13372 /* Remember the currently selected window. */
13376 forget_escape_and_glyphless_faces ();
13378 /* If face_change, init_iterator will free all realized faces, which
13379 includes the faces referenced from current matrices. So, we
13380 can't reuse current matrices in this case. */
13382 windows_or_buffers_changed
= 47;
13384 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13385 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13387 /* Since frames on a single ASCII terminal share the same
13388 display area, displaying a different frame means redisplay
13389 the whole thing. */
13390 SET_FRAME_GARBAGED (sf
);
13392 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13394 FRAME_TTY (sf
)->previous_frame
= sf
;
13397 /* Set the visible flags for all frames. Do this before checking for
13398 resized or garbaged frames; they want to know if their frames are
13399 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13400 number_of_visible_frames
= 0;
13402 FOR_EACH_FRAME (tail
, frame
)
13404 struct frame
*f
= XFRAME (frame
);
13406 if (FRAME_VISIBLE_P (f
))
13408 ++number_of_visible_frames
;
13409 /* Adjust matrices for visible frames only. */
13410 if (f
->fonts_changed
)
13412 adjust_frame_glyphs (f
);
13413 /* Disable all redisplay optimizations for this frame.
13414 This is because adjust_frame_glyphs resets the
13415 enabled_p flag for all glyph rows of all windows, so
13416 many optimizations will fail anyway, and some might
13417 fail to test that flag and do bogus things as
13419 SET_FRAME_GARBAGED (f
);
13420 f
->fonts_changed
= false;
13422 /* If cursor type has been changed on the frame
13423 other than selected, consider all frames. */
13424 if (f
!= sf
&& f
->cursor_type_changed
)
13425 update_mode_lines
= 31;
13427 clear_desired_matrices (f
);
13430 /* Notice any pending interrupt request to change frame size. */
13431 do_pending_window_change (true);
13433 /* do_pending_window_change could change the selected_window due to
13434 frame resizing which makes the selected window too small. */
13435 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13438 /* Clear frames marked as garbaged. */
13439 clear_garbaged_frames ();
13441 /* Build menubar and tool-bar items. */
13442 if (NILP (Vmemory_full
))
13443 prepare_menu_bars ();
13445 reconsider_clip_changes (w
);
13447 /* In most cases selected window displays current buffer. */
13448 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13451 /* Detect case that we need to write or remove a star in the mode line. */
13452 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13453 w
->update_mode_line
= true;
13455 if (mode_line_update_needed (w
))
13456 w
->update_mode_line
= true;
13458 /* If reconsider_clip_changes above decided that the narrowing
13459 in the current buffer changed, make sure all other windows
13460 showing that buffer will be redisplayed. */
13461 if (current_buffer
->clip_changed
)
13462 bset_update_mode_line (current_buffer
);
13465 /* Normally the message* functions will have already displayed and
13466 updated the echo area, but the frame may have been trashed, or
13467 the update may have been preempted, so display the echo area
13468 again here. Checking message_cleared_p captures the case that
13469 the echo area should be cleared. */
13470 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13471 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13472 || (message_cleared_p
13473 && minibuf_level
== 0
13474 /* If the mini-window is currently selected, this means the
13475 echo-area doesn't show through. */
13476 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13478 echo_area_display (false);
13480 if (message_cleared_p
)
13481 update_miniwindow_p
= true;
13483 must_finish
= true;
13485 /* If we don't display the current message, don't clear the
13486 message_cleared_p flag, because, if we did, we wouldn't clear
13487 the echo area in the next redisplay which doesn't preserve
13489 if (!display_last_displayed_message_p
)
13490 message_cleared_p
= false;
13492 else if (EQ (selected_window
, minibuf_window
)
13493 && (current_buffer
->clip_changed
|| window_outdated (w
))
13494 && resize_mini_window (w
, false))
13496 /* Resized active mini-window to fit the size of what it is
13497 showing if its contents might have changed. */
13498 must_finish
= true;
13500 /* If window configuration was changed, frames may have been
13501 marked garbaged. Clear them or we will experience
13502 surprises wrt scrolling. */
13503 clear_garbaged_frames ();
13506 if (windows_or_buffers_changed
&& !update_mode_lines
)
13507 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13508 only the windows's contents needs to be refreshed, or whether the
13509 mode-lines also need a refresh. */
13510 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13511 ? REDISPLAY_SOME
: 32);
13513 /* If specs for an arrow have changed, do thorough redisplay
13514 to ensure we remove any arrow that should no longer exist. */
13515 if (overlay_arrows_changed_p ())
13516 /* Apparently, this is the only case where we update other windows,
13517 without updating other mode-lines. */
13518 windows_or_buffers_changed
= 49;
13520 consider_all_windows_p
= (update_mode_lines
13521 || windows_or_buffers_changed
);
13523 #define AINC(a,i) \
13524 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13525 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13527 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13528 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13530 /* Optimize the case that only the line containing the cursor in the
13531 selected window has changed. Variables starting with this_ are
13532 set in display_line and record information about the line
13533 containing the cursor. */
13534 tlbufpos
= this_line_start_pos
;
13535 tlendpos
= this_line_end_pos
;
13536 if (!consider_all_windows_p
13537 && CHARPOS (tlbufpos
) > 0
13538 && !w
->update_mode_line
13539 && !current_buffer
->clip_changed
13540 && !current_buffer
->prevent_redisplay_optimizations_p
13541 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13542 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13543 && !XFRAME (w
->frame
)->cursor_type_changed
13544 /* Make sure recorded data applies to current buffer, etc. */
13545 && this_line_buffer
== current_buffer
13548 && !w
->optional_new_start
13549 /* Point must be on the line that we have info recorded about. */
13550 && PT
>= CHARPOS (tlbufpos
)
13551 && PT
<= Z
- CHARPOS (tlendpos
)
13552 /* All text outside that line, including its final newline,
13553 must be unchanged. */
13554 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13555 CHARPOS (tlendpos
)))
13557 if (CHARPOS (tlbufpos
) > BEGV
13558 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13559 && (CHARPOS (tlbufpos
) == ZV
13560 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13561 /* Former continuation line has disappeared by becoming empty. */
13563 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13565 /* We have to handle the case of continuation around a
13566 wide-column character (see the comment in indent.c around
13569 For instance, in the following case:
13571 -------- Insert --------
13572 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13573 J_I_ ==> J_I_ `^^' are cursors.
13577 As we have to redraw the line above, we cannot use this
13581 int line_height_before
= this_line_pixel_height
;
13583 /* Note that start_display will handle the case that the
13584 line starting at tlbufpos is a continuation line. */
13585 start_display (&it
, w
, tlbufpos
);
13587 /* Implementation note: It this still necessary? */
13588 if (it
.current_x
!= this_line_start_x
)
13591 TRACE ((stderr
, "trying display optimization 1\n"));
13592 w
->cursor
.vpos
= -1;
13593 overlay_arrow_seen
= false;
13594 it
.vpos
= this_line_vpos
;
13595 it
.current_y
= this_line_y
;
13596 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13597 display_line (&it
);
13599 /* If line contains point, is not continued,
13600 and ends at same distance from eob as before, we win. */
13601 if (w
->cursor
.vpos
>= 0
13602 /* Line is not continued, otherwise this_line_start_pos
13603 would have been set to 0 in display_line. */
13604 && CHARPOS (this_line_start_pos
)
13605 /* Line ends as before. */
13606 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13607 /* Line has same height as before. Otherwise other lines
13608 would have to be shifted up or down. */
13609 && this_line_pixel_height
== line_height_before
)
13611 /* If this is not the window's last line, we must adjust
13612 the charstarts of the lines below. */
13613 if (it
.current_y
< it
.last_visible_y
)
13615 struct glyph_row
*row
13616 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13617 ptrdiff_t delta
, delta_bytes
;
13619 /* We used to distinguish between two cases here,
13620 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13621 when the line ends in a newline or the end of the
13622 buffer's accessible portion. But both cases did
13623 the same, so they were collapsed. */
13625 - CHARPOS (tlendpos
)
13626 - MATRIX_ROW_START_CHARPOS (row
));
13627 delta_bytes
= (Z_BYTE
13628 - BYTEPOS (tlendpos
)
13629 - MATRIX_ROW_START_BYTEPOS (row
));
13631 increment_matrix_positions (w
->current_matrix
,
13632 this_line_vpos
+ 1,
13633 w
->current_matrix
->nrows
,
13634 delta
, delta_bytes
);
13637 /* If this row displays text now but previously didn't,
13638 or vice versa, w->window_end_vpos may have to be
13640 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13642 if (w
->window_end_vpos
< this_line_vpos
)
13643 w
->window_end_vpos
= this_line_vpos
;
13645 else if (w
->window_end_vpos
== this_line_vpos
13646 && this_line_vpos
> 0)
13647 w
->window_end_vpos
= this_line_vpos
- 1;
13648 w
->window_end_valid
= false;
13650 /* Update hint: No need to try to scroll in update_window. */
13651 w
->desired_matrix
->no_scrolling_p
= true;
13654 *w
->desired_matrix
->method
= 0;
13655 debug_method_add (w
, "optimization 1");
13657 #ifdef HAVE_WINDOW_SYSTEM
13658 update_window_fringes (w
, false);
13665 else if (/* Cursor position hasn't changed. */
13666 PT
== w
->last_point
13667 /* Make sure the cursor was last displayed
13668 in this window. Otherwise we have to reposition it. */
13670 /* PXW: Must be converted to pixels, probably. */
13671 && 0 <= w
->cursor
.vpos
13672 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13676 do_pending_window_change (true);
13677 /* If selected_window changed, redisplay again. */
13678 if (WINDOWP (selected_window
)
13679 && (w
= XWINDOW (selected_window
)) != sw
)
13682 /* We used to always goto end_of_redisplay here, but this
13683 isn't enough if we have a blinking cursor. */
13684 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13685 goto end_of_redisplay
;
13689 /* If highlighting the region, or if the cursor is in the echo area,
13690 then we can't just move the cursor. */
13691 else if (NILP (Vshow_trailing_whitespace
)
13692 && !cursor_in_echo_area
)
13695 struct glyph_row
*row
;
13697 /* Skip from tlbufpos to PT and see where it is. Note that
13698 PT may be in invisible text. If so, we will end at the
13699 next visible position. */
13700 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13701 NULL
, DEFAULT_FACE_ID
);
13702 it
.current_x
= this_line_start_x
;
13703 it
.current_y
= this_line_y
;
13704 it
.vpos
= this_line_vpos
;
13706 /* The call to move_it_to stops in front of PT, but
13707 moves over before-strings. */
13708 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13710 if (it
.vpos
== this_line_vpos
13711 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13714 eassert (this_line_vpos
== it
.vpos
);
13715 eassert (this_line_y
== it
.current_y
);
13716 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13718 *w
->desired_matrix
->method
= 0;
13719 debug_method_add (w
, "optimization 3");
13728 /* Text changed drastically or point moved off of line. */
13729 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13732 CHARPOS (this_line_start_pos
) = 0;
13733 ++clear_face_cache_count
;
13734 #ifdef HAVE_WINDOW_SYSTEM
13735 ++clear_image_cache_count
;
13738 /* Build desired matrices, and update the display. If
13739 consider_all_windows_p, do it for all windows on all frames.
13740 Otherwise do it for selected_window, only. */
13742 if (consider_all_windows_p
)
13744 FOR_EACH_FRAME (tail
, frame
)
13745 XFRAME (frame
)->updated_p
= false;
13747 propagate_buffer_redisplay ();
13749 FOR_EACH_FRAME (tail
, frame
)
13751 struct frame
*f
= XFRAME (frame
);
13753 /* We don't have to do anything for unselected terminal
13755 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13756 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13760 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13763 /* Only GC scrollbars when we redisplay the whole frame. */
13764 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13765 /* Mark all the scroll bars to be removed; we'll redeem
13766 the ones we want when we redisplay their windows. */
13767 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13768 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13770 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13771 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13772 /* Remember that the invisible frames need to be redisplayed next
13773 time they're visible. */
13774 else if (!REDISPLAY_SOME_P ())
13775 f
->redisplay
= true;
13777 /* The X error handler may have deleted that frame. */
13778 if (!FRAME_LIVE_P (f
))
13781 /* Any scroll bars which redisplay_windows should have
13782 nuked should now go away. */
13783 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13784 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13786 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13788 /* If fonts changed on visible frame, display again. */
13789 if (f
->fonts_changed
)
13791 adjust_frame_glyphs (f
);
13792 /* Disable all redisplay optimizations for this
13793 frame. For the reasons, see the comment near
13794 the previous call to adjust_frame_glyphs above. */
13795 SET_FRAME_GARBAGED (f
);
13796 f
->fonts_changed
= false;
13800 /* See if we have to hscroll. */
13801 if (!f
->already_hscrolled_p
)
13803 f
->already_hscrolled_p
= true;
13804 if (hscroll_windows (f
->root_window
))
13808 /* Prevent various kinds of signals during display
13809 update. stdio is not robust about handling
13810 signals, which can cause an apparent I/O error. */
13811 if (interrupt_input
)
13812 unrequest_sigio ();
13815 pending
|= update_frame (f
, false, false);
13816 f
->cursor_type_changed
= false;
13817 f
->updated_p
= true;
13822 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13826 /* Do the mark_window_display_accurate after all windows have
13827 been redisplayed because this call resets flags in buffers
13828 which are needed for proper redisplay. */
13829 FOR_EACH_FRAME (tail
, frame
)
13831 struct frame
*f
= XFRAME (frame
);
13834 f
->redisplay
= false;
13835 mark_window_display_accurate (f
->root_window
, true);
13836 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13837 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13842 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13844 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13845 struct frame
*mini_frame
;
13847 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13848 /* Use list_of_error, not Qerror, so that
13849 we catch only errors and don't run the debugger. */
13850 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13852 redisplay_window_error
);
13853 if (update_miniwindow_p
)
13854 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13856 redisplay_window_error
);
13858 /* Compare desired and current matrices, perform output. */
13861 /* If fonts changed, display again. */
13862 if (sf
->fonts_changed
)
13865 /* Prevent various kinds of signals during display update.
13866 stdio is not robust about handling signals,
13867 which can cause an apparent I/O error. */
13868 if (interrupt_input
)
13869 unrequest_sigio ();
13872 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13874 if (hscroll_windows (selected_window
))
13877 XWINDOW (selected_window
)->must_be_updated_p
= true;
13878 pending
= update_frame (sf
, false, false);
13879 sf
->cursor_type_changed
= false;
13882 /* We may have called echo_area_display at the top of this
13883 function. If the echo area is on another frame, that may
13884 have put text on a frame other than the selected one, so the
13885 above call to update_frame would not have caught it. Catch
13887 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13888 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13890 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13892 XWINDOW (mini_window
)->must_be_updated_p
= true;
13893 pending
|= update_frame (mini_frame
, false, false);
13894 mini_frame
->cursor_type_changed
= false;
13895 if (!pending
&& hscroll_windows (mini_window
))
13900 /* If display was paused because of pending input, make sure we do a
13901 thorough update the next time. */
13904 /* Prevent the optimization at the beginning of
13905 redisplay_internal that tries a single-line update of the
13906 line containing the cursor in the selected window. */
13907 CHARPOS (this_line_start_pos
) = 0;
13909 /* Let the overlay arrow be updated the next time. */
13910 update_overlay_arrows (0);
13912 /* If we pause after scrolling, some rows in the current
13913 matrices of some windows are not valid. */
13914 if (!WINDOW_FULL_WIDTH_P (w
)
13915 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13916 update_mode_lines
= 36;
13920 if (!consider_all_windows_p
)
13922 /* This has already been done above if
13923 consider_all_windows_p is set. */
13924 if (XBUFFER (w
->contents
)->text
->redisplay
13925 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13926 /* This can happen if b->text->redisplay was set during
13928 propagate_buffer_redisplay ();
13929 mark_window_display_accurate_1 (w
, true);
13931 /* Say overlay arrows are up to date. */
13932 update_overlay_arrows (1);
13934 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13935 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13938 update_mode_lines
= 0;
13939 windows_or_buffers_changed
= 0;
13942 /* Start SIGIO interrupts coming again. Having them off during the
13943 code above makes it less likely one will discard output, but not
13944 impossible, since there might be stuff in the system buffer here.
13945 But it is much hairier to try to do anything about that. */
13946 if (interrupt_input
)
13950 /* If a frame has become visible which was not before, redisplay
13951 again, so that we display it. Expose events for such a frame
13952 (which it gets when becoming visible) don't call the parts of
13953 redisplay constructing glyphs, so simply exposing a frame won't
13954 display anything in this case. So, we have to display these
13955 frames here explicitly. */
13960 FOR_EACH_FRAME (tail
, frame
)
13962 if (XFRAME (frame
)->visible
)
13966 if (new_count
!= number_of_visible_frames
)
13967 windows_or_buffers_changed
= 52;
13970 /* Change frame size now if a change is pending. */
13971 do_pending_window_change (true);
13973 /* If we just did a pending size change, or have additional
13974 visible frames, or selected_window changed, redisplay again. */
13975 if ((windows_or_buffers_changed
&& !pending
)
13976 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13979 /* Clear the face and image caches.
13981 We used to do this only if consider_all_windows_p. But the cache
13982 needs to be cleared if a timer creates images in the current
13983 buffer (e.g. the test case in Bug#6230). */
13985 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13987 clear_face_cache (false);
13988 clear_face_cache_count
= 0;
13991 #ifdef HAVE_WINDOW_SYSTEM
13992 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13994 clear_image_caches (Qnil
);
13995 clear_image_cache_count
= 0;
13997 #endif /* HAVE_WINDOW_SYSTEM */
14001 ns_set_doc_edited ();
14003 if (interrupt_input
&& interrupts_deferred
)
14006 unbind_to (count
, Qnil
);
14011 /* Redisplay, but leave alone any recent echo area message unless
14012 another message has been requested in its place.
14014 This is useful in situations where you need to redisplay but no
14015 user action has occurred, making it inappropriate for the message
14016 area to be cleared. See tracking_off and
14017 wait_reading_process_output for examples of these situations.
14019 FROM_WHERE is an integer saying from where this function was
14020 called. This is useful for debugging. */
14023 redisplay_preserve_echo_area (int from_where
)
14025 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14027 if (!NILP (echo_area_buffer
[1]))
14029 /* We have a previously displayed message, but no current
14030 message. Redisplay the previous message. */
14031 display_last_displayed_message_p
= true;
14032 redisplay_internal ();
14033 display_last_displayed_message_p
= false;
14036 redisplay_internal ();
14038 flush_frame (SELECTED_FRAME ());
14042 /* Function registered with record_unwind_protect in redisplay_internal. */
14045 unwind_redisplay (void)
14047 redisplaying_p
= false;
14051 /* Mark the display of leaf window W as accurate or inaccurate.
14052 If ACCURATE_P, mark display of W as accurate.
14053 If !ACCURATE_P, arrange for W to be redisplayed the next
14054 time redisplay_internal is called. */
14057 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14059 struct buffer
*b
= XBUFFER (w
->contents
);
14061 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14062 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14063 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14067 b
->clip_changed
= false;
14068 b
->prevent_redisplay_optimizations_p
= false;
14069 eassert (buffer_window_count (b
) > 0);
14070 /* Resetting b->text->redisplay is problematic!
14071 In order to make it safer to do it here, redisplay_internal must
14072 have copied all b->text->redisplay to their respective windows. */
14073 b
->text
->redisplay
= false;
14075 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14076 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14077 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14078 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14080 w
->current_matrix
->buffer
= b
;
14081 w
->current_matrix
->begv
= BUF_BEGV (b
);
14082 w
->current_matrix
->zv
= BUF_ZV (b
);
14084 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14085 w
->last_cursor_off_p
= w
->cursor_off_p
;
14087 if (w
== XWINDOW (selected_window
))
14088 w
->last_point
= BUF_PT (b
);
14090 w
->last_point
= marker_position (w
->pointm
);
14092 w
->window_end_valid
= true;
14093 w
->update_mode_line
= false;
14096 w
->redisplay
= !accurate_p
;
14100 /* Mark the display of windows in the window tree rooted at WINDOW as
14101 accurate or inaccurate. If ACCURATE_P, mark display of
14102 windows as accurate. If !ACCURATE_P, arrange for windows to
14103 be redisplayed the next time redisplay_internal is called. */
14106 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14110 for (; !NILP (window
); window
= w
->next
)
14112 w
= XWINDOW (window
);
14113 if (WINDOWP (w
->contents
))
14114 mark_window_display_accurate (w
->contents
, accurate_p
);
14116 mark_window_display_accurate_1 (w
, accurate_p
);
14120 update_overlay_arrows (1);
14122 /* Force a thorough redisplay the next time by setting
14123 last_arrow_position and last_arrow_string to t, which is
14124 unequal to any useful value of Voverlay_arrow_... */
14125 update_overlay_arrows (-1);
14129 /* Return value in display table DP (Lisp_Char_Table *) for character
14130 C. Since a display table doesn't have any parent, we don't have to
14131 follow parent. Do not call this function directly but use the
14132 macro DISP_CHAR_VECTOR. */
14135 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14139 if (ASCII_CHAR_P (c
))
14142 if (SUB_CHAR_TABLE_P (val
))
14143 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14149 XSETCHAR_TABLE (table
, dp
);
14150 val
= char_table_ref (table
, c
);
14159 /***********************************************************************
14161 ***********************************************************************/
14163 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14166 redisplay_windows (Lisp_Object window
)
14168 while (!NILP (window
))
14170 struct window
*w
= XWINDOW (window
);
14172 if (WINDOWP (w
->contents
))
14173 redisplay_windows (w
->contents
);
14174 else if (BUFFERP (w
->contents
))
14176 displayed_buffer
= XBUFFER (w
->contents
);
14177 /* Use list_of_error, not Qerror, so that
14178 we catch only errors and don't run the debugger. */
14179 internal_condition_case_1 (redisplay_window_0
, window
,
14181 redisplay_window_error
);
14189 redisplay_window_error (Lisp_Object ignore
)
14191 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14196 redisplay_window_0 (Lisp_Object window
)
14198 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14199 redisplay_window (window
, false);
14204 redisplay_window_1 (Lisp_Object window
)
14206 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14207 redisplay_window (window
, true);
14212 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14213 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14214 which positions recorded in ROW differ from current buffer
14217 Return true iff cursor is on this row. */
14220 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14221 struct glyph_matrix
*matrix
,
14222 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14225 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14226 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14227 struct glyph
*cursor
= NULL
;
14228 /* The last known character position in row. */
14229 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14231 ptrdiff_t pt_old
= PT
- delta
;
14232 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14233 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14234 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14235 /* A glyph beyond the edge of TEXT_AREA which we should never
14237 struct glyph
*glyphs_end
= end
;
14238 /* True means we've found a match for cursor position, but that
14239 glyph has the avoid_cursor_p flag set. */
14240 bool match_with_avoid_cursor
= false;
14241 /* True means we've seen at least one glyph that came from a
14243 bool string_seen
= false;
14244 /* Largest and smallest buffer positions seen so far during scan of
14246 ptrdiff_t bpos_max
= pos_before
;
14247 ptrdiff_t bpos_min
= pos_after
;
14248 /* Last buffer position covered by an overlay string with an integer
14249 `cursor' property. */
14250 ptrdiff_t bpos_covered
= 0;
14251 /* True means the display string on which to display the cursor
14252 comes from a text property, not from an overlay. */
14253 bool string_from_text_prop
= false;
14255 /* Don't even try doing anything if called for a mode-line or
14256 header-line row, since the rest of the code isn't prepared to
14257 deal with such calamities. */
14258 eassert (!row
->mode_line_p
);
14259 if (row
->mode_line_p
)
14262 /* Skip over glyphs not having an object at the start and the end of
14263 the row. These are special glyphs like truncation marks on
14264 terminal frames. */
14265 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14267 if (!row
->reversed_p
)
14270 && NILP (glyph
->object
)
14271 && glyph
->charpos
< 0)
14273 x
+= glyph
->pixel_width
;
14277 && NILP ((end
- 1)->object
)
14278 /* CHARPOS is zero for blanks and stretch glyphs
14279 inserted by extend_face_to_end_of_line. */
14280 && (end
- 1)->charpos
<= 0)
14282 glyph_before
= glyph
- 1;
14289 /* If the glyph row is reversed, we need to process it from back
14290 to front, so swap the edge pointers. */
14291 glyphs_end
= end
= glyph
- 1;
14292 glyph
+= row
->used
[TEXT_AREA
] - 1;
14294 while (glyph
> end
+ 1
14295 && NILP (glyph
->object
)
14296 && glyph
->charpos
< 0)
14299 x
-= glyph
->pixel_width
;
14301 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14303 /* By default, in reversed rows we put the cursor on the
14304 rightmost (first in the reading order) glyph. */
14305 for (g
= end
+ 1; g
< glyph
; g
++)
14306 x
+= g
->pixel_width
;
14308 && NILP ((end
+ 1)->object
)
14309 && (end
+ 1)->charpos
<= 0)
14311 glyph_before
= glyph
+ 1;
14315 else if (row
->reversed_p
)
14317 /* In R2L rows that don't display text, put the cursor on the
14318 rightmost glyph. Case in point: an empty last line that is
14319 part of an R2L paragraph. */
14321 /* Avoid placing the cursor on the last glyph of the row, where
14322 on terminal frames we hold the vertical border between
14323 adjacent windows. */
14324 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14325 && !WINDOW_RIGHTMOST_P (w
)
14326 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14328 x
= -1; /* will be computed below, at label compute_x */
14331 /* Step 1: Try to find the glyph whose character position
14332 corresponds to point. If that's not possible, find 2 glyphs
14333 whose character positions are the closest to point, one before
14334 point, the other after it. */
14335 if (!row
->reversed_p
)
14336 while (/* not marched to end of glyph row */
14338 /* glyph was not inserted by redisplay for internal purposes */
14339 && !NILP (glyph
->object
))
14341 if (BUFFERP (glyph
->object
))
14343 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14345 if (glyph
->charpos
> bpos_max
)
14346 bpos_max
= glyph
->charpos
;
14347 if (glyph
->charpos
< bpos_min
)
14348 bpos_min
= glyph
->charpos
;
14349 if (!glyph
->avoid_cursor_p
)
14351 /* If we hit point, we've found the glyph on which to
14352 display the cursor. */
14355 match_with_avoid_cursor
= false;
14358 /* See if we've found a better approximation to
14359 POS_BEFORE or to POS_AFTER. */
14360 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14362 pos_before
= glyph
->charpos
;
14363 glyph_before
= glyph
;
14365 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14367 pos_after
= glyph
->charpos
;
14368 glyph_after
= glyph
;
14371 else if (dpos
== 0)
14372 match_with_avoid_cursor
= true;
14374 else if (STRINGP (glyph
->object
))
14376 Lisp_Object chprop
;
14377 ptrdiff_t glyph_pos
= glyph
->charpos
;
14379 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14381 if (!NILP (chprop
))
14383 /* If the string came from a `display' text property,
14384 look up the buffer position of that property and
14385 use that position to update bpos_max, as if we
14386 actually saw such a position in one of the row's
14387 glyphs. This helps with supporting integer values
14388 of `cursor' property on the display string in
14389 situations where most or all of the row's buffer
14390 text is completely covered by display properties,
14391 so that no glyph with valid buffer positions is
14392 ever seen in the row. */
14393 ptrdiff_t prop_pos
=
14394 string_buffer_position_lim (glyph
->object
, pos_before
,
14397 if (prop_pos
>= pos_before
)
14398 bpos_max
= prop_pos
;
14400 if (INTEGERP (chprop
))
14402 bpos_covered
= bpos_max
+ XINT (chprop
);
14403 /* If the `cursor' property covers buffer positions up
14404 to and including point, we should display cursor on
14405 this glyph. Note that, if a `cursor' property on one
14406 of the string's characters has an integer value, we
14407 will break out of the loop below _before_ we get to
14408 the position match above. IOW, integer values of
14409 the `cursor' property override the "exact match for
14410 point" strategy of positioning the cursor. */
14411 /* Implementation note: bpos_max == pt_old when, e.g.,
14412 we are in an empty line, where bpos_max is set to
14413 MATRIX_ROW_START_CHARPOS, see above. */
14414 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14421 string_seen
= true;
14423 x
+= glyph
->pixel_width
;
14426 else if (glyph
> end
) /* row is reversed */
14427 while (!NILP (glyph
->object
))
14429 if (BUFFERP (glyph
->object
))
14431 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14433 if (glyph
->charpos
> bpos_max
)
14434 bpos_max
= glyph
->charpos
;
14435 if (glyph
->charpos
< bpos_min
)
14436 bpos_min
= glyph
->charpos
;
14437 if (!glyph
->avoid_cursor_p
)
14441 match_with_avoid_cursor
= false;
14444 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14446 pos_before
= glyph
->charpos
;
14447 glyph_before
= glyph
;
14449 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14451 pos_after
= glyph
->charpos
;
14452 glyph_after
= glyph
;
14455 else if (dpos
== 0)
14456 match_with_avoid_cursor
= true;
14458 else if (STRINGP (glyph
->object
))
14460 Lisp_Object chprop
;
14461 ptrdiff_t glyph_pos
= glyph
->charpos
;
14463 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14465 if (!NILP (chprop
))
14467 ptrdiff_t prop_pos
=
14468 string_buffer_position_lim (glyph
->object
, pos_before
,
14471 if (prop_pos
>= pos_before
)
14472 bpos_max
= prop_pos
;
14474 if (INTEGERP (chprop
))
14476 bpos_covered
= bpos_max
+ XINT (chprop
);
14477 /* If the `cursor' property covers buffer positions up
14478 to and including point, we should display cursor on
14480 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14486 string_seen
= true;
14489 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14491 x
--; /* can't use any pixel_width */
14494 x
-= glyph
->pixel_width
;
14497 /* Step 2: If we didn't find an exact match for point, we need to
14498 look for a proper place to put the cursor among glyphs between
14499 GLYPH_BEFORE and GLYPH_AFTER. */
14500 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14501 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14502 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14504 /* An empty line has a single glyph whose OBJECT is nil and
14505 whose CHARPOS is the position of a newline on that line.
14506 Note that on a TTY, there are more glyphs after that, which
14507 were produced by extend_face_to_end_of_line, but their
14508 CHARPOS is zero or negative. */
14509 bool empty_line_p
=
14510 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14511 && NILP (glyph
->object
) && glyph
->charpos
> 0
14512 /* On a TTY, continued and truncated rows also have a glyph at
14513 their end whose OBJECT is nil and whose CHARPOS is
14514 positive (the continuation and truncation glyphs), but such
14515 rows are obviously not "empty". */
14516 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14518 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14520 ptrdiff_t ellipsis_pos
;
14522 /* Scan back over the ellipsis glyphs. */
14523 if (!row
->reversed_p
)
14525 ellipsis_pos
= (glyph
- 1)->charpos
;
14526 while (glyph
> row
->glyphs
[TEXT_AREA
]
14527 && (glyph
- 1)->charpos
== ellipsis_pos
)
14528 glyph
--, x
-= glyph
->pixel_width
;
14529 /* That loop always goes one position too far, including
14530 the glyph before the ellipsis. So scan forward over
14532 x
+= glyph
->pixel_width
;
14535 else /* row is reversed */
14537 ellipsis_pos
= (glyph
+ 1)->charpos
;
14538 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14539 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14540 glyph
++, x
+= glyph
->pixel_width
;
14541 x
-= glyph
->pixel_width
;
14545 else if (match_with_avoid_cursor
)
14547 cursor
= glyph_after
;
14550 else if (string_seen
)
14552 int incr
= row
->reversed_p
? -1 : +1;
14554 /* Need to find the glyph that came out of a string which is
14555 present at point. That glyph is somewhere between
14556 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14557 positioned between POS_BEFORE and POS_AFTER in the
14559 struct glyph
*start
, *stop
;
14560 ptrdiff_t pos
= pos_before
;
14564 /* If the row ends in a newline from a display string,
14565 reordering could have moved the glyphs belonging to the
14566 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14567 in this case we extend the search to the last glyph in
14568 the row that was not inserted by redisplay. */
14569 if (row
->ends_in_newline_from_string_p
)
14572 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14575 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14576 correspond to POS_BEFORE and POS_AFTER, respectively. We
14577 need START and STOP in the order that corresponds to the
14578 row's direction as given by its reversed_p flag. If the
14579 directionality of characters between POS_BEFORE and
14580 POS_AFTER is the opposite of the row's base direction,
14581 these characters will have been reordered for display,
14582 and we need to reverse START and STOP. */
14583 if (!row
->reversed_p
)
14585 start
= min (glyph_before
, glyph_after
);
14586 stop
= max (glyph_before
, glyph_after
);
14590 start
= max (glyph_before
, glyph_after
);
14591 stop
= min (glyph_before
, glyph_after
);
14593 for (glyph
= start
+ incr
;
14594 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14597 /* Any glyphs that come from the buffer are here because
14598 of bidi reordering. Skip them, and only pay
14599 attention to glyphs that came from some string. */
14600 if (STRINGP (glyph
->object
))
14604 /* If the display property covers the newline, we
14605 need to search for it one position farther. */
14606 ptrdiff_t lim
= pos_after
14607 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14609 string_from_text_prop
= false;
14610 str
= glyph
->object
;
14611 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14612 if (tem
== 0 /* from overlay */
14615 /* If the string from which this glyph came is
14616 found in the buffer at point, or at position
14617 that is closer to point than pos_after, then
14618 we've found the glyph we've been looking for.
14619 If it comes from an overlay (tem == 0), and
14620 it has the `cursor' property on one of its
14621 glyphs, record that glyph as a candidate for
14622 displaying the cursor. (As in the
14623 unidirectional version, we will display the
14624 cursor on the last candidate we find.) */
14627 || (tem
- pt_old
> 0 && tem
< pos_after
))
14629 /* The glyphs from this string could have
14630 been reordered. Find the one with the
14631 smallest string position. Or there could
14632 be a character in the string with the
14633 `cursor' property, which means display
14634 cursor on that character's glyph. */
14635 ptrdiff_t strpos
= glyph
->charpos
;
14640 string_from_text_prop
= true;
14643 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14644 && EQ (glyph
->object
, str
);
14648 ptrdiff_t gpos
= glyph
->charpos
;
14650 cprop
= Fget_char_property (make_number (gpos
),
14658 if (tem
&& glyph
->charpos
< strpos
)
14660 strpos
= glyph
->charpos
;
14666 || (tem
- pt_old
> 0 && tem
< pos_after
))
14670 pos
= tem
+ 1; /* don't find previous instances */
14672 /* This string is not what we want; skip all of the
14673 glyphs that came from it. */
14674 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14675 && EQ (glyph
->object
, str
))
14682 /* If we reached the end of the line, and END was from a string,
14683 the cursor is not on this line. */
14685 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14686 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14687 && STRINGP (end
->object
)
14688 && row
->continued_p
)
14691 /* A truncated row may not include PT among its character positions.
14692 Setting the cursor inside the scroll margin will trigger
14693 recalculation of hscroll in hscroll_window_tree. But if a
14694 display string covers point, defer to the string-handling
14695 code below to figure this out. */
14696 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14698 cursor
= glyph_before
;
14701 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14702 /* Zero-width characters produce no glyphs. */
14704 && (row
->reversed_p
14705 ? glyph_after
> glyphs_end
14706 : glyph_after
< glyphs_end
)))
14708 cursor
= glyph_after
;
14714 if (cursor
!= NULL
)
14716 else if (glyph
== glyphs_end
14717 && pos_before
== pos_after
14718 && STRINGP ((row
->reversed_p
14719 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14720 : row
->glyphs
[TEXT_AREA
])->object
))
14722 /* If all the glyphs of this row came from strings, put the
14723 cursor on the first glyph of the row. This avoids having the
14724 cursor outside of the text area in this very rare and hard
14728 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14729 : row
->glyphs
[TEXT_AREA
];
14735 /* Need to compute x that corresponds to GLYPH. */
14736 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14738 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14740 x
+= g
->pixel_width
;
14744 /* ROW could be part of a continued line, which, under bidi
14745 reordering, might have other rows whose start and end charpos
14746 occlude point. Only set w->cursor if we found a better
14747 approximation to the cursor position than we have from previously
14748 examined candidate rows belonging to the same continued line. */
14749 if (/* We already have a candidate row. */
14750 w
->cursor
.vpos
>= 0
14751 /* That candidate is not the row we are processing. */
14752 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14753 /* Make sure cursor.vpos specifies a row whose start and end
14754 charpos occlude point, and it is valid candidate for being a
14755 cursor-row. This is because some callers of this function
14756 leave cursor.vpos at the row where the cursor was displayed
14757 during the last redisplay cycle. */
14758 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14759 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14760 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14763 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14765 /* Don't consider glyphs that are outside TEXT_AREA. */
14766 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14768 /* Keep the candidate whose buffer position is the closest to
14769 point or has the `cursor' property. */
14770 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14771 w
->cursor
.hpos
>= 0
14772 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14773 && ((BUFFERP (g1
->object
)
14774 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14775 || (BUFFERP (glyph
->object
)
14776 && eabs (g1
->charpos
- pt_old
)
14777 < eabs (glyph
->charpos
- pt_old
))))
14778 /* Previous candidate is a glyph from a string that has
14779 a non-nil `cursor' property. */
14780 || (STRINGP (g1
->object
)
14781 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14782 Qcursor
, g1
->object
))
14783 /* Previous candidate is from the same display
14784 string as this one, and the display string
14785 came from a text property. */
14786 || (EQ (g1
->object
, glyph
->object
)
14787 && string_from_text_prop
)
14788 /* this candidate is from newline and its
14789 position is not an exact match */
14790 || (NILP (glyph
->object
)
14791 && glyph
->charpos
!= pt_old
)))))
14793 /* If this candidate gives an exact match, use that. */
14794 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14795 /* If this candidate is a glyph created for the
14796 terminating newline of a line, and point is on that
14797 newline, it wins because it's an exact match. */
14798 || (!row
->continued_p
14799 && NILP (glyph
->object
)
14800 && glyph
->charpos
== 0
14801 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14802 /* Otherwise, keep the candidate that comes from a row
14803 spanning less buffer positions. This may win when one or
14804 both candidate positions are on glyphs that came from
14805 display strings, for which we cannot compare buffer
14807 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14808 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14809 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14812 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14814 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14815 w
->cursor
.y
= row
->y
+ dy
;
14817 if (w
== XWINDOW (selected_window
))
14819 if (!row
->continued_p
14820 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14823 this_line_buffer
= XBUFFER (w
->contents
);
14825 CHARPOS (this_line_start_pos
)
14826 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14827 BYTEPOS (this_line_start_pos
)
14828 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14830 CHARPOS (this_line_end_pos
)
14831 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14832 BYTEPOS (this_line_end_pos
)
14833 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14835 this_line_y
= w
->cursor
.y
;
14836 this_line_pixel_height
= row
->height
;
14837 this_line_vpos
= w
->cursor
.vpos
;
14838 this_line_start_x
= row
->x
;
14841 CHARPOS (this_line_start_pos
) = 0;
14848 /* Run window scroll functions, if any, for WINDOW with new window
14849 start STARTP. Sets the window start of WINDOW to that position.
14851 We assume that the window's buffer is really current. */
14853 static struct text_pos
14854 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14856 struct window
*w
= XWINDOW (window
);
14857 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14859 eassert (current_buffer
== XBUFFER (w
->contents
));
14861 if (!NILP (Vwindow_scroll_functions
))
14863 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14864 make_number (CHARPOS (startp
)));
14865 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14866 /* In case the hook functions switch buffers. */
14867 set_buffer_internal (XBUFFER (w
->contents
));
14874 /* Make sure the line containing the cursor is fully visible.
14875 A value of true means there is nothing to be done.
14876 (Either the line is fully visible, or it cannot be made so,
14877 or we cannot tell.)
14879 If FORCE_P, return false even if partial visible cursor row
14880 is higher than window.
14882 If CURRENT_MATRIX_P, use the information from the
14883 window's current glyph matrix; otherwise use the desired glyph
14886 A value of false means the caller should do scrolling
14887 as if point had gone off the screen. */
14890 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
14891 bool current_matrix_p
)
14893 struct glyph_matrix
*matrix
;
14894 struct glyph_row
*row
;
14897 if (!make_cursor_line_fully_visible_p
)
14900 /* It's not always possible to find the cursor, e.g, when a window
14901 is full of overlay strings. Don't do anything in that case. */
14902 if (w
->cursor
.vpos
< 0)
14905 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14906 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14908 /* If the cursor row is not partially visible, there's nothing to do. */
14909 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14912 /* If the row the cursor is in is taller than the window's height,
14913 it's not clear what to do, so do nothing. */
14914 window_height
= window_box_height (w
);
14915 if (row
->height
>= window_height
)
14917 if (!force_p
|| MINI_WINDOW_P (w
)
14918 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14925 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14926 means only WINDOW is redisplayed in redisplay_internal.
14927 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14928 in redisplay_window to bring a partially visible line into view in
14929 the case that only the cursor has moved.
14931 LAST_LINE_MISFIT should be true if we're scrolling because the
14932 last screen line's vertical height extends past the end of the screen.
14936 1 if scrolling succeeded
14938 0 if scrolling didn't find point.
14940 -1 if new fonts have been loaded so that we must interrupt
14941 redisplay, adjust glyph matrices, and try again. */
14947 SCROLLING_NEED_LARGER_MATRICES
14950 /* If scroll-conservatively is more than this, never recenter.
14952 If you change this, don't forget to update the doc string of
14953 `scroll-conservatively' and the Emacs manual. */
14954 #define SCROLL_LIMIT 100
14957 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
14958 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14959 bool temp_scroll_step
, bool last_line_misfit
)
14961 struct window
*w
= XWINDOW (window
);
14962 struct frame
*f
= XFRAME (w
->frame
);
14963 struct text_pos pos
, startp
;
14965 int this_scroll_margin
, scroll_max
, rc
, height
;
14966 int dy
= 0, amount_to_scroll
= 0;
14967 bool scroll_down_p
= false;
14968 int extra_scroll_margin_lines
= last_line_misfit
;
14969 Lisp_Object aggressive
;
14970 /* We will never try scrolling more than this number of lines. */
14971 int scroll_limit
= SCROLL_LIMIT
;
14972 int frame_line_height
= default_line_pixel_height (w
);
14973 int window_total_lines
14974 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
14977 debug_method_add (w
, "try_scrolling");
14980 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14982 /* Compute scroll margin height in pixels. We scroll when point is
14983 within this distance from the top or bottom of the window. */
14984 if (scroll_margin
> 0)
14985 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
14986 * frame_line_height
;
14988 this_scroll_margin
= 0;
14990 /* Force arg_scroll_conservatively to have a reasonable value, to
14991 avoid scrolling too far away with slow move_it_* functions. Note
14992 that the user can supply scroll-conservatively equal to
14993 `most-positive-fixnum', which can be larger than INT_MAX. */
14994 if (arg_scroll_conservatively
> scroll_limit
)
14996 arg_scroll_conservatively
= scroll_limit
+ 1;
14997 scroll_max
= scroll_limit
* frame_line_height
;
14999 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15000 /* Compute how much we should try to scroll maximally to bring
15001 point into view. */
15002 scroll_max
= (max (scroll_step
,
15003 max (arg_scroll_conservatively
, temp_scroll_step
))
15004 * frame_line_height
);
15005 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15006 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15007 /* We're trying to scroll because of aggressive scrolling but no
15008 scroll_step is set. Choose an arbitrary one. */
15009 scroll_max
= 10 * frame_line_height
;
15015 /* Decide whether to scroll down. */
15016 if (PT
> CHARPOS (startp
))
15018 int scroll_margin_y
;
15020 /* Compute the pixel ypos of the scroll margin, then move IT to
15021 either that ypos or PT, whichever comes first. */
15022 start_display (&it
, w
, startp
);
15023 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15024 - frame_line_height
* extra_scroll_margin_lines
;
15025 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15026 (MOVE_TO_POS
| MOVE_TO_Y
));
15028 if (PT
> CHARPOS (it
.current
.pos
))
15030 int y0
= line_bottom_y (&it
);
15031 /* Compute how many pixels below window bottom to stop searching
15032 for PT. This avoids costly search for PT that is far away if
15033 the user limited scrolling by a small number of lines, but
15034 always finds PT if scroll_conservatively is set to a large
15035 number, such as most-positive-fixnum. */
15036 int slack
= max (scroll_max
, 10 * frame_line_height
);
15037 int y_to_move
= it
.last_visible_y
+ slack
;
15039 /* Compute the distance from the scroll margin to PT or to
15040 the scroll limit, whichever comes first. This should
15041 include the height of the cursor line, to make that line
15043 move_it_to (&it
, PT
, -1, y_to_move
,
15044 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15045 dy
= line_bottom_y (&it
) - y0
;
15047 if (dy
> scroll_max
)
15048 return SCROLLING_FAILED
;
15051 scroll_down_p
= true;
15057 /* Point is in or below the bottom scroll margin, so move the
15058 window start down. If scrolling conservatively, move it just
15059 enough down to make point visible. If scroll_step is set,
15060 move it down by scroll_step. */
15061 if (arg_scroll_conservatively
)
15063 = min (max (dy
, frame_line_height
),
15064 frame_line_height
* arg_scroll_conservatively
);
15065 else if (scroll_step
|| temp_scroll_step
)
15066 amount_to_scroll
= scroll_max
;
15069 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15070 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15071 if (NUMBERP (aggressive
))
15073 double float_amount
= XFLOATINT (aggressive
) * height
;
15074 int aggressive_scroll
= float_amount
;
15075 if (aggressive_scroll
== 0 && float_amount
> 0)
15076 aggressive_scroll
= 1;
15077 /* Don't let point enter the scroll margin near top of
15078 the window. This could happen if the value of
15079 scroll_up_aggressively is too large and there are
15080 non-zero margins, because scroll_up_aggressively
15081 means put point that fraction of window height
15082 _from_the_bottom_margin_. */
15083 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15084 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15085 amount_to_scroll
= dy
+ aggressive_scroll
;
15089 if (amount_to_scroll
<= 0)
15090 return SCROLLING_FAILED
;
15092 start_display (&it
, w
, startp
);
15093 if (arg_scroll_conservatively
<= scroll_limit
)
15094 move_it_vertically (&it
, amount_to_scroll
);
15097 /* Extra precision for users who set scroll-conservatively
15098 to a large number: make sure the amount we scroll
15099 the window start is never less than amount_to_scroll,
15100 which was computed as distance from window bottom to
15101 point. This matters when lines at window top and lines
15102 below window bottom have different height. */
15104 void *it1data
= NULL
;
15105 /* We use a temporary it1 because line_bottom_y can modify
15106 its argument, if it moves one line down; see there. */
15109 SAVE_IT (it1
, it
, it1data
);
15110 start_y
= line_bottom_y (&it1
);
15112 RESTORE_IT (&it
, &it
, it1data
);
15113 move_it_by_lines (&it
, 1);
15114 SAVE_IT (it1
, it
, it1data
);
15115 } while (IT_CHARPOS (it
) < ZV
15116 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15117 bidi_unshelve_cache (it1data
, true);
15120 /* If STARTP is unchanged, move it down another screen line. */
15121 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15122 move_it_by_lines (&it
, 1);
15123 startp
= it
.current
.pos
;
15127 struct text_pos scroll_margin_pos
= startp
;
15130 /* See if point is inside the scroll margin at the top of the
15132 if (this_scroll_margin
)
15136 start_display (&it
, w
, startp
);
15137 y_start
= it
.current_y
;
15138 move_it_vertically (&it
, this_scroll_margin
);
15139 scroll_margin_pos
= it
.current
.pos
;
15140 /* If we didn't move enough before hitting ZV, request
15141 additional amount of scroll, to move point out of the
15143 if (IT_CHARPOS (it
) == ZV
15144 && it
.current_y
- y_start
< this_scroll_margin
)
15145 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15148 if (PT
< CHARPOS (scroll_margin_pos
))
15150 /* Point is in the scroll margin at the top of the window or
15151 above what is displayed in the window. */
15154 /* Compute the vertical distance from PT to the scroll
15155 margin position. Move as far as scroll_max allows, or
15156 one screenful, or 10 screen lines, whichever is largest.
15157 Give up if distance is greater than scroll_max or if we
15158 didn't reach the scroll margin position. */
15159 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15160 start_display (&it
, w
, pos
);
15162 y_to_move
= max (it
.last_visible_y
,
15163 max (scroll_max
, 10 * frame_line_height
));
15164 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15166 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15167 dy
= it
.current_y
- y0
;
15168 if (dy
> scroll_max
15169 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15170 return SCROLLING_FAILED
;
15172 /* Additional scroll for when ZV was too close to point. */
15175 /* Compute new window start. */
15176 start_display (&it
, w
, startp
);
15178 if (arg_scroll_conservatively
)
15179 amount_to_scroll
= max (dy
, frame_line_height
15180 * max (scroll_step
, temp_scroll_step
));
15181 else if (scroll_step
|| temp_scroll_step
)
15182 amount_to_scroll
= scroll_max
;
15185 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15186 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15187 if (NUMBERP (aggressive
))
15189 double float_amount
= XFLOATINT (aggressive
) * height
;
15190 int aggressive_scroll
= float_amount
;
15191 if (aggressive_scroll
== 0 && float_amount
> 0)
15192 aggressive_scroll
= 1;
15193 /* Don't let point enter the scroll margin near
15194 bottom of the window, if the value of
15195 scroll_down_aggressively happens to be too
15197 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15198 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15199 amount_to_scroll
= dy
+ aggressive_scroll
;
15203 if (amount_to_scroll
<= 0)
15204 return SCROLLING_FAILED
;
15206 move_it_vertically_backward (&it
, amount_to_scroll
);
15207 startp
= it
.current
.pos
;
15211 /* Run window scroll functions. */
15212 startp
= run_window_scroll_functions (window
, startp
);
15214 /* Display the window. Give up if new fonts are loaded, or if point
15216 if (!try_window (window
, startp
, 0))
15217 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15218 else if (w
->cursor
.vpos
< 0)
15220 clear_glyph_matrix (w
->desired_matrix
);
15221 rc
= SCROLLING_FAILED
;
15225 /* Maybe forget recorded base line for line number display. */
15226 if (!just_this_one_p
15227 || current_buffer
->clip_changed
15228 || BEG_UNCHANGED
< CHARPOS (startp
))
15229 w
->base_line_number
= 0;
15231 /* If cursor ends up on a partially visible line,
15232 treat that as being off the bottom of the screen. */
15233 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15235 /* It's possible that the cursor is on the first line of the
15236 buffer, which is partially obscured due to a vscroll
15237 (Bug#7537). In that case, avoid looping forever. */
15238 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15240 clear_glyph_matrix (w
->desired_matrix
);
15241 ++extra_scroll_margin_lines
;
15244 rc
= SCROLLING_SUCCESS
;
15251 /* Compute a suitable window start for window W if display of W starts
15252 on a continuation line. Value is true if a new window start
15255 The new window start will be computed, based on W's width, starting
15256 from the start of the continued line. It is the start of the
15257 screen line with the minimum distance from the old start W->start. */
15260 compute_window_start_on_continuation_line (struct window
*w
)
15262 struct text_pos pos
, start_pos
;
15263 bool window_start_changed_p
= false;
15265 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15267 /* If window start is on a continuation line... Window start may be
15268 < BEGV in case there's invisible text at the start of the
15269 buffer (M-x rmail, for example). */
15270 if (CHARPOS (start_pos
) > BEGV
15271 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15274 struct glyph_row
*row
;
15276 /* Handle the case that the window start is out of range. */
15277 if (CHARPOS (start_pos
) < BEGV
)
15278 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15279 else if (CHARPOS (start_pos
) > ZV
)
15280 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15282 /* Find the start of the continued line. This should be fast
15283 because find_newline is fast (newline cache). */
15284 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15285 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15286 row
, DEFAULT_FACE_ID
);
15287 reseat_at_previous_visible_line_start (&it
);
15289 /* If the line start is "too far" away from the window start,
15290 say it takes too much time to compute a new window start. */
15291 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15292 /* PXW: Do we need upper bounds here? */
15293 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15295 int min_distance
, distance
;
15297 /* Move forward by display lines to find the new window
15298 start. If window width was enlarged, the new start can
15299 be expected to be > the old start. If window width was
15300 decreased, the new window start will be < the old start.
15301 So, we're looking for the display line start with the
15302 minimum distance from the old window start. */
15303 pos
= it
.current
.pos
;
15304 min_distance
= INFINITY
;
15305 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15306 distance
< min_distance
)
15308 min_distance
= distance
;
15309 pos
= it
.current
.pos
;
15310 if (it
.line_wrap
== WORD_WRAP
)
15312 /* Under WORD_WRAP, move_it_by_lines is likely to
15313 overshoot and stop not at the first, but the
15314 second character from the left margin. So in
15315 that case, we need a more tight control on the X
15316 coordinate of the iterator than move_it_by_lines
15317 promises in its contract. The method is to first
15318 go to the last (rightmost) visible character of a
15319 line, then move to the leftmost character on the
15320 next line in a separate call. */
15321 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15322 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15323 move_it_to (&it
, ZV
, 0,
15324 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15325 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15328 move_it_by_lines (&it
, 1);
15331 /* Set the window start there. */
15332 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15333 window_start_changed_p
= true;
15337 return window_start_changed_p
;
15341 /* Try cursor movement in case text has not changed in window WINDOW,
15342 with window start STARTP. Value is
15344 CURSOR_MOVEMENT_SUCCESS if successful
15346 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15348 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15349 display. *SCROLL_STEP is set to true, under certain circumstances, if
15350 we want to scroll as if scroll-step were set to 1. See the code.
15352 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15353 which case we have to abort this redisplay, and adjust matrices
15358 CURSOR_MOVEMENT_SUCCESS
,
15359 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15360 CURSOR_MOVEMENT_MUST_SCROLL
,
15361 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15365 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15368 struct window
*w
= XWINDOW (window
);
15369 struct frame
*f
= XFRAME (w
->frame
);
15370 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15373 if (inhibit_try_cursor_movement
)
15377 /* Previously, there was a check for Lisp integer in the
15378 if-statement below. Now, this field is converted to
15379 ptrdiff_t, thus zero means invalid position in a buffer. */
15380 eassert (w
->last_point
> 0);
15381 /* Likewise there was a check whether window_end_vpos is nil or larger
15382 than the window. Now window_end_vpos is int and so never nil, but
15383 let's leave eassert to check whether it fits in the window. */
15384 eassert (!w
->window_end_valid
15385 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15387 /* Handle case where text has not changed, only point, and it has
15388 not moved off the frame. */
15389 if (/* Point may be in this window. */
15390 PT
>= CHARPOS (startp
)
15391 /* Selective display hasn't changed. */
15392 && !current_buffer
->clip_changed
15393 /* Function force-mode-line-update is used to force a thorough
15394 redisplay. It sets either windows_or_buffers_changed or
15395 update_mode_lines. So don't take a shortcut here for these
15397 && !update_mode_lines
15398 && !windows_or_buffers_changed
15399 && !f
->cursor_type_changed
15400 && NILP (Vshow_trailing_whitespace
)
15401 /* This code is not used for mini-buffer for the sake of the case
15402 of redisplaying to replace an echo area message; since in
15403 that case the mini-buffer contents per se are usually
15404 unchanged. This code is of no real use in the mini-buffer
15405 since the handling of this_line_start_pos, etc., in redisplay
15406 handles the same cases. */
15407 && !EQ (window
, minibuf_window
)
15408 && (FRAME_WINDOW_P (f
)
15409 || !overlay_arrow_in_current_buffer_p ()))
15411 int this_scroll_margin
, top_scroll_margin
;
15412 struct glyph_row
*row
= NULL
;
15413 int frame_line_height
= default_line_pixel_height (w
);
15414 int window_total_lines
15415 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15418 debug_method_add (w
, "cursor movement");
15421 /* Scroll if point within this distance from the top or bottom
15422 of the window. This is a pixel value. */
15423 if (scroll_margin
> 0)
15425 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15426 this_scroll_margin
*= frame_line_height
;
15429 this_scroll_margin
= 0;
15431 top_scroll_margin
= this_scroll_margin
;
15432 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15433 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15435 /* Start with the row the cursor was displayed during the last
15436 not paused redisplay. Give up if that row is not valid. */
15437 if (w
->last_cursor_vpos
< 0
15438 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15439 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15442 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15443 if (row
->mode_line_p
)
15445 if (!row
->enabled_p
)
15446 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15449 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15451 bool scroll_p
= false, must_scroll
= false;
15452 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15454 if (PT
> w
->last_point
)
15456 /* Point has moved forward. */
15457 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15458 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15460 eassert (row
->enabled_p
);
15464 /* If the end position of a row equals the start
15465 position of the next row, and PT is at that position,
15466 we would rather display cursor in the next line. */
15467 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15468 && MATRIX_ROW_END_CHARPOS (row
) == PT
15469 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15470 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15471 && !cursor_row_p (row
))
15474 /* If within the scroll margin, scroll. Note that
15475 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15476 the next line would be drawn, and that
15477 this_scroll_margin can be zero. */
15478 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15479 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15480 /* Line is completely visible last line in window
15481 and PT is to be set in the next line. */
15482 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15483 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15484 && !row
->ends_at_zv_p
15485 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15488 else if (PT
< w
->last_point
)
15490 /* Cursor has to be moved backward. Note that PT >=
15491 CHARPOS (startp) because of the outer if-statement. */
15492 while (!row
->mode_line_p
15493 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15494 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15495 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15496 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15497 row
> w
->current_matrix
->rows
15498 && (row
-1)->ends_in_newline_from_string_p
))))
15499 && (row
->y
> top_scroll_margin
15500 || CHARPOS (startp
) == BEGV
))
15502 eassert (row
->enabled_p
);
15506 /* Consider the following case: Window starts at BEGV,
15507 there is invisible, intangible text at BEGV, so that
15508 display starts at some point START > BEGV. It can
15509 happen that we are called with PT somewhere between
15510 BEGV and START. Try to handle that case. */
15511 if (row
< w
->current_matrix
->rows
15512 || row
->mode_line_p
)
15514 row
= w
->current_matrix
->rows
;
15515 if (row
->mode_line_p
)
15519 /* Due to newlines in overlay strings, we may have to
15520 skip forward over overlay strings. */
15521 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15522 && MATRIX_ROW_END_CHARPOS (row
) == PT
15523 && !cursor_row_p (row
))
15526 /* If within the scroll margin, scroll. */
15527 if (row
->y
< top_scroll_margin
15528 && CHARPOS (startp
) != BEGV
)
15533 /* Cursor did not move. So don't scroll even if cursor line
15534 is partially visible, as it was so before. */
15535 rc
= CURSOR_MOVEMENT_SUCCESS
;
15538 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15539 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15541 /* if PT is not in the glyph row, give up. */
15542 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15543 must_scroll
= true;
15545 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15546 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15548 struct glyph_row
*row1
;
15550 /* If rows are bidi-reordered and point moved, back up
15551 until we find a row that does not belong to a
15552 continuation line. This is because we must consider
15553 all rows of a continued line as candidates for the
15554 new cursor positioning, since row start and end
15555 positions change non-linearly with vertical position
15557 /* FIXME: Revisit this when glyph ``spilling'' in
15558 continuation lines' rows is implemented for
15559 bidi-reordered rows. */
15560 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15561 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15564 /* If we hit the beginning of the displayed portion
15565 without finding the first row of a continued
15569 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15572 eassert (row
->enabled_p
);
15577 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15578 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15579 /* Make sure this isn't a header line by any chance, since
15580 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15581 && !row
->mode_line_p
15582 && make_cursor_line_fully_visible_p
)
15584 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15585 && !row
->ends_at_zv_p
15586 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15587 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15588 else if (row
->height
> window_box_height (w
))
15590 /* If we end up in a partially visible line, let's
15591 make it fully visible, except when it's taller
15592 than the window, in which case we can't do much
15594 *scroll_step
= true;
15595 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15599 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15600 if (!cursor_row_fully_visible_p (w
, false, true))
15601 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15603 rc
= CURSOR_MOVEMENT_SUCCESS
;
15607 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15608 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15609 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15611 /* With bidi-reordered rows, there could be more than
15612 one candidate row whose start and end positions
15613 occlude point. We need to let set_cursor_from_row
15614 find the best candidate. */
15615 /* FIXME: Revisit this when glyph ``spilling'' in
15616 continuation lines' rows is implemented for
15617 bidi-reordered rows. */
15622 bool at_zv_p
= false, exact_match_p
= false;
15624 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15625 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15626 && cursor_row_p (row
))
15627 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15629 /* As soon as we've found the exact match for point,
15630 or the first suitable row whose ends_at_zv_p flag
15631 is set, we are done. */
15634 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15635 w
->cursor
.vpos
)->ends_at_zv_p
;
15637 && w
->cursor
.hpos
>= 0
15638 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15641 struct glyph_row
*candidate
=
15642 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15644 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15645 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15648 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15649 || (NILP (g
->object
)
15650 && (g
->charpos
== PT
15651 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15653 if (at_zv_p
|| exact_match_p
)
15655 rc
= CURSOR_MOVEMENT_SUCCESS
;
15659 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15663 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15664 || row
->continued_p
)
15665 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15666 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15667 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15668 /* If we didn't find any candidate rows, or exited the
15669 loop before all the candidates were examined, signal
15670 to the caller that this method failed. */
15671 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15673 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15674 && !row
->continued_p
))
15675 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15677 rc
= CURSOR_MOVEMENT_SUCCESS
;
15683 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15685 rc
= CURSOR_MOVEMENT_SUCCESS
;
15690 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15691 && MATRIX_ROW_START_CHARPOS (row
) == PT
15692 && cursor_row_p (row
));
15702 set_vertical_scroll_bar (struct window
*w
)
15704 ptrdiff_t start
, end
, whole
;
15706 /* Calculate the start and end positions for the current window.
15707 At some point, it would be nice to choose between scrollbars
15708 which reflect the whole buffer size, with special markers
15709 indicating narrowing, and scrollbars which reflect only the
15712 Note that mini-buffers sometimes aren't displaying any text. */
15713 if (!MINI_WINDOW_P (w
)
15714 || (w
== XWINDOW (minibuf_window
)
15715 && NILP (echo_area_buffer
[0])))
15717 struct buffer
*buf
= XBUFFER (w
->contents
);
15718 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15719 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15720 /* I don't think this is guaranteed to be right. For the
15721 moment, we'll pretend it is. */
15722 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15726 if (whole
< (end
- start
))
15727 whole
= end
- start
;
15730 start
= end
= whole
= 0;
15732 /* Indicate what this scroll bar ought to be displaying now. */
15733 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15734 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15735 (w
, end
- start
, whole
, start
);
15740 set_horizontal_scroll_bar (struct window
*w
)
15742 int start
, end
, whole
, portion
;
15744 if (!MINI_WINDOW_P (w
)
15745 || (w
== XWINDOW (minibuf_window
)
15746 && NILP (echo_area_buffer
[0])))
15748 struct buffer
*b
= XBUFFER (w
->contents
);
15749 struct buffer
*old_buffer
= NULL
;
15751 struct text_pos startp
;
15753 if (b
!= current_buffer
)
15755 old_buffer
= current_buffer
;
15756 set_buffer_internal (b
);
15759 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15760 start_display (&it
, w
, startp
);
15761 it
.last_visible_x
= INT_MAX
;
15762 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15763 MOVE_TO_X
| MOVE_TO_Y
);
15764 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15765 window_box_height (w), -1,
15766 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15768 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15769 end
= start
+ window_box_width (w
, TEXT_AREA
);
15770 portion
= end
- start
;
15771 /* After enlarging a horizontally scrolled window such that it
15772 gets at least as wide as the text it contains, make sure that
15773 the thumb doesn't fill the entire scroll bar so we can still
15774 drag it back to see the entire text. */
15775 whole
= max (whole
, end
);
15781 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15782 if (EQ (pdir
, Qright_to_left
))
15784 start
= whole
- end
;
15785 end
= start
+ portion
;
15790 set_buffer_internal (old_buffer
);
15793 start
= end
= whole
= portion
= 0;
15795 w
->hscroll_whole
= whole
;
15797 /* Indicate what this scroll bar ought to be displaying now. */
15798 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15799 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15800 (w
, portion
, whole
, start
);
15804 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15805 selected_window is redisplayed.
15807 We can return without actually redisplaying the window if fonts has been
15808 changed on window's frame. In that case, redisplay_internal will retry.
15810 As one of the important parts of redisplaying a window, we need to
15811 decide whether the previous window-start position (stored in the
15812 window's w->start marker position) is still valid, and if it isn't,
15813 recompute it. Some details about that:
15815 . The previous window-start could be in a continuation line, in
15816 which case we need to recompute it when the window width
15817 changes. See compute_window_start_on_continuation_line and its
15820 . The text that changed since last redisplay could include the
15821 previous window-start position. In that case, we try to salvage
15822 what we can from the current glyph matrix by calling
15823 try_scrolling, which see.
15825 . Some Emacs command could force us to use a specific window-start
15826 position by setting the window's force_start flag, or gently
15827 propose doing that by setting the window's optional_new_start
15828 flag. In these cases, we try using the specified start point if
15829 that succeeds (i.e. the window desired matrix is successfully
15830 recomputed, and point location is within the window). In case
15831 of optional_new_start, we first check if the specified start
15832 position is feasible, i.e. if it will allow point to be
15833 displayed in the window. If using the specified start point
15834 fails, e.g., if new fonts are needed to be loaded, we abort the
15835 redisplay cycle and leave it up to the next cycle to figure out
15838 . Note that the window's force_start flag is sometimes set by
15839 redisplay itself, when it decides that the previous window start
15840 point is fine and should be kept. Search for "goto force_start"
15841 below to see the details. Like the values of window-start
15842 specified outside of redisplay, these internally-deduced values
15843 are tested for feasibility, and ignored if found to be
15846 . Note that the function try_window, used to completely redisplay
15847 a window, accepts the window's start point as its argument.
15848 This is used several times in the redisplay code to control
15849 where the window start will be, according to user options such
15850 as scroll-conservatively, and also to ensure the screen line
15851 showing point will be fully (as opposed to partially) visible on
15855 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15857 struct window
*w
= XWINDOW (window
);
15858 struct frame
*f
= XFRAME (w
->frame
);
15859 struct buffer
*buffer
= XBUFFER (w
->contents
);
15860 struct buffer
*old
= current_buffer
;
15861 struct text_pos lpoint
, opoint
, startp
;
15862 bool update_mode_line
;
15865 /* Record it now because it's overwritten. */
15866 bool current_matrix_up_to_date_p
= false;
15867 bool used_current_matrix_p
= false;
15868 /* This is less strict than current_matrix_up_to_date_p.
15869 It indicates that the buffer contents and narrowing are unchanged. */
15870 bool buffer_unchanged_p
= false;
15871 bool temp_scroll_step
= false;
15872 ptrdiff_t count
= SPECPDL_INDEX ();
15874 int centering_position
= -1;
15875 bool last_line_misfit
= false;
15876 ptrdiff_t beg_unchanged
, end_unchanged
;
15877 int frame_line_height
;
15879 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15883 *w
->desired_matrix
->method
= 0;
15886 if (!just_this_one_p
15887 && REDISPLAY_SOME_P ()
15889 && !w
->update_mode_line
15891 && !buffer
->text
->redisplay
15892 && BUF_PT (buffer
) == w
->last_point
)
15895 /* Make sure that both W's markers are valid. */
15896 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15897 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15899 /* We come here again if we need to run window-text-change-functions
15902 reconsider_clip_changes (w
);
15903 frame_line_height
= default_line_pixel_height (w
);
15905 /* Has the mode line to be updated? */
15906 update_mode_line
= (w
->update_mode_line
15907 || update_mode_lines
15908 || buffer
->clip_changed
15909 || buffer
->prevent_redisplay_optimizations_p
);
15911 if (!just_this_one_p
)
15912 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15913 cleverly elsewhere. */
15914 w
->must_be_updated_p
= true;
15916 if (MINI_WINDOW_P (w
))
15918 if (w
== XWINDOW (echo_area_window
)
15919 && !NILP (echo_area_buffer
[0]))
15921 if (update_mode_line
)
15922 /* We may have to update a tty frame's menu bar or a
15923 tool-bar. Example `M-x C-h C-h C-g'. */
15924 goto finish_menu_bars
;
15926 /* We've already displayed the echo area glyphs in this window. */
15927 goto finish_scroll_bars
;
15929 else if ((w
!= XWINDOW (minibuf_window
)
15930 || minibuf_level
== 0)
15931 /* When buffer is nonempty, redisplay window normally. */
15932 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15933 /* Quail displays non-mini buffers in minibuffer window.
15934 In that case, redisplay the window normally. */
15935 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15937 /* W is a mini-buffer window, but it's not active, so clear
15939 int yb
= window_text_bottom_y (w
);
15940 struct glyph_row
*row
;
15943 for (y
= 0, row
= w
->desired_matrix
->rows
;
15945 y
+= row
->height
, ++row
)
15946 blank_row (w
, row
, y
);
15947 goto finish_scroll_bars
;
15950 clear_glyph_matrix (w
->desired_matrix
);
15953 /* Otherwise set up data on this window; select its buffer and point
15955 /* Really select the buffer, for the sake of buffer-local
15957 set_buffer_internal_1 (XBUFFER (w
->contents
));
15959 current_matrix_up_to_date_p
15960 = (w
->window_end_valid
15961 && !current_buffer
->clip_changed
15962 && !current_buffer
->prevent_redisplay_optimizations_p
15963 && !window_outdated (w
));
15965 /* Run the window-text-change-functions
15966 if it is possible that the text on the screen has changed
15967 (either due to modification of the text, or any other reason). */
15968 if (!current_matrix_up_to_date_p
15969 && !NILP (Vwindow_text_change_functions
))
15971 safe_run_hooks (Qwindow_text_change_functions
);
15975 beg_unchanged
= BEG_UNCHANGED
;
15976 end_unchanged
= END_UNCHANGED
;
15978 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15980 specbind (Qinhibit_point_motion_hooks
, Qt
);
15983 = (w
->window_end_valid
15984 && !current_buffer
->clip_changed
15985 && !window_outdated (w
));
15987 /* When windows_or_buffers_changed is non-zero, we can't rely
15988 on the window end being valid, so set it to zero there. */
15989 if (windows_or_buffers_changed
)
15991 /* If window starts on a continuation line, maybe adjust the
15992 window start in case the window's width changed. */
15993 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15994 compute_window_start_on_continuation_line (w
);
15996 w
->window_end_valid
= false;
15997 /* If so, we also can't rely on current matrix
15998 and should not fool try_cursor_movement below. */
15999 current_matrix_up_to_date_p
= false;
16002 /* Some sanity checks. */
16003 CHECK_WINDOW_END (w
);
16004 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16006 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16009 if (mode_line_update_needed (w
))
16010 update_mode_line
= true;
16012 /* Point refers normally to the selected window. For any other
16013 window, set up appropriate value. */
16014 if (!EQ (window
, selected_window
))
16016 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16017 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16022 new_pt_byte
= BEGV_BYTE
;
16023 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16025 else if (new_pt
> (ZV
- 1))
16028 new_pt_byte
= ZV_BYTE
;
16029 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16032 /* We don't use SET_PT so that the point-motion hooks don't run. */
16033 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16036 /* If any of the character widths specified in the display table
16037 have changed, invalidate the width run cache. It's true that
16038 this may be a bit late to catch such changes, but the rest of
16039 redisplay goes (non-fatally) haywire when the display table is
16040 changed, so why should we worry about doing any better? */
16041 if (current_buffer
->width_run_cache
16042 || (current_buffer
->base_buffer
16043 && current_buffer
->base_buffer
->width_run_cache
))
16045 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16047 if (! disptab_matches_widthtab
16048 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16050 struct buffer
*buf
= current_buffer
;
16052 if (buf
->base_buffer
)
16053 buf
= buf
->base_buffer
;
16054 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16055 recompute_width_table (current_buffer
, disptab
);
16059 /* If window-start is screwed up, choose a new one. */
16060 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16063 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16065 /* If someone specified a new starting point but did not insist,
16066 check whether it can be used. */
16067 if ((w
->optional_new_start
|| window_frozen_p (w
))
16068 && CHARPOS (startp
) >= BEGV
16069 && CHARPOS (startp
) <= ZV
)
16071 ptrdiff_t it_charpos
;
16073 w
->optional_new_start
= false;
16074 start_display (&it
, w
, startp
);
16075 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16076 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16077 /* Record IT's position now, since line_bottom_y might change
16079 it_charpos
= IT_CHARPOS (it
);
16080 /* Make sure we set the force_start flag only if the cursor row
16081 will be fully visible. Otherwise, the code under force_start
16082 label below will try to move point back into view, which is
16083 not what the code which sets optional_new_start wants. */
16084 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16085 && !w
->force_start
)
16087 if (it_charpos
== PT
)
16088 w
->force_start
= true;
16089 /* IT may overshoot PT if text at PT is invisible. */
16090 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16091 w
->force_start
= true;
16093 if (w
->force_start
)
16095 if (window_frozen_p (w
))
16096 debug_method_add (w
, "set force_start from frozen window start");
16098 debug_method_add (w
, "set force_start from optional_new_start");
16106 /* Handle case where place to start displaying has been specified,
16107 unless the specified location is outside the accessible range. */
16108 if (w
->force_start
)
16110 /* We set this later on if we have to adjust point. */
16113 w
->force_start
= false;
16115 w
->window_end_valid
= false;
16117 /* Forget any recorded base line for line number display. */
16118 if (!buffer_unchanged_p
)
16119 w
->base_line_number
= 0;
16121 /* Redisplay the mode line. Select the buffer properly for that.
16122 Also, run the hook window-scroll-functions
16123 because we have scrolled. */
16124 /* Note, we do this after clearing force_start because
16125 if there's an error, it is better to forget about force_start
16126 than to get into an infinite loop calling the hook functions
16127 and having them get more errors. */
16128 if (!update_mode_line
16129 || ! NILP (Vwindow_scroll_functions
))
16131 update_mode_line
= true;
16132 w
->update_mode_line
= true;
16133 startp
= run_window_scroll_functions (window
, startp
);
16136 if (CHARPOS (startp
) < BEGV
)
16137 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16138 else if (CHARPOS (startp
) > ZV
)
16139 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16141 /* Redisplay, then check if cursor has been set during the
16142 redisplay. Give up if new fonts were loaded. */
16143 /* We used to issue a CHECK_MARGINS argument to try_window here,
16144 but this causes scrolling to fail when point begins inside
16145 the scroll margin (bug#148) -- cyd */
16146 if (!try_window (window
, startp
, 0))
16148 w
->force_start
= true;
16149 clear_glyph_matrix (w
->desired_matrix
);
16150 goto need_larger_matrices
;
16153 if (w
->cursor
.vpos
< 0)
16155 /* If point does not appear, try to move point so it does
16156 appear. The desired matrix has been built above, so we
16157 can use it here. */
16158 new_vpos
= window_box_height (w
) / 2;
16161 if (!cursor_row_fully_visible_p (w
, false, false))
16163 /* Point does appear, but on a line partly visible at end of window.
16164 Move it back to a fully-visible line. */
16165 new_vpos
= window_box_height (w
);
16166 /* But if window_box_height suggests a Y coordinate that is
16167 not less than we already have, that line will clearly not
16168 be fully visible, so give up and scroll the display.
16169 This can happen when the default face uses a font whose
16170 dimensions are different from the frame's default
16172 if (new_vpos
>= w
->cursor
.y
)
16174 w
->cursor
.vpos
= -1;
16175 clear_glyph_matrix (w
->desired_matrix
);
16176 goto try_to_scroll
;
16179 else if (w
->cursor
.vpos
>= 0)
16181 /* Some people insist on not letting point enter the scroll
16182 margin, even though this part handles windows that didn't
16184 int window_total_lines
16185 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16186 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16187 int pixel_margin
= margin
* frame_line_height
;
16188 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16190 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16191 below, which finds the row to move point to, advances by
16192 the Y coordinate of the _next_ row, see the definition of
16193 MATRIX_ROW_BOTTOM_Y. */
16194 if (w
->cursor
.vpos
< margin
+ header_line
)
16196 w
->cursor
.vpos
= -1;
16197 clear_glyph_matrix (w
->desired_matrix
);
16198 goto try_to_scroll
;
16202 int window_height
= window_box_height (w
);
16205 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16206 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16208 w
->cursor
.vpos
= -1;
16209 clear_glyph_matrix (w
->desired_matrix
);
16210 goto try_to_scroll
;
16215 /* If we need to move point for either of the above reasons,
16216 now actually do it. */
16219 struct glyph_row
*row
;
16221 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16222 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16225 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16226 MATRIX_ROW_START_BYTEPOS (row
));
16228 if (w
!= XWINDOW (selected_window
))
16229 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16230 else if (current_buffer
== old
)
16231 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16233 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16235 /* Re-run pre-redisplay-function so it can update the region
16236 according to the new position of point. */
16237 /* Other than the cursor, w's redisplay is done so we can set its
16238 redisplay to false. Also the buffer's redisplay can be set to
16239 false, since propagate_buffer_redisplay should have already
16240 propagated its info to `w' anyway. */
16241 w
->redisplay
= false;
16242 XBUFFER (w
->contents
)->text
->redisplay
= false;
16243 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16245 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16247 /* pre-redisplay-function made changes (e.g. move the region)
16248 that require another round of redisplay. */
16249 clear_glyph_matrix (w
->desired_matrix
);
16250 if (!try_window (window
, startp
, 0))
16251 goto need_larger_matrices
;
16254 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16256 clear_glyph_matrix (w
->desired_matrix
);
16257 goto try_to_scroll
;
16261 debug_method_add (w
, "forced window start");
16266 /* Handle case where text has not changed, only point, and it has
16267 not moved off the frame, and we are not retrying after hscroll.
16268 (current_matrix_up_to_date_p is true when retrying.) */
16269 if (current_matrix_up_to_date_p
16270 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16271 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16275 case CURSOR_MOVEMENT_SUCCESS
:
16276 used_current_matrix_p
= true;
16279 case CURSOR_MOVEMENT_MUST_SCROLL
:
16280 goto try_to_scroll
;
16286 /* If current starting point was originally the beginning of a line
16287 but no longer is, find a new starting point. */
16288 else if (w
->start_at_line_beg
16289 && !(CHARPOS (startp
) <= BEGV
16290 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16293 debug_method_add (w
, "recenter 1");
16298 /* Try scrolling with try_window_id. Value is > 0 if update has
16299 been done, it is -1 if we know that the same window start will
16300 not work. It is 0 if unsuccessful for some other reason. */
16301 else if ((tem
= try_window_id (w
)) != 0)
16304 debug_method_add (w
, "try_window_id %d", tem
);
16307 if (f
->fonts_changed
)
16308 goto need_larger_matrices
;
16312 /* Otherwise try_window_id has returned -1 which means that we
16313 don't want the alternative below this comment to execute. */
16315 else if (CHARPOS (startp
) >= BEGV
16316 && CHARPOS (startp
) <= ZV
16317 && PT
>= CHARPOS (startp
)
16318 && (CHARPOS (startp
) < ZV
16319 /* Avoid starting at end of buffer. */
16320 || CHARPOS (startp
) == BEGV
16321 || !window_outdated (w
)))
16323 int d1
, d2
, d5
, d6
;
16326 /* If first window line is a continuation line, and window start
16327 is inside the modified region, but the first change is before
16328 current window start, we must select a new window start.
16330 However, if this is the result of a down-mouse event (e.g. by
16331 extending the mouse-drag-overlay), we don't want to select a
16332 new window start, since that would change the position under
16333 the mouse, resulting in an unwanted mouse-movement rather
16334 than a simple mouse-click. */
16335 if (!w
->start_at_line_beg
16336 && NILP (do_mouse_tracking
)
16337 && CHARPOS (startp
) > BEGV
16338 && CHARPOS (startp
) > BEG
+ beg_unchanged
16339 && CHARPOS (startp
) <= Z
- end_unchanged
16340 /* Even if w->start_at_line_beg is nil, a new window may
16341 start at a line_beg, since that's how set_buffer_window
16342 sets it. So, we need to check the return value of
16343 compute_window_start_on_continuation_line. (See also
16345 && XMARKER (w
->start
)->buffer
== current_buffer
16346 && compute_window_start_on_continuation_line (w
)
16347 /* It doesn't make sense to force the window start like we
16348 do at label force_start if it is already known that point
16349 will not be fully visible in the resulting window, because
16350 doing so will move point from its correct position
16351 instead of scrolling the window to bring point into view.
16353 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16354 /* A very tall row could need more than the window height,
16355 in which case we accept that it is partially visible. */
16356 && (rtop
!= 0) == (rbot
!= 0))
16358 w
->force_start
= true;
16359 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16361 debug_method_add (w
, "recomputed window start in continuation line");
16367 debug_method_add (w
, "same window start");
16370 /* Try to redisplay starting at same place as before.
16371 If point has not moved off frame, accept the results. */
16372 if (!current_matrix_up_to_date_p
16373 /* Don't use try_window_reusing_current_matrix in this case
16374 because a window scroll function can have changed the
16376 || !NILP (Vwindow_scroll_functions
)
16377 || MINI_WINDOW_P (w
)
16378 || !(used_current_matrix_p
16379 = try_window_reusing_current_matrix (w
)))
16381 IF_DEBUG (debug_method_add (w
, "1"));
16382 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16383 /* -1 means we need to scroll.
16384 0 means we need new matrices, but fonts_changed
16385 is set in that case, so we will detect it below. */
16386 goto try_to_scroll
;
16389 if (f
->fonts_changed
)
16390 goto need_larger_matrices
;
16392 if (w
->cursor
.vpos
>= 0)
16394 if (!just_this_one_p
16395 || current_buffer
->clip_changed
16396 || BEG_UNCHANGED
< CHARPOS (startp
))
16397 /* Forget any recorded base line for line number display. */
16398 w
->base_line_number
= 0;
16400 if (!cursor_row_fully_visible_p (w
, true, false))
16402 clear_glyph_matrix (w
->desired_matrix
);
16403 last_line_misfit
= true;
16405 /* Drop through and scroll. */
16410 clear_glyph_matrix (w
->desired_matrix
);
16415 /* Redisplay the mode line. Select the buffer properly for that. */
16416 if (!update_mode_line
)
16418 update_mode_line
= true;
16419 w
->update_mode_line
= true;
16422 /* Try to scroll by specified few lines. */
16423 if ((scroll_conservatively
16424 || emacs_scroll_step
16425 || temp_scroll_step
16426 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16427 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16428 && CHARPOS (startp
) >= BEGV
16429 && CHARPOS (startp
) <= ZV
)
16431 /* The function returns -1 if new fonts were loaded, 1 if
16432 successful, 0 if not successful. */
16433 int ss
= try_scrolling (window
, just_this_one_p
,
16434 scroll_conservatively
,
16436 temp_scroll_step
, last_line_misfit
);
16439 case SCROLLING_SUCCESS
:
16442 case SCROLLING_NEED_LARGER_MATRICES
:
16443 goto need_larger_matrices
;
16445 case SCROLLING_FAILED
:
16453 /* Finally, just choose a place to start which positions point
16454 according to user preferences. */
16459 debug_method_add (w
, "recenter");
16462 /* Forget any previously recorded base line for line number display. */
16463 if (!buffer_unchanged_p
)
16464 w
->base_line_number
= 0;
16466 /* Determine the window start relative to point. */
16467 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16468 it
.current_y
= it
.last_visible_y
;
16469 if (centering_position
< 0)
16471 int window_total_lines
16472 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16474 = scroll_margin
> 0
16475 ? min (scroll_margin
, window_total_lines
/ 4)
16477 ptrdiff_t margin_pos
= CHARPOS (startp
);
16478 Lisp_Object aggressive
;
16481 /* If there is a scroll margin at the top of the window, find
16482 its character position. */
16484 /* Cannot call start_display if startp is not in the
16485 accessible region of the buffer. This can happen when we
16486 have just switched to a different buffer and/or changed
16487 its restriction. In that case, startp is initialized to
16488 the character position 1 (BEGV) because we did not yet
16489 have chance to display the buffer even once. */
16490 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16493 void *it1data
= NULL
;
16495 SAVE_IT (it1
, it
, it1data
);
16496 start_display (&it1
, w
, startp
);
16497 move_it_vertically (&it1
, margin
* frame_line_height
);
16498 margin_pos
= IT_CHARPOS (it1
);
16499 RESTORE_IT (&it
, &it
, it1data
);
16501 scrolling_up
= PT
> margin_pos
;
16504 ? BVAR (current_buffer
, scroll_up_aggressively
)
16505 : BVAR (current_buffer
, scroll_down_aggressively
);
16507 if (!MINI_WINDOW_P (w
)
16508 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16512 /* Setting scroll-conservatively overrides
16513 scroll-*-aggressively. */
16514 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16516 double float_amount
= XFLOATINT (aggressive
);
16518 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16519 if (pt_offset
== 0 && float_amount
> 0)
16521 if (pt_offset
&& margin
> 0)
16524 /* Compute how much to move the window start backward from
16525 point so that point will be displayed where the user
16529 centering_position
= it
.last_visible_y
;
16531 centering_position
-= pt_offset
;
16532 centering_position
-=
16533 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16534 + WINDOW_HEADER_LINE_HEIGHT (w
));
16535 /* Don't let point enter the scroll margin near top of
16537 if (centering_position
< margin
* frame_line_height
)
16538 centering_position
= margin
* frame_line_height
;
16541 centering_position
= margin
* frame_line_height
+ pt_offset
;
16544 /* Set the window start half the height of the window backward
16546 centering_position
= window_box_height (w
) / 2;
16548 move_it_vertically_backward (&it
, centering_position
);
16550 eassert (IT_CHARPOS (it
) >= BEGV
);
16552 /* The function move_it_vertically_backward may move over more
16553 than the specified y-distance. If it->w is small, e.g. a
16554 mini-buffer window, we may end up in front of the window's
16555 display area. Start displaying at the start of the line
16556 containing PT in this case. */
16557 if (it
.current_y
<= 0)
16559 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16560 move_it_vertically_backward (&it
, 0);
16564 it
.current_x
= it
.hpos
= 0;
16566 /* Set the window start position here explicitly, to avoid an
16567 infinite loop in case the functions in window-scroll-functions
16569 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16571 /* Run scroll hooks. */
16572 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16574 /* Redisplay the window. */
16575 if (!current_matrix_up_to_date_p
16576 || windows_or_buffers_changed
16577 || f
->cursor_type_changed
16578 /* Don't use try_window_reusing_current_matrix in this case
16579 because it can have changed the buffer. */
16580 || !NILP (Vwindow_scroll_functions
)
16581 || !just_this_one_p
16582 || MINI_WINDOW_P (w
)
16583 || !(used_current_matrix_p
16584 = try_window_reusing_current_matrix (w
)))
16585 try_window (window
, startp
, 0);
16587 /* If new fonts have been loaded (due to fontsets), give up. We
16588 have to start a new redisplay since we need to re-adjust glyph
16590 if (f
->fonts_changed
)
16591 goto need_larger_matrices
;
16593 /* If cursor did not appear assume that the middle of the window is
16594 in the first line of the window. Do it again with the next line.
16595 (Imagine a window of height 100, displaying two lines of height
16596 60. Moving back 50 from it->last_visible_y will end in the first
16598 if (w
->cursor
.vpos
< 0)
16600 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16602 clear_glyph_matrix (w
->desired_matrix
);
16603 move_it_by_lines (&it
, 1);
16604 try_window (window
, it
.current
.pos
, 0);
16606 else if (PT
< IT_CHARPOS (it
))
16608 clear_glyph_matrix (w
->desired_matrix
);
16609 move_it_by_lines (&it
, -1);
16610 try_window (window
, it
.current
.pos
, 0);
16614 /* Not much we can do about it. */
16618 /* Consider the following case: Window starts at BEGV, there is
16619 invisible, intangible text at BEGV, so that display starts at
16620 some point START > BEGV. It can happen that we are called with
16621 PT somewhere between BEGV and START. Try to handle that case,
16622 and similar ones. */
16623 if (w
->cursor
.vpos
< 0)
16625 /* First, try locating the proper glyph row for PT. */
16626 struct glyph_row
*row
=
16627 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16629 /* Sometimes point is at the beginning of invisible text that is
16630 before the 1st character displayed in the row. In that case,
16631 row_containing_pos fails to find the row, because no glyphs
16632 with appropriate buffer positions are present in the row.
16633 Therefore, we next try to find the row which shows the 1st
16634 position after the invisible text. */
16638 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16641 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16644 Lisp_Object invis_end
=
16645 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16648 if (NATNUMP (invis_end
))
16649 alt_pos
= XFASTINT (invis_end
);
16652 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16656 /* Finally, fall back on the first row of the window after the
16657 header line (if any). This is slightly better than not
16658 displaying the cursor at all. */
16661 row
= w
->current_matrix
->rows
;
16662 if (row
->mode_line_p
)
16665 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16668 if (!cursor_row_fully_visible_p (w
, false, false))
16670 /* If vscroll is enabled, disable it and try again. */
16674 clear_glyph_matrix (w
->desired_matrix
);
16678 /* Users who set scroll-conservatively to a large number want
16679 point just above/below the scroll margin. If we ended up
16680 with point's row partially visible, move the window start to
16681 make that row fully visible and out of the margin. */
16682 if (scroll_conservatively
> SCROLL_LIMIT
)
16684 int window_total_lines
16685 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16688 ? min (scroll_margin
, window_total_lines
/ 4)
16690 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16692 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16693 clear_glyph_matrix (w
->desired_matrix
);
16694 if (1 == try_window (window
, it
.current
.pos
,
16695 TRY_WINDOW_CHECK_MARGINS
))
16699 /* If centering point failed to make the whole line visible,
16700 put point at the top instead. That has to make the whole line
16701 visible, if it can be done. */
16702 if (centering_position
== 0)
16705 clear_glyph_matrix (w
->desired_matrix
);
16706 centering_position
= 0;
16712 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16713 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16714 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16716 /* Display the mode line, if we must. */
16717 if ((update_mode_line
16718 /* If window not full width, must redo its mode line
16719 if (a) the window to its side is being redone and
16720 (b) we do a frame-based redisplay. This is a consequence
16721 of how inverted lines are drawn in frame-based redisplay. */
16722 || (!just_this_one_p
16723 && !FRAME_WINDOW_P (f
)
16724 && !WINDOW_FULL_WIDTH_P (w
))
16725 /* Line number to display. */
16726 || w
->base_line_pos
> 0
16727 /* Column number is displayed and different from the one displayed. */
16728 || (w
->column_number_displayed
!= -1
16729 && (w
->column_number_displayed
!= current_column ())))
16730 /* This means that the window has a mode line. */
16731 && (WINDOW_WANTS_MODELINE_P (w
)
16732 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16735 display_mode_lines (w
);
16737 /* If mode line height has changed, arrange for a thorough
16738 immediate redisplay using the correct mode line height. */
16739 if (WINDOW_WANTS_MODELINE_P (w
)
16740 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16742 f
->fonts_changed
= true;
16743 w
->mode_line_height
= -1;
16744 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16745 = DESIRED_MODE_LINE_HEIGHT (w
);
16748 /* If header line height has changed, arrange for a thorough
16749 immediate redisplay using the correct header line height. */
16750 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16751 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16753 f
->fonts_changed
= true;
16754 w
->header_line_height
= -1;
16755 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16756 = DESIRED_HEADER_LINE_HEIGHT (w
);
16759 if (f
->fonts_changed
)
16760 goto need_larger_matrices
;
16763 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16765 w
->base_line_pos
= 0;
16766 w
->base_line_number
= 0;
16771 /* When we reach a frame's selected window, redo the frame's menu bar. */
16772 if (update_mode_line
16773 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16775 bool redisplay_menu_p
;
16777 if (FRAME_WINDOW_P (f
))
16779 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16780 || defined (HAVE_NS) || defined (USE_GTK)
16781 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16783 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16787 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16789 if (redisplay_menu_p
)
16790 display_menu_bar (w
);
16792 #ifdef HAVE_WINDOW_SYSTEM
16793 if (FRAME_WINDOW_P (f
))
16795 #if defined (USE_GTK) || defined (HAVE_NS)
16796 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16797 redisplay_tool_bar (f
);
16799 if (WINDOWP (f
->tool_bar_window
)
16800 && (FRAME_TOOL_BAR_LINES (f
) > 0
16801 || !NILP (Vauto_resize_tool_bars
))
16802 && redisplay_tool_bar (f
))
16803 ignore_mouse_drag_p
= true;
16809 #ifdef HAVE_WINDOW_SYSTEM
16810 if (FRAME_WINDOW_P (f
)
16811 && update_window_fringes (w
, (just_this_one_p
16812 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16813 || w
->pseudo_window_p
)))
16817 if (draw_window_fringes (w
, true))
16819 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16820 x_draw_right_divider (w
);
16822 x_draw_vertical_border (w
);
16828 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16829 x_draw_bottom_divider (w
);
16830 #endif /* HAVE_WINDOW_SYSTEM */
16832 /* We go to this label, with fonts_changed set, if it is
16833 necessary to try again using larger glyph matrices.
16834 We have to redeem the scroll bar even in this case,
16835 because the loop in redisplay_internal expects that. */
16836 need_larger_matrices
:
16838 finish_scroll_bars
:
16840 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16842 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16843 /* Set the thumb's position and size. */
16844 set_vertical_scroll_bar (w
);
16846 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16847 /* Set the thumb's position and size. */
16848 set_horizontal_scroll_bar (w
);
16850 /* Note that we actually used the scroll bar attached to this
16851 window, so it shouldn't be deleted at the end of redisplay. */
16852 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16853 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16856 /* Restore current_buffer and value of point in it. The window
16857 update may have changed the buffer, so first make sure `opoint'
16858 is still valid (Bug#6177). */
16859 if (CHARPOS (opoint
) < BEGV
)
16860 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16861 else if (CHARPOS (opoint
) > ZV
)
16862 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16864 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16866 set_buffer_internal_1 (old
);
16867 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16868 shorter. This can be caused by log truncation in *Messages*. */
16869 if (CHARPOS (lpoint
) <= ZV
)
16870 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16872 unbind_to (count
, Qnil
);
16876 /* Build the complete desired matrix of WINDOW with a window start
16877 buffer position POS.
16879 Value is 1 if successful. It is zero if fonts were loaded during
16880 redisplay which makes re-adjusting glyph matrices necessary, and -1
16881 if point would appear in the scroll margins.
16882 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16883 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16887 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16889 struct window
*w
= XWINDOW (window
);
16891 struct glyph_row
*last_text_row
= NULL
;
16892 struct frame
*f
= XFRAME (w
->frame
);
16893 int frame_line_height
= default_line_pixel_height (w
);
16895 /* Make POS the new window start. */
16896 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16898 /* Mark cursor position as unknown. No overlay arrow seen. */
16899 w
->cursor
.vpos
= -1;
16900 overlay_arrow_seen
= false;
16902 /* Initialize iterator and info to start at POS. */
16903 start_display (&it
, w
, pos
);
16904 it
.glyph_row
->reversed_p
= false;
16906 /* Display all lines of W. */
16907 while (it
.current_y
< it
.last_visible_y
)
16909 if (display_line (&it
))
16910 last_text_row
= it
.glyph_row
- 1;
16911 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16915 /* Don't let the cursor end in the scroll margins. */
16916 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16917 && !MINI_WINDOW_P (w
))
16919 int this_scroll_margin
;
16920 int window_total_lines
16921 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16923 if (scroll_margin
> 0)
16925 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16926 this_scroll_margin
*= frame_line_height
;
16929 this_scroll_margin
= 0;
16931 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16932 && w
->cursor
.y
< this_scroll_margin
16933 && CHARPOS (pos
) > BEGV
16934 && IT_CHARPOS (it
) < ZV
)
16935 /* rms: considering make_cursor_line_fully_visible_p here
16936 seems to give wrong results. We don't want to recenter
16937 when the last line is partly visible, we want to allow
16938 that case to be handled in the usual way. */
16939 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16941 w
->cursor
.vpos
= -1;
16942 clear_glyph_matrix (w
->desired_matrix
);
16947 /* If bottom moved off end of frame, change mode line percentage. */
16948 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16949 w
->update_mode_line
= true;
16951 /* Set window_end_pos to the offset of the last character displayed
16952 on the window from the end of current_buffer. Set
16953 window_end_vpos to its row number. */
16956 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16957 adjust_window_ends (w
, last_text_row
, false);
16959 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16960 w
->window_end_vpos
)));
16964 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16965 w
->window_end_pos
= Z
- ZV
;
16966 w
->window_end_vpos
= 0;
16969 /* But that is not valid info until redisplay finishes. */
16970 w
->window_end_valid
= false;
16976 /************************************************************************
16977 Window redisplay reusing current matrix when buffer has not changed
16978 ************************************************************************/
16980 /* Try redisplay of window W showing an unchanged buffer with a
16981 different window start than the last time it was displayed by
16982 reusing its current matrix. Value is true if successful.
16983 W->start is the new window start. */
16986 try_window_reusing_current_matrix (struct window
*w
)
16988 struct frame
*f
= XFRAME (w
->frame
);
16989 struct glyph_row
*bottom_row
;
16992 struct text_pos start
, new_start
;
16993 int nrows_scrolled
, i
;
16994 struct glyph_row
*last_text_row
;
16995 struct glyph_row
*last_reused_text_row
;
16996 struct glyph_row
*start_row
;
16997 int start_vpos
, min_y
, max_y
;
17000 if (inhibit_try_window_reusing
)
17004 if (/* This function doesn't handle terminal frames. */
17005 !FRAME_WINDOW_P (f
)
17006 /* Don't try to reuse the display if windows have been split
17008 || windows_or_buffers_changed
17009 || f
->cursor_type_changed
)
17012 /* Can't do this if showing trailing whitespace. */
17013 if (!NILP (Vshow_trailing_whitespace
))
17016 /* If top-line visibility has changed, give up. */
17017 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17018 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17021 /* Give up if old or new display is scrolled vertically. We could
17022 make this function handle this, but right now it doesn't. */
17023 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17024 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17027 /* The variable new_start now holds the new window start. The old
17028 start `start' can be determined from the current matrix. */
17029 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17030 start
= start_row
->minpos
;
17031 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17033 /* Clear the desired matrix for the display below. */
17034 clear_glyph_matrix (w
->desired_matrix
);
17036 if (CHARPOS (new_start
) <= CHARPOS (start
))
17038 /* Don't use this method if the display starts with an ellipsis
17039 displayed for invisible text. It's not easy to handle that case
17040 below, and it's certainly not worth the effort since this is
17041 not a frequent case. */
17042 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17045 IF_DEBUG (debug_method_add (w
, "twu1"));
17047 /* Display up to a row that can be reused. The variable
17048 last_text_row is set to the last row displayed that displays
17049 text. Note that it.vpos == 0 if or if not there is a
17050 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17051 start_display (&it
, w
, new_start
);
17052 w
->cursor
.vpos
= -1;
17053 last_text_row
= last_reused_text_row
= NULL
;
17055 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17057 /* If we have reached into the characters in the START row,
17058 that means the line boundaries have changed. So we
17059 can't start copying with the row START. Maybe it will
17060 work to start copying with the following row. */
17061 while (IT_CHARPOS (it
) > CHARPOS (start
))
17063 /* Advance to the next row as the "start". */
17065 start
= start_row
->minpos
;
17066 /* If there are no more rows to try, or just one, give up. */
17067 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17068 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17069 || CHARPOS (start
) == ZV
)
17071 clear_glyph_matrix (w
->desired_matrix
);
17075 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17077 /* If we have reached alignment, we can copy the rest of the
17079 if (IT_CHARPOS (it
) == CHARPOS (start
)
17080 /* Don't accept "alignment" inside a display vector,
17081 since start_row could have started in the middle of
17082 that same display vector (thus their character
17083 positions match), and we have no way of telling if
17084 that is the case. */
17085 && it
.current
.dpvec_index
< 0)
17088 it
.glyph_row
->reversed_p
= false;
17089 if (display_line (&it
))
17090 last_text_row
= it
.glyph_row
- 1;
17094 /* A value of current_y < last_visible_y means that we stopped
17095 at the previous window start, which in turn means that we
17096 have at least one reusable row. */
17097 if (it
.current_y
< it
.last_visible_y
)
17099 struct glyph_row
*row
;
17101 /* IT.vpos always starts from 0; it counts text lines. */
17102 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17104 /* Find PT if not already found in the lines displayed. */
17105 if (w
->cursor
.vpos
< 0)
17107 int dy
= it
.current_y
- start_row
->y
;
17109 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17110 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17112 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17113 dy
, nrows_scrolled
);
17116 clear_glyph_matrix (w
->desired_matrix
);
17121 /* Scroll the display. Do it before the current matrix is
17122 changed. The problem here is that update has not yet
17123 run, i.e. part of the current matrix is not up to date.
17124 scroll_run_hook will clear the cursor, and use the
17125 current matrix to get the height of the row the cursor is
17127 run
.current_y
= start_row
->y
;
17128 run
.desired_y
= it
.current_y
;
17129 run
.height
= it
.last_visible_y
- it
.current_y
;
17131 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17134 FRAME_RIF (f
)->update_window_begin_hook (w
);
17135 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17136 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17137 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17141 /* Shift current matrix down by nrows_scrolled lines. */
17142 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17143 rotate_matrix (w
->current_matrix
,
17145 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17148 /* Disable lines that must be updated. */
17149 for (i
= 0; i
< nrows_scrolled
; ++i
)
17150 (start_row
+ i
)->enabled_p
= false;
17152 /* Re-compute Y positions. */
17153 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17154 max_y
= it
.last_visible_y
;
17155 for (row
= start_row
+ nrows_scrolled
;
17159 row
->y
= it
.current_y
;
17160 row
->visible_height
= row
->height
;
17162 if (row
->y
< min_y
)
17163 row
->visible_height
-= min_y
- row
->y
;
17164 if (row
->y
+ row
->height
> max_y
)
17165 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17166 if (row
->fringe_bitmap_periodic_p
)
17167 row
->redraw_fringe_bitmaps_p
= true;
17169 it
.current_y
+= row
->height
;
17171 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17172 last_reused_text_row
= row
;
17173 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17177 /* Disable lines in the current matrix which are now
17178 below the window. */
17179 for (++row
; row
< bottom_row
; ++row
)
17180 row
->enabled_p
= row
->mode_line_p
= false;
17183 /* Update window_end_pos etc.; last_reused_text_row is the last
17184 reused row from the current matrix containing text, if any.
17185 The value of last_text_row is the last displayed line
17186 containing text. */
17187 if (last_reused_text_row
)
17188 adjust_window_ends (w
, last_reused_text_row
, true);
17189 else if (last_text_row
)
17190 adjust_window_ends (w
, last_text_row
, false);
17193 /* This window must be completely empty. */
17194 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17195 w
->window_end_pos
= Z
- ZV
;
17196 w
->window_end_vpos
= 0;
17198 w
->window_end_valid
= false;
17200 /* Update hint: don't try scrolling again in update_window. */
17201 w
->desired_matrix
->no_scrolling_p
= true;
17204 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17208 else if (CHARPOS (new_start
) > CHARPOS (start
))
17210 struct glyph_row
*pt_row
, *row
;
17211 struct glyph_row
*first_reusable_row
;
17212 struct glyph_row
*first_row_to_display
;
17214 int yb
= window_text_bottom_y (w
);
17216 /* Find the row starting at new_start, if there is one. Don't
17217 reuse a partially visible line at the end. */
17218 first_reusable_row
= start_row
;
17219 while (first_reusable_row
->enabled_p
17220 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17221 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17222 < CHARPOS (new_start
)))
17223 ++first_reusable_row
;
17225 /* Give up if there is no row to reuse. */
17226 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17227 || !first_reusable_row
->enabled_p
17228 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17229 != CHARPOS (new_start
)))
17232 /* We can reuse fully visible rows beginning with
17233 first_reusable_row to the end of the window. Set
17234 first_row_to_display to the first row that cannot be reused.
17235 Set pt_row to the row containing point, if there is any. */
17237 for (first_row_to_display
= first_reusable_row
;
17238 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17239 ++first_row_to_display
)
17241 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17242 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17243 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17244 && first_row_to_display
->ends_at_zv_p
17245 && pt_row
== NULL
)))
17246 pt_row
= first_row_to_display
;
17249 /* Start displaying at the start of first_row_to_display. */
17250 eassert (first_row_to_display
->y
< yb
);
17251 init_to_row_start (&it
, w
, first_row_to_display
);
17253 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17255 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17257 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17258 + WINDOW_HEADER_LINE_HEIGHT (w
));
17260 /* Display lines beginning with first_row_to_display in the
17261 desired matrix. Set last_text_row to the last row displayed
17262 that displays text. */
17263 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17264 if (pt_row
== NULL
)
17265 w
->cursor
.vpos
= -1;
17266 last_text_row
= NULL
;
17267 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17268 if (display_line (&it
))
17269 last_text_row
= it
.glyph_row
- 1;
17271 /* If point is in a reused row, adjust y and vpos of the cursor
17275 w
->cursor
.vpos
-= nrows_scrolled
;
17276 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17279 /* Give up if point isn't in a row displayed or reused. (This
17280 also handles the case where w->cursor.vpos < nrows_scrolled
17281 after the calls to display_line, which can happen with scroll
17282 margins. See bug#1295.) */
17283 if (w
->cursor
.vpos
< 0)
17285 clear_glyph_matrix (w
->desired_matrix
);
17289 /* Scroll the display. */
17290 run
.current_y
= first_reusable_row
->y
;
17291 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17292 run
.height
= it
.last_visible_y
- run
.current_y
;
17293 dy
= run
.current_y
- run
.desired_y
;
17298 FRAME_RIF (f
)->update_window_begin_hook (w
);
17299 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17300 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17301 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17305 /* Adjust Y positions of reused rows. */
17306 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17307 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17308 max_y
= it
.last_visible_y
;
17309 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17312 row
->visible_height
= row
->height
;
17313 if (row
->y
< min_y
)
17314 row
->visible_height
-= min_y
- row
->y
;
17315 if (row
->y
+ row
->height
> max_y
)
17316 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17317 if (row
->fringe_bitmap_periodic_p
)
17318 row
->redraw_fringe_bitmaps_p
= true;
17321 /* Scroll the current matrix. */
17322 eassert (nrows_scrolled
> 0);
17323 rotate_matrix (w
->current_matrix
,
17325 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17328 /* Disable rows not reused. */
17329 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17330 row
->enabled_p
= false;
17332 /* Point may have moved to a different line, so we cannot assume that
17333 the previous cursor position is valid; locate the correct row. */
17336 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17338 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17339 && !row
->ends_at_zv_p
;
17343 w
->cursor
.y
= row
->y
;
17345 if (row
< bottom_row
)
17347 /* Can't simply scan the row for point with
17348 bidi-reordered glyph rows. Let set_cursor_from_row
17349 figure out where to put the cursor, and if it fails,
17351 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17353 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17356 clear_glyph_matrix (w
->desired_matrix
);
17362 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17363 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17366 && (!BUFFERP (glyph
->object
)
17367 || glyph
->charpos
< PT
);
17371 w
->cursor
.x
+= glyph
->pixel_width
;
17377 /* Adjust window end. A null value of last_text_row means that
17378 the window end is in reused rows which in turn means that
17379 only its vpos can have changed. */
17381 adjust_window_ends (w
, last_text_row
, false);
17383 w
->window_end_vpos
-= nrows_scrolled
;
17385 w
->window_end_valid
= false;
17386 w
->desired_matrix
->no_scrolling_p
= true;
17389 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17399 /************************************************************************
17400 Window redisplay reusing current matrix when buffer has changed
17401 ************************************************************************/
17403 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17404 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17405 ptrdiff_t *, ptrdiff_t *);
17406 static struct glyph_row
*
17407 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17408 struct glyph_row
*);
17411 /* Return the last row in MATRIX displaying text. If row START is
17412 non-null, start searching with that row. IT gives the dimensions
17413 of the display. Value is null if matrix is empty; otherwise it is
17414 a pointer to the row found. */
17416 static struct glyph_row
*
17417 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17418 struct glyph_row
*start
)
17420 struct glyph_row
*row
, *row_found
;
17422 /* Set row_found to the last row in IT->w's current matrix
17423 displaying text. The loop looks funny but think of partially
17426 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17427 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17429 eassert (row
->enabled_p
);
17431 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17440 /* Return the last row in the current matrix of W that is not affected
17441 by changes at the start of current_buffer that occurred since W's
17442 current matrix was built. Value is null if no such row exists.
17444 BEG_UNCHANGED us the number of characters unchanged at the start of
17445 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17446 first changed character in current_buffer. Characters at positions <
17447 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17448 when the current matrix was built. */
17450 static struct glyph_row
*
17451 find_last_unchanged_at_beg_row (struct window
*w
)
17453 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17454 struct glyph_row
*row
;
17455 struct glyph_row
*row_found
= NULL
;
17456 int yb
= window_text_bottom_y (w
);
17458 /* Find the last row displaying unchanged text. */
17459 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17460 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17461 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17464 if (/* If row ends before first_changed_pos, it is unchanged,
17465 except in some case. */
17466 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17467 /* When row ends in ZV and we write at ZV it is not
17469 && !row
->ends_at_zv_p
17470 /* When first_changed_pos is the end of a continued line,
17471 row is not unchanged because it may be no longer
17473 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17474 && (row
->continued_p
17475 || row
->exact_window_width_line_p
))
17476 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17477 needs to be recomputed, so don't consider this row as
17478 unchanged. This happens when the last line was
17479 bidi-reordered and was killed immediately before this
17480 redisplay cycle. In that case, ROW->end stores the
17481 buffer position of the first visual-order character of
17482 the killed text, which is now beyond ZV. */
17483 && CHARPOS (row
->end
.pos
) <= ZV
)
17486 /* Stop if last visible row. */
17487 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17495 /* Find the first glyph row in the current matrix of W that is not
17496 affected by changes at the end of current_buffer since the
17497 time W's current matrix was built.
17499 Return in *DELTA the number of chars by which buffer positions in
17500 unchanged text at the end of current_buffer must be adjusted.
17502 Return in *DELTA_BYTES the corresponding number of bytes.
17504 Value is null if no such row exists, i.e. all rows are affected by
17507 static struct glyph_row
*
17508 find_first_unchanged_at_end_row (struct window
*w
,
17509 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17511 struct glyph_row
*row
;
17512 struct glyph_row
*row_found
= NULL
;
17514 *delta
= *delta_bytes
= 0;
17516 /* Display must not have been paused, otherwise the current matrix
17517 is not up to date. */
17518 eassert (w
->window_end_valid
);
17520 /* A value of window_end_pos >= END_UNCHANGED means that the window
17521 end is in the range of changed text. If so, there is no
17522 unchanged row at the end of W's current matrix. */
17523 if (w
->window_end_pos
>= END_UNCHANGED
)
17526 /* Set row to the last row in W's current matrix displaying text. */
17527 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17529 /* If matrix is entirely empty, no unchanged row exists. */
17530 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17532 /* The value of row is the last glyph row in the matrix having a
17533 meaningful buffer position in it. The end position of row
17534 corresponds to window_end_pos. This allows us to translate
17535 buffer positions in the current matrix to current buffer
17536 positions for characters not in changed text. */
17538 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17539 ptrdiff_t Z_BYTE_old
=
17540 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17541 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17542 struct glyph_row
*first_text_row
17543 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17545 *delta
= Z
- Z_old
;
17546 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17548 /* Set last_unchanged_pos to the buffer position of the last
17549 character in the buffer that has not been changed. Z is the
17550 index + 1 of the last character in current_buffer, i.e. by
17551 subtracting END_UNCHANGED we get the index of the last
17552 unchanged character, and we have to add BEG to get its buffer
17554 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17555 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17557 /* Search backward from ROW for a row displaying a line that
17558 starts at a minimum position >= last_unchanged_pos_old. */
17559 for (; row
> first_text_row
; --row
)
17561 /* This used to abort, but it can happen.
17562 It is ok to just stop the search instead here. KFS. */
17563 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17566 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17571 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17577 /* Make sure that glyph rows in the current matrix of window W
17578 reference the same glyph memory as corresponding rows in the
17579 frame's frame matrix. This function is called after scrolling W's
17580 current matrix on a terminal frame in try_window_id and
17581 try_window_reusing_current_matrix. */
17584 sync_frame_with_window_matrix_rows (struct window
*w
)
17586 struct frame
*f
= XFRAME (w
->frame
);
17587 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17589 /* Preconditions: W must be a leaf window and full-width. Its frame
17590 must have a frame matrix. */
17591 eassert (BUFFERP (w
->contents
));
17592 eassert (WINDOW_FULL_WIDTH_P (w
));
17593 eassert (!FRAME_WINDOW_P (f
));
17595 /* If W is a full-width window, glyph pointers in W's current matrix
17596 have, by definition, to be the same as glyph pointers in the
17597 corresponding frame matrix. Note that frame matrices have no
17598 marginal areas (see build_frame_matrix). */
17599 window_row
= w
->current_matrix
->rows
;
17600 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17601 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17602 while (window_row
< window_row_end
)
17604 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17605 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17607 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17608 frame_row
->glyphs
[TEXT_AREA
] = start
;
17609 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17610 frame_row
->glyphs
[LAST_AREA
] = end
;
17612 /* Disable frame rows whose corresponding window rows have
17613 been disabled in try_window_id. */
17614 if (!window_row
->enabled_p
)
17615 frame_row
->enabled_p
= false;
17617 ++window_row
, ++frame_row
;
17622 /* Find the glyph row in window W containing CHARPOS. Consider all
17623 rows between START and END (not inclusive). END null means search
17624 all rows to the end of the display area of W. Value is the row
17625 containing CHARPOS or null. */
17628 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17629 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17631 struct glyph_row
*row
= start
;
17632 struct glyph_row
*best_row
= NULL
;
17633 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17636 /* If we happen to start on a header-line, skip that. */
17637 if (row
->mode_line_p
)
17640 if ((end
&& row
>= end
) || !row
->enabled_p
)
17643 last_y
= window_text_bottom_y (w
) - dy
;
17647 /* Give up if we have gone too far. */
17648 if (end
&& row
>= end
)
17650 /* This formerly returned if they were equal.
17651 I think that both quantities are of a "last plus one" type;
17652 if so, when they are equal, the row is within the screen. -- rms. */
17653 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17656 /* If it is in this row, return this row. */
17657 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17658 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17659 /* The end position of a row equals the start
17660 position of the next row. If CHARPOS is there, we
17661 would rather consider it displayed in the next
17662 line, except when this line ends in ZV. */
17663 && !row_for_charpos_p (row
, charpos
)))
17664 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17668 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17669 || (!best_row
&& !row
->continued_p
))
17671 /* In bidi-reordered rows, there could be several rows whose
17672 edges surround CHARPOS, all of these rows belonging to
17673 the same continued line. We need to find the row which
17674 fits CHARPOS the best. */
17675 for (g
= row
->glyphs
[TEXT_AREA
];
17676 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17679 if (!STRINGP (g
->object
))
17681 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17683 mindif
= eabs (g
->charpos
- charpos
);
17685 /* Exact match always wins. */
17692 else if (best_row
&& !row
->continued_p
)
17699 /* Try to redisplay window W by reusing its existing display. W's
17700 current matrix must be up to date when this function is called,
17701 i.e., window_end_valid must be true.
17705 >= 1 if successful, i.e. display has been updated
17707 1 means the changes were in front of a newline that precedes
17708 the window start, and the whole current matrix was reused
17709 2 means the changes were after the last position displayed
17710 in the window, and the whole current matrix was reused
17711 3 means portions of the current matrix were reused, while
17712 some of the screen lines were redrawn
17713 -1 if redisplay with same window start is known not to succeed
17714 0 if otherwise unsuccessful
17716 The following steps are performed:
17718 1. Find the last row in the current matrix of W that is not
17719 affected by changes at the start of current_buffer. If no such row
17722 2. Find the first row in W's current matrix that is not affected by
17723 changes at the end of current_buffer. Maybe there is no such row.
17725 3. Display lines beginning with the row + 1 found in step 1 to the
17726 row found in step 2 or, if step 2 didn't find a row, to the end of
17729 4. If cursor is not known to appear on the window, give up.
17731 5. If display stopped at the row found in step 2, scroll the
17732 display and current matrix as needed.
17734 6. Maybe display some lines at the end of W, if we must. This can
17735 happen under various circumstances, like a partially visible line
17736 becoming fully visible, or because newly displayed lines are displayed
17737 in smaller font sizes.
17739 7. Update W's window end information. */
17742 try_window_id (struct window
*w
)
17744 struct frame
*f
= XFRAME (w
->frame
);
17745 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17746 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17747 struct glyph_row
*last_unchanged_at_beg_row
;
17748 struct glyph_row
*first_unchanged_at_end_row
;
17749 struct glyph_row
*row
;
17750 struct glyph_row
*bottom_row
;
17753 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17755 struct text_pos start_pos
;
17757 int first_unchanged_at_end_vpos
= 0;
17758 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17759 struct text_pos start
;
17760 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17763 if (inhibit_try_window_id
)
17767 /* This is handy for debugging. */
17769 #define GIVE_UP(X) \
17771 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17775 #define GIVE_UP(X) return 0
17778 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17780 /* Don't use this for mini-windows because these can show
17781 messages and mini-buffers, and we don't handle that here. */
17782 if (MINI_WINDOW_P (w
))
17785 /* This flag is used to prevent redisplay optimizations. */
17786 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17789 /* This function's optimizations cannot be used if overlays have
17790 changed in the buffer displayed by the window, so give up if they
17792 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17795 /* Verify that narrowing has not changed.
17796 Also verify that we were not told to prevent redisplay optimizations.
17797 It would be nice to further
17798 reduce the number of cases where this prevents try_window_id. */
17799 if (current_buffer
->clip_changed
17800 || current_buffer
->prevent_redisplay_optimizations_p
)
17803 /* Window must either use window-based redisplay or be full width. */
17804 if (!FRAME_WINDOW_P (f
)
17805 && (!FRAME_LINE_INS_DEL_OK (f
)
17806 || !WINDOW_FULL_WIDTH_P (w
)))
17809 /* Give up if point is known NOT to appear in W. */
17810 if (PT
< CHARPOS (start
))
17813 /* Another way to prevent redisplay optimizations. */
17814 if (w
->last_modified
== 0)
17817 /* Verify that window is not hscrolled. */
17818 if (w
->hscroll
!= 0)
17821 /* Verify that display wasn't paused. */
17822 if (!w
->window_end_valid
)
17825 /* Likewise if highlighting trailing whitespace. */
17826 if (!NILP (Vshow_trailing_whitespace
))
17829 /* Can't use this if overlay arrow position and/or string have
17831 if (overlay_arrows_changed_p ())
17834 /* When word-wrap is on, adding a space to the first word of a
17835 wrapped line can change the wrap position, altering the line
17836 above it. It might be worthwhile to handle this more
17837 intelligently, but for now just redisplay from scratch. */
17838 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17841 /* Under bidi reordering, adding or deleting a character in the
17842 beginning of a paragraph, before the first strong directional
17843 character, can change the base direction of the paragraph (unless
17844 the buffer specifies a fixed paragraph direction), which will
17845 require to redisplay the whole paragraph. It might be worthwhile
17846 to find the paragraph limits and widen the range of redisplayed
17847 lines to that, but for now just give up this optimization and
17848 redisplay from scratch. */
17849 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17850 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17853 /* Give up if the buffer has line-spacing set, as Lisp-level changes
17854 to that variable require thorough redisplay. */
17855 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
17858 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17859 only if buffer has really changed. The reason is that the gap is
17860 initially at Z for freshly visited files. The code below would
17861 set end_unchanged to 0 in that case. */
17862 if (MODIFF
> SAVE_MODIFF
17863 /* This seems to happen sometimes after saving a buffer. */
17864 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17866 if (GPT
- BEG
< BEG_UNCHANGED
)
17867 BEG_UNCHANGED
= GPT
- BEG
;
17868 if (Z
- GPT
< END_UNCHANGED
)
17869 END_UNCHANGED
= Z
- GPT
;
17872 /* The position of the first and last character that has been changed. */
17873 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17874 last_changed_charpos
= Z
- END_UNCHANGED
;
17876 /* If window starts after a line end, and the last change is in
17877 front of that newline, then changes don't affect the display.
17878 This case happens with stealth-fontification. Note that although
17879 the display is unchanged, glyph positions in the matrix have to
17880 be adjusted, of course. */
17881 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17882 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17883 && ((last_changed_charpos
< CHARPOS (start
)
17884 && CHARPOS (start
) == BEGV
)
17885 || (last_changed_charpos
< CHARPOS (start
) - 1
17886 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17888 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17889 struct glyph_row
*r0
;
17891 /* Compute how many chars/bytes have been added to or removed
17892 from the buffer. */
17893 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17894 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17895 Z_delta
= Z
- Z_old
;
17896 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17898 /* Give up if PT is not in the window. Note that it already has
17899 been checked at the start of try_window_id that PT is not in
17900 front of the window start. */
17901 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17904 /* If window start is unchanged, we can reuse the whole matrix
17905 as is, after adjusting glyph positions. No need to compute
17906 the window end again, since its offset from Z hasn't changed. */
17907 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17908 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17909 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17910 /* PT must not be in a partially visible line. */
17911 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17912 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17914 /* Adjust positions in the glyph matrix. */
17915 if (Z_delta
|| Z_delta_bytes
)
17917 struct glyph_row
*r1
17918 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17919 increment_matrix_positions (w
->current_matrix
,
17920 MATRIX_ROW_VPOS (r0
, current_matrix
),
17921 MATRIX_ROW_VPOS (r1
, current_matrix
),
17922 Z_delta
, Z_delta_bytes
);
17925 /* Set the cursor. */
17926 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17928 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17933 /* Handle the case that changes are all below what is displayed in
17934 the window, and that PT is in the window. This shortcut cannot
17935 be taken if ZV is visible in the window, and text has been added
17936 there that is visible in the window. */
17937 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17938 /* ZV is not visible in the window, or there are no
17939 changes at ZV, actually. */
17940 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17941 || first_changed_charpos
== last_changed_charpos
))
17943 struct glyph_row
*r0
;
17945 /* Give up if PT is not in the window. Note that it already has
17946 been checked at the start of try_window_id that PT is not in
17947 front of the window start. */
17948 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17951 /* If window start is unchanged, we can reuse the whole matrix
17952 as is, without changing glyph positions since no text has
17953 been added/removed in front of the window end. */
17954 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17955 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17956 /* PT must not be in a partially visible line. */
17957 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17958 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17960 /* We have to compute the window end anew since text
17961 could have been added/removed after it. */
17962 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17963 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17965 /* Set the cursor. */
17966 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17968 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17973 /* Give up if window start is in the changed area.
17975 The condition used to read
17977 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17979 but why that was tested escapes me at the moment. */
17980 if (CHARPOS (start
) >= first_changed_charpos
17981 && CHARPOS (start
) <= last_changed_charpos
)
17984 /* Check that window start agrees with the start of the first glyph
17985 row in its current matrix. Check this after we know the window
17986 start is not in changed text, otherwise positions would not be
17988 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17989 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17992 /* Give up if the window ends in strings. Overlay strings
17993 at the end are difficult to handle, so don't try. */
17994 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
17995 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17998 /* Compute the position at which we have to start displaying new
17999 lines. Some of the lines at the top of the window might be
18000 reusable because they are not displaying changed text. Find the
18001 last row in W's current matrix not affected by changes at the
18002 start of current_buffer. Value is null if changes start in the
18003 first line of window. */
18004 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18005 if (last_unchanged_at_beg_row
)
18007 /* Avoid starting to display in the middle of a character, a TAB
18008 for instance. This is easier than to set up the iterator
18009 exactly, and it's not a frequent case, so the additional
18010 effort wouldn't really pay off. */
18011 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18012 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18013 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18014 --last_unchanged_at_beg_row
;
18016 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18019 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18021 start_pos
= it
.current
.pos
;
18023 /* Start displaying new lines in the desired matrix at the same
18024 vpos we would use in the current matrix, i.e. below
18025 last_unchanged_at_beg_row. */
18026 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18028 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18029 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18031 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18035 /* There are no reusable lines at the start of the window.
18036 Start displaying in the first text line. */
18037 start_display (&it
, w
, start
);
18038 it
.vpos
= it
.first_vpos
;
18039 start_pos
= it
.current
.pos
;
18042 /* Find the first row that is not affected by changes at the end of
18043 the buffer. Value will be null if there is no unchanged row, in
18044 which case we must redisplay to the end of the window. delta
18045 will be set to the value by which buffer positions beginning with
18046 first_unchanged_at_end_row have to be adjusted due to text
18048 first_unchanged_at_end_row
18049 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18050 IF_DEBUG (debug_delta
= delta
);
18051 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18053 /* Set stop_pos to the buffer position up to which we will have to
18054 display new lines. If first_unchanged_at_end_row != NULL, this
18055 is the buffer position of the start of the line displayed in that
18056 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18057 that we don't stop at a buffer position. */
18059 if (first_unchanged_at_end_row
)
18061 eassert (last_unchanged_at_beg_row
== NULL
18062 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18064 /* If this is a continuation line, move forward to the next one
18065 that isn't. Changes in lines above affect this line.
18066 Caution: this may move first_unchanged_at_end_row to a row
18067 not displaying text. */
18068 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18069 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18070 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18071 < it
.last_visible_y
))
18072 ++first_unchanged_at_end_row
;
18074 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18075 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18076 >= it
.last_visible_y
))
18077 first_unchanged_at_end_row
= NULL
;
18080 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18082 first_unchanged_at_end_vpos
18083 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18084 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18087 else if (last_unchanged_at_beg_row
== NULL
)
18093 /* Either there is no unchanged row at the end, or the one we have
18094 now displays text. This is a necessary condition for the window
18095 end pos calculation at the end of this function. */
18096 eassert (first_unchanged_at_end_row
== NULL
18097 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18099 debug_last_unchanged_at_beg_vpos
18100 = (last_unchanged_at_beg_row
18101 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18103 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18105 #endif /* GLYPH_DEBUG */
18108 /* Display new lines. Set last_text_row to the last new line
18109 displayed which has text on it, i.e. might end up as being the
18110 line where the window_end_vpos is. */
18111 w
->cursor
.vpos
= -1;
18112 last_text_row
= NULL
;
18113 overlay_arrow_seen
= false;
18114 if (it
.current_y
< it
.last_visible_y
18115 && !f
->fonts_changed
18116 && (first_unchanged_at_end_row
== NULL
18117 || IT_CHARPOS (it
) < stop_pos
))
18118 it
.glyph_row
->reversed_p
= false;
18119 while (it
.current_y
< it
.last_visible_y
18120 && !f
->fonts_changed
18121 && (first_unchanged_at_end_row
== NULL
18122 || IT_CHARPOS (it
) < stop_pos
))
18124 if (display_line (&it
))
18125 last_text_row
= it
.glyph_row
- 1;
18128 if (f
->fonts_changed
)
18131 /* The redisplay iterations in display_line above could have
18132 triggered font-lock, which could have done something that
18133 invalidates IT->w window's end-point information, on which we
18134 rely below. E.g., one package, which will remain unnamed, used
18135 to install a font-lock-fontify-region-function that called
18136 bury-buffer, whose side effect is to switch the buffer displayed
18137 by IT->w, and that predictably resets IT->w's window_end_valid
18138 flag, which we already tested at the entry to this function.
18139 Amply punish such packages/modes by giving up on this
18140 optimization in those cases. */
18141 if (!w
->window_end_valid
)
18143 clear_glyph_matrix (w
->desired_matrix
);
18147 /* Compute differences in buffer positions, y-positions etc. for
18148 lines reused at the bottom of the window. Compute what we can
18150 if (first_unchanged_at_end_row
18151 /* No lines reused because we displayed everything up to the
18152 bottom of the window. */
18153 && it
.current_y
< it
.last_visible_y
)
18156 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18158 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18159 run
.current_y
= first_unchanged_at_end_row
->y
;
18160 run
.desired_y
= run
.current_y
+ dy
;
18161 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18165 delta
= delta_bytes
= dvpos
= dy
18166 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18167 first_unchanged_at_end_row
= NULL
;
18169 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18172 /* Find the cursor if not already found. We have to decide whether
18173 PT will appear on this window (it sometimes doesn't, but this is
18174 not a very frequent case.) This decision has to be made before
18175 the current matrix is altered. A value of cursor.vpos < 0 means
18176 that PT is either in one of the lines beginning at
18177 first_unchanged_at_end_row or below the window. Don't care for
18178 lines that might be displayed later at the window end; as
18179 mentioned, this is not a frequent case. */
18180 if (w
->cursor
.vpos
< 0)
18182 /* Cursor in unchanged rows at the top? */
18183 if (PT
< CHARPOS (start_pos
)
18184 && last_unchanged_at_beg_row
)
18186 row
= row_containing_pos (w
, PT
,
18187 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18188 last_unchanged_at_beg_row
+ 1, 0);
18190 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18193 /* Start from first_unchanged_at_end_row looking for PT. */
18194 else if (first_unchanged_at_end_row
)
18196 row
= row_containing_pos (w
, PT
- delta
,
18197 first_unchanged_at_end_row
, NULL
, 0);
18199 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18200 delta_bytes
, dy
, dvpos
);
18203 /* Give up if cursor was not found. */
18204 if (w
->cursor
.vpos
< 0)
18206 clear_glyph_matrix (w
->desired_matrix
);
18211 /* Don't let the cursor end in the scroll margins. */
18213 int this_scroll_margin
, cursor_height
;
18214 int frame_line_height
= default_line_pixel_height (w
);
18215 int window_total_lines
18216 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18218 this_scroll_margin
=
18219 max (0, min (scroll_margin
, window_total_lines
/ 4));
18220 this_scroll_margin
*= frame_line_height
;
18221 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18223 if ((w
->cursor
.y
< this_scroll_margin
18224 && CHARPOS (start
) > BEGV
)
18225 /* Old redisplay didn't take scroll margin into account at the bottom,
18226 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18227 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18228 ? cursor_height
+ this_scroll_margin
18229 : 1)) > it
.last_visible_y
)
18231 w
->cursor
.vpos
= -1;
18232 clear_glyph_matrix (w
->desired_matrix
);
18237 /* Scroll the display. Do it before changing the current matrix so
18238 that xterm.c doesn't get confused about where the cursor glyph is
18240 if (dy
&& run
.height
)
18244 if (FRAME_WINDOW_P (f
))
18246 FRAME_RIF (f
)->update_window_begin_hook (w
);
18247 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18248 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18249 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18253 /* Terminal frame. In this case, dvpos gives the number of
18254 lines to scroll by; dvpos < 0 means scroll up. */
18256 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18257 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18258 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18259 + WINDOW_WANTS_HEADER_LINE_P (w
)
18260 + window_internal_height (w
));
18262 #if defined (HAVE_GPM) || defined (MSDOS)
18263 x_clear_window_mouse_face (w
);
18265 /* Perform the operation on the screen. */
18268 /* Scroll last_unchanged_at_beg_row to the end of the
18269 window down dvpos lines. */
18270 set_terminal_window (f
, end
);
18272 /* On dumb terminals delete dvpos lines at the end
18273 before inserting dvpos empty lines. */
18274 if (!FRAME_SCROLL_REGION_OK (f
))
18275 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18277 /* Insert dvpos empty lines in front of
18278 last_unchanged_at_beg_row. */
18279 ins_del_lines (f
, from
, dvpos
);
18281 else if (dvpos
< 0)
18283 /* Scroll up last_unchanged_at_beg_vpos to the end of
18284 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18285 set_terminal_window (f
, end
);
18287 /* Delete dvpos lines in front of
18288 last_unchanged_at_beg_vpos. ins_del_lines will set
18289 the cursor to the given vpos and emit |dvpos| delete
18291 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18293 /* On a dumb terminal insert dvpos empty lines at the
18295 if (!FRAME_SCROLL_REGION_OK (f
))
18296 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18299 set_terminal_window (f
, 0);
18305 /* Shift reused rows of the current matrix to the right position.
18306 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18308 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18309 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18312 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18313 bottom_vpos
, dvpos
);
18314 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18317 else if (dvpos
> 0)
18319 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18320 bottom_vpos
, dvpos
);
18321 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18322 first_unchanged_at_end_vpos
+ dvpos
);
18325 /* For frame-based redisplay, make sure that current frame and window
18326 matrix are in sync with respect to glyph memory. */
18327 if (!FRAME_WINDOW_P (f
))
18328 sync_frame_with_window_matrix_rows (w
);
18330 /* Adjust buffer positions in reused rows. */
18331 if (delta
|| delta_bytes
)
18332 increment_matrix_positions (current_matrix
,
18333 first_unchanged_at_end_vpos
+ dvpos
,
18334 bottom_vpos
, delta
, delta_bytes
);
18336 /* Adjust Y positions. */
18338 shift_glyph_matrix (w
, current_matrix
,
18339 first_unchanged_at_end_vpos
+ dvpos
,
18342 if (first_unchanged_at_end_row
)
18344 first_unchanged_at_end_row
+= dvpos
;
18345 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18346 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18347 first_unchanged_at_end_row
= NULL
;
18350 /* If scrolling up, there may be some lines to display at the end of
18352 last_text_row_at_end
= NULL
;
18355 /* Scrolling up can leave for example a partially visible line
18356 at the end of the window to be redisplayed. */
18357 /* Set last_row to the glyph row in the current matrix where the
18358 window end line is found. It has been moved up or down in
18359 the matrix by dvpos. */
18360 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18361 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18363 /* If last_row is the window end line, it should display text. */
18364 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18366 /* If window end line was partially visible before, begin
18367 displaying at that line. Otherwise begin displaying with the
18368 line following it. */
18369 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18371 init_to_row_start (&it
, w
, last_row
);
18372 it
.vpos
= last_vpos
;
18373 it
.current_y
= last_row
->y
;
18377 init_to_row_end (&it
, w
, last_row
);
18378 it
.vpos
= 1 + last_vpos
;
18379 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18383 /* We may start in a continuation line. If so, we have to
18384 get the right continuation_lines_width and current_x. */
18385 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18386 it
.hpos
= it
.current_x
= 0;
18388 /* Display the rest of the lines at the window end. */
18389 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18390 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18392 /* Is it always sure that the display agrees with lines in
18393 the current matrix? I don't think so, so we mark rows
18394 displayed invalid in the current matrix by setting their
18395 enabled_p flag to false. */
18396 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18397 if (display_line (&it
))
18398 last_text_row_at_end
= it
.glyph_row
- 1;
18402 /* Update window_end_pos and window_end_vpos. */
18403 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18405 /* Window end line if one of the preserved rows from the current
18406 matrix. Set row to the last row displaying text in current
18407 matrix starting at first_unchanged_at_end_row, after
18409 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18410 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18411 first_unchanged_at_end_row
);
18412 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18413 adjust_window_ends (w
, row
, true);
18414 eassert (w
->window_end_bytepos
>= 0);
18415 IF_DEBUG (debug_method_add (w
, "A"));
18417 else if (last_text_row_at_end
)
18419 adjust_window_ends (w
, last_text_row_at_end
, false);
18420 eassert (w
->window_end_bytepos
>= 0);
18421 IF_DEBUG (debug_method_add (w
, "B"));
18423 else if (last_text_row
)
18425 /* We have displayed either to the end of the window or at the
18426 end of the window, i.e. the last row with text is to be found
18427 in the desired matrix. */
18428 adjust_window_ends (w
, last_text_row
, false);
18429 eassert (w
->window_end_bytepos
>= 0);
18431 else if (first_unchanged_at_end_row
== NULL
18432 && last_text_row
== NULL
18433 && last_text_row_at_end
== NULL
)
18435 /* Displayed to end of window, but no line containing text was
18436 displayed. Lines were deleted at the end of the window. */
18437 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18438 int vpos
= w
->window_end_vpos
;
18439 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18440 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18443 row
== NULL
&& vpos
>= first_vpos
;
18444 --vpos
, --current_row
, --desired_row
)
18446 if (desired_row
->enabled_p
)
18448 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18451 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18455 eassert (row
!= NULL
);
18456 w
->window_end_vpos
= vpos
+ 1;
18457 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18458 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18459 eassert (w
->window_end_bytepos
>= 0);
18460 IF_DEBUG (debug_method_add (w
, "C"));
18465 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18466 debug_end_vpos
= w
->window_end_vpos
));
18468 /* Record that display has not been completed. */
18469 w
->window_end_valid
= false;
18470 w
->desired_matrix
->no_scrolling_p
= true;
18478 /***********************************************************************
18479 More debugging support
18480 ***********************************************************************/
18484 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18485 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18486 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18489 /* Dump the contents of glyph matrix MATRIX on stderr.
18491 GLYPHS 0 means don't show glyph contents.
18492 GLYPHS 1 means show glyphs in short form
18493 GLYPHS > 1 means show glyphs in long form. */
18496 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18499 for (i
= 0; i
< matrix
->nrows
; ++i
)
18500 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18504 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18505 the glyph row and area where the glyph comes from. */
18508 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18510 if (glyph
->type
== CHAR_GLYPH
18511 || glyph
->type
== GLYPHLESS_GLYPH
)
18514 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18515 glyph
- row
->glyphs
[TEXT_AREA
],
18516 (glyph
->type
== CHAR_GLYPH
18520 (BUFFERP (glyph
->object
)
18522 : (STRINGP (glyph
->object
)
18524 : (NILP (glyph
->object
)
18527 glyph
->pixel_width
,
18529 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18533 glyph
->left_box_line_p
,
18534 glyph
->right_box_line_p
);
18536 else if (glyph
->type
== STRETCH_GLYPH
)
18539 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18540 glyph
- row
->glyphs
[TEXT_AREA
],
18543 (BUFFERP (glyph
->object
)
18545 : (STRINGP (glyph
->object
)
18547 : (NILP (glyph
->object
)
18550 glyph
->pixel_width
,
18554 glyph
->left_box_line_p
,
18555 glyph
->right_box_line_p
);
18557 else if (glyph
->type
== IMAGE_GLYPH
)
18560 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18561 glyph
- row
->glyphs
[TEXT_AREA
],
18564 (BUFFERP (glyph
->object
)
18566 : (STRINGP (glyph
->object
)
18568 : (NILP (glyph
->object
)
18571 glyph
->pixel_width
,
18575 glyph
->left_box_line_p
,
18576 glyph
->right_box_line_p
);
18578 else if (glyph
->type
== COMPOSITE_GLYPH
)
18581 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18582 glyph
- row
->glyphs
[TEXT_AREA
],
18585 (BUFFERP (glyph
->object
)
18587 : (STRINGP (glyph
->object
)
18589 : (NILP (glyph
->object
)
18592 glyph
->pixel_width
,
18594 if (glyph
->u
.cmp
.automatic
)
18597 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18598 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18600 glyph
->left_box_line_p
,
18601 glyph
->right_box_line_p
);
18606 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18607 GLYPHS 0 means don't show glyph contents.
18608 GLYPHS 1 means show glyphs in short form
18609 GLYPHS > 1 means show glyphs in long form. */
18612 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18616 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18617 fprintf (stderr
, "==============================================================================\n");
18619 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18620 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18622 MATRIX_ROW_START_CHARPOS (row
),
18623 MATRIX_ROW_END_CHARPOS (row
),
18624 row
->used
[TEXT_AREA
],
18625 row
->contains_overlapping_glyphs_p
,
18627 row
->truncated_on_left_p
,
18628 row
->truncated_on_right_p
,
18630 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18631 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18634 row
->ends_in_middle_of_char_p
,
18635 row
->starts_in_middle_of_char_p
,
18641 row
->visible_height
,
18644 /* The next 3 lines should align to "Start" in the header. */
18645 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18646 row
->end
.overlay_string_index
,
18647 row
->continuation_lines_width
);
18648 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18649 CHARPOS (row
->start
.string_pos
),
18650 CHARPOS (row
->end
.string_pos
));
18651 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18652 row
->end
.dpvec_index
);
18659 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18661 struct glyph
*glyph
= row
->glyphs
[area
];
18662 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18664 /* Glyph for a line end in text. */
18665 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18668 if (glyph
< glyph_end
)
18669 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18671 for (; glyph
< glyph_end
; ++glyph
)
18672 dump_glyph (row
, glyph
, area
);
18675 else if (glyphs
== 1)
18678 char s
[SHRT_MAX
+ 4];
18680 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18684 for (i
= 0; i
< row
->used
[area
]; ++i
)
18686 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18687 if (i
== row
->used
[area
] - 1
18688 && area
== TEXT_AREA
18689 && NILP (glyph
->object
)
18690 && glyph
->type
== CHAR_GLYPH
18691 && glyph
->u
.ch
== ' ')
18693 strcpy (&s
[i
], "[\\n]");
18696 else if (glyph
->type
== CHAR_GLYPH
18697 && glyph
->u
.ch
< 0x80
18698 && glyph
->u
.ch
>= ' ')
18699 s
[i
] = glyph
->u
.ch
;
18705 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18711 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18712 Sdump_glyph_matrix
, 0, 1, "p",
18713 doc
: /* Dump the current matrix of the selected window to stderr.
18714 Shows contents of glyph row structures. With non-nil
18715 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18716 glyphs in short form, otherwise show glyphs in long form.
18718 Interactively, no argument means show glyphs in short form;
18719 with numeric argument, its value is passed as the GLYPHS flag. */)
18720 (Lisp_Object glyphs
)
18722 struct window
*w
= XWINDOW (selected_window
);
18723 struct buffer
*buffer
= XBUFFER (w
->contents
);
18725 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18726 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18727 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18728 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18729 fprintf (stderr
, "=============================================\n");
18730 dump_glyph_matrix (w
->current_matrix
,
18731 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18736 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18737 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18738 Only text-mode frames have frame glyph matrices. */)
18741 struct frame
*f
= XFRAME (selected_frame
);
18743 if (f
->current_matrix
)
18744 dump_glyph_matrix (f
->current_matrix
, 1);
18746 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18751 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18752 doc
: /* Dump glyph row ROW to stderr.
18753 GLYPH 0 means don't dump glyphs.
18754 GLYPH 1 means dump glyphs in short form.
18755 GLYPH > 1 or omitted means dump glyphs in long form. */)
18756 (Lisp_Object row
, Lisp_Object glyphs
)
18758 struct glyph_matrix
*matrix
;
18761 CHECK_NUMBER (row
);
18762 matrix
= XWINDOW (selected_window
)->current_matrix
;
18764 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18765 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18767 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18772 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18773 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18774 GLYPH 0 means don't dump glyphs.
18775 GLYPH 1 means dump glyphs in short form.
18776 GLYPH > 1 or omitted means dump glyphs in long form.
18778 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18780 (Lisp_Object row
, Lisp_Object glyphs
)
18782 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18783 struct frame
*sf
= SELECTED_FRAME ();
18784 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18787 CHECK_NUMBER (row
);
18789 if (vpos
>= 0 && vpos
< m
->nrows
)
18790 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18791 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18797 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18798 doc
: /* Toggle tracing of redisplay.
18799 With ARG, turn tracing on if and only if ARG is positive. */)
18803 trace_redisplay_p
= !trace_redisplay_p
;
18806 arg
= Fprefix_numeric_value (arg
);
18807 trace_redisplay_p
= XINT (arg
) > 0;
18814 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18815 doc
: /* Like `format', but print result to stderr.
18816 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18817 (ptrdiff_t nargs
, Lisp_Object
*args
)
18819 Lisp_Object s
= Fformat (nargs
, args
);
18820 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18824 #endif /* GLYPH_DEBUG */
18828 /***********************************************************************
18829 Building Desired Matrix Rows
18830 ***********************************************************************/
18832 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18833 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18835 static struct glyph_row
*
18836 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18838 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18839 struct buffer
*buffer
= XBUFFER (w
->contents
);
18840 struct buffer
*old
= current_buffer
;
18841 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18842 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18843 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18844 const unsigned char *p
;
18847 int n_glyphs_before
;
18849 set_buffer_temp (buffer
);
18850 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18851 scratch_glyph_row
.reversed_p
= false;
18852 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18853 SET_TEXT_POS (it
.position
, 0, 0);
18855 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18857 while (p
< arrow_end
)
18859 Lisp_Object face
, ilisp
;
18861 /* Get the next character. */
18863 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18866 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18867 if (! ASCII_CHAR_P (it
.c
))
18868 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18872 /* Get its face. */
18873 ilisp
= make_number (p
- arrow_string
);
18874 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18875 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18877 /* Compute its width, get its glyphs. */
18878 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18879 SET_TEXT_POS (it
.position
, -1, -1);
18880 PRODUCE_GLYPHS (&it
);
18882 /* If this character doesn't fit any more in the line, we have
18883 to remove some glyphs. */
18884 if (it
.current_x
> it
.last_visible_x
)
18886 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18891 set_buffer_temp (old
);
18892 return it
.glyph_row
;
18896 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18897 glyphs to insert is determined by produce_special_glyphs. */
18900 insert_left_trunc_glyphs (struct it
*it
)
18902 struct it truncate_it
;
18903 struct glyph
*from
, *end
, *to
, *toend
;
18905 eassert (!FRAME_WINDOW_P (it
->f
)
18906 || (!it
->glyph_row
->reversed_p
18907 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18908 || (it
->glyph_row
->reversed_p
18909 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18911 /* Get the truncation glyphs. */
18913 truncate_it
.current_x
= 0;
18914 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18915 truncate_it
.glyph_row
= &scratch_glyph_row
;
18916 truncate_it
.area
= TEXT_AREA
;
18917 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18918 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18919 truncate_it
.object
= Qnil
;
18920 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18922 /* Overwrite glyphs from IT with truncation glyphs. */
18923 if (!it
->glyph_row
->reversed_p
)
18925 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18927 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18928 end
= from
+ tused
;
18929 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18930 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18931 if (FRAME_WINDOW_P (it
->f
))
18933 /* On GUI frames, when variable-size fonts are displayed,
18934 the truncation glyphs may need more pixels than the row's
18935 glyphs they overwrite. We overwrite more glyphs to free
18936 enough screen real estate, and enlarge the stretch glyph
18937 on the right (see display_line), if there is one, to
18938 preserve the screen position of the truncation glyphs on
18941 struct glyph
*g
= to
;
18944 /* The first glyph could be partially visible, in which case
18945 it->glyph_row->x will be negative. But we want the left
18946 truncation glyphs to be aligned at the left margin of the
18947 window, so we override the x coordinate at which the row
18949 it
->glyph_row
->x
= 0;
18950 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18952 w
+= g
->pixel_width
;
18955 if (g
- to
- tused
> 0)
18957 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18958 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18960 used
= it
->glyph_row
->used
[TEXT_AREA
];
18961 if (it
->glyph_row
->truncated_on_right_p
18962 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18963 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18966 int extra
= w
- it
->truncation_pixel_width
;
18968 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18975 /* There may be padding glyphs left over. Overwrite them too. */
18976 if (!FRAME_WINDOW_P (it
->f
))
18978 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18980 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18987 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18991 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18993 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18994 that back to front. */
18995 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18996 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18997 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18998 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18999 if (FRAME_WINDOW_P (it
->f
))
19002 struct glyph
*g
= to
;
19004 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19006 w
+= g
->pixel_width
;
19009 if (to
- g
- tused
> 0)
19011 if (it
->glyph_row
->truncated_on_right_p
19012 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19013 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19015 int extra
= w
- it
->truncation_pixel_width
;
19017 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19021 while (from
>= end
&& to
>= toend
)
19023 if (!FRAME_WINDOW_P (it
->f
))
19025 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19028 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19029 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19030 while (from
>= end
&& to
>= toend
)
19036 /* Need to free some room before prepending additional
19038 int move_by
= from
- end
+ 1;
19039 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19040 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19042 for ( ; g
>= g0
; g
--)
19044 while (from
>= end
)
19046 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19051 /* Compute the hash code for ROW. */
19053 row_hash (struct glyph_row
*row
)
19056 unsigned hashval
= 0;
19058 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19059 for (k
= 0; k
< row
->used
[area
]; ++k
)
19060 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19061 + row
->glyphs
[area
][k
].u
.val
19062 + row
->glyphs
[area
][k
].face_id
19063 + row
->glyphs
[area
][k
].padding_p
19064 + (row
->glyphs
[area
][k
].type
<< 2));
19069 /* Compute the pixel height and width of IT->glyph_row.
19071 Most of the time, ascent and height of a display line will be equal
19072 to the max_ascent and max_height values of the display iterator
19073 structure. This is not the case if
19075 1. We hit ZV without displaying anything. In this case, max_ascent
19076 and max_height will be zero.
19078 2. We have some glyphs that don't contribute to the line height.
19079 (The glyph row flag contributes_to_line_height_p is for future
19080 pixmap extensions).
19082 The first case is easily covered by using default values because in
19083 these cases, the line height does not really matter, except that it
19084 must not be zero. */
19087 compute_line_metrics (struct it
*it
)
19089 struct glyph_row
*row
= it
->glyph_row
;
19091 if (FRAME_WINDOW_P (it
->f
))
19093 int i
, min_y
, max_y
;
19095 /* The line may consist of one space only, that was added to
19096 place the cursor on it. If so, the row's height hasn't been
19098 if (row
->height
== 0)
19100 if (it
->max_ascent
+ it
->max_descent
== 0)
19101 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19102 row
->ascent
= it
->max_ascent
;
19103 row
->height
= it
->max_ascent
+ it
->max_descent
;
19104 row
->phys_ascent
= it
->max_phys_ascent
;
19105 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19106 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19109 /* Compute the width of this line. */
19110 row
->pixel_width
= row
->x
;
19111 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19112 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19114 eassert (row
->pixel_width
>= 0);
19115 eassert (row
->ascent
>= 0 && row
->height
> 0);
19117 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19118 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19120 /* If first line's physical ascent is larger than its logical
19121 ascent, use the physical ascent, and make the row taller.
19122 This makes accented characters fully visible. */
19123 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19124 && row
->phys_ascent
> row
->ascent
)
19126 row
->height
+= row
->phys_ascent
- row
->ascent
;
19127 row
->ascent
= row
->phys_ascent
;
19130 /* Compute how much of the line is visible. */
19131 row
->visible_height
= row
->height
;
19133 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19134 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19136 if (row
->y
< min_y
)
19137 row
->visible_height
-= min_y
- row
->y
;
19138 if (row
->y
+ row
->height
> max_y
)
19139 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19143 row
->pixel_width
= row
->used
[TEXT_AREA
];
19144 if (row
->continued_p
)
19145 row
->pixel_width
-= it
->continuation_pixel_width
;
19146 else if (row
->truncated_on_right_p
)
19147 row
->pixel_width
-= it
->truncation_pixel_width
;
19148 row
->ascent
= row
->phys_ascent
= 0;
19149 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19150 row
->extra_line_spacing
= 0;
19153 /* Compute a hash code for this row. */
19154 row
->hash
= row_hash (row
);
19156 it
->max_ascent
= it
->max_descent
= 0;
19157 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19161 /* Append one space to the glyph row of iterator IT if doing a
19162 window-based redisplay. The space has the same face as
19163 IT->face_id. Value is true if a space was added.
19165 This function is called to make sure that there is always one glyph
19166 at the end of a glyph row that the cursor can be set on under
19167 window-systems. (If there weren't such a glyph we would not know
19168 how wide and tall a box cursor should be displayed).
19170 At the same time this space let's a nicely handle clearing to the
19171 end of the line if the row ends in italic text. */
19174 append_space_for_newline (struct it
*it
, bool default_face_p
)
19176 if (FRAME_WINDOW_P (it
->f
))
19178 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19180 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19181 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19183 /* Save some values that must not be changed.
19184 Must save IT->c and IT->len because otherwise
19185 ITERATOR_AT_END_P wouldn't work anymore after
19186 append_space_for_newline has been called. */
19187 enum display_element_type saved_what
= it
->what
;
19188 int saved_c
= it
->c
, saved_len
= it
->len
;
19189 int saved_char_to_display
= it
->char_to_display
;
19190 int saved_x
= it
->current_x
;
19191 int saved_face_id
= it
->face_id
;
19192 bool saved_box_end
= it
->end_of_box_run_p
;
19193 struct text_pos saved_pos
;
19194 Lisp_Object saved_object
;
19198 saved_object
= it
->object
;
19199 saved_pos
= it
->position
;
19201 it
->what
= IT_CHARACTER
;
19202 memset (&it
->position
, 0, sizeof it
->position
);
19204 it
->c
= it
->char_to_display
= ' ';
19207 /* If the default face was remapped, be sure to use the
19208 remapped face for the appended newline. */
19209 if (default_face_p
)
19210 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19211 else if (it
->face_before_selective_p
)
19212 it
->face_id
= it
->saved_face_id
;
19213 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19214 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19215 /* In R2L rows, we will prepend a stretch glyph that will
19216 have the end_of_box_run_p flag set for it, so there's no
19217 need for the appended newline glyph to have that flag
19219 if (it
->glyph_row
->reversed_p
19220 /* But if the appended newline glyph goes all the way to
19221 the end of the row, there will be no stretch glyph,
19222 so leave the box flag set. */
19223 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19224 it
->end_of_box_run_p
= false;
19226 PRODUCE_GLYPHS (it
);
19228 #ifdef HAVE_WINDOW_SYSTEM
19229 /* Make sure this space glyph has the right ascent and
19230 descent values, or else cursor at end of line will look
19231 funny, and height of empty lines will be incorrect. */
19232 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19233 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19236 Lisp_Object height
, total_height
;
19237 int extra_line_spacing
= it
->extra_line_spacing
;
19238 int boff
= font
->baseline_offset
;
19240 if (font
->vertical_centering
)
19241 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19243 it
->object
= saved_object
; /* get_it_property needs this */
19244 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19245 /* Must do a subset of line height processing from
19246 x_produce_glyph for newline characters. */
19247 height
= get_it_property (it
, Qline_height
);
19249 && CONSP (XCDR (height
))
19250 && NILP (XCDR (XCDR (height
))))
19252 total_height
= XCAR (XCDR (height
));
19253 height
= XCAR (height
);
19256 total_height
= Qnil
;
19257 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19259 if (it
->override_ascent
>= 0)
19261 it
->ascent
= it
->override_ascent
;
19262 it
->descent
= it
->override_descent
;
19263 boff
= it
->override_boff
;
19265 if (EQ (height
, Qt
))
19266 extra_line_spacing
= 0;
19269 Lisp_Object spacing
;
19271 it
->phys_ascent
= it
->ascent
;
19272 it
->phys_descent
= it
->descent
;
19274 && XINT (height
) > it
->ascent
+ it
->descent
)
19275 it
->ascent
= XINT (height
) - it
->descent
;
19277 if (!NILP (total_height
))
19278 spacing
= calc_line_height_property (it
, total_height
, font
,
19282 spacing
= get_it_property (it
, Qline_spacing
);
19283 spacing
= calc_line_height_property (it
, spacing
, font
,
19286 if (INTEGERP (spacing
))
19288 extra_line_spacing
= XINT (spacing
);
19289 if (!NILP (total_height
))
19290 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19293 if (extra_line_spacing
> 0)
19295 it
->descent
+= extra_line_spacing
;
19296 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19297 it
->max_extra_line_spacing
= extra_line_spacing
;
19299 it
->max_ascent
= it
->ascent
;
19300 it
->max_descent
= it
->descent
;
19301 /* Make sure compute_line_metrics recomputes the row height. */
19302 it
->glyph_row
->height
= 0;
19305 g
->ascent
= it
->max_ascent
;
19306 g
->descent
= it
->max_descent
;
19309 it
->override_ascent
= -1;
19310 it
->constrain_row_ascent_descent_p
= false;
19311 it
->current_x
= saved_x
;
19312 it
->object
= saved_object
;
19313 it
->position
= saved_pos
;
19314 it
->what
= saved_what
;
19315 it
->face_id
= saved_face_id
;
19316 it
->len
= saved_len
;
19318 it
->char_to_display
= saved_char_to_display
;
19319 it
->end_of_box_run_p
= saved_box_end
;
19328 /* Extend the face of the last glyph in the text area of IT->glyph_row
19329 to the end of the display line. Called from display_line. If the
19330 glyph row is empty, add a space glyph to it so that we know the
19331 face to draw. Set the glyph row flag fill_line_p. If the glyph
19332 row is R2L, prepend a stretch glyph to cover the empty space to the
19333 left of the leftmost glyph. */
19336 extend_face_to_end_of_line (struct it
*it
)
19338 struct face
*face
, *default_face
;
19339 struct frame
*f
= it
->f
;
19341 /* If line is already filled, do nothing. Non window-system frames
19342 get a grace of one more ``pixel'' because their characters are
19343 1-``pixel'' wide, so they hit the equality too early. This grace
19344 is needed only for R2L rows that are not continued, to produce
19345 one extra blank where we could display the cursor. */
19346 if ((it
->current_x
>= it
->last_visible_x
19347 + (!FRAME_WINDOW_P (f
)
19348 && it
->glyph_row
->reversed_p
19349 && !it
->glyph_row
->continued_p
))
19350 /* If the window has display margins, we will need to extend
19351 their face even if the text area is filled. */
19352 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19353 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19356 /* The default face, possibly remapped. */
19357 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19359 /* Face extension extends the background and box of IT->face_id
19360 to the end of the line. If the background equals the background
19361 of the frame, we don't have to do anything. */
19362 if (it
->face_before_selective_p
)
19363 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19365 face
= FACE_FROM_ID (f
, it
->face_id
);
19367 if (FRAME_WINDOW_P (f
)
19368 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19369 && face
->box
== FACE_NO_BOX
19370 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19371 #ifdef HAVE_WINDOW_SYSTEM
19374 && !it
->glyph_row
->reversed_p
)
19377 /* Set the glyph row flag indicating that the face of the last glyph
19378 in the text area has to be drawn to the end of the text area. */
19379 it
->glyph_row
->fill_line_p
= true;
19381 /* If current character of IT is not ASCII, make sure we have the
19382 ASCII face. This will be automatically undone the next time
19383 get_next_display_element returns a multibyte character. Note
19384 that the character will always be single byte in unibyte
19386 if (!ASCII_CHAR_P (it
->c
))
19388 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19391 if (FRAME_WINDOW_P (f
))
19393 /* If the row is empty, add a space with the current face of IT,
19394 so that we know which face to draw. */
19395 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19397 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19398 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19399 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19401 /* Mode line and the header line don't have margins, and
19402 likewise the frame's tool-bar window, if there is any. */
19403 if (!(it
->glyph_row
->mode_line_p
19404 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19405 || (WINDOWP (f
->tool_bar_window
)
19406 && it
->w
== XWINDOW (f
->tool_bar_window
))
19410 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19411 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19413 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19414 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19416 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19418 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19419 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19421 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19422 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19424 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19427 #ifdef HAVE_WINDOW_SYSTEM
19428 if (it
->glyph_row
->reversed_p
)
19430 /* Prepend a stretch glyph to the row, such that the
19431 rightmost glyph will be drawn flushed all the way to the
19432 right margin of the window. The stretch glyph that will
19433 occupy the empty space, if any, to the left of the
19435 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19436 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19437 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19439 int row_width
, stretch_ascent
, stretch_width
;
19440 struct text_pos saved_pos
;
19442 bool saved_avoid_cursor
, saved_box_start
;
19444 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19445 row_width
+= g
->pixel_width
;
19447 /* FIXME: There are various minor display glitches in R2L
19448 rows when only one of the fringes is missing. The
19449 strange condition below produces the least bad effect. */
19450 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19451 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19452 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19453 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19455 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19456 stretch_width
-= row_width
;
19458 if (stretch_width
> 0)
19461 (((it
->ascent
+ it
->descent
)
19462 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19463 saved_pos
= it
->position
;
19464 memset (&it
->position
, 0, sizeof it
->position
);
19465 saved_avoid_cursor
= it
->avoid_cursor_p
;
19466 it
->avoid_cursor_p
= true;
19467 saved_face_id
= it
->face_id
;
19468 saved_box_start
= it
->start_of_box_run_p
;
19469 /* The last row's stretch glyph should get the default
19470 face, to avoid painting the rest of the window with
19471 the region face, if the region ends at ZV. */
19472 if (it
->glyph_row
->ends_at_zv_p
)
19473 it
->face_id
= default_face
->id
;
19475 it
->face_id
= face
->id
;
19476 it
->start_of_box_run_p
= false;
19477 append_stretch_glyph (it
, Qnil
, stretch_width
,
19478 it
->ascent
+ it
->descent
, stretch_ascent
);
19479 it
->position
= saved_pos
;
19480 it
->avoid_cursor_p
= saved_avoid_cursor
;
19481 it
->face_id
= saved_face_id
;
19482 it
->start_of_box_run_p
= saved_box_start
;
19484 /* If stretch_width comes out negative, it means that the
19485 last glyph is only partially visible. In R2L rows, we
19486 want the leftmost glyph to be partially visible, so we
19487 need to give the row the corresponding left offset. */
19488 if (stretch_width
< 0)
19489 it
->glyph_row
->x
= stretch_width
;
19491 #endif /* HAVE_WINDOW_SYSTEM */
19495 /* Save some values that must not be changed. */
19496 int saved_x
= it
->current_x
;
19497 struct text_pos saved_pos
;
19498 Lisp_Object saved_object
;
19499 enum display_element_type saved_what
= it
->what
;
19500 int saved_face_id
= it
->face_id
;
19502 saved_object
= it
->object
;
19503 saved_pos
= it
->position
;
19505 it
->what
= IT_CHARACTER
;
19506 memset (&it
->position
, 0, sizeof it
->position
);
19508 it
->c
= it
->char_to_display
= ' ';
19511 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19512 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19513 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19514 && !it
->glyph_row
->mode_line_p
19515 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19517 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19518 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19520 for (it
->current_x
= 0; g
< e
; g
++)
19521 it
->current_x
+= g
->pixel_width
;
19523 it
->area
= LEFT_MARGIN_AREA
;
19524 it
->face_id
= default_face
->id
;
19525 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19526 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19528 PRODUCE_GLYPHS (it
);
19529 /* term.c:produce_glyphs advances it->current_x only for
19531 it
->current_x
+= it
->pixel_width
;
19534 it
->current_x
= saved_x
;
19535 it
->area
= TEXT_AREA
;
19538 /* The last row's blank glyphs should get the default face, to
19539 avoid painting the rest of the window with the region face,
19540 if the region ends at ZV. */
19541 if (it
->glyph_row
->ends_at_zv_p
)
19542 it
->face_id
= default_face
->id
;
19544 it
->face_id
= face
->id
;
19545 PRODUCE_GLYPHS (it
);
19547 while (it
->current_x
<= it
->last_visible_x
)
19548 PRODUCE_GLYPHS (it
);
19550 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19551 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19552 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19553 && !it
->glyph_row
->mode_line_p
19554 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19556 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19557 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19559 for ( ; g
< e
; g
++)
19560 it
->current_x
+= g
->pixel_width
;
19562 it
->area
= RIGHT_MARGIN_AREA
;
19563 it
->face_id
= default_face
->id
;
19564 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19565 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19567 PRODUCE_GLYPHS (it
);
19568 it
->current_x
+= it
->pixel_width
;
19571 it
->area
= TEXT_AREA
;
19574 /* Don't count these blanks really. It would let us insert a left
19575 truncation glyph below and make us set the cursor on them, maybe. */
19576 it
->current_x
= saved_x
;
19577 it
->object
= saved_object
;
19578 it
->position
= saved_pos
;
19579 it
->what
= saved_what
;
19580 it
->face_id
= saved_face_id
;
19585 /* Value is true if text starting at CHARPOS in current_buffer is
19586 trailing whitespace. */
19589 trailing_whitespace_p (ptrdiff_t charpos
)
19591 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19594 while (bytepos
< ZV_BYTE
19595 && (c
= FETCH_CHAR (bytepos
),
19596 c
== ' ' || c
== '\t'))
19599 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19601 if (bytepos
!= PT_BYTE
)
19608 /* Highlight trailing whitespace, if any, in ROW. */
19611 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19613 int used
= row
->used
[TEXT_AREA
];
19617 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19618 struct glyph
*glyph
= start
+ used
- 1;
19620 if (row
->reversed_p
)
19622 /* Right-to-left rows need to be processed in the opposite
19623 direction, so swap the edge pointers. */
19625 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19628 /* Skip over glyphs inserted to display the cursor at the
19629 end of a line, for extending the face of the last glyph
19630 to the end of the line on terminals, and for truncation
19631 and continuation glyphs. */
19632 if (!row
->reversed_p
)
19634 while (glyph
>= start
19635 && glyph
->type
== CHAR_GLYPH
19636 && NILP (glyph
->object
))
19641 while (glyph
<= start
19642 && glyph
->type
== CHAR_GLYPH
19643 && NILP (glyph
->object
))
19647 /* If last glyph is a space or stretch, and it's trailing
19648 whitespace, set the face of all trailing whitespace glyphs in
19649 IT->glyph_row to `trailing-whitespace'. */
19650 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19651 && BUFFERP (glyph
->object
)
19652 && (glyph
->type
== STRETCH_GLYPH
19653 || (glyph
->type
== CHAR_GLYPH
19654 && glyph
->u
.ch
== ' '))
19655 && trailing_whitespace_p (glyph
->charpos
))
19657 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19661 if (!row
->reversed_p
)
19663 while (glyph
>= start
19664 && BUFFERP (glyph
->object
)
19665 && (glyph
->type
== STRETCH_GLYPH
19666 || (glyph
->type
== CHAR_GLYPH
19667 && glyph
->u
.ch
== ' ')))
19668 (glyph
--)->face_id
= face_id
;
19672 while (glyph
<= start
19673 && BUFFERP (glyph
->object
)
19674 && (glyph
->type
== STRETCH_GLYPH
19675 || (glyph
->type
== CHAR_GLYPH
19676 && glyph
->u
.ch
== ' ')))
19677 (glyph
++)->face_id
= face_id
;
19684 /* Value is true if glyph row ROW should be
19685 considered to hold the buffer position CHARPOS. */
19688 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19690 bool result
= true;
19692 if (charpos
== CHARPOS (row
->end
.pos
)
19693 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19695 /* Suppose the row ends on a string.
19696 Unless the row is continued, that means it ends on a newline
19697 in the string. If it's anything other than a display string
19698 (e.g., a before-string from an overlay), we don't want the
19699 cursor there. (This heuristic seems to give the optimal
19700 behavior for the various types of multi-line strings.)
19701 One exception: if the string has `cursor' property on one of
19702 its characters, we _do_ want the cursor there. */
19703 if (CHARPOS (row
->end
.string_pos
) >= 0)
19705 if (row
->continued_p
)
19709 /* Check for `display' property. */
19710 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19711 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19712 struct glyph
*glyph
;
19715 for (glyph
= end
; glyph
>= beg
; --glyph
)
19716 if (STRINGP (glyph
->object
))
19719 = Fget_char_property (make_number (charpos
),
19723 && display_prop_string_p (prop
, glyph
->object
));
19724 /* If there's a `cursor' property on one of the
19725 string's characters, this row is a cursor row,
19726 even though this is not a display string. */
19729 Lisp_Object s
= glyph
->object
;
19731 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19733 ptrdiff_t gpos
= glyph
->charpos
;
19735 if (!NILP (Fget_char_property (make_number (gpos
),
19747 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19749 /* If the row ends in middle of a real character,
19750 and the line is continued, we want the cursor here.
19751 That's because CHARPOS (ROW->end.pos) would equal
19752 PT if PT is before the character. */
19753 if (!row
->ends_in_ellipsis_p
)
19754 result
= row
->continued_p
;
19756 /* If the row ends in an ellipsis, then
19757 CHARPOS (ROW->end.pos) will equal point after the
19758 invisible text. We want that position to be displayed
19759 after the ellipsis. */
19762 /* If the row ends at ZV, display the cursor at the end of that
19763 row instead of at the start of the row below. */
19765 result
= row
->ends_at_zv_p
;
19771 /* Value is true if glyph row ROW should be
19772 used to hold the cursor. */
19775 cursor_row_p (struct glyph_row
*row
)
19777 return row_for_charpos_p (row
, PT
);
19782 /* Push the property PROP so that it will be rendered at the current
19783 position in IT. Return true if PROP was successfully pushed, false
19784 otherwise. Called from handle_line_prefix to handle the
19785 `line-prefix' and `wrap-prefix' properties. */
19788 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19790 struct text_pos pos
=
19791 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19793 eassert (it
->method
== GET_FROM_BUFFER
19794 || it
->method
== GET_FROM_DISPLAY_VECTOR
19795 || it
->method
== GET_FROM_STRING
);
19797 /* We need to save the current buffer/string position, so it will be
19798 restored by pop_it, because iterate_out_of_display_property
19799 depends on that being set correctly, but some situations leave
19800 it->position not yet set when this function is called. */
19801 push_it (it
, &pos
);
19803 if (STRINGP (prop
))
19805 if (SCHARS (prop
) == 0)
19812 it
->string_from_prefix_prop_p
= true;
19813 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19814 it
->current
.overlay_string_index
= -1;
19815 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19816 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19817 it
->method
= GET_FROM_STRING
;
19818 it
->stop_charpos
= 0;
19820 it
->base_level_stop
= 0;
19822 /* Force paragraph direction to be that of the parent
19824 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19825 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19827 it
->paragraph_embedding
= L2R
;
19829 /* Set up the bidi iterator for this display string. */
19832 it
->bidi_it
.string
.lstring
= it
->string
;
19833 it
->bidi_it
.string
.s
= NULL
;
19834 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19835 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19836 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19837 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19838 it
->bidi_it
.w
= it
->w
;
19839 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19842 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19844 it
->method
= GET_FROM_STRETCH
;
19847 #ifdef HAVE_WINDOW_SYSTEM
19848 else if (IMAGEP (prop
))
19850 it
->what
= IT_IMAGE
;
19851 it
->image_id
= lookup_image (it
->f
, prop
);
19852 it
->method
= GET_FROM_IMAGE
;
19854 #endif /* HAVE_WINDOW_SYSTEM */
19857 pop_it (it
); /* bogus display property, give up */
19864 /* Return the character-property PROP at the current position in IT. */
19867 get_it_property (struct it
*it
, Lisp_Object prop
)
19869 Lisp_Object position
, object
= it
->object
;
19871 if (STRINGP (object
))
19872 position
= make_number (IT_STRING_CHARPOS (*it
));
19873 else if (BUFFERP (object
))
19875 position
= make_number (IT_CHARPOS (*it
));
19876 object
= it
->window
;
19881 return Fget_char_property (position
, prop
, object
);
19884 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19887 handle_line_prefix (struct it
*it
)
19889 Lisp_Object prefix
;
19891 if (it
->continuation_lines_width
> 0)
19893 prefix
= get_it_property (it
, Qwrap_prefix
);
19895 prefix
= Vwrap_prefix
;
19899 prefix
= get_it_property (it
, Qline_prefix
);
19901 prefix
= Vline_prefix
;
19903 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19905 /* If the prefix is wider than the window, and we try to wrap
19906 it, it would acquire its own wrap prefix, and so on till the
19907 iterator stack overflows. So, don't wrap the prefix. */
19908 it
->line_wrap
= TRUNCATE
;
19909 it
->avoid_cursor_p
= true;
19915 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19916 only for R2L lines from display_line and display_string, when they
19917 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19918 the line/string needs to be continued on the next glyph row. */
19920 unproduce_glyphs (struct it
*it
, int n
)
19922 struct glyph
*glyph
, *end
;
19924 eassert (it
->glyph_row
);
19925 eassert (it
->glyph_row
->reversed_p
);
19926 eassert (it
->area
== TEXT_AREA
);
19927 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19929 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19930 n
= it
->glyph_row
->used
[TEXT_AREA
];
19931 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19932 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19933 for ( ; glyph
< end
; glyph
++)
19934 glyph
[-n
] = *glyph
;
19937 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19938 and ROW->maxpos. */
19940 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19941 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19942 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19944 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19945 lines' rows is implemented for bidi-reordered rows. */
19947 /* ROW->minpos is the value of min_pos, the minimal buffer position
19948 we have in ROW, or ROW->start.pos if that is smaller. */
19949 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19950 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19952 /* We didn't find buffer positions smaller than ROW->start, or
19953 didn't find _any_ valid buffer positions in any of the glyphs,
19954 so we must trust the iterator's computed positions. */
19955 row
->minpos
= row
->start
.pos
;
19958 max_pos
= CHARPOS (it
->current
.pos
);
19959 max_bpos
= BYTEPOS (it
->current
.pos
);
19962 /* Here are the various use-cases for ending the row, and the
19963 corresponding values for ROW->maxpos:
19965 Line ends in a newline from buffer eol_pos + 1
19966 Line is continued from buffer max_pos + 1
19967 Line is truncated on right it->current.pos
19968 Line ends in a newline from string max_pos + 1(*)
19969 (*) + 1 only when line ends in a forward scan
19970 Line is continued from string max_pos
19971 Line is continued from display vector max_pos
19972 Line is entirely from a string min_pos == max_pos
19973 Line is entirely from a display vector min_pos == max_pos
19974 Line that ends at ZV ZV
19976 If you discover other use-cases, please add them here as
19978 if (row
->ends_at_zv_p
)
19979 row
->maxpos
= it
->current
.pos
;
19980 else if (row
->used
[TEXT_AREA
])
19982 bool seen_this_string
= false;
19983 struct glyph_row
*r1
= row
- 1;
19985 /* Did we see the same display string on the previous row? */
19986 if (STRINGP (it
->object
)
19987 /* this is not the first row */
19988 && row
> it
->w
->desired_matrix
->rows
19989 /* previous row is not the header line */
19990 && !r1
->mode_line_p
19991 /* previous row also ends in a newline from a string */
19992 && r1
->ends_in_newline_from_string_p
)
19994 struct glyph
*start
, *end
;
19996 /* Search for the last glyph of the previous row that came
19997 from buffer or string. Depending on whether the row is
19998 L2R or R2L, we need to process it front to back or the
19999 other way round. */
20000 if (!r1
->reversed_p
)
20002 start
= r1
->glyphs
[TEXT_AREA
];
20003 end
= start
+ r1
->used
[TEXT_AREA
];
20004 /* Glyphs inserted by redisplay have nil as their object. */
20006 && NILP ((end
- 1)->object
)
20007 && (end
- 1)->charpos
<= 0)
20011 if (EQ ((end
- 1)->object
, it
->object
))
20012 seen_this_string
= true;
20015 /* If all the glyphs of the previous row were inserted
20016 by redisplay, it means the previous row was
20017 produced from a single newline, which is only
20018 possible if that newline came from the same string
20019 as the one which produced this ROW. */
20020 seen_this_string
= true;
20024 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20025 start
= end
+ r1
->used
[TEXT_AREA
];
20027 && NILP ((end
+ 1)->object
)
20028 && (end
+ 1)->charpos
<= 0)
20032 if (EQ ((end
+ 1)->object
, it
->object
))
20033 seen_this_string
= true;
20036 seen_this_string
= true;
20039 /* Take note of each display string that covers a newline only
20040 once, the first time we see it. This is for when a display
20041 string includes more than one newline in it. */
20042 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20044 /* If we were scanning the buffer forward when we displayed
20045 the string, we want to account for at least one buffer
20046 position that belongs to this row (position covered by
20047 the display string), so that cursor positioning will
20048 consider this row as a candidate when point is at the end
20049 of the visual line represented by this row. This is not
20050 required when scanning back, because max_pos will already
20051 have a much larger value. */
20052 if (CHARPOS (row
->end
.pos
) > max_pos
)
20053 INC_BOTH (max_pos
, max_bpos
);
20054 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20056 else if (CHARPOS (it
->eol_pos
) > 0)
20057 SET_TEXT_POS (row
->maxpos
,
20058 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20059 else if (row
->continued_p
)
20061 /* If max_pos is different from IT's current position, it
20062 means IT->method does not belong to the display element
20063 at max_pos. However, it also means that the display
20064 element at max_pos was displayed in its entirety on this
20065 line, which is equivalent to saying that the next line
20066 starts at the next buffer position. */
20067 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20068 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20071 INC_BOTH (max_pos
, max_bpos
);
20072 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20075 else if (row
->truncated_on_right_p
)
20076 /* display_line already called reseat_at_next_visible_line_start,
20077 which puts the iterator at the beginning of the next line, in
20078 the logical order. */
20079 row
->maxpos
= it
->current
.pos
;
20080 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20081 /* A line that is entirely from a string/image/stretch... */
20082 row
->maxpos
= row
->minpos
;
20087 row
->maxpos
= it
->current
.pos
;
20090 /* Construct the glyph row IT->glyph_row in the desired matrix of
20091 IT->w from text at the current position of IT. See dispextern.h
20092 for an overview of struct it. Value is true if
20093 IT->glyph_row displays text, as opposed to a line displaying ZV
20097 display_line (struct it
*it
)
20099 struct glyph_row
*row
= it
->glyph_row
;
20100 Lisp_Object overlay_arrow_string
;
20102 void *wrap_data
= NULL
;
20103 bool may_wrap
= false;
20104 int wrap_x
IF_LINT (= 0);
20105 int wrap_row_used
= -1;
20106 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20107 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20108 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20109 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20110 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20112 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20113 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20114 bool pending_handle_line_prefix
= false;
20116 /* We always start displaying at hpos zero even if hscrolled. */
20117 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20119 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20120 >= it
->w
->desired_matrix
->nrows
)
20122 it
->w
->nrows_scale_factor
++;
20123 it
->f
->fonts_changed
= true;
20127 /* Clear the result glyph row and enable it. */
20128 prepare_desired_row (it
->w
, row
, false);
20130 row
->y
= it
->current_y
;
20131 row
->start
= it
->start
;
20132 row
->continuation_lines_width
= it
->continuation_lines_width
;
20133 row
->displays_text_p
= true;
20134 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20135 it
->starts_in_middle_of_char_p
= false;
20137 /* Arrange the overlays nicely for our purposes. Usually, we call
20138 display_line on only one line at a time, in which case this
20139 can't really hurt too much, or we call it on lines which appear
20140 one after another in the buffer, in which case all calls to
20141 recenter_overlay_lists but the first will be pretty cheap. */
20142 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20144 /* Move over display elements that are not visible because we are
20145 hscrolled. This may stop at an x-position < IT->first_visible_x
20146 if the first glyph is partially visible or if we hit a line end. */
20147 if (it
->current_x
< it
->first_visible_x
)
20149 enum move_it_result move_result
;
20151 this_line_min_pos
= row
->start
.pos
;
20152 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20153 MOVE_TO_POS
| MOVE_TO_X
);
20154 /* If we are under a large hscroll, move_it_in_display_line_to
20155 could hit the end of the line without reaching
20156 it->first_visible_x. Pretend that we did reach it. This is
20157 especially important on a TTY, where we will call
20158 extend_face_to_end_of_line, which needs to know how many
20159 blank glyphs to produce. */
20160 if (it
->current_x
< it
->first_visible_x
20161 && (move_result
== MOVE_NEWLINE_OR_CR
20162 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20163 it
->current_x
= it
->first_visible_x
;
20165 /* Record the smallest positions seen while we moved over
20166 display elements that are not visible. This is needed by
20167 redisplay_internal for optimizing the case where the cursor
20168 stays inside the same line. The rest of this function only
20169 considers positions that are actually displayed, so
20170 RECORD_MAX_MIN_POS will not otherwise record positions that
20171 are hscrolled to the left of the left edge of the window. */
20172 min_pos
= CHARPOS (this_line_min_pos
);
20173 min_bpos
= BYTEPOS (this_line_min_pos
);
20175 else if (it
->area
== TEXT_AREA
)
20177 /* We only do this when not calling move_it_in_display_line_to
20178 above, because that function calls itself handle_line_prefix. */
20179 handle_line_prefix (it
);
20183 /* Line-prefix and wrap-prefix are always displayed in the text
20184 area. But if this is the first call to display_line after
20185 init_iterator, the iterator might have been set up to write
20186 into a marginal area, e.g. if the line begins with some
20187 display property that writes to the margins. So we need to
20188 wait with the call to handle_line_prefix until whatever
20189 writes to the margin has done its job. */
20190 pending_handle_line_prefix
= true;
20193 /* Get the initial row height. This is either the height of the
20194 text hscrolled, if there is any, or zero. */
20195 row
->ascent
= it
->max_ascent
;
20196 row
->height
= it
->max_ascent
+ it
->max_descent
;
20197 row
->phys_ascent
= it
->max_phys_ascent
;
20198 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20199 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20201 /* Utility macro to record max and min buffer positions seen until now. */
20202 #define RECORD_MAX_MIN_POS(IT) \
20205 bool composition_p \
20206 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20207 ptrdiff_t current_pos = \
20208 composition_p ? (IT)->cmp_it.charpos \
20209 : IT_CHARPOS (*(IT)); \
20210 ptrdiff_t current_bpos = \
20211 composition_p ? CHAR_TO_BYTE (current_pos) \
20212 : IT_BYTEPOS (*(IT)); \
20213 if (current_pos < min_pos) \
20215 min_pos = current_pos; \
20216 min_bpos = current_bpos; \
20218 if (IT_CHARPOS (*it) > max_pos) \
20220 max_pos = IT_CHARPOS (*it); \
20221 max_bpos = IT_BYTEPOS (*it); \
20226 /* Loop generating characters. The loop is left with IT on the next
20227 character to display. */
20230 int n_glyphs_before
, hpos_before
, x_before
;
20232 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20234 /* Retrieve the next thing to display. Value is false if end of
20236 if (!get_next_display_element (it
))
20238 /* Maybe add a space at the end of this line that is used to
20239 display the cursor there under X. Set the charpos of the
20240 first glyph of blank lines not corresponding to any text
20242 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20243 row
->exact_window_width_line_p
= true;
20244 else if ((append_space_for_newline (it
, true)
20245 && row
->used
[TEXT_AREA
] == 1)
20246 || row
->used
[TEXT_AREA
] == 0)
20248 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20249 row
->displays_text_p
= false;
20251 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20252 && (!MINI_WINDOW_P (it
->w
)
20253 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20254 row
->indicate_empty_line_p
= true;
20257 it
->continuation_lines_width
= 0;
20258 row
->ends_at_zv_p
= true;
20259 /* A row that displays right-to-left text must always have
20260 its last face extended all the way to the end of line,
20261 even if this row ends in ZV, because we still write to
20262 the screen left to right. We also need to extend the
20263 last face if the default face is remapped to some
20264 different face, otherwise the functions that clear
20265 portions of the screen will clear with the default face's
20266 background color. */
20267 if (row
->reversed_p
20268 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20269 extend_face_to_end_of_line (it
);
20273 /* Now, get the metrics of what we want to display. This also
20274 generates glyphs in `row' (which is IT->glyph_row). */
20275 n_glyphs_before
= row
->used
[TEXT_AREA
];
20278 /* Remember the line height so far in case the next element doesn't
20279 fit on the line. */
20280 if (it
->line_wrap
!= TRUNCATE
)
20282 ascent
= it
->max_ascent
;
20283 descent
= it
->max_descent
;
20284 phys_ascent
= it
->max_phys_ascent
;
20285 phys_descent
= it
->max_phys_descent
;
20287 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20289 if (IT_DISPLAYING_WHITESPACE (it
))
20293 SAVE_IT (wrap_it
, *it
, wrap_data
);
20295 wrap_row_used
= row
->used
[TEXT_AREA
];
20296 wrap_row_ascent
= row
->ascent
;
20297 wrap_row_height
= row
->height
;
20298 wrap_row_phys_ascent
= row
->phys_ascent
;
20299 wrap_row_phys_height
= row
->phys_height
;
20300 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20301 wrap_row_min_pos
= min_pos
;
20302 wrap_row_min_bpos
= min_bpos
;
20303 wrap_row_max_pos
= max_pos
;
20304 wrap_row_max_bpos
= max_bpos
;
20310 PRODUCE_GLYPHS (it
);
20312 /* If this display element was in marginal areas, continue with
20314 if (it
->area
!= TEXT_AREA
)
20316 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20317 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20318 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20319 row
->phys_height
= max (row
->phys_height
,
20320 it
->max_phys_ascent
+ it
->max_phys_descent
);
20321 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20322 it
->max_extra_line_spacing
);
20323 set_iterator_to_next (it
, true);
20324 /* If we didn't handle the line/wrap prefix above, and the
20325 call to set_iterator_to_next just switched to TEXT_AREA,
20326 process the prefix now. */
20327 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20329 pending_handle_line_prefix
= false;
20330 handle_line_prefix (it
);
20335 /* Does the display element fit on the line? If we truncate
20336 lines, we should draw past the right edge of the window. If
20337 we don't truncate, we want to stop so that we can display the
20338 continuation glyph before the right margin. If lines are
20339 continued, there are two possible strategies for characters
20340 resulting in more than 1 glyph (e.g. tabs): Display as many
20341 glyphs as possible in this line and leave the rest for the
20342 continuation line, or display the whole element in the next
20343 line. Original redisplay did the former, so we do it also. */
20344 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20345 hpos_before
= it
->hpos
;
20348 if (/* Not a newline. */
20350 /* Glyphs produced fit entirely in the line. */
20351 && it
->current_x
< it
->last_visible_x
)
20353 it
->hpos
+= nglyphs
;
20354 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20355 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20356 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20357 row
->phys_height
= max (row
->phys_height
,
20358 it
->max_phys_ascent
+ it
->max_phys_descent
);
20359 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20360 it
->max_extra_line_spacing
);
20361 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20362 /* In R2L rows, we arrange in extend_face_to_end_of_line
20363 to add a right offset to the line, by a suitable
20364 change to the stretch glyph that is the leftmost
20365 glyph of the line. */
20366 && !row
->reversed_p
)
20367 row
->x
= x
- it
->first_visible_x
;
20368 /* Record the maximum and minimum buffer positions seen so
20369 far in glyphs that will be displayed by this row. */
20371 RECORD_MAX_MIN_POS (it
);
20376 struct glyph
*glyph
;
20378 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20380 /* Identify the glyphs added by the last call to
20381 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20382 the previous glyphs. */
20383 if (!row
->reversed_p
)
20384 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20386 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20387 new_x
= x
+ glyph
->pixel_width
;
20389 if (/* Lines are continued. */
20390 it
->line_wrap
!= TRUNCATE
20391 && (/* Glyph doesn't fit on the line. */
20392 new_x
> it
->last_visible_x
20393 /* Or it fits exactly on a window system frame. */
20394 || (new_x
== it
->last_visible_x
20395 && FRAME_WINDOW_P (it
->f
)
20396 && (row
->reversed_p
20397 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20398 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20400 /* End of a continued line. */
20403 || (new_x
== it
->last_visible_x
20404 && FRAME_WINDOW_P (it
->f
)
20405 && (row
->reversed_p
20406 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20407 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20409 /* Current glyph is the only one on the line or
20410 fits exactly on the line. We must continue
20411 the line because we can't draw the cursor
20412 after the glyph. */
20413 row
->continued_p
= true;
20414 it
->current_x
= new_x
;
20415 it
->continuation_lines_width
+= new_x
;
20417 if (i
== nglyphs
- 1)
20419 /* If line-wrap is on, check if a previous
20420 wrap point was found. */
20421 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20422 && wrap_row_used
> 0
20423 /* Even if there is a previous wrap
20424 point, continue the line here as
20425 usual, if (i) the previous character
20426 was a space or tab AND (ii) the
20427 current character is not. */
20429 || IT_DISPLAYING_WHITESPACE (it
)))
20432 /* Record the maximum and minimum buffer
20433 positions seen so far in glyphs that will be
20434 displayed by this row. */
20436 RECORD_MAX_MIN_POS (it
);
20437 set_iterator_to_next (it
, true);
20438 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20440 if (!get_next_display_element (it
))
20442 row
->exact_window_width_line_p
= true;
20443 it
->continuation_lines_width
= 0;
20444 row
->continued_p
= false;
20445 row
->ends_at_zv_p
= true;
20447 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20449 row
->continued_p
= false;
20450 row
->exact_window_width_line_p
= true;
20452 /* If line-wrap is on, check if a
20453 previous wrap point was found. */
20454 else if (wrap_row_used
> 0
20455 /* Even if there is a previous wrap
20456 point, continue the line here as
20457 usual, if (i) the previous character
20458 was a space or tab AND (ii) the
20459 current character is not. */
20461 || IT_DISPLAYING_WHITESPACE (it
)))
20466 else if (it
->bidi_p
)
20467 RECORD_MAX_MIN_POS (it
);
20468 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20469 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20470 extend_face_to_end_of_line (it
);
20472 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20473 && !FRAME_WINDOW_P (it
->f
))
20475 /* A padding glyph that doesn't fit on this line.
20476 This means the whole character doesn't fit
20478 if (row
->reversed_p
)
20479 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20480 - n_glyphs_before
);
20481 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20483 /* Fill the rest of the row with continuation
20484 glyphs like in 20.x. */
20485 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20486 < row
->glyphs
[1 + TEXT_AREA
])
20487 produce_special_glyphs (it
, IT_CONTINUATION
);
20489 row
->continued_p
= true;
20490 it
->current_x
= x_before
;
20491 it
->continuation_lines_width
+= x_before
;
20493 /* Restore the height to what it was before the
20494 element not fitting on the line. */
20495 it
->max_ascent
= ascent
;
20496 it
->max_descent
= descent
;
20497 it
->max_phys_ascent
= phys_ascent
;
20498 it
->max_phys_descent
= phys_descent
;
20499 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20500 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20501 extend_face_to_end_of_line (it
);
20503 else if (wrap_row_used
> 0)
20506 if (row
->reversed_p
)
20507 unproduce_glyphs (it
,
20508 row
->used
[TEXT_AREA
] - wrap_row_used
);
20509 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20510 it
->continuation_lines_width
+= wrap_x
;
20511 row
->used
[TEXT_AREA
] = wrap_row_used
;
20512 row
->ascent
= wrap_row_ascent
;
20513 row
->height
= wrap_row_height
;
20514 row
->phys_ascent
= wrap_row_phys_ascent
;
20515 row
->phys_height
= wrap_row_phys_height
;
20516 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20517 min_pos
= wrap_row_min_pos
;
20518 min_bpos
= wrap_row_min_bpos
;
20519 max_pos
= wrap_row_max_pos
;
20520 max_bpos
= wrap_row_max_bpos
;
20521 row
->continued_p
= true;
20522 row
->ends_at_zv_p
= false;
20523 row
->exact_window_width_line_p
= false;
20524 it
->continuation_lines_width
+= x
;
20526 /* Make sure that a non-default face is extended
20527 up to the right margin of the window. */
20528 extend_face_to_end_of_line (it
);
20530 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20532 /* A TAB that extends past the right edge of the
20533 window. This produces a single glyph on
20534 window system frames. We leave the glyph in
20535 this row and let it fill the row, but don't
20536 consume the TAB. */
20537 if ((row
->reversed_p
20538 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20539 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20540 produce_special_glyphs (it
, IT_CONTINUATION
);
20541 it
->continuation_lines_width
+= it
->last_visible_x
;
20542 row
->ends_in_middle_of_char_p
= true;
20543 row
->continued_p
= true;
20544 glyph
->pixel_width
= it
->last_visible_x
- x
;
20545 it
->starts_in_middle_of_char_p
= true;
20546 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20547 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20548 extend_face_to_end_of_line (it
);
20552 /* Something other than a TAB that draws past
20553 the right edge of the window. Restore
20554 positions to values before the element. */
20555 if (row
->reversed_p
)
20556 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20557 - (n_glyphs_before
+ i
));
20558 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20560 /* Display continuation glyphs. */
20561 it
->current_x
= x_before
;
20562 it
->continuation_lines_width
+= x
;
20563 if (!FRAME_WINDOW_P (it
->f
)
20564 || (row
->reversed_p
20565 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20566 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20567 produce_special_glyphs (it
, IT_CONTINUATION
);
20568 row
->continued_p
= true;
20570 extend_face_to_end_of_line (it
);
20572 if (nglyphs
> 1 && i
> 0)
20574 row
->ends_in_middle_of_char_p
= true;
20575 it
->starts_in_middle_of_char_p
= true;
20578 /* Restore the height to what it was before the
20579 element not fitting on the line. */
20580 it
->max_ascent
= ascent
;
20581 it
->max_descent
= descent
;
20582 it
->max_phys_ascent
= phys_ascent
;
20583 it
->max_phys_descent
= phys_descent
;
20588 else if (new_x
> it
->first_visible_x
)
20590 /* Increment number of glyphs actually displayed. */
20593 /* Record the maximum and minimum buffer positions
20594 seen so far in glyphs that will be displayed by
20597 RECORD_MAX_MIN_POS (it
);
20599 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20600 /* Glyph is partially visible, i.e. row starts at
20601 negative X position. Don't do that in R2L
20602 rows, where we arrange to add a right offset to
20603 the line in extend_face_to_end_of_line, by a
20604 suitable change to the stretch glyph that is
20605 the leftmost glyph of the line. */
20606 row
->x
= x
- it
->first_visible_x
;
20607 /* When the last glyph of an R2L row only fits
20608 partially on the line, we need to set row->x to a
20609 negative offset, so that the leftmost glyph is
20610 the one that is partially visible. But if we are
20611 going to produce the truncation glyph, this will
20612 be taken care of in produce_special_glyphs. */
20613 if (row
->reversed_p
20614 && new_x
> it
->last_visible_x
20615 && !(it
->line_wrap
== TRUNCATE
20616 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20618 eassert (FRAME_WINDOW_P (it
->f
));
20619 row
->x
= it
->last_visible_x
- new_x
;
20624 /* Glyph is completely off the left margin of the
20625 window. This should not happen because of the
20626 move_it_in_display_line at the start of this
20627 function, unless the text display area of the
20628 window is empty. */
20629 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20632 /* Even if this display element produced no glyphs at all,
20633 we want to record its position. */
20634 if (it
->bidi_p
&& nglyphs
== 0)
20635 RECORD_MAX_MIN_POS (it
);
20637 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20638 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20639 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20640 row
->phys_height
= max (row
->phys_height
,
20641 it
->max_phys_ascent
+ it
->max_phys_descent
);
20642 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20643 it
->max_extra_line_spacing
);
20645 /* End of this display line if row is continued. */
20646 if (row
->continued_p
|| row
->ends_at_zv_p
)
20651 /* Is this a line end? If yes, we're also done, after making
20652 sure that a non-default face is extended up to the right
20653 margin of the window. */
20654 if (ITERATOR_AT_END_OF_LINE_P (it
))
20656 int used_before
= row
->used
[TEXT_AREA
];
20658 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20660 /* Add a space at the end of the line that is used to
20661 display the cursor there. */
20662 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20663 append_space_for_newline (it
, false);
20665 /* Extend the face to the end of the line. */
20666 extend_face_to_end_of_line (it
);
20668 /* Make sure we have the position. */
20669 if (used_before
== 0)
20670 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20672 /* Record the position of the newline, for use in
20674 it
->eol_pos
= it
->current
.pos
;
20676 /* Consume the line end. This skips over invisible lines. */
20677 set_iterator_to_next (it
, true);
20678 it
->continuation_lines_width
= 0;
20682 /* Proceed with next display element. Note that this skips
20683 over lines invisible because of selective display. */
20684 set_iterator_to_next (it
, true);
20686 /* If we truncate lines, we are done when the last displayed
20687 glyphs reach past the right margin of the window. */
20688 if (it
->line_wrap
== TRUNCATE
20689 && ((FRAME_WINDOW_P (it
->f
)
20690 /* Images are preprocessed in produce_image_glyph such
20691 that they are cropped at the right edge of the
20692 window, so an image glyph will always end exactly at
20693 last_visible_x, even if there's no right fringe. */
20694 && ((row
->reversed_p
20695 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20696 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20697 || it
->what
== IT_IMAGE
))
20698 ? (it
->current_x
>= it
->last_visible_x
)
20699 : (it
->current_x
> it
->last_visible_x
)))
20701 /* Maybe add truncation glyphs. */
20702 if (!FRAME_WINDOW_P (it
->f
)
20703 || (row
->reversed_p
20704 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20705 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20709 if (!row
->reversed_p
)
20711 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20712 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20717 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20718 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20720 /* Remove any padding glyphs at the front of ROW, to
20721 make room for the truncation glyphs we will be
20722 adding below. The loop below always inserts at
20723 least one truncation glyph, so also remove the
20724 last glyph added to ROW. */
20725 unproduce_glyphs (it
, i
+ 1);
20726 /* Adjust i for the loop below. */
20727 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20730 /* produce_special_glyphs overwrites the last glyph, so
20731 we don't want that if we want to keep that last
20732 glyph, which means it's an image. */
20733 if (it
->current_x
> it
->last_visible_x
)
20735 it
->current_x
= x_before
;
20736 if (!FRAME_WINDOW_P (it
->f
))
20738 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20740 row
->used
[TEXT_AREA
] = i
;
20741 produce_special_glyphs (it
, IT_TRUNCATION
);
20746 row
->used
[TEXT_AREA
] = i
;
20747 produce_special_glyphs (it
, IT_TRUNCATION
);
20749 it
->hpos
= hpos_before
;
20752 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20754 /* Don't truncate if we can overflow newline into fringe. */
20755 if (!get_next_display_element (it
))
20757 it
->continuation_lines_width
= 0;
20758 row
->ends_at_zv_p
= true;
20759 row
->exact_window_width_line_p
= true;
20762 if (ITERATOR_AT_END_OF_LINE_P (it
))
20764 row
->exact_window_width_line_p
= true;
20765 goto at_end_of_line
;
20767 it
->current_x
= x_before
;
20768 it
->hpos
= hpos_before
;
20771 row
->truncated_on_right_p
= true;
20772 it
->continuation_lines_width
= 0;
20773 reseat_at_next_visible_line_start (it
, false);
20774 /* We insist below that IT's position be at ZV because in
20775 bidi-reordered lines the character at visible line start
20776 might not be the character that follows the newline in
20777 the logical order. */
20778 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20779 row
->ends_at_zv_p
=
20780 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20782 row
->ends_at_zv_p
= false;
20788 bidi_unshelve_cache (wrap_data
, true);
20790 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20791 at the left window margin. */
20792 if (it
->first_visible_x
20793 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20795 if (!FRAME_WINDOW_P (it
->f
)
20796 || (((row
->reversed_p
20797 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20798 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20799 /* Don't let insert_left_trunc_glyphs overwrite the
20800 first glyph of the row if it is an image. */
20801 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20802 insert_left_trunc_glyphs (it
);
20803 row
->truncated_on_left_p
= true;
20806 /* Remember the position at which this line ends.
20808 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20809 cannot be before the call to find_row_edges below, since that is
20810 where these positions are determined. */
20811 row
->end
= it
->current
;
20814 row
->minpos
= row
->start
.pos
;
20815 row
->maxpos
= row
->end
.pos
;
20819 /* ROW->minpos and ROW->maxpos must be the smallest and
20820 `1 + the largest' buffer positions in ROW. But if ROW was
20821 bidi-reordered, these two positions can be anywhere in the
20822 row, so we must determine them now. */
20823 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20826 /* If the start of this line is the overlay arrow-position, then
20827 mark this glyph row as the one containing the overlay arrow.
20828 This is clearly a mess with variable size fonts. It would be
20829 better to let it be displayed like cursors under X. */
20830 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20831 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20832 !NILP (overlay_arrow_string
)))
20834 /* Overlay arrow in window redisplay is a fringe bitmap. */
20835 if (STRINGP (overlay_arrow_string
))
20837 struct glyph_row
*arrow_row
20838 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20839 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20840 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20841 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20842 struct glyph
*p2
, *end
;
20844 /* Copy the arrow glyphs. */
20845 while (glyph
< arrow_end
)
20848 /* Throw away padding glyphs. */
20850 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20851 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20857 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20862 eassert (INTEGERP (overlay_arrow_string
));
20863 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20865 overlay_arrow_seen
= true;
20868 /* Highlight trailing whitespace. */
20869 if (!NILP (Vshow_trailing_whitespace
))
20870 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20872 /* Compute pixel dimensions of this line. */
20873 compute_line_metrics (it
);
20875 /* Implementation note: No changes in the glyphs of ROW or in their
20876 faces can be done past this point, because compute_line_metrics
20877 computes ROW's hash value and stores it within the glyph_row
20880 /* Record whether this row ends inside an ellipsis. */
20881 row
->ends_in_ellipsis_p
20882 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20883 && it
->ellipsis_p
);
20885 /* Save fringe bitmaps in this row. */
20886 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20887 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20888 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20889 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20891 it
->left_user_fringe_bitmap
= 0;
20892 it
->left_user_fringe_face_id
= 0;
20893 it
->right_user_fringe_bitmap
= 0;
20894 it
->right_user_fringe_face_id
= 0;
20896 /* Maybe set the cursor. */
20897 cvpos
= it
->w
->cursor
.vpos
;
20899 /* In bidi-reordered rows, keep checking for proper cursor
20900 position even if one has been found already, because buffer
20901 positions in such rows change non-linearly with ROW->VPOS,
20902 when a line is continued. One exception: when we are at ZV,
20903 display cursor on the first suitable glyph row, since all
20904 the empty rows after that also have their position set to ZV. */
20905 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20906 lines' rows is implemented for bidi-reordered rows. */
20908 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20909 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20910 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20911 && cursor_row_p (row
))
20912 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20914 /* Prepare for the next line. This line starts horizontally at (X
20915 HPOS) = (0 0). Vertical positions are incremented. As a
20916 convenience for the caller, IT->glyph_row is set to the next
20918 it
->current_x
= it
->hpos
= 0;
20919 it
->current_y
+= row
->height
;
20920 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20923 /* The next row should by default use the same value of the
20924 reversed_p flag as this one. set_iterator_to_next decides when
20925 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20926 the flag accordingly. */
20927 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20928 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20929 it
->start
= row
->end
;
20930 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20932 #undef RECORD_MAX_MIN_POS
20935 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20936 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20937 doc
: /* Return paragraph direction at point in BUFFER.
20938 Value is either `left-to-right' or `right-to-left'.
20939 If BUFFER is omitted or nil, it defaults to the current buffer.
20941 Paragraph direction determines how the text in the paragraph is displayed.
20942 In left-to-right paragraphs, text begins at the left margin of the window
20943 and the reading direction is generally left to right. In right-to-left
20944 paragraphs, text begins at the right margin and is read from right to left.
20946 See also `bidi-paragraph-direction'. */)
20947 (Lisp_Object buffer
)
20949 struct buffer
*buf
= current_buffer
;
20950 struct buffer
*old
= buf
;
20952 if (! NILP (buffer
))
20954 CHECK_BUFFER (buffer
);
20955 buf
= XBUFFER (buffer
);
20958 if (NILP (BVAR (buf
, bidi_display_reordering
))
20959 || NILP (BVAR (buf
, enable_multibyte_characters
))
20960 /* When we are loading loadup.el, the character property tables
20961 needed for bidi iteration are not yet available. */
20962 || !NILP (Vpurify_flag
))
20963 return Qleft_to_right
;
20964 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20965 return BVAR (buf
, bidi_paragraph_direction
);
20968 /* Determine the direction from buffer text. We could try to
20969 use current_matrix if it is up to date, but this seems fast
20970 enough as it is. */
20971 struct bidi_it itb
;
20972 ptrdiff_t pos
= BUF_PT (buf
);
20973 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20975 void *itb_data
= bidi_shelve_cache ();
20977 set_buffer_temp (buf
);
20978 /* bidi_paragraph_init finds the base direction of the paragraph
20979 by searching forward from paragraph start. We need the base
20980 direction of the current or _previous_ paragraph, so we need
20981 to make sure we are within that paragraph. To that end, find
20982 the previous non-empty line. */
20983 if (pos
>= ZV
&& pos
> BEGV
)
20984 DEC_BOTH (pos
, bytepos
);
20985 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
20986 if (fast_looking_at (trailing_white_space
,
20987 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20989 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20990 || c
== ' ' || c
== '\t' || c
== '\f')
20992 if (bytepos
<= BEGV_BYTE
)
20997 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21000 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21001 itb
.paragraph_dir
= NEUTRAL_DIR
;
21002 itb
.string
.s
= NULL
;
21003 itb
.string
.lstring
= Qnil
;
21004 itb
.string
.bufpos
= 0;
21005 itb
.string
.from_disp_str
= false;
21006 itb
.string
.unibyte
= false;
21007 /* We have no window to use here for ignoring window-specific
21008 overlays. Using NULL for window pointer will cause
21009 compute_display_string_pos to use the current buffer. */
21011 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21012 bidi_unshelve_cache (itb_data
, false);
21013 set_buffer_temp (old
);
21014 switch (itb
.paragraph_dir
)
21017 return Qleft_to_right
;
21020 return Qright_to_left
;
21028 DEFUN ("bidi-find-overridden-directionality",
21029 Fbidi_find_overridden_directionality
,
21030 Sbidi_find_overridden_directionality
, 2, 3, 0,
21031 doc
: /* Return position between FROM and TO where directionality was overridden.
21033 This function returns the first character position in the specified
21034 region of OBJECT where there is a character whose `bidi-class' property
21035 is `L', but which was forced to display as `R' by a directional
21036 override, and likewise with characters whose `bidi-class' is `R'
21037 or `AL' that were forced to display as `L'.
21039 If no such character is found, the function returns nil.
21041 OBJECT is a Lisp string or buffer to search for overridden
21042 directionality, and defaults to the current buffer if nil or omitted.
21043 OBJECT can also be a window, in which case the function will search
21044 the buffer displayed in that window. Passing the window instead of
21045 a buffer is preferable when the buffer is displayed in some window,
21046 because this function will then be able to correctly account for
21047 window-specific overlays, which can affect the results.
21049 Strong directional characters `L', `R', and `AL' can have their
21050 intrinsic directionality overridden by directional override
21051 control characters RLO (u+202e) and LRO (u+202d). See the
21052 function `get-char-code-property' for a way to inquire about
21053 the `bidi-class' property of a character. */)
21054 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21056 struct buffer
*buf
= current_buffer
;
21057 struct buffer
*old
= buf
;
21058 struct window
*w
= NULL
;
21059 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21060 struct bidi_it itb
;
21061 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21064 if (!NILP (object
))
21066 if (BUFFERP (object
))
21067 buf
= XBUFFER (object
);
21068 else if (WINDOWP (object
))
21070 w
= decode_live_window (object
);
21071 buf
= XBUFFER (w
->contents
);
21072 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21075 CHECK_STRING (object
);
21078 if (STRINGP (object
))
21080 /* Characters in unibyte strings are always treated by bidi.c as
21082 if (!STRING_MULTIBYTE (object
)
21083 /* When we are loading loadup.el, the character property
21084 tables needed for bidi iteration are not yet
21086 || !NILP (Vpurify_flag
))
21089 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21090 if (from_pos
>= SCHARS (object
))
21093 /* Set up the bidi iterator. */
21094 itb_data
= bidi_shelve_cache ();
21095 itb
.paragraph_dir
= NEUTRAL_DIR
;
21096 itb
.string
.lstring
= object
;
21097 itb
.string
.s
= NULL
;
21098 itb
.string
.schars
= SCHARS (object
);
21099 itb
.string
.bufpos
= 0;
21100 itb
.string
.from_disp_str
= false;
21101 itb
.string
.unibyte
= false;
21103 bidi_init_it (0, 0, frame_window_p
, &itb
);
21107 /* Nothing this fancy can happen in unibyte buffers, or in a
21108 buffer that disabled reordering, or if FROM is at EOB. */
21109 if (NILP (BVAR (buf
, bidi_display_reordering
))
21110 || NILP (BVAR (buf
, enable_multibyte_characters
))
21111 /* When we are loading loadup.el, the character property
21112 tables needed for bidi iteration are not yet
21114 || !NILP (Vpurify_flag
))
21117 set_buffer_temp (buf
);
21118 validate_region (&from
, &to
);
21119 from_pos
= XINT (from
);
21120 to_pos
= XINT (to
);
21121 if (from_pos
>= ZV
)
21124 /* Set up the bidi iterator. */
21125 itb_data
= bidi_shelve_cache ();
21126 from_bpos
= CHAR_TO_BYTE (from_pos
);
21127 if (from_pos
== BEGV
)
21129 itb
.charpos
= BEGV
;
21130 itb
.bytepos
= BEGV_BYTE
;
21132 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21134 itb
.charpos
= from_pos
;
21135 itb
.bytepos
= from_bpos
;
21138 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21140 itb
.paragraph_dir
= NEUTRAL_DIR
;
21141 itb
.string
.s
= NULL
;
21142 itb
.string
.lstring
= Qnil
;
21143 itb
.string
.bufpos
= 0;
21144 itb
.string
.from_disp_str
= false;
21145 itb
.string
.unibyte
= false;
21147 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21152 /* For the purposes of this function, the actual base direction of
21153 the paragraph doesn't matter, so just set it to L2R. */
21154 bidi_paragraph_init (L2R
, &itb
, false);
21155 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21157 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21159 bidi_unshelve_cache (itb_data
, false);
21160 set_buffer_temp (old
);
21162 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21165 DEFUN ("move-point-visually", Fmove_point_visually
,
21166 Smove_point_visually
, 1, 1, 0,
21167 doc
: /* Move point in the visual order in the specified DIRECTION.
21168 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21171 Value is the new character position of point. */)
21172 (Lisp_Object direction
)
21174 struct window
*w
= XWINDOW (selected_window
);
21175 struct buffer
*b
= XBUFFER (w
->contents
);
21176 struct glyph_row
*row
;
21178 Lisp_Object paragraph_dir
;
21180 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21181 (!(ROW)->continued_p \
21182 && NILP ((GLYPH)->object) \
21183 && (GLYPH)->type == CHAR_GLYPH \
21184 && (GLYPH)->u.ch == ' ' \
21185 && (GLYPH)->charpos >= 0 \
21186 && !(GLYPH)->avoid_cursor_p)
21188 CHECK_NUMBER (direction
);
21189 dir
= XINT (direction
);
21195 /* If current matrix is up-to-date, we can use the information
21196 recorded in the glyphs, at least as long as the goal is on the
21198 if (w
->window_end_valid
21199 && !windows_or_buffers_changed
21201 && !b
->clip_changed
21202 && !b
->prevent_redisplay_optimizations_p
21203 && !window_outdated (w
)
21204 /* We rely below on the cursor coordinates to be up to date, but
21205 we cannot trust them if some command moved point since the
21206 last complete redisplay. */
21207 && w
->last_point
== BUF_PT (b
)
21208 && w
->cursor
.vpos
>= 0
21209 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21210 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21212 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21213 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21214 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21216 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21218 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21220 SET_PT (g
->charpos
);
21221 w
->cursor
.vpos
= -1;
21222 return make_number (PT
);
21224 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21228 if (BUFFERP (gpt
->object
))
21231 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21232 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21234 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21236 else if (BUFFERP (g
->object
))
21237 new_pos
= g
->charpos
;
21241 w
->cursor
.vpos
= -1;
21242 return make_number (PT
);
21244 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21246 /* Glyphs inserted at the end of a non-empty line for
21247 positioning the cursor have zero charpos, so we must
21248 deduce the value of point by other means. */
21249 if (g
->charpos
> 0)
21250 SET_PT (g
->charpos
);
21251 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21253 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21254 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21257 w
->cursor
.vpos
= -1;
21258 return make_number (PT
);
21261 if (g
== e
|| NILP (g
->object
))
21263 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21264 goto simulate_display
;
21265 if (!row
->reversed_p
)
21269 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21270 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21271 goto simulate_display
;
21275 if (row
->reversed_p
&& !row
->continued_p
)
21277 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21278 w
->cursor
.vpos
= -1;
21279 return make_number (PT
);
21281 g
= row
->glyphs
[TEXT_AREA
];
21282 e
= g
+ row
->used
[TEXT_AREA
];
21283 for ( ; g
< e
; g
++)
21285 if (BUFFERP (g
->object
)
21286 /* Empty lines have only one glyph, which stands
21287 for the newline, and whose charpos is the
21288 buffer position of the newline. */
21289 || ROW_GLYPH_NEWLINE_P (row
, g
)
21290 /* When the buffer ends in a newline, the line at
21291 EOB also has one glyph, but its charpos is -1. */
21292 || (row
->ends_at_zv_p
21293 && !row
->reversed_p
21294 && NILP (g
->object
)
21295 && g
->type
== CHAR_GLYPH
21296 && g
->u
.ch
== ' '))
21298 if (g
->charpos
> 0)
21299 SET_PT (g
->charpos
);
21300 else if (!row
->reversed_p
21301 && row
->ends_at_zv_p
21306 w
->cursor
.vpos
= -1;
21307 return make_number (PT
);
21313 if (!row
->reversed_p
&& !row
->continued_p
)
21315 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21316 w
->cursor
.vpos
= -1;
21317 return make_number (PT
);
21319 e
= row
->glyphs
[TEXT_AREA
];
21320 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21321 for ( ; g
>= e
; g
--)
21323 if (BUFFERP (g
->object
)
21324 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21326 /* Empty R2L lines on GUI frames have the buffer
21327 position of the newline stored in the stretch
21329 || g
->type
== STRETCH_GLYPH
21330 || (row
->ends_at_zv_p
21332 && NILP (g
->object
)
21333 && g
->type
== CHAR_GLYPH
21334 && g
->u
.ch
== ' '))
21336 if (g
->charpos
> 0)
21337 SET_PT (g
->charpos
);
21338 else if (row
->reversed_p
21339 && row
->ends_at_zv_p
21344 w
->cursor
.vpos
= -1;
21345 return make_number (PT
);
21354 /* If we wind up here, we failed to move by using the glyphs, so we
21355 need to simulate display instead. */
21358 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21360 paragraph_dir
= Qleft_to_right
;
21361 if (EQ (paragraph_dir
, Qright_to_left
))
21363 if (PT
<= BEGV
&& dir
< 0)
21364 xsignal0 (Qbeginning_of_buffer
);
21365 else if (PT
>= ZV
&& dir
> 0)
21366 xsignal0 (Qend_of_buffer
);
21369 struct text_pos pt
;
21371 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21373 bool overshoot_expected
= false;
21374 bool target_is_eol_p
= false;
21376 /* Setup the arena. */
21377 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21378 start_display (&it
, w
, pt
);
21379 /* When lines are truncated, we could be called with point
21380 outside of the windows edges, in which case move_it_*
21381 functions either prematurely stop at window's edge or jump to
21382 the next screen line, whereas we rely below on our ability to
21383 reach point, in order to start from its X coordinate. So we
21384 need to disregard the window's horizontal extent in that case. */
21385 if (it
.line_wrap
== TRUNCATE
)
21386 it
.last_visible_x
= INFINITY
;
21388 if (it
.cmp_it
.id
< 0
21389 && it
.method
== GET_FROM_STRING
21390 && it
.area
== TEXT_AREA
21391 && it
.string_from_display_prop_p
21392 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21393 overshoot_expected
= true;
21395 /* Find the X coordinate of point. We start from the beginning
21396 of this or previous line to make sure we are before point in
21397 the logical order (since the move_it_* functions can only
21400 reseat_at_previous_visible_line_start (&it
);
21401 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21402 if (IT_CHARPOS (it
) != PT
)
21404 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21405 -1, -1, -1, MOVE_TO_POS
);
21406 /* If we missed point because the character there is
21407 displayed out of a display vector that has more than one
21408 glyph, retry expecting overshoot. */
21409 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21410 && it
.current
.dpvec_index
> 0
21411 && !overshoot_expected
)
21413 overshoot_expected
= true;
21416 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21417 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21419 pt_x
= it
.current_x
;
21421 if (dir
> 0 || overshoot_expected
)
21423 struct glyph_row
*row
= it
.glyph_row
;
21425 /* When point is at beginning of line, we don't have
21426 information about the glyph there loaded into struct
21427 it. Calling get_next_display_element fixes that. */
21429 get_next_display_element (&it
);
21430 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21431 it
.glyph_row
= NULL
;
21432 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21433 it
.glyph_row
= row
;
21434 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21435 it, lest it will become out of sync with it's buffer
21437 it
.current_x
= pt_x
;
21440 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21441 pixel_width
= it
.pixel_width
;
21442 if (overshoot_expected
&& at_eol_p
)
21444 else if (pixel_width
<= 0)
21447 /* If there's a display string (or something similar) at point,
21448 we are actually at the glyph to the left of point, so we need
21449 to correct the X coordinate. */
21450 if (overshoot_expected
)
21453 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21455 pt_x
+= pixel_width
;
21458 /* Compute target X coordinate, either to the left or to the
21459 right of point. On TTY frames, all characters have the same
21460 pixel width of 1, so we can use that. On GUI frames we don't
21461 have an easy way of getting at the pixel width of the
21462 character to the left of point, so we use a different method
21463 of getting to that place. */
21465 target_x
= pt_x
+ pixel_width
;
21467 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21469 /* Target X coordinate could be one line above or below the line
21470 of point, in which case we need to adjust the target X
21471 coordinate. Also, if moving to the left, we need to begin at
21472 the left edge of the point's screen line. */
21477 start_display (&it
, w
, pt
);
21478 if (it
.line_wrap
== TRUNCATE
)
21479 it
.last_visible_x
= INFINITY
;
21480 reseat_at_previous_visible_line_start (&it
);
21481 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21483 move_it_by_lines (&it
, pt_vpos
);
21487 move_it_by_lines (&it
, -1);
21488 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21489 target_is_eol_p
= true;
21490 /* Under word-wrap, we don't know the x coordinate of
21491 the last character displayed on the previous line,
21492 which immediately precedes the wrap point. To find
21493 out its x coordinate, we try moving to the right
21494 margin of the window, which will stop at the wrap
21495 point, and then reset target_x to point at the
21496 character that precedes the wrap point. This is not
21497 needed on GUI frames, because (see below) there we
21498 move from the left margin one grapheme cluster at a
21499 time, and stop when we hit the wrap point. */
21500 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21502 void *it_data
= NULL
;
21505 SAVE_IT (it2
, it
, it_data
);
21506 move_it_in_display_line_to (&it
, ZV
, target_x
,
21507 MOVE_TO_POS
| MOVE_TO_X
);
21508 /* If we arrived at target_x, that _is_ the last
21509 character on the previous line. */
21510 if (it
.current_x
!= target_x
)
21511 target_x
= it
.current_x
- 1;
21512 RESTORE_IT (&it
, &it2
, it_data
);
21519 || (target_x
>= it
.last_visible_x
21520 && it
.line_wrap
!= TRUNCATE
))
21523 move_it_by_lines (&it
, 0);
21524 move_it_by_lines (&it
, 1);
21529 /* Move to the target X coordinate. */
21530 #ifdef HAVE_WINDOW_SYSTEM
21531 /* On GUI frames, as we don't know the X coordinate of the
21532 character to the left of point, moving point to the left
21533 requires walking, one grapheme cluster at a time, until we
21534 find ourself at a place immediately to the left of the
21535 character at point. */
21536 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21538 struct text_pos new_pos
;
21539 enum move_it_result rc
= MOVE_X_REACHED
;
21541 if (it
.current_x
== 0)
21542 get_next_display_element (&it
);
21543 if (it
.what
== IT_COMPOSITION
)
21545 new_pos
.charpos
= it
.cmp_it
.charpos
;
21546 new_pos
.bytepos
= -1;
21549 new_pos
= it
.current
.pos
;
21551 while (it
.current_x
+ it
.pixel_width
<= target_x
21552 && (rc
== MOVE_X_REACHED
21553 /* Under word-wrap, move_it_in_display_line_to
21554 stops at correct coordinates, but sometimes
21555 returns MOVE_POS_MATCH_OR_ZV. */
21556 || (it
.line_wrap
== WORD_WRAP
21557 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21559 int new_x
= it
.current_x
+ it
.pixel_width
;
21561 /* For composed characters, we want the position of the
21562 first character in the grapheme cluster (usually, the
21563 composition's base character), whereas it.current
21564 might give us the position of the _last_ one, e.g. if
21565 the composition is rendered in reverse due to bidi
21567 if (it
.what
== IT_COMPOSITION
)
21569 new_pos
.charpos
= it
.cmp_it
.charpos
;
21570 new_pos
.bytepos
= -1;
21573 new_pos
= it
.current
.pos
;
21574 if (new_x
== it
.current_x
)
21576 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21577 MOVE_TO_POS
| MOVE_TO_X
);
21578 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21581 /* The previous position we saw in the loop is the one we
21583 if (new_pos
.bytepos
== -1)
21584 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21585 it
.current
.pos
= new_pos
;
21589 if (it
.current_x
!= target_x
)
21590 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21592 /* If we ended up in a display string that covers point, move to
21593 buffer position to the right in the visual order. */
21596 while (IT_CHARPOS (it
) == PT
)
21598 set_iterator_to_next (&it
, false);
21599 if (!get_next_display_element (&it
))
21604 /* Move point to that position. */
21605 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21608 return make_number (PT
);
21610 #undef ROW_GLYPH_NEWLINE_P
21613 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21614 Sbidi_resolved_levels
, 0, 1, 0,
21615 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21617 The resolved levels are produced by the Emacs bidi reordering engine
21618 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21619 read the Unicode Standard Annex 9 (UAX#9) for background information
21620 about these levels.
21622 VPOS is the zero-based number of the current window's screen line
21623 for which to produce the resolved levels. If VPOS is nil or omitted,
21624 it defaults to the screen line of point. If the window displays a
21625 header line, VPOS of zero will report on the header line, and first
21626 line of text in the window will have VPOS of 1.
21628 Value is an array of resolved levels, indexed by glyph number.
21629 Glyphs are numbered from zero starting from the beginning of the
21630 screen line, i.e. the left edge of the window for left-to-right lines
21631 and from the right edge for right-to-left lines. The resolved levels
21632 are produced only for the window's text area; text in display margins
21635 If the selected window's display is not up-to-date, or if the specified
21636 screen line does not display text, this function returns nil. It is
21637 highly recommended to bind this function to some simple key, like F8,
21638 in order to avoid these problems.
21640 This function exists mainly for testing the correctness of the
21641 Emacs UBA implementation, in particular with the test suite. */)
21644 struct window
*w
= XWINDOW (selected_window
);
21645 struct buffer
*b
= XBUFFER (w
->contents
);
21647 struct glyph_row
*row
;
21651 int d1
, d2
, d3
, d4
, d5
;
21653 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21657 CHECK_NUMBER_COERCE_MARKER (vpos
);
21658 nrow
= XINT (vpos
);
21661 /* We require up-to-date glyph matrix for this window. */
21662 if (w
->window_end_valid
21663 && !windows_or_buffers_changed
21665 && !b
->clip_changed
21666 && !b
->prevent_redisplay_optimizations_p
21667 && !window_outdated (w
)
21669 && nrow
< w
->current_matrix
->nrows
21670 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21671 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21673 struct glyph
*g
, *e
, *g1
;
21675 Lisp_Object levels
;
21677 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21679 g
= g1
= row
->glyphs
[TEXT_AREA
];
21680 e
= g
+ row
->used
[TEXT_AREA
];
21682 /* Skip over glyphs at the start of the row that was
21683 generated by redisplay for its own needs. */
21685 && NILP (g
->object
)
21690 /* Count the "interesting" glyphs in this row. */
21691 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21694 /* Create and fill the array. */
21695 levels
= make_uninit_vector (nglyphs
);
21696 for (i
= 0; g1
< g
; i
++, g1
++)
21697 ASET (levels
, i
, make_number (g1
->resolved_level
));
21699 else /* Right-to-left glyph row. */
21701 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21702 e
= row
->glyphs
[TEXT_AREA
] - 1;
21704 && NILP (g
->object
)
21708 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21710 levels
= make_uninit_vector (nglyphs
);
21711 for (i
= 0; g1
> g
; i
++, g1
--)
21712 ASET (levels
, i
, make_number (g1
->resolved_level
));
21722 /***********************************************************************
21724 ***********************************************************************/
21726 /* Redisplay the menu bar in the frame for window W.
21728 The menu bar of X frames that don't have X toolkit support is
21729 displayed in a special window W->frame->menu_bar_window.
21731 The menu bar of terminal frames is treated specially as far as
21732 glyph matrices are concerned. Menu bar lines are not part of
21733 windows, so the update is done directly on the frame matrix rows
21734 for the menu bar. */
21737 display_menu_bar (struct window
*w
)
21739 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21744 /* Don't do all this for graphical frames. */
21746 if (FRAME_W32_P (f
))
21749 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21755 if (FRAME_NS_P (f
))
21757 #endif /* HAVE_NS */
21759 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21760 eassert (!FRAME_WINDOW_P (f
));
21761 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21762 it
.first_visible_x
= 0;
21763 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21764 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21765 if (FRAME_WINDOW_P (f
))
21767 /* Menu bar lines are displayed in the desired matrix of the
21768 dummy window menu_bar_window. */
21769 struct window
*menu_w
;
21770 menu_w
= XWINDOW (f
->menu_bar_window
);
21771 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21773 it
.first_visible_x
= 0;
21774 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21777 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21779 /* This is a TTY frame, i.e. character hpos/vpos are used as
21781 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21783 it
.first_visible_x
= 0;
21784 it
.last_visible_x
= FRAME_COLS (f
);
21787 /* FIXME: This should be controlled by a user option. See the
21788 comments in redisplay_tool_bar and display_mode_line about
21790 it
.paragraph_embedding
= L2R
;
21792 /* Clear all rows of the menu bar. */
21793 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21795 struct glyph_row
*row
= it
.glyph_row
+ i
;
21796 clear_glyph_row (row
);
21797 row
->enabled_p
= true;
21798 row
->full_width_p
= true;
21799 row
->reversed_p
= false;
21802 /* Display all items of the menu bar. */
21803 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21804 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21806 Lisp_Object string
;
21808 /* Stop at nil string. */
21809 string
= AREF (items
, i
+ 1);
21813 /* Remember where item was displayed. */
21814 ASET (items
, i
+ 3, make_number (it
.hpos
));
21816 /* Display the item, pad with one space. */
21817 if (it
.current_x
< it
.last_visible_x
)
21818 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21819 SCHARS (string
) + 1, 0, 0, -1);
21822 /* Fill out the line with spaces. */
21823 if (it
.current_x
< it
.last_visible_x
)
21824 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21826 /* Compute the total height of the lines. */
21827 compute_line_metrics (&it
);
21830 /* Deep copy of a glyph row, including the glyphs. */
21832 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21834 struct glyph
*pointers
[1 + LAST_AREA
];
21835 int to_used
= to
->used
[TEXT_AREA
];
21837 /* Save glyph pointers of TO. */
21838 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21840 /* Do a structure assignment. */
21843 /* Restore original glyph pointers of TO. */
21844 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21846 /* Copy the glyphs. */
21847 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21848 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21850 /* If we filled only part of the TO row, fill the rest with
21851 space_glyph (which will display as empty space). */
21852 if (to_used
> from
->used
[TEXT_AREA
])
21853 fill_up_frame_row_with_spaces (to
, to_used
);
21856 /* Display one menu item on a TTY, by overwriting the glyphs in the
21857 frame F's desired glyph matrix with glyphs produced from the menu
21858 item text. Called from term.c to display TTY drop-down menus one
21861 ITEM_TEXT is the menu item text as a C string.
21863 FACE_ID is the face ID to be used for this menu item. FACE_ID
21864 could specify one of 3 faces: a face for an enabled item, a face
21865 for a disabled item, or a face for a selected item.
21867 X and Y are coordinates of the first glyph in the frame's desired
21868 matrix to be overwritten by the menu item. Since this is a TTY, Y
21869 is the zero-based number of the glyph row and X is the zero-based
21870 glyph number in the row, starting from left, where to start
21871 displaying the item.
21873 SUBMENU means this menu item drops down a submenu, which
21874 should be indicated by displaying a proper visual cue after the
21878 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21879 int x
, int y
, bool submenu
)
21882 struct frame
*f
= SELECTED_FRAME ();
21883 struct window
*w
= XWINDOW (f
->selected_window
);
21884 struct glyph_row
*row
;
21885 size_t item_len
= strlen (item_text
);
21887 eassert (FRAME_TERMCAP_P (f
));
21889 /* Don't write beyond the matrix's last row. This can happen for
21890 TTY screens that are not high enough to show the entire menu.
21891 (This is actually a bit of defensive programming, as
21892 tty_menu_display already limits the number of menu items to one
21893 less than the number of screen lines.) */
21894 if (y
>= f
->desired_matrix
->nrows
)
21897 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21898 it
.first_visible_x
= 0;
21899 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21900 row
= it
.glyph_row
;
21901 /* Start with the row contents from the current matrix. */
21902 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21903 bool saved_width
= row
->full_width_p
;
21904 row
->full_width_p
= true;
21905 bool saved_reversed
= row
->reversed_p
;
21906 row
->reversed_p
= false;
21907 row
->enabled_p
= true;
21909 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21911 eassert (x
< f
->desired_matrix
->matrix_w
);
21912 it
.current_x
= it
.hpos
= x
;
21913 it
.current_y
= it
.vpos
= y
;
21914 int saved_used
= row
->used
[TEXT_AREA
];
21915 bool saved_truncated
= row
->truncated_on_right_p
;
21916 row
->used
[TEXT_AREA
] = x
;
21917 it
.face_id
= face_id
;
21918 it
.line_wrap
= TRUNCATE
;
21920 /* FIXME: This should be controlled by a user option. See the
21921 comments in redisplay_tool_bar and display_mode_line about this.
21922 Also, if paragraph_embedding could ever be R2L, changes will be
21923 needed to avoid shifting to the right the row characters in
21924 term.c:append_glyph. */
21925 it
.paragraph_embedding
= L2R
;
21927 /* Pad with a space on the left. */
21928 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21930 /* Display the menu item, pad with spaces to WIDTH. */
21933 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21934 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21936 /* Indicate with " >" that there's a submenu. */
21937 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21938 FRAME_COLS (f
) - 1, -1);
21941 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21942 width
, 0, FRAME_COLS (f
) - 1, -1);
21944 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21945 row
->truncated_on_right_p
= saved_truncated
;
21946 row
->hash
= row_hash (row
);
21947 row
->full_width_p
= saved_width
;
21948 row
->reversed_p
= saved_reversed
;
21951 /***********************************************************************
21953 ***********************************************************************/
21955 /* Redisplay mode lines in the window tree whose root is WINDOW.
21956 If FORCE, redisplay mode lines unconditionally.
21957 Otherwise, redisplay only mode lines that are garbaged. Value is
21958 the number of windows whose mode lines were redisplayed. */
21961 redisplay_mode_lines (Lisp_Object window
, bool force
)
21965 while (!NILP (window
))
21967 struct window
*w
= XWINDOW (window
);
21969 if (WINDOWP (w
->contents
))
21970 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21972 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21973 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21975 struct text_pos lpoint
;
21976 struct buffer
*old
= current_buffer
;
21978 /* Set the window's buffer for the mode line display. */
21979 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21980 set_buffer_internal_1 (XBUFFER (w
->contents
));
21982 /* Point refers normally to the selected window. For any
21983 other window, set up appropriate value. */
21984 if (!EQ (window
, selected_window
))
21986 struct text_pos pt
;
21988 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21989 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21992 /* Display mode lines. */
21993 clear_glyph_matrix (w
->desired_matrix
);
21994 if (display_mode_lines (w
))
21997 /* Restore old settings. */
21998 set_buffer_internal_1 (old
);
21999 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22009 /* Display the mode and/or header line of window W. Value is the
22010 sum number of mode lines and header lines displayed. */
22013 display_mode_lines (struct window
*w
)
22015 Lisp_Object old_selected_window
= selected_window
;
22016 Lisp_Object old_selected_frame
= selected_frame
;
22017 Lisp_Object new_frame
= w
->frame
;
22018 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22021 selected_frame
= new_frame
;
22022 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22023 or window's point, then we'd need select_window_1 here as well. */
22024 XSETWINDOW (selected_window
, w
);
22025 XFRAME (new_frame
)->selected_window
= selected_window
;
22027 /* These will be set while the mode line specs are processed. */
22028 line_number_displayed
= false;
22029 w
->column_number_displayed
= -1;
22031 if (WINDOW_WANTS_MODELINE_P (w
))
22033 struct window
*sel_w
= XWINDOW (old_selected_window
);
22035 /* Select mode line face based on the real selected window. */
22036 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22037 BVAR (current_buffer
, mode_line_format
));
22041 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22043 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22044 BVAR (current_buffer
, header_line_format
));
22048 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22049 selected_frame
= old_selected_frame
;
22050 selected_window
= old_selected_window
;
22052 w
->must_be_updated_p
= true;
22057 /* Display mode or header line of window W. FACE_ID specifies which
22058 line to display; it is either MODE_LINE_FACE_ID or
22059 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22060 display. Value is the pixel height of the mode/header line
22064 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22068 ptrdiff_t count
= SPECPDL_INDEX ();
22070 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22071 /* Don't extend on a previously drawn mode-line.
22072 This may happen if called from pos_visible_p. */
22073 it
.glyph_row
->enabled_p
= false;
22074 prepare_desired_row (w
, it
.glyph_row
, true);
22076 it
.glyph_row
->mode_line_p
= true;
22078 /* FIXME: This should be controlled by a user option. But
22079 supporting such an option is not trivial, since the mode line is
22080 made up of many separate strings. */
22081 it
.paragraph_embedding
= L2R
;
22083 record_unwind_protect (unwind_format_mode_line
,
22084 format_mode_line_unwind_data (NULL
, NULL
,
22087 mode_line_target
= MODE_LINE_DISPLAY
;
22089 /* Temporarily make frame's keyboard the current kboard so that
22090 kboard-local variables in the mode_line_format will get the right
22092 push_kboard (FRAME_KBOARD (it
.f
));
22093 record_unwind_save_match_data ();
22094 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22097 unbind_to (count
, Qnil
);
22099 /* Fill up with spaces. */
22100 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22102 compute_line_metrics (&it
);
22103 it
.glyph_row
->full_width_p
= true;
22104 it
.glyph_row
->continued_p
= false;
22105 it
.glyph_row
->truncated_on_left_p
= false;
22106 it
.glyph_row
->truncated_on_right_p
= false;
22108 /* Make a 3D mode-line have a shadow at its right end. */
22109 face
= FACE_FROM_ID (it
.f
, face_id
);
22110 extend_face_to_end_of_line (&it
);
22111 if (face
->box
!= FACE_NO_BOX
)
22113 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22114 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22115 last
->right_box_line_p
= true;
22118 return it
.glyph_row
->height
;
22121 /* Move element ELT in LIST to the front of LIST.
22122 Return the updated list. */
22125 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22127 register Lisp_Object tail
, prev
;
22128 register Lisp_Object tem
;
22132 while (CONSP (tail
))
22138 /* Splice out the link TAIL. */
22140 list
= XCDR (tail
);
22142 Fsetcdr (prev
, XCDR (tail
));
22144 /* Now make it the first. */
22145 Fsetcdr (tail
, list
);
22150 tail
= XCDR (tail
);
22154 /* Not found--return unchanged LIST. */
22158 /* Contribute ELT to the mode line for window IT->w. How it
22159 translates into text depends on its data type.
22161 IT describes the display environment in which we display, as usual.
22163 DEPTH is the depth in recursion. It is used to prevent
22164 infinite recursion here.
22166 FIELD_WIDTH is the number of characters the display of ELT should
22167 occupy in the mode line, and PRECISION is the maximum number of
22168 characters to display from ELT's representation. See
22169 display_string for details.
22171 Returns the hpos of the end of the text generated by ELT.
22173 PROPS is a property list to add to any string we encounter.
22175 If RISKY, remove (disregard) any properties in any string
22176 we encounter, and ignore :eval and :propertize.
22178 The global variable `mode_line_target' determines whether the
22179 output is passed to `store_mode_line_noprop',
22180 `store_mode_line_string', or `display_string'. */
22183 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22184 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22186 int n
= 0, field
, prec
;
22187 bool literal
= false;
22191 elt
= build_string ("*too-deep*");
22195 switch (XTYPE (elt
))
22199 /* A string: output it and check for %-constructs within it. */
22201 ptrdiff_t offset
= 0;
22203 if (SCHARS (elt
) > 0
22204 && (!NILP (props
) || risky
))
22206 Lisp_Object oprops
, aelt
;
22207 oprops
= Ftext_properties_at (make_number (0), elt
);
22209 /* If the starting string's properties are not what
22210 we want, translate the string. Also, if the string
22211 is risky, do that anyway. */
22213 if (NILP (Fequal (props
, oprops
)) || risky
)
22215 /* If the starting string has properties,
22216 merge the specified ones onto the existing ones. */
22217 if (! NILP (oprops
) && !risky
)
22221 oprops
= Fcopy_sequence (oprops
);
22223 while (CONSP (tem
))
22225 oprops
= Fplist_put (oprops
, XCAR (tem
),
22226 XCAR (XCDR (tem
)));
22227 tem
= XCDR (XCDR (tem
));
22232 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22233 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22235 /* AELT is what we want. Move it to the front
22236 without consing. */
22238 mode_line_proptrans_alist
22239 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22245 /* If AELT has the wrong props, it is useless.
22246 so get rid of it. */
22248 mode_line_proptrans_alist
22249 = Fdelq (aelt
, mode_line_proptrans_alist
);
22251 elt
= Fcopy_sequence (elt
);
22252 Fset_text_properties (make_number (0), Flength (elt
),
22254 /* Add this item to mode_line_proptrans_alist. */
22255 mode_line_proptrans_alist
22256 = Fcons (Fcons (elt
, props
),
22257 mode_line_proptrans_alist
);
22258 /* Truncate mode_line_proptrans_alist
22259 to at most 50 elements. */
22260 tem
= Fnthcdr (make_number (50),
22261 mode_line_proptrans_alist
);
22263 XSETCDR (tem
, Qnil
);
22272 prec
= precision
- n
;
22273 switch (mode_line_target
)
22275 case MODE_LINE_NOPROP
:
22276 case MODE_LINE_TITLE
:
22277 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22279 case MODE_LINE_STRING
:
22280 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22282 case MODE_LINE_DISPLAY
:
22283 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22284 0, prec
, 0, STRING_MULTIBYTE (elt
));
22291 /* Handle the non-literal case. */
22293 while ((precision
<= 0 || n
< precision
)
22294 && SREF (elt
, offset
) != 0
22295 && (mode_line_target
!= MODE_LINE_DISPLAY
22296 || it
->current_x
< it
->last_visible_x
))
22298 ptrdiff_t last_offset
= offset
;
22300 /* Advance to end of string or next format specifier. */
22301 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22304 if (offset
- 1 != last_offset
)
22306 ptrdiff_t nchars
, nbytes
;
22308 /* Output to end of string or up to '%'. Field width
22309 is length of string. Don't output more than
22310 PRECISION allows us. */
22313 prec
= c_string_width (SDATA (elt
) + last_offset
,
22314 offset
- last_offset
, precision
- n
,
22317 switch (mode_line_target
)
22319 case MODE_LINE_NOPROP
:
22320 case MODE_LINE_TITLE
:
22321 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22323 case MODE_LINE_STRING
:
22325 ptrdiff_t bytepos
= last_offset
;
22326 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22327 ptrdiff_t endpos
= (precision
<= 0
22328 ? string_byte_to_char (elt
, offset
)
22329 : charpos
+ nchars
);
22330 Lisp_Object mode_string
22331 = Fsubstring (elt
, make_number (charpos
),
22332 make_number (endpos
));
22333 n
+= store_mode_line_string (NULL
, mode_string
, false,
22337 case MODE_LINE_DISPLAY
:
22339 ptrdiff_t bytepos
= last_offset
;
22340 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22342 if (precision
<= 0)
22343 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22344 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22346 STRING_MULTIBYTE (elt
));
22351 else /* c == '%' */
22353 ptrdiff_t percent_position
= offset
;
22355 /* Get the specified minimum width. Zero means
22358 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22359 field
= field
* 10 + c
- '0';
22361 /* Don't pad beyond the total padding allowed. */
22362 if (field_width
- n
> 0 && field
> field_width
- n
)
22363 field
= field_width
- n
;
22365 /* Note that either PRECISION <= 0 or N < PRECISION. */
22366 prec
= precision
- n
;
22369 n
+= display_mode_element (it
, depth
, field
, prec
,
22370 Vglobal_mode_string
, props
,
22375 ptrdiff_t bytepos
, charpos
;
22377 Lisp_Object string
;
22379 bytepos
= percent_position
;
22380 charpos
= (STRING_MULTIBYTE (elt
)
22381 ? string_byte_to_char (elt
, bytepos
)
22383 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22384 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22386 switch (mode_line_target
)
22388 case MODE_LINE_NOPROP
:
22389 case MODE_LINE_TITLE
:
22390 n
+= store_mode_line_noprop (spec
, field
, prec
);
22392 case MODE_LINE_STRING
:
22394 Lisp_Object tem
= build_string (spec
);
22395 props
= Ftext_properties_at (make_number (charpos
), elt
);
22396 /* Should only keep face property in props */
22397 n
+= store_mode_line_string (NULL
, tem
, false,
22398 field
, prec
, props
);
22401 case MODE_LINE_DISPLAY
:
22403 int nglyphs_before
, nwritten
;
22405 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22406 nwritten
= display_string (spec
, string
, elt
,
22411 /* Assign to the glyphs written above the
22412 string where the `%x' came from, position
22416 struct glyph
*glyph
22417 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22421 for (i
= 0; i
< nwritten
; ++i
)
22423 glyph
[i
].object
= elt
;
22424 glyph
[i
].charpos
= charpos
;
22441 /* A symbol: process the value of the symbol recursively
22442 as if it appeared here directly. Avoid error if symbol void.
22443 Special case: if value of symbol is a string, output the string
22446 register Lisp_Object tem
;
22448 /* If the variable is not marked as risky to set
22449 then its contents are risky to use. */
22450 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22453 tem
= Fboundp (elt
);
22456 tem
= Fsymbol_value (elt
);
22457 /* If value is a string, output that string literally:
22458 don't check for % within it. */
22462 if (!EQ (tem
, elt
))
22464 /* Give up right away for nil or t. */
22474 register Lisp_Object car
, tem
;
22476 /* A cons cell: five distinct cases.
22477 If first element is :eval or :propertize, do something special.
22478 If first element is a string or a cons, process all the elements
22479 and effectively concatenate them.
22480 If first element is a negative number, truncate displaying cdr to
22481 at most that many characters. If positive, pad (with spaces)
22482 to at least that many characters.
22483 If first element is a symbol, process the cadr or caddr recursively
22484 according to whether the symbol's value is non-nil or nil. */
22486 if (EQ (car
, QCeval
))
22488 /* An element of the form (:eval FORM) means evaluate FORM
22489 and use the result as mode line elements. */
22494 if (CONSP (XCDR (elt
)))
22497 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22498 n
+= display_mode_element (it
, depth
, field_width
- n
,
22499 precision
- n
, spec
, props
,
22503 else if (EQ (car
, QCpropertize
))
22505 /* An element of the form (:propertize ELT PROPS...)
22506 means display ELT but applying properties PROPS. */
22511 if (CONSP (XCDR (elt
)))
22512 n
+= display_mode_element (it
, depth
, field_width
- n
,
22513 precision
- n
, XCAR (XCDR (elt
)),
22514 XCDR (XCDR (elt
)), risky
);
22516 else if (SYMBOLP (car
))
22518 tem
= Fboundp (car
);
22522 /* elt is now the cdr, and we know it is a cons cell.
22523 Use its car if CAR has a non-nil value. */
22526 tem
= Fsymbol_value (car
);
22533 /* Symbol's value is nil (or symbol is unbound)
22534 Get the cddr of the original list
22535 and if possible find the caddr and use that. */
22539 else if (!CONSP (elt
))
22544 else if (INTEGERP (car
))
22546 register int lim
= XINT (car
);
22550 /* Negative int means reduce maximum width. */
22551 if (precision
<= 0)
22554 precision
= min (precision
, -lim
);
22558 /* Padding specified. Don't let it be more than
22559 current maximum. */
22561 lim
= min (precision
, lim
);
22563 /* If that's more padding than already wanted, queue it.
22564 But don't reduce padding already specified even if
22565 that is beyond the current truncation point. */
22566 field_width
= max (lim
, field_width
);
22570 else if (STRINGP (car
) || CONSP (car
))
22572 Lisp_Object halftail
= elt
;
22576 && (precision
<= 0 || n
< precision
))
22578 n
+= display_mode_element (it
, depth
,
22579 /* Do padding only after the last
22580 element in the list. */
22581 (! CONSP (XCDR (elt
))
22584 precision
- n
, XCAR (elt
),
22588 if ((len
& 1) == 0)
22589 halftail
= XCDR (halftail
);
22590 /* Check for cycle. */
22591 if (EQ (halftail
, elt
))
22600 elt
= build_string ("*invalid*");
22604 /* Pad to FIELD_WIDTH. */
22605 if (field_width
> 0 && n
< field_width
)
22607 switch (mode_line_target
)
22609 case MODE_LINE_NOPROP
:
22610 case MODE_LINE_TITLE
:
22611 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22613 case MODE_LINE_STRING
:
22614 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22617 case MODE_LINE_DISPLAY
:
22618 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22627 /* Store a mode-line string element in mode_line_string_list.
22629 If STRING is non-null, display that C string. Otherwise, the Lisp
22630 string LISP_STRING is displayed.
22632 FIELD_WIDTH is the minimum number of output glyphs to produce.
22633 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22634 with spaces. FIELD_WIDTH <= 0 means don't pad.
22636 PRECISION is the maximum number of characters to output from
22637 STRING. PRECISION <= 0 means don't truncate the string.
22639 If COPY_STRING, make a copy of LISP_STRING before adding
22640 properties to the string.
22642 PROPS are the properties to add to the string.
22643 The mode_line_string_face face property is always added to the string.
22647 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22649 int field_width
, int precision
, Lisp_Object props
)
22654 if (string
!= NULL
)
22656 len
= strlen (string
);
22657 if (precision
> 0 && len
> precision
)
22659 lisp_string
= make_string (string
, len
);
22661 props
= mode_line_string_face_prop
;
22662 else if (!NILP (mode_line_string_face
))
22664 Lisp_Object face
= Fplist_get (props
, Qface
);
22665 props
= Fcopy_sequence (props
);
22667 face
= mode_line_string_face
;
22669 face
= list2 (face
, mode_line_string_face
);
22670 props
= Fplist_put (props
, Qface
, face
);
22672 Fadd_text_properties (make_number (0), make_number (len
),
22673 props
, lisp_string
);
22677 len
= XFASTINT (Flength (lisp_string
));
22678 if (precision
> 0 && len
> precision
)
22681 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22684 if (!NILP (mode_line_string_face
))
22688 props
= Ftext_properties_at (make_number (0), lisp_string
);
22689 face
= Fplist_get (props
, Qface
);
22691 face
= mode_line_string_face
;
22693 face
= list2 (face
, mode_line_string_face
);
22694 props
= list2 (Qface
, face
);
22696 lisp_string
= Fcopy_sequence (lisp_string
);
22699 Fadd_text_properties (make_number (0), make_number (len
),
22700 props
, lisp_string
);
22705 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22709 if (field_width
> len
)
22711 field_width
-= len
;
22712 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22714 Fadd_text_properties (make_number (0), make_number (field_width
),
22715 props
, lisp_string
);
22716 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22724 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22726 doc
: /* Format a string out of a mode line format specification.
22727 First arg FORMAT specifies the mode line format (see `mode-line-format'
22728 for details) to use.
22730 By default, the format is evaluated for the currently selected window.
22732 Optional second arg FACE specifies the face property to put on all
22733 characters for which no face is specified. The value nil means the
22734 default face. The value t means whatever face the window's mode line
22735 currently uses (either `mode-line' or `mode-line-inactive',
22736 depending on whether the window is the selected window or not).
22737 An integer value means the value string has no text
22740 Optional third and fourth args WINDOW and BUFFER specify the window
22741 and buffer to use as the context for the formatting (defaults
22742 are the selected window and the WINDOW's buffer). */)
22743 (Lisp_Object format
, Lisp_Object face
,
22744 Lisp_Object window
, Lisp_Object buffer
)
22749 struct buffer
*old_buffer
= NULL
;
22751 bool no_props
= INTEGERP (face
);
22752 ptrdiff_t count
= SPECPDL_INDEX ();
22754 int string_start
= 0;
22756 w
= decode_any_window (window
);
22757 XSETWINDOW (window
, w
);
22760 buffer
= w
->contents
;
22761 CHECK_BUFFER (buffer
);
22763 /* Make formatting the modeline a non-op when noninteractive, otherwise
22764 there will be problems later caused by a partially initialized frame. */
22765 if (NILP (format
) || noninteractive
)
22766 return empty_unibyte_string
;
22771 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22772 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22773 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22774 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22775 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22776 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22777 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22780 old_buffer
= current_buffer
;
22782 /* Save things including mode_line_proptrans_alist,
22783 and set that to nil so that we don't alter the outer value. */
22784 record_unwind_protect (unwind_format_mode_line
,
22785 format_mode_line_unwind_data
22786 (XFRAME (WINDOW_FRAME (w
)),
22787 old_buffer
, selected_window
, true));
22788 mode_line_proptrans_alist
= Qnil
;
22790 Fselect_window (window
, Qt
);
22791 set_buffer_internal_1 (XBUFFER (buffer
));
22793 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22797 mode_line_target
= MODE_LINE_NOPROP
;
22798 mode_line_string_face_prop
= Qnil
;
22799 mode_line_string_list
= Qnil
;
22800 string_start
= MODE_LINE_NOPROP_LEN (0);
22804 mode_line_target
= MODE_LINE_STRING
;
22805 mode_line_string_list
= Qnil
;
22806 mode_line_string_face
= face
;
22807 mode_line_string_face_prop
22808 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22811 push_kboard (FRAME_KBOARD (it
.f
));
22812 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22817 len
= MODE_LINE_NOPROP_LEN (string_start
);
22818 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22822 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22823 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
22824 empty_unibyte_string
);
22827 unbind_to (count
, Qnil
);
22831 /* Write a null-terminated, right justified decimal representation of
22832 the positive integer D to BUF using a minimal field width WIDTH. */
22835 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22837 register char *p
= buf
;
22845 *p
++ = d
% 10 + '0';
22850 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22861 /* Write a null-terminated, right justified decimal and "human
22862 readable" representation of the nonnegative integer D to BUF using
22863 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22865 static const char power_letter
[] =
22879 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22881 /* We aim to represent the nonnegative integer D as
22882 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22883 ptrdiff_t quotient
= d
;
22885 /* -1 means: do not use TENTHS. */
22889 /* Length of QUOTIENT.TENTHS as a string. */
22895 if (quotient
>= 1000)
22897 /* Scale to the appropriate EXPONENT. */
22900 remainder
= quotient
% 1000;
22904 while (quotient
>= 1000);
22906 /* Round to nearest and decide whether to use TENTHS or not. */
22909 tenths
= remainder
/ 100;
22910 if (remainder
% 100 >= 50)
22917 if (quotient
== 10)
22925 if (remainder
>= 500)
22927 if (quotient
< 999)
22938 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22939 if (tenths
== -1 && quotient
<= 99)
22946 p
= psuffix
= buf
+ max (width
, length
);
22948 /* Print EXPONENT. */
22949 *psuffix
++ = power_letter
[exponent
];
22952 /* Print TENTHS. */
22955 *--p
= '0' + tenths
;
22959 /* Print QUOTIENT. */
22962 int digit
= quotient
% 10;
22963 *--p
= '0' + digit
;
22965 while ((quotient
/= 10) != 0);
22967 /* Print leading spaces. */
22972 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22973 If EOL_FLAG, set also a mnemonic character for end-of-line
22974 type of CODING_SYSTEM. Return updated pointer into BUF. */
22976 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22979 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
22982 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22983 const unsigned char *eol_str
;
22985 /* The EOL conversion we are using. */
22986 Lisp_Object eoltype
;
22988 val
= CODING_SYSTEM_SPEC (coding_system
);
22991 if (!VECTORP (val
)) /* Not yet decided. */
22993 *buf
++ = multibyte
? '-' : ' ';
22995 eoltype
= eol_mnemonic_undecided
;
22996 /* Don't mention EOL conversion if it isn't decided. */
23001 Lisp_Object eolvalue
;
23003 attrs
= AREF (val
, 0);
23004 eolvalue
= AREF (val
, 2);
23007 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23012 /* The EOL conversion that is normal on this system. */
23014 if (NILP (eolvalue
)) /* Not yet decided. */
23015 eoltype
= eol_mnemonic_undecided
;
23016 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23017 eoltype
= eol_mnemonic_undecided
;
23018 else /* eolvalue is Qunix, Qdos, or Qmac. */
23019 eoltype
= (EQ (eolvalue
, Qunix
)
23020 ? eol_mnemonic_unix
23021 : EQ (eolvalue
, Qdos
)
23022 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23028 /* Mention the EOL conversion if it is not the usual one. */
23029 if (STRINGP (eoltype
))
23031 eol_str
= SDATA (eoltype
);
23032 eol_str_len
= SBYTES (eoltype
);
23034 else if (CHARACTERP (eoltype
))
23036 int c
= XFASTINT (eoltype
);
23037 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23041 eol_str
= invalid_eol_type
;
23042 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23044 memcpy (buf
, eol_str
, eol_str_len
);
23045 buf
+= eol_str_len
;
23051 /* Return a string for the output of a mode line %-spec for window W,
23052 generated by character C. FIELD_WIDTH > 0 means pad the string
23053 returned with spaces to that value. Return a Lisp string in
23054 *STRING if the resulting string is taken from that Lisp string.
23056 Note we operate on the current buffer for most purposes. */
23058 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23060 static const char *
23061 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23062 Lisp_Object
*string
)
23065 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23066 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23067 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23068 produce strings from numerical values, so limit preposterously
23069 large values of FIELD_WIDTH to avoid overrunning the buffer's
23070 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23071 bytes plus the terminating null. */
23072 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23073 struct buffer
*b
= current_buffer
;
23081 if (!NILP (BVAR (b
, read_only
)))
23083 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23088 /* This differs from %* only for a modified read-only buffer. */
23089 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23091 if (!NILP (BVAR (b
, read_only
)))
23096 /* This differs from %* in ignoring read-only-ness. */
23097 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23109 if (command_loop_level
> 5)
23111 p
= decode_mode_spec_buf
;
23112 for (i
= 0; i
< command_loop_level
; i
++)
23115 return decode_mode_spec_buf
;
23123 if (command_loop_level
> 5)
23125 p
= decode_mode_spec_buf
;
23126 for (i
= 0; i
< command_loop_level
; i
++)
23129 return decode_mode_spec_buf
;
23136 /* Let lots_of_dashes be a string of infinite length. */
23137 if (mode_line_target
== MODE_LINE_NOPROP
23138 || mode_line_target
== MODE_LINE_STRING
)
23140 if (field_width
<= 0
23141 || field_width
> sizeof (lots_of_dashes
))
23143 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23144 decode_mode_spec_buf
[i
] = '-';
23145 decode_mode_spec_buf
[i
] = '\0';
23146 return decode_mode_spec_buf
;
23149 return lots_of_dashes
;
23153 obj
= BVAR (b
, name
);
23157 /* %c and %l are ignored in `frame-title-format'.
23158 (In redisplay_internal, the frame title is drawn _before_ the
23159 windows are updated, so the stuff which depends on actual
23160 window contents (such as %l) may fail to render properly, or
23161 even crash emacs.) */
23162 if (mode_line_target
== MODE_LINE_TITLE
)
23166 ptrdiff_t col
= current_column ();
23167 w
->column_number_displayed
= col
;
23168 pint2str (decode_mode_spec_buf
, width
, col
);
23169 return decode_mode_spec_buf
;
23173 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23175 if (NILP (Vmemory_full
))
23178 return "!MEM FULL! ";
23185 /* %F displays the frame name. */
23186 if (!NILP (f
->title
))
23187 return SSDATA (f
->title
);
23188 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23189 return SSDATA (f
->name
);
23193 obj
= BVAR (b
, filename
);
23198 ptrdiff_t size
= ZV
- BEGV
;
23199 pint2str (decode_mode_spec_buf
, width
, size
);
23200 return decode_mode_spec_buf
;
23205 ptrdiff_t size
= ZV
- BEGV
;
23206 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23207 return decode_mode_spec_buf
;
23212 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23213 ptrdiff_t topline
, nlines
, height
;
23216 /* %c and %l are ignored in `frame-title-format'. */
23217 if (mode_line_target
== MODE_LINE_TITLE
)
23220 startpos
= marker_position (w
->start
);
23221 startpos_byte
= marker_byte_position (w
->start
);
23222 height
= WINDOW_TOTAL_LINES (w
);
23224 /* If we decided that this buffer isn't suitable for line numbers,
23225 don't forget that too fast. */
23226 if (w
->base_line_pos
== -1)
23229 /* If the buffer is very big, don't waste time. */
23230 if (INTEGERP (Vline_number_display_limit
)
23231 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23233 w
->base_line_pos
= 0;
23234 w
->base_line_number
= 0;
23238 if (w
->base_line_number
> 0
23239 && w
->base_line_pos
> 0
23240 && w
->base_line_pos
<= startpos
)
23242 line
= w
->base_line_number
;
23243 linepos
= w
->base_line_pos
;
23244 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23249 linepos
= BUF_BEGV (b
);
23250 linepos_byte
= BUF_BEGV_BYTE (b
);
23253 /* Count lines from base line to window start position. */
23254 nlines
= display_count_lines (linepos_byte
,
23258 topline
= nlines
+ line
;
23260 /* Determine a new base line, if the old one is too close
23261 or too far away, or if we did not have one.
23262 "Too close" means it's plausible a scroll-down would
23263 go back past it. */
23264 if (startpos
== BUF_BEGV (b
))
23266 w
->base_line_number
= topline
;
23267 w
->base_line_pos
= BUF_BEGV (b
);
23269 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23270 || linepos
== BUF_BEGV (b
))
23272 ptrdiff_t limit
= BUF_BEGV (b
);
23273 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23274 ptrdiff_t position
;
23275 ptrdiff_t distance
=
23276 (height
* 2 + 30) * line_number_display_limit_width
;
23278 if (startpos
- distance
> limit
)
23280 limit
= startpos
- distance
;
23281 limit_byte
= CHAR_TO_BYTE (limit
);
23284 nlines
= display_count_lines (startpos_byte
,
23286 - (height
* 2 + 30),
23288 /* If we couldn't find the lines we wanted within
23289 line_number_display_limit_width chars per line,
23290 give up on line numbers for this window. */
23291 if (position
== limit_byte
&& limit
== startpos
- distance
)
23293 w
->base_line_pos
= -1;
23294 w
->base_line_number
= 0;
23298 w
->base_line_number
= topline
- nlines
;
23299 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23302 /* Now count lines from the start pos to point. */
23303 nlines
= display_count_lines (startpos_byte
,
23304 PT_BYTE
, PT
, &junk
);
23306 /* Record that we did display the line number. */
23307 line_number_displayed
= true;
23309 /* Make the string to show. */
23310 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23311 return decode_mode_spec_buf
;
23314 char *p
= decode_mode_spec_buf
;
23315 int pad
= width
- 2;
23321 return decode_mode_spec_buf
;
23327 obj
= BVAR (b
, mode_name
);
23331 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23337 ptrdiff_t pos
= marker_position (w
->start
);
23338 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23340 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23342 if (pos
<= BUF_BEGV (b
))
23347 else if (pos
<= BUF_BEGV (b
))
23351 if (total
> 1000000)
23352 /* Do it differently for a large value, to avoid overflow. */
23353 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23355 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23356 /* We can't normally display a 3-digit number,
23357 so get us a 2-digit number that is close. */
23360 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23361 return decode_mode_spec_buf
;
23365 /* Display percentage of size above the bottom of the screen. */
23368 ptrdiff_t toppos
= marker_position (w
->start
);
23369 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23370 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23372 if (botpos
>= BUF_ZV (b
))
23374 if (toppos
<= BUF_BEGV (b
))
23381 if (total
> 1000000)
23382 /* Do it differently for a large value, to avoid overflow. */
23383 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23385 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23386 /* We can't normally display a 3-digit number,
23387 so get us a 2-digit number that is close. */
23390 if (toppos
<= BUF_BEGV (b
))
23391 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23393 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23394 return decode_mode_spec_buf
;
23399 /* status of process */
23400 obj
= Fget_buffer_process (Fcurrent_buffer ());
23402 return "no process";
23404 obj
= Fsymbol_name (Fprocess_status (obj
));
23410 ptrdiff_t count
= inhibit_garbage_collection ();
23411 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23412 Lisp_Object val
= Qnil
;
23414 if (STRINGP (curdir
))
23415 val
= call1 (intern ("file-remote-p"), curdir
);
23417 unbind_to (count
, Qnil
);
23426 /* coding-system (not including end-of-line format) */
23428 /* coding-system (including end-of-line type) */
23430 bool eol_flag
= (c
== 'Z');
23431 char *p
= decode_mode_spec_buf
;
23433 if (! FRAME_WINDOW_P (f
))
23435 /* No need to mention EOL here--the terminal never needs
23436 to do EOL conversion. */
23437 p
= decode_mode_spec_coding (CODING_ID_NAME
23438 (FRAME_KEYBOARD_CODING (f
)->id
),
23440 p
= decode_mode_spec_coding (CODING_ID_NAME
23441 (FRAME_TERMINAL_CODING (f
)->id
),
23444 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23447 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23448 #ifdef subprocesses
23449 obj
= Fget_buffer_process (Fcurrent_buffer ());
23450 if (PROCESSP (obj
))
23452 p
= decode_mode_spec_coding
23453 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23454 p
= decode_mode_spec_coding
23455 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23457 #endif /* subprocesses */
23460 return decode_mode_spec_buf
;
23467 return SSDATA (obj
);
23474 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23475 means count lines back from START_BYTE. But don't go beyond
23476 LIMIT_BYTE. Return the number of lines thus found (always
23479 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23480 either the position COUNT lines after/before START_BYTE, if we
23481 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23485 display_count_lines (ptrdiff_t start_byte
,
23486 ptrdiff_t limit_byte
, ptrdiff_t count
,
23487 ptrdiff_t *byte_pos_ptr
)
23489 register unsigned char *cursor
;
23490 unsigned char *base
;
23492 register ptrdiff_t ceiling
;
23493 register unsigned char *ceiling_addr
;
23494 ptrdiff_t orig_count
= count
;
23496 /* If we are not in selective display mode,
23497 check only for newlines. */
23498 bool selective_display
23499 = (!NILP (BVAR (current_buffer
, selective_display
))
23500 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23504 while (start_byte
< limit_byte
)
23506 ceiling
= BUFFER_CEILING_OF (start_byte
);
23507 ceiling
= min (limit_byte
- 1, ceiling
);
23508 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23509 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23513 if (selective_display
)
23515 while (*cursor
!= '\n' && *cursor
!= 015
23516 && ++cursor
!= ceiling_addr
)
23518 if (cursor
== ceiling_addr
)
23523 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23532 start_byte
+= cursor
- base
;
23533 *byte_pos_ptr
= start_byte
;
23537 while (cursor
< ceiling_addr
);
23539 start_byte
+= ceiling_addr
- base
;
23544 while (start_byte
> limit_byte
)
23546 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23547 ceiling
= max (limit_byte
, ceiling
);
23548 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23549 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23552 if (selective_display
)
23554 while (--cursor
>= ceiling_addr
23555 && *cursor
!= '\n' && *cursor
!= 015)
23557 if (cursor
< ceiling_addr
)
23562 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23569 start_byte
+= cursor
- base
+ 1;
23570 *byte_pos_ptr
= start_byte
;
23571 /* When scanning backwards, we should
23572 not count the newline posterior to which we stop. */
23573 return - orig_count
- 1;
23576 start_byte
+= ceiling_addr
- base
;
23580 *byte_pos_ptr
= limit_byte
;
23583 return - orig_count
+ count
;
23584 return orig_count
- count
;
23590 /***********************************************************************
23592 ***********************************************************************/
23594 /* Display a NUL-terminated string, starting with index START.
23596 If STRING is non-null, display that C string. Otherwise, the Lisp
23597 string LISP_STRING is displayed. There's a case that STRING is
23598 non-null and LISP_STRING is not nil. It means STRING is a string
23599 data of LISP_STRING. In that case, we display LISP_STRING while
23600 ignoring its text properties.
23602 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23603 FACE_STRING. Display STRING or LISP_STRING with the face at
23604 FACE_STRING_POS in FACE_STRING:
23606 Display the string in the environment given by IT, but use the
23607 standard display table, temporarily.
23609 FIELD_WIDTH is the minimum number of output glyphs to produce.
23610 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23611 with spaces. If STRING has more characters, more than FIELD_WIDTH
23612 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23614 PRECISION is the maximum number of characters to output from
23615 STRING. PRECISION < 0 means don't truncate the string.
23617 This is roughly equivalent to printf format specifiers:
23619 FIELD_WIDTH PRECISION PRINTF
23620 ----------------------------------------
23626 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23627 display them, and < 0 means obey the current buffer's value of
23628 enable_multibyte_characters.
23630 Value is the number of columns displayed. */
23633 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23634 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23635 int field_width
, int precision
, int max_x
, int multibyte
)
23637 int hpos_at_start
= it
->hpos
;
23638 int saved_face_id
= it
->face_id
;
23639 struct glyph_row
*row
= it
->glyph_row
;
23640 ptrdiff_t it_charpos
;
23642 /* Initialize the iterator IT for iteration over STRING beginning
23643 with index START. */
23644 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23645 precision
, field_width
, multibyte
);
23646 if (string
&& STRINGP (lisp_string
))
23647 /* LISP_STRING is the one returned by decode_mode_spec. We should
23648 ignore its text properties. */
23649 it
->stop_charpos
= it
->end_charpos
;
23651 /* If displaying STRING, set up the face of the iterator from
23652 FACE_STRING, if that's given. */
23653 if (STRINGP (face_string
))
23659 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23660 0, &endptr
, it
->base_face_id
, false);
23661 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23662 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23665 /* Set max_x to the maximum allowed X position. Don't let it go
23666 beyond the right edge of the window. */
23668 max_x
= it
->last_visible_x
;
23670 max_x
= min (max_x
, it
->last_visible_x
);
23672 /* Skip over display elements that are not visible. because IT->w is
23674 if (it
->current_x
< it
->first_visible_x
)
23675 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23676 MOVE_TO_POS
| MOVE_TO_X
);
23678 row
->ascent
= it
->max_ascent
;
23679 row
->height
= it
->max_ascent
+ it
->max_descent
;
23680 row
->phys_ascent
= it
->max_phys_ascent
;
23681 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23682 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23684 if (STRINGP (it
->string
))
23685 it_charpos
= IT_STRING_CHARPOS (*it
);
23687 it_charpos
= IT_CHARPOS (*it
);
23689 /* This condition is for the case that we are called with current_x
23690 past last_visible_x. */
23691 while (it
->current_x
< max_x
)
23693 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23695 /* Get the next display element. */
23696 if (!get_next_display_element (it
))
23699 /* Produce glyphs. */
23700 x_before
= it
->current_x
;
23701 n_glyphs_before
= row
->used
[TEXT_AREA
];
23702 PRODUCE_GLYPHS (it
);
23704 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23707 while (i
< nglyphs
)
23709 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23711 if (it
->line_wrap
!= TRUNCATE
23712 && x
+ glyph
->pixel_width
> max_x
)
23714 /* End of continued line or max_x reached. */
23715 if (CHAR_GLYPH_PADDING_P (*glyph
))
23717 /* A wide character is unbreakable. */
23718 if (row
->reversed_p
)
23719 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23720 - n_glyphs_before
);
23721 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23722 it
->current_x
= x_before
;
23726 if (row
->reversed_p
)
23727 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23728 - (n_glyphs_before
+ i
));
23729 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23734 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23736 /* Glyph is at least partially visible. */
23738 if (x
< it
->first_visible_x
)
23739 row
->x
= x
- it
->first_visible_x
;
23743 /* Glyph is off the left margin of the display area.
23744 Should not happen. */
23748 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23749 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23750 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23751 row
->phys_height
= max (row
->phys_height
,
23752 it
->max_phys_ascent
+ it
->max_phys_descent
);
23753 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23754 it
->max_extra_line_spacing
);
23755 x
+= glyph
->pixel_width
;
23759 /* Stop if max_x reached. */
23763 /* Stop at line ends. */
23764 if (ITERATOR_AT_END_OF_LINE_P (it
))
23766 it
->continuation_lines_width
= 0;
23770 set_iterator_to_next (it
, true);
23771 if (STRINGP (it
->string
))
23772 it_charpos
= IT_STRING_CHARPOS (*it
);
23774 it_charpos
= IT_CHARPOS (*it
);
23776 /* Stop if truncating at the right edge. */
23777 if (it
->line_wrap
== TRUNCATE
23778 && it
->current_x
>= it
->last_visible_x
)
23780 /* Add truncation mark, but don't do it if the line is
23781 truncated at a padding space. */
23782 if (it_charpos
< it
->string_nchars
)
23784 if (!FRAME_WINDOW_P (it
->f
))
23788 if (it
->current_x
> it
->last_visible_x
)
23790 if (!row
->reversed_p
)
23792 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23793 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23798 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23799 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23801 unproduce_glyphs (it
, ii
+ 1);
23802 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23804 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23806 row
->used
[TEXT_AREA
] = ii
;
23807 produce_special_glyphs (it
, IT_TRUNCATION
);
23810 produce_special_glyphs (it
, IT_TRUNCATION
);
23812 row
->truncated_on_right_p
= true;
23818 /* Maybe insert a truncation at the left. */
23819 if (it
->first_visible_x
23822 if (!FRAME_WINDOW_P (it
->f
)
23823 || (row
->reversed_p
23824 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23825 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23826 insert_left_trunc_glyphs (it
);
23827 row
->truncated_on_left_p
= true;
23830 it
->face_id
= saved_face_id
;
23832 /* Value is number of columns displayed. */
23833 return it
->hpos
- hpos_at_start
;
23838 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23839 appears as an element of LIST or as the car of an element of LIST.
23840 If PROPVAL is a list, compare each element against LIST in that
23841 way, and return 1/2 if any element of PROPVAL is found in LIST.
23842 Otherwise return 0. This function cannot quit.
23843 The return value is 2 if the text is invisible but with an ellipsis
23844 and 1 if it's invisible and without an ellipsis. */
23847 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
23849 Lisp_Object tail
, proptail
;
23851 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23853 register Lisp_Object tem
;
23855 if (EQ (propval
, tem
))
23857 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23858 return NILP (XCDR (tem
)) ? 1 : 2;
23861 if (CONSP (propval
))
23863 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23865 Lisp_Object propelt
;
23866 propelt
= XCAR (proptail
);
23867 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23869 register Lisp_Object tem
;
23871 if (EQ (propelt
, tem
))
23873 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23874 return NILP (XCDR (tem
)) ? 1 : 2;
23882 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23883 doc
: /* Non-nil if the property makes the text invisible.
23884 POS-OR-PROP can be a marker or number, in which case it is taken to be
23885 a position in the current buffer and the value of the `invisible' property
23886 is checked; or it can be some other value, which is then presumed to be the
23887 value of the `invisible' property of the text of interest.
23888 The non-nil value returned can be t for truly invisible text or something
23889 else if the text is replaced by an ellipsis. */)
23890 (Lisp_Object pos_or_prop
)
23893 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23894 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23896 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23897 return (invis
== 0 ? Qnil
23899 : make_number (invis
));
23902 /* Calculate a width or height in pixels from a specification using
23903 the following elements:
23906 NUM - a (fractional) multiple of the default font width/height
23907 (NUM) - specifies exactly NUM pixels
23908 UNIT - a fixed number of pixels, see below.
23909 ELEMENT - size of a display element in pixels, see below.
23910 (NUM . SPEC) - equals NUM * SPEC
23911 (+ SPEC SPEC ...) - add pixel values
23912 (- SPEC SPEC ...) - subtract pixel values
23913 (- SPEC) - negate pixel value
23916 INT or FLOAT - a number constant
23917 SYMBOL - use symbol's (buffer local) variable binding.
23920 in - pixels per inch *)
23921 mm - pixels per 1/1000 meter *)
23922 cm - pixels per 1/100 meter *)
23923 width - width of current font in pixels.
23924 height - height of current font in pixels.
23926 *) using the ratio(s) defined in display-pixels-per-inch.
23930 left-fringe - left fringe width in pixels
23931 right-fringe - right fringe width in pixels
23933 left-margin - left margin width in pixels
23934 right-margin - right margin width in pixels
23936 scroll-bar - scroll-bar area width in pixels
23940 Pixels corresponding to 5 inches:
23943 Total width of non-text areas on left side of window (if scroll-bar is on left):
23944 '(space :width (+ left-fringe left-margin scroll-bar))
23946 Align to first text column (in header line):
23947 '(space :align-to 0)
23949 Align to middle of text area minus half the width of variable `my-image'
23950 containing a loaded image:
23951 '(space :align-to (0.5 . (- text my-image)))
23953 Width of left margin minus width of 1 character in the default font:
23954 '(space :width (- left-margin 1))
23956 Width of left margin minus width of 2 characters in the current font:
23957 '(space :width (- left-margin (2 . width)))
23959 Center 1 character over left-margin (in header line):
23960 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23962 Different ways to express width of left fringe plus left margin minus one pixel:
23963 '(space :width (- (+ left-fringe left-margin) (1)))
23964 '(space :width (+ left-fringe left-margin (- (1))))
23965 '(space :width (+ left-fringe left-margin (-1)))
23970 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23971 struct font
*font
, bool width_p
, int *align_to
)
23975 # define OK_PIXELS(val) (*res = (val), true)
23976 # define OK_ALIGN_TO(val) (*align_to = (val), true)
23979 return OK_PIXELS (0);
23981 eassert (FRAME_LIVE_P (it
->f
));
23983 if (SYMBOLP (prop
))
23985 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23987 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23989 if (unit
[0] == 'i' && unit
[1] == 'n')
23991 else if (unit
[0] == 'm' && unit
[1] == 'm')
23993 else if (unit
[0] == 'c' && unit
[1] == 'm')
23999 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24000 : FRAME_RES_Y (it
->f
));
24003 return OK_PIXELS (ppi
/ pixels
);
24008 #ifdef HAVE_WINDOW_SYSTEM
24009 if (EQ (prop
, Qheight
))
24010 return OK_PIXELS (font
24011 ? normal_char_height (font
, -1)
24012 : FRAME_LINE_HEIGHT (it
->f
));
24013 if (EQ (prop
, Qwidth
))
24014 return OK_PIXELS (font
24015 ? FONT_WIDTH (font
)
24016 : FRAME_COLUMN_WIDTH (it
->f
));
24018 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24019 return OK_PIXELS (1);
24022 if (EQ (prop
, Qtext
))
24023 return OK_PIXELS (width_p
24024 ? window_box_width (it
->w
, TEXT_AREA
)
24025 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24027 if (align_to
&& *align_to
< 0)
24030 if (EQ (prop
, Qleft
))
24031 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24032 if (EQ (prop
, Qright
))
24033 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24034 if (EQ (prop
, Qcenter
))
24035 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24036 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24037 if (EQ (prop
, Qleft_fringe
))
24038 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24039 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24040 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24041 if (EQ (prop
, Qright_fringe
))
24042 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24043 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24044 : window_box_right_offset (it
->w
, TEXT_AREA
));
24045 if (EQ (prop
, Qleft_margin
))
24046 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24047 if (EQ (prop
, Qright_margin
))
24048 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24049 if (EQ (prop
, Qscroll_bar
))
24050 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24052 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24053 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24054 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24059 if (EQ (prop
, Qleft_fringe
))
24060 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24061 if (EQ (prop
, Qright_fringe
))
24062 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24063 if (EQ (prop
, Qleft_margin
))
24064 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24065 if (EQ (prop
, Qright_margin
))
24066 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24067 if (EQ (prop
, Qscroll_bar
))
24068 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24071 prop
= buffer_local_value (prop
, it
->w
->contents
);
24072 if (EQ (prop
, Qunbound
))
24076 if (NUMBERP (prop
))
24078 int base_unit
= (width_p
24079 ? FRAME_COLUMN_WIDTH (it
->f
)
24080 : FRAME_LINE_HEIGHT (it
->f
));
24081 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24086 Lisp_Object car
= XCAR (prop
);
24087 Lisp_Object cdr
= XCDR (prop
);
24091 #ifdef HAVE_WINDOW_SYSTEM
24092 if (FRAME_WINDOW_P (it
->f
)
24093 && valid_image_p (prop
))
24095 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24096 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24098 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24101 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24107 while (CONSP (cdr
))
24109 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24110 font
, width_p
, align_to
))
24113 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24118 if (EQ (car
, Qminus
))
24120 return OK_PIXELS (pixels
);
24123 car
= buffer_local_value (car
, it
->w
->contents
);
24124 if (EQ (car
, Qunbound
))
24131 pixels
= XFLOATINT (car
);
24133 return OK_PIXELS (pixels
);
24134 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24135 font
, width_p
, align_to
))
24136 return OK_PIXELS (pixels
* fact
);
24147 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24149 #ifdef HAVE_WINDOW_SYSTEM
24150 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24158 /***********************************************************************
24160 ***********************************************************************/
24162 #ifdef HAVE_WINDOW_SYSTEM
24167 dump_glyph_string (struct glyph_string
*s
)
24169 fprintf (stderr
, "glyph string\n");
24170 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24171 s
->x
, s
->y
, s
->width
, s
->height
);
24172 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24173 fprintf (stderr
, " hl = %d\n", s
->hl
);
24174 fprintf (stderr
, " left overhang = %d, right = %d\n",
24175 s
->left_overhang
, s
->right_overhang
);
24176 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24177 fprintf (stderr
, " extends to end of line = %d\n",
24178 s
->extends_to_end_of_line_p
);
24179 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24180 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24183 #endif /* GLYPH_DEBUG */
24185 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24186 of XChar2b structures for S; it can't be allocated in
24187 init_glyph_string because it must be allocated via `alloca'. W
24188 is the window on which S is drawn. ROW and AREA are the glyph row
24189 and area within the row from which S is constructed. START is the
24190 index of the first glyph structure covered by S. HL is a
24191 face-override for drawing S. */
24194 #define OPTIONAL_HDC(hdc) HDC hdc,
24195 #define DECLARE_HDC(hdc) HDC hdc;
24196 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24197 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24200 #ifndef OPTIONAL_HDC
24201 #define OPTIONAL_HDC(hdc)
24202 #define DECLARE_HDC(hdc)
24203 #define ALLOCATE_HDC(hdc, f)
24204 #define RELEASE_HDC(hdc, f)
24208 init_glyph_string (struct glyph_string
*s
,
24210 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24211 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24213 memset (s
, 0, sizeof *s
);
24215 s
->f
= XFRAME (w
->frame
);
24219 s
->display
= FRAME_X_DISPLAY (s
->f
);
24220 s
->window
= FRAME_X_WINDOW (s
->f
);
24221 s
->char2b
= char2b
;
24225 s
->first_glyph
= row
->glyphs
[area
] + start
;
24226 s
->height
= row
->height
;
24227 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24228 s
->ybase
= s
->y
+ row
->ascent
;
24232 /* Append the list of glyph strings with head H and tail T to the list
24233 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24236 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24237 struct glyph_string
*h
, struct glyph_string
*t
)
24251 /* Prepend the list of glyph strings with head H and tail T to the
24252 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24256 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24257 struct glyph_string
*h
, struct glyph_string
*t
)
24271 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24272 Set *HEAD and *TAIL to the resulting list. */
24275 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24276 struct glyph_string
*s
)
24278 s
->next
= s
->prev
= NULL
;
24279 append_glyph_string_lists (head
, tail
, s
, s
);
24283 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24284 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24285 make sure that X resources for the face returned are allocated.
24286 Value is a pointer to a realized face that is ready for display if
24289 static struct face
*
24290 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24291 XChar2b
*char2b
, bool display_p
)
24293 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24298 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24300 if (code
== FONT_INVALID_CODE
)
24303 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24305 /* Make sure X resources of the face are allocated. */
24306 #ifdef HAVE_X_WINDOWS
24310 eassert (face
!= NULL
);
24311 prepare_face_for_display (f
, face
);
24318 /* Get face and two-byte form of character glyph GLYPH on frame F.
24319 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24320 a pointer to a realized face that is ready for display. */
24322 static struct face
*
24323 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24329 eassert (glyph
->type
== CHAR_GLYPH
);
24330 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24332 /* Make sure X resources of the face are allocated. */
24333 eassert (face
!= NULL
);
24334 prepare_face_for_display (f
, face
);
24338 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24339 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24341 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24343 if (code
== FONT_INVALID_CODE
)
24347 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24352 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24353 Return true iff FONT has a glyph for C. */
24356 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24360 if (CHAR_BYTE8_P (c
))
24361 code
= CHAR_TO_BYTE8 (c
);
24363 code
= font
->driver
->encode_char (font
, c
);
24365 if (code
== FONT_INVALID_CODE
)
24367 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24372 /* Fill glyph string S with composition components specified by S->cmp.
24374 BASE_FACE is the base face of the composition.
24375 S->cmp_from is the index of the first component for S.
24377 OVERLAPS non-zero means S should draw the foreground only, and use
24378 its physical height for clipping. See also draw_glyphs.
24380 Value is the index of a component not in S. */
24383 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24387 /* For all glyphs of this composition, starting at the offset
24388 S->cmp_from, until we reach the end of the definition or encounter a
24389 glyph that requires the different face, add it to S. */
24394 s
->for_overlaps
= overlaps
;
24397 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24399 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24401 /* TAB in a composition means display glyphs with padding space
24402 on the left or right. */
24405 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24408 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24409 s
->char2b
+ i
, true);
24415 s
->font
= s
->face
->font
;
24417 else if (s
->face
!= face
)
24425 if (s
->face
== NULL
)
24427 s
->face
= base_face
->ascii_face
;
24428 s
->font
= s
->face
->font
;
24431 /* All glyph strings for the same composition has the same width,
24432 i.e. the width set for the first component of the composition. */
24433 s
->width
= s
->first_glyph
->pixel_width
;
24435 /* If the specified font could not be loaded, use the frame's
24436 default font, but record the fact that we couldn't load it in
24437 the glyph string so that we can draw rectangles for the
24438 characters of the glyph string. */
24439 if (s
->font
== NULL
)
24441 s
->font_not_found_p
= true;
24442 s
->font
= FRAME_FONT (s
->f
);
24445 /* Adjust base line for subscript/superscript text. */
24446 s
->ybase
+= s
->first_glyph
->voffset
;
24452 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24453 int start
, int end
, int overlaps
)
24455 struct glyph
*glyph
, *last
;
24456 Lisp_Object lgstring
;
24459 s
->for_overlaps
= overlaps
;
24460 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24461 last
= s
->row
->glyphs
[s
->area
] + end
;
24462 s
->cmp_id
= glyph
->u
.cmp
.id
;
24463 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24464 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24465 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24466 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24467 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24469 while (glyph
< last
24470 && glyph
->u
.cmp
.automatic
24471 && glyph
->u
.cmp
.id
== s
->cmp_id
24472 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24473 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24475 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24477 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24478 unsigned code
= LGLYPH_CODE (lglyph
);
24480 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24482 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24483 return glyph
- s
->row
->glyphs
[s
->area
];
24487 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24488 See the comment of fill_glyph_string for arguments.
24489 Value is the index of the first glyph not in S. */
24493 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24494 int start
, int end
, int overlaps
)
24496 struct glyph
*glyph
, *last
;
24499 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24500 s
->for_overlaps
= overlaps
;
24501 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24502 last
= s
->row
->glyphs
[s
->area
] + end
;
24503 voffset
= glyph
->voffset
;
24504 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24505 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24507 s
->width
= glyph
->pixel_width
;
24509 while (glyph
< last
24510 && glyph
->type
== GLYPHLESS_GLYPH
24511 && glyph
->voffset
== voffset
24512 && glyph
->face_id
== face_id
)
24515 s
->width
+= glyph
->pixel_width
;
24518 s
->ybase
+= voffset
;
24519 return glyph
- s
->row
->glyphs
[s
->area
];
24523 /* Fill glyph string S from a sequence of character glyphs.
24525 FACE_ID is the face id of the string. START is the index of the
24526 first glyph to consider, END is the index of the last + 1.
24527 OVERLAPS non-zero means S should draw the foreground only, and use
24528 its physical height for clipping. See also draw_glyphs.
24530 Value is the index of the first glyph not in S. */
24533 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24534 int start
, int end
, int overlaps
)
24536 struct glyph
*glyph
, *last
;
24538 bool glyph_not_available_p
;
24540 eassert (s
->f
== XFRAME (s
->w
->frame
));
24541 eassert (s
->nchars
== 0);
24542 eassert (start
>= 0 && end
> start
);
24544 s
->for_overlaps
= overlaps
;
24545 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24546 last
= s
->row
->glyphs
[s
->area
] + end
;
24547 voffset
= glyph
->voffset
;
24548 s
->padding_p
= glyph
->padding_p
;
24549 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24551 while (glyph
< last
24552 && glyph
->type
== CHAR_GLYPH
24553 && glyph
->voffset
== voffset
24554 /* Same face id implies same font, nowadays. */
24555 && glyph
->face_id
== face_id
24556 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24558 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24559 s
->char2b
+ s
->nchars
);
24561 eassert (s
->nchars
<= end
- start
);
24562 s
->width
+= glyph
->pixel_width
;
24563 if (glyph
++->padding_p
!= s
->padding_p
)
24567 s
->font
= s
->face
->font
;
24569 /* If the specified font could not be loaded, use the frame's font,
24570 but record the fact that we couldn't load it in
24571 S->font_not_found_p so that we can draw rectangles for the
24572 characters of the glyph string. */
24573 if (s
->font
== NULL
|| glyph_not_available_p
)
24575 s
->font_not_found_p
= true;
24576 s
->font
= FRAME_FONT (s
->f
);
24579 /* Adjust base line for subscript/superscript text. */
24580 s
->ybase
+= voffset
;
24582 eassert (s
->face
&& s
->face
->gc
);
24583 return glyph
- s
->row
->glyphs
[s
->area
];
24587 /* Fill glyph string S from image glyph S->first_glyph. */
24590 fill_image_glyph_string (struct glyph_string
*s
)
24592 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24593 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24595 s
->slice
= s
->first_glyph
->slice
.img
;
24596 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24597 s
->font
= s
->face
->font
;
24598 s
->width
= s
->first_glyph
->pixel_width
;
24600 /* Adjust base line for subscript/superscript text. */
24601 s
->ybase
+= s
->first_glyph
->voffset
;
24605 /* Fill glyph string S from a sequence of stretch glyphs.
24607 START is the index of the first glyph to consider,
24608 END is the index of the last + 1.
24610 Value is the index of the first glyph not in S. */
24613 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24615 struct glyph
*glyph
, *last
;
24616 int voffset
, face_id
;
24618 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24620 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24621 last
= s
->row
->glyphs
[s
->area
] + end
;
24622 face_id
= glyph
->face_id
;
24623 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24624 s
->font
= s
->face
->font
;
24625 s
->width
= glyph
->pixel_width
;
24627 voffset
= glyph
->voffset
;
24631 && glyph
->type
== STRETCH_GLYPH
24632 && glyph
->voffset
== voffset
24633 && glyph
->face_id
== face_id
);
24635 s
->width
+= glyph
->pixel_width
;
24637 /* Adjust base line for subscript/superscript text. */
24638 s
->ybase
+= voffset
;
24640 /* The case that face->gc == 0 is handled when drawing the glyph
24641 string by calling prepare_face_for_display. */
24643 return glyph
- s
->row
->glyphs
[s
->area
];
24646 static struct font_metrics
*
24647 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24649 static struct font_metrics metrics
;
24654 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24655 if (code
== FONT_INVALID_CODE
)
24657 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24661 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24662 for FONT. Values are taken from font-global ones, except for fonts
24663 that claim preposterously large values, but whose glyphs actually
24664 have reasonable dimensions. C is the character to use for metrics
24665 if the font-global values are too large; if C is negative, the
24666 function selects a default character. */
24668 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24670 *ascent
= FONT_BASE (font
);
24671 *descent
= FONT_DESCENT (font
);
24673 if (FONT_TOO_HIGH (font
))
24677 /* Get metrics of C, defaulting to a reasonably sized ASCII
24679 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24681 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24683 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24685 /* We add 1 pixel to character dimensions as heuristics
24686 that produces nicer display, e.g. when the face has
24687 the box attribute. */
24688 *ascent
= pcm
->ascent
+ 1;
24689 *descent
= pcm
->descent
+ 1;
24695 /* A subroutine that computes a reasonable "normal character height"
24696 for fonts that claim preposterously large vertical dimensions, but
24697 whose glyphs are actually reasonably sized. C is the character
24698 whose metrics to use for those fonts, or -1 for default
24701 normal_char_height (struct font
*font
, int c
)
24703 int ascent
, descent
;
24705 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24707 return ascent
+ descent
;
24711 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24712 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24713 assumed to be zero. */
24716 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24718 *left
= *right
= 0;
24720 if (glyph
->type
== CHAR_GLYPH
)
24723 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24726 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24729 if (pcm
->rbearing
> pcm
->width
)
24730 *right
= pcm
->rbearing
- pcm
->width
;
24731 if (pcm
->lbearing
< 0)
24732 *left
= -pcm
->lbearing
;
24736 else if (glyph
->type
== COMPOSITE_GLYPH
)
24738 if (! glyph
->u
.cmp
.automatic
)
24740 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24742 if (cmp
->rbearing
> cmp
->pixel_width
)
24743 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24744 if (cmp
->lbearing
< 0)
24745 *left
= - cmp
->lbearing
;
24749 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24750 struct font_metrics metrics
;
24752 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24753 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24754 if (metrics
.rbearing
> metrics
.width
)
24755 *right
= metrics
.rbearing
- metrics
.width
;
24756 if (metrics
.lbearing
< 0)
24757 *left
= - metrics
.lbearing
;
24763 /* Return the index of the first glyph preceding glyph string S that
24764 is overwritten by S because of S's left overhang. Value is -1
24765 if no glyphs are overwritten. */
24768 left_overwritten (struct glyph_string
*s
)
24772 if (s
->left_overhang
)
24775 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24776 int first
= s
->first_glyph
- glyphs
;
24778 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24779 x
-= glyphs
[i
].pixel_width
;
24790 /* Return the index of the first glyph preceding glyph string S that
24791 is overwriting S because of its right overhang. Value is -1 if no
24792 glyph in front of S overwrites S. */
24795 left_overwriting (struct glyph_string
*s
)
24798 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24799 int first
= s
->first_glyph
- glyphs
;
24803 for (i
= first
- 1; i
>= 0; --i
)
24806 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24809 x
-= glyphs
[i
].pixel_width
;
24816 /* Return the index of the last glyph following glyph string S that is
24817 overwritten by S because of S's right overhang. Value is -1 if
24818 no such glyph is found. */
24821 right_overwritten (struct glyph_string
*s
)
24825 if (s
->right_overhang
)
24828 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24829 int first
= (s
->first_glyph
- glyphs
24830 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24831 int end
= s
->row
->used
[s
->area
];
24833 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24834 x
+= glyphs
[i
].pixel_width
;
24843 /* Return the index of the last glyph following glyph string S that
24844 overwrites S because of its left overhang. Value is negative
24845 if no such glyph is found. */
24848 right_overwriting (struct glyph_string
*s
)
24851 int end
= s
->row
->used
[s
->area
];
24852 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24853 int first
= (s
->first_glyph
- glyphs
24854 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24858 for (i
= first
; i
< end
; ++i
)
24861 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24864 x
+= glyphs
[i
].pixel_width
;
24871 /* Set background width of glyph string S. START is the index of the
24872 first glyph following S. LAST_X is the right-most x-position + 1
24873 in the drawing area. */
24876 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24878 /* If the face of this glyph string has to be drawn to the end of
24879 the drawing area, set S->extends_to_end_of_line_p. */
24881 if (start
== s
->row
->used
[s
->area
]
24882 && ((s
->row
->fill_line_p
24883 && (s
->hl
== DRAW_NORMAL_TEXT
24884 || s
->hl
== DRAW_IMAGE_RAISED
24885 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24886 || s
->hl
== DRAW_MOUSE_FACE
))
24887 s
->extends_to_end_of_line_p
= true;
24889 /* If S extends its face to the end of the line, set its
24890 background_width to the distance to the right edge of the drawing
24892 if (s
->extends_to_end_of_line_p
)
24893 s
->background_width
= last_x
- s
->x
+ 1;
24895 s
->background_width
= s
->width
;
24899 /* Compute overhangs and x-positions for glyph string S and its
24900 predecessors, or successors. X is the starting x-position for S.
24901 BACKWARD_P means process predecessors. */
24904 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
24910 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24911 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24921 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24922 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24932 /* The following macros are only called from draw_glyphs below.
24933 They reference the following parameters of that function directly:
24934 `w', `row', `area', and `overlap_p'
24935 as well as the following local variables:
24936 `s', `f', and `hdc' (in W32) */
24939 /* On W32, silently add local `hdc' variable to argument list of
24940 init_glyph_string. */
24941 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24942 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24944 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24945 init_glyph_string (s, char2b, w, row, area, start, hl)
24948 /* Add a glyph string for a stretch glyph to the list of strings
24949 between HEAD and TAIL. START is the index of the stretch glyph in
24950 row area AREA of glyph row ROW. END is the index of the last glyph
24951 in that glyph row area. X is the current output position assigned
24952 to the new glyph string constructed. HL overrides that face of the
24953 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24954 is the right-most x-position of the drawing area. */
24956 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24957 and below -- keep them on one line. */
24958 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24961 s = alloca (sizeof *s); \
24962 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24963 START = fill_stretch_glyph_string (s, START, END); \
24964 append_glyph_string (&HEAD, &TAIL, s); \
24970 /* Add a glyph string for an image glyph to the list of strings
24971 between HEAD and TAIL. START is the index of the image glyph in
24972 row area AREA of glyph row ROW. END is the index of the last glyph
24973 in that glyph row area. X is the current output position assigned
24974 to the new glyph string constructed. HL overrides that face of the
24975 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24976 is the right-most x-position of the drawing area. */
24978 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24981 s = alloca (sizeof *s); \
24982 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24983 fill_image_glyph_string (s); \
24984 append_glyph_string (&HEAD, &TAIL, s); \
24991 /* Add a glyph string for a sequence of character glyphs to the list
24992 of strings between HEAD and TAIL. START is the index of the first
24993 glyph in row area AREA of glyph row ROW that is part of the new
24994 glyph string. END is the index of the last glyph in that glyph row
24995 area. X is the current output position assigned to the new glyph
24996 string constructed. HL overrides that face of the glyph; e.g. it
24997 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24998 right-most x-position of the drawing area. */
25000 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25006 face_id = (row)->glyphs[area][START].face_id; \
25008 s = alloca (sizeof *s); \
25009 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25010 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25011 append_glyph_string (&HEAD, &TAIL, s); \
25013 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25018 /* Add a glyph string for a composite sequence to the list of strings
25019 between HEAD and TAIL. START is the index of the first glyph in
25020 row area AREA of glyph row ROW that is part of the new glyph
25021 string. END is the index of the last glyph in that glyph row area.
25022 X is the current output position assigned to the new glyph string
25023 constructed. HL overrides that face of the glyph; e.g. it is
25024 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25025 x-position of the drawing area. */
25027 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25029 int face_id = (row)->glyphs[area][START].face_id; \
25030 struct face *base_face = FACE_FROM_ID (f, face_id); \
25031 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25032 struct composition *cmp = composition_table[cmp_id]; \
25034 struct glyph_string *first_s = NULL; \
25037 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25039 /* Make glyph_strings for each glyph sequence that is drawable by \
25040 the same face, and append them to HEAD/TAIL. */ \
25041 for (n = 0; n < cmp->glyph_len;) \
25043 s = alloca (sizeof *s); \
25044 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25045 append_glyph_string (&(HEAD), &(TAIL), s); \
25051 n = fill_composite_glyph_string (s, base_face, overlaps); \
25059 /* Add a glyph string for a glyph-string sequence to the list of strings
25060 between HEAD and TAIL. */
25062 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25066 Lisp_Object gstring; \
25068 face_id = (row)->glyphs[area][START].face_id; \
25069 gstring = (composition_gstring_from_id \
25070 ((row)->glyphs[area][START].u.cmp.id)); \
25071 s = alloca (sizeof *s); \
25072 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25073 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25074 append_glyph_string (&(HEAD), &(TAIL), s); \
25076 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25080 /* Add a glyph string for a sequence of glyphless character's glyphs
25081 to the list of strings between HEAD and TAIL. The meanings of
25082 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25084 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25089 face_id = (row)->glyphs[area][START].face_id; \
25091 s = alloca (sizeof *s); \
25092 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25093 append_glyph_string (&HEAD, &TAIL, s); \
25095 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25101 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25102 of AREA of glyph row ROW on window W between indices START and END.
25103 HL overrides the face for drawing glyph strings, e.g. it is
25104 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25105 x-positions of the drawing area.
25107 This is an ugly monster macro construct because we must use alloca
25108 to allocate glyph strings (because draw_glyphs can be called
25109 asynchronously). */
25111 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25114 HEAD = TAIL = NULL; \
25115 while (START < END) \
25117 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25118 switch (first_glyph->type) \
25121 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25125 case COMPOSITE_GLYPH: \
25126 if (first_glyph->u.cmp.automatic) \
25127 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25130 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25134 case STRETCH_GLYPH: \
25135 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25139 case IMAGE_GLYPH: \
25140 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25144 case GLYPHLESS_GLYPH: \
25145 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25155 set_glyph_string_background_width (s, START, LAST_X); \
25162 /* Draw glyphs between START and END in AREA of ROW on window W,
25163 starting at x-position X. X is relative to AREA in W. HL is a
25164 face-override with the following meaning:
25166 DRAW_NORMAL_TEXT draw normally
25167 DRAW_CURSOR draw in cursor face
25168 DRAW_MOUSE_FACE draw in mouse face.
25169 DRAW_INVERSE_VIDEO draw in mode line face
25170 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25171 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25173 If OVERLAPS is non-zero, draw only the foreground of characters and
25174 clip to the physical height of ROW. Non-zero value also defines
25175 the overlapping part to be drawn:
25177 OVERLAPS_PRED overlap with preceding rows
25178 OVERLAPS_SUCC overlap with succeeding rows
25179 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25180 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25182 Value is the x-position reached, relative to AREA of W. */
25185 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25186 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25187 enum draw_glyphs_face hl
, int overlaps
)
25189 struct glyph_string
*head
, *tail
;
25190 struct glyph_string
*s
;
25191 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25192 int i
, j
, x_reached
, last_x
, area_left
= 0;
25193 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25196 ALLOCATE_HDC (hdc
, f
);
25198 /* Let's rather be paranoid than getting a SEGV. */
25199 end
= min (end
, row
->used
[area
]);
25200 start
= clip_to_bounds (0, start
, end
);
25202 /* Translate X to frame coordinates. Set last_x to the right
25203 end of the drawing area. */
25204 if (row
->full_width_p
)
25206 /* X is relative to the left edge of W, without scroll bars
25208 area_left
= WINDOW_LEFT_EDGE_X (w
);
25209 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25210 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25214 area_left
= window_box_left (w
, area
);
25215 last_x
= area_left
+ window_box_width (w
, area
);
25219 /* Build a doubly-linked list of glyph_string structures between
25220 head and tail from what we have to draw. Note that the macro
25221 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25222 the reason we use a separate variable `i'. */
25225 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25227 x_reached
= tail
->x
+ tail
->background_width
;
25231 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25232 the row, redraw some glyphs in front or following the glyph
25233 strings built above. */
25234 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25236 struct glyph_string
*h
, *t
;
25237 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25238 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25239 bool check_mouse_face
= false;
25242 /* If mouse highlighting is on, we may need to draw adjacent
25243 glyphs using mouse-face highlighting. */
25244 if (area
== TEXT_AREA
&& row
->mouse_face_p
25245 && hlinfo
->mouse_face_beg_row
>= 0
25246 && hlinfo
->mouse_face_end_row
>= 0)
25248 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25250 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25251 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25253 check_mouse_face
= true;
25254 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25255 ? hlinfo
->mouse_face_beg_col
: 0;
25256 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25257 ? hlinfo
->mouse_face_end_col
25258 : row
->used
[TEXT_AREA
];
25262 /* Compute overhangs for all glyph strings. */
25263 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25264 for (s
= head
; s
; s
= s
->next
)
25265 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25267 /* Prepend glyph strings for glyphs in front of the first glyph
25268 string that are overwritten because of the first glyph
25269 string's left overhang. The background of all strings
25270 prepended must be drawn because the first glyph string
25272 i
= left_overwritten (head
);
25275 enum draw_glyphs_face overlap_hl
;
25277 /* If this row contains mouse highlighting, attempt to draw
25278 the overlapped glyphs with the correct highlight. This
25279 code fails if the overlap encompasses more than one glyph
25280 and mouse-highlight spans only some of these glyphs.
25281 However, making it work perfectly involves a lot more
25282 code, and I don't know if the pathological case occurs in
25283 practice, so we'll stick to this for now. --- cyd */
25284 if (check_mouse_face
25285 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25286 overlap_hl
= DRAW_MOUSE_FACE
;
25288 overlap_hl
= DRAW_NORMAL_TEXT
;
25290 if (hl
!= overlap_hl
)
25293 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25294 overlap_hl
, dummy_x
, last_x
);
25296 compute_overhangs_and_x (t
, head
->x
, true);
25297 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25298 if (clip_head
== NULL
)
25302 /* Prepend glyph strings for glyphs in front of the first glyph
25303 string that overwrite that glyph string because of their
25304 right overhang. For these strings, only the foreground must
25305 be drawn, because it draws over the glyph string at `head'.
25306 The background must not be drawn because this would overwrite
25307 right overhangs of preceding glyphs for which no glyph
25309 i
= left_overwriting (head
);
25312 enum draw_glyphs_face overlap_hl
;
25314 if (check_mouse_face
25315 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25316 overlap_hl
= DRAW_MOUSE_FACE
;
25318 overlap_hl
= DRAW_NORMAL_TEXT
;
25320 if (hl
== overlap_hl
|| clip_head
== NULL
)
25322 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25323 overlap_hl
, dummy_x
, last_x
);
25324 for (s
= h
; s
; s
= s
->next
)
25325 s
->background_filled_p
= true;
25326 compute_overhangs_and_x (t
, head
->x
, true);
25327 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25330 /* Append glyphs strings for glyphs following the last glyph
25331 string tail that are overwritten by tail. The background of
25332 these strings has to be drawn because tail's foreground draws
25334 i
= right_overwritten (tail
);
25337 enum draw_glyphs_face overlap_hl
;
25339 if (check_mouse_face
25340 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25341 overlap_hl
= DRAW_MOUSE_FACE
;
25343 overlap_hl
= DRAW_NORMAL_TEXT
;
25345 if (hl
!= overlap_hl
)
25347 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25348 overlap_hl
, x
, last_x
);
25349 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25350 we don't have `end = i;' here. */
25351 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25352 append_glyph_string_lists (&head
, &tail
, h
, t
);
25353 if (clip_tail
== NULL
)
25357 /* Append glyph strings for glyphs following the last glyph
25358 string tail that overwrite tail. The foreground of such
25359 glyphs has to be drawn because it writes into the background
25360 of tail. The background must not be drawn because it could
25361 paint over the foreground of following glyphs. */
25362 i
= right_overwriting (tail
);
25365 enum draw_glyphs_face overlap_hl
;
25366 if (check_mouse_face
25367 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25368 overlap_hl
= DRAW_MOUSE_FACE
;
25370 overlap_hl
= DRAW_NORMAL_TEXT
;
25372 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25374 i
++; /* We must include the Ith glyph. */
25375 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25376 overlap_hl
, x
, last_x
);
25377 for (s
= h
; s
; s
= s
->next
)
25378 s
->background_filled_p
= true;
25379 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25380 append_glyph_string_lists (&head
, &tail
, h
, t
);
25382 if (clip_head
|| clip_tail
)
25383 for (s
= head
; s
; s
= s
->next
)
25385 s
->clip_head
= clip_head
;
25386 s
->clip_tail
= clip_tail
;
25390 /* Draw all strings. */
25391 for (s
= head
; s
; s
= s
->next
)
25392 FRAME_RIF (f
)->draw_glyph_string (s
);
25395 /* When focus a sole frame and move horizontally, this clears on_p
25396 causing a failure to erase prev cursor position. */
25397 if (area
== TEXT_AREA
25398 && !row
->full_width_p
25399 /* When drawing overlapping rows, only the glyph strings'
25400 foreground is drawn, which doesn't erase a cursor
25404 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25405 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25406 : (tail
? tail
->x
+ tail
->background_width
: x
));
25410 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25411 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25415 /* Value is the x-position up to which drawn, relative to AREA of W.
25416 This doesn't include parts drawn because of overhangs. */
25417 if (row
->full_width_p
)
25418 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25420 x_reached
-= area_left
;
25422 RELEASE_HDC (hdc
, f
);
25428 /* Expand row matrix if too narrow. Don't expand if area
25431 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25433 if (!it->f->fonts_changed \
25434 && (it->glyph_row->glyphs[area] \
25435 < it->glyph_row->glyphs[area + 1])) \
25437 it->w->ncols_scale_factor++; \
25438 it->f->fonts_changed = true; \
25442 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25443 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25446 append_glyph (struct it
*it
)
25448 struct glyph
*glyph
;
25449 enum glyph_row_area area
= it
->area
;
25451 eassert (it
->glyph_row
);
25452 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25454 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25455 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25457 /* If the glyph row is reversed, we need to prepend the glyph
25458 rather than append it. */
25459 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25463 /* Make room for the additional glyph. */
25464 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25466 glyph
= it
->glyph_row
->glyphs
[area
];
25468 glyph
->charpos
= CHARPOS (it
->position
);
25469 glyph
->object
= it
->object
;
25470 if (it
->pixel_width
> 0)
25472 glyph
->pixel_width
= it
->pixel_width
;
25473 glyph
->padding_p
= false;
25477 /* Assure at least 1-pixel width. Otherwise, cursor can't
25478 be displayed correctly. */
25479 glyph
->pixel_width
= 1;
25480 glyph
->padding_p
= true;
25482 glyph
->ascent
= it
->ascent
;
25483 glyph
->descent
= it
->descent
;
25484 glyph
->voffset
= it
->voffset
;
25485 glyph
->type
= CHAR_GLYPH
;
25486 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25487 glyph
->multibyte_p
= it
->multibyte_p
;
25488 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25490 /* In R2L rows, the left and the right box edges need to be
25491 drawn in reverse direction. */
25492 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25493 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25497 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25498 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25500 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25501 || it
->phys_descent
> it
->descent
);
25502 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25503 glyph
->face_id
= it
->face_id
;
25504 glyph
->u
.ch
= it
->char_to_display
;
25505 glyph
->slice
.img
= null_glyph_slice
;
25506 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25509 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25510 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25511 glyph
->bidi_type
= it
->bidi_it
.type
;
25515 glyph
->resolved_level
= 0;
25516 glyph
->bidi_type
= UNKNOWN_BT
;
25518 ++it
->glyph_row
->used
[area
];
25521 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25524 /* Store one glyph for the composition IT->cmp_it.id in
25525 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25529 append_composite_glyph (struct it
*it
)
25531 struct glyph
*glyph
;
25532 enum glyph_row_area area
= it
->area
;
25534 eassert (it
->glyph_row
);
25536 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25537 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25539 /* If the glyph row is reversed, we need to prepend the glyph
25540 rather than append it. */
25541 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25545 /* Make room for the new glyph. */
25546 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25548 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25550 glyph
->charpos
= it
->cmp_it
.charpos
;
25551 glyph
->object
= it
->object
;
25552 glyph
->pixel_width
= it
->pixel_width
;
25553 glyph
->ascent
= it
->ascent
;
25554 glyph
->descent
= it
->descent
;
25555 glyph
->voffset
= it
->voffset
;
25556 glyph
->type
= COMPOSITE_GLYPH
;
25557 if (it
->cmp_it
.ch
< 0)
25559 glyph
->u
.cmp
.automatic
= false;
25560 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25561 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25565 glyph
->u
.cmp
.automatic
= true;
25566 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25567 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25568 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25570 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25571 glyph
->multibyte_p
= it
->multibyte_p
;
25572 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25574 /* In R2L rows, the left and the right box edges need to be
25575 drawn in reverse direction. */
25576 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25577 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25581 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25582 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25584 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25585 || it
->phys_descent
> it
->descent
);
25586 glyph
->padding_p
= false;
25587 glyph
->glyph_not_available_p
= false;
25588 glyph
->face_id
= it
->face_id
;
25589 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25592 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25593 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25594 glyph
->bidi_type
= it
->bidi_it
.type
;
25596 ++it
->glyph_row
->used
[area
];
25599 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25603 /* Change IT->ascent and IT->height according to the setting of
25607 take_vertical_position_into_account (struct it
*it
)
25611 if (it
->voffset
< 0)
25612 /* Increase the ascent so that we can display the text higher
25614 it
->ascent
-= it
->voffset
;
25616 /* Increase the descent so that we can display the text lower
25618 it
->descent
+= it
->voffset
;
25623 /* Produce glyphs/get display metrics for the image IT is loaded with.
25624 See the description of struct display_iterator in dispextern.h for
25625 an overview of struct display_iterator. */
25628 produce_image_glyph (struct it
*it
)
25632 int glyph_ascent
, crop
;
25633 struct glyph_slice slice
;
25635 eassert (it
->what
== IT_IMAGE
);
25637 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25639 /* Make sure X resources of the face is loaded. */
25640 prepare_face_for_display (it
->f
, face
);
25642 if (it
->image_id
< 0)
25644 /* Fringe bitmap. */
25645 it
->ascent
= it
->phys_ascent
= 0;
25646 it
->descent
= it
->phys_descent
= 0;
25647 it
->pixel_width
= 0;
25652 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25654 /* Make sure X resources of the image is loaded. */
25655 prepare_image_for_display (it
->f
, img
);
25657 slice
.x
= slice
.y
= 0;
25658 slice
.width
= img
->width
;
25659 slice
.height
= img
->height
;
25661 if (INTEGERP (it
->slice
.x
))
25662 slice
.x
= XINT (it
->slice
.x
);
25663 else if (FLOATP (it
->slice
.x
))
25664 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25666 if (INTEGERP (it
->slice
.y
))
25667 slice
.y
= XINT (it
->slice
.y
);
25668 else if (FLOATP (it
->slice
.y
))
25669 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25671 if (INTEGERP (it
->slice
.width
))
25672 slice
.width
= XINT (it
->slice
.width
);
25673 else if (FLOATP (it
->slice
.width
))
25674 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25676 if (INTEGERP (it
->slice
.height
))
25677 slice
.height
= XINT (it
->slice
.height
);
25678 else if (FLOATP (it
->slice
.height
))
25679 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25681 if (slice
.x
>= img
->width
)
25682 slice
.x
= img
->width
;
25683 if (slice
.y
>= img
->height
)
25684 slice
.y
= img
->height
;
25685 if (slice
.x
+ slice
.width
>= img
->width
)
25686 slice
.width
= img
->width
- slice
.x
;
25687 if (slice
.y
+ slice
.height
> img
->height
)
25688 slice
.height
= img
->height
- slice
.y
;
25690 if (slice
.width
== 0 || slice
.height
== 0)
25693 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25695 it
->descent
= slice
.height
- glyph_ascent
;
25697 it
->descent
+= img
->vmargin
;
25698 if (slice
.y
+ slice
.height
== img
->height
)
25699 it
->descent
+= img
->vmargin
;
25700 it
->phys_descent
= it
->descent
;
25702 it
->pixel_width
= slice
.width
;
25704 it
->pixel_width
+= img
->hmargin
;
25705 if (slice
.x
+ slice
.width
== img
->width
)
25706 it
->pixel_width
+= img
->hmargin
;
25708 /* It's quite possible for images to have an ascent greater than
25709 their height, so don't get confused in that case. */
25710 if (it
->descent
< 0)
25715 if (face
->box
!= FACE_NO_BOX
)
25717 if (face
->box_line_width
> 0)
25720 it
->ascent
+= face
->box_line_width
;
25721 if (slice
.y
+ slice
.height
== img
->height
)
25722 it
->descent
+= face
->box_line_width
;
25725 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25726 it
->pixel_width
+= eabs (face
->box_line_width
);
25727 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25728 it
->pixel_width
+= eabs (face
->box_line_width
);
25731 take_vertical_position_into_account (it
);
25733 /* Automatically crop wide image glyphs at right edge so we can
25734 draw the cursor on same display row. */
25735 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25736 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25738 it
->pixel_width
-= crop
;
25739 slice
.width
-= crop
;
25744 struct glyph
*glyph
;
25745 enum glyph_row_area area
= it
->area
;
25747 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25748 if (it
->glyph_row
->reversed_p
)
25752 /* Make room for the new glyph. */
25753 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25755 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25757 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25759 glyph
->charpos
= CHARPOS (it
->position
);
25760 glyph
->object
= it
->object
;
25761 glyph
->pixel_width
= it
->pixel_width
;
25762 glyph
->ascent
= glyph_ascent
;
25763 glyph
->descent
= it
->descent
;
25764 glyph
->voffset
= it
->voffset
;
25765 glyph
->type
= IMAGE_GLYPH
;
25766 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25767 glyph
->multibyte_p
= it
->multibyte_p
;
25768 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25770 /* In R2L rows, the left and the right box edges need to be
25771 drawn in reverse direction. */
25772 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25773 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25777 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25778 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25780 glyph
->overlaps_vertically_p
= false;
25781 glyph
->padding_p
= false;
25782 glyph
->glyph_not_available_p
= false;
25783 glyph
->face_id
= it
->face_id
;
25784 glyph
->u
.img_id
= img
->id
;
25785 glyph
->slice
.img
= slice
;
25786 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25789 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25790 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25791 glyph
->bidi_type
= it
->bidi_it
.type
;
25793 ++it
->glyph_row
->used
[area
];
25796 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25801 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25802 of the glyph, WIDTH and HEIGHT are the width and height of the
25803 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25806 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25807 int width
, int height
, int ascent
)
25809 struct glyph
*glyph
;
25810 enum glyph_row_area area
= it
->area
;
25812 eassert (ascent
>= 0 && ascent
<= height
);
25814 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25815 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25817 /* If the glyph row is reversed, we need to prepend the glyph
25818 rather than append it. */
25819 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25823 /* Make room for the additional glyph. */
25824 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25826 glyph
= it
->glyph_row
->glyphs
[area
];
25828 /* Decrease the width of the first glyph of the row that
25829 begins before first_visible_x (e.g., due to hscroll).
25830 This is so the overall width of the row becomes smaller
25831 by the scroll amount, and the stretch glyph appended by
25832 extend_face_to_end_of_line will be wider, to shift the
25833 row glyphs to the right. (In L2R rows, the corresponding
25834 left-shift effect is accomplished by setting row->x to a
25835 negative value, which won't work with R2L rows.)
25837 This must leave us with a positive value of WIDTH, since
25838 otherwise the call to move_it_in_display_line_to at the
25839 beginning of display_line would have got past the entire
25840 first glyph, and then it->current_x would have been
25841 greater or equal to it->first_visible_x. */
25842 if (it
->current_x
< it
->first_visible_x
)
25843 width
-= it
->first_visible_x
- it
->current_x
;
25844 eassert (width
> 0);
25846 glyph
->charpos
= CHARPOS (it
->position
);
25847 glyph
->object
= object
;
25848 glyph
->pixel_width
= width
;
25849 glyph
->ascent
= ascent
;
25850 glyph
->descent
= height
- ascent
;
25851 glyph
->voffset
= it
->voffset
;
25852 glyph
->type
= STRETCH_GLYPH
;
25853 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25854 glyph
->multibyte_p
= it
->multibyte_p
;
25855 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25857 /* In R2L rows, the left and the right box edges need to be
25858 drawn in reverse direction. */
25859 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25860 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25864 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25865 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25867 glyph
->overlaps_vertically_p
= false;
25868 glyph
->padding_p
= false;
25869 glyph
->glyph_not_available_p
= false;
25870 glyph
->face_id
= it
->face_id
;
25871 glyph
->u
.stretch
.ascent
= ascent
;
25872 glyph
->u
.stretch
.height
= height
;
25873 glyph
->slice
.img
= null_glyph_slice
;
25874 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25877 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25878 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25879 glyph
->bidi_type
= it
->bidi_it
.type
;
25883 glyph
->resolved_level
= 0;
25884 glyph
->bidi_type
= UNKNOWN_BT
;
25886 ++it
->glyph_row
->used
[area
];
25889 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25892 #endif /* HAVE_WINDOW_SYSTEM */
25894 /* Produce a stretch glyph for iterator IT. IT->object is the value
25895 of the glyph property displayed. The value must be a list
25896 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25899 1. `:width WIDTH' specifies that the space should be WIDTH *
25900 canonical char width wide. WIDTH may be an integer or floating
25903 2. `:relative-width FACTOR' specifies that the width of the stretch
25904 should be computed from the width of the first character having the
25905 `glyph' property, and should be FACTOR times that width.
25907 3. `:align-to HPOS' specifies that the space should be wide enough
25908 to reach HPOS, a value in canonical character units.
25910 Exactly one of the above pairs must be present.
25912 4. `:height HEIGHT' specifies that the height of the stretch produced
25913 should be HEIGHT, measured in canonical character units.
25915 5. `:relative-height FACTOR' specifies that the height of the
25916 stretch should be FACTOR times the height of the characters having
25917 the glyph property.
25919 Either none or exactly one of 4 or 5 must be present.
25921 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25922 of the stretch should be used for the ascent of the stretch.
25923 ASCENT must be in the range 0 <= ASCENT <= 100. */
25926 produce_stretch_glyph (struct it
*it
)
25928 /* (space :width WIDTH :height HEIGHT ...) */
25929 Lisp_Object prop
, plist
;
25930 int width
= 0, height
= 0, align_to
= -1;
25931 bool zero_width_ok_p
= false;
25933 struct font
*font
= NULL
;
25935 #ifdef HAVE_WINDOW_SYSTEM
25937 bool zero_height_ok_p
= false;
25939 if (FRAME_WINDOW_P (it
->f
))
25941 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25942 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25943 prepare_face_for_display (it
->f
, face
);
25947 /* List should start with `space'. */
25948 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25949 plist
= XCDR (it
->object
);
25951 /* Compute the width of the stretch. */
25952 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25953 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
25955 /* Absolute width `:width WIDTH' specified and valid. */
25956 zero_width_ok_p
= true;
25959 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
25961 /* Relative width `:relative-width FACTOR' specified and valid.
25962 Compute the width of the characters having the `glyph'
25965 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25968 if (it
->multibyte_p
)
25969 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25972 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25973 if (! ASCII_CHAR_P (it2
.c
))
25974 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25977 it2
.glyph_row
= NULL
;
25978 it2
.what
= IT_CHARACTER
;
25979 PRODUCE_GLYPHS (&it2
);
25980 width
= NUMVAL (prop
) * it2
.pixel_width
;
25982 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25983 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
25986 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25987 align_to
= (align_to
< 0
25989 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25990 else if (align_to
< 0)
25991 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25992 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25993 zero_width_ok_p
= true;
25996 /* Nothing specified -> width defaults to canonical char width. */
25997 width
= FRAME_COLUMN_WIDTH (it
->f
);
25999 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26002 #ifdef HAVE_WINDOW_SYSTEM
26003 /* Compute height. */
26004 if (FRAME_WINDOW_P (it
->f
))
26006 int default_height
= normal_char_height (font
, ' ');
26008 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26009 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26012 zero_height_ok_p
= true;
26014 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26016 height
= default_height
* NUMVAL (prop
);
26018 height
= default_height
;
26020 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26023 /* Compute percentage of height used for ascent. If
26024 `:ascent ASCENT' is present and valid, use that. Otherwise,
26025 derive the ascent from the font in use. */
26026 if (prop
= Fplist_get (plist
, QCascent
),
26027 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26028 ascent
= height
* NUMVAL (prop
) / 100.0;
26029 else if (!NILP (prop
)
26030 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26031 ascent
= min (max (0, (int)tem
), height
);
26033 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26036 #endif /* HAVE_WINDOW_SYSTEM */
26039 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26040 && it
->current_x
+ width
> it
->last_visible_x
)
26042 width
= it
->last_visible_x
- it
->current_x
;
26043 #ifdef HAVE_WINDOW_SYSTEM
26044 /* Subtract one more pixel from the stretch width, but only on
26045 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26046 width
-= FRAME_WINDOW_P (it
->f
);
26050 if (width
> 0 && height
> 0 && it
->glyph_row
)
26052 Lisp_Object o_object
= it
->object
;
26053 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26056 if (!STRINGP (object
))
26057 object
= it
->w
->contents
;
26058 #ifdef HAVE_WINDOW_SYSTEM
26059 if (FRAME_WINDOW_P (it
->f
))
26060 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26064 it
->object
= object
;
26065 it
->char_to_display
= ' ';
26066 it
->pixel_width
= it
->len
= 1;
26068 tty_append_glyph (it
);
26069 it
->object
= o_object
;
26073 it
->pixel_width
= width
;
26074 #ifdef HAVE_WINDOW_SYSTEM
26075 if (FRAME_WINDOW_P (it
->f
))
26077 it
->ascent
= it
->phys_ascent
= ascent
;
26078 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26079 it
->nglyphs
= width
> 0 && height
> 0;
26080 take_vertical_position_into_account (it
);
26084 it
->nglyphs
= width
;
26087 /* Get information about special display element WHAT in an
26088 environment described by IT. WHAT is one of IT_TRUNCATION or
26089 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26090 non-null glyph_row member. This function ensures that fields like
26091 face_id, c, len of IT are left untouched. */
26094 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26101 temp_it
.object
= Qnil
;
26102 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26104 if (what
== IT_CONTINUATION
)
26106 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26107 if (it
->bidi_it
.paragraph_dir
== R2L
)
26108 SET_GLYPH_FROM_CHAR (glyph
, '/');
26110 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26112 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26114 /* FIXME: Should we mirror GC for R2L lines? */
26115 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26116 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26119 else if (what
== IT_TRUNCATION
)
26121 /* Truncation glyph. */
26122 SET_GLYPH_FROM_CHAR (glyph
, '$');
26124 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26126 /* FIXME: Should we mirror GC for R2L lines? */
26127 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26128 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26134 #ifdef HAVE_WINDOW_SYSTEM
26135 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26136 is turned off, we precede the truncation/continuation glyphs by a
26137 stretch glyph whose width is computed such that these special
26138 glyphs are aligned at the window margin, even when very different
26139 fonts are used in different glyph rows. */
26140 if (FRAME_WINDOW_P (temp_it
.f
)
26141 /* init_iterator calls this with it->glyph_row == NULL, and it
26142 wants only the pixel width of the truncation/continuation
26144 && temp_it
.glyph_row
26145 /* insert_left_trunc_glyphs calls us at the beginning of the
26146 row, and it has its own calculation of the stretch glyph
26148 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26149 && (temp_it
.glyph_row
->reversed_p
26150 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26151 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26153 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26155 if (stretch_width
> 0)
26157 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26158 struct font
*font
=
26159 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26160 int stretch_ascent
=
26161 (((temp_it
.ascent
+ temp_it
.descent
)
26162 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26164 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26165 temp_it
.ascent
+ temp_it
.descent
,
26172 temp_it
.what
= IT_CHARACTER
;
26173 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26174 temp_it
.face_id
= GLYPH_FACE (glyph
);
26175 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26177 PRODUCE_GLYPHS (&temp_it
);
26178 it
->pixel_width
= temp_it
.pixel_width
;
26179 it
->nglyphs
= temp_it
.nglyphs
;
26182 #ifdef HAVE_WINDOW_SYSTEM
26184 /* Calculate line-height and line-spacing properties.
26185 An integer value specifies explicit pixel value.
26186 A float value specifies relative value to current face height.
26187 A cons (float . face-name) specifies relative value to
26188 height of specified face font.
26190 Returns height in pixels, or nil. */
26193 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26194 int boff
, bool override
)
26196 Lisp_Object face_name
= Qnil
;
26197 int ascent
, descent
, height
;
26199 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26204 face_name
= XCAR (val
);
26206 if (!NUMBERP (val
))
26207 val
= make_number (1);
26208 if (NILP (face_name
))
26210 height
= it
->ascent
+ it
->descent
;
26215 if (NILP (face_name
))
26217 font
= FRAME_FONT (it
->f
);
26218 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26220 else if (EQ (face_name
, Qt
))
26229 face_id
= lookup_named_face (it
->f
, face_name
, false);
26231 return make_number (-1);
26233 face
= FACE_FROM_ID (it
->f
, face_id
);
26236 return make_number (-1);
26237 boff
= font
->baseline_offset
;
26238 if (font
->vertical_centering
)
26239 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26242 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26246 it
->override_ascent
= ascent
;
26247 it
->override_descent
= descent
;
26248 it
->override_boff
= boff
;
26251 height
= ascent
+ descent
;
26255 height
= (int)(XFLOAT_DATA (val
) * height
);
26256 else if (INTEGERP (val
))
26257 height
*= XINT (val
);
26259 return make_number (height
);
26263 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26264 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26265 and only if this is for a character for which no font was found.
26267 If the display method (it->glyphless_method) is
26268 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26269 length of the acronym or the hexadecimal string, UPPER_XOFF and
26270 UPPER_YOFF are pixel offsets for the upper part of the string,
26271 LOWER_XOFF and LOWER_YOFF are for the lower part.
26273 For the other display methods, LEN through LOWER_YOFF are zero. */
26276 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26277 short upper_xoff
, short upper_yoff
,
26278 short lower_xoff
, short lower_yoff
)
26280 struct glyph
*glyph
;
26281 enum glyph_row_area area
= it
->area
;
26283 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26284 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26286 /* If the glyph row is reversed, we need to prepend the glyph
26287 rather than append it. */
26288 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26292 /* Make room for the additional glyph. */
26293 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26295 glyph
= it
->glyph_row
->glyphs
[area
];
26297 glyph
->charpos
= CHARPOS (it
->position
);
26298 glyph
->object
= it
->object
;
26299 glyph
->pixel_width
= it
->pixel_width
;
26300 glyph
->ascent
= it
->ascent
;
26301 glyph
->descent
= it
->descent
;
26302 glyph
->voffset
= it
->voffset
;
26303 glyph
->type
= GLYPHLESS_GLYPH
;
26304 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26305 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26306 glyph
->u
.glyphless
.len
= len
;
26307 glyph
->u
.glyphless
.ch
= it
->c
;
26308 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26309 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26310 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26311 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26312 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26313 glyph
->multibyte_p
= it
->multibyte_p
;
26314 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26316 /* In R2L rows, the left and the right box edges need to be
26317 drawn in reverse direction. */
26318 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26319 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26323 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26324 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26326 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26327 || it
->phys_descent
> it
->descent
);
26328 glyph
->padding_p
= false;
26329 glyph
->glyph_not_available_p
= false;
26330 glyph
->face_id
= face_id
;
26331 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26334 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26335 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26336 glyph
->bidi_type
= it
->bidi_it
.type
;
26338 ++it
->glyph_row
->used
[area
];
26341 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26345 /* Produce a glyph for a glyphless character for iterator IT.
26346 IT->glyphless_method specifies which method to use for displaying
26347 the character. See the description of enum
26348 glyphless_display_method in dispextern.h for the detail.
26350 FOR_NO_FONT is true if and only if this is for a character for
26351 which no font was found. ACRONYM, if non-nil, is an acronym string
26352 for the character. */
26355 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26360 int base_width
, base_height
, width
, height
;
26361 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26364 /* Get the metrics of the base font. We always refer to the current
26366 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26367 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26368 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26369 it
->ascent
+= font
->baseline_offset
;
26370 it
->descent
-= font
->baseline_offset
;
26371 base_height
= it
->ascent
+ it
->descent
;
26372 base_width
= font
->average_width
;
26374 face_id
= merge_glyphless_glyph_face (it
);
26376 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26378 it
->pixel_width
= THIN_SPACE_WIDTH
;
26380 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26382 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26384 width
= CHAR_WIDTH (it
->c
);
26387 else if (width
> 4)
26389 it
->pixel_width
= base_width
* width
;
26391 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26397 unsigned int code
[6];
26399 int ascent
, descent
;
26400 struct font_metrics metrics_upper
, metrics_lower
;
26402 face
= FACE_FROM_ID (it
->f
, face_id
);
26403 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26404 prepare_face_for_display (it
->f
, face
);
26406 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26408 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26409 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26410 if (CONSP (acronym
))
26411 acronym
= XCAR (acronym
);
26412 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26416 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26417 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26420 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26421 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26422 upper_len
= (len
+ 1) / 2;
26423 font
->driver
->text_extents (font
, code
, upper_len
,
26425 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26430 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26431 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26432 upper_xoff
= upper_yoff
= 2; /* the typical case */
26433 if (base_width
>= width
)
26435 /* Align the upper to the left, the lower to the right. */
26436 it
->pixel_width
= base_width
;
26437 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26441 /* Center the shorter one. */
26442 it
->pixel_width
= width
;
26443 if (metrics_upper
.width
>= metrics_lower
.width
)
26444 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26447 /* FIXME: This code doesn't look right. It formerly was
26448 missing the "lower_xoff = 0;", which couldn't have
26449 been right since it left lower_xoff uninitialized. */
26451 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26455 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26456 top, bottom, and between upper and lower strings. */
26457 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26458 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26459 /* Center vertically.
26460 H:base_height, D:base_descent
26461 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26463 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26464 descent = D - H/2 + h/2;
26465 lower_yoff = descent - 2 - ld;
26466 upper_yoff = lower_yoff - la - 1 - ud; */
26467 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26468 descent
= it
->descent
- (base_height
- height
) / 2;
26469 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26470 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26471 - metrics_upper
.descent
);
26472 /* Don't make the height shorter than the base height. */
26473 if (height
> base_height
)
26475 it
->ascent
= ascent
;
26476 it
->descent
= descent
;
26480 it
->phys_ascent
= it
->ascent
;
26481 it
->phys_descent
= it
->descent
;
26483 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26484 upper_xoff
, upper_yoff
,
26485 lower_xoff
, lower_yoff
);
26487 take_vertical_position_into_account (it
);
26492 Produce glyphs/get display metrics for the display element IT is
26493 loaded with. See the description of struct it in dispextern.h
26494 for an overview of struct it. */
26497 x_produce_glyphs (struct it
*it
)
26499 int extra_line_spacing
= it
->extra_line_spacing
;
26501 it
->glyph_not_available_p
= false;
26503 if (it
->what
== IT_CHARACTER
)
26506 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26507 struct font
*font
= face
->font
;
26508 struct font_metrics
*pcm
= NULL
;
26509 int boff
; /* Baseline offset. */
26513 /* When no suitable font is found, display this character by
26514 the method specified in the first extra slot of
26515 Vglyphless_char_display. */
26516 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26518 eassert (it
->what
== IT_GLYPHLESS
);
26519 produce_glyphless_glyph (it
, true,
26520 STRINGP (acronym
) ? acronym
: Qnil
);
26524 boff
= font
->baseline_offset
;
26525 if (font
->vertical_centering
)
26526 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26528 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26532 if (it
->override_ascent
>= 0)
26534 it
->ascent
= it
->override_ascent
;
26535 it
->descent
= it
->override_descent
;
26536 boff
= it
->override_boff
;
26540 it
->ascent
= FONT_BASE (font
) + boff
;
26541 it
->descent
= FONT_DESCENT (font
) - boff
;
26544 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26546 pcm
= get_per_char_metric (font
, &char2b
);
26547 if (pcm
->width
== 0
26548 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26554 it
->phys_ascent
= pcm
->ascent
+ boff
;
26555 it
->phys_descent
= pcm
->descent
- boff
;
26556 it
->pixel_width
= pcm
->width
;
26557 /* Don't use font-global values for ascent and descent
26558 if they result in an exceedingly large line height. */
26559 if (it
->override_ascent
< 0)
26561 if (FONT_TOO_HIGH (font
))
26563 it
->ascent
= it
->phys_ascent
;
26564 it
->descent
= it
->phys_descent
;
26565 /* These limitations are enforced by an
26566 assertion near the end of this function. */
26567 if (it
->ascent
< 0)
26569 if (it
->descent
< 0)
26576 it
->glyph_not_available_p
= true;
26577 it
->phys_ascent
= it
->ascent
;
26578 it
->phys_descent
= it
->descent
;
26579 it
->pixel_width
= font
->space_width
;
26582 if (it
->constrain_row_ascent_descent_p
)
26584 if (it
->descent
> it
->max_descent
)
26586 it
->ascent
+= it
->descent
- it
->max_descent
;
26587 it
->descent
= it
->max_descent
;
26589 if (it
->ascent
> it
->max_ascent
)
26591 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26592 it
->ascent
= it
->max_ascent
;
26594 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26595 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26596 extra_line_spacing
= 0;
26599 /* If this is a space inside a region of text with
26600 `space-width' property, change its width. */
26602 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26604 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26606 /* If face has a box, add the box thickness to the character
26607 height. If character has a box line to the left and/or
26608 right, add the box line width to the character's width. */
26609 if (face
->box
!= FACE_NO_BOX
)
26611 int thick
= face
->box_line_width
;
26615 it
->ascent
+= thick
;
26616 it
->descent
+= thick
;
26621 if (it
->start_of_box_run_p
)
26622 it
->pixel_width
+= thick
;
26623 if (it
->end_of_box_run_p
)
26624 it
->pixel_width
+= thick
;
26627 /* If face has an overline, add the height of the overline
26628 (1 pixel) and a 1 pixel margin to the character height. */
26629 if (face
->overline_p
)
26630 it
->ascent
+= overline_margin
;
26632 if (it
->constrain_row_ascent_descent_p
)
26634 if (it
->ascent
> it
->max_ascent
)
26635 it
->ascent
= it
->max_ascent
;
26636 if (it
->descent
> it
->max_descent
)
26637 it
->descent
= it
->max_descent
;
26640 take_vertical_position_into_account (it
);
26642 /* If we have to actually produce glyphs, do it. */
26647 /* Translate a space with a `space-width' property
26648 into a stretch glyph. */
26649 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26650 / FONT_HEIGHT (font
));
26651 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26652 it
->ascent
+ it
->descent
, ascent
);
26657 /* If characters with lbearing or rbearing are displayed
26658 in this line, record that fact in a flag of the
26659 glyph row. This is used to optimize X output code. */
26660 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26661 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26663 if (! stretched_p
&& it
->pixel_width
== 0)
26664 /* We assure that all visible glyphs have at least 1-pixel
26666 it
->pixel_width
= 1;
26668 else if (it
->char_to_display
== '\n')
26670 /* A newline has no width, but we need the height of the
26671 line. But if previous part of the line sets a height,
26672 don't increase that height. */
26674 Lisp_Object height
;
26675 Lisp_Object total_height
= Qnil
;
26677 it
->override_ascent
= -1;
26678 it
->pixel_width
= 0;
26681 height
= get_it_property (it
, Qline_height
);
26682 /* Split (line-height total-height) list. */
26684 && CONSP (XCDR (height
))
26685 && NILP (XCDR (XCDR (height
))))
26687 total_height
= XCAR (XCDR (height
));
26688 height
= XCAR (height
);
26690 height
= calc_line_height_property (it
, height
, font
, boff
, true);
26692 if (it
->override_ascent
>= 0)
26694 it
->ascent
= it
->override_ascent
;
26695 it
->descent
= it
->override_descent
;
26696 boff
= it
->override_boff
;
26700 if (FONT_TOO_HIGH (font
))
26702 it
->ascent
= font
->pixel_size
+ boff
- 1;
26703 it
->descent
= -boff
+ 1;
26704 if (it
->descent
< 0)
26709 it
->ascent
= FONT_BASE (font
) + boff
;
26710 it
->descent
= FONT_DESCENT (font
) - boff
;
26714 if (EQ (height
, Qt
))
26716 if (it
->descent
> it
->max_descent
)
26718 it
->ascent
+= it
->descent
- it
->max_descent
;
26719 it
->descent
= it
->max_descent
;
26721 if (it
->ascent
> it
->max_ascent
)
26723 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26724 it
->ascent
= it
->max_ascent
;
26726 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26727 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26728 it
->constrain_row_ascent_descent_p
= true;
26729 extra_line_spacing
= 0;
26733 Lisp_Object spacing
;
26735 it
->phys_ascent
= it
->ascent
;
26736 it
->phys_descent
= it
->descent
;
26738 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26739 && face
->box
!= FACE_NO_BOX
26740 && face
->box_line_width
> 0)
26742 it
->ascent
+= face
->box_line_width
;
26743 it
->descent
+= face
->box_line_width
;
26746 && XINT (height
) > it
->ascent
+ it
->descent
)
26747 it
->ascent
= XINT (height
) - it
->descent
;
26749 if (!NILP (total_height
))
26750 spacing
= calc_line_height_property (it
, total_height
, font
,
26754 spacing
= get_it_property (it
, Qline_spacing
);
26755 spacing
= calc_line_height_property (it
, spacing
, font
,
26758 if (INTEGERP (spacing
))
26760 extra_line_spacing
= XINT (spacing
);
26761 if (!NILP (total_height
))
26762 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26766 else /* i.e. (it->char_to_display == '\t') */
26768 if (font
->space_width
> 0)
26770 int tab_width
= it
->tab_width
* font
->space_width
;
26771 int x
= it
->current_x
+ it
->continuation_lines_width
;
26772 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26774 /* If the distance from the current position to the next tab
26775 stop is less than a space character width, use the
26776 tab stop after that. */
26777 if (next_tab_x
- x
< font
->space_width
)
26778 next_tab_x
+= tab_width
;
26780 it
->pixel_width
= next_tab_x
- x
;
26782 if (FONT_TOO_HIGH (font
))
26784 if (get_char_glyph_code (' ', font
, &char2b
))
26786 pcm
= get_per_char_metric (font
, &char2b
);
26787 if (pcm
->width
== 0
26788 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26794 it
->ascent
= pcm
->ascent
+ boff
;
26795 it
->descent
= pcm
->descent
- boff
;
26799 it
->ascent
= font
->pixel_size
+ boff
- 1;
26800 it
->descent
= -boff
+ 1;
26802 if (it
->ascent
< 0)
26804 if (it
->descent
< 0)
26809 it
->ascent
= FONT_BASE (font
) + boff
;
26810 it
->descent
= FONT_DESCENT (font
) - boff
;
26812 it
->phys_ascent
= it
->ascent
;
26813 it
->phys_descent
= it
->descent
;
26817 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26818 it
->ascent
+ it
->descent
, it
->ascent
);
26823 it
->pixel_width
= 0;
26828 if (FONT_TOO_HIGH (font
))
26830 int font_ascent
, font_descent
;
26832 /* For very large fonts, where we ignore the declared font
26833 dimensions, and go by per-character metrics instead,
26834 don't let the row ascent and descent values (and the row
26835 height computed from them) be smaller than the "normal"
26836 character metrics. This avoids unpleasant effects
26837 whereby lines on display would change their height
26838 depending on which characters are shown. */
26839 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26840 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
26841 it
->max_descent
= max (it
->max_descent
, font_descent
);
26844 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26846 /* A static composition.
26848 Note: A composition is represented as one glyph in the
26849 glyph matrix. There are no padding glyphs.
26851 Important note: pixel_width, ascent, and descent are the
26852 values of what is drawn by draw_glyphs (i.e. the values of
26853 the overall glyphs composed). */
26854 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26855 int boff
; /* baseline offset */
26856 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26857 int glyph_len
= cmp
->glyph_len
;
26858 struct font
*font
= face
->font
;
26862 /* If we have not yet calculated pixel size data of glyphs of
26863 the composition for the current face font, calculate them
26864 now. Theoretically, we have to check all fonts for the
26865 glyphs, but that requires much time and memory space. So,
26866 here we check only the font of the first glyph. This may
26867 lead to incorrect display, but it's very rare, and C-l
26868 (recenter-top-bottom) can correct the display anyway. */
26869 if (! cmp
->font
|| cmp
->font
!= font
)
26871 /* Ascent and descent of the font of the first character
26872 of this composition (adjusted by baseline offset).
26873 Ascent and descent of overall glyphs should not be less
26874 than these, respectively. */
26875 int font_ascent
, font_descent
, font_height
;
26876 /* Bounding box of the overall glyphs. */
26877 int leftmost
, rightmost
, lowest
, highest
;
26878 int lbearing
, rbearing
;
26879 int i
, width
, ascent
, descent
;
26880 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26882 struct font_metrics
*pcm
;
26885 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26886 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26888 bool right_padded
= glyph_len
< cmp
->glyph_len
;
26889 for (i
= 0; i
< glyph_len
; i
++)
26891 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26893 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26895 bool left_padded
= i
> 0;
26897 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26898 : IT_CHARPOS (*it
));
26899 /* If no suitable font is found, use the default font. */
26900 bool font_not_found_p
= font
== NULL
;
26901 if (font_not_found_p
)
26903 face
= face
->ascii_face
;
26906 boff
= font
->baseline_offset
;
26907 if (font
->vertical_centering
)
26908 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26909 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26910 font_ascent
+= boff
;
26911 font_descent
-= boff
;
26912 font_height
= font_ascent
+ font_descent
;
26917 if (! font_not_found_p
)
26919 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26921 pcm
= get_per_char_metric (font
, &char2b
);
26924 /* Initialize the bounding box. */
26927 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26928 ascent
= pcm
->ascent
;
26929 descent
= pcm
->descent
;
26930 lbearing
= pcm
->lbearing
;
26931 rbearing
= pcm
->rbearing
;
26935 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26936 ascent
= FONT_BASE (font
);
26937 descent
= FONT_DESCENT (font
);
26944 lowest
= - descent
+ boff
;
26945 highest
= ascent
+ boff
;
26947 if (! font_not_found_p
26948 && font
->default_ascent
26949 && CHAR_TABLE_P (Vuse_default_ascent
)
26950 && !NILP (Faref (Vuse_default_ascent
,
26951 make_number (it
->char_to_display
))))
26952 highest
= font
->default_ascent
+ boff
;
26954 /* Draw the first glyph at the normal position. It may be
26955 shifted to right later if some other glyphs are drawn
26957 cmp
->offsets
[i
* 2] = 0;
26958 cmp
->offsets
[i
* 2 + 1] = boff
;
26959 cmp
->lbearing
= lbearing
;
26960 cmp
->rbearing
= rbearing
;
26962 /* Set cmp->offsets for the remaining glyphs. */
26963 for (i
++; i
< glyph_len
; i
++)
26965 int left
, right
, btm
, top
;
26966 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26968 struct face
*this_face
;
26972 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26973 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26974 font
= this_face
->font
;
26980 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26982 pcm
= get_per_char_metric (font
, &char2b
);
26985 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26988 width
= pcm
->width
;
26989 ascent
= pcm
->ascent
;
26990 descent
= pcm
->descent
;
26991 lbearing
= pcm
->lbearing
;
26992 rbearing
= pcm
->rbearing
;
26993 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26995 /* Relative composition with or without
26996 alternate chars. */
26997 left
= (leftmost
+ rightmost
- width
) / 2;
26998 btm
= - descent
+ boff
;
26999 if (font
->relative_compose
27000 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27001 || NILP (Faref (Vignore_relative_composition
,
27002 make_number (ch
)))))
27005 if (- descent
>= font
->relative_compose
)
27006 /* One extra pixel between two glyphs. */
27008 else if (ascent
<= 0)
27009 /* One extra pixel between two glyphs. */
27010 btm
= lowest
- 1 - ascent
- descent
;
27015 /* A composition rule is specified by an integer
27016 value that encodes global and new reference
27017 points (GREF and NREF). GREF and NREF are
27018 specified by numbers as below:
27020 0---1---2 -- ascent
27024 9--10--11 -- center
27026 ---3---4---5--- baseline
27028 6---7---8 -- descent
27030 int rule
= COMPOSITION_RULE (cmp
, i
);
27031 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27033 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27034 grefx
= gref
% 3, nrefx
= nref
% 3;
27035 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27037 xoff
= font_height
* (xoff
- 128) / 256;
27039 yoff
= font_height
* (yoff
- 128) / 256;
27042 + grefx
* (rightmost
- leftmost
) / 2
27043 - nrefx
* width
/ 2
27046 btm
= ((grefy
== 0 ? highest
27048 : grefy
== 2 ? lowest
27049 : (highest
+ lowest
) / 2)
27050 - (nrefy
== 0 ? ascent
+ descent
27051 : nrefy
== 1 ? descent
- boff
27053 : (ascent
+ descent
) / 2)
27057 cmp
->offsets
[i
* 2] = left
;
27058 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27060 /* Update the bounding box of the overall glyphs. */
27063 right
= left
+ width
;
27064 if (left
< leftmost
)
27066 if (right
> rightmost
)
27069 top
= btm
+ descent
+ ascent
;
27075 if (cmp
->lbearing
> left
+ lbearing
)
27076 cmp
->lbearing
= left
+ lbearing
;
27077 if (cmp
->rbearing
< left
+ rbearing
)
27078 cmp
->rbearing
= left
+ rbearing
;
27082 /* If there are glyphs whose x-offsets are negative,
27083 shift all glyphs to the right and make all x-offsets
27087 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27088 cmp
->offsets
[i
* 2] -= leftmost
;
27089 rightmost
-= leftmost
;
27090 cmp
->lbearing
-= leftmost
;
27091 cmp
->rbearing
-= leftmost
;
27094 if (left_padded
&& cmp
->lbearing
< 0)
27096 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27097 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27098 rightmost
-= cmp
->lbearing
;
27099 cmp
->rbearing
-= cmp
->lbearing
;
27102 if (right_padded
&& rightmost
< cmp
->rbearing
)
27104 rightmost
= cmp
->rbearing
;
27107 cmp
->pixel_width
= rightmost
;
27108 cmp
->ascent
= highest
;
27109 cmp
->descent
= - lowest
;
27110 if (cmp
->ascent
< font_ascent
)
27111 cmp
->ascent
= font_ascent
;
27112 if (cmp
->descent
< font_descent
)
27113 cmp
->descent
= font_descent
;
27117 && (cmp
->lbearing
< 0
27118 || cmp
->rbearing
> cmp
->pixel_width
))
27119 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27121 it
->pixel_width
= cmp
->pixel_width
;
27122 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27123 it
->descent
= it
->phys_descent
= cmp
->descent
;
27124 if (face
->box
!= FACE_NO_BOX
)
27126 int thick
= face
->box_line_width
;
27130 it
->ascent
+= thick
;
27131 it
->descent
+= thick
;
27136 if (it
->start_of_box_run_p
)
27137 it
->pixel_width
+= thick
;
27138 if (it
->end_of_box_run_p
)
27139 it
->pixel_width
+= thick
;
27142 /* If face has an overline, add the height of the overline
27143 (1 pixel) and a 1 pixel margin to the character height. */
27144 if (face
->overline_p
)
27145 it
->ascent
+= overline_margin
;
27147 take_vertical_position_into_account (it
);
27148 if (it
->ascent
< 0)
27150 if (it
->descent
< 0)
27153 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27154 append_composite_glyph (it
);
27156 else if (it
->what
== IT_COMPOSITION
)
27158 /* A dynamic (automatic) composition. */
27159 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27160 Lisp_Object gstring
;
27161 struct font_metrics metrics
;
27165 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27167 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27170 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27171 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27172 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27173 it
->descent
= it
->phys_descent
= metrics
.descent
;
27174 if (face
->box
!= FACE_NO_BOX
)
27176 int thick
= face
->box_line_width
;
27180 it
->ascent
+= thick
;
27181 it
->descent
+= thick
;
27186 if (it
->start_of_box_run_p
)
27187 it
->pixel_width
+= thick
;
27188 if (it
->end_of_box_run_p
)
27189 it
->pixel_width
+= thick
;
27191 /* If face has an overline, add the height of the overline
27192 (1 pixel) and a 1 pixel margin to the character height. */
27193 if (face
->overline_p
)
27194 it
->ascent
+= overline_margin
;
27195 take_vertical_position_into_account (it
);
27196 if (it
->ascent
< 0)
27198 if (it
->descent
< 0)
27202 append_composite_glyph (it
);
27204 else if (it
->what
== IT_GLYPHLESS
)
27205 produce_glyphless_glyph (it
, false, Qnil
);
27206 else if (it
->what
== IT_IMAGE
)
27207 produce_image_glyph (it
);
27208 else if (it
->what
== IT_STRETCH
)
27209 produce_stretch_glyph (it
);
27212 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27213 because this isn't true for images with `:ascent 100'. */
27214 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27215 if (it
->area
== TEXT_AREA
)
27216 it
->current_x
+= it
->pixel_width
;
27218 if (extra_line_spacing
> 0)
27220 it
->descent
+= extra_line_spacing
;
27221 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27222 it
->max_extra_line_spacing
= extra_line_spacing
;
27225 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27226 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27227 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27228 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27232 Output LEN glyphs starting at START at the nominal cursor position.
27233 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27234 being updated, and UPDATED_AREA is the area of that row being updated. */
27237 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27238 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27240 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27242 eassert (updated_row
);
27243 /* When the window is hscrolled, cursor hpos can legitimately be out
27244 of bounds, but we draw the cursor at the corresponding window
27245 margin in that case. */
27246 if (!updated_row
->reversed_p
&& chpos
< 0)
27248 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27249 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27253 /* Write glyphs. */
27255 hpos
= start
- updated_row
->glyphs
[updated_area
];
27256 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27257 updated_row
, updated_area
,
27259 DRAW_NORMAL_TEXT
, 0);
27261 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27262 if (updated_area
== TEXT_AREA
27263 && w
->phys_cursor_on_p
27264 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27266 && chpos
< hpos
+ len
)
27267 w
->phys_cursor_on_p
= false;
27271 /* Advance the output cursor. */
27272 w
->output_cursor
.hpos
+= len
;
27273 w
->output_cursor
.x
= x
;
27278 Insert LEN glyphs from START at the nominal cursor position. */
27281 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27282 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27285 int line_height
, shift_by_width
, shifted_region_width
;
27286 struct glyph_row
*row
;
27287 struct glyph
*glyph
;
27288 int frame_x
, frame_y
;
27291 eassert (updated_row
);
27293 f
= XFRAME (WINDOW_FRAME (w
));
27295 /* Get the height of the line we are in. */
27297 line_height
= row
->height
;
27299 /* Get the width of the glyphs to insert. */
27300 shift_by_width
= 0;
27301 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27302 shift_by_width
+= glyph
->pixel_width
;
27304 /* Get the width of the region to shift right. */
27305 shifted_region_width
= (window_box_width (w
, updated_area
)
27306 - w
->output_cursor
.x
27310 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27311 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27313 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27314 line_height
, shift_by_width
);
27316 /* Write the glyphs. */
27317 hpos
= start
- row
->glyphs
[updated_area
];
27318 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27320 DRAW_NORMAL_TEXT
, 0);
27322 /* Advance the output cursor. */
27323 w
->output_cursor
.hpos
+= len
;
27324 w
->output_cursor
.x
+= shift_by_width
;
27330 Erase the current text line from the nominal cursor position
27331 (inclusive) to pixel column TO_X (exclusive). The idea is that
27332 everything from TO_X onward is already erased.
27334 TO_X is a pixel position relative to UPDATED_AREA of currently
27335 updated window W. TO_X == -1 means clear to the end of this area. */
27338 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27339 enum glyph_row_area updated_area
, int to_x
)
27342 int max_x
, min_y
, max_y
;
27343 int from_x
, from_y
, to_y
;
27345 eassert (updated_row
);
27346 f
= XFRAME (w
->frame
);
27348 if (updated_row
->full_width_p
)
27349 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27350 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27352 max_x
= window_box_width (w
, updated_area
);
27353 max_y
= window_text_bottom_y (w
);
27355 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27356 of window. For TO_X > 0, truncate to end of drawing area. */
27362 to_x
= min (to_x
, max_x
);
27364 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27366 /* Notice if the cursor will be cleared by this operation. */
27367 if (!updated_row
->full_width_p
)
27368 notice_overwritten_cursor (w
, updated_area
,
27369 w
->output_cursor
.x
, -1,
27371 MATRIX_ROW_BOTTOM_Y (updated_row
));
27373 from_x
= w
->output_cursor
.x
;
27375 /* Translate to frame coordinates. */
27376 if (updated_row
->full_width_p
)
27378 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27379 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27383 int area_left
= window_box_left (w
, updated_area
);
27384 from_x
+= area_left
;
27388 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27389 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27390 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27392 /* Prevent inadvertently clearing to end of the X window. */
27393 if (to_x
> from_x
&& to_y
> from_y
)
27396 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27397 to_x
- from_x
, to_y
- from_y
);
27402 #endif /* HAVE_WINDOW_SYSTEM */
27406 /***********************************************************************
27408 ***********************************************************************/
27410 /* Value is the internal representation of the specified cursor type
27411 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27412 of the bar cursor. */
27414 static enum text_cursor_kinds
27415 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27417 enum text_cursor_kinds type
;
27422 if (EQ (arg
, Qbox
))
27423 return FILLED_BOX_CURSOR
;
27425 if (EQ (arg
, Qhollow
))
27426 return HOLLOW_BOX_CURSOR
;
27428 if (EQ (arg
, Qbar
))
27435 && EQ (XCAR (arg
), Qbar
)
27436 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27438 *width
= XINT (XCDR (arg
));
27442 if (EQ (arg
, Qhbar
))
27445 return HBAR_CURSOR
;
27449 && EQ (XCAR (arg
), Qhbar
)
27450 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27452 *width
= XINT (XCDR (arg
));
27453 return HBAR_CURSOR
;
27456 /* Treat anything unknown as "hollow box cursor".
27457 It was bad to signal an error; people have trouble fixing
27458 .Xdefaults with Emacs, when it has something bad in it. */
27459 type
= HOLLOW_BOX_CURSOR
;
27464 /* Set the default cursor types for specified frame. */
27466 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27471 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27472 FRAME_CURSOR_WIDTH (f
) = width
;
27474 /* By default, set up the blink-off state depending on the on-state. */
27476 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27479 FRAME_BLINK_OFF_CURSOR (f
)
27480 = get_specified_cursor_type (XCDR (tem
), &width
);
27481 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27484 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27486 /* Make sure the cursor gets redrawn. */
27487 f
->cursor_type_changed
= true;
27491 #ifdef HAVE_WINDOW_SYSTEM
27493 /* Return the cursor we want to be displayed in window W. Return
27494 width of bar/hbar cursor through WIDTH arg. Return with
27495 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27496 (i.e. if the `system caret' should track this cursor).
27498 In a mini-buffer window, we want the cursor only to appear if we
27499 are reading input from this window. For the selected window, we
27500 want the cursor type given by the frame parameter or buffer local
27501 setting of cursor-type. If explicitly marked off, draw no cursor.
27502 In all other cases, we want a hollow box cursor. */
27504 static enum text_cursor_kinds
27505 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27506 bool *active_cursor
)
27508 struct frame
*f
= XFRAME (w
->frame
);
27509 struct buffer
*b
= XBUFFER (w
->contents
);
27510 int cursor_type
= DEFAULT_CURSOR
;
27511 Lisp_Object alt_cursor
;
27512 bool non_selected
= false;
27514 *active_cursor
= true;
27517 if (cursor_in_echo_area
27518 && FRAME_HAS_MINIBUF_P (f
)
27519 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27521 if (w
== XWINDOW (echo_area_window
))
27523 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27525 *width
= FRAME_CURSOR_WIDTH (f
);
27526 return FRAME_DESIRED_CURSOR (f
);
27529 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27532 *active_cursor
= false;
27533 non_selected
= true;
27536 /* Detect a nonselected window or nonselected frame. */
27537 else if (w
!= XWINDOW (f
->selected_window
)
27538 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27540 *active_cursor
= false;
27542 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27545 non_selected
= true;
27548 /* Never display a cursor in a window in which cursor-type is nil. */
27549 if (NILP (BVAR (b
, cursor_type
)))
27552 /* Get the normal cursor type for this window. */
27553 if (EQ (BVAR (b
, cursor_type
), Qt
))
27555 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27556 *width
= FRAME_CURSOR_WIDTH (f
);
27559 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27561 /* Use cursor-in-non-selected-windows instead
27562 for non-selected window or frame. */
27565 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27566 if (!EQ (Qt
, alt_cursor
))
27567 return get_specified_cursor_type (alt_cursor
, width
);
27568 /* t means modify the normal cursor type. */
27569 if (cursor_type
== FILLED_BOX_CURSOR
)
27570 cursor_type
= HOLLOW_BOX_CURSOR
;
27571 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27573 return cursor_type
;
27576 /* Use normal cursor if not blinked off. */
27577 if (!w
->cursor_off_p
)
27579 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27581 if (cursor_type
== FILLED_BOX_CURSOR
)
27583 /* Using a block cursor on large images can be very annoying.
27584 So use a hollow cursor for "large" images.
27585 If image is not transparent (no mask), also use hollow cursor. */
27586 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27587 if (img
!= NULL
&& IMAGEP (img
->spec
))
27589 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27590 where N = size of default frame font size.
27591 This should cover most of the "tiny" icons people may use. */
27593 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27594 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27595 cursor_type
= HOLLOW_BOX_CURSOR
;
27598 else if (cursor_type
!= NO_CURSOR
)
27600 /* Display current only supports BOX and HOLLOW cursors for images.
27601 So for now, unconditionally use a HOLLOW cursor when cursor is
27602 not a solid box cursor. */
27603 cursor_type
= HOLLOW_BOX_CURSOR
;
27606 return cursor_type
;
27609 /* Cursor is blinked off, so determine how to "toggle" it. */
27611 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27612 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27613 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27615 /* Then see if frame has specified a specific blink off cursor type. */
27616 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27618 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27619 return FRAME_BLINK_OFF_CURSOR (f
);
27623 /* Some people liked having a permanently visible blinking cursor,
27624 while others had very strong opinions against it. So it was
27625 decided to remove it. KFS 2003-09-03 */
27627 /* Finally perform built-in cursor blinking:
27628 filled box <-> hollow box
27629 wide [h]bar <-> narrow [h]bar
27630 narrow [h]bar <-> no cursor
27631 other type <-> no cursor */
27633 if (cursor_type
== FILLED_BOX_CURSOR
)
27634 return HOLLOW_BOX_CURSOR
;
27636 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27639 return cursor_type
;
27647 /* Notice when the text cursor of window W has been completely
27648 overwritten by a drawing operation that outputs glyphs in AREA
27649 starting at X0 and ending at X1 in the line starting at Y0 and
27650 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27651 the rest of the line after X0 has been written. Y coordinates
27652 are window-relative. */
27655 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27656 int x0
, int x1
, int y0
, int y1
)
27658 int cx0
, cx1
, cy0
, cy1
;
27659 struct glyph_row
*row
;
27661 if (!w
->phys_cursor_on_p
)
27663 if (area
!= TEXT_AREA
)
27666 if (w
->phys_cursor
.vpos
< 0
27667 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27668 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27669 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27672 if (row
->cursor_in_fringe_p
)
27674 row
->cursor_in_fringe_p
= false;
27675 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27676 w
->phys_cursor_on_p
= false;
27680 cx0
= w
->phys_cursor
.x
;
27681 cx1
= cx0
+ w
->phys_cursor_width
;
27682 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27685 /* The cursor image will be completely removed from the
27686 screen if the output area intersects the cursor area in
27687 y-direction. When we draw in [y0 y1[, and some part of
27688 the cursor is at y < y0, that part must have been drawn
27689 before. When scrolling, the cursor is erased before
27690 actually scrolling, so we don't come here. When not
27691 scrolling, the rows above the old cursor row must have
27692 changed, and in this case these rows must have written
27693 over the cursor image.
27695 Likewise if part of the cursor is below y1, with the
27696 exception of the cursor being in the first blank row at
27697 the buffer and window end because update_text_area
27698 doesn't draw that row. (Except when it does, but
27699 that's handled in update_text_area.) */
27701 cy0
= w
->phys_cursor
.y
;
27702 cy1
= cy0
+ w
->phys_cursor_height
;
27703 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27706 w
->phys_cursor_on_p
= false;
27709 #endif /* HAVE_WINDOW_SYSTEM */
27712 /************************************************************************
27714 ************************************************************************/
27716 #ifdef HAVE_WINDOW_SYSTEM
27719 Fix the display of area AREA of overlapping row ROW in window W
27720 with respect to the overlapping part OVERLAPS. */
27723 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27724 enum glyph_row_area area
, int overlaps
)
27731 for (i
= 0; i
< row
->used
[area
];)
27733 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27735 int start
= i
, start_x
= x
;
27739 x
+= row
->glyphs
[area
][i
].pixel_width
;
27742 while (i
< row
->used
[area
]
27743 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27745 draw_glyphs (w
, start_x
, row
, area
,
27747 DRAW_NORMAL_TEXT
, overlaps
);
27751 x
+= row
->glyphs
[area
][i
].pixel_width
;
27761 Draw the cursor glyph of window W in glyph row ROW. See the
27762 comment of draw_glyphs for the meaning of HL. */
27765 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27766 enum draw_glyphs_face hl
)
27768 /* If cursor hpos is out of bounds, don't draw garbage. This can
27769 happen in mini-buffer windows when switching between echo area
27770 glyphs and mini-buffer. */
27771 if ((row
->reversed_p
27772 ? (w
->phys_cursor
.hpos
>= 0)
27773 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27775 bool on_p
= w
->phys_cursor_on_p
;
27777 int hpos
= w
->phys_cursor
.hpos
;
27779 /* When the window is hscrolled, cursor hpos can legitimately be
27780 out of bounds, but we draw the cursor at the corresponding
27781 window margin in that case. */
27782 if (!row
->reversed_p
&& hpos
< 0)
27784 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27785 hpos
= row
->used
[TEXT_AREA
] - 1;
27787 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27789 w
->phys_cursor_on_p
= on_p
;
27791 if (hl
== DRAW_CURSOR
)
27792 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27793 /* When we erase the cursor, and ROW is overlapped by other
27794 rows, make sure that these overlapping parts of other rows
27796 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27798 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27800 if (row
> w
->current_matrix
->rows
27801 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27802 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27803 OVERLAPS_ERASED_CURSOR
);
27805 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27806 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27807 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27808 OVERLAPS_ERASED_CURSOR
);
27814 /* Erase the image of a cursor of window W from the screen. */
27817 erase_phys_cursor (struct window
*w
)
27819 struct frame
*f
= XFRAME (w
->frame
);
27820 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27821 int hpos
= w
->phys_cursor
.hpos
;
27822 int vpos
= w
->phys_cursor
.vpos
;
27823 bool mouse_face_here_p
= false;
27824 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27825 struct glyph_row
*cursor_row
;
27826 struct glyph
*cursor_glyph
;
27827 enum draw_glyphs_face hl
;
27829 /* No cursor displayed or row invalidated => nothing to do on the
27831 if (w
->phys_cursor_type
== NO_CURSOR
)
27832 goto mark_cursor_off
;
27834 /* VPOS >= active_glyphs->nrows means that window has been resized.
27835 Don't bother to erase the cursor. */
27836 if (vpos
>= active_glyphs
->nrows
)
27837 goto mark_cursor_off
;
27839 /* If row containing cursor is marked invalid, there is nothing we
27841 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27842 if (!cursor_row
->enabled_p
)
27843 goto mark_cursor_off
;
27845 /* If line spacing is > 0, old cursor may only be partially visible in
27846 window after split-window. So adjust visible height. */
27847 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27848 window_text_bottom_y (w
) - cursor_row
->y
);
27850 /* If row is completely invisible, don't attempt to delete a cursor which
27851 isn't there. This can happen if cursor is at top of a window, and
27852 we switch to a buffer with a header line in that window. */
27853 if (cursor_row
->visible_height
<= 0)
27854 goto mark_cursor_off
;
27856 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27857 if (cursor_row
->cursor_in_fringe_p
)
27859 cursor_row
->cursor_in_fringe_p
= false;
27860 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27861 goto mark_cursor_off
;
27864 /* This can happen when the new row is shorter than the old one.
27865 In this case, either draw_glyphs or clear_end_of_line
27866 should have cleared the cursor. Note that we wouldn't be
27867 able to erase the cursor in this case because we don't have a
27868 cursor glyph at hand. */
27869 if ((cursor_row
->reversed_p
27870 ? (w
->phys_cursor
.hpos
< 0)
27871 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27872 goto mark_cursor_off
;
27874 /* When the window is hscrolled, cursor hpos can legitimately be out
27875 of bounds, but we draw the cursor at the corresponding window
27876 margin in that case. */
27877 if (!cursor_row
->reversed_p
&& hpos
< 0)
27879 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27880 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27882 /* If the cursor is in the mouse face area, redisplay that when
27883 we clear the cursor. */
27884 if (! NILP (hlinfo
->mouse_face_window
)
27885 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27886 /* Don't redraw the cursor's spot in mouse face if it is at the
27887 end of a line (on a newline). The cursor appears there, but
27888 mouse highlighting does not. */
27889 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27890 mouse_face_here_p
= true;
27892 /* Maybe clear the display under the cursor. */
27893 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27896 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27899 cursor_glyph
= get_phys_cursor_glyph (w
);
27900 if (cursor_glyph
== NULL
)
27901 goto mark_cursor_off
;
27903 width
= cursor_glyph
->pixel_width
;
27904 x
= w
->phys_cursor
.x
;
27910 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27911 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27912 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27915 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27918 /* Erase the cursor by redrawing the character underneath it. */
27919 if (mouse_face_here_p
)
27920 hl
= DRAW_MOUSE_FACE
;
27922 hl
= DRAW_NORMAL_TEXT
;
27923 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27926 w
->phys_cursor_on_p
= false;
27927 w
->phys_cursor_type
= NO_CURSOR
;
27931 /* Display or clear cursor of window W. If !ON, clear the cursor.
27932 If ON, display the cursor; where to put the cursor is specified by
27933 HPOS, VPOS, X and Y. */
27936 display_and_set_cursor (struct window
*w
, bool on
,
27937 int hpos
, int vpos
, int x
, int y
)
27939 struct frame
*f
= XFRAME (w
->frame
);
27940 int new_cursor_type
;
27941 int new_cursor_width
;
27942 bool active_cursor
;
27943 struct glyph_row
*glyph_row
;
27944 struct glyph
*glyph
;
27946 /* This is pointless on invisible frames, and dangerous on garbaged
27947 windows and frames; in the latter case, the frame or window may
27948 be in the midst of changing its size, and x and y may be off the
27950 if (! FRAME_VISIBLE_P (f
)
27951 || FRAME_GARBAGED_P (f
)
27952 || vpos
>= w
->current_matrix
->nrows
27953 || hpos
>= w
->current_matrix
->matrix_w
)
27956 /* If cursor is off and we want it off, return quickly. */
27957 if (!on
&& !w
->phys_cursor_on_p
)
27960 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27961 /* If cursor row is not enabled, we don't really know where to
27962 display the cursor. */
27963 if (!glyph_row
->enabled_p
)
27965 w
->phys_cursor_on_p
= false;
27970 if (!glyph_row
->exact_window_width_line_p
27971 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27972 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27974 eassert (input_blocked_p ());
27976 /* Set new_cursor_type to the cursor we want to be displayed. */
27977 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27978 &new_cursor_width
, &active_cursor
);
27980 /* If cursor is currently being shown and we don't want it to be or
27981 it is in the wrong place, or the cursor type is not what we want,
27983 if (w
->phys_cursor_on_p
27985 || w
->phys_cursor
.x
!= x
27986 || w
->phys_cursor
.y
!= y
27987 /* HPOS can be negative in R2L rows whose
27988 exact_window_width_line_p flag is set (i.e. their newline
27989 would "overflow into the fringe"). */
27991 || new_cursor_type
!= w
->phys_cursor_type
27992 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27993 && new_cursor_width
!= w
->phys_cursor_width
)))
27994 erase_phys_cursor (w
);
27996 /* Don't check phys_cursor_on_p here because that flag is only set
27997 to false in some cases where we know that the cursor has been
27998 completely erased, to avoid the extra work of erasing the cursor
27999 twice. In other words, phys_cursor_on_p can be true and the cursor
28000 still not be visible, or it has only been partly erased. */
28003 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28004 w
->phys_cursor_height
= glyph_row
->height
;
28006 /* Set phys_cursor_.* before x_draw_.* is called because some
28007 of them may need the information. */
28008 w
->phys_cursor
.x
= x
;
28009 w
->phys_cursor
.y
= glyph_row
->y
;
28010 w
->phys_cursor
.hpos
= hpos
;
28011 w
->phys_cursor
.vpos
= vpos
;
28014 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28015 new_cursor_type
, new_cursor_width
,
28016 on
, active_cursor
);
28020 /* Switch the display of W's cursor on or off, according to the value
28024 update_window_cursor (struct window
*w
, bool on
)
28026 /* Don't update cursor in windows whose frame is in the process
28027 of being deleted. */
28028 if (w
->current_matrix
)
28030 int hpos
= w
->phys_cursor
.hpos
;
28031 int vpos
= w
->phys_cursor
.vpos
;
28032 struct glyph_row
*row
;
28034 if (vpos
>= w
->current_matrix
->nrows
28035 || hpos
>= w
->current_matrix
->matrix_w
)
28038 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28040 /* When the window is hscrolled, cursor hpos can legitimately be
28041 out of bounds, but we draw the cursor at the corresponding
28042 window margin in that case. */
28043 if (!row
->reversed_p
&& hpos
< 0)
28045 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28046 hpos
= row
->used
[TEXT_AREA
] - 1;
28049 display_and_set_cursor (w
, on
, hpos
, vpos
,
28050 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28056 /* Call update_window_cursor with parameter ON_P on all leaf windows
28057 in the window tree rooted at W. */
28060 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28064 if (WINDOWP (w
->contents
))
28065 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28067 update_window_cursor (w
, on_p
);
28069 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28075 Display the cursor on window W, or clear it, according to ON_P.
28076 Don't change the cursor's position. */
28079 x_update_cursor (struct frame
*f
, bool on_p
)
28081 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28086 Clear the cursor of window W to background color, and mark the
28087 cursor as not shown. This is used when the text where the cursor
28088 is about to be rewritten. */
28091 x_clear_cursor (struct window
*w
)
28093 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28094 update_window_cursor (w
, false);
28097 #endif /* HAVE_WINDOW_SYSTEM */
28099 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28102 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28103 int start_hpos
, int end_hpos
,
28104 enum draw_glyphs_face draw
)
28106 #ifdef HAVE_WINDOW_SYSTEM
28107 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28109 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28113 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28114 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28118 /* Display the active region described by mouse_face_* according to DRAW. */
28121 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28123 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28124 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28126 if (/* If window is in the process of being destroyed, don't bother
28128 w
->current_matrix
!= NULL
28129 /* Don't update mouse highlight if hidden. */
28130 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28131 /* Recognize when we are called to operate on rows that don't exist
28132 anymore. This can happen when a window is split. */
28133 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28135 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28136 struct glyph_row
*row
, *first
, *last
;
28138 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28139 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28141 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28143 int start_hpos
, end_hpos
, start_x
;
28145 /* For all but the first row, the highlight starts at column 0. */
28148 /* R2L rows have BEG and END in reversed order, but the
28149 screen drawing geometry is always left to right. So
28150 we need to mirror the beginning and end of the
28151 highlighted area in R2L rows. */
28152 if (!row
->reversed_p
)
28154 start_hpos
= hlinfo
->mouse_face_beg_col
;
28155 start_x
= hlinfo
->mouse_face_beg_x
;
28157 else if (row
== last
)
28159 start_hpos
= hlinfo
->mouse_face_end_col
;
28160 start_x
= hlinfo
->mouse_face_end_x
;
28168 else if (row
->reversed_p
&& row
== last
)
28170 start_hpos
= hlinfo
->mouse_face_end_col
;
28171 start_x
= hlinfo
->mouse_face_end_x
;
28181 if (!row
->reversed_p
)
28182 end_hpos
= hlinfo
->mouse_face_end_col
;
28183 else if (row
== first
)
28184 end_hpos
= hlinfo
->mouse_face_beg_col
;
28187 end_hpos
= row
->used
[TEXT_AREA
];
28188 if (draw
== DRAW_NORMAL_TEXT
)
28189 row
->fill_line_p
= true; /* Clear to end of line. */
28192 else if (row
->reversed_p
&& row
== first
)
28193 end_hpos
= hlinfo
->mouse_face_beg_col
;
28196 end_hpos
= row
->used
[TEXT_AREA
];
28197 if (draw
== DRAW_NORMAL_TEXT
)
28198 row
->fill_line_p
= true; /* Clear to end of line. */
28201 if (end_hpos
> start_hpos
)
28203 draw_row_with_mouse_face (w
, start_x
, row
,
28204 start_hpos
, end_hpos
, draw
);
28207 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28211 #ifdef HAVE_WINDOW_SYSTEM
28212 /* When we've written over the cursor, arrange for it to
28213 be displayed again. */
28214 if (FRAME_WINDOW_P (f
)
28215 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28217 int hpos
= w
->phys_cursor
.hpos
;
28219 /* When the window is hscrolled, cursor hpos can legitimately be
28220 out of bounds, but we draw the cursor at the corresponding
28221 window margin in that case. */
28222 if (!row
->reversed_p
&& hpos
< 0)
28224 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28225 hpos
= row
->used
[TEXT_AREA
] - 1;
28228 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28229 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28232 #endif /* HAVE_WINDOW_SYSTEM */
28235 #ifdef HAVE_WINDOW_SYSTEM
28236 /* Change the mouse cursor. */
28237 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28239 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28240 if (draw
== DRAW_NORMAL_TEXT
28241 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28242 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28245 if (draw
== DRAW_MOUSE_FACE
)
28246 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28248 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28250 #endif /* HAVE_WINDOW_SYSTEM */
28254 Clear out the mouse-highlighted active region.
28255 Redraw it un-highlighted first. Value is true if mouse
28256 face was actually drawn unhighlighted. */
28259 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28262 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28264 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28265 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28266 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28267 hlinfo
->mouse_face_window
= Qnil
;
28268 hlinfo
->mouse_face_overlay
= Qnil
;
28272 /* Return true if the coordinates HPOS and VPOS on windows W are
28273 within the mouse face on that window. */
28275 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28277 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28279 /* Quickly resolve the easy cases. */
28280 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28281 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28283 if (vpos
< hlinfo
->mouse_face_beg_row
28284 || vpos
> hlinfo
->mouse_face_end_row
)
28286 if (vpos
> hlinfo
->mouse_face_beg_row
28287 && vpos
< hlinfo
->mouse_face_end_row
)
28290 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28292 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28294 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28297 else if ((vpos
== hlinfo
->mouse_face_beg_row
28298 && hpos
>= hlinfo
->mouse_face_beg_col
)
28299 || (vpos
== hlinfo
->mouse_face_end_row
28300 && hpos
< hlinfo
->mouse_face_end_col
))
28305 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28307 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28310 else if ((vpos
== hlinfo
->mouse_face_beg_row
28311 && hpos
<= hlinfo
->mouse_face_beg_col
)
28312 || (vpos
== hlinfo
->mouse_face_end_row
28313 && hpos
> hlinfo
->mouse_face_end_col
))
28321 True if physical cursor of window W is within mouse face. */
28324 cursor_in_mouse_face_p (struct window
*w
)
28326 int hpos
= w
->phys_cursor
.hpos
;
28327 int vpos
= w
->phys_cursor
.vpos
;
28328 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28330 /* When the window is hscrolled, cursor hpos can legitimately be out
28331 of bounds, but we draw the cursor at the corresponding window
28332 margin in that case. */
28333 if (!row
->reversed_p
&& hpos
< 0)
28335 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28336 hpos
= row
->used
[TEXT_AREA
] - 1;
28338 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28343 /* Find the glyph rows START_ROW and END_ROW of window W that display
28344 characters between buffer positions START_CHARPOS and END_CHARPOS
28345 (excluding END_CHARPOS). DISP_STRING is a display string that
28346 covers these buffer positions. This is similar to
28347 row_containing_pos, but is more accurate when bidi reordering makes
28348 buffer positions change non-linearly with glyph rows. */
28350 rows_from_pos_range (struct window
*w
,
28351 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28352 Lisp_Object disp_string
,
28353 struct glyph_row
**start
, struct glyph_row
**end
)
28355 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28356 int last_y
= window_text_bottom_y (w
);
28357 struct glyph_row
*row
;
28362 while (!first
->enabled_p
28363 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28366 /* Find the START row. */
28368 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28371 /* A row can potentially be the START row if the range of the
28372 characters it displays intersects the range
28373 [START_CHARPOS..END_CHARPOS). */
28374 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28375 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28376 /* See the commentary in row_containing_pos, for the
28377 explanation of the complicated way to check whether
28378 some position is beyond the end of the characters
28379 displayed by a row. */
28380 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28381 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28382 && !row
->ends_at_zv_p
28383 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28384 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28385 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28386 && !row
->ends_at_zv_p
28387 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28389 /* Found a candidate row. Now make sure at least one of the
28390 glyphs it displays has a charpos from the range
28391 [START_CHARPOS..END_CHARPOS).
28393 This is not obvious because bidi reordering could make
28394 buffer positions of a row be 1,2,3,102,101,100, and if we
28395 want to highlight characters in [50..60), we don't want
28396 this row, even though [50..60) does intersect [1..103),
28397 the range of character positions given by the row's start
28398 and end positions. */
28399 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28400 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28404 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28405 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28406 /* A glyph that comes from DISP_STRING is by
28407 definition to be highlighted. */
28408 || EQ (g
->object
, disp_string
))
28417 /* Find the END row. */
28419 /* If the last row is partially visible, start looking for END
28420 from that row, instead of starting from FIRST. */
28421 && !(row
->enabled_p
28422 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28424 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28426 struct glyph_row
*next
= row
+ 1;
28427 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28429 if (!next
->enabled_p
28430 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28431 /* The first row >= START whose range of displayed characters
28432 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28433 is the row END + 1. */
28434 || (start_charpos
< next_start
28435 && end_charpos
< next_start
)
28436 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28437 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28438 && !next
->ends_at_zv_p
28439 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28440 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28441 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28442 && !next
->ends_at_zv_p
28443 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28450 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28451 but none of the characters it displays are in the range, it is
28453 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28454 struct glyph
*s
= g
;
28455 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28459 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28460 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28461 /* If the buffer position of the first glyph in
28462 the row is equal to END_CHARPOS, it means
28463 the last character to be highlighted is the
28464 newline of ROW, and we must consider NEXT as
28466 || (((!next
->reversed_p
&& g
== s
)
28467 || (next
->reversed_p
&& g
== e
- 1))
28468 && (g
->charpos
== end_charpos
28469 /* Special case for when NEXT is an
28470 empty line at ZV. */
28471 || (g
->charpos
== -1
28472 && !row
->ends_at_zv_p
28473 && next_start
== end_charpos
)))))
28474 /* A glyph that comes from DISP_STRING is by
28475 definition to be highlighted. */
28476 || EQ (g
->object
, disp_string
))
28485 /* The first row that ends at ZV must be the last to be
28487 else if (next
->ends_at_zv_p
)
28496 /* This function sets the mouse_face_* elements of HLINFO, assuming
28497 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28498 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28499 for the overlay or run of text properties specifying the mouse
28500 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28501 before-string and after-string that must also be highlighted.
28502 DISP_STRING, if non-nil, is a display string that may cover some
28503 or all of the highlighted text. */
28506 mouse_face_from_buffer_pos (Lisp_Object window
,
28507 Mouse_HLInfo
*hlinfo
,
28508 ptrdiff_t mouse_charpos
,
28509 ptrdiff_t start_charpos
,
28510 ptrdiff_t end_charpos
,
28511 Lisp_Object before_string
,
28512 Lisp_Object after_string
,
28513 Lisp_Object disp_string
)
28515 struct window
*w
= XWINDOW (window
);
28516 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28517 struct glyph_row
*r1
, *r2
;
28518 struct glyph
*glyph
, *end
;
28519 ptrdiff_t ignore
, pos
;
28522 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28523 eassert (NILP (before_string
) || STRINGP (before_string
));
28524 eassert (NILP (after_string
) || STRINGP (after_string
));
28526 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28527 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28529 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28530 /* If the before-string or display-string contains newlines,
28531 rows_from_pos_range skips to its last row. Move back. */
28532 if (!NILP (before_string
) || !NILP (disp_string
))
28534 struct glyph_row
*prev
;
28535 while ((prev
= r1
- 1, prev
>= first
)
28536 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28537 && prev
->used
[TEXT_AREA
] > 0)
28539 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28540 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28541 while (--glyph
>= beg
&& NILP (glyph
->object
));
28543 || !(EQ (glyph
->object
, before_string
)
28544 || EQ (glyph
->object
, disp_string
)))
28551 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28552 hlinfo
->mouse_face_past_end
= true;
28554 else if (!NILP (after_string
))
28556 /* If the after-string has newlines, advance to its last row. */
28557 struct glyph_row
*next
;
28558 struct glyph_row
*last
28559 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28561 for (next
= r2
+ 1;
28563 && next
->used
[TEXT_AREA
] > 0
28564 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28568 /* The rest of the display engine assumes that mouse_face_beg_row is
28569 either above mouse_face_end_row or identical to it. But with
28570 bidi-reordered continued lines, the row for START_CHARPOS could
28571 be below the row for END_CHARPOS. If so, swap the rows and store
28572 them in correct order. */
28575 struct glyph_row
*tem
= r2
;
28581 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28582 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28584 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28585 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28586 could be anywhere in the row and in any order. The strategy
28587 below is to find the leftmost and the rightmost glyph that
28588 belongs to either of these 3 strings, or whose position is
28589 between START_CHARPOS and END_CHARPOS, and highlight all the
28590 glyphs between those two. This may cover more than just the text
28591 between START_CHARPOS and END_CHARPOS if the range of characters
28592 strides the bidi level boundary, e.g. if the beginning is in R2L
28593 text while the end is in L2R text or vice versa. */
28594 if (!r1
->reversed_p
)
28596 /* This row is in a left to right paragraph. Scan it left to
28598 glyph
= r1
->glyphs
[TEXT_AREA
];
28599 end
= glyph
+ r1
->used
[TEXT_AREA
];
28602 /* Skip truncation glyphs at the start of the glyph row. */
28603 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28605 && NILP (glyph
->object
)
28606 && glyph
->charpos
< 0;
28608 x
+= glyph
->pixel_width
;
28610 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28611 or DISP_STRING, and the first glyph from buffer whose
28612 position is between START_CHARPOS and END_CHARPOS. */
28614 && !NILP (glyph
->object
)
28615 && !EQ (glyph
->object
, disp_string
)
28616 && !(BUFFERP (glyph
->object
)
28617 && (glyph
->charpos
>= start_charpos
28618 && glyph
->charpos
< end_charpos
));
28621 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28622 are present at buffer positions between START_CHARPOS and
28623 END_CHARPOS, or if they come from an overlay. */
28624 if (EQ (glyph
->object
, before_string
))
28626 pos
= string_buffer_position (before_string
,
28628 /* If pos == 0, it means before_string came from an
28629 overlay, not from a buffer position. */
28630 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28633 else if (EQ (glyph
->object
, after_string
))
28635 pos
= string_buffer_position (after_string
, end_charpos
);
28636 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28639 x
+= glyph
->pixel_width
;
28641 hlinfo
->mouse_face_beg_x
= x
;
28642 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28646 /* This row is in a right to left paragraph. Scan it right to
28650 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28651 glyph
= end
+ r1
->used
[TEXT_AREA
];
28653 /* Skip truncation glyphs at the start of the glyph row. */
28654 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28656 && NILP (glyph
->object
)
28657 && glyph
->charpos
< 0;
28661 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28662 or DISP_STRING, and the first glyph from buffer whose
28663 position is between START_CHARPOS and END_CHARPOS. */
28665 && !NILP (glyph
->object
)
28666 && !EQ (glyph
->object
, disp_string
)
28667 && !(BUFFERP (glyph
->object
)
28668 && (glyph
->charpos
>= start_charpos
28669 && glyph
->charpos
< end_charpos
));
28672 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28673 are present at buffer positions between START_CHARPOS and
28674 END_CHARPOS, or if they come from an overlay. */
28675 if (EQ (glyph
->object
, before_string
))
28677 pos
= string_buffer_position (before_string
, start_charpos
);
28678 /* If pos == 0, it means before_string came from an
28679 overlay, not from a buffer position. */
28680 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28683 else if (EQ (glyph
->object
, after_string
))
28685 pos
= string_buffer_position (after_string
, end_charpos
);
28686 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28691 glyph
++; /* first glyph to the right of the highlighted area */
28692 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28693 x
+= g
->pixel_width
;
28694 hlinfo
->mouse_face_beg_x
= x
;
28695 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28698 /* If the highlight ends in a different row, compute GLYPH and END
28699 for the end row. Otherwise, reuse the values computed above for
28700 the row where the highlight begins. */
28703 if (!r2
->reversed_p
)
28705 glyph
= r2
->glyphs
[TEXT_AREA
];
28706 end
= glyph
+ r2
->used
[TEXT_AREA
];
28711 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28712 glyph
= end
+ r2
->used
[TEXT_AREA
];
28716 if (!r2
->reversed_p
)
28718 /* Skip truncation and continuation glyphs near the end of the
28719 row, and also blanks and stretch glyphs inserted by
28720 extend_face_to_end_of_line. */
28722 && NILP ((end
- 1)->object
))
28724 /* Scan the rest of the glyph row from the end, looking for the
28725 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28726 DISP_STRING, or whose position is between START_CHARPOS
28730 && !NILP (end
->object
)
28731 && !EQ (end
->object
, disp_string
)
28732 && !(BUFFERP (end
->object
)
28733 && (end
->charpos
>= start_charpos
28734 && end
->charpos
< end_charpos
));
28737 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28738 are present at buffer positions between START_CHARPOS and
28739 END_CHARPOS, or if they come from an overlay. */
28740 if (EQ (end
->object
, before_string
))
28742 pos
= string_buffer_position (before_string
, start_charpos
);
28743 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28746 else if (EQ (end
->object
, after_string
))
28748 pos
= string_buffer_position (after_string
, end_charpos
);
28749 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28753 /* Find the X coordinate of the last glyph to be highlighted. */
28754 for (; glyph
<= end
; ++glyph
)
28755 x
+= glyph
->pixel_width
;
28757 hlinfo
->mouse_face_end_x
= x
;
28758 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28762 /* Skip truncation and continuation glyphs near the end of the
28763 row, and also blanks and stretch glyphs inserted by
28764 extend_face_to_end_of_line. */
28768 && NILP (end
->object
))
28770 x
+= end
->pixel_width
;
28773 /* Scan the rest of the glyph row from the end, looking for the
28774 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28775 DISP_STRING, or whose position is between START_CHARPOS
28779 && !NILP (end
->object
)
28780 && !EQ (end
->object
, disp_string
)
28781 && !(BUFFERP (end
->object
)
28782 && (end
->charpos
>= start_charpos
28783 && end
->charpos
< end_charpos
));
28786 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28787 are present at buffer positions between START_CHARPOS and
28788 END_CHARPOS, or if they come from an overlay. */
28789 if (EQ (end
->object
, before_string
))
28791 pos
= string_buffer_position (before_string
, start_charpos
);
28792 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28795 else if (EQ (end
->object
, after_string
))
28797 pos
= string_buffer_position (after_string
, end_charpos
);
28798 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28801 x
+= end
->pixel_width
;
28803 /* If we exited the above loop because we arrived at the last
28804 glyph of the row, and its buffer position is still not in
28805 range, it means the last character in range is the preceding
28806 newline. Bump the end column and x values to get past the
28809 && BUFFERP (end
->object
)
28810 && (end
->charpos
< start_charpos
28811 || end
->charpos
>= end_charpos
))
28813 x
+= end
->pixel_width
;
28816 hlinfo
->mouse_face_end_x
= x
;
28817 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28820 hlinfo
->mouse_face_window
= window
;
28821 hlinfo
->mouse_face_face_id
28822 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28824 !hlinfo
->mouse_face_hidden
, -1);
28825 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28828 /* The following function is not used anymore (replaced with
28829 mouse_face_from_string_pos), but I leave it here for the time
28830 being, in case someone would. */
28832 #if false /* not used */
28834 /* Find the position of the glyph for position POS in OBJECT in
28835 window W's current matrix, and return in *X, *Y the pixel
28836 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28838 RIGHT_P means return the position of the right edge of the glyph.
28839 !RIGHT_P means return the left edge position.
28841 If no glyph for POS exists in the matrix, return the position of
28842 the glyph with the next smaller position that is in the matrix, if
28843 RIGHT_P is false. If RIGHT_P, and no glyph for POS
28844 exists in the matrix, return the position of the glyph with the
28845 next larger position in OBJECT.
28847 Value is true if a glyph was found. */
28850 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28851 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
28853 int yb
= window_text_bottom_y (w
);
28854 struct glyph_row
*r
;
28855 struct glyph
*best_glyph
= NULL
;
28856 struct glyph_row
*best_row
= NULL
;
28859 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28860 r
->enabled_p
&& r
->y
< yb
;
28863 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28864 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28867 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28868 if (EQ (g
->object
, object
))
28870 if (g
->charpos
== pos
)
28877 else if (best_glyph
== NULL
28878 || ((eabs (g
->charpos
- pos
)
28879 < eabs (best_glyph
->charpos
- pos
))
28882 : g
->charpos
> pos
)))
28896 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28900 *x
+= best_glyph
->pixel_width
;
28905 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28908 return best_glyph
!= NULL
;
28910 #endif /* not used */
28912 /* Find the positions of the first and the last glyphs in window W's
28913 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28914 (assumed to be a string), and return in HLINFO's mouse_face_*
28915 members the pixel and column/row coordinates of those glyphs. */
28918 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28919 Lisp_Object object
,
28920 ptrdiff_t startpos
, ptrdiff_t endpos
)
28922 int yb
= window_text_bottom_y (w
);
28923 struct glyph_row
*r
;
28924 struct glyph
*g
, *e
;
28926 bool found
= false;
28928 /* Find the glyph row with at least one position in the range
28929 [STARTPOS..ENDPOS), and the first glyph in that row whose
28930 position belongs to that range. */
28931 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28932 r
->enabled_p
&& r
->y
< yb
;
28935 if (!r
->reversed_p
)
28937 g
= r
->glyphs
[TEXT_AREA
];
28938 e
= g
+ r
->used
[TEXT_AREA
];
28939 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28940 if (EQ (g
->object
, object
)
28941 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28943 hlinfo
->mouse_face_beg_row
28944 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28945 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28946 hlinfo
->mouse_face_beg_x
= gx
;
28955 e
= r
->glyphs
[TEXT_AREA
];
28956 g
= e
+ r
->used
[TEXT_AREA
];
28957 for ( ; g
> e
; --g
)
28958 if (EQ ((g
-1)->object
, object
)
28959 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28961 hlinfo
->mouse_face_beg_row
28962 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28963 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28964 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28965 gx
+= g1
->pixel_width
;
28966 hlinfo
->mouse_face_beg_x
= gx
;
28978 /* Starting with the next row, look for the first row which does NOT
28979 include any glyphs whose positions are in the range. */
28980 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28982 g
= r
->glyphs
[TEXT_AREA
];
28983 e
= g
+ r
->used
[TEXT_AREA
];
28985 for ( ; g
< e
; ++g
)
28986 if (EQ (g
->object
, object
)
28987 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28996 /* The highlighted region ends on the previous row. */
28999 /* Set the end row. */
29000 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29002 /* Compute and set the end column and the end column's horizontal
29003 pixel coordinate. */
29004 if (!r
->reversed_p
)
29006 g
= r
->glyphs
[TEXT_AREA
];
29007 e
= g
+ r
->used
[TEXT_AREA
];
29008 for ( ; e
> g
; --e
)
29009 if (EQ ((e
-1)->object
, object
)
29010 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29012 hlinfo
->mouse_face_end_col
= e
- g
;
29014 for (gx
= r
->x
; g
< e
; ++g
)
29015 gx
+= g
->pixel_width
;
29016 hlinfo
->mouse_face_end_x
= gx
;
29020 e
= r
->glyphs
[TEXT_AREA
];
29021 g
= e
+ r
->used
[TEXT_AREA
];
29022 for (gx
= r
->x
; e
< g
; ++e
)
29024 if (EQ (e
->object
, object
)
29025 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29027 gx
+= e
->pixel_width
;
29029 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29030 hlinfo
->mouse_face_end_x
= gx
;
29034 #ifdef HAVE_WINDOW_SYSTEM
29036 /* See if position X, Y is within a hot-spot of an image. */
29039 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29041 if (!CONSP (hot_spot
))
29044 if (EQ (XCAR (hot_spot
), Qrect
))
29046 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29047 Lisp_Object rect
= XCDR (hot_spot
);
29051 if (!CONSP (XCAR (rect
)))
29053 if (!CONSP (XCDR (rect
)))
29055 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29057 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29059 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29061 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29065 else if (EQ (XCAR (hot_spot
), Qcircle
))
29067 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29068 Lisp_Object circ
= XCDR (hot_spot
);
29069 Lisp_Object lr
, lx0
, ly0
;
29071 && CONSP (XCAR (circ
))
29072 && (lr
= XCDR (circ
), NUMBERP (lr
))
29073 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29074 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29076 double r
= XFLOATINT (lr
);
29077 double dx
= XINT (lx0
) - x
;
29078 double dy
= XINT (ly0
) - y
;
29079 return (dx
* dx
+ dy
* dy
<= r
* r
);
29082 else if (EQ (XCAR (hot_spot
), Qpoly
))
29084 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29085 if (VECTORP (XCDR (hot_spot
)))
29087 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29088 Lisp_Object
*poly
= v
->contents
;
29089 ptrdiff_t n
= v
->header
.size
;
29091 bool inside
= false;
29092 Lisp_Object lx
, ly
;
29095 /* Need an even number of coordinates, and at least 3 edges. */
29096 if (n
< 6 || n
& 1)
29099 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29100 If count is odd, we are inside polygon. Pixels on edges
29101 may or may not be included depending on actual geometry of the
29103 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29104 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29106 x0
= XINT (lx
), y0
= XINT (ly
);
29107 for (i
= 0; i
< n
; i
+= 2)
29109 int x1
= x0
, y1
= y0
;
29110 if ((lx
= poly
[i
], !INTEGERP (lx
))
29111 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29113 x0
= XINT (lx
), y0
= XINT (ly
);
29115 /* Does this segment cross the X line? */
29123 if (y
> y0
&& y
> y1
)
29125 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29135 find_hot_spot (Lisp_Object map
, int x
, int y
)
29137 while (CONSP (map
))
29139 if (CONSP (XCAR (map
))
29140 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29148 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29150 doc
: /* Lookup in image map MAP coordinates X and Y.
29151 An image map is an alist where each element has the format (AREA ID PLIST).
29152 An AREA is specified as either a rectangle, a circle, or a polygon:
29153 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29154 pixel coordinates of the upper left and bottom right corners.
29155 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29156 and the radius of the circle; r may be a float or integer.
29157 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29158 vector describes one corner in the polygon.
29159 Returns the alist element for the first matching AREA in MAP. */)
29160 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29168 return find_hot_spot (map
,
29169 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29170 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29174 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29176 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29178 /* Do not change cursor shape while dragging mouse. */
29179 if (EQ (do_mouse_tracking
, Qdragging
))
29182 if (!NILP (pointer
))
29184 if (EQ (pointer
, Qarrow
))
29185 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29186 else if (EQ (pointer
, Qhand
))
29187 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29188 else if (EQ (pointer
, Qtext
))
29189 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29190 else if (EQ (pointer
, intern ("hdrag")))
29191 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29192 else if (EQ (pointer
, intern ("nhdrag")))
29193 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29194 #ifdef HAVE_X_WINDOWS
29195 else if (EQ (pointer
, intern ("vdrag")))
29196 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29198 else if (EQ (pointer
, intern ("hourglass")))
29199 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29200 else if (EQ (pointer
, Qmodeline
))
29201 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29203 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29206 if (cursor
!= No_Cursor
)
29207 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29210 #endif /* HAVE_WINDOW_SYSTEM */
29212 /* Take proper action when mouse has moved to the mode or header line
29213 or marginal area AREA of window W, x-position X and y-position Y.
29214 X is relative to the start of the text display area of W, so the
29215 width of bitmap areas and scroll bars must be subtracted to get a
29216 position relative to the start of the mode line. */
29219 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29220 enum window_part area
)
29222 struct window
*w
= XWINDOW (window
);
29223 struct frame
*f
= XFRAME (w
->frame
);
29224 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29225 #ifdef HAVE_WINDOW_SYSTEM
29226 Display_Info
*dpyinfo
;
29228 Cursor cursor
= No_Cursor
;
29229 Lisp_Object pointer
= Qnil
;
29230 int dx
, dy
, width
, height
;
29232 Lisp_Object string
, object
= Qnil
;
29233 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29235 Lisp_Object mouse_face
;
29236 int original_x_pixel
= x
;
29237 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29238 struct glyph_row
*row
IF_LINT (= 0);
29240 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29245 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29246 returns them in row/column units! */
29247 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29248 &object
, &dx
, &dy
, &width
, &height
);
29250 row
= (area
== ON_MODE_LINE
29251 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29252 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29254 /* Find the glyph under the mouse pointer. */
29255 if (row
->mode_line_p
&& row
->enabled_p
)
29257 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29258 end
= glyph
+ row
->used
[TEXT_AREA
];
29260 for (x0
= original_x_pixel
;
29261 glyph
< end
&& x0
>= glyph
->pixel_width
;
29263 x0
-= glyph
->pixel_width
;
29271 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29272 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29273 returns them in row/column units! */
29274 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29275 &object
, &dx
, &dy
, &width
, &height
);
29280 #ifdef HAVE_WINDOW_SYSTEM
29281 if (IMAGEP (object
))
29283 Lisp_Object image_map
, hotspot
;
29284 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29286 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29288 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29292 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29293 If so, we could look for mouse-enter, mouse-leave
29294 properties in PLIST (and do something...). */
29295 hotspot
= XCDR (hotspot
);
29296 if (CONSP (hotspot
)
29297 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29299 pointer
= Fplist_get (plist
, Qpointer
);
29300 if (NILP (pointer
))
29302 help
= Fplist_get (plist
, Qhelp_echo
);
29305 help_echo_string
= help
;
29306 XSETWINDOW (help_echo_window
, w
);
29307 help_echo_object
= w
->contents
;
29308 help_echo_pos
= charpos
;
29312 if (NILP (pointer
))
29313 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29315 #endif /* HAVE_WINDOW_SYSTEM */
29317 if (STRINGP (string
))
29318 pos
= make_number (charpos
);
29320 /* Set the help text and mouse pointer. If the mouse is on a part
29321 of the mode line without any text (e.g. past the right edge of
29322 the mode line text), use the default help text and pointer. */
29323 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29325 /* Arrange to display the help by setting the global variables
29326 help_echo_string, help_echo_object, and help_echo_pos. */
29329 if (STRINGP (string
))
29330 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29334 help_echo_string
= help
;
29335 XSETWINDOW (help_echo_window
, w
);
29336 help_echo_object
= string
;
29337 help_echo_pos
= charpos
;
29339 else if (area
== ON_MODE_LINE
)
29341 Lisp_Object default_help
29342 = buffer_local_value (Qmode_line_default_help_echo
,
29345 if (STRINGP (default_help
))
29347 help_echo_string
= default_help
;
29348 XSETWINDOW (help_echo_window
, w
);
29349 help_echo_object
= Qnil
;
29350 help_echo_pos
= -1;
29355 #ifdef HAVE_WINDOW_SYSTEM
29356 /* Change the mouse pointer according to what is under it. */
29357 if (FRAME_WINDOW_P (f
))
29359 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29361 || NILP (Vresize_mini_windows
));
29363 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29364 if (STRINGP (string
))
29366 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29368 if (NILP (pointer
))
29369 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29371 /* Change the mouse pointer according to what is under X/Y. */
29373 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29376 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29377 if (!KEYMAPP (map
))
29378 map
= Fget_text_property (pos
, Qkeymap
, string
);
29379 if (!KEYMAPP (map
) && draggable
)
29380 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29383 else if (draggable
)
29384 /* Default mode-line pointer. */
29385 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29390 /* Change the mouse face according to what is under X/Y. */
29391 bool mouse_face_shown
= false;
29392 if (STRINGP (string
))
29394 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29395 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29396 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29401 struct glyph
* tmp_glyph
;
29405 int total_pixel_width
;
29406 ptrdiff_t begpos
, endpos
, ignore
;
29410 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29411 Qmouse_face
, string
, Qnil
);
29417 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29419 endpos
= SCHARS (string
);
29423 /* Calculate the glyph position GPOS of GLYPH in the
29424 displayed string, relative to the beginning of the
29425 highlighted part of the string.
29427 Note: GPOS is different from CHARPOS. CHARPOS is the
29428 position of GLYPH in the internal string object. A mode
29429 line string format has structures which are converted to
29430 a flattened string by the Emacs Lisp interpreter. The
29431 internal string is an element of those structures. The
29432 displayed string is the flattened string. */
29433 tmp_glyph
= row_start_glyph
;
29434 while (tmp_glyph
< glyph
29435 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29436 && begpos
<= tmp_glyph
->charpos
29437 && tmp_glyph
->charpos
< endpos
)))
29439 gpos
= glyph
- tmp_glyph
;
29441 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29442 the highlighted part of the displayed string to which
29443 GLYPH belongs. Note: GSEQ_LENGTH is different from
29444 SCHARS (STRING), because the latter returns the length of
29445 the internal string. */
29446 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29448 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29449 && begpos
<= tmp_glyph
->charpos
29450 && tmp_glyph
->charpos
< endpos
));
29453 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29455 /* Calculate the total pixel width of all the glyphs between
29456 the beginning of the highlighted area and GLYPH. */
29457 total_pixel_width
= 0;
29458 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29459 total_pixel_width
+= tmp_glyph
->pixel_width
;
29461 /* Pre calculation of re-rendering position. Note: X is in
29462 column units here, after the call to mode_line_string or
29463 marginal_area_string. */
29465 vpos
= (area
== ON_MODE_LINE
29466 ? (w
->current_matrix
)->nrows
- 1
29469 /* If GLYPH's position is included in the region that is
29470 already drawn in mouse face, we have nothing to do. */
29471 if ( EQ (window
, hlinfo
->mouse_face_window
)
29472 && (!row
->reversed_p
29473 ? (hlinfo
->mouse_face_beg_col
<= hpos
29474 && hpos
< hlinfo
->mouse_face_end_col
)
29475 /* In R2L rows we swap BEG and END, see below. */
29476 : (hlinfo
->mouse_face_end_col
<= hpos
29477 && hpos
< hlinfo
->mouse_face_beg_col
))
29478 && hlinfo
->mouse_face_beg_row
== vpos
)
29481 if (clear_mouse_face (hlinfo
))
29482 cursor
= No_Cursor
;
29484 if (!row
->reversed_p
)
29486 hlinfo
->mouse_face_beg_col
= hpos
;
29487 hlinfo
->mouse_face_beg_x
= original_x_pixel
29488 - (total_pixel_width
+ dx
);
29489 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29490 hlinfo
->mouse_face_end_x
= 0;
29494 /* In R2L rows, show_mouse_face expects BEG and END
29495 coordinates to be swapped. */
29496 hlinfo
->mouse_face_end_col
= hpos
;
29497 hlinfo
->mouse_face_end_x
= original_x_pixel
29498 - (total_pixel_width
+ dx
);
29499 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29500 hlinfo
->mouse_face_beg_x
= 0;
29503 hlinfo
->mouse_face_beg_row
= vpos
;
29504 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29505 hlinfo
->mouse_face_past_end
= false;
29506 hlinfo
->mouse_face_window
= window
;
29508 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29513 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29514 mouse_face_shown
= true;
29516 if (NILP (pointer
))
29521 /* If mouse-face doesn't need to be shown, clear any existing
29523 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29524 clear_mouse_face (hlinfo
);
29526 #ifdef HAVE_WINDOW_SYSTEM
29527 if (FRAME_WINDOW_P (f
))
29528 define_frame_cursor1 (f
, cursor
, pointer
);
29534 Take proper action when the mouse has moved to position X, Y on
29535 frame F with regards to highlighting portions of display that have
29536 mouse-face properties. Also de-highlight portions of display where
29537 the mouse was before, set the mouse pointer shape as appropriate
29538 for the mouse coordinates, and activate help echo (tooltips).
29539 X and Y can be negative or out of range. */
29542 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29544 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29545 enum window_part part
= ON_NOTHING
;
29546 Lisp_Object window
;
29548 Cursor cursor
= No_Cursor
;
29549 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29552 /* When a menu is active, don't highlight because this looks odd. */
29553 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29554 if (popup_activated ())
29558 if (!f
->glyphs_initialized_p
29559 || f
->pointer_invisible
)
29562 hlinfo
->mouse_face_mouse_x
= x
;
29563 hlinfo
->mouse_face_mouse_y
= y
;
29564 hlinfo
->mouse_face_mouse_frame
= f
;
29566 if (hlinfo
->mouse_face_defer
)
29569 /* Which window is that in? */
29570 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29572 /* If displaying active text in another window, clear that. */
29573 if (! EQ (window
, hlinfo
->mouse_face_window
)
29574 /* Also clear if we move out of text area in same window. */
29575 || (!NILP (hlinfo
->mouse_face_window
)
29578 && part
!= ON_MODE_LINE
29579 && part
!= ON_HEADER_LINE
))
29580 clear_mouse_face (hlinfo
);
29582 /* Not on a window -> return. */
29583 if (!WINDOWP (window
))
29586 /* Reset help_echo_string. It will get recomputed below. */
29587 help_echo_string
= Qnil
;
29589 /* Convert to window-relative pixel coordinates. */
29590 w
= XWINDOW (window
);
29591 frame_to_window_pixel_xy (w
, &x
, &y
);
29593 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29594 /* Handle tool-bar window differently since it doesn't display a
29596 if (EQ (window
, f
->tool_bar_window
))
29598 note_tool_bar_highlight (f
, x
, y
);
29603 /* Mouse is on the mode, header line or margin? */
29604 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29605 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29607 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29609 #ifdef HAVE_WINDOW_SYSTEM
29610 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29612 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29613 /* Show non-text cursor (Bug#16647). */
29621 #ifdef HAVE_WINDOW_SYSTEM
29622 if (part
== ON_VERTICAL_BORDER
)
29624 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29625 help_echo_string
= build_string ("drag-mouse-1: resize");
29627 else if (part
== ON_RIGHT_DIVIDER
)
29629 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29630 help_echo_string
= build_string ("drag-mouse-1: resize");
29632 else if (part
== ON_BOTTOM_DIVIDER
)
29633 if (! WINDOW_BOTTOMMOST_P (w
)
29635 || NILP (Vresize_mini_windows
))
29637 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29638 help_echo_string
= build_string ("drag-mouse-1: resize");
29641 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29642 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29643 || part
== ON_VERTICAL_SCROLL_BAR
29644 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29645 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29647 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29650 /* Are we in a window whose display is up to date?
29651 And verify the buffer's text has not changed. */
29652 b
= XBUFFER (w
->contents
);
29653 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29655 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29657 struct glyph
*glyph
;
29658 Lisp_Object object
;
29659 Lisp_Object mouse_face
= Qnil
, position
;
29660 Lisp_Object
*overlay_vec
= NULL
;
29661 ptrdiff_t i
, noverlays
;
29662 struct buffer
*obuf
;
29663 ptrdiff_t obegv
, ozv
;
29666 /* Find the glyph under X/Y. */
29667 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29669 #ifdef HAVE_WINDOW_SYSTEM
29670 /* Look for :pointer property on image. */
29671 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29673 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29674 if (img
!= NULL
&& IMAGEP (img
->spec
))
29676 Lisp_Object image_map
, hotspot
;
29677 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29679 && (hotspot
= find_hot_spot (image_map
,
29680 glyph
->slice
.img
.x
+ dx
,
29681 glyph
->slice
.img
.y
+ dy
),
29683 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29687 /* Could check XCAR (hotspot) to see if we enter/leave
29689 If so, we could look for mouse-enter, mouse-leave
29690 properties in PLIST (and do something...). */
29691 hotspot
= XCDR (hotspot
);
29692 if (CONSP (hotspot
)
29693 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29695 pointer
= Fplist_get (plist
, Qpointer
);
29696 if (NILP (pointer
))
29698 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29699 if (!NILP (help_echo_string
))
29701 help_echo_window
= window
;
29702 help_echo_object
= glyph
->object
;
29703 help_echo_pos
= glyph
->charpos
;
29707 if (NILP (pointer
))
29708 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29711 #endif /* HAVE_WINDOW_SYSTEM */
29713 /* Clear mouse face if X/Y not over text. */
29715 || area
!= TEXT_AREA
29716 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29717 /* Glyph's OBJECT is nil for glyphs inserted by the
29718 display engine for its internal purposes, like truncation
29719 and continuation glyphs and blanks beyond the end of
29720 line's text on text terminals. If we are over such a
29721 glyph, we are not over any text. */
29722 || NILP (glyph
->object
)
29723 /* R2L rows have a stretch glyph at their front, which
29724 stands for no text, whereas L2R rows have no glyphs at
29725 all beyond the end of text. Treat such stretch glyphs
29726 like we do with NULL glyphs in L2R rows. */
29727 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29728 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29729 && glyph
->type
== STRETCH_GLYPH
29730 && glyph
->avoid_cursor_p
))
29732 if (clear_mouse_face (hlinfo
))
29733 cursor
= No_Cursor
;
29734 #ifdef HAVE_WINDOW_SYSTEM
29735 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29737 if (area
!= TEXT_AREA
)
29738 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29740 pointer
= Vvoid_text_area_pointer
;
29746 pos
= glyph
->charpos
;
29747 object
= glyph
->object
;
29748 if (!STRINGP (object
) && !BUFFERP (object
))
29751 /* If we get an out-of-range value, return now; avoid an error. */
29752 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29755 /* Make the window's buffer temporarily current for
29756 overlays_at and compute_char_face. */
29757 obuf
= current_buffer
;
29758 current_buffer
= b
;
29764 /* Is this char mouse-active or does it have help-echo? */
29765 position
= make_number (pos
);
29769 if (BUFFERP (object
))
29771 /* Put all the overlays we want in a vector in overlay_vec. */
29772 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
29773 /* Sort overlays into increasing priority order. */
29774 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29779 if (NILP (Vmouse_highlight
))
29781 clear_mouse_face (hlinfo
);
29782 goto check_help_echo
;
29785 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29788 cursor
= No_Cursor
;
29790 /* Check mouse-face highlighting. */
29792 /* If there exists an overlay with mouse-face overlapping
29793 the one we are currently highlighting, we have to
29794 check if we enter the overlapping overlay, and then
29795 highlight only that. */
29796 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29797 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29799 /* Find the highest priority overlay with a mouse-face. */
29800 Lisp_Object overlay
= Qnil
;
29801 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29803 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29804 if (!NILP (mouse_face
))
29805 overlay
= overlay_vec
[i
];
29808 /* If we're highlighting the same overlay as before, there's
29809 no need to do that again. */
29810 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29811 goto check_help_echo
;
29812 hlinfo
->mouse_face_overlay
= overlay
;
29814 /* Clear the display of the old active region, if any. */
29815 if (clear_mouse_face (hlinfo
))
29816 cursor
= No_Cursor
;
29818 /* If no overlay applies, get a text property. */
29819 if (NILP (overlay
))
29820 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29822 /* Next, compute the bounds of the mouse highlighting and
29824 if (!NILP (mouse_face
) && STRINGP (object
))
29826 /* The mouse-highlighting comes from a display string
29827 with a mouse-face. */
29831 s
= Fprevious_single_property_change
29832 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29833 e
= Fnext_single_property_change
29834 (position
, Qmouse_face
, object
, Qnil
);
29836 s
= make_number (0);
29838 e
= make_number (SCHARS (object
));
29839 mouse_face_from_string_pos (w
, hlinfo
, object
,
29840 XINT (s
), XINT (e
));
29841 hlinfo
->mouse_face_past_end
= false;
29842 hlinfo
->mouse_face_window
= window
;
29843 hlinfo
->mouse_face_face_id
29844 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29845 glyph
->face_id
, true);
29846 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29847 cursor
= No_Cursor
;
29851 /* The mouse-highlighting, if any, comes from an overlay
29852 or text property in the buffer. */
29853 Lisp_Object buffer
IF_LINT (= Qnil
);
29854 Lisp_Object disp_string
IF_LINT (= Qnil
);
29856 if (STRINGP (object
))
29858 /* If we are on a display string with no mouse-face,
29859 check if the text under it has one. */
29860 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29861 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29862 pos
= string_buffer_position (object
, start
);
29865 mouse_face
= get_char_property_and_overlay
29866 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29867 buffer
= w
->contents
;
29868 disp_string
= object
;
29874 disp_string
= Qnil
;
29877 if (!NILP (mouse_face
))
29879 Lisp_Object before
, after
;
29880 Lisp_Object before_string
, after_string
;
29881 /* To correctly find the limits of mouse highlight
29882 in a bidi-reordered buffer, we must not use the
29883 optimization of limiting the search in
29884 previous-single-property-change and
29885 next-single-property-change, because
29886 rows_from_pos_range needs the real start and end
29887 positions to DTRT in this case. That's because
29888 the first row visible in a window does not
29889 necessarily display the character whose position
29890 is the smallest. */
29892 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29893 ? Fmarker_position (w
->start
)
29896 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29897 ? make_number (BUF_Z (XBUFFER (buffer
))
29898 - w
->window_end_pos
)
29901 if (NILP (overlay
))
29903 /* Handle the text property case. */
29904 before
= Fprevious_single_property_change
29905 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29906 after
= Fnext_single_property_change
29907 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29908 before_string
= after_string
= Qnil
;
29912 /* Handle the overlay case. */
29913 before
= Foverlay_start (overlay
);
29914 after
= Foverlay_end (overlay
);
29915 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29916 after_string
= Foverlay_get (overlay
, Qafter_string
);
29918 if (!STRINGP (before_string
)) before_string
= Qnil
;
29919 if (!STRINGP (after_string
)) after_string
= Qnil
;
29922 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29925 : XFASTINT (before
),
29927 ? BUF_Z (XBUFFER (buffer
))
29928 : XFASTINT (after
),
29929 before_string
, after_string
,
29931 cursor
= No_Cursor
;
29938 /* Look for a `help-echo' property. */
29939 if (NILP (help_echo_string
)) {
29940 Lisp_Object help
, overlay
;
29942 /* Check overlays first. */
29943 help
= overlay
= Qnil
;
29944 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29946 overlay
= overlay_vec
[i
];
29947 help
= Foverlay_get (overlay
, Qhelp_echo
);
29952 help_echo_string
= help
;
29953 help_echo_window
= window
;
29954 help_echo_object
= overlay
;
29955 help_echo_pos
= pos
;
29959 Lisp_Object obj
= glyph
->object
;
29960 ptrdiff_t charpos
= glyph
->charpos
;
29962 /* Try text properties. */
29965 && charpos
< SCHARS (obj
))
29967 help
= Fget_text_property (make_number (charpos
),
29971 /* If the string itself doesn't specify a help-echo,
29972 see if the buffer text ``under'' it does. */
29973 struct glyph_row
*r
29974 = MATRIX_ROW (w
->current_matrix
, vpos
);
29975 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29976 ptrdiff_t p
= string_buffer_position (obj
, start
);
29979 help
= Fget_char_property (make_number (p
),
29980 Qhelp_echo
, w
->contents
);
29989 else if (BUFFERP (obj
)
29992 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29997 help_echo_string
= help
;
29998 help_echo_window
= window
;
29999 help_echo_object
= obj
;
30000 help_echo_pos
= charpos
;
30005 #ifdef HAVE_WINDOW_SYSTEM
30006 /* Look for a `pointer' property. */
30007 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30009 /* Check overlays first. */
30010 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30011 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30013 if (NILP (pointer
))
30015 Lisp_Object obj
= glyph
->object
;
30016 ptrdiff_t charpos
= glyph
->charpos
;
30018 /* Try text properties. */
30021 && charpos
< SCHARS (obj
))
30023 pointer
= Fget_text_property (make_number (charpos
),
30025 if (NILP (pointer
))
30027 /* If the string itself doesn't specify a pointer,
30028 see if the buffer text ``under'' it does. */
30029 struct glyph_row
*r
30030 = MATRIX_ROW (w
->current_matrix
, vpos
);
30031 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30032 ptrdiff_t p
= string_buffer_position (obj
, start
);
30034 pointer
= Fget_char_property (make_number (p
),
30035 Qpointer
, w
->contents
);
30038 else if (BUFFERP (obj
)
30041 pointer
= Fget_text_property (make_number (charpos
),
30045 #endif /* HAVE_WINDOW_SYSTEM */
30049 current_buffer
= obuf
;
30055 #ifdef HAVE_WINDOW_SYSTEM
30056 if (FRAME_WINDOW_P (f
))
30057 define_frame_cursor1 (f
, cursor
, pointer
);
30059 /* This is here to prevent a compiler error, about "label at end of
30060 compound statement". */
30067 Clear any mouse-face on window W. This function is part of the
30068 redisplay interface, and is called from try_window_id and similar
30069 functions to ensure the mouse-highlight is off. */
30072 x_clear_window_mouse_face (struct window
*w
)
30074 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30075 Lisp_Object window
;
30078 XSETWINDOW (window
, w
);
30079 if (EQ (window
, hlinfo
->mouse_face_window
))
30080 clear_mouse_face (hlinfo
);
30086 Just discard the mouse face information for frame F, if any.
30087 This is used when the size of F is changed. */
30090 cancel_mouse_face (struct frame
*f
)
30092 Lisp_Object window
;
30093 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30095 window
= hlinfo
->mouse_face_window
;
30096 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30097 reset_mouse_highlight (hlinfo
);
30102 /***********************************************************************
30104 ***********************************************************************/
30106 #ifdef HAVE_WINDOW_SYSTEM
30108 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30109 which intersects rectangle R. R is in window-relative coordinates. */
30112 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30113 enum glyph_row_area area
)
30115 struct glyph
*first
= row
->glyphs
[area
];
30116 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30117 struct glyph
*last
;
30118 int first_x
, start_x
, x
;
30120 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30121 /* If row extends face to end of line write the whole line. */
30122 draw_glyphs (w
, 0, row
, area
,
30123 0, row
->used
[area
],
30124 DRAW_NORMAL_TEXT
, 0);
30127 /* Set START_X to the window-relative start position for drawing glyphs of
30128 AREA. The first glyph of the text area can be partially visible.
30129 The first glyphs of other areas cannot. */
30130 start_x
= window_box_left_offset (w
, area
);
30132 if (area
== TEXT_AREA
)
30135 /* Find the first glyph that must be redrawn. */
30137 && x
+ first
->pixel_width
< r
->x
)
30139 x
+= first
->pixel_width
;
30143 /* Find the last one. */
30146 /* Use a signed int intermediate value to avoid catastrophic
30147 failures due to comparison between signed and unsigned, when
30148 x is negative (can happen for wide images that are hscrolled). */
30149 int r_end
= r
->x
+ r
->width
;
30150 while (last
< end
&& x
< r_end
)
30152 x
+= last
->pixel_width
;
30158 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30159 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30160 DRAW_NORMAL_TEXT
, 0);
30165 /* Redraw the parts of the glyph row ROW on window W intersecting
30166 rectangle R. R is in window-relative coordinates. Value is
30167 true if mouse-face was overwritten. */
30170 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30172 eassert (row
->enabled_p
);
30174 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30175 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30176 0, row
->used
[TEXT_AREA
],
30177 DRAW_NORMAL_TEXT
, 0);
30180 if (row
->used
[LEFT_MARGIN_AREA
])
30181 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30182 if (row
->used
[TEXT_AREA
])
30183 expose_area (w
, row
, r
, TEXT_AREA
);
30184 if (row
->used
[RIGHT_MARGIN_AREA
])
30185 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30186 draw_row_fringe_bitmaps (w
, row
);
30189 return row
->mouse_face_p
;
30193 /* Redraw those parts of glyphs rows during expose event handling that
30194 overlap other rows. Redrawing of an exposed line writes over parts
30195 of lines overlapping that exposed line; this function fixes that.
30197 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30198 row in W's current matrix that is exposed and overlaps other rows.
30199 LAST_OVERLAPPING_ROW is the last such row. */
30202 expose_overlaps (struct window
*w
,
30203 struct glyph_row
*first_overlapping_row
,
30204 struct glyph_row
*last_overlapping_row
,
30207 struct glyph_row
*row
;
30209 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30210 if (row
->overlapping_p
)
30212 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30215 if (row
->used
[LEFT_MARGIN_AREA
])
30216 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30218 if (row
->used
[TEXT_AREA
])
30219 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30221 if (row
->used
[RIGHT_MARGIN_AREA
])
30222 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30228 /* Return true if W's cursor intersects rectangle R. */
30231 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30233 XRectangle cr
, result
;
30234 struct glyph
*cursor_glyph
;
30235 struct glyph_row
*row
;
30237 if (w
->phys_cursor
.vpos
>= 0
30238 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30239 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30241 && row
->cursor_in_fringe_p
)
30243 /* Cursor is in the fringe. */
30244 cr
.x
= window_box_right_offset (w
,
30245 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30246 ? RIGHT_MARGIN_AREA
30249 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30250 cr
.height
= row
->height
;
30251 return x_intersect_rectangles (&cr
, r
, &result
);
30254 cursor_glyph
= get_phys_cursor_glyph (w
);
30257 /* r is relative to W's box, but w->phys_cursor.x is relative
30258 to left edge of W's TEXT area. Adjust it. */
30259 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30260 cr
.y
= w
->phys_cursor
.y
;
30261 cr
.width
= cursor_glyph
->pixel_width
;
30262 cr
.height
= w
->phys_cursor_height
;
30263 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30264 I assume the effect is the same -- and this is portable. */
30265 return x_intersect_rectangles (&cr
, r
, &result
);
30267 /* If we don't understand the format, pretend we're not in the hot-spot. */
30273 Draw a vertical window border to the right of window W if W doesn't
30274 have vertical scroll bars. */
30277 x_draw_vertical_border (struct window
*w
)
30279 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30281 /* We could do better, if we knew what type of scroll-bar the adjacent
30282 windows (on either side) have... But we don't :-(
30283 However, I think this works ok. ++KFS 2003-04-25 */
30285 /* Redraw borders between horizontally adjacent windows. Don't
30286 do it for frames with vertical scroll bars because either the
30287 right scroll bar of a window, or the left scroll bar of its
30288 neighbor will suffice as a border. */
30289 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30292 /* Note: It is necessary to redraw both the left and the right
30293 borders, for when only this single window W is being
30295 if (!WINDOW_RIGHTMOST_P (w
)
30296 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30298 int x0
, x1
, y0
, y1
;
30300 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30303 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30306 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30309 if (!WINDOW_LEFTMOST_P (w
)
30310 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30312 int x0
, x1
, y0
, y1
;
30314 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30317 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30320 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30325 /* Draw window dividers for window W. */
30328 x_draw_right_divider (struct window
*w
)
30330 struct frame
*f
= WINDOW_XFRAME (w
);
30332 if (w
->mini
|| w
->pseudo_window_p
)
30334 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30336 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30337 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30338 int y0
= WINDOW_TOP_EDGE_Y (w
);
30339 /* The bottom divider prevails. */
30340 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30342 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30347 x_draw_bottom_divider (struct window
*w
)
30349 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30351 if (w
->mini
|| w
->pseudo_window_p
)
30353 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30355 int x0
= WINDOW_LEFT_EDGE_X (w
);
30356 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30357 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30358 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30360 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30364 /* Redraw the part of window W intersection rectangle FR. Pixel
30365 coordinates in FR are frame-relative. Call this function with
30366 input blocked. Value is true if the exposure overwrites
30370 expose_window (struct window
*w
, XRectangle
*fr
)
30372 struct frame
*f
= XFRAME (w
->frame
);
30374 bool mouse_face_overwritten_p
= false;
30376 /* If window is not yet fully initialized, do nothing. This can
30377 happen when toolkit scroll bars are used and a window is split.
30378 Reconfiguring the scroll bar will generate an expose for a newly
30380 if (w
->current_matrix
== NULL
)
30383 /* When we're currently updating the window, display and current
30384 matrix usually don't agree. Arrange for a thorough display
30386 if (w
->must_be_updated_p
)
30388 SET_FRAME_GARBAGED (f
);
30392 /* Frame-relative pixel rectangle of W. */
30393 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30394 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30395 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30396 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30398 if (x_intersect_rectangles (fr
, &wr
, &r
))
30400 int yb
= window_text_bottom_y (w
);
30401 struct glyph_row
*row
;
30402 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30404 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30405 r
.x
, r
.y
, r
.width
, r
.height
));
30407 /* Convert to window coordinates. */
30408 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30409 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30411 /* Turn off the cursor. */
30412 bool cursor_cleared_p
= (!w
->pseudo_window_p
30413 && phys_cursor_in_rect_p (w
, &r
));
30414 if (cursor_cleared_p
)
30415 x_clear_cursor (w
);
30417 /* If the row containing the cursor extends face to end of line,
30418 then expose_area might overwrite the cursor outside the
30419 rectangle and thus notice_overwritten_cursor might clear
30420 w->phys_cursor_on_p. We remember the original value and
30421 check later if it is changed. */
30422 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30424 /* Use a signed int intermediate value to avoid catastrophic
30425 failures due to comparison between signed and unsigned, when
30426 y0 or y1 is negative (can happen for tall images). */
30427 int r_bottom
= r
.y
+ r
.height
;
30429 /* Update lines intersecting rectangle R. */
30430 first_overlapping_row
= last_overlapping_row
= NULL
;
30431 for (row
= w
->current_matrix
->rows
;
30436 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30438 if ((y0
>= r
.y
&& y0
< r_bottom
)
30439 || (y1
> r
.y
&& y1
< r_bottom
)
30440 || (r
.y
>= y0
&& r
.y
< y1
)
30441 || (r_bottom
> y0
&& r_bottom
< y1
))
30443 /* A header line may be overlapping, but there is no need
30444 to fix overlapping areas for them. KFS 2005-02-12 */
30445 if (row
->overlapping_p
&& !row
->mode_line_p
)
30447 if (first_overlapping_row
== NULL
)
30448 first_overlapping_row
= row
;
30449 last_overlapping_row
= row
;
30453 if (expose_line (w
, row
, &r
))
30454 mouse_face_overwritten_p
= true;
30457 else if (row
->overlapping_p
)
30459 /* We must redraw a row overlapping the exposed area. */
30461 ? y0
+ row
->phys_height
> r
.y
30462 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30464 if (first_overlapping_row
== NULL
)
30465 first_overlapping_row
= row
;
30466 last_overlapping_row
= row
;
30474 /* Display the mode line if there is one. */
30475 if (WINDOW_WANTS_MODELINE_P (w
)
30476 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30478 && row
->y
< r_bottom
)
30480 if (expose_line (w
, row
, &r
))
30481 mouse_face_overwritten_p
= true;
30484 if (!w
->pseudo_window_p
)
30486 /* Fix the display of overlapping rows. */
30487 if (first_overlapping_row
)
30488 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30491 /* Draw border between windows. */
30492 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30493 x_draw_right_divider (w
);
30495 x_draw_vertical_border (w
);
30497 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30498 x_draw_bottom_divider (w
);
30500 /* Turn the cursor on again. */
30501 if (cursor_cleared_p
30502 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30503 update_window_cursor (w
, true);
30507 return mouse_face_overwritten_p
;
30512 /* Redraw (parts) of all windows in the window tree rooted at W that
30513 intersect R. R contains frame pixel coordinates. Value is
30514 true if the exposure overwrites mouse-face. */
30517 expose_window_tree (struct window
*w
, XRectangle
*r
)
30519 struct frame
*f
= XFRAME (w
->frame
);
30520 bool mouse_face_overwritten_p
= false;
30522 while (w
&& !FRAME_GARBAGED_P (f
))
30524 mouse_face_overwritten_p
30525 |= (WINDOWP (w
->contents
)
30526 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30527 : expose_window (w
, r
));
30529 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30532 return mouse_face_overwritten_p
;
30537 Redisplay an exposed area of frame F. X and Y are the upper-left
30538 corner of the exposed rectangle. W and H are width and height of
30539 the exposed area. All are pixel values. W or H zero means redraw
30540 the entire frame. */
30543 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30546 bool mouse_face_overwritten_p
= false;
30548 TRACE ((stderr
, "expose_frame "));
30550 /* No need to redraw if frame will be redrawn soon. */
30551 if (FRAME_GARBAGED_P (f
))
30553 TRACE ((stderr
, " garbaged\n"));
30557 /* If basic faces haven't been realized yet, there is no point in
30558 trying to redraw anything. This can happen when we get an expose
30559 event while Emacs is starting, e.g. by moving another window. */
30560 if (FRAME_FACE_CACHE (f
) == NULL
30561 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30563 TRACE ((stderr
, " no faces\n"));
30567 if (w
== 0 || h
== 0)
30570 r
.width
= FRAME_TEXT_WIDTH (f
);
30571 r
.height
= FRAME_TEXT_HEIGHT (f
);
30581 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30582 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30584 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30585 if (WINDOWP (f
->tool_bar_window
))
30586 mouse_face_overwritten_p
30587 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30590 #ifdef HAVE_X_WINDOWS
30592 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30593 if (WINDOWP (f
->menu_bar_window
))
30594 mouse_face_overwritten_p
30595 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30596 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30600 /* Some window managers support a focus-follows-mouse style with
30601 delayed raising of frames. Imagine a partially obscured frame,
30602 and moving the mouse into partially obscured mouse-face on that
30603 frame. The visible part of the mouse-face will be highlighted,
30604 then the WM raises the obscured frame. With at least one WM, KDE
30605 2.1, Emacs is not getting any event for the raising of the frame
30606 (even tried with SubstructureRedirectMask), only Expose events.
30607 These expose events will draw text normally, i.e. not
30608 highlighted. Which means we must redo the highlight here.
30609 Subsume it under ``we love X''. --gerd 2001-08-15 */
30610 /* Included in Windows version because Windows most likely does not
30611 do the right thing if any third party tool offers
30612 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30613 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30615 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30616 if (f
== hlinfo
->mouse_face_mouse_frame
)
30618 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30619 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30620 clear_mouse_face (hlinfo
);
30621 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30628 Determine the intersection of two rectangles R1 and R2. Return
30629 the intersection in *RESULT. Value is true if RESULT is not
30633 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30635 XRectangle
*left
, *right
;
30636 XRectangle
*upper
, *lower
;
30637 bool intersection_p
= false;
30639 /* Rearrange so that R1 is the left-most rectangle. */
30641 left
= r1
, right
= r2
;
30643 left
= r2
, right
= r1
;
30645 /* X0 of the intersection is right.x0, if this is inside R1,
30646 otherwise there is no intersection. */
30647 if (right
->x
<= left
->x
+ left
->width
)
30649 result
->x
= right
->x
;
30651 /* The right end of the intersection is the minimum of
30652 the right ends of left and right. */
30653 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30656 /* Same game for Y. */
30658 upper
= r1
, lower
= r2
;
30660 upper
= r2
, lower
= r1
;
30662 /* The upper end of the intersection is lower.y0, if this is inside
30663 of upper. Otherwise, there is no intersection. */
30664 if (lower
->y
<= upper
->y
+ upper
->height
)
30666 result
->y
= lower
->y
;
30668 /* The lower end of the intersection is the minimum of the lower
30669 ends of upper and lower. */
30670 result
->height
= (min (lower
->y
+ lower
->height
,
30671 upper
->y
+ upper
->height
)
30673 intersection_p
= true;
30677 return intersection_p
;
30680 #endif /* HAVE_WINDOW_SYSTEM */
30683 /***********************************************************************
30685 ***********************************************************************/
30688 syms_of_xdisp (void)
30690 Vwith_echo_area_save_vector
= Qnil
;
30691 staticpro (&Vwith_echo_area_save_vector
);
30693 Vmessage_stack
= Qnil
;
30694 staticpro (&Vmessage_stack
);
30696 /* Non-nil means don't actually do any redisplay. */
30697 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30699 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30701 DEFVAR_BOOL("inhibit-message", inhibit_message
,
30702 doc
: /* Non-nil means calls to `message' are not displayed.
30703 They are still logged to the *Messages* buffer. */);
30704 inhibit_message
= 0;
30706 message_dolog_marker1
= Fmake_marker ();
30707 staticpro (&message_dolog_marker1
);
30708 message_dolog_marker2
= Fmake_marker ();
30709 staticpro (&message_dolog_marker2
);
30710 message_dolog_marker3
= Fmake_marker ();
30711 staticpro (&message_dolog_marker3
);
30714 defsubr (&Sdump_frame_glyph_matrix
);
30715 defsubr (&Sdump_glyph_matrix
);
30716 defsubr (&Sdump_glyph_row
);
30717 defsubr (&Sdump_tool_bar_row
);
30718 defsubr (&Strace_redisplay
);
30719 defsubr (&Strace_to_stderr
);
30721 #ifdef HAVE_WINDOW_SYSTEM
30722 defsubr (&Stool_bar_height
);
30723 defsubr (&Slookup_image_map
);
30725 defsubr (&Sline_pixel_height
);
30726 defsubr (&Sformat_mode_line
);
30727 defsubr (&Sinvisible_p
);
30728 defsubr (&Scurrent_bidi_paragraph_direction
);
30729 defsubr (&Swindow_text_pixel_size
);
30730 defsubr (&Smove_point_visually
);
30731 defsubr (&Sbidi_find_overridden_directionality
);
30733 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30734 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30735 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30736 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30737 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30738 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30739 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30740 DEFSYM (Qeval
, "eval");
30741 DEFSYM (QCdata
, ":data");
30743 /* Names of text properties relevant for redisplay. */
30744 DEFSYM (Qdisplay
, "display");
30745 DEFSYM (Qspace_width
, "space-width");
30746 DEFSYM (Qraise
, "raise");
30747 DEFSYM (Qslice
, "slice");
30748 DEFSYM (Qspace
, "space");
30749 DEFSYM (Qmargin
, "margin");
30750 DEFSYM (Qpointer
, "pointer");
30751 DEFSYM (Qleft_margin
, "left-margin");
30752 DEFSYM (Qright_margin
, "right-margin");
30753 DEFSYM (Qcenter
, "center");
30754 DEFSYM (Qline_height
, "line-height");
30755 DEFSYM (QCalign_to
, ":align-to");
30756 DEFSYM (QCrelative_width
, ":relative-width");
30757 DEFSYM (QCrelative_height
, ":relative-height");
30758 DEFSYM (QCeval
, ":eval");
30759 DEFSYM (QCpropertize
, ":propertize");
30760 DEFSYM (QCfile
, ":file");
30761 DEFSYM (Qfontified
, "fontified");
30762 DEFSYM (Qfontification_functions
, "fontification-functions");
30764 /* Name of the face used to highlight trailing whitespace. */
30765 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30767 /* Name and number of the face used to highlight escape glyphs. */
30768 DEFSYM (Qescape_glyph
, "escape-glyph");
30770 /* Name and number of the face used to highlight non-breaking spaces. */
30771 DEFSYM (Qnobreak_space
, "nobreak-space");
30773 /* The symbol 'image' which is the car of the lists used to represent
30774 images in Lisp. Also a tool bar style. */
30775 DEFSYM (Qimage
, "image");
30777 /* Tool bar styles. */
30778 DEFSYM (Qtext
, "text");
30779 DEFSYM (Qboth
, "both");
30780 DEFSYM (Qboth_horiz
, "both-horiz");
30781 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30783 /* The image map types. */
30784 DEFSYM (QCmap
, ":map");
30785 DEFSYM (QCpointer
, ":pointer");
30786 DEFSYM (Qrect
, "rect");
30787 DEFSYM (Qcircle
, "circle");
30788 DEFSYM (Qpoly
, "poly");
30790 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30792 DEFSYM (Qgrow_only
, "grow-only");
30793 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30794 DEFSYM (Qposition
, "position");
30795 DEFSYM (Qbuffer_position
, "buffer-position");
30796 DEFSYM (Qobject
, "object");
30798 /* Cursor shapes. */
30799 DEFSYM (Qbar
, "bar");
30800 DEFSYM (Qhbar
, "hbar");
30801 DEFSYM (Qbox
, "box");
30802 DEFSYM (Qhollow
, "hollow");
30804 /* Pointer shapes. */
30805 DEFSYM (Qhand
, "hand");
30806 DEFSYM (Qarrow
, "arrow");
30809 DEFSYM (Qdragging
, "dragging");
30811 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30813 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
30814 staticpro (&list_of_error
);
30816 /* Values of those variables at last redisplay are stored as
30817 properties on 'overlay-arrow-position' symbol. However, if
30818 Voverlay_arrow_position is a marker, last-arrow-position is its
30819 numerical position. */
30820 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30821 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30823 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30824 properties on a symbol in overlay-arrow-variable-list. */
30825 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30826 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30828 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30829 staticpro (&echo_buffer
[0]);
30830 staticpro (&echo_buffer
[1]);
30832 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30833 staticpro (&echo_area_buffer
[0]);
30834 staticpro (&echo_area_buffer
[1]);
30836 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30837 staticpro (&Vmessages_buffer_name
);
30839 mode_line_proptrans_alist
= Qnil
;
30840 staticpro (&mode_line_proptrans_alist
);
30841 mode_line_string_list
= Qnil
;
30842 staticpro (&mode_line_string_list
);
30843 mode_line_string_face
= Qnil
;
30844 staticpro (&mode_line_string_face
);
30845 mode_line_string_face_prop
= Qnil
;
30846 staticpro (&mode_line_string_face_prop
);
30847 Vmode_line_unwind_vector
= Qnil
;
30848 staticpro (&Vmode_line_unwind_vector
);
30850 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30852 help_echo_string
= Qnil
;
30853 staticpro (&help_echo_string
);
30854 help_echo_object
= Qnil
;
30855 staticpro (&help_echo_object
);
30856 help_echo_window
= Qnil
;
30857 staticpro (&help_echo_window
);
30858 previous_help_echo_string
= Qnil
;
30859 staticpro (&previous_help_echo_string
);
30860 help_echo_pos
= -1;
30862 DEFSYM (Qright_to_left
, "right-to-left");
30863 DEFSYM (Qleft_to_right
, "left-to-right");
30864 defsubr (&Sbidi_resolved_levels
);
30866 #ifdef HAVE_WINDOW_SYSTEM
30867 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30868 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30869 For example, if a block cursor is over a tab, it will be drawn as
30870 wide as that tab on the display. */);
30871 x_stretch_cursor_p
= 0;
30874 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30875 doc
: /* Non-nil means highlight trailing whitespace.
30876 The face used for trailing whitespace is `trailing-whitespace'. */);
30877 Vshow_trailing_whitespace
= Qnil
;
30879 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30880 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30881 If the value is t, Emacs highlights non-ASCII chars which have the
30882 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30883 or `escape-glyph' face respectively.
30885 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30886 U+2011 (non-breaking hyphen) are affected.
30888 Any other non-nil value means to display these characters as a escape
30889 glyph followed by an ordinary space or hyphen.
30891 A value of nil means no special handling of these characters. */);
30892 Vnobreak_char_display
= Qt
;
30894 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30895 doc
: /* The pointer shape to show in void text areas.
30896 A value of nil means to show the text pointer. Other options are
30897 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30899 Vvoid_text_area_pointer
= Qarrow
;
30901 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30902 doc
: /* Non-nil means don't actually do any redisplay.
30903 This is used for internal purposes. */);
30904 Vinhibit_redisplay
= Qnil
;
30906 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30907 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30908 Vglobal_mode_string
= Qnil
;
30910 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30911 doc
: /* Marker for where to display an arrow on top of the buffer text.
30912 This must be the beginning of a line in order to work.
30913 See also `overlay-arrow-string'. */);
30914 Voverlay_arrow_position
= Qnil
;
30916 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30917 doc
: /* String to display as an arrow in non-window frames.
30918 See also `overlay-arrow-position'. */);
30919 Voverlay_arrow_string
= build_pure_c_string ("=>");
30921 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30922 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30923 The symbols on this list are examined during redisplay to determine
30924 where to display overlay arrows. */);
30925 Voverlay_arrow_variable_list
30926 = list1 (intern_c_string ("overlay-arrow-position"));
30928 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30929 doc
: /* The number of lines to try scrolling a window by when point moves out.
30930 If that fails to bring point back on frame, point is centered instead.
30931 If this is zero, point is always centered after it moves off frame.
30932 If you want scrolling to always be a line at a time, you should set
30933 `scroll-conservatively' to a large value rather than set this to 1. */);
30935 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30936 doc
: /* Scroll up to this many lines, to bring point back on screen.
30937 If point moves off-screen, redisplay will scroll by up to
30938 `scroll-conservatively' lines in order to bring point just barely
30939 onto the screen again. If that cannot be done, then redisplay
30940 recenters point as usual.
30942 If the value is greater than 100, redisplay will never recenter point,
30943 but will always scroll just enough text to bring point into view, even
30944 if you move far away.
30946 A value of zero means always recenter point if it moves off screen. */);
30947 scroll_conservatively
= 0;
30949 DEFVAR_INT ("scroll-margin", scroll_margin
,
30950 doc
: /* Number of lines of margin at the top and bottom of a window.
30951 Recenter the window whenever point gets within this many lines
30952 of the top or bottom of the window. */);
30955 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30956 doc
: /* Pixels per inch value for non-window system displays.
30957 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30958 Vdisplay_pixels_per_inch
= make_float (72.0);
30961 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30964 DEFVAR_LISP ("truncate-partial-width-windows",
30965 Vtruncate_partial_width_windows
,
30966 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30967 For an integer value, truncate lines in each window narrower than the
30968 full frame width, provided the window width is less than that integer;
30969 otherwise, respect the value of `truncate-lines'.
30971 For any other non-nil value, truncate lines in all windows that do
30972 not span the full frame width.
30974 A value of nil means to respect the value of `truncate-lines'.
30976 If `word-wrap' is enabled, you might want to reduce this. */);
30977 Vtruncate_partial_width_windows
= make_number (50);
30979 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30980 doc
: /* Maximum buffer size for which line number should be displayed.
30981 If the buffer is bigger than this, the line number does not appear
30982 in the mode line. A value of nil means no limit. */);
30983 Vline_number_display_limit
= Qnil
;
30985 DEFVAR_INT ("line-number-display-limit-width",
30986 line_number_display_limit_width
,
30987 doc
: /* Maximum line width (in characters) for line number display.
30988 If the average length of the lines near point is bigger than this, then the
30989 line number may be omitted from the mode line. */);
30990 line_number_display_limit_width
= 200;
30992 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30993 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30994 highlight_nonselected_windows
= false;
30996 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30997 doc
: /* Non-nil if more than one frame is visible on this display.
30998 Minibuffer-only frames don't count, but iconified frames do.
30999 This variable is not guaranteed to be accurate except while processing
31000 `frame-title-format' and `icon-title-format'. */);
31002 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31003 doc
: /* Template for displaying the title bar of visible frames.
31004 (Assuming the window manager supports this feature.)
31006 This variable has the same structure as `mode-line-format', except that
31007 the %c and %l constructs are ignored. It is used only on frames for
31008 which no explicit name has been set (see `modify-frame-parameters'). */);
31010 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31011 doc
: /* Template for displaying the title bar of an iconified frame.
31012 (Assuming the window manager supports this feature.)
31013 This variable has the same structure as `mode-line-format' (which see),
31014 and is used only on frames for which no explicit name has been set
31015 (see `modify-frame-parameters'). */);
31017 = Vframe_title_format
31018 = listn (CONSTYPE_PURE
, 3,
31019 intern_c_string ("multiple-frames"),
31020 build_pure_c_string ("%b"),
31021 listn (CONSTYPE_PURE
, 4,
31022 empty_unibyte_string
,
31023 intern_c_string ("invocation-name"),
31024 build_pure_c_string ("@"),
31025 intern_c_string ("system-name")));
31027 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31028 doc
: /* Maximum number of lines to keep in the message log buffer.
31029 If nil, disable message logging. If t, log messages but don't truncate
31030 the buffer when it becomes large. */);
31031 Vmessage_log_max
= make_number (1000);
31033 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31034 doc
: /* Functions called before redisplay, if window sizes have changed.
31035 The value should be a list of functions that take one argument.
31036 Just before redisplay, for each frame, if any of its windows have changed
31037 size since the last redisplay, or have been split or deleted,
31038 all the functions in the list are called, with the frame as argument. */);
31039 Vwindow_size_change_functions
= Qnil
;
31041 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31042 doc
: /* List of functions to call before redisplaying a window with scrolling.
31043 Each function is called with two arguments, the window and its new
31044 display-start position.
31045 These functions are called whenever the `window-start' marker is modified,
31046 either to point into another buffer (e.g. via `set-window-buffer') or another
31047 place in the same buffer.
31048 Note that the value of `window-end' is not valid when these functions are
31051 Warning: Do not use this feature to alter the way the window
31052 is scrolled. It is not designed for that, and such use probably won't
31054 Vwindow_scroll_functions
= Qnil
;
31056 DEFVAR_LISP ("window-text-change-functions",
31057 Vwindow_text_change_functions
,
31058 doc
: /* Functions to call in redisplay when text in the window might change. */);
31059 Vwindow_text_change_functions
= Qnil
;
31061 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31062 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31063 Each function is called with two arguments, the window and the end trigger value.
31064 See `set-window-redisplay-end-trigger'. */);
31065 Vredisplay_end_trigger_functions
= Qnil
;
31067 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31068 doc
: /* Non-nil means autoselect window with mouse pointer.
31069 If nil, do not autoselect windows.
31070 A positive number means delay autoselection by that many seconds: a
31071 window is autoselected only after the mouse has remained in that
31072 window for the duration of the delay.
31073 A negative number has a similar effect, but causes windows to be
31074 autoselected only after the mouse has stopped moving. (Because of
31075 the way Emacs compares mouse events, you will occasionally wait twice
31076 that time before the window gets selected.)
31077 Any other value means to autoselect window instantaneously when the
31078 mouse pointer enters it.
31080 Autoselection selects the minibuffer only if it is active, and never
31081 unselects the minibuffer if it is active.
31083 When customizing this variable make sure that the actual value of
31084 `focus-follows-mouse' matches the behavior of your window manager. */);
31085 Vmouse_autoselect_window
= Qnil
;
31087 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31088 doc
: /* Non-nil means automatically resize tool-bars.
31089 This dynamically changes the tool-bar's height to the minimum height
31090 that is needed to make all tool-bar items visible.
31091 If value is `grow-only', the tool-bar's height is only increased
31092 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31093 Vauto_resize_tool_bars
= Qt
;
31095 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31096 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31097 auto_raise_tool_bar_buttons_p
= true;
31099 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31100 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31101 make_cursor_line_fully_visible_p
= true;
31103 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31104 doc
: /* Border below tool-bar in pixels.
31105 If an integer, use it as the height of the border.
31106 If it is one of `internal-border-width' or `border-width', use the
31107 value of the corresponding frame parameter.
31108 Otherwise, no border is added below the tool-bar. */);
31109 Vtool_bar_border
= Qinternal_border_width
;
31111 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31112 doc
: /* Margin around tool-bar buttons in pixels.
31113 If an integer, use that for both horizontal and vertical margins.
31114 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31115 HORZ specifying the horizontal margin, and VERT specifying the
31116 vertical margin. */);
31117 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31119 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31120 doc
: /* Relief thickness of tool-bar buttons. */);
31121 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31123 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31124 doc
: /* Tool bar style to use.
31126 image - show images only
31127 text - show text only
31128 both - show both, text below image
31129 both-horiz - show text to the right of the image
31130 text-image-horiz - show text to the left of the image
31131 any other - use system default or image if no system default.
31133 This variable only affects the GTK+ toolkit version of Emacs. */);
31134 Vtool_bar_style
= Qnil
;
31136 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31137 doc
: /* Maximum number of characters a label can have to be shown.
31138 The tool bar style must also show labels for this to have any effect, see
31139 `tool-bar-style'. */);
31140 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31142 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31143 doc
: /* List of functions to call to fontify regions of text.
31144 Each function is called with one argument POS. Functions must
31145 fontify a region starting at POS in the current buffer, and give
31146 fontified regions the property `fontified'. */);
31147 Vfontification_functions
= Qnil
;
31148 Fmake_variable_buffer_local (Qfontification_functions
);
31150 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31151 unibyte_display_via_language_environment
,
31152 doc
: /* Non-nil means display unibyte text according to language environment.
31153 Specifically, this means that raw bytes in the range 160-255 decimal
31154 are displayed by converting them to the equivalent multibyte characters
31155 according to the current language environment. As a result, they are
31156 displayed according to the current fontset.
31158 Note that this variable affects only how these bytes are displayed,
31159 but does not change the fact they are interpreted as raw bytes. */);
31160 unibyte_display_via_language_environment
= false;
31162 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31163 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31164 If a float, it specifies a fraction of the mini-window frame's height.
31165 If an integer, it specifies a number of lines. */);
31166 Vmax_mini_window_height
= make_float (0.25);
31168 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31169 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31170 A value of nil means don't automatically resize mini-windows.
31171 A value of t means resize them to fit the text displayed in them.
31172 A value of `grow-only', the default, means let mini-windows grow only;
31173 they return to their normal size when the minibuffer is closed, or the
31174 echo area becomes empty. */);
31175 Vresize_mini_windows
= Qgrow_only
;
31177 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31178 doc
: /* Alist specifying how to blink the cursor off.
31179 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31180 `cursor-type' frame-parameter or variable equals ON-STATE,
31181 comparing using `equal', Emacs uses OFF-STATE to specify
31182 how to blink it off. ON-STATE and OFF-STATE are values for
31183 the `cursor-type' frame parameter.
31185 If a frame's ON-STATE has no entry in this list,
31186 the frame's other specifications determine how to blink the cursor off. */);
31187 Vblink_cursor_alist
= Qnil
;
31189 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31190 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31191 If non-nil, windows are automatically scrolled horizontally to make
31192 point visible. */);
31193 automatic_hscrolling_p
= true;
31194 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31196 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31197 doc
: /* How many columns away from the window edge point is allowed to get
31198 before automatic hscrolling will horizontally scroll the window. */);
31199 hscroll_margin
= 5;
31201 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31202 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31203 When point is less than `hscroll-margin' columns from the window
31204 edge, automatic hscrolling will scroll the window by the amount of columns
31205 determined by this variable. If its value is a positive integer, scroll that
31206 many columns. If it's a positive floating-point number, it specifies the
31207 fraction of the window's width to scroll. If it's nil or zero, point will be
31208 centered horizontally after the scroll. Any other value, including negative
31209 numbers, are treated as if the value were zero.
31211 Automatic hscrolling always moves point outside the scroll margin, so if
31212 point was more than scroll step columns inside the margin, the window will
31213 scroll more than the value given by the scroll step.
31215 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31216 and `scroll-right' overrides this variable's effect. */);
31217 Vhscroll_step
= make_number (0);
31219 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31220 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31221 Bind this around calls to `message' to let it take effect. */);
31222 message_truncate_lines
= false;
31224 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31225 doc
: /* Normal hook run to update the menu bar definitions.
31226 Redisplay runs this hook before it redisplays the menu bar.
31227 This is used to update menus such as Buffers, whose contents depend on
31229 Vmenu_bar_update_hook
= Qnil
;
31231 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31232 doc
: /* Frame for which we are updating a menu.
31233 The enable predicate for a menu binding should check this variable. */);
31234 Vmenu_updating_frame
= Qnil
;
31236 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31237 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31238 inhibit_menubar_update
= false;
31240 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31241 doc
: /* Prefix prepended to all continuation lines at display time.
31242 The value may be a string, an image, or a stretch-glyph; it is
31243 interpreted in the same way as the value of a `display' text property.
31245 This variable is overridden by any `wrap-prefix' text or overlay
31248 To add a prefix to non-continuation lines, use `line-prefix'. */);
31249 Vwrap_prefix
= Qnil
;
31250 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31251 Fmake_variable_buffer_local (Qwrap_prefix
);
31253 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31254 doc
: /* Prefix prepended to all non-continuation lines at display time.
31255 The value may be a string, an image, or a stretch-glyph; it is
31256 interpreted in the same way as the value of a `display' text property.
31258 This variable is overridden by any `line-prefix' text or overlay
31261 To add a prefix to continuation lines, use `wrap-prefix'. */);
31262 Vline_prefix
= Qnil
;
31263 DEFSYM (Qline_prefix
, "line-prefix");
31264 Fmake_variable_buffer_local (Qline_prefix
);
31266 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31267 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31268 inhibit_eval_during_redisplay
= false;
31270 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31271 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31272 inhibit_free_realized_faces
= false;
31274 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31275 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31276 Intended for use during debugging and for testing bidi display;
31277 see biditest.el in the test suite. */);
31278 inhibit_bidi_mirroring
= false;
31281 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31282 doc
: /* Inhibit try_window_id display optimization. */);
31283 inhibit_try_window_id
= false;
31285 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31286 doc
: /* Inhibit try_window_reusing display optimization. */);
31287 inhibit_try_window_reusing
= false;
31289 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31290 doc
: /* Inhibit try_cursor_movement display optimization. */);
31291 inhibit_try_cursor_movement
= false;
31292 #endif /* GLYPH_DEBUG */
31294 DEFVAR_INT ("overline-margin", overline_margin
,
31295 doc
: /* Space between overline and text, in pixels.
31296 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31297 margin to the character height. */);
31298 overline_margin
= 2;
31300 DEFVAR_INT ("underline-minimum-offset",
31301 underline_minimum_offset
,
31302 doc
: /* Minimum distance between baseline and underline.
31303 This can improve legibility of underlined text at small font sizes,
31304 particularly when using variable `x-use-underline-position-properties'
31305 with fonts that specify an UNDERLINE_POSITION relatively close to the
31306 baseline. The default value is 1. */);
31307 underline_minimum_offset
= 1;
31309 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31310 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31311 This feature only works when on a window system that can change
31312 cursor shapes. */);
31313 display_hourglass_p
= true;
31315 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31316 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31317 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31319 #ifdef HAVE_WINDOW_SYSTEM
31320 hourglass_atimer
= NULL
;
31321 hourglass_shown_p
= false;
31322 #endif /* HAVE_WINDOW_SYSTEM */
31324 /* Name of the face used to display glyphless characters. */
31325 DEFSYM (Qglyphless_char
, "glyphless-char");
31327 /* Method symbols for Vglyphless_char_display. */
31328 DEFSYM (Qhex_code
, "hex-code");
31329 DEFSYM (Qempty_box
, "empty-box");
31330 DEFSYM (Qthin_space
, "thin-space");
31331 DEFSYM (Qzero_width
, "zero-width");
31333 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31334 doc
: /* Function run just before redisplay.
31335 It is called with one argument, which is the set of windows that are to
31336 be redisplayed. This set can be nil (meaning, only the selected window),
31337 or t (meaning all windows). */);
31338 Vpre_redisplay_function
= intern ("ignore");
31340 /* Symbol for the purpose of Vglyphless_char_display. */
31341 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31342 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31344 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31345 doc
: /* Char-table defining glyphless characters.
31346 Each element, if non-nil, should be one of the following:
31347 an ASCII acronym string: display this string in a box
31348 `hex-code': display the hexadecimal code of a character in a box
31349 `empty-box': display as an empty box
31350 `thin-space': display as 1-pixel width space
31351 `zero-width': don't display
31352 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31353 display method for graphical terminals and text terminals respectively.
31354 GRAPHICAL and TEXT should each have one of the values listed above.
31356 The char-table has one extra slot to control the display of a character for
31357 which no font is found. This slot only takes effect on graphical terminals.
31358 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31359 `thin-space'. The default is `empty-box'.
31361 If a character has a non-nil entry in an active display table, the
31362 display table takes effect; in this case, Emacs does not consult
31363 `glyphless-char-display' at all. */);
31364 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31365 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31368 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31369 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31370 Vdebug_on_message
= Qnil
;
31372 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31374 Vredisplay__all_windows_cause
31375 = Fmake_vector (make_number (100), make_number (0));
31377 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31379 Vredisplay__mode_lines_cause
31380 = Fmake_vector (make_number (100), make_number (0));
31384 /* Initialize this module when Emacs starts. */
31389 CHARPOS (this_line_start_pos
) = 0;
31391 if (!noninteractive
)
31393 struct window
*m
= XWINDOW (minibuf_window
);
31394 Lisp_Object frame
= m
->frame
;
31395 struct frame
*f
= XFRAME (frame
);
31396 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31397 struct window
*r
= XWINDOW (root
);
31400 echo_area_window
= minibuf_window
;
31402 r
->top_line
= FRAME_TOP_MARGIN (f
);
31403 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31404 r
->total_cols
= FRAME_COLS (f
);
31405 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31406 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31407 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31409 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31410 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31411 m
->total_cols
= FRAME_COLS (f
);
31412 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31413 m
->total_lines
= 1;
31414 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31416 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31417 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31418 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31420 /* The default ellipsis glyphs `...'. */
31421 for (i
= 0; i
< 3; ++i
)
31422 default_invis_vector
[i
] = make_number ('.');
31426 /* Allocate the buffer for frame titles.
31427 Also used for `format-mode-line'. */
31429 mode_line_noprop_buf
= xmalloc (size
);
31430 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31431 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31432 mode_line_target
= MODE_LINE_DISPLAY
;
31435 help_echo_showing_p
= false;
31438 #ifdef HAVE_WINDOW_SYSTEM
31440 /* Platform-independent portion of hourglass implementation. */
31442 /* Timer function of hourglass_atimer. */
31445 show_hourglass (struct atimer
*timer
)
31447 /* The timer implementation will cancel this timer automatically
31448 after this function has run. Set hourglass_atimer to null
31449 so that we know the timer doesn't have to be canceled. */
31450 hourglass_atimer
= NULL
;
31452 if (!hourglass_shown_p
)
31454 Lisp_Object tail
, frame
;
31458 FOR_EACH_FRAME (tail
, frame
)
31460 struct frame
*f
= XFRAME (frame
);
31462 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31463 && FRAME_RIF (f
)->show_hourglass
)
31464 FRAME_RIF (f
)->show_hourglass (f
);
31467 hourglass_shown_p
= true;
31472 /* Cancel a currently active hourglass timer, and start a new one. */
31475 start_hourglass (void)
31477 struct timespec delay
;
31479 cancel_hourglass ();
31481 if (INTEGERP (Vhourglass_delay
)
31482 && XINT (Vhourglass_delay
) > 0)
31483 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31484 TYPE_MAXIMUM (time_t)),
31486 else if (FLOATP (Vhourglass_delay
)
31487 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31488 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31490 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31492 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31493 show_hourglass
, NULL
);
31496 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31500 cancel_hourglass (void)
31502 if (hourglass_atimer
)
31504 cancel_atimer (hourglass_atimer
);
31505 hourglass_atimer
= NULL
;
31508 if (hourglass_shown_p
)
31510 Lisp_Object tail
, frame
;
31514 FOR_EACH_FRAME (tail
, frame
)
31516 struct frame
*f
= XFRAME (frame
);
31518 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31519 && FRAME_RIF (f
)->hide_hourglass
)
31520 FRAME_RIF (f
)->hide_hourglass (f
);
31522 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31523 else if (!FRAME_W32_P (f
))
31524 w32_arrow_cursor ();
31528 hourglass_shown_p
= false;
31533 #endif /* HAVE_WINDOW_SYSTEM */